SiegfriedSiegert/PTU5KAS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/userguide.rst: Add recommendation for repo-id naming

Browse Source 
This is added to avoid confusion in the creation of downstream layers.

Signed-off-by: Quirin Gylstorff <quirin.gylstorff@siemens.com>
[Jan: fixed over-long line]
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
This commit is contained in:
Quirin Gylstorff 2021-12-01 15:40:53 +01:00 committed by Jan Kiszka
parent 41dbef918a
commit 1dea24145e
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/userguide.rst
View File

@ -159,11 +159,16 @@ which are strings that are added to the head of the respective files
CONF_VERSION = "1"
IMAGE_FSTYPES = "tar"
``meta-custom`` in these examples should be a unique name (in project scope)
for this configuration entries. We assume that your configuration file is part
of a ``meta-custom`` repository/layer. This way its possible to overwrite or
append entries in files that include this configuration by naming an entry the
same (overwriting) or using an unused name (appending).
``meta-custom`` in these examples should be a unique name for this
configuration entries.
We recommend that this unique name is the **same** as the name of the
containing repository/layer to ease cross-project referencing.
In given examples we assume that your configuration file is part of a
``meta-custom`` repository/layer. This way it is possible to overwrite or
append entries in files that include this configuration by naming an entry
the same (overwriting) or using an unused name (appending).
Including in-tree configuration files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -358,7 +363,9 @@ Configuration reference
Contains the definition of a repository and the layers, that should be
part of the build. If the value is ``None``, the repository, where the
current configuration file is located is defined as ``<repo-id>`` and
added as a layer to the build.
added as a layer to the build. It is recommended that the ``<repo-id>``
is related to the containing repository/layer to ease cross-project
referencing.
* ``name``: string [optional]
Defines under which name the repository is stored. If its missing