public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: michael.opdenacker@bootlin.com
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	Talel BELHAJSALEM <bhstalel@gmail.com>
Subject: [kirkstone][PATCH 11/16] dev-manual: layers: Add notes about layer.conf
Date: Tue, 24 Oct 2023 15:27:07 +0200	[thread overview]
Message-ID: <20231024132712.90600-12-michael.opdenacker@bootlin.com> (raw)
In-Reply-To: <20231024132712.90600-1-michael.opdenacker@bootlin.com>

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

From: BELHADJ SALEM Talel <bhstalel@gmail.com>

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.

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/dev-manual/layers.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index c5c34134b6..16f62ee696 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:
       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`",
+      explaining how the ``layer.conf`` file is created from a template located in
+      ``meta/lib/bblayers/templates/layer.conf``.
+      In fact, none of the variables set in ``layer.conf`` are mandatory,
+      except when :term:`BBFILE_COLLECTIONS` is present. In this case
+      :term:`LAYERSERIES_COMPAT` and :term:`BBFILE_PATTERN` 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
-- 
2.34.1



  parent reply	other threads:[~2023-10-24 13:27 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-24 13:26 [kirkstone][PATCH 00/16] kirkstone documentation backports michael.opdenacker
2023-10-24 13:26 ` [kirkstone][PATCH 01/16] ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipes michael.opdenacker
2023-10-24 13:26 ` [kirkstone][PATCH 02/16] manuals: update linux-yocto append examples michael.opdenacker
2023-10-24 13:26 ` [kirkstone][PATCH 03/16] dev-manual: wic: update "wic list images" output michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 04/16] sdk-manual: appendix-obtain: improve and update descriptions michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 05/16] bsp-guide: bsp: skip Intel machines no longer supported in Poky michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 06/16] dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" section michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 07/16] dev/ref-manual: Document INIT_MANAGER michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 08/16] ref-manual: Fix PACKAGECONFIG term and add an example michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 09/16] profile-manual: aesthetic cleanups michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 10/16] ref-manual: variables: provide no-match example for COMPATIBLE_MACHINE michael.opdenacker
2023-10-24 13:27 ` michael.opdenacker [this message]
2023-10-24 13:27 ` [kirkstone][PATCH 12/16] brief-yoctoprojectqs: use new CDN mirror for sstate michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 13/16] dev-manual: start.rst: remove obsolete reference michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 14/16] ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVE michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 15/16] ref-manual: variables: add TOOLCHAIN_OPTIONS variable michael.opdenacker
2023-10-24 13:27 ` [kirkstone][PATCH 16/16] ref-manual: variables: add example for SYSROOT_DIRS variable michael.opdenacker

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231024132712.90600-12-michael.opdenacker@bootlin.com \
    --to=michael.opdenacker@bootlin.com \
    --cc=bhstalel@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox