summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-02-09 21:10:37 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-02-15 10:26:44 +0000
commiteb79d7609979eb6f88d8b4e8e258294929f2209c (patch)
tree0d45ad54fe9c199121377063a1d7f06b726414bb
parentaec83663aadc871354b441eef0a3a41eb3780b13 (diff)
downloadpoky-eb79d7609979eb6f88d8b4e8e258294929f2209c.tar.gz
ref-manual: document SSTATE_EXCLUDEDEPS_SYSROOT
Backport from master: https://git.yoctoproject.org/yocto-docs/commit/?id=b6690011c14ce4bf30571f045152a9d324ad5039 (From yocto-docs rev: 733cbdc608d87b36e115689e97467117aee40442) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/conf.py1
-rw-r--r--documentation/ref-manual/ref-variables.rst26
2 files changed, 27 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index df67a5cdf2..e9078e054e 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -97,6 +97,7 @@ extlinks = {
97 'yocto_git': ('https://git.yoctoproject.org%s', None), 97 'yocto_git': ('https://git.yoctoproject.org%s', None),
98 'oe_home': ('https://www.openembedded.org%s', None), 98 'oe_home': ('https://www.openembedded.org%s', None),
99 'oe_lists': ('https://lists.openembedded.org%s', None), 99 'oe_lists': ('https://lists.openembedded.org%s', None),
100 'oe_git': ('https://git.openembedded.org%s', None),
100} 101}
101 102
102# Intersphinx config to use cross reference with Bitbake user manual 103# Intersphinx config to use cross reference with Bitbake user manual
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index b8d56a082b..f582bc72ea 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -7147,6 +7147,32 @@ system and gives an overview of their function and contents.
7147 :term:`SSTATE_DIR` 7147 :term:`SSTATE_DIR`
7148 The directory for the shared state cache. 7148 The directory for the shared state cache.
7149 7149
7150 :term:`SSTATE_EXCLUDEDEPS_SYSROOT`
7151 This variable allows to specify indirect dependencies to exclude
7152 from sysroots, for example to avoid the situations when a dependency on
7153 any ``-native`` recipe will pull in all dependencies of that recipe
7154 in the recipe sysroot. This behaviour might not always be wanted,
7155 for example when that ``-native`` recipe depends on build tools
7156 that are not relevant for the current recipe.
7157
7158 This way, irrelevant dependencies are ignored, which could have
7159 prevented the reuse of prebuilt artifacts stored in the Shared
7160 State Cache.
7161
7162 :term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular
7163 expressions of recipe and dependency to ignore. An example
7164 is the rule in :oe_git:`meta/conf/layer.conf </openembedded-core/tree/meta/conf/layer.conf>`::
7165
7166 # Nothing needs to depend on libc-initial
7167 # base-passwd/shadow-sysroot don't need their dependencies
7168 SSTATE_EXCLUDEDEPS_SYSROOT += "\
7169 .*->.*-initial.* \
7170 .*(base-passwd|shadow-sysroot)->.* \
7171 "
7172
7173 The ``->`` substring represents the dependency between
7174 the two regular expressions.
7175
7150 :term:`SSTATE_MIRROR_ALLOW_NETWORK` 7176 :term:`SSTATE_MIRROR_ALLOW_NETWORK`
7151 If set to "1", allows fetches from mirrors that are specified in 7177 If set to "1", allows fetches from mirrors that are specified in
7152 :term:`SSTATE_MIRRORS` to work even when 7178 :term:`SSTATE_MIRRORS` to work even when