| Message ID | 20231016120607.3054101-1-bhstalel@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | Add notes about layer.conf | expand |
Hi Talel, Thanks for this patch! On 16.10.23 at 14:06, BELHADJ SALEM Talel wrote: > Remove the second note in the previous PATCH as it's not accurate and can cause confusion. > > 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> Actually, we don't want the "Remove the second note..." line here as it would appear in the final commit message. The commit history should hide the review process and information about draft versions of the changes. You can add notes for reviewing after a "---" line after the Signed-off-by information. They won't appear in the final commit messages when the patches are applied. > --- > documentation/dev-manual/layers.rst | 10 ++++++++++ > 1 file changed, 10 insertions(+) > > diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst > index 2d809562d..070d82ee3 100644 > --- a/documentation/dev-manual/layers.rst > +++ b/documentation/dev-manual/layers.rst > @@ -128,6 +128,16 @@ 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 for the precense of Please use double backquotes in the above lines, instead of single ones. s/precense/presence/ > + :term:`BBFILE_COLLECTIONS` will lead to the obligation of :term:`LAYERSERIES_COMPAT`, and :term:`BBFILE_PATTERN`. This last sentence is difficult to understand. Did you mean... "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."? Thanks in advance for the update. Cheers Michael.
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 2d809562d..070d82ee3 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -128,6 +128,16 @@ 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 for the precense of + :term:`BBFILE_COLLECTIONS` will lead to the obligation of :term:`LAYERSERIES_COMPAT`, and :term:`BBFILE_PATTERN`. + #. *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
Remove the second note in the previous PATCH as it's not accurate and can cause confusion. 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 | 10 ++++++++++ 1 file changed, 10 insertions(+)