From: "Michael Opdenacker" <michael.opdenacker@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH v2 1/3] documentation/README: improve BitBake manual referencing guidelines
Date: Tue, 27 Jul 2021 19:11:45 +0200 [thread overview]
Message-ID: <20210727171147.132288-2-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20210727171147.132288-1-michael.opdenacker@bootlin.com>
Removing the ":ref:`-D <bitbake:..." syntax as it's not necessary
Adding more and simpler ways of making references to the BitBake
manual.
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/README | 15 ++++++++++++---
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/documentation/README b/documentation/README
index f9e803a28b..fad19683c1 100644
--- a/documentation/README
+++ b/documentation/README
@@ -328,10 +328,19 @@ The sphinx.ext.intersphinx extension is enabled by default
so that we can cross reference content from other Sphinx based
documentation projects, such as the BitBake manual.
-References to the bitbake manual can be done like this:
+References to the BitBake manual can be done:
+ - With a specific description instead of the section name:
+ :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
+ - With the section name:
+ ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax` option
+ - Linking to the entire BitBake manual:
+ :doc:`BitBake User Manual <bitbake:index>`
+
+Note that a reference to a variable (:term:`VARIABLE`) automatically points to
+the BitBake manual if the variable is not described in the Reference Manual's Variable Glossary.
+However, if you need to bypass this, you can explicitely refer to a description in the
+BitBake manual as follows:
- See the ":ref:`-D <bitbake:bitbake-user-manual/bitbake-user-manual-intro:usage and syntax>`" option
-or
:term:`bitbake:BB_NUMBER_PARSE_THREADS`
Submitting documentation changes
--
2.25.1
next prev parent reply other threads:[~2021-07-27 17:12 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <1695B21F5A0B37B5.3345@lists.yoctoproject.org>
2021-07-27 17:11 ` [PATCH v2 0/3] Improve/simplify references to the BitBake manual Michael Opdenacker
2021-07-27 17:11 ` Michael Opdenacker [this message]
2021-07-27 17:11 ` [PATCH v2 2/3] manuals: simplify references to " Michael Opdenacker
2021-07-28 8:46 ` [docs] " Quentin Schulz
2021-07-28 9:13 ` Michael Opdenacker
[not found] ` <1695E98A2F617A0D.29235@lists.yoctoproject.org>
2021-07-30 16:26 ` Michael Opdenacker
2021-07-27 17:11 ` [PATCH v2 3/3] manuals: remove explicit BitBake variable references Michael Opdenacker
2021-07-28 8:48 ` [docs] [PATCH v2 0/3] Improve/simplify references to the BitBake manual Quentin Schulz
2021-07-28 9:16 ` Michael Opdenacker
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=20210727171147.132288-2-michael.opdenacker@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox