Harmonize sections references titles#145
Merged
vstehle merged 1 commit intoARM-software:mainfrom Aug 27, 2025
Merged
Conversation
Collaborator
Author
|
Added missing citation reference to the FF-A footnote. |
Collaborator
Author
|
Rebased. |
daniel-thompson
approved these changes
Aug 26, 2025
As we use a Sphinx extension for all our references to the UEFI specification, all those references mention the section title after the section number automatically. Among our other references written manually, some do mention the section title (FF-A) and some do not (BBR & Devicetree). Harmonize all our sections references to mention the referenced section title after the § sign and the section number. This has the benefit that references become easier to follow across revisions when updating the referenced specifications. Also, document the convention in the README. Reviewed-by: Daniel Thompson <daniel.thompson@linaro.org> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Vincent Stehlé <vincent.stehle@arm.com>
Collaborator
Author
|
Thank you @daniel-thompson and @xypron for the review; capturing in the commit message. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Please have a look and let me know if there is any veto.
I think this is clearer and worth harmonizing.