瀏覽代碼

bitbake: bitbake-user-manual: Updates to variable wildcard support.

Fixes [YOCTO #12390]

Applied some fixes to the variable wildcard support documentation
in the BitBake manual.  Wording changes and changes to make links
referencing Python syntax go to version 3 rather than version 2.

(Bitbake rev: 0cfc71d1a342b82781b0ba547421e41f6340902a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark 6 年之前
父節點
當前提交
2520246d67

+ 12 - 11
bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml

@@ -2752,27 +2752,28 @@
         </para>
     </section>
 
-    <section id='wildcard-support'>
-        <title>Wildcard Support</title>
+    <section id='wildcard-support-in-variables'>
+        <title>Wildcard Support in Variables</title>
 
         <para>
-            Support for wildcard use varies depending on the context in
-            which it is used.
+            Support for wildcard use in variables varies depending on the
+            context in which it is used.
             For example, some variables and file names allow limited use of
             wildcards through the "<filename>%</filename>" and
             "<filename>*</filename>" characters.
             Other variables or names support Python's
-            <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>
+            <ulink url='https://docs.python.org/3/library/glob.html'><filename>glob</filename></ulink>
             syntax,
-            <ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink>
-            syntax, or Regular Expression (re) syntax.
+            <ulink url='https://docs.python.org/3/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink>
+            syntax, or
+            <ulink url='https://docs.python.org/3/library/re.html#re'><filename>Regular Expression (re)</filename></ulink>
+            syntax.
         </para>
 
         <para>
-            When a particular variable's list of filenames or filenames
-            in general used by BitBake or a build system
-            based on BitBake support the use of wildcards, the
-            documentation describes its use and limitations.
+            For variables that have wildcard suport, the
+            documentation describes which form of wildcard, its
+            use, and its limitations.
         </para>
     </section>
 

+ 12 - 5
bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml

@@ -126,11 +126,18 @@
      BB_ALLOWED_NETWORKS = "*.gnu.org"
                             </literallayout>
                             <note><title>Important</title>
-                                The use of the "<filename>*</filename>"
+                                <para>The use of the "<filename>*</filename>"
                                 character only works at the beginning of
-                                a host name.
+                                a host name and it must be isolated from
+                                the remainder of the host name.
                                 You cannot use the wildcard character in any
-                                other location of the name.
+                                other location of the name or combined with
+                                the front part of the name.</para>
+
+                                <para>For example,
+                                <filename>*.foo.bar</filename> is supported,
+                                while <filename>*aa.foo.bar</filename> is not.
+                                </para>
                             </note>
                             </para></listitem>
                         <listitem><para>
@@ -1098,7 +1105,7 @@
                 <para>
                     When specifying recipe files, you can pattern match using
                     Python's
-                    <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>
+                    <ulink url='https://docs.python.org/3/library/glob.html'><filename>glob</filename></ulink>
                     syntax.
                     For details on the syntax, see the documentation by
                     following the previous link.
@@ -1198,7 +1205,7 @@
                     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>.
+                    <ulink url='http://docs.python.org/3/library/re.html#re'></ulink>.
                 </para>
 
                 <para>