esp-idf/tools/cmake/project_description.json.in

30 lines
1.3 KiB
JSON
Raw Normal View History

{
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-06-08 11:31:42 -04:00
"version": "1",
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-06-08 11:31:42 -04:00
"project_version": "${PROJECT_VER}",
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-06-08 11:31:42 -04:00
"idf_path": "${IDF_PATH}",
2019-04-26 01:42:10 -04:00
"build_dir": "${BUILD_DIR}",
"config_file": "${SDKCONFIG}",
2019-04-26 01:42:10 -04:00
"config_defaults": "${SDKCONFIG_DEFAULTS}",
"app_elf": "${PROJECT_EXECUTABLE}",
"app_bin": "${PROJECT_BIN}",
"git_revision": "${IDF_VER}",
"target": "${CONFIG_IDF_TARGET}",
2021-02-01 05:40:03 -05:00
"rev": "${CONFIG_ESP32_REV_MIN}",
"min_rev": "${CONFIG_ESP_REV_MIN_FULL}",
"max_rev": "${CONFIG_ESP_REV_MAX_FULL}",
"phy_data_partition": "${CONFIG_ESP32_PHY_INIT_DATA_IN_PARTITION}",
"monitor_baud" : "${CONFIG_ESPTOOLPY_MONITOR_BAUD}",
"monitor_toolprefix": "${CONFIG_SDK_TOOLPREFIX}",
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-06-08 11:31:42 -04:00
"c_compiler": "${CMAKE_C_COMPILER}",
"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-06-08 11:31:42 -04:00
"common_component_reqs": ${common_component_reqs_json},
"build_components" : ${build_components_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-06-08 11:31:42 -04:00
"build_component_paths" : ${build_component_paths_json},
"build_component_info" : ${build_component_info_json}
}