From 718e3b49842520ca2523a88b6488ee3195a9ff6e Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Wed, 30 Jan 2013 15:42:26 -0600
Subject: 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>
---
 .../dev-manual/dev-manual-common-tasks.xml         | 27 +++++++++++++++-------
 1 file changed, 19 insertions(+), 8 deletions(-)

(limited to 'documentation/dev-manual')

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 @@
         <title>Excluding Recipes From the Build</title>
 
         <para>
-            You might find that there are groups of recipes you want to filter
-            out of the build process.
+            You might find that there are groups of recipes or append files
+            that you want to filter out of the build process.
             For example, recipes you know you will never use or want should not
             be part of the build.
-            Removing these recipes from parsing speeds up parts of the build.
+            Removing these files from parsing speeds up parts of the build.
         </para>
 
         <para>
             It is possible to filter or mask out <filename>.bb</filename> and
             <filename>.bbappend</filename> files.
             You can do this by providing an expression with the
-            <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'>BBMASK</ulink></filename>
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'><filename>BBMASK</filename></ulink>
             variable.
             Here is an example:
             <literallayout class='monospaced'>
-     BBMASK = ".*/meta-mymachine/recipes-maybe/"
+     BBMASK = "/meta-mymachine/recipes-maybe/"
             </literallayout>
-            Here, all <filename>.bb</filename> and <filename>.bbappend</filename> files
-            in the directory that match the expression are ignored during the build
-            process.
+            Here, all <filename>.bb</filename> and
+            <filename>.bbappend</filename> files in the directory that matches
+            the expression are ignored during the build process.
+            See the glossary entry for the
+            <ulink url='&YOCTO_DOCS_REF_URL;#var-BBMASK'><filename>BBMASK</filename></ulink>
+            variable for more information.
         </para>
+
+        <note>
+            The value you provide is passed to python's regular expression
+            compiler.
+            The expression is compared against the full paths to the files.
+            For complete syntax information, see python's documentation at
+            <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>.
+        </note>
     </section>
 
     <section id="platdev-appdev-srcrev">
-- 
cgit v1.2.3-54-g00ecf