summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
diff options
context:
space:
mode:
authorPaul Barker <pbarker@konsulko.com>2020-11-27 15:19:09 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-03 12:04:21 +0000
commit48748377a41a697a2b280ddbecb1c39487d1b7b8 (patch)
tree256c470487c98c810fbb28ab4973d7180ac23baf /documentation/overview-manual
parent8faafa99cc9a45c1920ec3ea696a9ec7fb653194 (diff)
downloadpoky-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/overview-manual')
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst17
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst7
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst12
3 files changed, 16 insertions, 20 deletions
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
273build environment. Here is a list of a few. To see the default 273build environment. Here is a list of a few. To see the default
274configurations in a ``local.conf`` file created by the build environment 274configurations in a ``local.conf`` file created by the build environment
275script, see the 275script, see the
276:yocto_git:`local.conf.sample </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>` 276:yocto_git:`local.conf.sample </poky/tree/meta-poky/conf/local.conf.sample>`
277in the ``meta-poky`` layer: 277in the ``meta-poky`` layer:
278 278
279- *Target Machine Selection:* Controlled by the 279- *Target Machine Selection:* Controlled by the
@@ -393,17 +393,17 @@ figure <#general-workflow-figure>`__:
393 configurations. This type of information is specific to a particular 393 configurations. This type of information is specific to a particular
394 target architecture. A good example of a BSP layer from the `Poky 394 target architecture. A good example of a BSP layer from the `Poky
395 Reference Distribution <#gs-reference-distribution-poky>`__ is the 395 Reference Distribution <#gs-reference-distribution-poky>`__ is the
396 :yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>` 396 :yocto_git:`meta-yocto-bsp </poky/tree/meta-yocto-bsp>`
397 layer. 397 layer.
398 398
399- *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in 399- *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in
400 the following figure) providing top-level or general policies for the 400 the following figure) providing top-level or general policies for the
401 images or SDKs being built for a particular distribution. For 401 images or SDKs being built for a particular distribution. For
402 example, in the Poky Reference Distribution the distro layer is the 402 example, in the Poky Reference Distribution the distro layer is the
403 :yocto_git:`meta-poky </cgit/cgit.cgi/poky/tree/meta-poky>` 403 :yocto_git:`meta-poky </poky/tree/meta-poky>`
404 layer. Within the distro layer is a ``conf/distro`` directory that 404 layer. Within the distro layer is a ``conf/distro`` directory that
405 contains distro configuration files (e.g. 405 contains distro configuration files (e.g.
406 :yocto_git:`poky.conf </cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>` 406 :yocto_git:`poky.conf </poky/tree/meta-poky/conf/distro/poky.conf>`
407 that contain many policy configurations for the Poky distribution. 407 that contain many policy configurations for the Poky distribution.
408 408
409The following figure shows an expanded representation of these three 409The following figure shows an expanded representation of these three
@@ -427,9 +427,8 @@ Model <#the-yocto-project-layer-model>`__" sections both earlier in this
427manual. 427manual.
428 428
429If you explored the previous links, you discovered some areas where many 429If you explored the previous links, you discovered some areas where many
430layers that work with the Yocto Project exist. The `Source 430layers that work with the Yocto Project exist. The :yocto_git:`Source
431Repositories <http://git.yoctoproject.org/>`__ also shows layers 431Repositories <>` also shows layers categorized under "Yocto Metadata Layers."
432categorized under "Yocto Metadata Layers."
433 432
434.. note:: 433.. note::
435 434
@@ -879,7 +878,7 @@ This step in the build process consists of the following tasks:
879 variables. For information on how this variable works within that 878 variables. For information on how this variable works within that
880 class, see the 879 class, see the
881 :ref:`autotools <ref-classes-autotools>` class 880 :ref:`autotools <ref-classes-autotools>` class
882 :yocto_git:`here </cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`. 881 :yocto_git:`here </poky/tree/meta/classes/autotools.bbclass>`.
883 882
884- *do_compile*: Once a configuration task has been satisfied, 883- *do_compile*: Once a configuration task has been satisfied,
885 BitBake compiles the source using the 884 BitBake compiles the source using the
@@ -957,7 +956,7 @@ The :term:`FILES` variable defines the
957files that go into each package in 956files that go into each package in
958:term:`PACKAGES`. If you want 957:term:`PACKAGES`. If you want
959details on how this is accomplished, you can look at 958details on how this is accomplished, you can look at
960:yocto_git:`package.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`. 959:yocto_git:`package.bbclass </poky/tree/meta/classes/package.bbclass>`.
961 960
962Depending on the type of packages being created (RPM, DEB, or IPK), the 961Depending on the type of packages being created (RPM, DEB, or IPK), the
963:ref:`do_package_write_* <ref-tasks-package_write_deb>` 962:ref:`do_package_write_* <ref-tasks-package_write_deb>`
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.
416For example, the ``poky`` repository has several branches that include 416For example, the ``poky`` repository has several branches that include
417the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many 417the current "&DISTRO_NAME_NO_CAP;" branch, the "master" branch, and many
418branches for past Yocto Project releases. You can see all the branches 418branches for past Yocto Project releases. You can see all the branches
419by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the 419by going to :yocto_git:`/poky/` and clicking on the
420``[...]`` link beneath the "Branch" heading. 420``[...]`` link beneath the "Branch" heading.
421 421
422Each of these branches represents a specific area of development. The 422Each of these branches represents a specific area of development. The
@@ -461,9 +461,8 @@ Yocto Project Release.
461Git uses "tags" to mark specific changes in a repository branch 461Git uses "tags" to mark specific changes in a repository branch
462structure. Typically, a tag is used to mark a special point such as the 462structure. Typically, a tag is used to mark a special point such as the
463final change (or commit) before a project is released. You can see the 463final change (or commit) before a project is released. You can see the
464tags used with the ``poky`` Git repository by going to 464tags used with the ``poky`` Git repository by going to :yocto_git:`/poky/`
465https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link 465and clicking on the ``[...]`` link beneath the "Tag" heading.
466beneath the "Tag" heading.
467 466
468Some key tags for the ``poky`` repository are ``jethro-14.0.3``, 467Some key tags for the ``poky`` repository are ``jethro-14.0.3``,
469``morty-16.0.1``, ``pyro-17.0.0``, and 468``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-``.
267 , but it is a commonly accepted standard in the Yocto Project 267 , but it is a commonly accepted standard in the Yocto Project
268 community. 268 community.
269 269
270For example, if you were to examine the `tree 270For example, if you were to examine the :yocto_git:`tree view </poky/tree/>`
271view <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/>`__ of the 271of the ``poky`` repository, you will see several layers: ``meta``,
272``poky`` repository, you will see several layers: ``meta``,
273``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and 272``meta-skeleton``, ``meta-selftest``, ``meta-poky``, and
274``meta-yocto-bsp``. Each of these repositories represents a distinct 273``meta-yocto-bsp``. Each of these repositories represents a distinct
275layer. 274layer.
@@ -467,7 +466,7 @@ The following list consists of components associated with the
467 OpenEmbedded-derived systems, which includes the Yocto Project. The 466 OpenEmbedded-derived systems, which includes the Yocto Project. The
468 Yocto Project and the OpenEmbedded Project both maintain the 467 Yocto Project and the OpenEmbedded Project both maintain the
469 OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto 468 OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto
470 Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta>`. 469 Project :yocto_git:`Source Repositories </poky/tree/meta>`.
471 470
472 Historically, the Yocto Project integrated the OE-Core metadata 471 Historically, the Yocto Project integrated the OE-Core metadata
473 throughout the Yocto Project source repository reference system 472 throughout the Yocto Project source repository reference system
@@ -671,7 +670,7 @@ Poky is a combined repository of BitBake, OpenEmbedded-Core (which is
671found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation 670found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation
672provided all together and known to work well together. You can view 671provided all together and known to work well together. You can view
673these items that make up the Poky repository in the 672these items that make up the Poky repository in the
674:yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/>`. 673:yocto_git:`Source Repositories </poky/tree/>`.
675 674
676.. note:: 675.. note::
677 676
@@ -870,8 +869,7 @@ helpful for getting started:
870 set of recipes. 869 set of recipes.
871 870
872 You can see the Metadata in the ``meta`` directory of the Yocto 871 You can see the Metadata in the ``meta`` directory of the Yocto
873 Project `Source 872 Project :yocto_git:`Source Repositories <>`.
874 Repositories <http://git.yoctoproject.org/cgit/cgit.cgi>`__.
875 873
876- *Packages:* In the context of the Yocto Project, this term refers to 874- *Packages:* In the context of the Yocto Project, this term refers to
877 a recipe's packaged output produced by BitBake (i.e. a "baked 875 a recipe's packaged output produced by BitBake (i.e. a "baked