summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorRobin Howard <robin@rhoward.id.au>2024-07-19 13:50:00 +1000
committerRobin Howard <robin@rhoward.id.au>2024-07-19 13:50:02 +1000
commitd8bdb3434d486e0f70da79d29bac155c7b618d4d (patch)
treed3cd98e7031fc075e06ff9431c2d6f243fd2be9b /BUILDING.md
parentac54cab319b7525630e8376c0a6d236df8ccb8fd (diff)
downloadtangara-fw-d8bdb3434d486e0f70da79d29bac155c7b618d4d.tar.gz
Adds sdkconfig.local (intentionally not tracked in .git) for local overrides.
Here's what I have in mine, for example: ``` CONFIG_LOG_DEFAULT_LEVEL_WARN=n CONFIG_LOG_DEFAULT_LEVEL_INFO=y CONFIG_LOG_DEFAULT_LEVEL=3 ```
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index 571aa359..ee64b088 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -72,3 +72,15 @@ If you get errors involving missing C++ includes, then you may need to edit
your editor's LSP invocation to include `--query-driver=**`.
You should then get proper LSP integration via clangd.
+
+# ESP-IDF configuration
+
+Espressif exposes a large collection of configuration options[1] for its
+framework; you can use `idf.py menuconfig` to generate a custom `sdkconfig`
+file, eg. to change the logging level.
+
+To avoid needing to select the same set of options every time you regenerate
+the sdkconfig, you can also set some defaults in `sdkconfig.local`; this is not
+tracked in git, and is ideal for local / per-checkout changes.
+
+1. https://docs.espressif.com/projects/esp-idf/en/release-v3.3/api-reference/kconfig.html