summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorRobert P. J. Day <rpjday@crashcourse.ca>2021-11-09 05:29:44 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-11-21 11:07:00 +0000
commit7e8f513910b795544d8264a615d893df295dfa4c (patch)
treed8e801858398440647fc6c0d478b3fcffe89ff41 /documentation
parentffe4af4feb3d99f716ae38f9af59b1338511c30d (diff)
downloadpoky-7e8f513910b795544d8264a615d893df295dfa4c.tar.gz
ref-manual: generalize definition of "container layer"
Given that there seems to be little value in being excruciatingly pedantic about whether a container layer has a valid layer as a top-level directory, expand the definition to allow either. (From yocto-docs rev: 95e5df9a51a7cda6588af523a3a0d6752613f189) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/terms.rst25
1 files changed, 21 insertions, 4 deletions
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index eccae91a1c..89b140e3fe 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -134,10 +134,27 @@ universal, the list includes them just in case:
134 the Texas Instruments ARM Cortex-A8 development board). 134 the Texas Instruments ARM Cortex-A8 development board).
135 135
136 :term:`Container Layer` 136 :term:`Container Layer`
137 Layers that hold other layers. An example of a container layer is 137 A flexible definition that typically refers to a single Git checkout
138 OpenEmbedded's `meta-openembedded 138 which contains multiple (and typically related) sub-layers which can
139 <https://github.com/openembedded/meta-openembedded>`_ layer. The 139 be included independently in your project's ``bblayers.conf`` file.
140 ``meta-openembedded`` layer contains many ``meta-*`` layers. 140
141 In some cases, such as with OpenEmbedded's
142 `meta-openembedded <https://github.com/openembedded/meta-openembedded>`_
143 layer, the top level ``meta-openembedded/`` directory is not itself an actual layer,
144 so you would never explicitly include it in a ``bblayers.conf`` file;
145 rather, you would include any number of its layer subdirectories, such as
146 `meta-openembedded/meta-oe <https://github.com/openembedded/meta-openembedded/tree/master/meta-oe>`_,
147 `meta-openembedded/meta-python <https://github.com/openembedded/meta-openembedded/tree/master/meta-python>`_
148 and so on.
149
150 On the other hand, some container layers (such as
151 `meta-security <https://git.yoctoproject.org/cgit/cgit.cgi/meta-security>`_)
152 have a top-level directory that is itself an actual layer, as well as
153 a variety of sub-layers, both of which could be included in your
154 ``bblayers.conf`` file.
155
156 In either case, the phrase "container layer" is simply used to describe
157 a directory structure which contains multiple valid OpenEmbedded layers.
141 158
142 :term:`Cross-Development Toolchain` 159 :term:`Cross-Development Toolchain`
143 In general, a cross-development toolchain is a collection of software 160 In general, a cross-development toolchain is a collection of software