Re: [docs] [PATCH 2/2] documentation: ref-manual: force glossary output to be alphabetically sorted

Re: [docs] [PATCH 2/2] documentation: ref-manual: force glossary output to be alphabetically sorted

[Michael Opdenacker]

Hi Quentin,

Thanks for this other patch. CCing the bitbake-devel list here too.

On 7/26/21 5:29 PM, Quentin Schulz wrote:
> Even though, care should be taken to have the terms in the glossary
> sources alphabetically ordered, it is possible some terms might be in
> the wrong place.
>
> This makes sure that whatever the order of terms in the glossary
> sources, the generated medium is correctly sorted.
>
> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
> Signed-off-by: Quentin Schulz <foss@0leil.net>
> ---
>  documentation/ref-manual/terms.rst     | 1 +
>  documentation/ref-manual/variables.rst | 1 +
>  2 files changed, 2 insertions(+)
>
> diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
> index 545100efa..4d960393c 100644
> --- a/documentation/ref-manual/terms.rst
> +++ b/documentation/ref-manual/terms.rst
> @@ -9,6 +9,7 @@ development environment might find helpful. While some of these terms are
>  universal, the list includes them just in case:
>  
>  .. glossary::
> +   :sorted:
>  
>     :term:`Append Files`
>        Files that append build information to a recipe file.  Append files are
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index e5525e922..220e88db1 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -17,6 +17,7 @@ system and gives an overview of their function and contents.
>  :term:`W <WARN_QA>` :term:`X <XSERVER>`
>  
>  .. glossary::
> +   :sorted:
>  
>     :term:`ABIEXTENSION`
>        Extension to the Application Binary Interface (ABI) field of the GNU

Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>

Richard, can you merge this patch as it was sent to the [docs] mailing list?

Thanks in advance
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com