summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-02-01 22:09:08 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-02-14 17:24:01 (GMT)
commit05e2c479d9bb859ea09c9465e604b201c00c0b45 (patch)
tree67621108dceb72138ea8892308c894eff3574460
parentcf10be36c1d9d37a8cec93a1e509b3049a9b4c5b (diff)
downloadpoky-05e2c479d9bb859ea09c9465e604b201c00c0b45.tar.gz
dev-manual: Updates to "Using .bbappend Files" section
Fixes YOCTO #3664 Added some information in the note to point out that not all append files add files into the mix. Some just exist to add build options. And, in this case the _prepend part of the FILESEXTRAPATHS statement is not necessary. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 388c441341006227be2f9e7d42bb1c509c32790d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml19
1 files changed, 14 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 4372769..e9555e6 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -295,7 +295,7 @@
295 </para> 295 </para>
296 296
297 <para> 297 <para>
298 Append files must have the same name as the corresponding recipe. 298 Append files must have the same root name as the corresponding recipe.
299 For example, the append file <filename>someapp_&DISTRO;.bbappend</filename> must 299 For example, the append file <filename>someapp_&DISTRO;.bbappend</filename> must
300 apply to <filename>someapp_&DISTRO;.bb</filename>. 300 apply to <filename>someapp_&DISTRO;.bb</filename>.
301 This means the original recipe and append file names are version number-specific. 301 This means the original recipe and append file names are version number-specific.
@@ -304,6 +304,9 @@
304 During the build process, BitBake displays an error on starting if it detects a 304 During the build process, BitBake displays an error on starting if it detects a
305 <filename>.bbappend</filename> file that does not have a corresponding recipe 305 <filename>.bbappend</filename> file that does not have a corresponding recipe
306 with a matching name. 306 with a matching name.
307 See the
308 <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_DANGLINGAPPENDS_WARNONLY'><filename>BB_DANGLINGAPPENDS_WARNONLY</filename></ulink>
309 variable for information on how to handle this error.
307 </para> 310 </para>
308 311
309 <para> 312 <para>
@@ -317,7 +320,7 @@
317 append file both from the 320 append file both from the
318 <link linkend='source-directory'>Source Directory</link>. 321 <link linkend='source-directory'>Source Directory</link>.
319 Here is the main formfactor recipe, which is named <filename>formfactor_0.0.bb</filename> and 322 Here is the main formfactor recipe, which is named <filename>formfactor_0.0.bb</filename> and
320 located in the meta layer at <filename>meta/recipes-bsp/formfactor</filename>: 323 located in the "meta" layer at <filename>meta/recipes-bsp/formfactor</filename>:
321 <literallayout class='monospaced'> 324 <literallayout class='monospaced'>
322 DESCRIPTION = "Device formfactor information" 325 DESCRIPTION = "Device formfactor information"
323 SECTION = "base" 326 SECTION = "base"
@@ -364,10 +367,16 @@
364 of the reference to <filename>THISDIR</filename>. 367 of the reference to <filename>THISDIR</filename>.
365 The trailing colon character is important as it ensures that items in the list remain 368 The trailing colon character is important as it ensures that items in the list remain
366 colon-separated. 369 colon-separated.
367 <note>BitBake automatically defines the <filename>THISDIR</filename> variable. 370 <note><para>BitBake automatically defines the
371 <filename>THISDIR</filename> variable.
368 You should never set this variable yourself. 372 You should never set this variable yourself.
369 Using <filename>_prepend</filename> ensures your path will be searched prior to other 373 Using <filename>_prepend</filename> ensures your path will
370 paths in the final list. 374 be searched prior to other paths in the final list.</para>
375 <para>Also, not all append files add extra files.
376 Many append files simply exist to add build options
377 (e.g. <filename>systemd</filename>).
378 For these cases, it is not necessary to use the
379 "_prepend" part of the statement.</para>
371 </note> 380 </note>
372 </para> 381 </para>
373 </section> 382 </section>