From 48748377a41a697a2b280ddbecb1c39487d1b7b8 Mon Sep 17 00:00:00 2001 From: Paul Barker Date: Fri, 27 Nov 2020 15:19:09 +0000 Subject: documentation: Simplify yocto_git links The yocto_git external link directive is modified to include the `/cgit/cgit.cgi` element of the URL so that we can simplify the links in the text. Manual links to git.yoctoproject.org are converted to use the yocto_git directive where possible. Note that this directive can't be used in some places such as example code. (From yocto-docs rev: 3a8ba5dcc783411c73fe49fb217cbc4d6528d9a7) Signed-off-by: Paul Barker Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/toaster-manual/toaster-manual-reference.rst | 15 ++++++--------- .../toaster-manual/toaster-manual-setup-and-use.rst | 4 ++-- 2 files changed, 8 insertions(+), 11 deletions(-) (limited to 'documentation/toaster-manual') diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst index 2202d599f6..ed0bad11b7 100644 --- a/documentation/toaster-manual/toaster-manual-reference.rst +++ b/documentation/toaster-manual/toaster-manual-reference.rst @@ -25,8 +25,7 @@ A layer index is a web application that contains information about a set of custom layers. A good example of an existing layer index is the OpenEmbedded Layer Index. A public instance of this layer index exists at http://layers.openembedded.org. You can find the code for this -layer index's web application at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/. +layer index's web application at :yocto_git:`/layerindex-web/`. When you tie a layer source into Toaster, it can query the layer source through a @@ -83,9 +82,8 @@ index. In the previous section, the code for the OpenEmbedded Metadata Index (i.e. http://layers.openembedded.org) was referenced. You can use -this code, which is at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/, as a -base to create your own layer index. +this code, which is at :yocto_git:`/layerindex-web/`, as a base to create +your own layer index. Use the Administration Interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -165,14 +163,13 @@ As shipped, Toaster is configured to work with the following releases: - *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* This release causes your Toaster projects to build against the head of the &DISTRO_NAME_NO_CAP; branch at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or - http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. + :yocto_git:`/poky/log/?h=&DISTRO_NAME_NO_CAP;` or + :oe_git:`/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;`. - *Yocto Project "Master" or OpenEmbedded "Master":* This release causes your Toaster Projects to build against the head of the master branch, which is where active development takes place, at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or - http://git.openembedded.org/openembedded-core/log/. + :yocto_git:`/poky/log/` or :oe_git:`/openembedded-core/log/`. - *Local Yocto Project or Local OpenEmbedded:* This release causes your Toaster Projects to build against the head of the ``poky`` or diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.rst b/documentation/toaster-manual/toaster-manual-setup-and-use.rst index b73caac375..6e2ba02531 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.rst +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.rst @@ -561,8 +561,8 @@ the same clone you are using to run Toaster. Unless you manually update this clone, your builds will always use the same Git revision. If you select any of the other release options, Toaster will fetch the -tip of your selected release from the upstream `Yocto Project -repository `__ every time you run a build. +tip of your selected release from the upstream :yocto_git:`Yocto Project +repository <>` every time you run a build. Fetching this tip effectively means that if your selected release is updated upstream, the Git revision you are using for your builds will change. If you are doing development locally, you might not want this -- cgit v1.2.3-54-g00ecf