summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-10-02 17:31:06 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-06 12:06:33 +0100
commit42303c0d9ff56cf5f479cdae3ac6bcde90f0df9e (patch)
treefc4b62784a114160c97b53d3cd2ca9b874191795
parentdc2f2ae714dd380c353d74b0cccdd2bca897d073 (diff)
downloadpoky-42303c0d9ff56cf5f479cdae3ac6bcde90f0df9e.tar.gz
kernel-dev: Miscellaneous Edits to Advanced Metadata chapter
(From yocto-docs rev: 74e27b697efa7ea7ecc1d1d59266b537dd70ae98) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml35
1 files changed, 21 insertions, 14 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 3d19ed2cf2..355bdc1ac2 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -327,7 +327,7 @@
327 # Increase default NR_CPUS from 8 to 64 so that platform with 327 # Increase default NR_CPUS from 8 to 64 so that platform with
328 # more than 8 processors can be all activated at boot time 328 # more than 8 processors can be all activated at boot time
329 CONFIG_NR_CPUS=64 329 CONFIG_NR_CPUS=64
330 # The following is nedded when setting NR_CPUS to something 330 # The following is needed when setting NR_CPUS to something
331 # greater than 8 on x86 architectures, it should be automatically 331 # greater than 8 on x86 architectures, it should be automatically
332 # disregarded by Kconfig when using a different arch 332 # disregarded by Kconfig when using a different arch
333 CONFIG_X86_BIGSMP=y 333 CONFIG_X86_BIGSMP=y
@@ -697,7 +697,7 @@
697 Metadata as it is here, you only need to ensure that the 697 Metadata as it is here, you only need to ensure that the
698 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink> 698 <ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink>
699 variable in the kernel recipe and the 699 variable in the kernel recipe and the
700 <filename>KTYPE</filename> variable in the BSP descriptionn 700 <filename>KTYPE</filename> variable in the BSP description
701 file match. 701 file match.
702 <note> 702 <note>
703 Future versions of the tooling make the specification of 703 Future versions of the tooling make the specification of
@@ -1133,10 +1133,9 @@
1133 </para> 1133 </para>
1134 1134
1135 <para> 1135 <para>
1136 If you find 1136 If you find yourself with numerous branches, you might consider
1137 yourself with numerous branches, you might consider using a 1137 using a hierarchical branching system similar to what the
1138 hierarchical branching system similar to what the linux-yocto Linux 1138 Yocto Linux Kernel Git repositories use:
1139 kernel repositories use:
1140 <literallayout class='monospaced'> 1139 <literallayout class='monospaced'>
1141 <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable> 1140 <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable>
1142 </literallayout> 1141 </literallayout>
@@ -1166,7 +1165,8 @@
1166 The "standard" and "small" branches add sources specific to those 1165 The "standard" and "small" branches add sources specific to those
1167 kernel types that for whatever reason are not appropriate for the 1166 kernel types that for whatever reason are not appropriate for the
1168 other branches. 1167 other branches.
1169 <note>The "base" branches are an artifact of the way Git manages 1168 <note>
1169 The "base" branches are an artifact of the way Git manages
1170 its data internally on the filesystem: Git will not allow you 1170 its data internally on the filesystem: Git will not allow you
1171 to use <filename>mydir/standard</filename> and 1171 to use <filename>mydir/standard</filename> and
1172 <filename>mydir/standard/machine_a</filename> because it 1172 <filename>mydir/standard/machine_a</filename> because it
@@ -1213,27 +1213,34 @@
1213 This section provides a brief reference for the commands you can use 1213 This section provides a brief reference for the commands you can use
1214 within an SCC description file (<filename>.scc</filename>): 1214 within an SCC description file (<filename>.scc</filename>):
1215 <itemizedlist> 1215 <itemizedlist>
1216 <listitem><para><filename>branch [ref]</filename>: 1216 <listitem><para>
1217 <filename>branch [ref]</filename>:
1217 Creates a new branch relative to the current branch 1218 Creates a new branch relative to the current branch
1218 (typically <filename>${KTYPE}</filename>) using 1219 (typically <filename>${KTYPE}</filename>) using
1219 the currently checked-out branch, or "ref" if specified. 1220 the currently checked-out branch, or "ref" if specified.
1220 </para></listitem> 1221 </para></listitem>
1221 <listitem><para><filename>define</filename>: 1222 <listitem><para>
1223 <filename>define</filename>:
1222 Defines variables, such as <filename>KMACHINE</filename>, 1224 Defines variables, such as <filename>KMACHINE</filename>,
1223 <filename>KTYPE</filename>, <filename>KARCH</filename>, 1225 <filename>KTYPE</filename>, <filename>KARCH</filename>,
1224 and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem> 1226 and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem>
1225 <listitem><para><filename>include SCC_FILE</filename>: 1227 <listitem><para>
1228 <filename>include SCC_FILE</filename>:
1226 Includes an SCC file in the current file. 1229 Includes an SCC file in the current file.
1227 The file is parsed as if you had inserted it inline. 1230 The file is parsed as if you had inserted it inline.
1228 </para></listitem> 1231 </para></listitem>
1229 <listitem><para><filename>kconf [hardware|non-hardware] CFG_FILE</filename>: 1232 <listitem><para>
1233 <filename>kconf [hardware|non-hardware] CFG_FILE</filename>:
1230 Queues a configuration fragment for merging into the final 1234 Queues a configuration fragment for merging into the final
1231 Linux <filename>.config</filename> file.</para></listitem> 1235 Linux <filename>.config</filename> file.</para></listitem>
1232 <listitem><para><filename>git merge GIT_BRANCH</filename>: 1236 <listitem><para>
1237 <filename>git merge GIT_BRANCH</filename>:
1233 Merges the feature branch into the current branch. 1238 Merges the feature branch into the current branch.
1234 </para></listitem> 1239 </para></listitem>
1235 <listitem><para><filename>patch PATCH_FILE</filename>: 1240 <listitem><para>
1236 Applies the patch to the current Git branch.</para></listitem> 1241 <filename>patch PATCH_FILE</filename>:
1242 Applies the patch to the current Git branch.
1243 </para></listitem>
1237 </itemizedlist> 1244 </itemizedlist>
1238 </para> 1245 </para>
1239</section> 1246</section>