Aksal/nuttx
3
1
Fork 1
mirror of https://github.com/apache/nuttx.git synced 2026-10-08 06:45:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

DOC: Fix documentation to include checkpatch.sh

Browse source 
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 <acassis@gmail.com>
This commit is contained in:
Alan Carvalho de Assis 2025-02-09 09:13:08 -03:00 • committed by Mateusz Szafoni
parent 3594f9d879
commit edba1b5701
1 changed files with 22 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Documentation/contributing/coding_style.rst
View file

@ -8,9 +8,28 @@ 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>`__.
**************************
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:
.. code-block:: bash
./tools/checkpatch.sh -g HEAD~...HEAD
Alternatevily you can run this script passing the .c file or .h header you
want to check:
.. code-block:: bash
./tools/checkpatch.sh -f path/to/your/file.c
*******************
General Conventions