build: namespace the generated version.h

Namespaced the generated `version.h` with `zephyr` to prevent potential conflict with other headers. Write a temporary `version.h` in the old location to redirect the include and shows deprecation warning. Updated the includes path of in-tree sources accordingly. Signed-off-by: Yong Cong Sin <[email protected]>
zephyrproject-rtos · Oct 16, 2023 · fca0d73 · fca0d73
1 parent f7f8aca
commit fca0d73
Show file tree

Hide file tree

Showing 17 changed files with 28 additions and 20 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -552,17 +552,25 @@ if(ZEPHYR_GIT_INDEX)
 endif()
 
 add_custom_command(
-  OUTPUT ${PROJECT_BINARY_DIR}/include/generated/version.h
+  OUTPUT ${PROJECT_BINARY_DIR}/include/generated/zephyr/version.h
   COMMAND ${CMAKE_COMMAND} -DZEPHYR_BASE=${ZEPHYR_BASE}
-    -DOUT_FILE=${PROJECT_BINARY_DIR}/include/generated/version.h
+    -DOUT_FILE=${PROJECT_BINARY_DIR}/include/generated/zephyr/version.h
     -DVERSION_TYPE=KERNEL
     -DVERSION_FILE=${ZEPHYR_BASE}/VERSION
     -DKERNEL_VERSION_CUSTOMIZATION="${KERNEL_VERSION_CUSTOMIZATION}"
     ${build_version_argument}
     -P ${ZEPHYR_BASE}/cmake/gen_version_h.cmake
   DEPENDS ${ZEPHYR_BASE}/VERSION ${git_dependency}
 )
