diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 27 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 69 |
2 files changed, 71 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 2ae83810e1..e7655ade9f 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -2321,27 +2321,38 @@ | |||
2321 | <title>Excluding Recipes From the Build</title> | 2321 | <title>Excluding Recipes From the Build</title> |
2322 | 2322 | ||
2323 | <para> | 2323 | <para> |
2324 | You might find that there are groups of recipes you want to filter | 2324 | You might find that there are groups of recipes or append files |
2325 | out of the build process. | 2325 | that you want to filter out of the build process. |
2326 | For example, recipes you know you will never use or want should not | 2326 | For example, recipes you know you will never use or want should not |
2327 | be part of the build. | 2327 | be part of the build. |
2328 | Removing these recipes from parsing speeds up parts of the build. | 2328 | Removing these files from parsing speeds up parts of the build. |
2329 | </para> | 2329 | </para> |
2330 | 2330 | ||
2331 | <para> | 2331 | <para> |
2332 | It is possible to filter or mask out <filename>.bb</filename> and | 2332 | It is possible to filter or mask out <filename>.bb</filename> and |
2333 | <filename>.bbappend</filename> files. | 2333 | <filename>.bbappend</filename> files. |
2334 | You can do this by providing an expression with the | 2334 | You can do this by providing an expression with the |
2335 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename> | 2335 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'><filename>BBMASK</filename></ulink> |
2336 | variable. | 2336 | variable. |
2337 | Here is an example: | 2337 | Here is an example: |
2338 | <literallayout class='monospaced'> | 2338 | <literallayout class='monospaced'> |
2339 | BBMASK = ".*/meta-mymachine/recipes-maybe/" | 2339 | BBMASK = "/meta-mymachine/recipes-maybe/" |
2340 | </literallayout> | 2340 | </literallayout> |
2341 | Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files | 2341 | Here, all <filename>.bb</filename> and |
2342 | in the directory that match the expression are ignored during the build | 2342 | <filename>.bbappend</filename> files in the directory that matches |
2343 | process. | 2343 | the expression are ignored during the build process. |
2344 | See the glossary entry for the | ||
2345 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'><filename>BBMASK</filename></ulink> | ||
2346 | variable for more information. | ||
2344 | </para> | 2347 | </para> |
2348 | |||
2349 | <note> | ||
2350 | The value you provide is passed to python's regular expression | ||
2351 | compiler. | ||
2352 | The expression is compared against the full paths to the files. | ||
2353 | For complete syntax information, see python's documentation at | ||
2354 | <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. | ||
2355 | </note> | ||
2345 | </section> | 2356 | </section> |
2346 | 2357 | ||
2347 | <section id="platdev-appdev-srcrev"> | 2358 | <section id="platdev-appdev-srcrev"> |
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 | ||