alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
af5579d3f2
esp-idf/tools/cmake/project_description.json.in

34 lines
1.5 KiB
JSON
Raw Normal View History

idf.py build & flash tool Generate flasher args files & .json project info file as part of cmake build
2018-01-23 01:08:28 -05:00
{
feat(tools): export information about all components in __COMPONENT_TARGETS Add new "all_component_info" dictionary into the project_description.json file. It contains information about all registered components presented in the __COMPONENT_TARGETS list. Since components in this list are not fully evaluated, because only the first stage of cmakefiles processing is done, it does not contain the same information as the "build_component_info" dictionary. The "type", "file" and "sources" variables are missing. Most of the properties are already attached to the component target, so this only adds INCLUDE_DIRS property to the target during the first cmakefiles processing stage. The "all_component_info" dict is generated in a separate function, even though the original function for "build_component_info" could be adjusted. This introduces a little bit of boilerplate, but keeps it logically separated and probably easier if we want to extend it in the future. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-10-02 09:31:06 -04:00
"version": "1.1",
cmake: build system changes
2019-04-26 01:42:10 -04:00
"project_name": "${PROJECT_NAME}",
tools: extend information in project_description.json This extends information provided in the project_description.json file. Newly added information can be used in the SBOM generating tool and also to improve hints regarding the the component dependency issues. Added fields version: This adds versioning to the project_description.json file, so it's easy to identify if it contains the required information. project_version: Can be used as a version for the resulting binary e.g. `hello_world.bin`. idf_path: This one is probably not necessary, but it allows tools to run even without esp-idf environment exported(e.g. export.sh). c_compiler: The `CMAKE_C_COMPILER` value with full path to the compiler binary. This can be used to get information about toolchain, which was used to build the project. common_component_reqs: List of common components as presented in cmake's __COMPONENT_REQUIRES_COMMON and set in tools/cmake/build.cmake:__build_init(). build_component_info: Detailed information about components used during build. It's a dictionary with the component name as a key and each component has a dictionary with detailed information. Following is an example for the efuse component. "efuse": { "alias": "idf::efuse", "target": "___idf_efuse", "prefix": "idf", "dir": "/home/fhrbata/work/esp-idf/components/efuse", "type": "LIBRARY", "lib": "__idf_efuse", "reqs": [], "priv_reqs": [ "bootloader_support", "soc", "spi_flash" ], "managed_reqs": [], "managed_priv_reqs": [], "file": "/home/fhrbata/work/blink/build/esp-idf/efuse/libefuse.a", "sources": [ "/home/fhrbata/work/esp-idf/components/efuse/esp32s3/esp_efuse_table.c", ... ], "include_dirs": [ "include", "esp32s3/include" ] } Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-04-14 08:55:04 -04:00
"project_version": "${PROJECT_VER}",
cmake: build system changes
2019-04-26 01:42:10 -04:00
"project_path": "${PROJECT_PATH}",
tools: extend information in project_description.json This extends information provided in the project_description.json file. Newly added information can be used in the SBOM generating tool and also to improve hints regarding the the component dependency issues. Added fields version: This adds versioning to the project_description.json file, so it's easy to identify if it contains the required information. project_version: Can be used as a version for the resulting binary e.g. `hello_world.bin`. idf_path: This one is probably not necessary, but it allows tools to run even without esp-idf environment exported(e.g. export.sh). c_compiler: The `CMAKE_C_COMPILER` value with full path to the compiler binary. This can be used to get information about toolchain, which was used to build the project. common_component_reqs: List of common components as presented in cmake's __COMPONENT_REQUIRES_COMMON and set in tools/cmake/build.cmake:__build_init(). build_component_info: Detailed information about components used during build. It's a dictionary with the component name as a key and each component has a dictionary with detailed information. Following is an example for the efuse component. "efuse": { "alias": "idf::efuse", "target": "___idf_efuse", "prefix": "idf", "dir": "/home/fhrbata/work/esp-idf/components/efuse", "type": "LIBRARY", "lib": "__idf_efuse", "reqs": [], "priv_reqs": [ "bootloader_support", "soc", "spi_flash" ], "managed_reqs": [], "managed_priv_reqs": [], "file": "/home/fhrbata/work/blink/build/esp-idf/efuse/libefuse.a", "sources": [ "/home/fhrbata/work/esp-idf/components/efuse/esp32s3/esp_efuse_table.c", ... ], "include_dirs": [ "include", "esp32s3/include" ] } Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-04-14 08:55:04 -04:00
"idf_path": "${IDF_PATH}",
cmake: build system changes
2019-04-26 01:42:10 -04:00
"build_dir": "${BUILD_DIR}",
idf.py build & flash tool Generate flasher args files & .json project info file as part of cmake build
2018-01-23 01:08:28 -05:00
"config_file": "${SDKCONFIG}",
cmake: build system changes
2019-04-26 01:42:10 -04:00
"config_defaults": "${SDKCONFIG_DEFAULTS}",
tools: fixed elf symbols load if gdbinit specified ROM and bootloader symbols add to use in GDB (via 'idf.py gdb')
2022-08-20 05:36:14 -04:00
"bootloader_elf": "${BOOTLOADER_ELF_FILE}",
cmake: build system changes
2019-04-26 01:42:10 -04:00
"app_elf": "${PROJECT_EXECUTABLE}",
"app_bin": "${PROJECT_BIN}",
feature: add build framework support
2023-01-30 05:03:59 -05:00
"build_type": "${PROJECT_BUILD_TYPE}",
cmake: Add "Preview release" getting start guide & build system documentation
2018-02-21 23:05:05 -05:00
"git_revision": "${IDF_VER}",
idf.py: pass correct toolchain prefix to the monitor
2019-06-07 06:22:14 -04:00
"target": "${CONFIG_IDF_TARGET}",
Decompose idf_monitor.py
2021-02-01 05:40:03 -05:00
"rev": "${CONFIG_ESP32_REV_MIN}",
all: Apply new version logic (major * 100 + minor)
2022-03-17 09:58:15 -04:00
"min_rev": "${CONFIG_ESP_REV_MIN_FULL}",
"max_rev": "${CONFIG_ESP_REV_MAX_FULL}",
idf.py build & flash tool Generate flasher args files & .json project info file as part of cmake build
2018-01-23 01:08:28 -05:00
"phy_data_partition": "${CONFIG_ESP32_PHY_INIT_DATA_IN_PARTITION}",
idf.py: pass correct toolchain prefix to the monitor
2019-06-07 06:22:14 -04:00
"monitor_baud" : "${CONFIG_ESPTOOLPY_MONITOR_BAUD}",
cmake: using toolchain prefix determined by cmake itself
2022-01-08 01:06:43 -05:00
"monitor_toolprefix": "${_CMAKE_TOOLCHAIN_PREFIX}",
tools: extend information in project_description.json This extends information provided in the project_description.json file. Newly added information can be used in the SBOM generating tool and also to improve hints regarding the the component dependency issues. Added fields version: This adds versioning to the project_description.json file, so it's easy to identify if it contains the required information. project_version: Can be used as a version for the resulting binary e.g. `hello_world.bin`. idf_path: This one is probably not necessary, but it allows tools to run even without esp-idf environment exported(e.g. export.sh). c_compiler: The `CMAKE_C_COMPILER` value with full path to the compiler binary. This can be used to get information about toolchain, which was used to build the project. common_component_reqs: List of common components as presented in cmake's __COMPONENT_REQUIRES_COMMON and set in tools/cmake/build.cmake:__build_init(). build_component_info: Detailed information about components used during build. It's a dictionary with the component name as a key and each component has a dictionary with detailed information. Following is an example for the efuse component. "efuse": { "alias": "idf::efuse", "target": "___idf_efuse", "prefix": "idf", "dir": "/home/fhrbata/work/esp-idf/components/efuse", "type": "LIBRARY", "lib": "__idf_efuse", "reqs": [], "priv_reqs": [ "bootloader_support", "soc", "spi_flash" ], "managed_reqs": [], "managed_priv_reqs": [], "file": "/home/fhrbata/work/blink/build/esp-idf/efuse/libefuse.a", "sources": [ "/home/fhrbata/work/esp-idf/components/efuse/esp32s3/esp_efuse_table.c", ... ], "include_dirs": [ "include", "esp32s3/include" ] } Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-04-14 08:55:04 -04:00
"c_compiler": "${CMAKE_C_COMPILER}",
cmake: Write configuration & component metadata to project_description.json
2018-04-05 03:26:28 -04:00
"config_environment" : {
"COMPONENT_KCONFIGS" : "${COMPONENT_KCONFIGS}",
"COMPONENT_KCONFIGS_PROJBUILD" : "${COMPONENT_KCONFIGS_PROJBUILD}"
},
tools: extend information in project_description.json This extends information provided in the project_description.json file. Newly added information can be used in the SBOM generating tool and also to improve hints regarding the the component dependency issues. Added fields version: This adds versioning to the project_description.json file, so it's easy to identify if it contains the required information. project_version: Can be used as a version for the resulting binary e.g. `hello_world.bin`. idf_path: This one is probably not necessary, but it allows tools to run even without esp-idf environment exported(e.g. export.sh). c_compiler: The `CMAKE_C_COMPILER` value with full path to the compiler binary. This can be used to get information about toolchain, which was used to build the project. common_component_reqs: List of common components as presented in cmake's __COMPONENT_REQUIRES_COMMON and set in tools/cmake/build.cmake:__build_init(). build_component_info: Detailed information about components used during build. It's a dictionary with the component name as a key and each component has a dictionary with detailed information. Following is an example for the efuse component. "efuse": { "alias": "idf::efuse", "target": "___idf_efuse", "prefix": "idf", "dir": "/home/fhrbata/work/esp-idf/components/efuse", "type": "LIBRARY", "lib": "__idf_efuse", "reqs": [], "priv_reqs": [ "bootloader_support", "soc", "spi_flash" ], "managed_reqs": [], "managed_priv_reqs": [], "file": "/home/fhrbata/work/blink/build/esp-idf/efuse/libefuse.a", "sources": [ "/home/fhrbata/work/esp-idf/components/efuse/esp32s3/esp_efuse_table.c", ... ], "include_dirs": [ "include", "esp32s3/include" ] } Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-04-14 08:55:04 -04:00
"common_component_reqs": ${common_component_reqs_json},
cmake: Write configuration & component metadata to project_description.json
2018-04-05 03:26:28 -04:00
"build_components" : ${build_components_json},
build: create BUILD_DIR/prefix_map_gdbinit when enable reproducible build add project property BUILD_COMPONENT_DIRS
2021-10-14 08:00:05 -04:00
"build_component_paths" : ${build_component_paths_json},
tools: extend information in project_description.json This extends information provided in the project_description.json file. Newly added information can be used in the SBOM generating tool and also to improve hints regarding the the component dependency issues. Added fields version: This adds versioning to the project_description.json file, so it's easy to identify if it contains the required information. project_version: Can be used as a version for the resulting binary e.g. `hello_world.bin`. idf_path: This one is probably not necessary, but it allows tools to run even without esp-idf environment exported(e.g. export.sh). c_compiler: The `CMAKE_C_COMPILER` value with full path to the compiler binary. This can be used to get information about toolchain, which was used to build the project. common_component_reqs: List of common components as presented in cmake's __COMPONENT_REQUIRES_COMMON and set in tools/cmake/build.cmake:__build_init(). build_component_info: Detailed information about components used during build. It's a dictionary with the component name as a key and each component has a dictionary with detailed information. Following is an example for the efuse component. "efuse": { "alias": "idf::efuse", "target": "___idf_efuse", "prefix": "idf", "dir": "/home/fhrbata/work/esp-idf/components/efuse", "type": "LIBRARY", "lib": "__idf_efuse", "reqs": [], "priv_reqs": [ "bootloader_support", "soc", "spi_flash" ], "managed_reqs": [], "managed_priv_reqs": [], "file": "/home/fhrbata/work/blink/build/esp-idf/efuse/libefuse.a", "sources": [ "/home/fhrbata/work/esp-idf/components/efuse/esp32s3/esp_efuse_table.c", ... ], "include_dirs": [ "include", "esp32s3/include" ] } Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-04-14 08:55:04 -04:00
"build_component_info" : ${build_component_info_json},
feat(tools): export information about all components in __COMPONENT_TARGETS Add new "all_component_info" dictionary into the project_description.json file. It contains information about all registered components presented in the __COMPONENT_TARGETS list. Since components in this list are not fully evaluated, because only the first stage of cmakefiles processing is done, it does not contain the same information as the "build_component_info" dictionary. The "type", "file" and "sources" variables are missing. Most of the properties are already attached to the component target, so this only adds INCLUDE_DIRS property to the target during the first cmakefiles processing stage. The "all_component_info" dict is generated in a separate function, even though the original function for "build_component_info" could be adjusted. This introduces a little bit of boilerplate, but keeps it logically separated and probably easier if we want to extend it in the future. Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-10-02 09:31:06 -04:00
"all_component_info" : ${all_component_info_json},
idf.py gdb: autoload prefix_map_gdbinit when exists in project_description.json
2021-10-25 22:41:13 -04:00
"debug_prefix_map_gdbinit": "${debug_prefix_map_gdbinit}"
idf.py build & flash tool Generate flasher args files & .json project info file as part of cmake build
2018-01-23 01:08:28 -05:00
}
Reference in New Issue Copy Permalink