From 8c0a94129e0e1699cd72fd965ac1cc6504b1269f Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 18 Oct 2018 13:15:49 -0700 Subject: 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 Signed-off-by: Richard Purdie --- .../bitbake-user-manual-intro.xml | 13 +++++- .../bitbake-user-manual-metadata.xml | 25 +++++++++++ .../bitbake-user-manual-ref-variables.xml | 50 +++++++++++++++++++--- 3 files changed, 79 insertions(+), 9 deletions(-) (limited to 'bitbake/doc') 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 @@ When you name an append file, you can use the - wildcard character (%) to allow for matching recipe names. + "%" wildcard character to allow for matching + recipe names. For example, suppose you have an append file named as follows: busybox_1.21.%.bbappend - That append file would match any busybox_1.21.x.bb + That append file would match any busybox_1.21.x.bb version of the recipe. So, the append file would match the following recipe names: @@ -356,6 +357,14 @@ busybox_1.21.2.bb busybox_1.21.3.bb + Important + The use of the "%" character + is limited in that it only works directly in front of the + .bbappend portion of the append file's + name. + You cannot use the wildcard character in any other + location of the name. + If the busybox recipe was updated to busybox_1.3.0.bb, the append name would not 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 @@ + +
+ Wildcard Support + + + 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 "%" and + "*" characters. + Other variables or names support Python's + glob + syntax, + fnmatch + syntax, or Regular Expression (re) syntax. + + + + 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. + +
+ 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 @@ is either not set or set to "0". - Limited support for wildcard matching against the + Limited support for the "*" + wildcard character for matching against the beginning of host names exists. For example, the following setting matches git.gnu.org, @@ -124,6 +125,13 @@ BB_ALLOWED_NETWORKS = "*.gnu.org" + Important + The use of the "*" + character only works at the beginning of + a host name. + You cannot use the wildcard character in any + other location of the name. + Mirrors not in the host list are skipped and @@ -1082,7 +1090,19 @@ BBFILES - List of recipe files BitBake uses to build software. + + A space-separated list of recipe files BitBake uses to + build software. + + + + When specifying recipe files, you can pattern match using + Python's + glob + syntax. + For details on the syntax, see the documentation by + following the previous link. + @@ -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. + used by BitBake. + + 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 PV accordingly for precedence. - You can use the "%" 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. + + + + The PREFERRED_VERSION variable + supports limited wildcard use through the + "%" 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: PREFERRED_VERSION_python = "2.7.3" PREFERRED_VERSION_linux-yocto = "4.12%" + Important + The use of the "%" 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. + -- cgit v1.2.3-54-g00ecf