|author||Scott Rifenbark <firstname.lastname@example.org>||2012-01-26 17:09:42 -0600|
|committer||Richard Purdie <email@example.com>||2012-03-08 12:07:45 -0800|
documentation/kernel-manual/kernel-how-to.xml: edits to tree construction
I made some clarifying edits to the section that describes how the YP team constructs the kernel repositories (the tree). There were some things that just weren't clear. (From yocto-docs rev: 127f0c8c89ec9b926a4ff348acc39a73f41e6fe7) Signed-off-by: Scott Rifenbark <firstname.lastname@example.org> Signed-off-by: Richard Purdie <email@example.com>
1 files changed, 19 insertions, 10 deletions
diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml
index e7fa93d4cc..c43af60d36 100644
@@ -54,15 +54,22 @@
"<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#local-kernel-files'>Linux Yocto Kernel</ulink>" bulleted item in The Yocto Project Development Manual.
- Once the Git repository is set up on your local machine, you can switch to the
- <filename>meta</filename> branch within the repository.
- Here, you can see a snapshot of all the kernel configuration and feature descriptions that are
- used to build the kernel repository.
+ Once you have cloned the kernel Git repository on your local machine, you can
+ switch to the <filename>meta</filename> branch within the repository.
+ Here is an example that assumes the local Git repository for the kernel is in
+ a top-level directory named <filename>linux-yocto-3.0</filename>:
+ <literallayout class='monospaced'>
+ $ cd ~/linux-yocto-3.0
+ $ git checkout -b meta origin/meta
+ Once you have checked out and switched to the <filename>meta</filename> branch,
+ you can see a snapshot of all the kernel configuration and feature descriptions that are
+ used to build that particular kernel repository.
These descriptions are in the form of <filename>.scc</filename> files.
- You should realize, however, that browsing your local snapshot of feature
- descriptions and patches is not an effective way to determine what is in a
+ You should realize, however, that browsing your local kernel repository
+ for feature descriptions and patches is not an effective way to determine what is in a
particular kernel branch.
Instead, you should use Git directly to discover the changes in a branch.
Using Git is an efficient and flexible way to inspect changes to the kernel.
@@ -76,10 +83,12 @@
- The following steps describe what happens when the Yocto kernel team constructs
- the kernel tree given the introduction of a new top-level kernel feature or BSP.
- These are the actions that effectively create the tree that includes the new feature, patch,
- or BSP:
+ The following steps describe what happens when the Yocto Project Team constructs
+ the Yocto Linux kernel source Git repository (or tree) found at
+ <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink> given the
+ introduction of a new top-level kernel feature or BSP.
+ These are the actions that effectively create the tree
+ that includes the new feature, patch or BSP:
<listitem><para>A top-level kernel feature is passed to the kernel build subsystem.
Normally, this feature is a BSP for a particular kernel type.</para></listitem>