From 2134930e080d10e067bfe8dcd2ff20f57968a748 Mon Sep 17 00:00:00 2001 From: Shubham Patil Date: Fri, 29 Jul 2022 19:11:41 +0530 Subject: [PATCH] [ESP32] Details for using ccache for idf builds (#21340) * [ESP32] Details for using ccache for idf builds * Remove unavailable menuconfig options readmes --- .github/.wordlist.txt | 1 + examples/all-clusters-app/esp32/README.md | 12 ++++++++++-- examples/all-clusters-minimal-app/esp32/README.md | 12 ++++++++++-- examples/bridge-app/esp32/README.md | 12 ++++++++++-- examples/light-switch-app/esp32/README.md | 8 ++++++++ examples/lighting-app/esp32/README.md | 8 ++++++++ examples/lock-app/esp32/README.md | 12 ++++++++++-- examples/temperature-measurement-app/esp32/README.md | 12 ++++++++++-- 8 files changed, 67 insertions(+), 10 deletions(-) diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt index a478491e4239fd..7b748179b6da85 100644 --- a/.github/.wordlist.txt +++ b/.github/.wordlist.txt @@ -182,6 +182,7 @@ CatalogVendorId CBB cbd CBOR +Ccache ccf CCMP CCS diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index 35574ac97a9083..f1bd82ba5a817d 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -113,6 +113,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh ``` +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Set To set IDF target, first: @@ -278,8 +286,8 @@ the ESP32 all-clusters-app to commission it onto a Wi-Fi network: Parameters: -1. Discriminator: 3840 (configurable through menuconfig) -2. Setup-pin-code: 20202021 (configurable through menuconfig) +1. Discriminator: 3840 +2. Setup-pin-code: 20202021 3. Node-id: 12344321 (you can assign any node id) ### Cluster control diff --git a/examples/all-clusters-minimal-app/esp32/README.md b/examples/all-clusters-minimal-app/esp32/README.md index 8c2965a834013d..244b3567ad47e9 100644 --- a/examples/all-clusters-minimal-app/esp32/README.md +++ b/examples/all-clusters-minimal-app/esp32/README.md @@ -113,6 +113,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh ``` +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Set To set IDF target, first: @@ -278,8 +286,8 @@ the ESP32 all-clusters-minimal-app to commission it onto a Wi-Fi network: Parameters: -1. Discriminator: 3840 (configurable through menuconfig) -2. Setup-pin-code: 20202021 (configurable through menuconfig) +1. Discriminator: 3840 +2. Setup-pin-code: 20202021 3. Node-id: 12344321 (you can assign any node id) ### Cluster control diff --git a/examples/bridge-app/esp32/README.md b/examples/bridge-app/esp32/README.md index c9a1dfbe9020a7..465cade4b0092c 100644 --- a/examples/bridge-app/esp32/README.md +++ b/examples/bridge-app/esp32/README.md @@ -135,6 +135,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). ESP32 based device types, please refer [examples/all-clusters-app/esp32](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/esp32) +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - To build the demo application. ``` @@ -255,8 +263,8 @@ the ESP32 all-clusters-app to commission it onto a Wi-Fi network: Parameters: -1. Discriminator: 3840 (configurable through menuconfig) -2. Setup-pin-code: 20202021 (configurable through menuconfig) +1. Discriminator: 3840 +2. Setup-pin-code: 20202021 3. Node-id: 12344321 (you can assign any node id) ### Cluster control diff --git a/examples/light-switch-app/esp32/README.md b/examples/light-switch-app/esp32/README.md index 9616c250526933..c0d238585163a2 100644 --- a/examples/light-switch-app/esp32/README.md +++ b/examples/light-switch-app/esp32/README.md @@ -65,6 +65,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Set $ idf.py set-target esp32 diff --git a/examples/lighting-app/esp32/README.md b/examples/lighting-app/esp32/README.md index eae01ad14d2978..44e6d6c4ec3087 100644 --- a/examples/lighting-app/esp32/README.md +++ b/examples/lighting-app/esp32/README.md @@ -75,6 +75,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Set $ idf.py set-target esp32 diff --git a/examples/lock-app/esp32/README.md b/examples/lock-app/esp32/README.md index 2d5ecd9cb9795d..dc172d6468ace9 100644 --- a/examples/lock-app/esp32/README.md +++ b/examples/lock-app/esp32/README.md @@ -57,6 +57,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Set $ idf.py set-target esp32(or esp32c3) @@ -171,8 +179,8 @@ the ESP32 all-clusters-app to commission it onto a Wi-Fi network: Parameters: -1. Discriminator: 3840 (configurable through menuconfig) -2. Setup-pin-code: 20202021 (configurable through menuconfig) +1. Discriminator: 3840 +2. Setup-pin-code: 20202021 3. Node-id: 12344321 (you can assign any node id) ### Cluster control diff --git a/examples/temperature-measurement-app/esp32/README.md b/examples/temperature-measurement-app/esp32/README.md index 6cf02bedbfd4d2..132a754a4a9ae8 100644 --- a/examples/temperature-measurement-app/esp32/README.md +++ b/examples/temperature-measurement-app/esp32/README.md @@ -57,6 +57,14 @@ make sure the IDF_PATH has been exported(See the manual setup steps above). $ source ./scripts/activate.sh +- Enable Ccache for faster IDF builds + + It is recommended to have Ccache installed for faster builds + + ``` + $ export IDF_CCACHE_ENABLE=1 + ``` + - Target Select $ idf.py set-target esp32(or esp32c3) @@ -171,8 +179,8 @@ the ESP32 all-clusters-app to commission it onto a Wi-Fi network: Parameters: -1. Discriminator: 3840 (configurable through menuconfig) -2. Setup-pin-code: 20202021 (configurable through menuconfig) +1. Discriminator: 3840 +2. Setup-pin-code: 20202021 3. Node-id: 12344321 (you can assign any node id) ### Cluster control