summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-26 15:11:13 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:09 +0000
commit4158e19d36016905f64f461c1157af05f3570f0a (patch)
tree7304d0436deb9d8a10013a710fcf0d68df397209
parent7f62af0d1207988ec54fb3dafa139f482e159825 (diff)
downloadpoky-4158e19d36016905f64f461c1157af05f3570f0a.tar.gz
kernel-dev: Format of the "Recipe-Space Metadata" section.
(From yocto-docs rev: 6db7f35316b5cc513c17d454237e13548911b6bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml85
1 files changed, 85 insertions, 0 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index cba219fe46..07c026378d 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -324,6 +324,91 @@ Regardless of where the meta-data is stored, the syntax as
324described in the following sections applies equally. 324described in the following sections applies equally.
325 </literallayout> 325 </literallayout>
326 </para> 326 </para>
327
328 <section id='recipe-space-metadata'>
329 <title>Recipe-Space Metadata</title>
330
331 <para>
332 When stored in recipe-space, the metadata files reside in a
333 directory hierarchy below
334 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></ulink>,
335 which is typically set to
336 <filename>${THISDIR}/${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink><filename>}</filename>
337 for a linux-yocto or linux-yocto-custom derived Linux kernel
338 recipe.
339 See the "<link linkend='modifying-an-existing-recipe'>Modifying an Existing Recipe</link>"
340 section for more information.
341 </para>
342
343 <para>
344 By way of example, a trivial tree of metadata stored in
345 recipe-space within a BSP layer might look like the following:
346 <literallayout class='monospaced'>
347 meta/
348 `-- recipes-kernel
349 `-- linux
350 `-- linux-yocto
351 |-- bsp-standard.scc
352 |-- bsp.cfg
353 `-- standard.cfg
354 </literallayout>
355 </para>
356
357 <para>
358 When the metadata is stored in recipe-space, you must take
359 steps to ensure BitBake has the necessary information to decide
360 which files to fetch and when they need to be fetched again.
361 </para>
362
363 <para>
364 It is only necessary to specify the <filename>.scc</filename>
365 files on the
366 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink>.
367 BitBake parses them and fetches any files referenced in the
368 <filename>.scc</filename> files by the <filename>include</filename>,
369 <filename>patch</filename>, or <filename>kconf</filename> commands.
370 Because of this, it is necessary to bump the recipe
371 <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>
372 value when changing the content of files not explicitly listed
373 in the SRC_URI.
374 </para>
375
376 <para>
377 Original text:
378 <literallayout class='monospaced'>
379When stored in recipe-space, the meta-data files reside in a directory hierarchy
380below FILESEXTRAPATHS, which is typically set to ${THISDIR}/${PN} for a
381linux-yocto or linux-yocto-custom derived Linux kernel recipe. See 2.2.
382
383By way of example, a trivial tree of meta-data stored in recipe-space within a
384BSP layer might look like the following:
385
386meta/
387`-- recipes-kernel
388 `-- linux
389 `-- linux-yocto
390 |-- bsp-standard.scc
391 |-- bsp.cfg
392 `-- standard.cfg
393
394When the meta-data is stored in recipe-space, you must take steps to ensure
395bitbake has the necessary information to decide which files to fetch and when
396they need to be fetched again.
397
398It is only necessary to specify the .scc files on the SRC_URI; bitbake will
399parse them and fetch any files referenced in the .scc files by the include,
400patch, or kconf commands. Because of this, it is necessary to bump the recipe PR
401value when changing the content of files not explicitly listed in the SRC_URI.
402 </literallayout>
403 </para>
404 </section>
405
406
407
408
409
410
411
327</section> 412</section>
328 413
329</chapter> 414</chapter>