summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-10-18 13:15:49 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-10-29 16:54:48 +0000
commit8c0a94129e0e1699cd72fd965ac1cc6504b1269f (patch)
tree5eb847e6938935b08c9e60a4da107036e8570450 /bitbake/doc
parent3e5c6cbf3475b513458a0bfc57dcd3353dd9e44d (diff)
downloadpoky-8c0a94129e0e1699cd72fd965ac1cc6504b1269f.tar.gz
bitbake: bitbake-user-manual: Added wildcarding descriptions
Fixes [YOCTO #12390] Added specific descriptions for how wildcarding works for a variety of variables and files (e.g. append files). (Bitbake rev: 0a4377cb1837ede213d9640344f4908de3689d91) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml13
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml25
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml50
3 files changed, 79 insertions, 9 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
index 9e2e6b2eb2..f7d312a32b 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
@@ -342,13 +342,14 @@
342 342
343 <para> 343 <para>
344 When you name an append file, you can use the 344 When you name an append file, you can use the
345 wildcard character (%) to allow for matching recipe names. 345 "<filename>%</filename>" wildcard character to allow for matching
346 recipe names.
346 For example, suppose you have an append file named 347 For example, suppose you have an append file named
347 as follows: 348 as follows:
348 <literallayout class='monospaced'> 349 <literallayout class='monospaced'>
349 busybox_1.21.%.bbappend 350 busybox_1.21.%.bbappend
350 </literallayout> 351 </literallayout>
351 That append file would match any <filename>busybox_1.21.x.bb</filename> 352 That append file would match any <filename>busybox_1.21.</filename><replaceable>x</replaceable><filename>.bb</filename>
352 version of the recipe. 353 version of the recipe.
353 So, the append file would match the following recipe names: 354 So, the append file would match the following recipe names:
354 <literallayout class='monospaced'> 355 <literallayout class='monospaced'>
@@ -356,6 +357,14 @@
356 busybox_1.21.2.bb 357 busybox_1.21.2.bb
357 busybox_1.21.3.bb 358 busybox_1.21.3.bb
358 </literallayout> 359 </literallayout>
360 <note><title>Important</title>
361 The use of the "<filename>%</filename>" character
362 is limited in that it only works directly in front of the
363 <filename>.bbappend</filename> portion of the append file's
364 name.
365 You cannot use the wildcard character in any other
366 location of the name.
367 </note>
359 If the <filename>busybox</filename> recipe was updated to 368 If the <filename>busybox</filename> recipe was updated to
360 <filename>busybox_1.3.0.bb</filename>, the append name would not 369 <filename>busybox_1.3.0.bb</filename>, the append name would not
361 match. 370 match.
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index fc55ef6483..df5364c299 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -2751,4 +2751,29 @@
2751 </itemizedlist> 2751 </itemizedlist>
2752 </para> 2752 </para>
2753 </section> 2753 </section>
2754
2755 <section id='wildcard-support'>
2756 <title>Wildcard Support</title>
2757
2758 <para>
2759 Support for wildcard use varies depending on the context in
2760 which it is used.
2761 For example, some variables and file names allow limited use of
2762 wildcards through the "<filename>%</filename>" and
2763 "<filename>*</filename>" characters.
2764 Other variables or names support Python's
2765 <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>
2766 syntax,
2767 <ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink>
2768 syntax, or Regular Expression (re) syntax.
2769 </para>
2770
2771 <para>
2772 When a particular variable's list of filenames or filenames
2773 in general used by BitBake or a build system
2774 based on BitBake support the use of wildcards, the
2775 documentation describes its use and limitations.
2776 </para>
2777 </section>
2778
2754</chapter> 2779</chapter>
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
index c327af52a9..d480881a24 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
@@ -115,7 +115,8 @@
115 is either not set or set to "0". 115 is either not set or set to "0".
116 </para></listitem> 116 </para></listitem>
117 <listitem><para> 117 <listitem><para>
118 Limited support for wildcard matching against the 118 Limited support for the "<filename>*</filename>"
119 wildcard character for matching against the
119 beginning of host names exists. 120 beginning of host names exists.
120 For example, the following setting matches 121 For example, the following setting matches
121 <filename>git.gnu.org</filename>, 122 <filename>git.gnu.org</filename>,
@@ -124,6 +125,13 @@
124 <literallayout class='monospaced'> 125 <literallayout class='monospaced'>
125 BB_ALLOWED_NETWORKS = "*.gnu.org" 126 BB_ALLOWED_NETWORKS = "*.gnu.org"
126 </literallayout> 127 </literallayout>
128 <note><title>Important</title>
129 The use of the "<filename>*</filename>"
130 character only works at the beginning of
131 a host name.
132 You cannot use the wildcard character in any
133 other location of the name.
134 </note>
127 </para></listitem> 135 </para></listitem>
128 <listitem><para> 136 <listitem><para>
129 Mirrors not in the host list are skipped and 137 Mirrors not in the host list are skipped and
@@ -1082,7 +1090,19 @@
1082 1090
1083 <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> 1091 <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
1084 <glossdef> 1092 <glossdef>
1085 <para>List of recipe files BitBake uses to build software.</para> 1093 <para>
1094 A space-separated list of recipe files BitBake uses to
1095 build software.
1096 </para>
1097
1098 <para>
1099 When specifying recipe files, you can pattern match using
1100 Python's
1101 <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>
1102 syntax.
1103 For details on the syntax, see the documentation by
1104 following the previous link.
1105 </para>
1086 </glossdef> 1106 </glossdef>
1087 </glossentry> 1107 </glossentry>
1088 1108
@@ -1166,10 +1186,14 @@
1166 match any of the expressions. 1186 match any of the expressions.
1167 It is as if BitBake does not see them at all. 1187 It is as if BitBake does not see them at all.
1168 Consequently, matching files are not parsed or otherwise 1188 Consequently, matching files are not parsed or otherwise
1169 used by BitBake.</para> 1189 used by BitBake.
1190 </para>
1191
1170 <para> 1192 <para>
1171 The values you provide are passed to Python's regular 1193 The values you provide are passed to Python's regular
1172 expression compiler. 1194 expression compiler.
1195 Consequently, the syntax follows Python's Regular
1196 Expression (re) syntax.
1173 The expressions are compared against the full paths to 1197 The expressions are compared against the full paths to
1174 the files. 1198 the files.
1175 For complete syntax information, see Python's 1199 For complete syntax information, see Python's
@@ -1933,15 +1957,27 @@
1933 you want to select, and you should set 1957 you want to select, and you should set
1934 <link linkend='var-PV'><filename>PV</filename></link> 1958 <link linkend='var-PV'><filename>PV</filename></link>
1935 accordingly for precedence. 1959 accordingly for precedence.
1936 You can use the "<filename>%</filename>" character as a 1960 </para>
1937 wildcard to match any number of characters, which can be 1961
1938 useful when specifying versions that contain long revision 1962 <para>
1939 numbers that could potentially change. 1963 The <filename>PREFERRED_VERSION</filename> variable
1964 supports limited wildcard use through the
1965 "<filename>%</filename>" character.
1966 You can use the character to match any number of
1967 characters, which can be useful when specifying versions
1968 that contain long revision numbers that potentially change.
1940 Here are two examples: 1969 Here are two examples:
1941 <literallayout class='monospaced'> 1970 <literallayout class='monospaced'>
1942 PREFERRED_VERSION_python = "2.7.3" 1971 PREFERRED_VERSION_python = "2.7.3"
1943 PREFERRED_VERSION_linux-yocto = "4.12%" 1972 PREFERRED_VERSION_linux-yocto = "4.12%"
1944 </literallayout> 1973 </literallayout>
1974 <note><title>Important</title>
1975 The use of the "<filename>%</filename>" character
1976 is limited in that it only works at the end of the
1977 string.
1978 You cannot use the wildcard character in any other
1979 location of the string.
1980 </note>
1945 </para> 1981 </para>
1946 </glossdef> 1982 </glossdef>
1947 </glossentry> 1983 </glossentry>