Merge branch 'bugfix/espcoredump_notes' into 'master'

coredump: Add some notes on how to generate test data

See merge request espressif/esp-idf!15497

components/espcoredump/test/test_espcoredump.sh

@@ -11,6 +11,11 @@ else
   elf_dir=$1
 fi
 
+if ! command -v coverage &> /dev/null; then
+  echo "coverage could not be found, please install it ('pip install coverage')"
+  exit 1
+fi
+
 SUPPORTED_TARGETS=("esp32" "esp32s2" "esp32c3" "esp32s3" )
 res=0
 coverage erase

components/espcoredump/test_apps/README.md

@@ -1,6 +1,30 @@
-| Supported Targets | ESP32 | ESP32-S2 | ESP32-C3 |
+| Supported Targets | ESP32 | ESP32-S2 | ESP32-C3 | ESP32-S3 |
-| ----------------- | ----- | -------- | -------- |
+| ----------------- | ----- | -------- | -------- | -------- |
 
 # ESP Core Dump Tests
 
 This test app is used to provide built binaries for the test cases under test folders
+
+## Update coredump.64 test data
+
+To update `test/<target>/coredump.64` build a `test_apps` for a target, flash and get a base64 text from `idf.py monitor`
+
+## Update expected_output test data
+
+To update `test/<target>/expected_output` run
+
+```
+TARGET=esp32
+espcoredump.py --chip $TARGET info_corefile -c ../test/$TARGET/coredump.b64 -t b64 -m ./build/test_core_dump.elf > ../test/$TARGET/expected_output
+```
+
+A `test_apps` app should be built for that target.
+
+Do the same for other targets: esp32s2, esp32c3, etc.
+
+## Update ELF test binaries
+
+The ELF test binaries are placed in a different git repository, _idf-coredump-elf_, to avoid putting big binaries in IDF repo.
+It is used in _test_espcoredump_ CI job.
+
+See _idf-coredump-elf/README.md_ to use `build_espcoredump.sh` and generate test ELF binaries