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/ref-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/ref-manual')
-rw-r--r-- | documentation/ref-manual/migration-1.3.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-1.6.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.2.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.3.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.5.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/migration-3.0.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-classes.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-devtool-reference.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-tasks.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-terms.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 2 |
11 files changed, 16 insertions, 16 deletions
diff --git a/documentation/ref-manual/migration-1.3.rst b/documentation/ref-manual/migration-1.3.rst index 5f975850ba..12e225b149 100644 --- a/documentation/ref-manual/migration-1.3.rst +++ b/documentation/ref-manual/migration-1.3.rst | |||
@@ -173,7 +173,7 @@ the OpenEmbedded community layers such as ``meta-oe`` and | |||
173 | ``meta-gnome``. For the remainder, you can now find them in the | 173 | ``meta-gnome``. For the remainder, you can now find them in the |
174 | ``meta-extras`` repository, which is in the | 174 | ``meta-extras`` repository, which is in the |
175 | :yocto_git:`Source Repositories <>` at | 175 | :yocto_git:`Source Repositories <>` at |
176 | :yocto_git:`/cgit/cgit.cgi/meta-extras/`. | 176 | :yocto_git:`/meta-extras/`. |
177 | 177 | ||
178 | .. _1.3-linux-kernel-naming: | 178 | .. _1.3-linux-kernel-naming: |
179 | 179 | ||
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst index a6c4c8a93a..822d5cfa03 100644 --- a/documentation/ref-manual/migration-1.6.rst +++ b/documentation/ref-manual/migration-1.6.rst | |||
@@ -411,6 +411,6 @@ The previous reference BSPs for the ``beagleboard`` and | |||
411 | ``routerstationpro`` machines are still available in a new | 411 | ``routerstationpro`` machines are still available in a new |
412 | ``meta-yocto-bsp-old`` layer in the | 412 | ``meta-yocto-bsp-old`` layer in the |
413 | :yocto_git:`Source Repositories <>` at | 413 | :yocto_git:`Source Repositories <>` at |
414 | :yocto_git:`/cgit/cgit.cgi/meta-yocto-bsp-old/`. | 414 | :yocto_git:`/meta-yocto-bsp-old/`. |
415 | 415 | ||
416 | 416 | ||
diff --git a/documentation/ref-manual/migration-2.2.rst b/documentation/ref-manual/migration-2.2.rst index 8afa8ffdda..ac247dce46 100644 --- a/documentation/ref-manual/migration-2.2.rst +++ b/documentation/ref-manual/migration-2.2.rst | |||
@@ -292,9 +292,9 @@ The following changes took place for BitBake: | |||
292 | functionality. These changes will affect external tools that use | 292 | functionality. These changes will affect external tools that use |
293 | BitBake's tinfoil module. For information on these changes, see the | 293 | BitBake's tinfoil module. For information on these changes, see the |
294 | changes made to the scripts supplied with OpenEmbedded-Core: | 294 | changes made to the scripts supplied with OpenEmbedded-Core: |
295 | `1 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>`__ | 295 | :yocto_git:`1 </poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>` |
296 | and | 296 | and |
297 | `2 <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`__. | 297 | :yocto_git:`2 </poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`. |
298 | 298 | ||
299 | - The task management code has been rewritten to avoid using ID | 299 | - The task management code has been rewritten to avoid using ID |
300 | indirection in order to improve performance. This change is unlikely | 300 | indirection in order to improve performance. This change is unlikely |
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index 4041ad0556..c0a8f04195 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst | |||
@@ -323,7 +323,7 @@ The following package management changes took place: | |||
323 | .. note:: | 323 | .. note:: |
324 | 324 | ||
325 | For further details on this change, see the | 325 | For further details on this change, see the |
326 | :yocto_git:`commit message </cgit/cgit.cgi/poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`. | 326 | :yocto_git:`commit message </poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`. |
327 | 327 | ||
328 | .. _migration-2.3-removed-recipes: | 328 | .. _migration-2.3-removed-recipes: |
329 | 329 | ||
diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst index 1aeddc81c3..7f1b80938f 100644 --- a/documentation/ref-manual/migration-2.5.rst +++ b/documentation/ref-manual/migration-2.5.rst | |||
@@ -180,7 +180,7 @@ or :: | |||
180 | The earlier build-time provides behavior was a quirk of the | 180 | The earlier build-time provides behavior was a quirk of the |
181 | way the Python manifest file was created. For more information on this | 181 | way the Python manifest file was created. For more information on this |
182 | change please see :yocto_git:`this commit | 182 | change please see :yocto_git:`this commit |
183 | </cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`. | 183 | </poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`. |
184 | 184 | ||
185 | .. _migration-2.5-miscellaneous-changes: | 185 | .. _migration-2.5-miscellaneous-changes: |
186 | 186 | ||
@@ -293,8 +293,8 @@ The following are additional changes: | |||
293 | 293 | ||
294 | - Patches whose context does not match exactly (i.e. where patch | 294 | - Patches whose context does not match exactly (i.e. where patch |
295 | reports "fuzz" when applying) will generate a warning. For an example | 295 | reports "fuzz" when applying) will generate a warning. For an example |
296 | of this see `this | 296 | of this see :yocto_git:`this commit |
297 | commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`__. | 297 | </poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`. |
298 | 298 | ||
299 | - Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match | 299 | - Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match |
300 | the version(s) of OpenEmbedded-Core they are compatible with. This is | 300 | the version(s) of OpenEmbedded-Core they are compatible with. This is |
diff --git a/documentation/ref-manual/migration-3.0.rst b/documentation/ref-manual/migration-3.0.rst index 047b75526f..7ef2742f8b 100644 --- a/documentation/ref-manual/migration-3.0.rst +++ b/documentation/ref-manual/migration-3.0.rst | |||
@@ -197,7 +197,7 @@ The following BitBake changes have occurred. | |||
197 | - The arguments passed to functions used with | 197 | - The arguments passed to functions used with |
198 | :term:`bitbake:BB_HASHCHECK_FUNCTION` | 198 | :term:`bitbake:BB_HASHCHECK_FUNCTION` |
199 | have changed. If you are using your own custom hash check function, | 199 | have changed. If you are using your own custom hash check function, |
200 | see :yocto_git:`/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` | 200 | see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` |
201 | for details. | 201 | for details. |
202 | 202 | ||
203 | - Task specifications in ``BB_TASKDEPDATA`` and class implementations | 203 | - Task specifications in ``BB_TASKDEPDATA`` and class implementations |
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index 62876194d1..e0cdbe87fa 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst | |||
@@ -2774,7 +2774,7 @@ To use this class, you need to define a number of variables: | |||
2774 | These variables list alternative commands needed by a package, provide | 2774 | These variables list alternative commands needed by a package, provide |
2775 | pathnames for links, default links for targets, and so forth. For | 2775 | pathnames for links, default links for targets, and so forth. For |
2776 | details on how to use this class, see the comments in the | 2776 | details on how to use this class, see the comments in the |
2777 | :yocto_git:`update-alternatives.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>` | 2777 | :yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes/update-alternatives.bbclass>` |
2778 | file. | 2778 | file. |
2779 | 2779 | ||
2780 | .. note:: | 2780 | .. note:: |
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst index 93fd1465f9..a769b3bd40 100644 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ b/documentation/ref-manual/ref-devtool-reference.rst | |||
@@ -349,7 +349,7 @@ particular recipe. | |||
349 | .. note:: | 349 | .. note:: |
350 | 350 | ||
351 | - For the ``oe-core`` layer, recipe maintainers come from the | 351 | - For the ``oe-core`` layer, recipe maintainers come from the |
352 | `maintainers.inc <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`_ | 352 | :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` |
353 | file. | 353 | file. |
354 | 354 | ||
355 | - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` | 355 | - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` |
@@ -388,7 +388,7 @@ satisfied. | |||
388 | When a reason for not upgrading displays, the reason is usually | 388 | When a reason for not upgrading displays, the reason is usually |
389 | written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` | 389 | written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` |
390 | variable. See the | 390 | variable. See the |
391 | :yocto_git:`base-passwd.bb </cgit/cgit.cgi/poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` | 391 | :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` |
392 | recipe for an example. | 392 | recipe for an example. |
393 | 393 | ||
394 | :: | 394 | :: |
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 299e8f7d66..9fde9a8378 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst | |||
@@ -301,7 +301,7 @@ to locate and apply patch files to the source code. | |||
301 | Patch files, by default, are ``*.patch`` and ``*.diff`` files created | 301 | Patch files, by default, are ``*.patch`` and ``*.diff`` files created |
302 | and kept in a subdirectory of the directory holding the recipe file. For | 302 | and kept in a subdirectory of the directory holding the recipe file. For |
303 | example, consider the | 303 | example, consider the |
304 | :yocto_git:`bluez5 </cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>` | 304 | :yocto_git:`bluez5 </poky/tree/meta/recipes-connectivity/bluez5>` |
305 | recipe from the OE-Core layer (i.e. ``poky/meta``): | 305 | recipe from the OE-Core layer (i.e. ``poky/meta``): |
306 | :: | 306 | :: |
307 | 307 | ||
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index b4ceebc0bb..f59aaf2788 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst | |||
@@ -218,7 +218,7 @@ universal, the list includes them just in case: | |||
218 | 218 | ||
219 | In the context of the kernel ("kernel Metadata"), the term refers to | 219 | In the context of the kernel ("kernel Metadata"), the term refers to |
220 | the kernel config fragments and features contained in the | 220 | the kernel config fragments and features contained in the |
221 | :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache>` | 221 | :yocto_git:`yocto-kernel-cache </yocto-kernel-cache>` |
222 | Git repository. | 222 | Git repository. |
223 | 223 | ||
224 | :term:`OpenEmbedded-Core (OE-Core)` | 224 | :term:`OpenEmbedded-Core (OE-Core)` |
@@ -232,7 +232,7 @@ universal, the list includes them just in case: | |||
232 | core set of recipes. | 232 | core set of recipes. |
233 | 233 | ||
234 | You can see the Metadata in the ``meta`` directory of the Yocto | 234 | You can see the Metadata in the ``meta`` directory of the Yocto |
235 | Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky>`. | 235 | Project :yocto_git:`Source Repositories </poky>`. |
236 | 236 | ||
237 | :term:`OpenEmbedded Build System` | 237 | :term:`OpenEmbedded Build System` |
238 | The build system specific to the Yocto | 238 | The build system specific to the Yocto |
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 921d19e7f5..f8cd5416d9 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -3600,7 +3600,7 @@ system and gives an overview of their function and contents. | |||
3600 | configuration file. You cannot set the variable in a recipe file. | 3600 | configuration file. You cannot set the variable in a recipe file. |
3601 | 3601 | ||
3602 | See the | 3602 | See the |
3603 | :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` | 3603 | :yocto_git:`local.conf.sample.extended </poky/tree/meta-poky/conf/local.conf.sample.extended>` |
3604 | file for additional information. Also, for information on creating an | 3604 | file for additional information. Also, for information on creating an |
3605 | initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section | 3605 | initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section |
3606 | in the Yocto Project Development Tasks Manual. | 3606 | in the Yocto Project Development Tasks Manual. |