summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-01-30 15:42:26 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-02-14 17:24:00 +0000
commit718e3b49842520ca2523a88b6488ee3195a9ff6e (patch)
tree86fd2c12d3b82b0993a33e7a150e93e9e58423db /documentation/ref-manual/ref-variables.xml
parent6a926df682a3964d6b5bc65c6610acf7463adaee (diff)
downloadpoky-718e3b49842520ca2523a88b6488ee3195a9ff6e.tar.gz
ref-manual, dev-manual: Updates to BBMASK variable.
Fixes YOCTO #3662 I added more information to the variable desription in the glossary for BBMASK. The information included a bit more syntax information as well as some more complex examples. I added more reference information to the "Excluding Recipes From the Build" section to help better describe how the BBMASK variable works. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: f10f43a543e7b0892863e165d2902741a8823009) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml69
1 files changed, 52 insertions, 17 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0a29502544..ff9a227db1 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -342,26 +342,61 @@
342 342
343 <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> 343 <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm>
344 <glossdef> 344 <glossdef>
345 <para>Prevents BitBake from processing recipes and recipe append files. 345 <para>
346 You can use the <filename>BBMASK</filename> variable to "hide" 346 Prevents BitBake from processing recipes and recipe
347 these <filename>.bb</filename> and <filename>.bbappend</filename> files. 347 append files.
348 BitBake ignores any recipe or recipe append files that match the expression. 348 Use the <filename>BBMASK</filename> variable from within the
349 <filename>conf/local.conf</filename> file found
350 in the
351 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
352 </para>
353
354 <para>
355 You can use the <filename>BBMASK</filename> variable
356 to "hide" these <filename>.bb</filename> and
357 <filename>.bbappend</filename> files.
358 BitBake ignores any recipe or recipe append files that
359 match the expression.
349 It is as if BitBake does not see them at all. 360 It is as if BitBake does not see them at all.
350 Consequently, matching files are not parsed or otherwise used by 361 Consequently, matching files are not parsed or otherwise
351 BitBake.</para> 362 used by BitBake.</para>
352 <para>The value you provide is passed to python's regular expression compiler. 363 <para>
353 For complete syntax information, see python's documentation at 364 The value you provide is passed to python's regular
365 expression compiler.
366 The expression is compared against the full paths to
367 the files.
368 For complete syntax information, see python's
369 documentation at
354 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. 370 <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
355 The expression is compared against the full paths to the files. 371 </para>
356 For example, the following uses a complete regular expression to tell 372
357 BitBake to ignore all recipe and recipe append files in the 373 <para>
358 <filename>.*/meta-ti/recipes-misc/</filename> directory: 374 The following example uses a complete regular expression
375 to tell BitBake to ignore all recipe and recipe append
376 files in the <filename>/meta-ti/recipes-misc/</filename>
377 directory:
359 <literallayout class='monospaced'> 378 <literallayout class='monospaced'>
360 BBMASK = ".*/meta-ti/recipes-misc/" 379 BBMASK = "/meta-ti/recipes-misc/"
361 </literallayout></para> 380 </literallayout>
362 <para>Use the <filename>BBMASK</filename> variable from within the 381 If you want to mask out multiple directories or recipes,
363 <filename>conf/local.conf</filename> file found 382 use the vertical bar to separate the regular expression
364 in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.</para> 383 fragments.
384 This next example masks out multiple directories and
385 individual recipes:
386 <literallayout class='monospaced'>
387 BBMASK = "meta-ti/recipes-misc/|meta-ti/recipes-ti/packagegroup/"
388 BBMASK .= "|.*meta-oe/recipes-support/"
389 BBMASK .= "|.*openldap"
390 BBMASK .= "|.*opencv"
391 BBMASK .= "|.*lzma"
392 </literallayout>
393 Notice how the vertical bar is used to append the fragments.
394 <note>
395 When specifying a directory name, use the trailing
396 slash character to ensure you match just that directory
397 name.
398 </note>
399 </para>
365 </glossdef> 400 </glossdef>
366 </glossentry> 401 </glossentry>
367 402