diff options
author | Paul Barker <pbarker@konsulko.com> | 2020-11-27 15:19:09 +0000 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-03 12:04:21 +0000 |
commit | 48748377a41a697a2b280ddbecb1c39487d1b7b8 (patch) | |
tree | 256c470487c98c810fbb28ab4973d7180ac23baf /documentation/toaster-manual | |
parent | 8faafa99cc9a45c1920ec3ea696a9ec7fb653194 (diff) | |
download | poky-48748377a41a697a2b280ddbecb1c39487d1b7b8.tar.gz |
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 <pbarker@konsulko.com>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r-- | documentation/toaster-manual/toaster-manual-reference.rst | 15 | ||||
-rw-r--r-- | documentation/toaster-manual/toaster-manual-setup-and-use.rst | 4 |
2 files changed, 8 insertions, 11 deletions
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 | |||
25 | of custom layers. A good example of an existing layer index is the | 25 | of custom layers. A good example of an existing layer index is the |
26 | OpenEmbedded Layer Index. A public instance of this layer index exists | 26 | OpenEmbedded Layer Index. A public instance of this layer index exists |
27 | at http://layers.openembedded.org. You can find the code for this | 27 | at http://layers.openembedded.org. You can find the code for this |
28 | layer index's web application at | 28 | layer index's web application at :yocto_git:`/layerindex-web/`. |
29 | http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/. | ||
30 | 29 | ||
31 | When you tie a layer source into Toaster, it can query the layer source | 30 | When you tie a layer source into Toaster, it can query the layer source |
32 | through a | 31 | through a |
@@ -83,9 +82,8 @@ index. | |||
83 | 82 | ||
84 | In the previous section, the code for the OpenEmbedded Metadata Index | 83 | In the previous section, the code for the OpenEmbedded Metadata Index |
85 | (i.e. http://layers.openembedded.org) was referenced. You can use | 84 | (i.e. http://layers.openembedded.org) was referenced. You can use |
86 | this code, which is at | 85 | this code, which is at :yocto_git:`/layerindex-web/`, as a base to create |
87 | http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/, as a | 86 | your own layer index. |
88 | base to create your own layer index. | ||
89 | 87 | ||
90 | Use the Administration Interface | 88 | Use the Administration Interface |
91 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 89 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
@@ -165,14 +163,13 @@ As shipped, Toaster is configured to work with the following releases: | |||
165 | - *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* | 163 | - *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* |
166 | This release causes your Toaster projects to build against the head | 164 | This release causes your Toaster projects to build against the head |
167 | of the &DISTRO_NAME_NO_CAP; branch at | 165 | of the &DISTRO_NAME_NO_CAP; branch at |
168 | https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or | 166 | :yocto_git:`/poky/log/?h=&DISTRO_NAME_NO_CAP;` or |
169 | http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. | 167 | :oe_git:`/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;`. |
170 | 168 | ||
171 | - *Yocto Project "Master" or OpenEmbedded "Master":* This release | 169 | - *Yocto Project "Master" or OpenEmbedded "Master":* This release |
172 | causes your Toaster Projects to build against the head of the master | 170 | causes your Toaster Projects to build against the head of the master |
173 | branch, which is where active development takes place, at | 171 | branch, which is where active development takes place, at |
174 | https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or | 172 | :yocto_git:`/poky/log/` or :oe_git:`/openembedded-core/log/`. |
175 | http://git.openembedded.org/openembedded-core/log/. | ||
176 | 173 | ||
177 | - *Local Yocto Project or Local OpenEmbedded:* This release causes your | 174 | - *Local Yocto Project or Local OpenEmbedded:* This release causes your |
178 | Toaster Projects to build against the head of the ``poky`` or | 175 | 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 | |||
561 | this clone, your builds will always use the same Git revision. | 561 | this clone, your builds will always use the same Git revision. |
562 | 562 | ||
563 | If you select any of the other release options, Toaster will fetch the | 563 | If you select any of the other release options, Toaster will fetch the |
564 | tip of your selected release from the upstream `Yocto Project | 564 | tip of your selected release from the upstream :yocto_git:`Yocto Project |
565 | repository <https://git.yoctoproject.org>`__ every time you run a build. | 565 | repository <>` every time you run a build. |
566 | Fetching this tip effectively means that if your selected release is | 566 | Fetching this tip effectively means that if your selected release is |
567 | updated upstream, the Git revision you are using for your builds will | 567 | updated upstream, the Git revision you are using for your builds will |
568 | change. If you are doing development locally, you might not want this | 568 | change. If you are doing development locally, you might not want this |