summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
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/dev-manual
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/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst35
-rw-r--r--documentation/dev-manual/dev-manual-intro.rst4
-rw-r--r--documentation/dev-manual/dev-manual-start.rst21
3 files changed, 28 insertions, 32 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 29a94b9a84..0703f3ebc8 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -68,8 +68,7 @@ Follow these general steps to create your layer without using tools:
68 ``conf`` directory and then modify the file as needed. 68 ``conf`` directory and then modify the file as needed.
69 69
70 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project 70 The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project
71 `Source 71 :yocto_git:`Source Repositories </cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>`
72 Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>`__
73 demonstrates the required syntax. For your layer, you need to replace 72 demonstrates the required syntax. For your layer, you need to replace
74 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" 73 "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz"
75 for a layer named "meta-machinexyz"): # We have a conf and classes 74 for a layer named "meta-machinexyz"): # We have a conf and classes
@@ -120,7 +119,7 @@ Follow these general steps to create your layer without using tools:
120 Lists all layers on which this layer depends (if any). 119 Lists all layers on which this layer depends (if any).
121 120
122 - :term:`LAYERSERIES_COMPAT`: 121 - :term:`LAYERSERIES_COMPAT`:
123 Lists the `Yocto Project <&YOCTO_WIKI_URL;/wiki/Releases>`__ 122 Lists the :yocto_wiki:`Yocto Project </wiki/Releases>`
124 releases for which the current version is compatible. This 123 releases for which the current version is compatible. This
125 variable is a good way to indicate if your particular layer is 124 variable is a good way to indicate if your particular layer is
126 current. 125 current.
@@ -4001,9 +4000,9 @@ your tunings to best consider build times and package feed maintenance.
4001 higher levels noted earlier can be useful. For example, consider how 4000 higher levels noted earlier can be useful. For example, consider how
4002 NXP (formerly Freescale) allows for the easy reuse of binary packages 4001 NXP (formerly Freescale) allows for the easy reuse of binary packages
4003 in their layer 4002 in their layer
4004 ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/>`__. 4003 :yocto_git:`meta-freescale </cgit/cgit.cgi/meta-freescale/>`.
4005 In this example, the 4004 In this example, the
4006 ```fsl-dynamic-packagearch`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`__ 4005 :yocto_git:`fsl-dynamic-packagearch </cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`
4007 class shares GPU packages for i.MX53 boards because all boards share 4006 class shares GPU packages for i.MX53 boards because all boards share
4008 the AMD GPU. The i.MX6-based boards can do the same because all 4007 the AMD GPU. The i.MX6-based boards can do the same because all
4009 boards share the Vivante GPU. This class inspects the BitBake 4008 boards share the Vivante GPU. This class inspects the BitBake
@@ -5058,7 +5057,7 @@ partition.
5058Source plugins are subclasses defined in plugin files. As shipped, the 5057Source plugins are subclasses defined in plugin files. As shipped, the
5059Yocto Project provides several plugin files. You can see the source 5058Yocto Project provides several plugin files. You can see the source
5060plugin files that ship with the Yocto Project 5059plugin files that ship with the Yocto Project
5061`here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`__. 5060:yocto_git:`here </cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`.
5062Each of these plugin files contains source plugins that are designed to 5061Each of these plugin files contains source plugins that are designed to
5063populate a specific Wic image partition. 5062populate a specific Wic image partition.
5064 5063
@@ -5591,8 +5590,8 @@ Tools for Hardening Your Image
5591------------------------------ 5590------------------------------
5592 5591
5593The Yocto Project provides tools for making your image more secure. You 5592The Yocto Project provides tools for making your image more secure. You
5594can find these tools in the ``meta-security`` layer of the `Yocto 5593can find these tools in the ``meta-security`` layer of the
5595Project Source Repositories <&YOCTO_GIT_URL;>`__. 5594:yocto_git:`Yocto Project Source Repositories <>`.
5596 5595
5597Creating Your Own Distribution 5596Creating Your Own Distribution
5598============================== 5597==============================
@@ -5872,7 +5871,7 @@ the following:
5872 build system uses this string to help define the value of ``PV`` when 5871 build system uses this string to help define the value of ``PV`` when
5873 the source code revision needs to be included in it. 5872 the source code revision needs to be included in it.
5874 5873
5875- `PR Service <https://wiki.yoctoproject.org/wiki/PR_Service>`__: A 5874- :yocto_wiki:`PR Service </wiki/PR_Service>`: A
5876 network-based service that helps automate keeping package feeds 5875 network-based service that helps automate keeping package feeds
5877 compatible with existing package manager applications such as RPM, 5876 compatible with existing package manager applications such as RPM,
5878 APT, and OPKG. 5877 APT, and OPKG.
@@ -6574,7 +6573,7 @@ testname where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and
6574the testname can be any identifying string. 6573the testname can be any identifying string.
6575 6574
6576For a list of Yocto Project recipes that are already enabled with ptest, 6575For a list of Yocto Project recipes that are already enabled with ptest,
6577see the `Ptest <https://wiki.yoctoproject.org/wiki/Ptest>`__ wiki page. 6576see the :yocto_wiki:`Ptest </wiki/Ptest>` wiki page.
6578 6577
6579.. note:: 6578.. note::
6580 6579
@@ -9209,10 +9208,9 @@ Here are some other tips that you might find useful:
9209 indicate that the documentation should be extended or improved. In 9208 indicate that the documentation should be extended or improved. In
9210 such cases, consider filing a documentation bug using the Yocto 9209 such cases, consider filing a documentation bug using the Yocto
9211 Project implementation of 9210 Project implementation of
9212 `Bugzilla <https://bugzilla.yoctoproject.org/>`__. For information on 9211 :yocto_bugs:`Bugzilla <>`. For information on
9213 how to submit a bug against the Yocto Project, see the Yocto Project 9212 how to submit a bug against the Yocto Project, see the Yocto Project
9214 Bugzilla `wiki 9213 Bugzilla :yocto_wiki:`wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
9215 page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__
9216 and the "`Submitting a Defect Against the Yocto 9214 and the "`Submitting a Defect Against the Yocto
9217 Project <#submitting-a-defect-against-the-yocto-project>`__" section. 9215 Project <#submitting-a-defect-against-the-yocto-project>`__" section.
9218 9216
@@ -9241,13 +9239,12 @@ against the Yocto Project. For additional information on this
9241implementation of Bugzilla see the "`Yocto Project 9239implementation of Bugzilla see the "`Yocto Project
9242Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the 9240Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the
9243Yocto Project Reference Manual. For more detail on any of the following 9241Yocto Project Reference Manual. For more detail on any of the following
9244steps, see the Yocto Project `Bugzilla wiki 9242steps, see the Yocto Project
9245page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__. 9243:yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`.
9246 9244
9247Use the following general steps to submit a bug" 9245Use the following general steps to submit a bug"
9248 9246
92491. Open the Yocto Project implementation of 92471. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`.
9250 `Bugzilla <&YOCTO_BUGZILLA_URL;>`__.
9251 9248
92522. Click "File a Bug" to enter a new bug. 92492. Click "File a Bug" to enter a new bug.
9253 9250
@@ -9365,8 +9362,8 @@ concepts on working in the Yocto Project development environment.
9365Two commonly used testing repositories exist for OpenEmbedded-Core: 9362Two commonly used testing repositories exist for OpenEmbedded-Core:
9366 9363
9367- *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the 9364- *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the
9368 ``poky-contrib`` repository in the `Yocto Project source 9365 ``poky-contrib`` repository in the
9369 repositories <&YOCTO_GIT_URL;>`__. 9366 :yocto_git:`Yocto Project source repositories <>`.
9370 9367
9371- *"master-next" branch:* This branch is part of the main "poky" 9368- *"master-next" branch:* This branch is part of the main "poky"
9372 repository in the Yocto Project source repositories. 9369 repository in the Yocto Project source repositories.
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst
index 492d3db82a..1dc552c750 100644
--- a/documentation/dev-manual/dev-manual-intro.rst
+++ b/documentation/dev-manual/dev-manual-intro.rst
@@ -53,8 +53,8 @@ Other Information
53 53
54Because this manual presents information for many different topics, 54Because this manual presents information for many different topics,
55supplemental information is recommended for full comprehension. For 55supplemental information is recommended for full comprehension. For
56introductory information on the Yocto Project, see the `Yocto Project 56introductory information on the Yocto Project, see the
57Website <&YOCTO_HOME_URL;>`__. If you want to build an image with no 57:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
58knowledge of Yocto Project as a way of quickly testing it out, see the 58knowledge of Yocto Project as a way of quickly testing it out, see the
59`Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. 59`Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document.
60 60
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 81fa7847e6..884d1286ef 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -92,7 +92,7 @@ particular working environment and set of practices.
92 92
93 It is relatively easy to set up Git services and create 93 It is relatively easy to set up Git services and create
94 infrastructure like 94 infrastructure like
95 `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__, which is based on 95 :yocto_git:`http://git.yoctoproject.org <>`, which is based on
96 server software called ``gitolite`` with ``cgit`` being used to 96 server software called ``gitolite`` with ``cgit`` being used to
97 generate the web interface that lets you view the repositories. The 97 generate the web interface that lets you view the repositories. The
98 ``gitolite`` software identifies users using SSH keys and allows 98 ``gitolite`` software identifies users using SSH keys and allows
@@ -322,8 +322,7 @@ Project Build Host:
322 validation and their status, see the "`Supported Linux 322 validation and their status, see the "`Supported Linux
323 Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__" 323 Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__"
324 section in the Yocto Project Reference Manual and the wiki page at 324 section in the Yocto Project Reference Manual and the wiki page at
325 `Distribution 325 :yocto_wiki:`Distribution Support </wiki/Distribution_Support>`.
326 Support <&YOCTO_WIKI_URL;/wiki/Distribution_Support>`__.
327 326
3282. *Have Enough Free Memory:* Your system should have at least 50 Gbytes 3272. *Have Enough Free Memory:* Your system should have at least 50 Gbytes
329 of free disk space for building images. 328 of free disk space for building images.
@@ -598,14 +597,14 @@ Working from a copy of the upstream Yocto Project `Source
598Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the 597Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the
599preferred method for obtaining and using a Yocto Project release. You 598preferred method for obtaining and using a Yocto Project release. You
600can view the Yocto Project Source Repositories at 599can view the Yocto Project Source Repositories at
601` <&YOCTO_GIT_URL;>`__. In particular, you can find the ``poky`` 600:yocto_git:`/`. In particular, you can find the ``poky``
602repository at ` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__. 601repository at :yocto_git:`/cgit.cgi/poky`.
603 602
604Use the following procedure to locate the latest upstream copy of the 603Use the following procedure to locate the latest upstream copy of the
605``poky`` Git repository: 604``poky`` Git repository:
606 605
6071. *Access Repositories:* Open a browser and go to 6061. *Access Repositories:* Open a browser and go to
608 ` <&YOCTO_GIT_URL;>`__ to access the GUI-based interface into the 607 :yocto_git:`/` to access the GUI-based interface into the
609 Yocto Project source repositories. 608 Yocto Project source repositories.
610 609
6112. *Select the Repository:* Click on the repository in which you are 6102. *Select the Repository:* Click on the repository in which you are
@@ -614,7 +613,7 @@ Use the following procedure to locate the latest upstream copy of the
6143. *Find the URL Used to Clone the Repository:* At the bottom of the 6133. *Find the URL Used to Clone the Repository:* At the bottom of the
615 page, note the URL used to 614 page, note the URL used to
616 `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository 615 `clone <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository
617 (e.g. ``YOCTO_GIT_URL/poky``). 616 (e.g. :yocto_git:`/git/poky`).
618 617
619 .. note:: 618 .. note::
620 619
@@ -642,7 +641,7 @@ of a given component.
642Follow these steps to locate and download a particular tarball: 641Follow these steps to locate and download a particular tarball:
643 642
6441. *Access the Index of Releases:* Open a browser and go to 6431. *Access the Index of Releases:* Open a browser and go to
645 ` <&YOCTO_DL_URL;/releases>`__ to access the Index of Releases. The 644 :yocto_dl:`Index of Releases <releases>`. The
646 list represents released components (e.g. ``bitbake``, ``sato``, and 645 list represents released components (e.g. ``bitbake``, ``sato``, and
647 so on). 646 so on).
648 647
@@ -670,7 +669,7 @@ Follow these steps to locate and download a particular tarball:
670Using the Downloads Page 669Using the Downloads Page
671------------------------ 670------------------------
672 671
673The `Yocto Project Website <&YOCTO_HOME_URL;>`__ uses a "DOWNLOADS" page 672The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page
674from which you can locate and download tarballs of any Yocto Project 673from which you can locate and download tarballs of any Yocto Project
675release. Rather than Git repositories, these files represent snapshot 674release. Rather than Git repositories, these files represent snapshot
676tarballs similar to the tarballs located in the Index of Releases 675tarballs similar to the tarballs located in the Index of Releases
@@ -684,8 +683,8 @@ Releases <#accessing-index-of-releases>`__" section.
684 repository. The procedure in this section exists should you desire a 683 repository. The procedure in this section exists should you desire a
685 tarball snapshot of any given component. 684 tarball snapshot of any given component.
686 685
6871. *Go to the Yocto Project Website:* Open The `Yocto Project 6861. *Go to the Yocto Project Website:* Open The
688 Website <&YOCTO_HOME_URL;>`__ in your browser. 687 :yocto_home:`Yocto Project Website <>` in your browser.
689 688
6902. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the 6892. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the
691 pull-down "SOFTWARE" tab menu near the top of the page. 690 pull-down "SOFTWARE" tab menu near the top of the page.