Skip to content

Commit e1b9873

Browse files
doc: releases: enforce sorting of entries
Enforce sorting of entries, using zephyr-keep-sorted. This will make sure that entries don't get out of order again within the release notes or migration guide by throwing a compliance error. Note that autogenerated areas do not have this enforcement enabled. Signed-off-by: Daniel DeGrasse <[email protected]>
1 parent 2a1b99c commit e1b9873

File tree

4 files changed

+43
-0
lines changed

4 files changed

+43
-0
lines changed

doc/releases/migration-guide-4.2.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ Boards
100100
Device Drivers and Devicetree
101101
*****************************
102102

103+
.. zephyr-keep-sorted-start re(^\w)
104+
103105
Audio
104106
=====
105107

@@ -491,9 +493,13 @@ qSPI/oSPI/xSPI
491493
Note that the property gives the actual size of the memory device in bits.
492494
Previous mapping address information is now described in xspi, ospi or qspi nodes at SoC dtsi level.
493495

496+
.. zephyr-keep-sorted-stop
497+
494498
Bluetooth
495499
*********
496500

501+
.. zephyr-keep-sorted-start re(^\w)
502+
497503
Bluetooth Audio
498504
===============
499505

@@ -550,6 +556,8 @@ Bluetooth Host
550556
* The ``CONFIG_BT_ISO_TX_FRAG_COUNT`` Kconfig option was removed as it was completely unused.
551557
Any uses of it can simply be removed. (:github:`89836`)
552558

559+
.. zephyr-keep-sorted-stop
560+
553561
Networking
554562
**********
555563

@@ -633,6 +641,8 @@ Networking
633641
the source of the DNS server information. For example when DNS server information is
634642
received via DHCPv4, then :c:enumerator:`DNS_SOURCE_DHCPV4` needs to be specified.
635643

644+
.. zephyr-keep-sorted-start re(^\w)
645+
636646
LwM2M
637647
=====
638648

@@ -738,10 +748,14 @@ OpenThread
738748
* You can now use OpenThread directly, without enabling Zephyr's L2 or IEEE802.15.4 layers, if
739749
your use case allows.
740750

751+
.. zephyr-keep-sorted-stop
752+
741753
742754
Other subsystems
743755
****************
744756

757+
.. zephyr-keep-sorted-start re(^\w)
758+
745759
Modbus
746760
======
747761

@@ -768,9 +782,13 @@ hawkBit
768782
be prepended with :kconfig:option:`CONFIG_BOARD`. It is the user's responsibility to write a
769783
callback that prepends the board name if needed.
770784

785+
.. zephyr-keep-sorted-stop
786+
771787
Modules
772788
*******
773789

790+
.. zephyr-keep-sorted-start re(^\w)
791+
774792
CMSIS
775793
=====
776794

@@ -785,6 +803,8 @@ CMSIS
785803

786804
Note: Zephyr will continue using the older ``cmsis`` module for Cortex-A and Cortex-R targets.
787805

806+
.. zephyr-keep-sorted-stop
807+
788808
Architectures
789809
*************
790810

doc/releases/migration-guide-4.3.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,31 @@ Boards
3232
Device Drivers and Devicetree
3333
*****************************
3434

35+
.. zephyr-keep-sorted-start re(^\w)
36+
37+
.. zephyr-keep-sorted-stop
38+
3539
Bluetooth
3640
*********
3741

42+
.. zephyr-keep-sorted-start re(^\w)
43+
44+
.. zephyr-keep-sorted-stop
45+
3846
Networking
3947
**********
4048

49+
.. zephyr-keep-sorted-start re(^\w)
50+
51+
.. zephyr-keep-sorted-stop
52+
4153
Other subsystems
4254
****************
4355

56+
.. zephyr-keep-sorted-start re(^\w)
57+
58+
.. zephyr-keep-sorted-stop
59+
4460
Modules
4561
*******
4662

doc/releases/release-notes-4.2.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,8 @@ New APIs and options
163163
like you need to add more details, add them in the API documentation code
164164
instead.
165165
166+
.. zephyr-keep-sorted-start re(^\* \w)
167+
166168
* Architectures
167169

168170
* NIOS2 Architecture was removed from Zephyr.
@@ -462,6 +464,7 @@ New APIs and options
462464
* :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_NODE_ALLOC_NONE`
463465
* :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_NODE_POOL_SIZE`
464466

467+
.. zephyr-keep-sorted-stop
465468
466469
* Other
467470

doc/releases/release-notes-4.3.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ New APIs and options
6363
like you need to add more details, add them in the API documentation code
6464
instead.
6565
66+
.. zephyr-keep-sorted-start re(^\* \w)
67+
68+
.. zephyr-keep-sorted-stop
69+
6670
New Boards
6771
**********
6872

0 commit comments

Comments
 (0)