This is an automated email from the ASF dual-hosted git repository.
xiaoxiang781216 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git
The following commit(s) were added to refs/heads/master by this push:
new 384e5e4df4d docs: document Python linting requirements
384e5e4df4d is described below
commit 384e5e4df4d8923351ff58faad9eecaa661842b8
Author: Taha Zarif <[email protected]>
AuthorDate: Mon Sep 14 23:31:45 2026 +0330
docs: document Python linting requirements
Document the Python format and lint tools enforced by checkpatch.sh and CI,
and show how to run the existing Python auto-format path.
Assisted-by: ChatGPT:gpt-5.6-sol
Signed-off-by: Taha Zarif <[email protected]>
---
Documentation/contributing/making-changes.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/Documentation/contributing/making-changes.rst
b/Documentation/contributing/making-changes.rst
index 7cbe6cb0add..a4884df27e6 100644
--- a/Documentation/contributing/making-changes.rst
+++ b/Documentation/contributing/making-changes.rst
@@ -137,6 +137,24 @@ maybe doing that several times. Then when everything
works, the branch is ready
$ # run again
$ ./tools/checkpatch.sh -f my-file.c
+ Python files are checked with ``black``, ``isort``, and ``flake8``. Install
+ these tools before checking a Python contribution:
+
+ .. code-block:: bash
+
+ $ pip install black isort flake8
+ $ ./tools/checkpatch.sh -f path/to/script.py
+
+ ``checkpatch.sh`` can also format Python files with the configured
+ ``isort`` settings and ``black``:
+
+ .. code-block:: bash
+
+ $ ./tools/checkpatch.sh -x path/to/script.py
+
+ You can also use :ref:`precommit` to run the repository's configured
+ checks automatically before committing changes.
+
If you have made a lot of changes, you can also use this bash commandline
to see the errors for all the changed C
files in your branch (assumes you are currently on the branch that has the
changed files):
