zephyr/cmake/modules/generated_file_directories....

# SPDX-License-Identifier: Apache-2.0

include_guard(GLOBAL)

# This file creates locations in the build directory
# for placing generated files.
#
# Outcome:
# - BINARY_DIR_INCLUDE is set to ${PROJECT_BINARY_DIR}/include
# - BINARY_DIR_INCLUDE_GENERATED is set to ${BINARY_DIR_INCLUDE}/generated
# - BINARY_DIR_INCLUDE_GENERATED is a directory
#
# Required variables:
# None
#
# Optional variables:
# None
#
# Optional environment variables:
# None

set(BINARY_DIR_INCLUDE ${PROJECT_BINARY_DIR}/include)
set(BINARY_DIR_INCLUDE_GENERATED ${BINARY_DIR_INCLUDE}/generated)
file(MAKE_DIRECTORY ${BINARY_DIR_INCLUDE_GENERATED})
cmake: modules: add generated_file_directories Due to Hyrum's Law, there are users out in the wild depending on this directory existing to place their own generated files, so it'd break things unnecessarily to not do this if we don't have a DTS, as explained in a source code comment. However, this doesn't really have anything to do with DTS processing, so split it into its own module to separate concerns. This isn't really a CMake module in the usual sense of something that defines functions you can use, and is therefore a form of technical debt. The decision was made to accept this because fixing this is a larger task for the files in cmake/modules/, since there are multiple other examples of this in here. This also paves the way for inserting another module in between the generated_file_directories and dts modules that itself depends on these directories existing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2023-02-28 06:27:28 +08:00			`# SPDX-License-Identifier: Apache-2.0`

			`include_guard(GLOBAL)`

			`# This file creates locations in the build directory`
			`# for placing generated files.`
			`#`
			`# Outcome:`
			`# - BINARY_DIR_INCLUDE is set to ${PROJECT_BINARY_DIR}/include`
			`# - BINARY_DIR_INCLUDE_GENERATED is set to ${BINARY_DIR_INCLUDE}/generated`
			`# - BINARY_DIR_INCLUDE_GENERATED is a directory`
			`#`
			`# Required variables:`
			`# None`
			`#`
			`# Optional variables:`
			`# None`
			`#`
			`# Optional environment variables:`
			`# None`

cmake: modules: generated_file_directories: fix paths The paths that got assigned to these variable don't quite match the description, likely a typo, fix that. Signed-off-by: Yong Cong Sin <ycsin@meta.com> 2024-01-30 14:27:25 +08:00			`set(BINARY_DIR_INCLUDE ${PROJECT_BINARY_DIR}/include)`
			`set(BINARY_DIR_INCLUDE_GENERATED ${BINARY_DIR_INCLUDE}/generated)`
cmake: modules: add generated_file_directories Due to Hyrum's Law, there are users out in the wild depending on this directory existing to place their own generated files, so it'd break things unnecessarily to not do this if we don't have a DTS, as explained in a source code comment. However, this doesn't really have anything to do with DTS processing, so split it into its own module to separate concerns. This isn't really a CMake module in the usual sense of something that defines functions you can use, and is therefore a form of technical debt. The decision was made to accept this because fixing this is a larger task for the files in cmake/modules/, since there are multiple other examples of this in here. This also paves the way for inserting another module in between the generated_file_directories and dts modules that itself depends on these directories existing. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no> 2023-02-28 06:27:28 +08:00			`file(MAKE_DIRECTORY ${BINARY_DIR_INCLUDE_GENERATED})`