summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-04-17 08:39:45 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:16 +0100
commitcef8b0f10f1a59924ee639b20e5c0b037e6956a1 (patch)
tree053e5cfe44d64c39a81828179481329ef2b2acce /documentation
parent7b582bc9a0c02ba0287b094dd5a10cf14ffb5564 (diff)
downloadpoky-cef8b0f10f1a59924ee639b20e5c0b037e6956a1.tar.gz
kernel-dev: Fixed a few links throughout manual.
The areas were found scrubbing the mega-manual. These were minor fixes. (From yocto-docs rev: aaa460be3f4a446c091d66a17ca6c010f335ccc4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml27
-rw-r--r--documentation/kernel-dev/kernel-dev-maint-appx.xml4
2 files changed, 15 insertions, 16 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index e152295233..5c76ed2391 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -64,8 +64,7 @@
64 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink> 64 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>
65 variable. 65 variable.
66 This variable is typically set to the same value as the 66 This variable is typically set to the same value as the
67 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 67 <filename>MACHINE</filename> variable, which is used by
68 variable, which is used by
69 <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>. 68 <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>.
70 However, in some cases, the variable might instead refer to the 69 However, in some cases, the variable might instead refer to the
71 underlying platform of the <filename>MACHINE</filename>. 70 underlying platform of the <filename>MACHINE</filename>.
@@ -77,8 +76,7 @@
77 Multiple Corei7-based BSPs could share the same "intel-corei7-64" 76 Multiple Corei7-based BSPs could share the same "intel-corei7-64"
78 value for <filename>KMACHINE</filename>. 77 value for <filename>KMACHINE</filename>.
79 It is important to realize that <filename>KMACHINE</filename> is 78 It is important to realize that <filename>KMACHINE</filename> is
80 just for kernel mapping, while 79 just for kernel mapping, while <filename>MACHINE</filename>
81 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
82 is the machine type within a BSP Layer. 80 is the machine type within a BSP Layer.
83 Even with this distinction, however, these two variables can hold 81 Even with this distinction, however, these two variables can hold
84 the same value. 82 the same value.
@@ -116,8 +114,7 @@
116 used in assembling the configuration. 114 used in assembling the configuration.
117 If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>, 115 If you do not specify a <filename>LINUX_KERNEL_TYPE</filename>,
118 it defaults to "standard". 116 it defaults to "standard".
119 Together with 117 Together with <filename>KMACHINE</filename>,
120 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
121 <filename>LINUX_KERNEL_TYPE</filename> defines the search 118 <filename>LINUX_KERNEL_TYPE</filename> defines the search
122 arguments used by the kernel tools to find the 119 arguments used by the kernel tools to find the
123 appropriate description within the kernel Metadata with which to 120 appropriate description within the kernel Metadata with which to
@@ -644,8 +641,7 @@
644 aggregation concepts, and presents a detailed example using 641 aggregation concepts, and presents a detailed example using
645 a BSP supported by the Yocto Project (i.e. BeagleBone Board). 642 a BSP supported by the Yocto Project (i.e. BeagleBone Board).
646 For complete information on BSP layer file hierarchy, see the 643 For complete information on BSP layer file hierarchy, see the
647 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support 644 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>.
648 Package (BSP) Developer's Guide</ulink>.
649 </para> 645 </para>
650 646
651 <section id='bsp-description-file-overview'> 647 <section id='bsp-description-file-overview'>
@@ -856,7 +852,7 @@
856 852
857 <para> 853 <para>
858 Now consider the "minnow" description for the "tiny" kernel 854 Now consider the "minnow" description for the "tiny" kernel
859 type (i.e. <filename>minnow-tiny.scc</filename>: 855 type (i.e. <filename>minnow-tiny.scc</filename>):
860 <literallayout class='monospaced'> 856 <literallayout class='monospaced'>
861 define KMACHINE minnow 857 define KMACHINE minnow
862 define KTYPE tiny 858 define KTYPE tiny
@@ -1018,8 +1014,7 @@
1018 1014
1019 <para> 1015 <para>
1020 If you modify the Metadata, you must not forget to update the 1016 If you modify the Metadata, you must not forget to update the
1021 <ulink url='&YOCTO_DOCS_REF_URL;#var-SRCREV'><filename>SRCREV</filename></ulink> 1017 <filename>SRCREV</filename> statements in the kernel's recipe.
1022 statements in the kernel's recipe.
1023 In particular, you need to update the 1018 In particular, you need to update the
1024 <filename>SRCREV_meta</filename> variable to match the commit in 1019 <filename>SRCREV_meta</filename> variable to match the commit in
1025 the <filename>KMETA</filename> branch you wish to use. 1020 the <filename>KMETA</filename> branch you wish to use.
@@ -1227,9 +1222,13 @@
1227 </para></listitem> 1222 </para></listitem>
1228 <listitem><para> 1223 <listitem><para>
1229 <filename>define</filename>: 1224 <filename>define</filename>:
1230 Defines variables, such as <filename>KMACHINE</filename>, 1225 Defines variables, such as
1231 <filename>KTYPE</filename>, <filename>KARCH</filename>, 1226 <ulink url='&YOCTO_DOCS_REF_URL;#var-KMACHINE'><filename>KMACHINE</filename></ulink>,
1232 and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem> 1227 <ulink url='&YOCTO_DOCS_REF_URL;#var-KTYPE'><filename>KTYPE</filename></ulink>,
1228 <ulink url='&YOCTO_DOCS_REF_URL;#var-KARCH'><filename>KARCH</filename></ulink>,
1229 and
1230 <ulink url='&YOCTO_DOCS_REF_URL;#var-KFEATURE_DESCRIPTION'><filename>KFEATURE_DESCRIPTION</filename></ulink>.
1231 </para></listitem>
1233 <listitem><para> 1232 <listitem><para>
1234 <filename>include SCC_FILE</filename>: 1233 <filename>include SCC_FILE</filename>:
1235 Includes an SCC file in the current file. 1234 Includes an SCC file in the current file.
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml
index 0a7c856bd6..b825ae7ea5 100644
--- a/documentation/kernel-dev/kernel-dev-maint-appx.xml
+++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml
@@ -14,7 +14,7 @@
14 create Yocto Linux kernel repositories. 14 create Yocto Linux kernel repositories.
15 These kernel repositories are found under the heading "Yocto Linux 15 These kernel repositories are found under the heading "Yocto Linux
16 Kernel" at 16 Kernel" at
17 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>&YOCTO_GIT_URL;/cgit.cgi</ulink> 17 <ulink url='&YOCTO_GIT_URL;'>&YOCTO_GIT_URL;</ulink>
18 and are shipped as part of a Yocto Project release. 18 and are shipped as part of a Yocto Project release.
19 The team creates these repositories by compiling and executing the 19 The team creates these repositories by compiling and executing the
20 set of feature descriptions for every BSP and feature in the 20 set of feature descriptions for every BSP and feature in the
@@ -118,7 +118,7 @@
118 The following steps describe what happens when the Yocto Project 118 The following steps describe what happens when the Yocto Project
119 Team constructs the Yocto Project kernel source Git repository 119 Team constructs the Yocto Project kernel source Git repository
120 (or tree) found at 120 (or tree) found at
121 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the 121 <ulink url='&YOCTO_GIT_URL;'></ulink> given the
122 introduction of a new top-level kernel feature or BSP. 122 introduction of a new top-level kernel feature or BSP.
123 The following actions effectively provide the Metadata 123 The following actions effectively provide the Metadata
124 and create the tree that includes the new feature, patch, or BSP: 124 and create the tree that includes the new feature, patch, or BSP: