diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-09 19:01:55 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
commit | 6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06 (patch) | |
tree | 6a59e9936ac9f2ca063d4fc8a5c4d9ecc9492769 /documentation/dev-manual/layers.rst | |
parent | 474e071608c7c1c97e9dafde810aef5630c716e7 (diff) | |
download | poky-6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06.tar.gz |
manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc.
(From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/layers.rst')
-rw-r--r-- | documentation/dev-manual/layers.rst | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index ad22524833..2d809562d1 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst | |||
@@ -28,14 +28,14 @@ Creating Your Own Layer | |||
28 | 28 | ||
29 | Follow these general steps to create your layer without using tools: | 29 | Follow these general steps to create your layer without using tools: |
30 | 30 | ||
31 | 1. *Check Existing Layers:* Before creating a new layer, you should be | 31 | #. *Check Existing Layers:* Before creating a new layer, you should be |
32 | sure someone has not already created a layer containing the Metadata | 32 | sure someone has not already created a layer containing the Metadata |
33 | you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` | 33 | you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` |
34 | for a list of layers from the OpenEmbedded community that can be used in | 34 | for a list of layers from the OpenEmbedded community that can be used in |
35 | the Yocto Project. You could find a layer that is identical or close | 35 | the Yocto Project. You could find a layer that is identical or close |
36 | to what you need. | 36 | to what you need. |
37 | 37 | ||
38 | 2. *Create a Directory:* Create the directory for your layer. When you | 38 | #. *Create a Directory:* Create the directory for your layer. When you |
39 | create the layer, be sure to create the directory in an area not | 39 | create the layer, be sure to create the directory in an area not |
40 | associated with the Yocto Project :term:`Source Directory` | 40 | associated with the Yocto Project :term:`Source Directory` |
41 | (e.g. the cloned ``poky`` repository). | 41 | (e.g. the cloned ``poky`` repository). |
@@ -58,7 +58,7 @@ Follow these general steps to create your layer without using tools: | |||
58 | "meta-" string are appended to several variables used in the | 58 | "meta-" string are appended to several variables used in the |
59 | configuration. | 59 | configuration. |
60 | 60 | ||
61 | 3. *Create a Layer Configuration File:* Inside your new layer folder, | 61 | #. *Create a Layer Configuration File:* Inside your new layer folder, |
62 | you need to create a ``conf/layer.conf`` file. It is easiest to take | 62 | you need to create a ``conf/layer.conf`` file. It is easiest to take |
63 | an existing layer configuration file and copy that to your layer's | 63 | an existing layer configuration file and copy that to your layer's |
64 | ``conf`` directory and then modify the file as needed. | 64 | ``conf`` directory and then modify the file as needed. |
@@ -128,7 +128,7 @@ Follow these general steps to create your layer without using tools: | |||
128 | variable is a good way to indicate if your particular layer is | 128 | variable is a good way to indicate if your particular layer is |
129 | current. | 129 | current. |
130 | 130 | ||
131 | 4. *Add Content:* Depending on the type of layer, add the content. If | 131 | #. *Add Content:* Depending on the type of layer, add the content. If |
132 | the layer adds support for a machine, add the machine configuration | 132 | the layer adds support for a machine, add the machine configuration |
133 | in a ``conf/machine/`` file within the layer. If the layer adds | 133 | in a ``conf/machine/`` file within the layer. If the layer adds |
134 | distro policy, add the distro configuration in a ``conf/distro/`` | 134 | distro policy, add the distro configuration in a ``conf/distro/`` |
@@ -141,7 +141,7 @@ Follow these general steps to create your layer without using tools: | |||
141 | Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" | 141 | Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" |
142 | section in the Yocto Project Board Support Package (BSP) Developer's Guide. | 142 | section in the Yocto Project Board Support Package (BSP) Developer's Guide. |
143 | 143 | ||
144 | 5. *Optionally Test for Compatibility:* If you want permission to use | 144 | #. *Optionally Test for Compatibility:* If you want permission to use |
145 | the Yocto Project Compatibility logo with your layer or application | 145 | the Yocto Project Compatibility logo with your layer or application |
146 | that uses your layer, perform the steps to apply for compatibility. | 146 | that uses your layer, perform the steps to apply for compatibility. |
147 | See the | 147 | See the |
@@ -292,13 +292,13 @@ The Yocto Project Compatibility Program consists of a layer application | |||
292 | process that requests permission to use the Yocto Project Compatibility | 292 | process that requests permission to use the Yocto Project Compatibility |
293 | Logo for your layer and application. The process consists of two parts: | 293 | Logo for your layer and application. The process consists of two parts: |
294 | 294 | ||
295 | 1. Successfully passing a script (``yocto-check-layer``) that when run | 295 | #. Successfully passing a script (``yocto-check-layer``) that when run |
296 | against your layer, tests it against constraints based on experiences | 296 | against your layer, tests it against constraints based on experiences |
297 | of how layers have worked in the real world and where pitfalls have | 297 | of how layers have worked in the real world and where pitfalls have |
298 | been found. Getting a "PASS" result from the script is required for | 298 | been found. Getting a "PASS" result from the script is required for |
299 | successful compatibility registration. | 299 | successful compatibility registration. |
300 | 300 | ||
301 | 2. Completion of an application acceptance form, which you can find at | 301 | #. Completion of an application acceptance form, which you can find at |
302 | :yocto_home:`/webform/yocto-project-compatible-registration`. | 302 | :yocto_home:`/webform/yocto-project-compatible-registration`. |
303 | 303 | ||
304 | To be granted permission to use the logo, you need to satisfy the | 304 | To be granted permission to use the logo, you need to satisfy the |
@@ -870,10 +870,10 @@ checked out first), or into a completely independent location. | |||
870 | The replication of the layers is performed by running the ``setup-layers`` script provided | 870 | The replication of the layers is performed by running the ``setup-layers`` script provided |
871 | above: | 871 | above: |
872 | 872 | ||
873 | 1. Clone the bootstrap layer or some other repository to obtain | 873 | #. Clone the bootstrap layer or some other repository to obtain |
874 | the json config and the setup script that can use it. | 874 | the json config and the setup script that can use it. |
875 | 875 | ||
876 | 2. Run the script directly with no options:: | 876 | #. Run the script directly with no options:: |
877 | 877 | ||
878 | alex@Zen2:/srv/work/alex/my-build$ meta-alex/setup-layers | 878 | alex@Zen2:/srv/work/alex/my-build$ meta-alex/setup-layers |
879 | Note: not checking out source meta-alex, use --force-bootstraplayer-checkout to override. | 879 | Note: not checking out source meta-alex, use --force-bootstraplayer-checkout to override. |