Skip to content

Commit 2838fb8

Browse files
kartbencfriedt
authored andcommitted
doc: releases: introduce release notes and migration guide docs for 4.4
This introduces the release notes and migration guide for Zephyr 4.4.0 earlier so that people have a placeholder to start adding content as they line up pull requests for the 4.4 release. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 3af17bf commit 2838fb8

File tree

2 files changed

+156
-0
lines changed

2 files changed

+156
-0
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
:orphan:
2+
3+
..
4+
See
5+
https://docs.zephyrproject.org/latest/releases/index.html#migration-guides
6+
for details of what is supposed to go into this document.
7+
8+
.. _migration_4.4:
9+
10+
Migration guide to Zephyr v4.4.0 (Working Draft)
11+
################################################
12+
13+
This document describes the changes required when migrating your application from Zephyr v4.3.0 to
14+
Zephyr v4.4.0.
15+
16+
Any other changes (not directly related to migrating applications) can be found in
17+
the :ref:`release notes<zephyr_4.4>`.
18+
19+
.. contents::
20+
:local:
21+
:depth: 2
22+
23+
Build System
24+
************
25+
26+
Kernel
27+
******
28+
29+
Boards
30+
******
31+
32+
Device Drivers and Devicetree
33+
*****************************
34+
35+
Bluetooth
36+
*********
37+
38+
Networking
39+
**********
40+
41+
Other subsystems
42+
****************
43+
44+
Modules
45+
*******
46+
47+
Architectures
48+
*************

doc/releases/release-notes-4.4.rst

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
:orphan:
2+
3+
..
4+
What goes here: removed/deprecated apis, new boards, new drivers, notable
5+
features. If you feel like something new can be useful to a user, put it
6+
under "Other Enhancements" in the first paragraph, if you feel like something
7+
is worth mentioning in the project media (release blog post, release
8+
livestream) put it under "Major enhancement".
9+
..
10+
If you are describing a feature or functionality, consider adding it to the
11+
actual project documentation rather than the release notes, so that the
12+
information does not get lost in time.
13+
..
14+
No list of bugfixes, minor changes, those are already in the git log, this is
15+
not a changelog.
16+
..
17+
Does the entry have a link that contains the details? Just add the link, if
18+
you think it needs more details, put them in the content that shows up on the
19+
link.
20+
..
21+
Are you thinking about generating this? Don't put anything at all.
22+
..
23+
Does the thing require the user to change their application? Put it on the
24+
migration guide instead. (TODO: move the removed APIs section in the
25+
migration guide)
26+
27+
.. _zephyr_4.4:
28+
29+
Zephyr 4.4.0 (Working Draft)
30+
############################
31+
32+
We are pleased to announce the release of Zephyr version 4.4.0.
33+
34+
Major enhancements with this release include:
35+
36+
An overview of the changes required or recommended when migrating your application from Zephyr
37+
v4.3.0 to Zephyr v4.4.0 can be found in the separate :ref:`migration guide<migration_4.4>`.
38+
39+
The following sections provide detailed lists of changes by component.
40+
41+
Security Vulnerability Related
42+
******************************
43+
44+
API Changes
45+
***********
46+
47+
..
48+
Only removed, deprecated and new APIs. Changes go in migration guide.
49+
50+
Removed APIs and options
51+
========================
52+
53+
Deprecated APIs and options
54+
===========================
55+
56+
New APIs and options
57+
====================
58+
59+
..
60+
Link to new APIs here, in a group if you think it's necessary, no need to get
61+
fancy just list the link, that should contain the documentation. If you feel
62+
like you need to add more details, add them in the API documentation code
63+
instead.
64+
65+
.. zephyr-keep-sorted-start re(^\* \w)
66+
67+
68+
.. zephyr-keep-sorted-stop
69+
70+
New Boards
71+
**********
72+
73+
..
74+
You may update this list as you contribute a new board during the release cycle, in order to make
75+
it visible to people who might be looking at the working draft of the release notes. However, note
76+
that this list will be recomputed at the time of the release, so you don't *have* to update it.
77+
In any case, just link the board, further details go in the board description.
78+
79+
New Shields
80+
***********
81+
82+
..
83+
Same as above, this will also be recomputed at the time of the release.
84+
85+
New Drivers
86+
***********
87+
88+
..
89+
Same as above, this will also be recomputed at the time of the release.
90+
Just link the driver, further details go in the binding description
91+
92+
New Samples
93+
***********
94+
95+
..
96+
Same as above, this will also be recomputed at the time of the release.
97+
Just link the sample, further details go in the sample documentation itself.
98+
99+
100+
Libraries / Subsystems
101+
**********************
102+
103+
Other notable changes
104+
*********************
105+
106+
..
107+
Any more descriptive subsystem or driver changes. Do you really want to write
108+
a paragraph or is it enough to link to the api/driver/Kconfig/board page above?

0 commit comments

Comments
 (0)