diff options
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.rst | 35 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.rst | 4 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-start.rst | 21 |
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. | |||
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. |
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 | ||
54 | Because this manual presents information for many different topics, | 54 | Because this manual presents information for many different topics, |
55 | supplemental information is recommended for full comprehension. For | 55 | supplemental information is recommended for full comprehension. For |
56 | introductory information on the Yocto Project, see the `Yocto Project | 56 | introductory information on the Yocto Project, see the |
57 | Website <&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 |
58 | knowledge of Yocto Project as a way of quickly testing it out, see the | 58 | knowledge 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 | ||
328 | 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes | 327 | 2. *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 | |||
598 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the | 597 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the |
599 | preferred method for obtaining and using a Yocto Project release. You | 598 | preferred method for obtaining and using a Yocto Project release. You |
600 | can view the Yocto Project Source Repositories at | 599 | can 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`` |
602 | repository at ` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/>`__. | 601 | repository at :yocto_git:`/cgit.cgi/poky`. |
603 | 602 | ||
604 | Use the following procedure to locate the latest upstream copy of the | 603 | Use the following procedure to locate the latest upstream copy of the |
605 | ``poky`` Git repository: | 604 | ``poky`` Git repository: |
606 | 605 | ||
607 | 1. *Access Repositories:* Open a browser and go to | 606 | 1. *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 | ||
611 | 2. *Select the Repository:* Click on the repository in which you are | 610 | 2. *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 | |||
614 | 3. *Find the URL Used to Clone the Repository:* At the bottom of the | 613 | 3. *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. | |||
642 | Follow these steps to locate and download a particular tarball: | 641 | Follow these steps to locate and download a particular tarball: |
643 | 642 | ||
644 | 1. *Access the Index of Releases:* Open a browser and go to | 643 | 1. *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: | |||
670 | Using the Downloads Page | 669 | Using the Downloads Page |
671 | ------------------------ | 670 | ------------------------ |
672 | 671 | ||
673 | The `Yocto Project Website <&YOCTO_HOME_URL;>`__ uses a "DOWNLOADS" page | 672 | The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page |
674 | from which you can locate and download tarballs of any Yocto Project | 673 | from which you can locate and download tarballs of any Yocto Project |
675 | release. Rather than Git repositories, these files represent snapshot | 674 | release. Rather than Git repositories, these files represent snapshot |
676 | tarballs similar to the tarballs located in the Index of Releases | 675 | tarballs 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 | ||
687 | 1. *Go to the Yocto Project Website:* Open The `Yocto Project | 686 | 1. *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 | ||
690 | 2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the | 689 | 2. *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. |