-add_custom_target(version_h DEPENDS ${PROJECT_BINARY_DIR}/include/generated/version.h)
+add_custom_target(version_h DEPENDS ${PROJECT_BINARY_DIR}/include/generated/zephyr/version.h)
+
+FILE(WRITE ${PROJECT_BINARY_DIR}/include/generated/version.h
+"#ifndef _DEPRECATED_KERNEL_VERSION_H_\n"
+"#define _DEPRECATED_KERNEL_VERSION_H_\n\n"
+"#include <zephyr/version.h>\n\n"
+"#warning \"<version.h> is deprecated, include <zephyr/version.h> instead\"\n\n"
+"#endif /* _DEPRECATED_KERNEL_VERSION_H_ */\n"
+)
 
 if(EXISTS ${APPLICATION_SOURCE_DIR}/VERSION)
   add_custom_command(
@@ -1882,7 +1890,7 @@ if(log_dict_db_output)
     ${ZEPHYR_BASE}/scripts/logging/dictionary/database_gen.py
     ${KERNEL_ELF_NAME}
     ${log_dict_db_output}
-    --build-header ${PROJECT_BINARY_DIR}/include/generated/version.h
+    --build-header ${PROJECT_BINARY_DIR}/include/generated/zephyr/version.h
     )
   list(APPEND
     post_build_byproducts

diff --git a/drivers/fpga/fpga_shell.c b/drivers/fpga/fpga_shell.c
@@ -6,7 +6,7 @@
 
 #include <zephyr/sys/printk.h>
 #include <zephyr/shell/shell.h>
-#include <version.h>
+#include <zephyr/version.h>
 #include <stdlib.h>
 #include <zephyr/drivers/fpga.h>
 

diff --git a/include/zephyr/usb/usb_ch9.h b/include/zephyr/usb/usb_ch9.h
@@ -12,7 +12,7 @@
  * and follows, with few exceptions, the USB Specification 2.0.
  */
 
-#include <version.h>
+#include <zephyr/version.h>
 #include <zephyr/sys/util.h>
 #include <zephyr/usb/class/usb_hub.h>
 

diff --git a/kernel/banner.c b/kernel/banner.c
@@ -7,7 +7,7 @@
 #include <zephyr/kernel.h>
 #include <zephyr/init.h>
 #include <zephyr/device.h>
-#include <version.h>
+#include <zephyr/version.h>
 
 #if defined(CONFIG_BOOT_DELAY) && (CONFIG_BOOT_DELAY > 0)
 #define DELAY_STR STRINGIFY(CONFIG_BOOT_DELAY)

diff --git a/kernel/version.c b/kernel/version.c
@@ -5,7 +5,7 @@
  */
 
 #include <zephyr/types.h>
-#include "version.h" /* generated by MAKE, at compile time */
+#include <zephyr/version.h> /* generated by MAKE, at compile time */
 
 /**
  * @brief Return the kernel version of the present build

diff --git a/lib/posix/uname.c b/lib/posix/uname.c
@@ -4,11 +4,11 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "version.h"
 #include <string.h>
 #include <zephyr/kernel.h>
 #include <zephyr/net/hostname.h>
 #include <zephyr/posix/sys/utsname.h>
+#include <zephyr/version.h>
 
 #ifdef CONFIG_NET_HOSTNAME_ENABLE
 #define UTSNAME_NODENAME CONFIG_NET_HOSTNAME

diff --git a/samples/subsys/shell/shell_module/src/main.c b/samples/subsys/shell/shell_module/src/main.c
@@ -6,7 +6,7 @@
 
 #include <zephyr/kernel.h>
 #include <zephyr/shell/shell.h>
-#include <version.h>
+#include <zephyr/version.h>
 #include <zephyr/logging/log.h>
 #include <stdlib.h>
 #include <zephyr/drivers/uart.h>

diff --git a/subsys/bindesc/bindesc_version.c b/subsys/bindesc/bindesc_version.c
@@ -6,7 +6,7 @@
 
 #include <zephyr/kernel.h>
 #include <zephyr/bindesc.h>
-#include <version.h>
+#include <zephyr/version.h>
 
 #if IS_ENABLED(CONFIG_BINDESC_KERNEL_VERSION_STRING)
 BINDESC_STR_DEFINE(kernel_version_string, BINDESC_ID_KERNEL_VERSION_STRING,

diff --git a/subsys/bluetooth/controller/hci/hci.c b/subsys/bluetooth/controller/hci/hci.c
@@ -8,7 +8,6 @@
 #include <stddef.h>
 #include <string.h>
 
-#include <version.h>
 #include <errno.h>
 
 #include <zephyr/sys/util.h>
@@ -20,6 +19,7 @@
 #include <zephyr/bluetooth/hci_types.h>
 #include <zephyr/bluetooth/hci_vs.h>
 #include <zephyr/bluetooth/buf.h>
+#include <zephyr/version.h>
 
 #include "../host/hci_ecc.h"
 

diff --git a/subsys/mgmt/mcumgr/grp/os_mgmt/src/os_mgmt.c b/subsys/mgmt/mcumgr/grp/os_mgmt/src/os_mgmt.c
@@ -35,7 +35,7 @@
 
 #if defined(CONFIG_MCUMGR_GRP_OS_INFO) || defined(CONFIG_MCUMGR_GRP_OS_BOOTLOADER_INFO)
 #include <stdio.h>
-#include <version.h>
+#include <zephyr/version.h>
 #if defined(CONFIG_MCUMGR_GRP_OS_INFO)
 #include <os_mgmt_processor.h>
 #endif

diff --git a/subsys/net/l2/openthread/openthread.c b/subsys/net/l2/openthread/openthread.c
@@ -19,7 +19,7 @@ LOG_MODULE_REGISTER(net_l2_openthread, CONFIG_OPENTHREAD_L2_LOG_LEVEL);
 #include <zephyr/sys/slist.h>
 #include <zephyr/sys/util.h>
 #include <zephyr/sys/__assert.h>
-#include <version.h>
+#include <zephyr/version.h>
 
 #include <openthread/cli.h>
 #include <openthread/ip6.h>

diff --git a/tests/kernel/common/src/main.c b/tests/kernel/common/src/main.c
@@ -8,7 +8,7 @@
 #include <zephyr/ztest.h>
 #include <zephyr/kernel_version.h>
 #include <zephyr/sys/speculation.h>
-#include "version.h"
+#include <zephyr/version.h>
 
 /**
  * @defgroup kernel_common_tests Common Tests

diff --git a/tests/subsys/bindesc/definition/src/main.c b/tests/subsys/bindesc/definition/src/main.c
@@ -6,7 +6,7 @@
 
 #include <zephyr/ztest.h>
 #include <zephyr/bindesc.h>
-#include <version.h>
+#include <zephyr/version.h>
 
 #define STR_ID 1
 #define UINT_ID 2

diff --git a/tests/subsys/mgmt/mcumgr/cb_notifications/src/main.c b/tests/subsys/mgmt/mcumgr/cb_notifications/src/main.c
@@ -10,11 +10,11 @@
 #include <zephyr/mgmt/mcumgr/transport/smp_dummy.h>
 #include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
 #include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>
+#include <zephyr/version.h>
 #include <zcbor_common.h>
 #include <zcbor_decode.h>
 #include <zcbor_encode.h>
 #include <mgmt/mcumgr/util/zcbor_bulk.h>
-#include <version.h>
 #include <string.h>
 #include <smp_internal.h>
 #include "smp_test_util.h"

diff --git a/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/build_date.c b/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/build_date.c
@@ -13,12 +13,12 @@
 #include <zephyr/mgmt/mcumgr/transport/smp_dummy.h>
 #include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
 #include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>
+#include <zephyr/version.h>
 #include <os_mgmt_processor.h>
 #include <zcbor_common.h>
 #include <zcbor_decode.h>
 #include <zcbor_encode.h>
 #include <mgmt/mcumgr/util/zcbor_bulk.h>
-#include <version.h>
 #include <smp_internal.h>
 #include "smp_test_util.h"
 

diff --git a/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/limited.c b/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/limited.c
@@ -12,12 +12,12 @@
 #include <zephyr/mgmt/mcumgr/transport/smp_dummy.h>
 #include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
 #include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>
+#include <zephyr/version.h>
 #include <os_mgmt_processor.h>
 #include <zcbor_common.h>
 #include <zcbor_decode.h>
 #include <zcbor_encode.h>
 #include <mgmt/mcumgr/util/zcbor_bulk.h>
-#include <version.h>
 #include <string.h>
 #include <smp_internal.h>
 #include "smp_test_util.h"

diff --git a/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/main.c b/tests/subsys/mgmt/mcumgr/os_mgmt_info/src/main.c
@@ -12,12 +12,12 @@
 #include <zephyr/mgmt/mcumgr/transport/smp_dummy.h>
 #include <zephyr/mgmt/mcumgr/mgmt/callbacks.h>
 #include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt.h>
+#include <zephyr/version.h>
 #include <os_mgmt_processor.h>
 #include <zcbor_common.h>
 #include <zcbor_decode.h>
 #include <zcbor_encode.h>
 #include <mgmt/mcumgr/util/zcbor_bulk.h>
-#include <version.h>
 #include <string.h>
 #include <smp_internal.h>
 #include "smp_test_util.h"