Mirrors_Framework/nuttx
1
0
Fork 0
mirror of https://github.com/apache/nuttx.git synced 2026-05-09 23:12:17 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

doc: Contributing tools/checkpatch.sh example update.

Browse Source 
* 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.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
This commit is contained in:
Tomasz 'CeDeROM' CEDRO
2026-04-18 05:41:47 +02:00
committed by Alan C. Assis
parent a33c555b5e
commit 865356908d
2 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/components/tools/checkpatch.rst
+2
View File
@@ -1,3 +1,5 @@
.. _checkpatch.sh:
=================
``checkpatch.sh``
=================
Documentation/contributing/coding_style.rst
+10 -9
View File
@@ -8,28 +8,29 @@ 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:
Please verify formatting of your git commits before a Pull Request is
submitted/updated. Use :ref:`checkpatch.sh` script that will verify the coding
style, encoding, and spelling issues:
.. code-block:: bash
./tools/checkpatch.sh -g HEAD~...HEAD
./tools/checkpatch.sh -c -u -m -g HEAD~...HEAD
Alternatevily you can run this script passing the .c file or .h header you
want to check:
want to check using ``-f`` switch:
.. code-block:: bash
./tools/checkpatch.sh -f path/to/your/file.c
./tools/checkpatch.sh -c -u -m -f path/to/your/file.c
*******************
General Conventions