summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev/kernel-dev-advanced.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-16 17:18:18 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-18 16:15:30 +0200
commitd6e89e7122c7d588cf3a505d4eb5f67fdb520a9d (patch)
treec549bdbaf22325f46ad5428781b672f7046542d4 /documentation/kernel-dev/kernel-dev-advanced.xml
parent5f613896ee90920baf9fe110faf5c8a4a249a9f9 (diff)
downloadpoky-d6e89e7122c7d588cf3a505d4eb5f67fdb520a9d.tar.gz
kernel-dev: Scrubbed and fixed all user-supplied input formatting.
In the manual I was using angled brackets to denote user-supplied input values. This was confusing so I changed to using the <replaceable></replaceable> tag pair. (From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev/kernel-dev-advanced.xml')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml35
1 files changed, 18 insertions, 17 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 4a6aeb7391..283f483112 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -214,7 +214,7 @@
214 Here is an example that shows a trivial tree of kernel Metadata 214 Here is an example that shows a trivial tree of kernel Metadata
215 stored in recipe-space within a BSP layer: 215 stored in recipe-space within a BSP layer:
216 <literallayout class='monospaced'> 216 <literallayout class='monospaced'>
217 meta-my_bsp_layer/ 217 meta-<replaceable>my_bsp_layer</replaceable>/
218 `-- recipes-kernel 218 `-- recipes-kernel
219 `-- linux 219 `-- linux
220 `-- linux-yocto 220 `-- linux-yocto
@@ -370,7 +370,7 @@
370 of Metadata. 370 of Metadata.
371 The following Metadata file hierarchy is recommended: 371 The following Metadata file hierarchy is recommended:
372 <literallayout class='monospaced'> 372 <literallayout class='monospaced'>
373 &lt;base&gt;/ 373 <replaceable>base</replaceable>/
374 bsp/ 374 bsp/
375 cfg/ 375 cfg/
376 features/ 376 features/
@@ -513,7 +513,7 @@
513 patch mypatch.patch 513 patch mypatch.patch
514 514
515 patches/mypatch.patch: 515 patches/mypatch.patch:
516 &lt;typical-patch&gt; 516 <replaceable>typical-patch</replaceable>
517 </literallayout> 517 </literallayout>
518 You can create the typical <filename>.patch</filename> 518 You can create the typical <filename>.patch</filename>
519 file using <filename>diff -Nurp</filename> or 519 file using <filename>diff -Nurp</filename> or
@@ -968,37 +968,38 @@
968 hierarchical branching system similar to what the linux-yocto Linux 968 hierarchical branching system similar to what the linux-yocto Linux
969 kernel repositories use: 969 kernel repositories use:
970 <literallayout class='monospaced'> 970 <literallayout class='monospaced'>
971 &lt;common&gt;/&lt;kernel_type&gt;/&lt;machine&gt; 971 <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable>
972 </literallayout> 972 </literallayout>
973 </para> 973 </para>
974 974
975 <para> 975 <para>
976 If you had two kernel types, "standard" and "small" for 976 If you had two kernel types, "standard" and "small" for
977 instance, and three machines, the branches in your 977 instance, three machines, and <replaceable>common</replaceable>
978 as <filename>mydir</filename>, the branches in your
978 Git repository might look like this: 979 Git repository might look like this:
979 <literallayout class='monospaced'> 980 <literallayout class='monospaced'>
980 common/base 981 mydir/base
981 common/standard/base 982 mydir/standard/base
982 common/standard/machine_a 983 mydir/standard/machine_a
983 common/standard/machine_b 984 mydir/standard/machine_b
984 common/standard/machine_c 985 mydir/standard/machine_c
985 common/small/base 986 mydir/small/base
986 common/small/machine_a 987 mydir/small/machine_a
987 </literallayout> 988 </literallayout>
988 </para> 989 </para>
989 990
990 <para> 991 <para>
991 This organization can help clarify the branch relationships. 992 This organization can help clarify the branch relationships.
992 In this case, <filename>common/standard/machine_a</filename> 993 In this case, <filename>mydir/standard/machine_a</filename>
993 includes everything in <filename>common/base</filename> and 994 includes everything in <filename>mydir/base</filename> and
994 <filename>common/standard/base</filename>. 995 <filename>mydir/standard/base</filename>.
995 The "standard" and "small" branches add sources specific to those 996 The "standard" and "small" branches add sources specific to those
996 kernel types that for whatever reason are not appropriate for the 997 kernel types that for whatever reason are not appropriate for the
997 other branches. 998 other branches.
998 <note>The "base" branches are an artifact of the way Git manages 999 <note>The "base" branches are an artifact of the way Git manages
999 its data internally on the filesystem: Git will not allow you 1000 its data internally on the filesystem: Git will not allow you
1000 to use <filename>common/standard</filename> and 1001 to use <filename>mydir/standard</filename> and
1001 <filename>common/standard/machine_a</filename> because it 1002 <filename>mydir/standard/machine_a</filename> because it
1002 would have to create a file and a directory named "standard". 1003 would have to create a file and a directory named "standard".
1003 </note> 1004 </note>
1004 </para> 1005 </para>