summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-development-environment.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 11:00:01 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (patch)
treeee9bc44a1a2789a729632f4c0c436257fa477b8e /documentation/overview-manual/overview-manual-development-environment.rst
parent26c5622bb5551e1ad61db1c20890579dfb6b87c2 (diff)
downloadpoky-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/overview-manual-development-environment.rst')
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst25
1 files changed, 12 insertions, 13 deletions
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
145The Yocto Project team maintains complete source repositories for all 145The Yocto Project team maintains complete source repositories for all
146Yocto Project files at ` <&YOCTO_GIT_URL;>`__. This web-based source 146Yocto Project files at :yocto_git:`/`. This web-based source
147code browser is organized into categories by function such as IDE 147code browser is organized into categories by function such as IDE
148Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the 148Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the
149interface, you can click on any particular item in the "Name" column and 149interface, 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
155Packages, and so forth. 155Packages, and so forth.
156 156
157For any supported release of Yocto Project, you can also go to the 157For 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"
159item from the "SOFTWARE" menu and get a released tarball of the ``poky`` 159item from the "SOFTWARE" menu and get a released tarball of the ``poky``
160repository, any supported BSP tarball, or Yocto Project tools. Unpacking 160repository, any supported BSP tarball, or Yocto Project tools. Unpacking
161these tarballs gives you a snapshot of the released files. 161these tarballs gives you a snapshot of the released files.
@@ -176,7 +176,7 @@ these tarballs gives you a snapshot of the released files.
176In summary, here is where you can get the project files needed for 176In summary, here is where you can get the project files needed for
177development: 177development:
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
260The Yocto Project ``poky`` Git repository also has an upstream 259The Yocto Project ``poky`` Git repository also has an upstream
261contribution Git repository named ``poky-contrib``. You can see all the 260contribution Git repository named ``poky-contrib``. You can see all the
262branches in this repository using the web interface of the `Source 261branches in this repository using the web interface of the
263Repositories <&YOCTO_GIT_URL;>`__ organized within the "Poky Support" 262:yocto_git:`Source Repositories <>` organized within the "Poky Support"
264area. These branches hold changes (commits) to the project that have 263area. These branches hold changes (commits) to the project that have
265been submitted or committed by the Yocto Project development team and by 264been submitted or committed by the Yocto Project development team and by
266community members who contribute to the project. The maintainer 265community members who contribute to the project. The maintainer
@@ -400,7 +399,7 @@ Repositories, Tags, and Branches
400As mentioned briefly in the previous section and also in the "`Git 399As mentioned briefly in the previous section and also in the "`Git
401Workflows and the Yocto 400Workflows and the Yocto
402Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto 401Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto
403Project maintains source repositories at ` <&YOCTO_GIT_URL;>`__. If you 402Project maintains source repositories at :yocto_git:`/`. If you
404look at this web-interface of the repositories, each item is a separate 403look at this web-interface of the repositories, each item is a separate
405Git repository. 404Git repository.
406 405
@@ -432,7 +431,7 @@ files. Git uses "branches" to organize different development efforts.
432For example, the ``poky`` repository has several branches that include 431For example, the ``poky`` repository has several branches that include
433the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many 432the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many
434branches for past Yocto Project releases. You can see all the branches 433branches for past Yocto Project releases. You can see all the branches
435by going to ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the 434by 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
438Each of these branches represents a specific area of development. The 437Each 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
472structure. Typically, a tag is used to mark a special point such as the 471structure. Typically, a tag is used to mark a special point such as the
473final change (or commit) before a project is released. You can see the 472final change (or commit) before a project is released. You can see the
474tags used with the ``poky`` Git repository by going to 473tags used with the ``poky`` Git repository by going to
475` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the ``[...]`` link 474https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link
476beneath the "Tag" heading. 475beneath the "Tag" heading.
477 476
478Some key tags for the ``poky`` repository are ``jethro-14.0.3``, 477Some key tags for the ``poky`` repository are ``jethro-14.0.3``,