alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 20:41:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: document inversion in kconfig

Browse Source
This commit is contained in:
Jan Beran
2024-07-23 17:26:42 +08:00
committed by Roland Dobai
parent eba71250ca
commit fdffa19958
2 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/en/api-reference/kconfig.rst
View File

@@ -61,6 +61,13 @@ The standard Kconfig_ tools ignore unknown options in ``sdkconfig``. So if a dev
3. ``kconfgen`` post-processes ``sdkconfig`` files and generates all build outputs (``sdkconfig.h``, ``sdkconfig.cmake``, and ``auto.conf``) by adding a list of compatibility statements, i.e., the values of old options are set for new options after modification. If users still use old options in their code, this will prevent it from breaking.
4. :ref:`configuration-deprecated-options` are automatically generated by ``kconfgen``.
The structure of the ``sdkconfig.rename`` file is as follows:
* Lines starting with ``#`` and empty lines will be ignored.
* All other lines should follow one of these formats:
* ``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``.
.. _configuration-options-reference:
Configuration Options Reference