| Message ID | 20231017120524.3094506-1-bhstalel@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | dev-manual: layers: Add notes about layer.conf | expand |
On 17.10.23 at 14:05, BELHADJ SALEM Talel wrote: > As discussed before with Richard Purdie, the code supports this but the documentation is 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. > > Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> > --- > documentation/dev-manual/layers.rst | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst > index 2d809562d..7e83d9a3a 100644 > --- a/documentation/dev-manual/layers.rst > +++ b/documentation/dev-manual/layers.rst > @@ -128,6 +128,17 @@ Follow these general steps to create your layer without using tools: > variable is a good way to indicate if your particular layer is > current. > > + > + .. note:: > + > + A layer does not have to contain only recipes ``.bb`` or append files ``.bbappend``. > + Generally, developers create layers using ``bitbake-layers create-layer``, see > + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`", that > + creates the ``layer.conf`` file from a template located in ``meta/lib/bblayers/templates/layer.conf``. > + In fact, all the variables set in ``layer.conf`` are not mandatory, > + except when :term:`BBFILE_COLLECTIONS` is present. In this case > + :term:`LAYERSERIES_COMPAT` and :term:`BBFILE_PATTERN` will have to be defined too. > + > #. *Add Content:* Depending on the type of layer, add the content. If > the layer adds support for a machine, add the machine configuration > in a ``conf/machine/`` file within the layer. If the layer adds Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> (after a few extra minor tweaks on a couple sentences) Merged into "master-next". Thanks again! Michael.
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 2d809562d..7e83d9a3a 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -128,6 +128,17 @@ Follow these general steps to create your layer without using tools: variable is a good way to indicate if your particular layer is current. + + .. note:: + + A layer does not have to contain only recipes ``.bb`` or append files ``.bbappend``. + Generally, developers create layers using ``bitbake-layers create-layer``, see + ":ref:`dev-manual/layers:creating a general layer using the \`\`bitbake-layers\`\` script`", that + creates the ``layer.conf`` file from a template located in ``meta/lib/bblayers/templates/layer.conf``. + In fact, all the variables set in ``layer.conf`` are not mandatory, + except when :term:`BBFILE_COLLECTIONS` is present. In this case + :term:`LAYERSERIES_COMPAT` and :term:`BBFILE_PATTERN` will have to be defined too. + #. *Add Content:* Depending on the type of layer, add the content. If the layer adds support for a machine, add the machine configuration in a ``conf/machine/`` file within the layer. If the layer adds
As discussed before with Richard Purdie, the code supports this but the documentation is 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. Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> --- documentation/dev-manual/layers.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)