All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Nicolas Dechesne" <nicolas.dechesne@linaro.org>
To: docs@lists.yoctoproject.org
Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Subject: [PATCH 00/11] A first pass at removing labels
Date: Thu, 19 Nov 2020 10:58:23 +0100	[thread overview]
Message-ID: <20201119095834.284864-1-nicolas.dechesne@linaro.org> (raw)

During the initial (automated) migration from Docbook to Sphinx with
pandoc, a custom label was created for each section, since these
labels were used when referencing sections. However with Sphinx, we
have enable autosectionlabel extention which allows us to refer
sections its title. So the vast majority of the labels are not used,
not needed, and use valuable space in our editors ;)

This is a first pass at removing the labels. I am dealing with the
'simple' ones for now, I wanted to have all of them done before
sending the patches, but for the ref-manual, dev-manual and
overview-manual we still use many labels, so it's taking more time. I
am hoping we can merge this first series, while I continue to fix the
last manuals!

This series is made of 2 parts: first I replace some documents which
use references to a label, with their corresponding 'autosection'
label, then I am removing all labels.

All patches in the second part of this series are generated with this
command:

sed -i '/{\n/{:a;N;/\n}/!ba};/^\.\. _.*/,+1d' *.rst

And the whole series is tested with:

git rebase -i origin/master --exec "make -C documentation clean html"

And has no warnings/errors..

Nicolas Dechesne (11):
  what-i-wish-id-known: replace labels with references to section title
  sdk-manual: replace labels with references to section title
  ref-manual: replace labels with references to section title
  dev-manual: replace labels with references to section title
  kernel-dev: replace labels with references to section title
  test-manual: remove unused labels
  bsp-guide: remove unused labels
  kernel-dev: remove unused labels
  profile-manual: remove unused labels
  sdk-manual: remove unused labels
  toaster-manual: remove unused labels

 documentation/bsp-guide/bsp.rst               | 20 --------
 .../dev-manual/dev-manual-common-tasks.rst    | 15 +++---
 .../kernel-dev/kernel-dev-advanced.rst        | 12 +----
 .../kernel-dev/kernel-dev-common.rst          |  2 -
 .../kernel-dev/kernel-dev-concepts-appx.rst   |  2 -
 documentation/kernel-dev/kernel-dev-faq.rst   |  2 -
 documentation/kernel-dev/kernel-dev-intro.rst | 10 ++--
 .../profile-manual/profile-manual-intro.rst   |  4 --
 .../profile-manual/profile-manual-usage.rst   | 46 -------------------
 documentation/ref-manual/faq.rst              |  4 +-
 .../ref-manual/ref-devtool-reference.rst      |  2 +-
 .../sdk-manual/sdk-appendix-obtain.rst        |  4 +-
 documentation/sdk-manual/sdk-extensible.rst   | 44 ------------------
 documentation/sdk-manual/sdk-intro.rst        |  4 --
 documentation/sdk-manual/sdk-using.rst        |  6 ---
 .../test-manual/test-manual-intro.rst         | 22 ---------
 .../test-manual/test-manual-test-process.rst  |  2 -
 .../test-manual-understand-autobuilder.rst    | 20 --------
 .../toaster-manual/toaster-manual-intro.rst   |  4 --
 .../toaster-manual-reference.rst              | 22 ---------
 .../toaster-manual-setup-and-use.rst          | 16 -------
 .../toaster-manual/toaster-manual-start.rst   |  6 ---
 documentation/what-i-wish-id-known.rst        |  2 +-
 23 files changed, 19 insertions(+), 252 deletions(-)

-- 
2.29.2


             reply	other threads:[~2020-11-19  9:58 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-19  9:58 Nicolas Dechesne [this message]
2020-11-19  9:58 ` [PATCH 01/11] what-i-wish-id-known: replace labels with references to section title Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 02/11] sdk-manual: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 03/11] ref-manual: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 04/11] dev-manual: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 05/11] kernel-dev: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 06/11] test-manual: remove unused labels Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 07/11] bsp-guide: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 08/11] kernel-dev: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 09/11] profile-manual: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 10/11] sdk-manual: " Nicolas Dechesne
2020-11-19  9:58 ` [PATCH 11/11] toaster-manual: " Nicolas Dechesne

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=20201119095834.284864-1-nicolas.dechesne@linaro.org \
    --to=nicolas.dechesne@linaro.org \
    --cc=docs@lists.yoctoproject.org \
    /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.