Skip to content

Commit

Permalink
DOC: Fix documentation to include checkpatch.sh
Browse files Browse the repository at this point in the history
Unfortunately new contributors used to submit code with many coding
issues. And in fact it is our guilt: our codign style documentation
doesn't say to them how to use the checkpatch to find the issues.

Signed-off-by: Alan C. Assis <[email protected]>
  • Loading branch information
acassis committed Feb 12, 2025
1 parent 1aced99 commit 6de79b4
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Documentation/contributing/coding_style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ 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 `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 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>`__.

*******************
General Conventions
Expand Down

0 comments on commit 6de79b4

Please sign in to comment.