diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 11:00:01 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch) | |
tree | ee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation/overview-manual | |
parent | 26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff) | |
download | poky-283ed72d487ed78d4f8e0fcc17f635d6c212b7c6.tar.gz |
sphinx: add links for Yocto project website
In DocBook, variables are used to create custom links (note that it is
not consistent everywhere, since some web addresses are still
hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL,
YOCTO_BUGS_URL and YOCTO_DL_URL..
In Sphinx they are replaced with extlinks.
(From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual')
4 files changed, 27 insertions, 29 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index 9764b25b6d..978c2b0b6f 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst | |||
@@ -277,7 +277,7 @@ The ``local.conf`` file provides many basic variables that define a | |||
277 | build environment. Here is a list of a few. To see the default | 277 | build environment. Here is a list of a few. To see the default |
278 | configurations in a ``local.conf`` file created by the build environment | 278 | configurations in a ``local.conf`` file created by the build environment |
279 | script, see the | 279 | script, see the |
280 | ```local.conf.sample`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`__ | 280 | :yocto_git:`local.conf.sample </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>` |
281 | in the ``meta-poky`` layer: | 281 | in the ``meta-poky`` layer: |
282 | 282 | ||
283 | - *Target Machine Selection:* Controlled by the | 283 | - *Target Machine Selection:* Controlled by the |
@@ -397,17 +397,17 @@ figure <#general-workflow-figure>`__: | |||
397 | configurations. This type of information is specific to a particular | 397 | configurations. This type of information is specific to a particular |
398 | target architecture. A good example of a BSP layer from the `Poky | 398 | target architecture. A good example of a BSP layer from the `Poky |
399 | Reference Distribution <#gs-reference-distribution-poky>`__ is the | 399 | Reference Distribution <#gs-reference-distribution-poky>`__ is the |
400 | ```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ | 400 | :yocto_git:`meta-yocto-bsp </cgit/cgit.cgi/poky/tree/meta-yocto-bsp>` |
401 | layer. | 401 | layer. |
402 | 402 | ||
403 | - *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in | 403 | - *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in |
404 | the following figure) providing top-level or general policies for the | 404 | the following figure) providing top-level or general policies for the |
405 | images or SDKs being built for a particular distribution. For | 405 | images or SDKs being built for a particular distribution. For |
406 | example, in the Poky Reference Distribution the distro layer is the | 406 | example, in the Poky Reference Distribution the distro layer is the |
407 | ```meta-poky`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky>`__ | 407 | :yocto_git:`meta-poky </cgit/cgit.cgi/poky/tree/meta-poky>` |
408 | layer. Within the distro layer is a ``conf/distro`` directory that | 408 | layer. Within the distro layer is a ``conf/distro`` directory that |
409 | contains distro configuration files (e.g. | 409 | contains distro configuration files (e.g. |
410 | ```poky.conf`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>`__ | 410 | :yocto_git:`poky.conf </cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>` |
411 | that contain many policy configurations for the Poky distribution. | 411 | that contain many policy configurations for the Poky distribution. |
412 | 412 | ||
413 | The following figure shows an expanded representation of these three | 413 | The following figure shows an expanded representation of these three |
@@ -901,7 +901,7 @@ This step in the build process consists of the following tasks: | |||
901 | variables. For information on how this variable works within that | 901 | variables. For information on how this variable works within that |
902 | class, see the | 902 | class, see the |
903 | :ref:`autotools <ref-classes-autotools>` class | 903 | :ref:`autotools <ref-classes-autotools>` class |
904 | `here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`__. | 904 | :yocto_git:`here </cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`. |
905 | 905 | ||
906 | - *``do_compile``*: Once a configuration task has been satisfied, | 906 | - *``do_compile``*: Once a configuration task has been satisfied, |
907 | BitBake compiles the source using the | 907 | BitBake compiles the source using the |
@@ -981,7 +981,7 @@ The :term:`FILES` variable defines the | |||
981 | files that go into each package in | 981 | files that go into each package in |
982 | :term:`PACKAGES`. If you want | 982 | :term:`PACKAGES`. If you want |
983 | details on how this is accomplished, you can look at | 983 | details on how this is accomplished, you can look at |
984 | ```package.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`__. | 984 | :yocto_git:`package.bbclass </cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`. |
985 | 985 | ||
986 | Depending on the type of packages being created (RPM, DEB, or IPK), the | 986 | Depending on the type of packages being created (RPM, DEB, or IPK), the |
987 | :ref:`do_package_write_* <ref-tasks-package_write_deb>` | 987 | :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 82562bf995..65ad1d1206 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst | |||
@@ -143,7 +143,7 @@ Yocto Project Source Repositories | |||
143 | ================================= | 143 | ================================= |
144 | 144 | ||
145 | The Yocto Project team maintains complete source repositories for all | 145 | The Yocto Project team maintains complete source repositories for all |
146 | Yocto Project files at ` <&YOCTO_GIT_URL;>`__. This web-based source | 146 | Yocto Project files at :yocto_git:`/`. This web-based source |
147 | code browser is organized into categories by function such as IDE | 147 | code browser is organized into categories by function such as IDE |
148 | Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the | 148 | Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the |
149 | interface, you can click on any particular item in the "Name" column and | 149 | interface, you can click on any particular item in the "Name" column and |
@@ -155,7 +155,7 @@ history, and ultimately enhance the Yocto Project's tools, Board Support | |||
155 | Packages, and so forth. | 155 | Packages, and so forth. |
156 | 156 | ||
157 | For any supported release of Yocto Project, you can also go to the | 157 | For any supported release of Yocto Project, you can also go to the |
158 | `Yocto Project Website <&YOCTO_HOME_URL;>`__ and select the "DOWNLOADS" | 158 | :yocto_home:`Yocto Project Website <>` and select the "DOWNLOADS" |
159 | item from the "SOFTWARE" menu and get a released tarball of the ``poky`` | 159 | item from the "SOFTWARE" menu and get a released tarball of the ``poky`` |
160 | repository, any supported BSP tarball, or Yocto Project tools. Unpacking | 160 | repository, any supported BSP tarball, or Yocto Project tools. Unpacking |
161 | these tarballs gives you a snapshot of the released files. | 161 | these tarballs gives you a snapshot of the released files. |
@@ -176,7 +176,7 @@ these tarballs gives you a snapshot of the released files. | |||
176 | In summary, here is where you can get the project files needed for | 176 | In summary, here is where you can get the project files needed for |
177 | development: | 177 | development: |
178 | 178 | ||
179 | - `Source Repositories: <&YOCTO_GIT_URL;>`__ This area contains IDE | 179 | - :yocto_git:`Source Repositories: <>` This area contains IDE |
180 | Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and | 180 | Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and |
181 | Yocto Metadata Layers. You can create local copies of Git | 181 | Yocto Metadata Layers. You can create local copies of Git |
182 | repositories for each of these areas. | 182 | repositories for each of these areas. |
@@ -189,7 +189,7 @@ development: | |||
189 | Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__" | 189 | Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__" |
190 | Section in the Yocto Project Development Tasks Manual. | 190 | Section in the Yocto Project Development Tasks Manual. |
191 | 191 | ||
192 | - `Index of /releases: <&YOCTO_DL_URL;/releases/>`__ This is an index | 192 | - :yocto_dl:`Index of /releases: <releases>` This is an index |
193 | of releases such as Poky, Pseudo, installers for cross-development | 193 | of releases such as Poky, Pseudo, installers for cross-development |
194 | toolchains, miscellaneous support and all released versions of Yocto | 194 | toolchains, miscellaneous support and all released versions of Yocto |
195 | Project in the form of images or tarballs. Downloading and extracting | 195 | Project in the form of images or tarballs. Downloading and extracting |
@@ -204,14 +204,13 @@ development: | |||
204 | Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__" | 204 | Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__" |
205 | section in the Yocto Project Development Tasks Manual. | 205 | section in the Yocto Project Development Tasks Manual. |
206 | 206 | ||
207 | - *"DOWNLOADS" page for the*\ `Yocto Project | 207 | - *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* |
208 | Website <&YOCTO_HOME_URL;>`__\ *:* | ||
209 | 208 | ||
210 | The Yocto Project website includes a "DOWNLOADS" page accessible | 209 | The Yocto Project website includes a "DOWNLOADS" page accessible |
211 | through the "SOFTWARE" menu that allows you to download any Yocto | 210 | through the "SOFTWARE" menu that allows you to download any Yocto |
212 | Project release, tool, and Board Support Package (BSP) in tarball | 211 | Project release, tool, and Board Support Package (BSP) in tarball |
213 | form. The tarballs are similar to those found in the `Index of | 212 | form. The tarballs are similar to those found in the |
214 | /releases: <&YOCTO_DL_URL;/releases/>`__ area. | 213 | :yocto_dl:`Index of /releases: <releases>` area. |
215 | 214 | ||
216 | .. image:: figures/yp-download.png | 215 | .. image:: figures/yp-download.png |
217 | :align: center | 216 | :align: center |
@@ -259,8 +258,8 @@ and so forth. | |||
259 | 258 | ||
260 | The Yocto Project ``poky`` Git repository also has an upstream | 259 | The Yocto Project ``poky`` Git repository also has an upstream |
261 | contribution Git repository named ``poky-contrib``. You can see all the | 260 | contribution Git repository named ``poky-contrib``. You can see all the |
262 | branches in this repository using the web interface of the `Source | 261 | branches in this repository using the web interface of the |
263 | Repositories <&YOCTO_GIT_URL;>`__ organized within the "Poky Support" | 262 | :yocto_git:`Source Repositories <>` organized within the "Poky Support" |
264 | area. These branches hold changes (commits) to the project that have | 263 | area. These branches hold changes (commits) to the project that have |
265 | been submitted or committed by the Yocto Project development team and by | 264 | been submitted or committed by the Yocto Project development team and by |
266 | community members who contribute to the project. The maintainer | 265 | community members who contribute to the project. The maintainer |
@@ -400,7 +399,7 @@ Repositories, Tags, and Branches | |||
400 | As mentioned briefly in the previous section and also in the "`Git | 399 | As mentioned briefly in the previous section and also in the "`Git |
401 | Workflows and the Yocto | 400 | Workflows and the Yocto |
402 | Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto | 401 | Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto |
403 | Project maintains source repositories at ` <&YOCTO_GIT_URL;>`__. If you | 402 | Project maintains source repositories at :yocto_git:`/`. If you |
404 | look at this web-interface of the repositories, each item is a separate | 403 | look at this web-interface of the repositories, each item is a separate |
405 | Git repository. | 404 | Git repository. |
406 | 405 | ||
@@ -432,7 +431,7 @@ files. Git uses "branches" to organize different development efforts. | |||
432 | For example, the ``poky`` repository has several branches that include | 431 | For example, the ``poky`` repository has several branches that include |
433 | the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many | 432 | the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many |
434 | branches for past Yocto Project releases. You can see all the branches | 433 | branches for past Yocto Project releases. You can see all the branches |
435 | by going to ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the | 434 | by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the |
436 | ``[...]`` link beneath the "Branch" heading. | 435 | ``[...]`` link beneath the "Branch" heading. |
437 | 436 | ||
438 | Each of these branches represents a specific area of development. The | 437 | Each of these branches represents a specific area of development. The |
@@ -472,7 +471,7 @@ Git uses "tags" to mark specific changes in a repository branch | |||
472 | structure. Typically, a tag is used to mark a special point such as the | 471 | structure. Typically, a tag is used to mark a special point such as the |
473 | final change (or commit) before a project is released. You can see the | 472 | final change (or commit) before a project is released. You can see the |
474 | tags used with the ``poky`` Git repository by going to | 473 | tags used with the ``poky`` Git repository by going to |
475 | ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the ``[...]`` link | 474 | https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link |
476 | beneath the "Tag" heading. | 475 | beneath the "Tag" heading. |
477 | 476 | ||
478 | Some key tags for the ``poky`` repository are ``jethro-14.0.3``, | 477 | Some key tags for the ``poky`` repository are ``jethro-14.0.3``, |
diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst index cddc176cff..2e96f1e338 100644 --- a/documentation/overview-manual/overview-manual-intro.rst +++ b/documentation/overview-manual/overview-manual-intro.rst | |||
@@ -66,8 +66,8 @@ Other Information | |||
66 | 66 | ||
67 | Because this manual presents information for many different topics, | 67 | Because this manual presents information for many different topics, |
68 | supplemental information is recommended for full comprehension. For | 68 | supplemental information is recommended for full comprehension. For |
69 | additional introductory information on the Yocto Project, see the `Yocto | 69 | additional introductory information on the Yocto Project, see the |
70 | Project Website <&YOCTO_HOME_URL;>`__. If you want to build an image | 70 | :yocto_home:`Yocto Project Website <>`. If you want to build an image |
71 | with no knowledge of Yocto Project as a way of quickly testing it out, | 71 | with no knowledge of Yocto Project as a way of quickly testing it out, |
72 | see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. | 72 | see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. |
73 | For a comprehensive list of links and other documentation, see the | 73 | For a comprehensive list of links and other documentation, see the |
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index 3f98fa939c..743353547e 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst | |||
@@ -47,8 +47,8 @@ Project: | |||
47 | system, software, and service vendors exist whose products and | 47 | system, software, and service vendors exist whose products and |
48 | services adopt and support the Yocto Project. For a look at the Yocto | 48 | services adopt and support the Yocto Project. For a look at the Yocto |
49 | Project community and the companies involved with the Yocto Project, | 49 | Project community and the companies involved with the Yocto Project, |
50 | see the "COMMUNITY" and "ECOSYSTEM" tabs on the `Yocto | 50 | see the "COMMUNITY" and "ECOSYSTEM" tabs on the |
51 | Project <&YOCTO_HOME_URL;>`__ home page. | 51 | :yocto_home:`Yocto Project <>` home page. |
52 | 52 | ||
53 | - *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS, | 53 | - *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS, |
54 | AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors | 54 | AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors |
@@ -482,8 +482,7 @@ The following list consists of components associated with the | |||
482 | OpenEmbedded-derived systems, which includes the Yocto Project. The | 482 | OpenEmbedded-derived systems, which includes the Yocto Project. The |
483 | Yocto Project and the OpenEmbedded Project both maintain the | 483 | Yocto Project and the OpenEmbedded Project both maintain the |
484 | OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto | 484 | OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto |
485 | Project `Source | 485 | Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta>`. |
486 | Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta>`__. | ||
487 | 486 | ||
488 | Historically, the Yocto Project integrated the OE-Core metadata | 487 | Historically, the Yocto Project integrated the OE-Core metadata |
489 | throughout the Yocto Project source repository reference system | 488 | throughout the Yocto Project source repository reference system |
@@ -543,8 +542,8 @@ targets: | |||
543 | applications that you can tailor to a specific, non-desktop platform | 542 | applications that you can tailor to a specific, non-desktop platform |
544 | to enhance usability in constrained environments. | 543 | to enhance usability in constrained environments. |
545 | 544 | ||
546 | You can find the Matchbox source in the Yocto Project `Source | 545 | You can find the Matchbox source in the Yocto Project |
547 | Repositories <&YOCTO_GIT_URL;>`__. | 546 | :yocto_git:`Source Repositories <>`. |
548 | 547 | ||
549 | - *Opkg* Open PacKaGe management (opkg) is a lightweight package | 548 | - *Opkg* Open PacKaGe management (opkg) is a lightweight package |
550 | management system based on the itsy package (ipkg) management system. | 549 | management system based on the itsy package (ipkg) management system. |
@@ -696,8 +695,8 @@ into a usable binary image. | |||
696 | Poky is a combined repository of BitBake, OpenEmbedded-Core (which is | 695 | Poky is a combined repository of BitBake, OpenEmbedded-Core (which is |
697 | found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation | 696 | found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation |
698 | provided all together and known to work well together. You can view | 697 | provided all together and known to work well together. You can view |
699 | these items that make up the Poky repository in the `Source | 698 | these items that make up the Poky repository in the |
700 | Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/>`__. | 699 | :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/>`. |
701 | 700 | ||
702 | .. note:: | 701 | .. note:: |
703 | 702 | ||