espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(kconfig): clarify how multiple renames work in sdkconfig.renames

Browse Source 
Describe how multiple renames of one deprecated option to several new
options work.
This commit is contained in:
Jan Beran
2026-03-18 16:23:02 +01:00
committed by Zhang Shuxian
parent 6e267cab0d
commit 29deb3f617
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-guides/kconfig/configuration_structure.rst
+2
View File
@@ -79,6 +79,8 @@ The structure of the ``sdkconfig.rename`` file is as follows:
* ``CONFIG_DEPRECATED_NAME CONFIG_NEW_NAME``, where ``CONFIG_DEPRECATED_NAME`` is the old config name which was renamed in a newer ESP-IDF version to ``CONFIG_NEW_NAME``.
* ``CONFIG_DEPRECATED_NAME !CONFIG_NEW_INVERTED_NAME`` where ``CONFIG_NEW_INVERTED_NAME`` was introduced in a newer ESP-IDF version by Boolean inversion of the logic value of ``CONFIG_DEPRECATED_NAME``.
If there is more than one mapping for the same deprecated option name (i.e. the same deprecated option name is renamed more than once), the last occurrence is used. Configuration system will report this only if configuration report verbosity is set to ``verbose`` (e.g. via ``KCONFIG_REPORT_VERBOSITY`` environment variable).
Primary use case of this file is to ensure backward compatibility when the config name is changed in the newer ESP-IDF version.
Example: