diff --git a/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark/README.md b/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark/README.md index 0bc404720c..9bb159f923 100644 --- a/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark/README.md +++ b/IDE/Espressif/ESP-IDF/examples/wolfssl_benchmark/README.md @@ -66,7 +66,8 @@ See the [feature request](https://sysprogs.com/w/forums/topic/feature-request-sh 1-1. Example Configuration -> BENCH_ARG : argument that you want to use. Default is "-lng 0" - The list of argument can be find in help. + The list of arguments can be found in help. See [benchmark/README.md](https://github.com/wolfSSL/wolfssl/blob/master/wolfcrypt/benchmark/README.md) + Features to be benchmarked are enabled in the `user_settings.h`. When you want to run the benchmark program @@ -107,7 +108,7 @@ WRK_IDF_PATH=/mnt/c/SysGCC/esp32-8.4/esp-idf/v4.4.1 # ESP-IDF v5.0 with toolchain v12.4 WRK_IDF_PATH=/mnt/c/SysGCC/esp32-12.4/esp-idf/v5.0 -# ESP-IDF v5.0 to v5.2.1 uses toolchain v12.4 +# ESP-IDF v5.0 to v5.2.1 uses toolchain v12.4 WRK_IDF_PATH=/mnt/c/SysGCC/esp32-12.4/esp-idf/v5.0 WRK_IDF_PATH=/mnt/c/SysGCC/esp32-12.4/esp-idf/v5.1 WRK_IDF_PATH=/mnt/c/SysGCC/esp32-12.4/esp-idf/v5.2.1 diff --git a/IDE/Espressif/ESP-IDF/examples/wolfssl_test/README.md b/IDE/Espressif/ESP-IDF/examples/wolfssl_test/README.md index 79f83d7542..86d53d93f1 100644 --- a/IDE/Espressif/ESP-IDF/examples/wolfssl_test/README.md +++ b/IDE/Espressif/ESP-IDF/examples/wolfssl_test/README.md @@ -27,8 +27,8 @@ No wolfSSL setup is needed. You may need to adjust your specific COM port. The d 1. `idf.py menuconfig` to configure the program. 1-1. Example Configuration -> - TEST_ARG : argument that you want to use. Default is "-lng 0" - The list of argument can be find in help. + There are no parametric arguments. See [wolfcrypt/test](https://github.com/wolfSSL/wolfssl/tree/master/wolfcrypt/test). + All features enabled in the `user_settings.h` will be tested. When you want to run the test program diff --git a/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/README.md b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/README.md index f8ec01cec6..6f6e10c480 100644 --- a/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/README.md +++ b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/README.md @@ -16,7 +16,7 @@ Open the VisualGDB Visual Studio Project file in the VisualGDB directory and cli 1-1. Example Configuration -> TEST_ARG : argument that you want to use. Default is "-lng 0" - The list of argument can be find in help. + The list of arguments can be found in help. When you want to run the test program diff --git a/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/components/README.md b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/components/README.md new file mode 100644 index 0000000000..6952a37a62 --- /dev/null +++ b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/components/README.md @@ -0,0 +1,9 @@ +# wolfssl_test_idf components + +The wolfSSL component should *not* be installed here. + +This example project tests the condition of having wolfSSL installed +*in* the Espressif ESP-IDF [components directory](https://github.com/espressif/esp-idf/tree/master/components). + +The recommended method is to use a local component as shown in +the [template example](../template/README.md). diff --git a/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/main/main.c b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/main/main.c index d740a2e2f5..4c29ecc97a 100644 --- a/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/main/main.c +++ b/IDE/Espressif/ESP-IDF/examples/wolfssl_test_idf/main/main.c @@ -27,6 +27,10 @@ /* Always include wolfcrypt/settings.h before any other wolfSSL file. */ /* Reminder: settings.h pulls in user_settings.h; don't include it here. */ #ifdef WOLFSSL_USER_SETTINGS + /* Unlike other examples with wolfSSL as a local component, this */ + /* example tests wolSSL *in* the ESP-IDF. If you get an error: */ + /* wolfssl/wolfcrypt/settings.h: No such file or directory */ + /* Then wolfSSL is missing from the ESP-IDF components */ #include #ifndef WOLFSSL_ESPIDF #warning "Problem with wolfSSL user_settings."