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/ref-manual/migration-1.3.rst | 2 +- documentation/ref-manual/migration-1.6.rst | 2 +- documentation/ref-manual/migration-2.2.rst | 4 ++-- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.5.rst | 6 +++--- documentation/ref-manual/migration-3.0.rst | 2 +- documentation/ref-manual/ref-classes.rst | 2 +- documentation/ref-manual/ref-devtool-reference.rst | 4 ++-- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 4 ++-- documentation/ref-manual/ref-variables.rst | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) (limited to 'documentation/ref-manual') 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 ``meta-gnome``. For the remainder, you can now find them in the ``meta-extras`` repository, which is in the :yocto_git:`Source Repositories <>` at -:yocto_git:`/cgit/cgit.cgi/meta-extras/`. +:yocto_git:`/meta-extras/`. .. _1.3-linux-kernel-naming: 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 ``routerstationpro`` machines are still available in a new ``meta-yocto-bsp-old`` layer in the :yocto_git:`Source Repositories <>` at -:yocto_git:`/cgit/cgit.cgi/meta-yocto-bsp-old/`. +:yocto_git:`/meta-yocto-bsp-old/`. 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: functionality. These changes will affect external tools that use BitBake's tinfoil module. For information on these changes, see the changes made to the scripts supplied with OpenEmbedded-Core: - `1 `__ + :yocto_git:`1 ` and - `2 `__. + :yocto_git:`2 `. - The task management code has been rewritten to avoid using ID 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: .. note:: For further details on this change, see the - :yocto_git:`commit message `. + :yocto_git:`commit message `. .. _migration-2.3-removed-recipes: 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 :: The earlier build-time provides behavior was a quirk of the way the Python manifest file was created. For more information on this change please see :yocto_git:`this commit -`. +`. .. _migration-2.5-miscellaneous-changes: @@ -293,8 +293,8 @@ The following are additional changes: - Patches whose context does not match exactly (i.e. where patch reports "fuzz" when applying) will generate a warning. For an example - of this see `this - commit `__. + of this see :yocto_git:`this commit + `. - Layers are expected to set ``LAYERSERIES_COMPAT_layername`` to match 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. - The arguments passed to functions used with :term:`bitbake:BB_HASHCHECK_FUNCTION` have changed. If you are using your own custom hash check function, - see :yocto_git:`/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` + see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` for details. - 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: These variables list alternative commands needed by a package, provide pathnames for links, default links for targets, and so forth. For details on how to use this class, see the comments in the -:yocto_git:`update-alternatives.bbclass ` +:yocto_git:`update-alternatives.bbclass ` file. .. 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. .. note:: - For the ``oe-core`` layer, recipe maintainers come from the - `maintainers.inc `_ + :yocto_git:`maintainers.inc ` file. - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` @@ -388,7 +388,7 @@ satisfied. When a reason for not upgrading displays, the reason is usually written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` variable. See the - :yocto_git:`base-passwd.bb ` + :yocto_git:`base-passwd.bb ` recipe for an example. :: 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. Patch files, by default, are ``*.patch`` and ``*.diff`` files created and kept in a subdirectory of the directory holding the recipe file. For example, consider the -:yocto_git:`bluez5 ` +:yocto_git:`bluez5 ` recipe from the OE-Core layer (i.e. ``poky/meta``): :: 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: In the context of the kernel ("kernel Metadata"), the term refers to the kernel config fragments and features contained in the - :yocto_git:`yocto-kernel-cache ` + :yocto_git:`yocto-kernel-cache ` Git repository. :term:`OpenEmbedded-Core (OE-Core)` @@ -232,7 +232,7 @@ universal, the list includes them just in case: core set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories `. + Project :yocto_git:`Source Repositories `. :term:`OpenEmbedded Build System` 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. configuration file. You cannot set the variable in a recipe file. See the - :yocto_git:`local.conf.sample.extended ` + :yocto_git:`local.conf.sample.extended ` file for additional information. Also, for information on creating an initramfs, see the ":ref:`dev-manual/dev-manual-common-tasks:building an initial ram filesystem (initramfs) image`" section in the Yocto Project Development Tasks Manual. -- cgit v1.2.3-54-g00ecf