From 2d912d52a0423b0f913d7b23220d33b8f89c87ae Mon Sep 17 00:00:00 2001 From: Yong Cong Sin Date: Thu, 7 Dec 2023 16:28:43 +0800 Subject: [PATCH] doc: releases: add notes for namespaced generated headers Add migration notes for generated headers being namespaced to the `zephyr/` folder. Signed-off-by: Yong Cong Sin --- doc/releases/migration-guide-3.7.rst | 33 ++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/doc/releases/migration-guide-3.7.rst b/doc/releases/migration-guide-3.7.rst index fb7587ad1c5..4d3dd78a6df 100644 --- a/doc/releases/migration-guide-3.7.rst +++ b/doc/releases/migration-guide-3.7.rst @@ -22,6 +22,39 @@ Build System out-of-tree SoCs and boards to be ported to the new model. See the :ref:`hw_model_v2` for more detailed information. (:github:`69607`) +* The following build-time generated headers: + + .. list-table:: + :header-rows: 1 + + * - Affected header files + * - ``app_version.h`` + * - ``cmake_intdef.h`` + * - ``core-isa-dM.h`` + * - ``devicetree_generated.h`` + * - ``driver-validation.h`` + * - ``kobj-types-enum.h`` + * - ``linker-kobject-prebuilt-data.h`` + * - ``linker-kobject-prebuilt-priv-stacks.h`` + * - ``linker-kobject-prebuilt-rodata.h`` + * - ``mcuboot_version.h`` + * - ``offsets.h`` + * - ``otype-to-size.h`` + * - ``otype-to-str.h`` + * - ``strerror_table.h`` + * - ``strsignal_table.h`` + * - ``syscall_list.h`` + * - ``version.h`` + * - ``zsr.h`` + + and syscall headers are now namespaced into the ``zephyr/`` folder. The change is largely + automated, and the script can be found in :github:`63973`. + For the time being, the compatibility Kconfig (:kconfig:option:`CONFIG_LEGACY_GENERATED_INCLUDE_PATH`) + is enabled by default so that downstream applications will continue to compile, a warning message + will be generated during CMake configuration time. + This Kconfig will be deprecated and eventually removed in the future, developers are advised to + update the include paths of these affected headers as soon as possible. + Kernel ******