From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
Subject: [PATCH 3/3] manuals: stop referring to the meta-openembedded repo from GitHub
Date: Thu, 27 Oct 2022 13:39:41 +0200 [thread overview]
Message-ID: <20221027113941.34972-3-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20221027113941.34972-1-michael.opdenacker@bootlin.com>
From: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
documentation/bsp-guide/bsp.rst | 3 +--
documentation/dev-manual/common-tasks.rst | 4 ++--
documentation/ref-manual/terms.rst | 8 +++-----
documentation/ref-manual/variables.rst | 5 ++---
4 files changed, 8 insertions(+), 12 deletions(-)
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 7e17b42886..efdaf80f63 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -109,8 +109,7 @@ them to the "Dependencies" section.
Some layers function as a layer to hold other BSP layers. These layers
are known as ":term:`container layers <Container Layer>`". An example of
-this type of layer is OpenEmbedded's
-`meta-openembedded <https://github.com/openembedded/meta-openembedded>`__
+this type of layer is OpenEmbedded's :oe_git:`meta-openbedded </meta-openembedded>`
layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers.
In cases like this, you need to include the names of the actual layers
you want to work with, such as::
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index c3defa0766..f24fa4dbb5 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -7555,8 +7555,8 @@ NPM packages:
- The NPM host tools need the native ``nodejs-npm`` package, which is
part of the OpenEmbedded environment. You need to get the package by
- cloning the https://github.com/openembedded/meta-openembedded
- repository out of GitHub. Be sure to add the path to your local copy
+ cloning the :oe_git:`meta-openembedded </meta-openembedded>`
+ repository. Be sure to add the path to your local copy
to your ``bblayers.conf`` file.
- ``devtool`` cannot detect native libraries in module dependencies.
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 1a2c055591..ee14df5684 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -138,14 +138,12 @@ universal, the list includes them just in case:
which contains multiple (and typically related) sub-layers which can
be included independently in your project's ``bblayers.conf`` file.
- In some cases, such as with OpenEmbedded's
- `meta-openembedded <https://github.com/openembedded/meta-openembedded>`__
+ In some cases, such as with OpenEmbedded's :oe_git:`meta-openembedded </meta-openembedded>`
layer, the top level ``meta-openembedded/`` directory is not itself an actual layer,
so you would never explicitly include it in a ``bblayers.conf`` file;
rather, you would include any number of its layer subdirectories, such as
- `meta-openembedded/meta-oe <https://github.com/openembedded/meta-openembedded/tree/master/meta-oe>`__,
- `meta-openembedded/meta-python <https://github.com/openembedded/meta-openembedded/tree/master/meta-python>`__
- and so on.
+ :oe_git:`meta-oe </meta-openembedded/tree/meta-oe>`, :oe_git:`meta-python
+ </meta-openembedded/tree/meta-python>` and so on.
On the other hand, some container layers (such as
:yocto_git:`meta-security </meta-security>`)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 59882fb158..1721b7fe69 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7896,9 +7896,8 @@ system and gives an overview of their function and contents.
<https://www.freedesktop.org/software/systemd/man/systemd.special.html>`__
for details.
- For example, this variable is used in the
- `core-image-minimal-xfce.bb
- <https://git.openembedded.org/meta-openembedded/tree/meta-xfce/recipes-core/images/core-image-minimal-xfce.bb>`__
+ For example, this variable is used in the :oe_git:`core-image-minimal-xfce.bb
+ </meta-openembedded/tree/meta-xfce/recipes-core/images/core-image-minimal-xfce.bb>`
recipe::
SYSTEMD_DEFAULT_TARGET = "graphical.target"
--
2.34.1
prev parent reply other threads:[~2022-10-27 11:39 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-27 11:39 [PATCH 1/3] Documentation/README: formalize guidelines for external link syntax michael.opdenacker
2022-10-27 11:39 ` [PATCH 2/3] manuals: replace "_" by "__" in external links michael.opdenacker
2022-10-27 11:39 ` michael.opdenacker [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=20221027113941.34972-3-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