From dc768a3d9d6df0cd048bf7ded4773372929f1675 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 29 Jul 2025 13:30:02 +0200 Subject: Add a script to validate documentation glossaries Instead of tracking the glossary manually, add a small script that checks if it is properly sorted. Add two comments between the start and end of the glossary for the script to know where it's located. The script also checks if the variables are properly sorted. It uses difflib and returns the diff if there's a difference between the unsorted and sorted list. Messages beginning with "WARNING:" are reported by the Autobuilder, which is the reason for this format. (From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e4d5a9c97a..6c2344950b 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7,6 +7,9 @@ Variables Glossary This chapter lists common variables used in the OpenEmbedded build system and gives an overview of their function and contents. +.. + check_glossary_begin + :term:`A ` :term:`B` :term:`C ` :term:`D` :term:`E ` :term:`F ` :term:`G ` :term:`H ` :term:`I ` @@ -16,6 +19,9 @@ system and gives an overview of their function and contents. :term:`U ` :term:`V ` :term:`W ` :term:`X ` :term:`Z ` +.. + check_glossary_end + .. glossary:: :sorted: -- cgit v1.2.3-54-g00ecf