Add documentation for the PROHIBITED_PATHS variable and associated
prohibited-path QA test
Signed-off-by: Martyn Welch <martyn.we...@collabora.co.uk>
---
Changes since v1:
- Correcting author and SOB.
Changes since v2:
- Reimplemented as image rather than package level QA test, altering
documentation to suit.
- Changed variable from PROHIBITED_PATH to PROHIBITED_PATHS to better
reflect its use.
documentation/ref-manual/ref-variables.xml | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/documentation/ref-manual/ref-variables.xml
b/documentation/ref-manual/ref-variables.xml
index e31aa21..1fb8a86 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -10820,6 +10820,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR =
"${INC_PR}.3"
</glossdef>
</glossentry>
+ <glossentry
id='var-PROHIBITED_PATHS'><glossterm>PROHIBITED_PATHS</glossterm>
+ <info>
+ PROHIBITED_PATHS[doc] = "A colon separated list of paths in
which recipes are prohibited from installing."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+<!-- <para role="glossdeffirst"><imagedata
fileref="figures/define-generic.png" /> -->
+ A colon separated list of paths in which recipes are
+ prohibited from installing.
+ Shell-style wildcards can be used in paths. All paths need
+ to be absolute paths.
+ </para>
+
+ <para>
+ For example, the following
+ <filename>PROHIBITED_PATHS</filename> ensures nothing is
+ installed under <filename>/mnt</filename>:
+ <literallayout class='monospaced'>
+ PROHIBITED_PATHS += "/mnt/*"
+ </literallayout>
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm>
<info>
PROVIDES[doc] = "A list of aliases that a recipe also
provides. These aliases are useful for satisfying dependencies of other recipes
during the build as specified by DEPENDS."
--
2.1.4
--
_______________________________________________
Openembedded-core mailing list
Openembedded-core@lists.openembedded.org
http://lists.openembedded.org/mailman/listinfo/openembedded-core
