All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Nicolas Dechesne" <nicolas.dechesne@linaro.org>
To: Quentin Schulz <foss@0leil.net>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH 1/3] docs: ref-manual: ref-variables: fix one-letter pointer links in glossary
Date: Sat, 3 Oct 2020 11:20:30 +0200	[thread overview]
Message-ID: <CAP71WjwFH8uC6Atg6+noA848vwM6ax9RM258x9kfGGAub3x3hg@mail.gmail.com> (raw)
In-Reply-To: <20201003082336.55703-1-foss@0leil.net>

On Sat, Oct 3, 2020 at 10:23 AM Quentin Schulz <foss@0leil.net> wrote:
>
> Since the move to sphinx, variables aren't linked with var- anchors but
> term-.
>
> Let's fix that so clicking on a letter will bring to the correct variable
> in the page.
>
> Signed-off-by: Quentin Schulz <foss@0leil.net>
> ---
>  documentation/ref-manual/ref-variables.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
> index 2d6719df1..e238b1247 100644
> --- a/documentation/ref-manual/ref-variables.rst
> +++ b/documentation/ref-manual/ref-variables.rst
> @@ -7,14 +7,14 @@ Variables Glossary
>  This chapter lists common variables used in the OpenEmbedded build
>  system and gives an overview of their function and contents.
>
> -`A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__
> -:term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__
> -`G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__
> -`K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__
> -`N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P`
> -`R <#var-RANLIB>`__ :term:`S` :term:`T`
> -`U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__
> -`W <#var-WARN_QA>`__ `X <#var-XSERVER>`__
> +:term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>`
> +:term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FEATURE_PACKAGES>`
> +:term:`G <GCCPIE>` :term:`H <HOMEPAGE>` :term:`I <ICECC_DISABLED>`
> +:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>`
> +:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P`
> +:term:`R <RANLIB>` :term:`S` :term:`T`
> +:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>`
> +:term:`W <WARN_QA>` :term:`X <XSERVER>`

thanks. it's a good cleanup.. I am pretty sure I did it at some
point.. but i guess i never pushed it.
though i remember wondering whether we should just delete that
completely, since chances are that it won't be well maintained.. and
we have the global index anyways
https://docs.yoctoproject.org/genindex.html

alternatively, if it's really useful we could write a small extension
to generate it, that shouldn't be too hard.

>
>  .. glossary::
>
> --
> 2.26.2
>
>
> 
>

      parent reply	other threads:[~2020-10-03  9:20 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-03  8:23 [PATCH 1/3] docs: ref-manual: ref-variables: fix one-letter pointer links in glossary Quentin Schulz
2020-10-03  8:23 ` [PATCH 2/3] docs: ref-manual: ref-variables: fix alphabetical order " Quentin Schulz
2020-10-03  9:25   ` [docs] " Nicolas Dechesne
2020-10-03  8:23 ` [PATCH 3/3] docs: ref-manual: ref-variables: add links to terms " Quentin Schulz
2020-10-03  9:31   ` [docs] " Nicolas Dechesne
2020-10-03  9:20 ` Nicolas Dechesne [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAP71WjwFH8uC6Atg6+noA848vwM6ax9RM258x9kfGGAub3x3hg@mail.gmail.com \
    --to=nicolas.dechesne@linaro.org \
    --cc=docs@lists.yoctoproject.org \
    --cc=foss@0leil.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.