diff options
-rw-r--r-- | documentation/conf.py | 2 | ||||
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 9 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 15 | ||||
-rw-r--r-- | documentation/overview-manual/yp-intro.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.3.rst | 2 | ||||
-rw-r--r-- | documentation/toaster-manual/intro.rst | 2 | ||||
-rw-r--r-- | documentation/toaster-manual/reference.rst | 4 | ||||
-rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 11 | ||||
-rw-r--r-- | documentation/transitioning-to-a-custom-environment.rst | 4 | ||||
-rw-r--r-- | documentation/what-i-wish-id-known.rst | 11 |
10 files changed, 30 insertions, 36 deletions
diff --git a/documentation/conf.py b/documentation/conf.py index b5351599da..68eb92b0a8 100644 --- a/documentation/conf.py +++ b/documentation/conf.py | |||
@@ -80,6 +80,8 @@ extlinks = { | |||
80 | 'oe_lists': ('https://lists.openembedded.org%s', None), | 80 | 'oe_lists': ('https://lists.openembedded.org%s', None), |
81 | 'oe_git': ('https://git.openembedded.org%s', None), | 81 | 'oe_git': ('https://git.openembedded.org%s', None), |
82 | 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), | 82 | 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), |
83 | 'oe_layerindex': ('https://layers.openembedded.org%s', None), | ||
84 | 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), | ||
83 | } | 85 | } |
84 | 86 | ||
85 | # Intersphinx config to use cross reference with Bitbake user manual | 87 | # Intersphinx config to use cross reference with Bitbake user manual |
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 39db6563c3..79acb8671f 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -38,9 +38,8 @@ Follow these general steps to create your layer without using tools: | |||
38 | 38 | ||
39 | 1. *Check Existing Layers:* Before creating a new layer, you should be | 39 | 1. *Check Existing Layers:* Before creating a new layer, you should be |
40 | sure someone has not already created a layer containing the Metadata | 40 | sure someone has not already created a layer containing the Metadata |
41 | you need. You can see the `OpenEmbedded Metadata | 41 | you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` |
42 | Index <https://layers.openembedded.org/layerindex/layers/>`__ for a | 42 | for a list of layers from the OpenEmbedded community that can be used in |
43 | list of layers from the OpenEmbedded community that can be used in | ||
44 | the Yocto Project. You could find a layer that is identical or close | 43 | the Yocto Project. You could find a layer that is identical or close |
45 | to what you need. | 44 | to what you need. |
46 | 45 | ||
@@ -1194,8 +1193,8 @@ Before writing a recipe from scratch, it is often useful to discover | |||
1194 | whether someone else has already written one that meets (or comes close | 1193 | whether someone else has already written one that meets (or comes close |
1195 | to meeting) your needs. The Yocto Project and OpenEmbedded communities | 1194 | to meeting) your needs. The Yocto Project and OpenEmbedded communities |
1196 | maintain many recipes that might be candidates for what you are doing. | 1195 | maintain many recipes that might be candidates for what you are doing. |
1197 | You can find a good central index of these recipes in the `OpenEmbedded | 1196 | You can find a good central index of these recipes in the |
1198 | Layer Index <https://layers.openembedded.org>`__. | 1197 | :oe_layerindex:`OpenEmbedded Layer Index <>`. |
1199 | 1198 | ||
1200 | Working from an existing recipe or a skeleton recipe is the best way to | 1199 | Working from an existing recipe or a skeleton recipe is the best way to |
1201 | get started. Here are some points on both methods: | 1200 | get started. Here are some points on both methods: |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index 8fbbabbac5..221d5e1044 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -144,8 +144,7 @@ several pieces of hardware. | |||
144 | Many layers exist that work in the Yocto Project development | 144 | Many layers exist that work in the Yocto Project development |
145 | environment. The `Yocto Project Curated Layer | 145 | environment. The `Yocto Project Curated Layer |
146 | Index <https://www.yoctoproject.org/software-overview/layers/>`__ | 146 | Index <https://www.yoctoproject.org/software-overview/layers/>`__ |
147 | and `OpenEmbedded Layer | 147 | and :oe_layerindex:`OpenEmbedded Layer Index <>` |
148 | Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__ | ||
149 | both contain layers from which you can use or leverage. | 148 | both contain layers from which you can use or leverage. |
150 | 149 | ||
151 | By convention, layers in the Yocto Project follow a specific form. | 150 | By convention, layers in the Yocto Project follow a specific form. |
@@ -380,13 +379,11 @@ figure <#general-workflow-figure>`__: | |||
380 | 379 | ||
381 | - *Metadata (.bb + Patches):* Software layers containing | 380 | - *Metadata (.bb + Patches):* Software layers containing |
382 | user-supplied recipe files, patches, and append files. A good example | 381 | user-supplied recipe files, patches, and append files. A good example |
383 | of a software layer might be the | 382 | of a software layer might be the :oe_layer:`meta-qt5 layer </meta-qt5>` |
384 | `meta-qt5 layer <https://github.com/meta-qt5/meta-qt5>`__ from | 383 | from the :oe_layerindex:`OpenEmbedded Layer Index <>`. This layer is for |
385 | the `OpenEmbedded Layer | 384 | version 5.0 of the popular `Qt <https://wiki.qt.io/About_Qt>`__ |
386 | Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__. | 385 | cross-platform application development framework for desktop, embedded and |
387 | This layer is for version 5.0 of the popular | 386 | mobile. |
388 | `Qt <https://wiki.qt.io/About_Qt>`__ cross-platform application | ||
389 | development framework for desktop, embedded and mobile. | ||
390 | 387 | ||
391 | - *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e. | 388 | - *Machine BSP Configuration:* Board Support Package (BSP) layers (i.e. |
392 | "BSP Layer" in the following figure) providing machine-specific | 389 | "BSP Layer" in the following figure) providing machine-specific |
diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 456bfc549a..4da55a83d5 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst | |||
@@ -221,8 +221,7 @@ your Metadata, the easier it is to cope with future changes. | |||
221 | 221 | ||
222 | - Familiarize yourself with the `Yocto Project curated layer | 222 | - Familiarize yourself with the `Yocto Project curated layer |
223 | index <https://www.yoctoproject.org/software-overview/layers/>`__ | 223 | index <https://www.yoctoproject.org/software-overview/layers/>`__ |
224 | or the `OpenEmbedded layer | 224 | or the :oe_layerindex:`OpenEmbedded layer index <>`. |
225 | index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__. | ||
226 | The latter contains more layers but they are less universally | 225 | The latter contains more layers but they are less universally |
227 | validated. | 226 | validated. |
228 | 227 | ||
@@ -364,8 +363,7 @@ activities using the Yocto Project: | |||
364 | versions available for Yocto Project. The main purpose of the system | 363 | versions available for Yocto Project. The main purpose of the system |
365 | is to help you manage the recipes you maintain and to offer a dynamic | 364 | is to help you manage the recipes you maintain and to offer a dynamic |
366 | overview of the project. The Recipe Reporting System is built on top | 365 | overview of the project. The Recipe Reporting System is built on top |
367 | of the `OpenEmbedded Layer | 366 | of the :oe_layerindex:`OpenEmbedded Layer Index <>`, which |
368 | Index <http://layers.openembedded.org/layerindex/layers/>`__, which | ||
369 | is a website that indexes OpenEmbedded-Core layers. | 367 | is a website that indexes OpenEmbedded-Core layers. |
370 | 368 | ||
371 | - *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__ | 369 | - *Patchwork:* `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__ |
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index 3e9758119b..a52178b0c4 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst | |||
@@ -238,7 +238,7 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the | |||
238 | .. note:: | 238 | .. note:: |
239 | 239 | ||
240 | You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at | 240 | You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at |
241 | https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/. | 241 | :oe_layer:`/meta-gplv2`. |
242 | 242 | ||
243 | These relocated GPLv2 recipes do not receive the same level of | 243 | These relocated GPLv2 recipes do not receive the same level of |
244 | maintenance as other core recipes. The recipes do not get security fixes | 244 | maintenance as other core recipes. The recipes do not get security fixes |
diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst index c78b3f53da..57e5b2bb7b 100644 --- a/documentation/toaster-manual/intro.rst +++ b/documentation/toaster-manual/intro.rst | |||
@@ -27,7 +27,7 @@ extensive information about the build process. | |||
27 | - Browse layers listed in the various | 27 | - Browse layers listed in the various |
28 | :ref:`layer sources <toaster-manual/reference:layer source>` | 28 | :ref:`layer sources <toaster-manual/reference:layer source>` |
29 | that are available in your project (e.g. the OpenEmbedded Layer Index at | 29 | that are available in your project (e.g. the OpenEmbedded Layer Index at |
30 | http://layers.openembedded.org/layerindex/). | 30 | :oe_layerindex:`/`). |
31 | 31 | ||
32 | - Browse images, recipes, and machines provided by those layers. | 32 | - Browse images, recipes, and machines provided by those layers. |
33 | 33 | ||
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index dfe51889e8..34a1f39cff 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst | |||
@@ -24,7 +24,7 @@ type of layer source called a "layer index." | |||
24 | A layer index is a web application that contains information about a set | 24 | A layer index is a web application that contains information about a set |
25 | of custom layers. A good example of an existing layer index is the | 25 | of custom layers. A good example of an existing layer index is the |
26 | OpenEmbedded Layer Index. A public instance of this layer index exists | 26 | OpenEmbedded Layer Index. A public instance of this layer index exists |
27 | at http://layers.openembedded.org. You can find the code for this | 27 | at :oe_layerindex:`/`. You can find the code for this |
28 | layer index's web application at :yocto_git:`/layerindex-web/`. | 28 | layer index's web application at :yocto_git:`/layerindex-web/`. |
29 | 29 | ||
30 | When you tie a layer source into Toaster, it can query the layer source | 30 | When you tie a layer source into Toaster, it can query the layer source |
@@ -81,7 +81,7 @@ describes two methods by which you can configure and use your layer | |||
81 | index. | 81 | index. |
82 | 82 | ||
83 | In the previous section, the code for the OpenEmbedded Metadata Index | 83 | In the previous section, the code for the OpenEmbedded Metadata Index |
84 | (i.e. http://layers.openembedded.org) was referenced. You can use | 84 | (i.e. :oe_layerindex:`/`) was referenced. You can use |
85 | this code, which is at :yocto_git:`/layerindex-web/`, as a base to create | 85 | this code, which is at :yocto_git:`/layerindex-web/`, as a base to create |
86 | your own layer index. | 86 | your own layer index. |
87 | 87 | ||
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 2cb7884eb9..ded771e796 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst | |||
@@ -462,9 +462,8 @@ Using the Toaster Web Interface | |||
462 | 462 | ||
463 | The Toaster web interface allows you to do the following: | 463 | The Toaster web interface allows you to do the following: |
464 | 464 | ||
465 | - Browse published layers in the `OpenEmbedded Layer | 465 | - Browse published layers in the :oe_layerindex:`OpenEmbedded Layer Index <>` |
466 | Index <http://layers.openembedded.org>`__ that are available for your | 466 | that are available for your selected version of the build system. |
467 | selected version of the build system. | ||
468 | 467 | ||
469 | - Import your own layers for building. | 468 | - Import your own layers for building. |
470 | 469 | ||
@@ -573,11 +572,11 @@ However, the "Local Yocto Project" release will not provide you with any | |||
573 | compatible layers, other than the three core layers that come with the | 572 | compatible layers, other than the three core layers that come with the |
574 | Yocto Project: | 573 | Yocto Project: |
575 | 574 | ||
576 | - `openembedded-core <http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/>`__ | 575 | - :oe_layer:`openembedded-core </openembedded-core>` |
577 | 576 | ||
578 | - `meta-poky <http://layers.openembedded.org/layerindex/branch/master/layer/meta-poky/>`__ | 577 | - :oe_layer:`meta-poky </meta-poky>` |
579 | 578 | ||
580 | - `meta-yocto-bsp <http://layers.openembedded.org/layerindex/branch/master/layer/meta-yocto-bsp/>`__ | 579 | - :oe_layer:`meta-yocto-bsp </meta-yocto-bsp>` |
581 | 580 | ||
582 | .. image:: figures/compatible-layers.png | 581 | .. image:: figures/compatible-layers.png |
583 | :align: center | 582 | :align: center |
diff --git a/documentation/transitioning-to-a-custom-environment.rst b/documentation/transitioning-to-a-custom-environment.rst index 415f295b33..abbd74ca1d 100644 --- a/documentation/transitioning-to-a-custom-environment.rst +++ b/documentation/transitioning-to-a-custom-environment.rst | |||
@@ -29,8 +29,8 @@ Transitioning to a custom environment for systems development | |||
29 | 29 | ||
30 | #. **Find and acquire the best BSP for your target**. | 30 | #. **Find and acquire the best BSP for your target**. |
31 | Use the :yocto_home:`Yocto Project curated layer index | 31 | Use the :yocto_home:`Yocto Project curated layer index |
32 | </software-overview/layers/>` or even the `OpenEmbedded layer index | 32 | </software-overview/layers/>` or even the :oe_layerindex:`OpenEmbedded |
33 | <https://layers.openembedded.org>`_ to find and acquire the best BSP for your | 33 | layer index <>` to find and acquire the best BSP for your |
34 | target board. The Yocto Project layer index BSPs are regularly validated. The | 34 | target board. The Yocto Project layer index BSPs are regularly validated. The |
35 | best place to get your first BSP is from your silicon manufacturer or board | 35 | best place to get your first BSP is from your silicon manufacturer or board |
36 | vendor – they can point you to their most qualified efforts. In general, for | 36 | vendor – they can point you to their most qualified efforts. In general, for |
diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index a051036bb6..143f9fbfed 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst | |||
@@ -27,11 +27,10 @@ contact us with other suggestions. | |||
27 | to be responsible for your own updates. | 27 | to be responsible for your own updates. |
28 | 28 | ||
29 | #. **Get to know the layer index:** | 29 | #. **Get to know the layer index:** |
30 | All layers can be found in the `layer index | 30 | All layers can be found in the :oe_layerindex:`layer index <>`. Layers which |
31 | <https://layers.openembedded.org/>`_. Layers which have applied for Yocto | 31 | have applied for Yocto Project Compatible status (structure continuity |
32 | Project Compatible status (structure continuity assurance and testing) can be | 32 | assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index |
33 | found in the :yocto_home:`Yocto Project Compatible index | 33 | </software-over/layer/>`. Generally check the Compatible layer index first, |
34 | </software-over/layer/>`. Generally check the Compatible layer index first, | ||
35 | and if you don't find the necessary layer check the general layer index. The | 34 | and if you don't find the necessary layer check the general layer index. The |
36 | layer index is an original artifact from the Open Embedded Project. As such, | 35 | layer index is an original artifact from the Open Embedded Project. As such, |
37 | that index doesn't have the curating and testing that the Yocto Project | 36 | that index doesn't have the curating and testing that the Yocto Project |
@@ -172,7 +171,7 @@ contact us with other suggestions. | |||
172 | * add an ssh server to an image (enable transferring of files to target) | 171 | * add an ssh server to an image (enable transferring of files to target) |
173 | * know the anatomy of a recipe | 172 | * know the anatomy of a recipe |
174 | * know how to create and use layers | 173 | * know how to create and use layers |
175 | * find recipes (with the `OpenEmbedded Layer index <https://layers.openembedded.org>`_) | 174 | * find recipes (with the :oe_layerindex:`OpenEmbedded Layer index <>`) |
176 | * understand difference between machine and distro settings | 175 | * understand difference between machine and distro settings |
177 | * find and use the right BSP (machine) for your hardware | 176 | * find and use the right BSP (machine) for your hardware |
178 | * find examples of distro features and know where to set them | 177 | * find examples of distro features and know where to set them |