Documentation of esp-idf-kconfig

This is the documentation for the esp-idf-kconfig project. The esp-idf-kconfig package is a Python library for working with Kconfig configuration files. It is designed to be used with the Espressif IoT Development Framework (ESP-IDF), although it can be used as a standalone package as well. Core kconfiglib and menuconfig functionality has been copied from the original kconfiglib repository.

The esp-idf-kconfig package is used for compile-time project configuration. For the detailed description of the Kconfig language, see the Kconfig section. Contributions are welcome. Before contributing please make sure that you have read the Developer and Contributor Guide.

ESP-IDF specific user guide can be found in the ESP-IDF documentation.

For those who want to visit the original Kconfig language documentation from the Linux kernel, see the Kconfig language documentation.

Excluding the core functionality, the esp-idf-kconfig package has been extended with the following features:

  • Checking the validity of Kconfig files (kconfcheck)

  • Support for configuration via IDEs (kconfserver)

  • Advanced Kconfig file manipulation (kconfgen)

Documentation Overview