adafruit-mirror/arduino-esp32
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #7036 from espressif/doc/faq_sdkconfig_options

Browse source 
docs: add FAQ entry about modifying sdkconfig options
This commit is contained in:
Vojtěch Bartoška 2022-07-25 14:04:30 +02:00 committed by GitHub
commit aae45633ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/source/faq.rst
View file

@ -1,3 +1,13 @@
########################## ##########################
Frequently Asked Questions Frequently Asked Questions
########################## ##########################
How to modify an sdkconfig option in Arduino?
---------------------------------------------
Arduino-esp32 project is based on ESP-IDF. While ESP-IDF supports configuration of various compile-time options (known as "Kconfig options" or "sdkconfig options") via a "menuconfig" tool, this feature is not available in Arduino IDE.
To use the arduino-esp32 core with a modified sdkconfig option, you need to use ESP-IDF to compile Arduino libraries. Please see :doc:`esp-idf_component` and :doc:`lib_builder` for the two solutions available.
Note that modifying ``sdkconfig`` or ``sdkconfig.h`` files found in the arduino-esp32 project tree **does not** result in changes to these options. This is because ESP-IDF libraries are included into the arduino-esp32 project tree as pre-built libraries.