diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-10-24 16:11:03 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-10-29 16:54:48 +0000 |
| commit | 2520246d6781f40e3d1aab13abb5a01dd09a7594 (patch) | |
| tree | 4c073dacc411697ae61d1e7c107e89a02dc63dee /bitbake/doc | |
| parent | 8c0a94129e0e1699cd72fd965ac1cc6504b1269f (diff) | |
| download | poky-2520246d6781f40e3d1aab13abb5a01dd09a7594.tar.gz | |
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>
Diffstat (limited to 'bitbake/doc')
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 23 | ||||
| -rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml | 17 |
2 files changed, 24 insertions, 16 deletions
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 df5364c299..8bfa32baa3 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | |||
| @@ -2752,27 +2752,28 @@ | |||
| 2752 | </para> | 2752 | </para> |
| 2753 | </section> | 2753 | </section> |
| 2754 | 2754 | ||
| 2755 | <section id='wildcard-support'> | 2755 | <section id='wildcard-support-in-variables'> |
| 2756 | <title>Wildcard Support</title> | 2756 | <title>Wildcard Support in Variables</title> |
| 2757 | 2757 | ||
| 2758 | <para> | 2758 | <para> |
| 2759 | Support for wildcard use varies depending on the context in | 2759 | Support for wildcard use in variables varies depending on the |
| 2760 | which it is used. | 2760 | context in which it is used. |
| 2761 | For example, some variables and file names allow limited use of | 2761 | For example, some variables and file names allow limited use of |
| 2762 | wildcards through the "<filename>%</filename>" and | 2762 | wildcards through the "<filename>%</filename>" and |
| 2763 | "<filename>*</filename>" characters. | 2763 | "<filename>*</filename>" characters. |
| 2764 | Other variables or names support Python's | 2764 | Other variables or names support Python's |
| 2765 | <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink> | 2765 | <ulink url='https://docs.python.org/3/library/glob.html'><filename>glob</filename></ulink> |
| 2766 | syntax, | 2766 | syntax, |
| 2767 | <ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink> | 2767 | <ulink url='https://docs.python.org/3/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink> |
| 2768 | syntax, or Regular Expression (re) syntax. | 2768 | syntax, or |
| 2769 | <ulink url='https://docs.python.org/3/library/re.html#re'><filename>Regular Expression (re)</filename></ulink> | ||
| 2770 | syntax. | ||
| 2769 | </para> | 2771 | </para> |
| 2770 | 2772 | ||
| 2771 | <para> | 2773 | <para> |
| 2772 | When a particular variable's list of filenames or filenames | 2774 | For variables that have wildcard suport, the |
| 2773 | in general used by BitBake or a build system | 2775 | documentation describes which form of wildcard, its |
| 2774 | based on BitBake support the use of wildcards, the | 2776 | use, and its limitations. |
| 2775 | documentation describes its use and limitations. | ||
| 2776 | </para> | 2777 | </para> |
| 2777 | </section> | 2778 | </section> |
| 2778 | 2779 | ||
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 d480881a24..a84b2bc994 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 | |||
| @@ -126,11 +126,18 @@ | |||
| 126 | BB_ALLOWED_NETWORKS = "*.gnu.org" | 126 | BB_ALLOWED_NETWORKS = "*.gnu.org" |
| 127 | </literallayout> | 127 | </literallayout> |
| 128 | <note><title>Important</title> | 128 | <note><title>Important</title> |
| 129 | The use of the "<filename>*</filename>" | 129 | <para>The use of the "<filename>*</filename>" |
| 130 | character only works at the beginning of | 130 | character only works at the beginning of |
| 131 | a host name. | 131 | a host name and it must be isolated from |
| 132 | the remainder of the host name. | ||
| 132 | You cannot use the wildcard character in any | 133 | You cannot use the wildcard character in any |
| 133 | other location of the name. | 134 | other location of the name or combined with |
| 135 | the front part of the name.</para> | ||
| 136 | |||
| 137 | <para>For example, | ||
| 138 | <filename>*.foo.bar</filename> is supported, | ||
| 139 | while <filename>*aa.foo.bar</filename> is not. | ||
| 140 | </para> | ||
| 134 | </note> | 141 | </note> |
| 135 | </para></listitem> | 142 | </para></listitem> |
| 136 | <listitem><para> | 143 | <listitem><para> |
| @@ -1098,7 +1105,7 @@ | |||
| 1098 | <para> | 1105 | <para> |
| 1099 | When specifying recipe files, you can pattern match using | 1106 | When specifying recipe files, you can pattern match using |
| 1100 | Python's | 1107 | Python's |
| 1101 | <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink> | 1108 | <ulink url='https://docs.python.org/3/library/glob.html'><filename>glob</filename></ulink> |
| 1102 | syntax. | 1109 | syntax. |
| 1103 | For details on the syntax, see the documentation by | 1110 | For details on the syntax, see the documentation by |
| 1104 | following the previous link. | 1111 | following the previous link. |
| @@ -1198,7 +1205,7 @@ | |||
| 1198 | the files. | 1205 | the files. |
| 1199 | For complete syntax information, see Python's | 1206 | For complete syntax information, see Python's |
| 1200 | documentation at | 1207 | documentation at |
| 1201 | <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. | 1208 | <ulink url='http://docs.python.org/3/library/re.html#re'></ulink>. |
| 1202 | </para> | 1209 | </para> |
| 1203 | 1210 | ||
| 1204 | <para> | 1211 | <para> |
