Developer Guide

This developer guide is intended for developers who want to work on the esp-idf-kconfig package. It also provides a guide for new contributors. For users searching for the information about how to configure their project with idf.py menuconfig, please refer to the User Guide in ESP-IDF Documentation. For advanced users using their own Kconfig files, please refer to the Kconfig language documentation.

• Contributions Guide
  • How to Contribute
• Writing Tests
  • Testing kconfiglib
• Writing Good Kconfig Files
  • The kconfcheck Tool
  • Useful Tips and Tricks
• Migration Guide From esp-idf-kconfig 2.x to 3.x
  • Changes Overview
  • Missing tristate type/m Value
  • The ---help--- Keyword Is No Longer Supported
  • The def_<type> Options Are Not Supported
  • The option Keyword Is Deprecated
  • The optional Keyword for Choice Entries Is Not Supported
  • config or choice Names Must Contain Only Numbers, Uppercase Letters, and Underscores
  • Preprocessor Macros Are Supported Only in the Form of symbol = value or symbol := value