Add documentation for the prohibited-path QA test and associated PROHIBITED_PATH variable.
Signed-off-by: Martyn Welch <mar...@welchs.me.uk> --- documentation/ref-manual/ref-classes.xml | 5 +++++ documentation/ref-manual/ref-variables.xml | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 5961d3e..15f5586 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -1714,6 +1714,11 @@ <filename>FILES_${PN} = "xyz"</filename> effectively turn into <filename>FILES = "xyz"</filename>. </para></listitem> + <listitem><para><emphasis><filename>prohibited-path:</filename></emphasis> + Checks that a recipe does not package and files in locations + specified in + <link linkend='var-PROHIBITED_PATH'><filename>PROHIBITED_PATH</filename></link>. + </para></listitem> <listitem><para><emphasis><filename>rpaths:</filename></emphasis> Checks for rpaths in the binaries that contain build system paths such as <filename>TMPDIR</filename>. diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index e31aa21..0bdbbba 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -10820,6 +10820,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-PROHIBITED_PATH'><glossterm>PROHIBITED_PATH</glossterm> + <info> + PROHIBITED_PATH[doc] = "A 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 list of paths in which recipes are prohibited from + installing. + Paths can be provided for specific locations or may include + a wildcard asterisk at the end to ensure nothing is + installed under the path provided. + </para> + + <para> + For example, the following + <filename>PROHIBITED_PATH</filename> ensures no packages + install anything under <filename>/mnt</filename>: + <literallayout class='monospaced'> + PROHIBITED_PATH += "/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 -- _______________________________________________ yocto mailing list yocto@yoctoproject.org https://lists.yoctoproject.org/listinfo/yocto