espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-04 20:05:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'fix/kconfigs_check_move' into 'master'

Browse Source 
fix(tools/kconfig): Moved check_konfigs.py to esp-idf-kconfig package

Closes IDFGH-9516

See merge request espressif/esp-idf!26033
This commit is contained in:
Roland Dobai
2023-10-10 17:58:43 +08:00
parent 7b0b7a8bf0 22dcc26674
commit 81804be35f
9 changed files with 51 additions and 687 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/kconfig.rst
+5 -1
View File
@@ -43,7 +43,11 @@ Format rules for Kconfig files are as follows:
Format Checker
--------------
``tools/ci/check_kconfigs.py`` is provided for checking Kconfig files against the above format rules. The checker checks all Kconfig and ``Kconfig.projbuild`` files in the ESP-IDF directory, and generates a new file with suffix ``.new`` with some suggestions about how to fix issues (if there are any). Please note that the checker cannot correct all format issues and the responsibility of the developer is to final check and make corrections in order to pass the tests. For example, indentations will be corrected if there is not any misleading formatting, but it cannot come up with a common prefix for options inside a menu.
``kconfcheck`` tool in esp-idf-kconfig_ package is provided for checking Kconfig files against the above format rules. The checker checks all Kconfig and ``Kconfig.projbuild`` files given as arguments, and generates a new file with suffix ``.new`` with some suggestions about how to fix issues (if there are any). Please note that the checker cannot correct all format issues and the responsibility of the developer is to final check and make corrections in order to pass the tests. For example, indentations will be corrected if there is not any misleading formatting, but it cannot come up with a common prefix for options inside a menu.
The ``esp-idf-kconfig`` package is available in ESP-IDF environments, where the checker tool can be invoked by running command: ``python -m kconfcheck <path_to_kconfig_file>``
For more information, see `esp-idf-kconfig package documentation <https://github.com/espressif/esp-idf-kconfig/blob/master/docs/DOCUMENTATION.md>`_
.. _configuration-options-compatibility: