esp-idf/tools/test_apps/system/no_embedded_paths/README.md

| Supported Targets | ESP32 | ESP32-C3 | ESP32-S2 |
| ----------------- | ----- | -------- | -------- |

# No Embedded Paths

This test app exists to verify that paths (like __FILE__) are not compiled into
any object files in configurations where this should be avoided.

Configurations where this is relevant include:

* Assertions disabled (doubles up as a build-time check that disabling assertions doesn't lead to any warnings)
* Silent assertions
* CONFIG_COMPILER_HIDE_PATHS_MACROS is set to replace IDF_PATH and project dir with placeholders when expanding `__FILE__`

Not embedding paths reduces the binary size, avoids leaking information about
the compilation environment, and is a necessary step to support reproducible
builds across projects built in different directories.
docs: changes docs supported targets tables 2022-07-13 10:41:36 +08:00			`\| Supported Targets \| ESP32 \| ESP32-C3 \| ESP32-S2 \|`
Support ESP32S3 Beta 3 target Update ROM API. Port changes from bringup branch. 2021-03-17 18:48:05 +08:00			`\| ----------------- \| ----- \| -------- \| -------- \|`

ci: Add a test app for not placing embedded file paths into binaries Doubles as a test app that building with assertions off doesn't produce warnings. Closes https://github.com/espressif/esp-idf/issues/6306 2021-02-18 11:08:49 +11:00			`# No Embedded Paths`

			`This test app exists to verify that paths (like __FILE__) are not compiled into`
			`any object files in configurations where this should be avoided.`

config: Add new option to replace IDF_PATH and project path with placeholders in macros Allows building with asserts on and still not finding any actual file paths in the final binary file. Alternative fix for https://github.com/espressif/esp-idf/issues/6306 Progress towards https://github.com/espressif/esp-idf/issues/5873 2021-02-18 16:02:23 +11:00			`Configurations where this is relevant include:`
ci: Add a test app for not placing embedded file paths into binaries Doubles as a test app that building with assertions off doesn't produce warnings. Closes https://github.com/espressif/esp-idf/issues/6306 2021-02-18 11:08:49 +11:00
config: Add new option to replace IDF_PATH and project path with placeholders in macros Allows building with asserts on and still not finding any actual file paths in the final binary file. Alternative fix for https://github.com/espressif/esp-idf/issues/6306 Progress towards https://github.com/espressif/esp-idf/issues/5873 2021-02-18 16:02:23 +11:00			`* Assertions disabled (doubles up as a build-time check that disabling assertions doesn't lead to any warnings)`
			`* Silent assertions`
			* CONFIG_COMPILER_HIDE_PATHS_MACROS is set to replace IDF_PATH and project dir with placeholders when expanding `__FILE__`
ci: Add a test app for not placing embedded file paths into binaries Doubles as a test app that building with assertions off doesn't produce warnings. Closes https://github.com/espressif/esp-idf/issues/6306 2021-02-18 11:08:49 +11:00
			`Not embedding paths reduces the binary size, avoids leaking information about`
config: Add new option to replace IDF_PATH and project path with placeholders in macros Allows building with asserts on and still not finding any actual file paths in the final binary file. Alternative fix for https://github.com/espressif/esp-idf/issues/6306 Progress towards https://github.com/espressif/esp-idf/issues/5873 2021-02-18 16:02:23 +11:00			`the compilation environment, and is a necessary step to support reproducible`
ci: Add a test app for not placing embedded file paths into binaries Doubles as a test app that building with assertions off doesn't produce warnings. Closes https://github.com/espressif/esp-idf/issues/6306 2021-02-18 11:08:49 +11:00			`builds across projects built in different directories.`