mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 05:09:24 +00:00
Code Issues Projects Releases Wiki Activity

bitbake: bitbake-user-manual: Added wildcarding descriptions

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2018-10-18 13:15:49 -07:00
committed by Richard Purdie
parent 3e5c6cbf34
commit 8c0a94129e
3 changed files with 79 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml
+11 -2
View File
@@ -342,13 +342,14 @@
<para>
When you name an append file, you can use the
wildcard character (%) to allow for matching recipe names.
"<filename>%</filename>" wildcard character to allow for matching
recipe names.
For example, suppose you have an append file named
as follows:
<literallayout class='monospaced'>
busybox_1.21.%.bbappend
</literallayout>
That append file would match any <filename>busybox_1.21.x.bb</filename>
That append file would match any <filename>busybox_1.21.</filename><replaceable>x</replaceable><filename>.bb</filename>
version of the recipe.
So, the append file would match the following recipe names:
<literallayout class='monospaced'>
@@ -356,6 +357,14 @@
busybox_1.21.2.bb
busybox_1.21.3.bb
</literallayout>
<note><title>Important</title>
The use of the "<filename>%</filename>" character
is limited in that it only works directly in front of the
<filename>.bbappend</filename> portion of the append file's
name.
You cannot use the wildcard character in any other
location of the name.
</note>
If the <filename>busybox</filename> recipe was updated to
<filename>busybox_1.3.0.bb</filename>, the append name would not
match.
bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+25
View File
@@ -2751,4 +2751,29 @@
</itemizedlist>
</para>
</section>
<section id='wildcard-support'>
<title>Wildcard Support</title>
<para>
Support for wildcard use 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>
syntax,
<ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink>
syntax, or Regular Expression (re) 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.
</para>
</section>
</chapter>
bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
+43 -7
View File
@@ -115,7 +115,8 @@
is either not set or set to "0".
</para></listitem>
<listitem><para>
Limited support for wildcard matching against the
Limited support for the "<filename>*</filename>"
wildcard character for matching against the
beginning of host names exists.
For example, the following setting matches
<filename>git.gnu.org</filename>,
@@ -124,6 +125,13 @@
<literallayout class='monospaced'>
BB_ALLOWED_NETWORKS = "*.gnu.org"
</literallayout>
<note><title>Important</title>
The use of the "<filename>*</filename>"
character only works at the beginning of
a host name.
You cannot use the wildcard character in any
other location of the name.
</note>
</para></listitem>
<listitem><para>
Mirrors not in the host list are skipped and
@@ -1082,7 +1090,19 @@
<glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
<glossdef>
<para>List of recipe files BitBake uses to build software.</para>
<para>
A space-separated list of recipe files BitBake uses to
build software.
</para>
<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>
syntax.
For details on the syntax, see the documentation by
following the previous link.
</para>
</glossdef>
</glossentry>
@@ -1166,10 +1186,14 @@
match any of the expressions.
It is as if BitBake does not see them at all.
Consequently, matching files are not parsed or otherwise
used by BitBake.</para>
used by BitBake.
</para>
<para>
The values you provide are passed to Python's regular
expression compiler.
Consequently, the syntax follows Python's Regular
Expression (re) syntax.
The expressions are compared against the full paths to
the files.
For complete syntax information, see Python's
@@ -1933,15 +1957,27 @@
you want to select, and you should set
<link linkend='var-PV'><filename>PV</filename></link>
accordingly for precedence.
You can use the "<filename>%</filename>" character as a
wildcard to match any number of characters, which can be
useful when specifying versions that contain long revision
numbers that could potentially change.
</para>
<para>
The <filename>PREFERRED_VERSION</filename> variable
supports limited wildcard use through the
"<filename>%</filename>" character.
You can use the character to match any number of
characters, which can be useful when specifying versions
that contain long revision numbers that potentially change.
Here are two examples:
<literallayout class='monospaced'>
PREFERRED_VERSION_python = "2.7.3"
PREFERRED_VERSION_linux-yocto = "4.12%"
</literallayout>
<note><title>Important</title>
The use of the "<filename>%</filename>" character
is limited in that it only works at the end of the
string.
You cannot use the wildcard character in any other
location of the string.
</note>
</para>
</glossdef>
</glossentry>