![]() ![]() So if a developer has custom settings for options which are renamed in newer ESP-IDF releases, then the given setting for the option would be silently ignored. The standard Kconfig tools ignore unknown options in sdkconfig. Backward Compatibility of Kconfig Options 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. 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. new with some suggestions about how to fix issues (if there are any). The checker checks all Kconfig and Kconfig.projbuild files in the ESP-IDF directory, and generates a new file with suffix. Tools/ci/check_kconfigs.py is provided for checking Kconfig files against the above format rules. The help section of each config in the menu is treated as reStructuredText to generate the reference documentation for each option. The maximum length of lines is 120 characters. The maximum length of options is 40 characters. No trailing spaces are allowed at the end of the lines. ![]() For example, menu is indented by 0 spaces, config menu by 4 spaces, help in config by 8 spaces, and the text under help by 12 spaces. All sub-items belonging to a parent item are indented by one level deeper. The unit of indentation should be 4 spaces. The prefix currently should have at least 3 characters. Option names in any menus should have consistent prefixes. Kconfig Format Rules įormat rules for Kconfig files are as follows: For more information, see Custom Sdkconfig Defaults. Note that during the build process, settings from faults will not override those already in sdkconfig. Project build targets will automatically create the sdkconfig file, populate it with the settings from the faults file, and configure the rest of the settings to their default values. Once faults is created, sdkconfig can be deleted or added to the ignore list of the revision control system (e.g., the. faults can be created manually when one remembers all the changed configuration, or it can be generated automatically by running the idf.py save-defconfig command. The format is the same as that of the sdkconfig file. It contains all the options which matter to the given application and are different from the default ones. ![]() This file is never touched by the build system, and can be created manually or automatically. The build system offers a solution to prevent it from happening, which is to create the faults file. In some cases, for example, when the sdkconfig file is under revision control, it may be inconvenient for the build system to change the sdkconfig file. Based on sdkconfig, application build targets will generate the sdkconfig.h file under the build directory, and will make the sdkconfig options available to the project build system and source files. Project Configuration Menu Īpplication developers can open a terminal-based project configuration menu with the idf.py menuconfig build target.Īfter being updated, this configuration is saved in the sdkconfig file under the project root directory. Kconfig files specify dependencies between options, default values of options, the way options are grouped together, etc.įor the full list of available features, please see Kconfig and kconfiglib extentions. ![]() Kconfig provides a compile-time project configuration mechanism and offers configuration options of several types (e.g., integers, strings, and boolens). The esp-idf-kconfig package that ESP-IDF uses is based on kconfiglib, which is a Python extension to the Kconfig system. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |