From 93d479d11e956969e3a5d3c7aad0cd12f35ea158 Mon Sep 17 00:00:00 2001 From: Martin Hoff Date: Wed, 9 Jul 2025 08:25:19 +0200 Subject: [PATCH] doc: releases: introduce release notes and migration guide docs for 4.3 This introduces the release notes and migration guide for Zephyr 4.3.0 earlier so that people have a placeholder to start adding content as they line up pull requests for the 4.3 release. Signed-off-by: Martin Hoff --- doc/releases/migration-guide-4.3.rst | 48 ++++++++++++++ doc/releases/release-notes-4.3.rst | 94 ++++++++++++++++++++++++++++ 2 files changed, 142 insertions(+) create mode 100644 doc/releases/migration-guide-4.3.rst create mode 100644 doc/releases/release-notes-4.3.rst diff --git a/doc/releases/migration-guide-4.3.rst b/doc/releases/migration-guide-4.3.rst new file mode 100644 index 0000000000000..f668d9ef6f561 --- /dev/null +++ b/doc/releases/migration-guide-4.3.rst @@ -0,0 +1,48 @@ +:orphan: + +.. + See + https://docs.zephyrproject.org/latest/releases/index.html#migration-guides + for details of what is supposed to go into this document. + +.. _migration_4.3: + +Migration guide to Zephyr v4.3.0 (Working Draft) +################################################ + +This document describes the changes required when migrating your application from Zephyr v4.2.0 to +Zephyr v4.3.0. + +Any other changes (not directly related to migrating applications) can be found in +the :ref:`release notes`. + +.. contents:: + :local: + :depth: 2 + +Build System +************ + +Kernel +****** + +Boards +****** + +Device Drivers and Devicetree +***************************** + +Bluetooth +********* + +Networking +********** + +Other subsystems +**************** + +Modules +******* + +Architectures +************* diff --git a/doc/releases/release-notes-4.3.rst b/doc/releases/release-notes-4.3.rst new file mode 100644 index 0000000000000..71aea3a12018e --- /dev/null +++ b/doc/releases/release-notes-4.3.rst @@ -0,0 +1,94 @@ +:orphan: + +.. + What goes here: removed/deprecated apis, new boards, new drivers, notable + features. If you feel like something new can be useful to a user, put it + under "Other Enhancements" in the first paragraph, if you feel like something + is worth mentioning in the project media (release blog post, release + livestream) put it under "Major enhancement". +.. + If you are describing a feature or functionality, consider adding it to the + actual project documentation rather than the release notes, so that the + information does not get lost in time. +.. + No list of bugfixes, minor changes, those are already in the git log, this is + not a changelog. +.. + Does the entry have a link that contains the details? Just add the link, if + you think it needs more details, put them in the content that shows up on the + link. +.. + Are you thinking about generating this? Don't put anything at all. +.. + Does the thing require the user to change their application? Put it on the + migration guide instead. (TODO: move the removed APIs section in the + migration guide) + +.. _zephyr_4.3: + +Zephyr 4.3.0 (Working Draft) +############################ + +We are pleased to announce the release of Zephyr version 4.3.0. + +Major enhancements with this release include: + +An overview of the changes required or recommended when migrating your application from Zephyr +v4.2.0 to Zephyr v4.3.0 can be found in the separate :ref:`migration guide`. + +The following sections provide detailed lists of changes by component. + +Security Vulnerability Related +****************************** +The following CVEs are addressed by this release: + +More detailed information can be found in: +https://docs.zephyrproject.org/latest/security/vulnerabilities.html + +API Changes +*********** + +Removed APIs and options +======================== + +Deprecated APIs and options +=========================== + +New APIs and options +==================== + +.. + Link to new APIs here, in a group if you think it's necessary, no need to get + fancy just list the link, that should contain the documentation. If you feel + like you need to add more details, add them in the API documentation code + instead. + +New Boards +********** + +.. + You may update this list as you contribute a new board during the release cycle, in order to make + it visible to people who might be looking at the working draft of the release notes. However, note + that this list will be recomputed at the time of the release, so you don't *have* to update it. + In any case, just link the board, further details go in the board description. + +New Drivers +*********** + +.. + Same as above for boards, this will also be recomputed at the time of the release. + Just link the driver, further details go in the binding description + +New Samples +*********** + +.. + Same as above for boards and drivers, this will also be recomputed at the time of the release. + Just link the sample, further details go in the sample documentation itself. + +Other notable changes +********************* + +.. + Any more descriptive subsystem or driver changes. Do you really want to write + a paragraph or is it enough to link to the api/driver/Kconfig/board page above?