| Message ID | 20250729-variables-checks-v1-0-5ad6ca9b9386@bootlin.com |
|---|---|
| Headers | show |
| Series | Add checks for glossaries correctness | expand |
On Tue, 29 Jul 2025 13:30:01 +0200, Antonin Godard wrote: > Instead of having to manually check if the glossary is up-to-date, add a > checks rule to the Makefile that performs basic checks on > documentation/ref-manual/variables.rst and > documentation/ref-manual/terms.rst. The > documentation/scripts/check-glossaries script checks that the glossary > is up-to-date (there's only one in variables.rst), and that the list of > terms/variables are properly sorted. > > [...] Applied, thanks! [1/5] Add a script to validate documentation glossaries commit: 416d50c0c322eb88bf13353a198db7211e4d665a [2/5] Makefile: add a checks rule commit: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf [3/5] ref-manual/variables.rst: fix the glossary commit: 4d3952414d109f9c9ebb029f3e20018664eacc86 [4/5] ref-manual/variables.rst: sort variables commit: 5cc4f262844a202553112a01f7203c9220d30fae [5/5] ref-manual/terms.rst: sort entries commit: e3c05f82596239c12dcb9871e6dac434c46bacec Best regards,
Instead of having to manually check if the glossary is up-to-date, add a checks rule to the Makefile that performs basic checks on documentation/ref-manual/variables.rst and documentation/ref-manual/terms.rst. The documentation/scripts/check-glossaries script checks that the glossary is up-to-date (there's only one in variables.rst), and that the list of terms/variables are properly sorted. This series was based on: https://lore.kernel.org/r/20250729-release-note-5-3-first-bunch-v1-0-058971e37c93@bootlin.com And so depends on it. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- Antonin Godard (5): Add a script to validate documentation glossaries Makefile: add a checks rule ref-manual/variables.rst: fix the glossary ref-manual/variables.rst: sort variables ref-manual/terms.rst: sort entries documentation/Makefile | 5 +- documentation/ref-manual/terms.rst | 26 ++-- documentation/ref-manual/variables.rst | 268 +++++++++++++++++---------------- documentation/tools/check-glossaries | 90 +++++++++++ 4 files changed, 244 insertions(+), 145 deletions(-) --- base-commit: 31b137092915f23ad25178b2d08845a9a01d6b02 change-id: 20250528-variables-checks-0adf80bf6720 Best regards, -- Antonin Godard <antonin.godard@bootlin.com>