diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-12-26 16:22:32 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-12-27 13:08:30 +0000 |
commit | 8615d47a3a39e78fb7cf29ee92203d18a2439a3b (patch) | |
tree | 9f4b653bc903f04371ffce8320499d6ca22d4408 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml | |
parent | ad4bdc680a2eb28b1bc6dfd937058c89006d2908 (diff) | |
download | poky-8615d47a3a39e78fb7cf29ee92203d18a2439a3b.tar.gz |
bitbake: bitbake-user-manual: Created unique tags for glossary variables.
Fixes [YOCTO #12399]
The bug was to get the BitBake User Manual into the YP Mega-manual.
All the changes here create unique tags used with variables in the
BitBake Manual. Prior to the fix, tags were identical between like
variables in the YP reference manual and the BitBake User Manual.
The reason for this is because when I created the BitBake manual's
glossary, it was a cut-and-paste operation to get the bulk of
the work started. At the time, the BitBake User Manual was not
a part of the Mega-manual. Once we decided to include the
BitBake User Manual as part of the Mega-Manual, building the
mega-manual produced warnings for all these duplicate links.
To fix, I have updated the variable tags in the BitBake User
Manual to use the following form:
'var-bb-<variable_name>'
The tags used in the YP ref-manual follow this form (original):
'var-<variable_name>'
(Bitbake rev: fb6de2057aae3fbdf37f007d2e47794b332020e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index 92b2c3d1be..3acd7c403e 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml | |||
@@ -44,7 +44,7 @@ | |||
44 | </literallayout> | 44 | </literallayout> |
45 | This code sets up an instance of the fetch class. | 45 | This code sets up an instance of the fetch class. |
46 | The instance uses a space-separated list of URLs from the | 46 | The instance uses a space-separated list of URLs from the |
47 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 47 | <link linkend='var-bb-SRC_URI'><filename>SRC_URI</filename></link> |
48 | variable and then calls the <filename>download</filename> | 48 | variable and then calls the <filename>download</filename> |
49 | method to download the files. | 49 | method to download the files. |
50 | </para> | 50 | </para> |
@@ -78,7 +78,7 @@ | |||
78 | <listitem><para><emphasis>Pre-mirror Sites:</emphasis> | 78 | <listitem><para><emphasis>Pre-mirror Sites:</emphasis> |
79 | BitBake first uses pre-mirrors to try and find source files. | 79 | BitBake first uses pre-mirrors to try and find source files. |
80 | These locations are defined using the | 80 | These locations are defined using the |
81 | <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> | 81 | <link linkend='var-bb-PREMIRRORS'><filename>PREMIRRORS</filename></link> |
82 | variable. | 82 | variable. |
83 | </para></listitem> | 83 | </para></listitem> |
84 | <listitem><para><emphasis>Source URI:</emphasis> | 84 | <listitem><para><emphasis>Source URI:</emphasis> |
@@ -88,7 +88,7 @@ | |||
88 | <listitem><para><emphasis>Mirror Sites:</emphasis> | 88 | <listitem><para><emphasis>Mirror Sites:</emphasis> |
89 | If fetch failures occur, BitBake next uses mirror locations as | 89 | If fetch failures occur, BitBake next uses mirror locations as |
90 | defined by the | 90 | defined by the |
91 | <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> | 91 | <link linkend='var-bb-MIRRORS'><filename>MIRRORS</filename></link> |
92 | variable. | 92 | variable. |
93 | </para></listitem> | 93 | </para></listitem> |
94 | </itemizedlist> | 94 | </itemizedlist> |
@@ -144,7 +144,7 @@ | |||
144 | Any source files that are not local (i.e. | 144 | Any source files that are not local (i.e. |
145 | downloaded from the Internet) are placed into the download | 145 | downloaded from the Internet) are placed into the download |
146 | directory, which is specified by the | 146 | directory, which is specified by the |
147 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 147 | <link linkend='var-bb-DL_DIR'><filename>DL_DIR</filename></link> |
148 | variable. | 148 | variable. |
149 | </para> | 149 | </para> |
150 | 150 | ||
@@ -184,11 +184,11 @@ | |||
184 | 184 | ||
185 | <para> | 185 | <para> |
186 | If | 186 | If |
187 | <link linkend='var-BB_STRICT_CHECKSUM'><filename>BB_STRICT_CHECKSUM</filename></link> | 187 | <link linkend='var-bb-BB_STRICT_CHECKSUM'><filename>BB_STRICT_CHECKSUM</filename></link> |
188 | is set, any download without a checksum triggers an | 188 | is set, any download without a checksum triggers an |
189 | error message. | 189 | error message. |
190 | The | 190 | The |
191 | <link linkend='var-BB_NO_NETWORK'><filename>BB_NO_NETWORK</filename></link> | 191 | <link linkend='var-bb-BB_NO_NETWORK'><filename>BB_NO_NETWORK</filename></link> |
192 | variable can be used to make any attempted network access a fatal | 192 | variable can be used to make any attempted network access a fatal |
193 | error, which is useful for checking that mirrors are complete | 193 | error, which is useful for checking that mirrors are complete |
194 | as well as other things. | 194 | as well as other things. |
@@ -265,11 +265,11 @@ | |||
265 | The filename you specify within the URL can be | 265 | The filename you specify within the URL can be |
266 | either an absolute or relative path to a file. | 266 | either an absolute or relative path to a file. |
267 | If the filename is relative, the contents of the | 267 | If the filename is relative, the contents of the |
268 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | 268 | <link linkend='var-bb-FILESPATH'><filename>FILESPATH</filename></link> |
269 | variable is used in the same way | 269 | variable is used in the same way |
270 | <filename>PATH</filename> is used to find executables. | 270 | <filename>PATH</filename> is used to find executables. |
271 | If the file cannot be found, it is assumed that it is available in | 271 | If the file cannot be found, it is assumed that it is available in |
272 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 272 | <link linkend='var-bb-DL_DIR'><filename>DL_DIR</filename></link> |
273 | by the time the <filename>download()</filename> method is called. | 273 | by the time the <filename>download()</filename> method is called. |
274 | </para> | 274 | </para> |
275 | 275 | ||
@@ -304,7 +304,7 @@ | |||
304 | allows the name of the downloaded file to be specified. | 304 | allows the name of the downloaded file to be specified. |
305 | Specifying the name of the downloaded file is useful | 305 | Specifying the name of the downloaded file is useful |
306 | for avoiding collisions in | 306 | for avoiding collisions in |
307 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 307 | <link linkend='var-bb-DL_DIR'><filename>DL_DIR</filename></link> |
308 | when dealing with multiple files that have the same name. | 308 | when dealing with multiple files that have the same name. |
309 | </para> | 309 | </para> |
310 | 310 | ||
@@ -355,7 +355,7 @@ | |||
355 | A special value of "now" causes the checkout to | 355 | A special value of "now" causes the checkout to |
356 | be updated on every build. | 356 | be updated on every build. |
357 | </para></listitem> | 357 | </para></listitem> |
358 | <listitem><para><emphasis><link linkend='var-CVSDIR'><filename>CVSDIR</filename></link>:</emphasis> | 358 | <listitem><para><emphasis><link linkend='var-bb-CVSDIR'><filename>CVSDIR</filename></link>:</emphasis> |
359 | Specifies where a temporary checkout is saved. | 359 | Specifies where a temporary checkout is saved. |
360 | The location is often <filename>DL_DIR/cvs</filename>. | 360 | The location is often <filename>DL_DIR/cvs</filename>. |
361 | </para></listitem> | 361 | </para></listitem> |
@@ -395,7 +395,7 @@ | |||
395 | <listitem><para><emphasis>"date":</emphasis> | 395 | <listitem><para><emphasis>"date":</emphasis> |
396 | Specifies a date. | 396 | Specifies a date. |
397 | If no "date" is specified, the | 397 | If no "date" is specified, the |
398 | <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> | 398 | <link linkend='var-bb-SRCDATE'><filename>SRCDATE</filename></link> |
399 | of the configuration is used to checkout a specific date. | 399 | of the configuration is used to checkout a specific date. |
400 | The special value of "now" causes the checkout to be | 400 | The special value of "now" causes the checkout to be |
401 | updated on every build. | 401 | updated on every build. |
@@ -406,7 +406,7 @@ | |||
406 | to which the module is unpacked. | 406 | to which the module is unpacked. |
407 | You are forcing the module into a special | 407 | You are forcing the module into a special |
408 | directory relative to | 408 | directory relative to |
409 | <link linkend='var-CVSDIR'><filename>CVSDIR</filename></link>. | 409 | <link linkend='var-bb-CVSDIR'><filename>CVSDIR</filename></link>. |
410 | </para></listitem> | 410 | </para></listitem> |
411 | <listitem><para><emphasis>"rsh"</emphasis> | 411 | <listitem><para><emphasis>"rsh"</emphasis> |
412 | Used in conjunction with the "method" parameter. | 412 | Used in conjunction with the "method" parameter. |
@@ -448,7 +448,7 @@ | |||
448 | <filename>FETCHCMD_svn</filename>, which defaults | 448 | <filename>FETCHCMD_svn</filename>, which defaults |
449 | to "svn". | 449 | to "svn". |
450 | The fetcher's temporary working directory is set by | 450 | The fetcher's temporary working directory is set by |
451 | <link linkend='var-SVNDIR'><filename>SVNDIR</filename></link>, | 451 | <link linkend='var-bb-SVNDIR'><filename>SVNDIR</filename></link>, |
452 | which is usually <filename>DL_DIR/svn</filename>. | 452 | which is usually <filename>DL_DIR/svn</filename>. |
453 | </para> | 453 | </para> |
454 | 454 | ||
@@ -509,7 +509,7 @@ | |||
509 | source control system. | 509 | source control system. |
510 | The fetcher works by creating a bare clone of the | 510 | The fetcher works by creating a bare clone of the |
511 | remote into | 511 | remote into |
512 | <link linkend='var-GITDIR'><filename>GITDIR</filename></link>, | 512 | <link linkend='var-bb-GITDIR'><filename>GITDIR</filename></link>, |
513 | which is usually <filename>DL_DIR/git2</filename>. | 513 | which is usually <filename>DL_DIR/git2</filename>. |
514 | This bare clone is then cloned into the work directory during the | 514 | This bare clone is then cloned into the work directory during the |
515 | unpack stage when a specific tree is checked out. | 515 | unpack stage when a specific tree is checked out. |
@@ -612,7 +612,7 @@ | |||
612 | This fetcher submodule inherits from the | 612 | This fetcher submodule inherits from the |
613 | <link linkend='git-fetcher'>Git fetcher</link> and extends | 613 | <link linkend='git-fetcher'>Git fetcher</link> and extends |
614 | that fetcher's behavior by fetching a repository's submodules. | 614 | that fetcher's behavior by fetching a repository's submodules. |
615 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> | 615 | <link linkend='var-bb-SRC_URI'><filename>SRC_URI</filename></link> |
616 | is passed to the Git fetcher as described in the | 616 | is passed to the Git fetcher as described in the |
617 | "<link linkend='git-fetcher'>Git Fetcher (<filename>git://</filename>)</link>" | 617 | "<link linkend='git-fetcher'>Git Fetcher (<filename>git://</filename>)</link>" |
618 | section. | 618 | section. |
@@ -647,9 +647,9 @@ | |||
647 | 647 | ||
648 | <para> | 648 | <para> |
649 | To use this fetcher, make sure your recipe has proper | 649 | To use this fetcher, make sure your recipe has proper |
650 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, | 650 | <link linkend='var-bb-SRC_URI'><filename>SRC_URI</filename></link>, |
651 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link>, and | 651 | <link linkend='var-bb-SRCREV'><filename>SRCREV</filename></link>, and |
652 | <link linkend='var-PV'><filename>PV</filename></link> settings. | 652 | <link linkend='var-bb-PV'><filename>PV</filename></link> settings. |
653 | Here is an example: | 653 | Here is an example: |
654 | <literallayout class='monospaced'> | 654 | <literallayout class='monospaced'> |
655 | SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" | 655 | SRC_URI = "ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" |
@@ -734,15 +734,15 @@ | |||
734 | <filename>FETCHCMD_p4</filename>, which defaults | 734 | <filename>FETCHCMD_p4</filename>, which defaults |
735 | to "p4". | 735 | to "p4". |
736 | The fetcher's temporary working directory is set by | 736 | The fetcher's temporary working directory is set by |
737 | <link linkend='var-P4DIR'><filename>P4DIR</filename></link>, | 737 | <link linkend='var-bb-P4DIR'><filename>P4DIR</filename></link>, |
738 | which defaults to "DL_DIR/p4". | 738 | which defaults to "DL_DIR/p4". |
739 | </para> | 739 | </para> |
740 | 740 | ||
741 | <para> | 741 | <para> |
742 | To use this fetcher, make sure your recipe has proper | 742 | To use this fetcher, make sure your recipe has proper |
743 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, | 743 | <link linkend='var-bb-SRC_URI'><filename>SRC_URI</filename></link>, |
744 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link>, and | 744 | <link linkend='var-bb-SRCREV'><filename>SRCREV</filename></link>, and |
745 | <link linkend='var-PV'><filename>PV</filename></link> values. | 745 | <link linkend='var-bb-PV'><filename>PV</filename></link> values. |
746 | The p4 executable is able to use the config file defined by your | 746 | The p4 executable is able to use the config file defined by your |
747 | system's <filename>P4CONFIG</filename> environment variable in | 747 | system's <filename>P4CONFIG</filename> environment variable in |
748 | order to define the Perforce server URL and port, username, and | 748 | order to define the Perforce server URL and port, username, and |
@@ -793,9 +793,9 @@ | |||
793 | <filename>google-repo</filename> source control system. | 793 | <filename>google-repo</filename> source control system. |
794 | The fetcher works by initiating and syncing sources of the | 794 | The fetcher works by initiating and syncing sources of the |
795 | repository into | 795 | repository into |
796 | <link linkend='var-REPODIR'><filename>REPODIR</filename></link>, | 796 | <link linkend='var-bb-REPODIR'><filename>REPODIR</filename></link>, |
797 | which is usually | 797 | which is usually |
798 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link><filename>/repo</filename>. | 798 | <link linkend='var-bb-DL_DIR'><filename>DL_DIR</filename></link><filename>/repo</filename>. |
799 | </para> | 799 | </para> |
800 | 800 | ||
801 | <para> | 801 | <para> |