You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "cederom (via GitHub)" <gi...@apache.org> on 2026/04/18 03:51:58 UTC
[PR] doc: Contributing tools/checkpatch.sh example update. [nuttx]
cederom opened a new pull request, #18758:
URL: https://github.com/apache/nuttx/pull/18758
## Summary
* Add `./tools/checkpatch.sh -c -u -m -g HEAD~...HEAD` example to match checks performed by our CI.
* Add cross-reference to checkpatch.sh documentation.
## Impact
* Documentation: adds more broad example of checkpatch verification before PR is submitted to match parameters used by our CI (including codespell and encoding).
## Testing
```
% uname -a
FreeBSD hexagon 14.4-RELEASE-p1 FreeBSD 14.4-RELEASE-p1 GENERIC amd64
% cd Documentation
% pipenv shell
(Documentation) hexagon% gmake html
Removing everything under '_build'...
Running Sphinx v6.2.1
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
Tags updated
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1567 source files that are out of date
updating environment: [new config] 1567 added, 0 changed, 0 removed
reading sources...
(..)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output...
(..)
copying downloadable files...
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in _build/html.
```
<img width="946" height="1113" alt="shot-2026-04-18_05-50-04" src="https://github.com/user-attachments/assets/19d244e0-7e83-41a4-b135-2b1a0b93b963" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: Contributing tools/checkpatch.sh example update. [nuttx]
Posted by "cederom (via GitHub)" <gi...@apache.org>.
cederom commented on code in PR #18758:
URL: https://github.com/apache/nuttx/pull/18758#discussion_r3105230605
##########
Documentation/contributing/coding_style.rst:
##########
@@ -8,17 +8,18 @@ C Coding Standard
NuttX follows a specific coding style which needs to be followed at all times
a contribution to be accepted. Please read this document before working on
new code so that you can follow the style from the start. To check your code
-for conformance to the coding style, you should use the checkpatch.sh script
-(that calls the `nxstyle <#nxstyle>`_ tool) included under ``tools/`` in the
-main NuttX repository, or enable the pre-commit functionality described in
-`pre-commit <#precommit>`__.
+for conformance to the coding style, you should use the :ref:`checkpatch.sh`
+script (that calls the `nxstyle <#nxstyle>`_ tool) included under ``tools/``
+in the main NuttX repository, or enable the pre-commit functionality
+described in `pre-commit <#precommit>`__.
**************************
Quick Check for Compliance
**************************
You should check for coding style issues before submitting your Pull Request.
-There is a script that you can run to check for coding styles issue:
+There is a :ref:`checkpatch.sh` script that you can run to check for coding
+styles issue:
Review Comment:
Thanks @hartmannathan :-) I have just updated first and second example to contain all checks, please verify, new render in the PR description :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: Contributing tools/checkpatch.sh example update. [nuttx]
Posted by "acassis (via GitHub)" <gi...@apache.org>.
acassis merged PR #18758:
URL: https://github.com/apache/nuttx/pull/18758
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] doc: Contributing tools/checkpatch.sh example update. [nuttx]
Posted by "hartmannathan (via GitHub)" <gi...@apache.org>.
hartmannathan commented on code in PR #18758:
URL: https://github.com/apache/nuttx/pull/18758#discussion_r3105169808
##########
Documentation/contributing/coding_style.rst:
##########
@@ -8,17 +8,18 @@ C Coding Standard
NuttX follows a specific coding style which needs to be followed at all times
a contribution to be accepted. Please read this document before working on
new code so that you can follow the style from the start. To check your code
-for conformance to the coding style, you should use the checkpatch.sh script
-(that calls the `nxstyle <#nxstyle>`_ tool) included under ``tools/`` in the
-main NuttX repository, or enable the pre-commit functionality described in
-`pre-commit <#precommit>`__.
+for conformance to the coding style, you should use the :ref:`checkpatch.sh`
+script (that calls the `nxstyle <#nxstyle>`_ tool) included under ``tools/``
+in the main NuttX repository, or enable the pre-commit functionality
+described in `pre-commit <#precommit>`__.
**************************
Quick Check for Compliance
**************************
You should check for coding style issues before submitting your Pull Request.
-There is a script that you can run to check for coding styles issue:
+There is a :ref:`checkpatch.sh` script that you can run to check for coding
+styles issue:
Review Comment:
style issues:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org