summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBELHADJ SALEM Talel <bhstalel@gmail.com>2023-10-17 13:05:24 +0100
committerSteve Sakoman <steve@sakoman.com>2023-10-25 04:51:01 -1000
commit9438f3d1fdbb5439a2c294ea0560895cf0d97484 (patch)
treea886aa7c2020a0db924cf68e2e1460cf44abcbfb
parent1680e558e15755a8ef03207f8fd1096336009872 (diff)
downloadpoky-9438f3d1fdbb5439a2c294ea0560895cf0d97484.tar.gz
dev-manual: layers: Add notes about layer.conf
As discussed before with Richard Purdie, the code supports this but the documentation does not. Developers in general will not notice this or focus on it because they do not mess with the layer.conf template file, but in my opinion I think more details can help. (From yocto-docs rev: 635b198dfeb8147728a610b710fbc8ce77859389) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/dev-manual/layers.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 2d809562d1..c65a94b4fa 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -128,6 +128,20 @@ 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
132 .. note::
133
134 A layer does not have to contain only recipes ``.bb`` or append files
135 ``.bbappend``. Generally, developers create layers using
136 ``bitbake-layers create-layer``.
137 See ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`",
138 explaining how the ``layer.conf`` file is created from a template located in
139 ``meta/lib/bblayers/templates/layer.conf``.
140 In fact, none of the variables set in ``layer.conf`` are mandatory,
141 except when :term:`BBFILE_COLLECTIONS` is present. In this case
142 :term:`LAYERSERIES_COMPAT` and :term:`BBFILE_PATTERN` have to be
143 defined too.
144
131#. *Add Content:* Depending on the type of layer, add the content. If 145#. *Add Content:* Depending on the type of layer, add the content. If
132 the layer adds support for a machine, add the machine configuration 146 the layer adds support for a machine, add the machine configuration
133 in a ``conf/machine/`` file within the layer. If the layer adds 147 in a ``conf/machine/`` file within the layer. If the layer adds