summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-12-26 16:22:32 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-12-27 13:08:30 +0000
commit8615d47a3a39e78fb7cf29ee92203d18a2439a3b (patch)
tree9f4b653bc903f04371ffce8320499d6ca22d4408 /bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
parentad4bdc680a2eb28b1bc6dfd937058c89006d2908 (diff)
downloadpoky-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-hello.xml')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml28
1 files changed, 14 insertions, 14 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
index 9076f0fcd4..39066e4b15 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.xml
@@ -194,7 +194,7 @@
194 <para> 194 <para>
195 When you run BitBake, it begins looking for metadata files. 195 When you run BitBake, it begins looking for metadata files.
196 The 196 The
197 <link linkend='var-BBPATH'><filename>BBPATH</filename></link> 197 <link linkend='var-bb-BBPATH'><filename>BBPATH</filename></link>
198 variable is what tells BitBake where to look for those files. 198 variable is what tells BitBake where to look for those files.
199 <filename>BBPATH</filename> is not set and you need to set it. 199 <filename>BBPATH</filename> is not set and you need to set it.
200 Without <filename>BBPATH</filename>, Bitbake cannot 200 Without <filename>BBPATH</filename>, Bitbake cannot
@@ -273,14 +273,14 @@
273 some editor to create the <filename>bitbake.conf</filename> 273 some editor to create the <filename>bitbake.conf</filename>
274 so that it contains the following: 274 so that it contains the following:
275 <literallayout class='monospaced'> 275 <literallayout class='monospaced'>
276 <link linkend='var-PN'>PN</link> = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}" 276 <link linkend='var-bb-PN'>PN</link> = "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 'defaultpkgname'}"
277 </literallayout> 277 </literallayout>
278 <literallayout class='monospaced'> 278 <literallayout class='monospaced'>
279 TMPDIR = "${<link linkend='var-TOPDIR'>TOPDIR</link>}/tmp" 279 TMPDIR = "${<link linkend='var-bb-TOPDIR'>TOPDIR</link>}/tmp"
280 <link linkend='var-CACHE'>CACHE</link> = "${TMPDIR}/cache" 280 <link linkend='var-bb-CACHE'>CACHE</link> = "${TMPDIR}/cache"
281 <link linkend='var-STAMP'>STAMP</link> = "${TMPDIR}/${PN}/stamps" 281 <link linkend='var-bb-STAMP'>STAMP</link> = "${TMPDIR}/${PN}/stamps"
282 <link linkend='var-T'>T</link> = "${TMPDIR}/${PN}/work" 282 <link linkend='var-bb-T'>T</link> = "${TMPDIR}/${PN}/work"
283 <link linkend='var-B'>B</link> = "${TMPDIR}/${PN}" 283 <link linkend='var-bb-B'>B</link> = "${TMPDIR}/${PN}"
284 </literallayout> 284 </literallayout>
285 <note> 285 <note>
286 Without a value for <filename>PN</filename>, the 286 Without a value for <filename>PN</filename>, the
@@ -402,12 +402,12 @@
402 Move to the <filename>conf</filename> directory and create a 402 Move to the <filename>conf</filename> directory and create a
403 <filename>layer.conf</filename> file that has the following: 403 <filename>layer.conf</filename> file that has the following:
404 <literallayout class='monospaced'> 404 <literallayout class='monospaced'>
405 BBPATH .= ":${<link linkend='var-LAYERDIR'>LAYERDIR</link>}" 405 BBPATH .= ":${<link linkend='var-bb-LAYERDIR'>LAYERDIR</link>}"
406 406
407 <link linkend='var-BBFILES'>BBFILES</link> += "${LAYERDIR}/*.bb" 407 <link linkend='var-bb-BBFILES'>BBFILES</link> += "${LAYERDIR}/*.bb"
408 408
409 <link linkend='var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</link> += "mylayer" 409 <link linkend='var-bb-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</link> += "mylayer"
410 <link linkend='var-BBFILE_PATTERN'>BBFILE_PATTERN_mylayer</link> := "^${LAYERDIR_RE}/" 410 <link linkend='var-bb-BBFILE_PATTERN'>BBFILE_PATTERN_mylayer</link> := "^${LAYERDIR_RE}/"
411 </literallayout> 411 </literallayout>
412 For information on these variables, click the links 412 For information on these variables, click the links
413 to go to the definitions in the glossary.</para> 413 to go to the definitions in the glossary.</para>
@@ -416,9 +416,9 @@
416 a recipe file named <filename>printhello.bb</filename> that 416 a recipe file named <filename>printhello.bb</filename> that
417 has the following: 417 has the following:
418 <literallayout class='monospaced'> 418 <literallayout class='monospaced'>
419 <link linkend='var-DESCRIPTION'>DESCRIPTION</link> = "Prints Hello World" 419 <link linkend='var-bb-DESCRIPTION'>DESCRIPTION</link> = "Prints Hello World"
420 <link linkend='var-PN'>PN</link> = 'printhello' 420 <link linkend='var-bb-PN'>PN</link> = 'printhello'
421 <link linkend='var-PV'>PV</link> = '1' 421 <link linkend='var-bb-PV'>PV</link> = '1'
422 422
423 python do_build() { 423 python do_build() {
424 bb.plain("********************"); 424 bb.plain("********************");