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/dev-manual/dev-manual-common-tasks.rst | |
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/dev-manual/dev-manual-common-tasks.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 35 |
1 files changed, 16 insertions, 19 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. | |||
5058 | Source plugins are subclasses defined in plugin files. As shipped, the | 5057 | Source plugins are subclasses defined in plugin files. As shipped, the |
5059 | Yocto Project provides several plugin files. You can see the source | 5058 | Yocto Project provides several plugin files. You can see the source |
5060 | plugin files that ship with the Yocto Project | 5059 | plugin 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>`. |
5062 | Each of these plugin files contains source plugins that are designed to | 5061 | Each of these plugin files contains source plugins that are designed to |
5063 | populate a specific Wic image partition. | 5062 | populate a specific Wic image partition. |
5064 | 5063 | ||
@@ -5591,8 +5590,8 @@ Tools for Hardening Your Image | |||
5591 | ------------------------------ | 5590 | ------------------------------ |
5592 | 5591 | ||
5593 | The Yocto Project provides tools for making your image more secure. You | 5592 | The Yocto Project provides tools for making your image more secure. You |
5594 | can find these tools in the ``meta-security`` layer of the `Yocto | 5593 | can find these tools in the ``meta-security`` layer of the |
5595 | Project Source Repositories <&YOCTO_GIT_URL;>`__. | 5594 | :yocto_git:`Yocto Project Source Repositories <>`. |
5596 | 5595 | ||
5597 | Creating Your Own Distribution | 5596 | Creating 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 | |||
6574 | the testname can be any identifying string. | 6573 | the testname can be any identifying string. |
6575 | 6574 | ||
6576 | For a list of Yocto Project recipes that are already enabled with ptest, | 6575 | For a list of Yocto Project recipes that are already enabled with ptest, |
6577 | see the `Ptest <https://wiki.yoctoproject.org/wiki/Ptest>`__ wiki page. | 6576 | see 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 | |||
9241 | implementation of Bugzilla see the "`Yocto Project | 9239 | implementation of Bugzilla see the "`Yocto Project |
9242 | Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the | 9240 | Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the |
9243 | Yocto Project Reference Manual. For more detail on any of the following | 9241 | Yocto Project Reference Manual. For more detail on any of the following |
9244 | steps, see the Yocto Project `Bugzilla wiki | 9242 | steps, see the Yocto Project |
9245 | page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__. | 9243 | :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`. |
9246 | 9244 | ||
9247 | Use the following general steps to submit a bug" | 9245 | Use the following general steps to submit a bug" |
9248 | 9246 | ||
9249 | 1. Open the Yocto Project implementation of | 9247 | 1. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. |
9250 | `Bugzilla <&YOCTO_BUGZILLA_URL;>`__. | ||
9251 | 9248 | ||
9252 | 2. Click "File a Bug" to enter a new bug. | 9249 | 2. Click "File a Bug" to enter a new bug. |
9253 | 9250 | ||
@@ -9365,8 +9362,8 @@ concepts on working in the Yocto Project development environment. | |||
9365 | Two commonly used testing repositories exist for OpenEmbedded-Core: | 9362 | Two 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. |