Skip to content

Commit e7e3295

Browse files
gmarullcarlescufi
authored andcommitted
doc: release-notes: inform about the new Zephyr include prefix
Inform about the new Zephyr include prefix, mention compatibility Kconfig option and migration script. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent 0d18e91 commit e7e3295

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/releases/release-notes-3.1.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ API Changes
1919
Changes in this release
2020
=======================
2121

22+
* All Zephyr public headers have been moved to ``include/zephyr``, meaning they
23+
need to be prefixed with ``<zephyr/...>`` when included. Because this change
24+
can potentially break many applications or libraries,
25+
:kconfig:option:`CONFIG_LEGACY_INCLUDE_PATH` is provided to allow using the
26+
old include path. This option is now enabled by default to allow a smooth
27+
transition. In order to facilitate the migration to the new include prefix, a
28+
script to automate the process is also provided:
29+
:zephyr_file:`scripts/utils/migrate_includes.py`.
30+
2231
* LoRaWAN: The message type parameter in :c:func:`lorawan_send` was changed
2332
from ``uint8_t`` to ``enum lorawan_message_type``. If ``0`` was passed for
2433
unconfirmed message, this has to be changed to ``LORAWAN_MSG_UNCONFIRMED``.

0 commit comments

Comments
 (0)