Commit 1ba95048 authored by Daniel DeGrasse's avatar Daniel DeGrasse Committed by Dan Kalowsky
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: default avatarDaniel DeGrasse <ddegrasse@tenstorrent.com>
parent f821de4d

doc/releases/migration-guide-4.2.rst

+20 −0
Original line number Diff line number Diff line
@@ -100,6 +100,8 @@ Boards 
Device Drivers and Devicetree

*****************************



.. zephyr-keep-sorted-start re(^\w)



Audio

=====
@@ -491,9 +493,13 @@ qSPI/oSPI/xSPI 
  Note that the property gives the actual size of the memory device in bits.

  Previous mapping address information is now described in xspi, ospi or qspi nodes at SoC dtsi level.



.. zephyr-keep-sorted-stop



Bluetooth

*********



.. zephyr-keep-sorted-start re(^\w)



Bluetooth Audio

===============
@@ -550,6 +556,8 @@ Bluetooth Host 
* The ``CONFIG_BT_ISO_TX_FRAG_COUNT`` Kconfig option was removed as it was completely unused.

  Any uses of it can simply be removed. (:github:`89836`)



.. zephyr-keep-sorted-stop



Networking

**********
@@ -633,6 +641,8 @@ Networking 
  the source of the DNS server information. For example when DNS server information is

  received via DHCPv4, then :c:enumerator:`DNS_SOURCE_DHCPV4` needs to be specified.



.. zephyr-keep-sorted-start re(^\w)



LwM2M

=====
@@ -738,10 +748,14 @@ OpenThread 
  * You can now use OpenThread directly, without enabling Zephyr's L2 or IEEE802.15.4 layers, if

    your use case allows.



.. zephyr-keep-sorted-stop





Other subsystems

****************



.. zephyr-keep-sorted-start re(^\w)



Modbus

======
@@ -768,9 +782,13 @@ hawkBit 
  be prepended with :kconfig:option:`CONFIG_BOARD`. It is the user's responsibility to write a

  callback that prepends the board name if needed.



.. zephyr-keep-sorted-stop



Modules

*******



.. zephyr-keep-sorted-start re(^\w)



CMSIS

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


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



.. zephyr-keep-sorted-stop



Architectures

*************

doc/releases/migration-guide-4.3.rst

+16 −0
Original line number Diff line number Diff line
@@ -32,15 +32,31 @@ Boards 
Device Drivers and Devicetree

*****************************



.. zephyr-keep-sorted-start re(^\w)



.. zephyr-keep-sorted-stop



Bluetooth

*********



.. zephyr-keep-sorted-start re(^\w)



.. zephyr-keep-sorted-stop



Networking

**********



.. zephyr-keep-sorted-start re(^\w)



.. zephyr-keep-sorted-stop



Other subsystems

****************



.. zephyr-keep-sorted-start re(^\w)



.. zephyr-keep-sorted-stop



Modules

*******

doc/releases/release-notes-4.2.rst

+3 −0
Original line number Diff line number Diff line
@@ -177,6 +177,8 @@ New APIs and options 
  like you need to add more details, add them in the API documentation code

  instead.



.. zephyr-keep-sorted-start re(^\* \w)



* Architectures



  * NIOS2 Architecture was removed from Zephyr.
@@ -486,6 +488,7 @@ New APIs and options 
  * :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_NODE_ALLOC_NONE`

  * :kconfig:option:`CONFIG_ZBUS_RUNTIME_OBSERVERS_NODE_POOL_SIZE`



.. zephyr-keep-sorted-stop



.. _boards_added_in_zephyr_4_2:

doc/releases/release-notes-4.3.rst

+4 −0
Original line number Diff line number Diff line
@@ -63,6 +63,10 @@ New APIs and options 
  like you need to add more details, add them in the API documentation code

  instead.



.. zephyr-keep-sorted-start re(^\* \w)



.. zephyr-keep-sorted-stop



New Boards

**********

CRA Git | Maintained and supported by SUSTech CRA and CCSE