doc: releases: clean up entry order #93290
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dkalowsk
previously approved these changes
Jul 17, 2025
stephanosio
previously approved these changes
Jul 18, 2025
jukkar
previously approved these changes
Jul 18, 2025
|
This can be forced with .. zephyr-keep-sorted-start re(^\w)
Title
=====
.. zephyr-keep-sorted-stopOnly lines that start with a word are taken into account. |
|
You'd still find some unsorted entries 😅:
Sorting case insensitive would require some more effort |
Great idea, thank you. Going to update PR with this, so that this gets pulled into future migration guides as well :) |
danieldegrasse
dismissed stale reviews from jukkar, stephanosio, and dkalowsk
via
e1b9873
danieldegrasse
force-pushed
the
doc/release-notes-cleanup
branch
from
0119c58 to
e1b9873
Compare
danieldegrasse
changed the title
danieldegrasse
force-pushed
the
doc/release-notes-cleanup
branch
from
e1b9873 to
d6b4741
Compare
Should be updated now- added the same sorting to release notes, where it caught several things to sort |
dleach02
reviewed
Jul 18, 2025
doc/releases/migration-guide-4.2.rst
Outdated
| @@ -164,6 +162,24 @@ Display | |||
| the format expected by Zephyr. This change ensures proper behavior of both | |||
| display and video capture samples. | |||
|
|
|||
| Eeprom | |||
There was a problem hiding this comment.
This should be all caps since it is an acronym for "electrically erasable programmable read-only memory"
Clean up order of entries in the migration guide to be alphabetical. Combine two duplicate regulator sections, and move driver sections mistakenly placed under networking where they ought to be. Signed-off-by: Daniel DeGrasse <[email protected]>
Clean up order of entries to be alphabetically sorted in the "new apis" section Signed-off-by: Daniel DeGrasse <[email protected]>
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]>
danieldegrasse
force-pushed
the
doc/release-notes-cleanup
branch
from
d6b4741 to
53ce308
Compare
pdgendt
approved these changes
Jul 18, 2025
|
dkalowsk
approved these changes
Jul 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clean up order of entries in the migration guide and release notes to be alphabetical. Combine two duplicate regulator sections, and move driver sections mistakenly placed under networking where they ought to be.
Also, add zephyr-keep-sorted entries to migration guide and release notes to keep alphabetical order enforced.
Migration guide rendered from this PR: https://builds.zephyrproject.io/zephyr/pr/93290/docs/releases/migration-guide-4.2.html