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 --- .../overview-manual/overview-manual-concepts.rst | 17 ++++++++--------- .../overview-manual-development-environment.rst | 7 +++---- .../overview-manual/overview-manual-yp-intro.rst | 12 +++++------- 3 files changed, 16 insertions(+), 20 deletions(-) (limited to 'documentation/overview-manual') diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index 353a2f99ff..1b522910d2 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst @@ -273,7 +273,7 @@ The ``local.conf`` file provides many basic variables that define a build environment. Here is a list of a few. To see the default configurations in a ``local.conf`` file created by the build environment script, see the -:yocto_git:`local.conf.sample ` +:yocto_git:`local.conf.sample ` in the ``meta-poky`` layer: - *Target Machine Selection:* Controlled by the @@ -393,17 +393,17 @@ figure <#general-workflow-figure>`__: configurations. This type of information is specific to a particular target architecture. A good example of a BSP layer from the `Poky Reference Distribution <#gs-reference-distribution-poky>`__ is the - :yocto_git:`meta-yocto-bsp ` + :yocto_git:`meta-yocto-bsp ` layer. - *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in the following figure) providing top-level or general policies for the images or SDKs being built for a particular distribution. For example, in the Poky Reference Distribution the distro layer is the - :yocto_git:`meta-poky ` + :yocto_git:`meta-poky ` layer. Within the distro layer is a ``conf/distro`` directory that contains distro configuration files (e.g. - :yocto_git:`poky.conf ` + :yocto_git:`poky.conf ` that contain many policy configurations for the Poky distribution. The following figure shows an expanded representation of these three @@ -427,9 +427,8 @@ Model <#the-yocto-project-layer-model>`__" sections both earlier in this manual. If you explored the previous links, you discovered some areas where many -layers that work with the Yocto Project exist. The `Source -Repositories `__ also shows layers -categorized under "Yocto Metadata Layers." +layers that work with the Yocto Project exist. The :yocto_git:`Source +Repositories <>` also shows layers categorized under "Yocto Metadata Layers." .. note:: @@ -879,7 +878,7 @@ This step in the build process consists of the following tasks: variables. For information on how this variable works within that class, see the :ref:`autotools ` class - :yocto_git:`here `. + :yocto_git:`here `. - *do_compile*: Once a configuration task has been satisfied, BitBake compiles the source using the @@ -957,7 +956,7 @@ The :term:`FILES` variable defines the files that go into each package in :term:`PACKAGES`. If you want details on how this is accomplished, you can look at -:yocto_git:`package.bbclass `. +:yocto_git:`package.bbclass `. Depending on the type of packages being created (RPM, DEB, or IPK), the :ref:`do_package_write_* ` diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst index 983e1919ef..5baf08946b 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst @@ -416,7 +416,7 @@ files. Git uses "branches" to organize different development efforts. For example, the ``poky`` repository has several branches that include the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many branches for past Yocto Project releases. You can see all the branches -by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the +by going to :yocto_git:`/poky/` and clicking on the ``[...]`` link beneath the "Branch" heading. Each of these branches represents a specific area of development. The @@ -461,9 +461,8 @@ Yocto Project Release. Git uses "tags" to mark specific changes in a repository branch structure. Typically, a tag is used to mark a special point such as the final change (or commit) before a project is released. You can see the -tags used with the ``poky`` Git repository by going to -https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link -beneath the "Tag" heading. +tags used with the ``poky`` Git repository by going to :yocto_git:`/poky/` +and clicking on the ``[...]`` link beneath the "Tag" heading. Some key tags for the ``poky`` repository are ``jethro-14.0.3``, ``morty-16.0.1``, ``pyro-17.0.0``, and diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index 83ed18a375..2b9ea91490 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst @@ -267,9 +267,8 @@ with the string ``meta-``. , but it is a commonly accepted standard in the Yocto Project community. -For example, if you were to examine the `tree -view `__ of the -``poky`` repository, you will see several layers: ``meta``, +For example, if you were to examine the :yocto_git:`tree view ` +of the ``poky`` repository, you will see several layers: ``meta``, ``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and ``meta-yocto-bsp``. Each of these repositories represents a distinct layer. @@ -467,7 +466,7 @@ The following list consists of components associated with the OpenEmbedded-derived systems, which includes the Yocto Project. The Yocto Project and the OpenEmbedded Project both maintain the OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto - Project :yocto_git:`Source Repositories `. + Project :yocto_git:`Source Repositories `. Historically, the Yocto Project integrated the OE-Core metadata throughout the Yocto Project source repository reference system @@ -671,7 +670,7 @@ Poky is a combined repository of BitBake, OpenEmbedded-Core (which is found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation provided all together and known to work well together. You can view these items that make up the Poky repository in the -:yocto_git:`Source Repositories `. +:yocto_git:`Source Repositories `. .. note:: @@ -870,8 +869,7 @@ helpful for getting started: set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project `Source - Repositories `__. + Project :yocto_git:`Source Repositories <>`. - *Packages:* In the context of the Yocto Project, this term refers to a recipe's packaged output produced by BitBake (i.e. a "baked -- cgit v1.2.3-54-g00ecf