From cba3e16bb6f8ab576e8548accb96d2e9e36fbf81 Mon Sep 17 00:00:00 2001 From: jparker324 Date: Wed, 21 Apr 2021 16:49:53 -0400 Subject: [PATCH 1/2] manifest.md- How sdkconfig files are processed Reference code https://github.com/Moddable-OpenSource/moddable/blob/1502614759bbee368833c600222406b1808fb972/tools/mcmanifest.js#L161 --- documentation/tools/manifest.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/tools/manifest.md b/documentation/tools/manifest.md index 3b38becb08..4731cccc31 100644 --- a/documentation/tools/manifest.md +++ b/documentation/tools/manifest.md @@ -107,7 +107,7 @@ The Moddable SDK sdkconfig defaults files are located in the `$MODDABLE/build/de When applications specify optional sdkconfig files using the `SDKCONFIGPATH` manifest environment variable, the merge processing additionally includes the following: -4. On debug builds, the application `sdkconfig.defaults` file, when provided, is merged on top of the base Moddable SDK `sdkconfig.defaults` file. +4. On debug builds, the application `sdkconfig.defaults` file, when provided, is merged on top of the merge performed in step 3. 5. On release builds, the application `sdkconfig.defaults.release` options, when provided, are merged on top of the merge performed in step 4. 6. On release instrumented builds, the `sdkconfig.inst` options, when provided, are merged on top of the merge performed in step 5. From c3449c66a6d74e8fab1f00d8799f9b0d8b824c23 Mon Sep 17 00:00:00 2001 From: jparker324 Date: Thu, 29 Apr 2021 11:12:15 -0400 Subject: [PATCH 2/2] Update manifest.md --- documentation/tools/manifest.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/tools/manifest.md b/documentation/tools/manifest.md index 4731cccc31..ce747dbc89 100644 --- a/documentation/tools/manifest.md +++ b/documentation/tools/manifest.md @@ -102,14 +102,14 @@ In this example, the modClock [partitions.csv](https://github.com/Moddable-OpenS The Moddable SDK sdkconfig defaults files are located in the `$MODDABLE/build/devices/esp32/xsProj-esp32` and `$MODDABLE/build/devices/esp32/xsProj-esp32s2` directories for ESP32 and ESP32-S2, respectively. The `sdkconfig.defaults` ([ESP32](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32/sdkconfig.defaults)/[ESP32-S2](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32s2/sdkconfig.defaults)) file is the base configuration file used by all ESP32/ESP32-S2 builds. Release and instrumented release builds merge additional configuration options, on top of the base `sdkconfig.defaults` file, from the `sdkconfig.defaults.release` ([ESP32](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32/sdkconfig.defaults.release)/[ESP32-S2](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32s2/sdkconfig.defaults.release)) and `sdkconfig.inst` ([ESP32](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32/sdkconfig.inst)/[ESP32-S2](https://github.com/Moddable-OpenSource/moddable/blob/public/build/devices/esp32/xsProj-esp32s2/sdkconfig.inst)) files respectively. When merging, configuration options that exist in the base `sdkconfig.defaults` file are replaced and options that don't exist in the base `sdkconfig.defaults` file are added. The merge processing order is as follows: 1. All base `sdkconfig.defaults` options are applied to the build. -2. On release builds, the `sdkconfig.defaults.release` options are merged on top of the `sdkconfig.defaults` options. -3. On release instrumented builds, the `sdkconfig.inst` options are merged on top of the merge performed in step 2. +2. On release builds, the `sdkconfig.defaults.release` options are merged. +3. On release instrumented builds, the `sdkconfig.inst` options are merged. When applications specify optional sdkconfig files using the `SDKCONFIGPATH` manifest environment variable, the merge processing additionally includes the following: -4. On debug builds, the application `sdkconfig.defaults` file, when provided, is merged on top of the merge performed in step 3. -5. On release builds, the application `sdkconfig.defaults.release` options, when provided, are merged on top of the merge performed in step 4. -6. On release instrumented builds, the `sdkconfig.inst` options, when provided, are merged on top of the merge performed in step 5. +4. The application `$(SDKCONFIGPATH)/sdkconfig.defaults` options, when provided, are merged. +5. On release builds, the application `$(SDKCONFIGPATH)/sdkconfig.defaults.release` options, when provided, are merged. +6. On release instrumented builds, the application `$(SDKCONFIGPATH)/sdkconfig.inst` options, when provided, are merged. ***