summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-26 15:37:20 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:10 +0000
commite8dabb022880845c6cfd941b93f6d99b618299a1 (patch)
tree45de2b5257ae11d85f890654b9b232b57de02357
parent4158e19d36016905f64f461c1157af05f3570f0a (diff)
downloadpoky-e8dabb022880845c6cfd941b93f6d99b618299a1.tar.gz
kernel-dev: Formatting "In-Tree Metadata" section.
(From yocto-docs rev: 92e9a5c6c6a3a416e3e8718d8e02f72025ad355c) 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.xml90
1 files changed, 90 insertions, 0 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 07c026378d..f14ed69586 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -403,12 +403,102 @@ value when changing the content of files not explicitly listed in the SRC_URI.
403 </para> 403 </para>
404 </section> 404 </section>
405 405
406 <section id='in-tree-metadata'>
407 <title>In-Tree Metadata</title>
406 408
409 <para>
410 When stored in-tree, the metadata files reside in the
411 "meta" directory of the Linux kernel sources.
412 They may be present in the same branch as the sources,
413 such as "master", or in their own orphan branch,
414 typically named "meta".
415 An orphan branch in Git is a branch with unique history and
416 content to the other branches in the repository.
417 This is useful to track metadata changes independently from the
418 sources of the Linux kernel, while still keeping them
419 together in the same repository.
420 For the purposes of this document, we will discuss all
421 in-tree metadata as residing below the
422 <filename>meta/cfg/kernel-cache</filename> directory.
423 </para>
407 424
425 <para>
426 By way of example, a trivial tree of metadata stored in a custom
427 Linux kernel Git repository might look like the following:
428 <literallayout class='monospaced'>
429 meta/
430 `-- cfg
431 `-- kernel-cache
432 |-- bsp-standard.scc
433 |-- bsp.cfg
434 `-- standard.cfg
435 </literallayout>
436 </para>
408 437
438 <para>
439 To use a specific branch for the metadata, specify the branch
440 in the <filename>KMETA</filename> variable in your Linux kernel
441 recipe, for example:
442 <literallayout class='monospaced'>
443 KMETA = "meta"
444 </literallayout>
445 To use the same branch as the sources, set
446 <filename>KMETA</filename> to the empty string:
447 <literallayout class='monospaced'>
448 KMETA = ""
449 </literallayout>
450 If you are working with your own sources and want to create an
451 orphan <filename>meta</filename> branch, you can do so using the
452 following commands from within your Linux kernel Git repository:
453 <literallayout class='monospaced'>
454 $ git checkout --orphan meta
455 $ git rm -rf .
456 $ git commit --allow-empty -m "Create orphan meta branch"
457 </literallayout>
458 </para>
459
460 <para>
461 Original text:
462 <literallayout class='monospaced'>
463When stored in-tree, the meta-data files reside in the "meta" directory of the
464Linux kernel sources. They may be present in the same branch as the sources,
465such as "master", or in their own orphan branch, typically named "meta". An
466orphan branch in git is a branch with unique history and content to the other
467branches in the repository. This is useful to track meta-data changes
468independently from the sources of the Linux kernel, while still keeping them
469together in the same repository. For the purposes of this document, we will
470discuss all in-tree meta-data as residing below the "meta/cfg/kernel-cache"
471directory.
472
473By way of example, a trivial tree of meta-data stored in a custom Linux kernel
474git repository might look like the following:
475
476meta/
477`-- cfg
478 `-- kernel-cache
479 |-- bsp-standard.scc
480 |-- bsp.cfg
481 `-- standard.cfg
409 482
483To use a specific branch for the meta-data, specify the branch in the KMETA
484variable in your Linux kernel recipe, for example:
410 485
486 KMETA = "meta"
411 487
488To use the same branch as the sources, set KMETA to the empty string:
489
490 KMETA = ""
491
492If you are working with your own sources and want to create an orphan meta
493branch, you can do so using the following commands from within your Linux kernel
494git repository:
495
496 $ git checkout --orphan meta
497 $ git rm -rf .
498 $ git commit --allow-empty -m "Create orphan meta branch"
499 </literallayout>
500 </para>
501 </section>
412</section> 502</section>
413 503
414</chapter> 504</chapter>