From edba1b5701507bccae675fc488b132ba350d4673 Mon Sep 17 00:00:00 2001 From: Alan Carvalho de Assis Date: Sun, 9 Feb 2025 09:13:08 -0300 Subject: [PATCH] DOC: Fix documentation to include checkpatch.sh 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 --- Documentation/contributing/coding_style.rst | 25 ++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/Documentation/contributing/coding_style.rst b/Documentation/contributing/coding_style.rst index da77570e45b..b2c57a8dd3c 100644 --- a/Documentation/contributing/coding_style.rst +++ b/Documentation/contributing/coding_style.rst @@ -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