summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-09 15:35:11 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-23 14:24:43 +0000
commitd048a99e2404601a3f343eeb65ce82fb963c6f51 (patch)
tree1027ee7fb4d4ffddc6118d6dbe65b7af6871c152 /documentation
parentaa3a201629c7e40341f53d4be57b6e4223a845c8 (diff)
downloadpoky-d048a99e2404601a3f343eeb65ce82fb963c6f51.tar.gz
documentation/kernel-manual: Converted to use variables from poky.ent.
Also removed a broken link. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-manual/kernel-concepts.xml24
-rw-r--r--documentation/kernel-manual/kernel-doc-intro.xml13
-rw-r--r--documentation/kernel-manual/kernel-how-to.xml36
-rw-r--r--documentation/kernel-manual/kernel-manual.xml9
4 files changed, 40 insertions, 42 deletions
diff --git a/documentation/kernel-manual/kernel-concepts.xml b/documentation/kernel-manual/kernel-concepts.xml
index 27b32098ec..a82977dc49 100644
--- a/documentation/kernel-manual/kernel-concepts.xml
+++ b/documentation/kernel-manual/kernel-concepts.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='kernel-concepts'> 5<chapter id='kernel-concepts'>
5 6
@@ -160,9 +161,8 @@
160 The features are tagged and organized by way of a branching strategy implemented by the 161 The features are tagged and organized by way of a branching strategy implemented by the
161 source code manager (SCM) Git. 162 source code manager (SCM) Git.
162 For information on Git as applied to the Yocto Project, see the 163 For information on Git as applied to the Yocto Project, see the
163 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" 164 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>" section in the
164 section in <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The 165 Yocto Project Development Manual.
165 Yocto Project Development Manual</ulink>.
166 </para> 166 </para>
167 <para> 167 <para>
168 The result is that the user has the ability to see the added features and 168 The result is that the user has the ability to see the added features and
@@ -289,9 +289,8 @@
289 <para> 289 <para>
290 You can find documentation on Git at <ulink url='http://git-scm.com/documentation'></ulink>. 290 You can find documentation on Git at <ulink url='http://git-scm.com/documentation'></ulink>.
291 You can also get an introduction to Git as it applies to the Yocto Project in the 291 You can also get an introduction to Git as it applies to the Yocto Project in the
292 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" 292 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>"
293 section in <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The 293 section in the Yocto Project Development Manual.
294 Yocto Project Development Manual</ulink>.
295 These referenced sections overview Git and describe a minimal set of 294 These referenced sections overview Git and describe a minimal set of
296 commands that allow you to be functional using Git. 295 commands that allow you to be functional using Git.
297 <note> 296 <note>
@@ -344,7 +343,7 @@
344 After the tool is built, you can interact with it normally. 343 After the tool is built, you can interact with it normally.
345 You can see how <filename>menuconfig</filename> is used to change a simple 344 You can see how <filename>menuconfig</filename> is used to change a simple
346 kernel configuration in the 345 kernel configuration in the
347 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#changing-the-config-smp-configuration-using-menuconfig'>Changing the&nbsp;&nbsp;<filename>CONFIG_SMP</filename> Configuration Using&nbsp;&nbsp;<filename>menuconfig</filename></ulink>" 346 "<ulink url='&YOCTO_DOCS_DEV_URL;#changing-the-config-smp-configuration-using-menuconfig'>Changing the&nbsp;&nbsp;<filename>CONFIG_SMP</filename> Configuration Using&nbsp;&nbsp;<filename>menuconfig</filename></ulink>"
348 section of The Yocto Project Development Manual. 347 section of The Yocto Project Development Manual.
349 For general information on <filename>menuconfig</filename>, see 348 For general information on <filename>menuconfig</filename>, see
350 <ulink url='http://en.wikipedia.org/wiki/Menuconfig'></ulink>. 349 <ulink url='http://en.wikipedia.org/wiki/Menuconfig'></ulink>.
@@ -356,10 +355,10 @@
356 by the Yocto Project build system to produce input used by the LKC 355 by the Yocto Project build system to produce input used by the LKC
357 that ultimately generates the <filename>.config</filename> file.</para> 356 that ultimately generates the <filename>.config</filename> file.</para>
358 <para>The 357 <para>The
359 <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink></filename> 358 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-KERNEL_FEATURES'>KERNEL_FEATURES</ulink></filename>
360 variable can be used to list configuration fragments. 359 variable can be used to list configuration fragments.
361 For further discussion on applying configuration fragments, see the 360 For further discussion on applying configuration fragments, see the
362 "<ulink url='http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#linux-kernel-configuration'>Linux Kernel Configuration</ulink>" 361 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-kernel'>Linux Kernel Configuration</ulink>"
363 section in the Yocto Project Board Support Package (BSP) Guide. 362 section in the Yocto Project Board Support Package (BSP) Guide.
364 </para></listitem> 363 </para></listitem>
365 </itemizedlist> 364 </itemizedlist>
@@ -400,11 +399,6 @@ kernel toolkit:
400</itemizedlist> 399</itemizedlist>
401</para> --> 400</para> -->
402 </section> 401 </section>
403
404
405
406
407
408</chapter> 402</chapter>
409<!-- 403<!--
410vim: expandtab tw=80 ts=4 404vim: expandtab tw=80 ts=4
diff --git a/documentation/kernel-manual/kernel-doc-intro.xml b/documentation/kernel-manual/kernel-doc-intro.xml
index 9f845823d3..c3fde6c731 100644
--- a/documentation/kernel-manual/kernel-doc-intro.xml
+++ b/documentation/kernel-manual/kernel-doc-intro.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='kernel-doc-intro'> 5<chapter id='kernel-doc-intro'>
5 6
@@ -46,21 +47,21 @@
46 47
47 <para> 48 <para>
48 For more discussion on the Yocto Project kernel, you can see these sections 49 For more discussion on the Yocto Project kernel, you can see these sections
49 in <ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html'>The Yocto Project Development Manual</ulink>: 50 in <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project Development Manual</ulink>:
50 <itemizedlist> 51 <itemizedlist>
51 <listitem><para> 52 <listitem><para>
52 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#kernel-overview'>Kernel Overview</ulink>"</para></listitem> 53 "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-overview'>Kernel Overview</ulink>"</para></listitem>
53 <listitem><para> 54 <listitem><para>
54 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#kernel-modification-workflow'>Kernel Modification Workflow</ulink>" 55 "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification Workflow</ulink>"
55 </para></listitem> 56 </para></listitem>
56 <listitem><para> 57 <listitem><para>
57 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>".</para></listitem> 58 "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>"</para></listitem>
58 </itemizedlist> 59 </itemizedlist>
59 </para> 60 </para>
60 61
61 <para> 62 <para>
62 For general information on the Yocto Project, visit the website at 63 For general information on the Yocto Project, visit the website at
63 <ulink url='http://www.yoctoproject.org'></ulink>. 64 <ulink url='&YOCTO_HOME_URL;'></ulink>.
64 </para> 65 </para>
65</section> 66</section>
66 67
diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml
index c43af60d36..37efbf0ae2 100644
--- a/documentation/kernel-manual/kernel-how-to.xml
+++ b/documentation/kernel-manual/kernel-how-to.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<chapter id='kernel-how-to'> 5<chapter id='kernel-how-to'>
5 6
@@ -27,7 +28,7 @@
27 This section describes construction of the Yocto Project kernel repositories 28 This section describes construction of the Yocto Project kernel repositories
28 as accomplished by the Yocto Project team to create kernel repositories. 29 as accomplished by the Yocto Project team to create kernel repositories.
29 These kernel repositories are found at 30 These kernel repositories are found at
30 <ulink url='http://git.yoctoproject.org/cgit.cgi'>http://git.yoctoproject.org/cgit.cgi</ulink> 31 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>&YOCTO_GIT_URL;/cgit.cgi</ulink>
31 and can be shipped as part of a Yocto Project release. 32 and can be shipped as part of a Yocto Project release.
32 The team creates these repositories by 33 The team creates these repositories by
33 compiling and executing the set of feature descriptions for every BSP/feature 34 compiling and executing the set of feature descriptions for every BSP/feature
@@ -51,7 +52,7 @@
51 </literallayout> 52 </literallayout>
52 For another example of how to set up a local Git repository of the Linux Yocto 53 For another example of how to set up a local Git repository of the Linux Yocto
53 kernel files, see the 54 kernel files, see the
54 "<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. 55 "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" bulleted item in The Yocto Project Development Manual.
55 </para> 56 </para>
56 <para> 57 <para>
57 Once you have cloned the kernel Git repository on your local machine, you can 58 Once you have cloned the kernel Git repository on your local machine, you can
@@ -85,7 +86,7 @@
85 <para> 86 <para>
86 The following steps describe what happens when the Yocto Project Team constructs 87 The following steps describe what happens when the Yocto Project Team constructs
87 the Yocto Linux kernel source Git repository (or tree) found at 88 the Yocto Linux kernel source Git repository (or tree) found at
88 <ulink url='http://git.yoctoproject.org/cgit.cgi'></ulink> given the 89 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the
89 introduction of a new top-level kernel feature or BSP. 90 introduction of a new top-level kernel feature or BSP.
90 These are the actions that effectively create the tree 91 These are the actions that effectively create the tree
91 that includes the new feature, patch or BSP: 92 that includes the new feature, patch or BSP:
@@ -135,7 +136,7 @@
135 Any add-ons and configuration data are applied to the end of an existing branch. 136 Any add-ons and configuration data are applied to the end of an existing branch.
136 The full repository generation that is found in the 137 The full repository generation that is found in the
137 official Yocto Project kernel repositories at 138 official Yocto Project kernel repositories at
138 <ulink url='http://git.yoctoproject.org/cgit.cgi'>http://git.yoctoproject.org/cgit.cgi</ulink> 139 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'>http://git.yoctoproject.org/cgit.cgi</ulink>
139 is the combination of all supported boards and configurations.</para> 140 is the combination of all supported boards and configurations.</para>
140 <para>The technique the Yocto Project team uses is flexible and allows for seamless 141 <para>The technique the Yocto Project team uses is flexible and allows for seamless
141 blending of an immutable history with additional patches specific to a 142 blending of an immutable history with additional patches specific to a
@@ -236,7 +237,7 @@
236 You can find Git documentation at 237 You can find Git documentation at
237 <ulink url='http://git-scm.com/documentation'></ulink>. 238 <ulink url='http://git-scm.com/documentation'></ulink>.
238 You can find a simple overview of using Git with the Yocto Project in the 239 You can find a simple overview of using Git with the Yocto Project in the
239 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#git'>Git</ulink>" 240 "<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink>"
240 section of The Yocto Project Development Manual. 241 section of The Yocto Project Development Manual.
241 </para> 242 </para>
242 243
@@ -362,9 +363,10 @@
362 The Yocto Project provides scripts that help you work in a collaborative development 363 The Yocto Project provides scripts that help you work in a collaborative development
363 environment. 364 environment.
364 For information on these scripts, see the 365 For information on these scripts, see the
365 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#pushing-a-change-upstream'>Pushing a Change Upstream and Requesting a Pull</ulink>" and 366 "<ulink url='&YOCTO_DOCS_DEV_URL;#pushing-a-change-upstream'>Pushing a Change
366 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#submitting-a-patch'>Submitting a Patch Through Email</ulink>" sections in The Yocto Project Development 367 Upstream and Requesting a Pull</ulink>" and
367 Manual. 368 "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-patch'>Submitting a Patch Through
369 Email</ulink>" sections in The Yocto Project Development Manual.
368 </para> 370 </para>
369 371
370 <para> 372 <para>
@@ -631,8 +633,6 @@
631 For example, kernel patches should follow standards such as: 633 For example, kernel patches should follow standards such as:
632 <itemizedlist> 634 <itemizedlist>
633 <listitem><para> 635 <listitem><para>
634 <ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem>
635 <listitem><para>
636 <ulink url='http://linux.yyz.us/patch-format.html'></ulink></para></listitem> 636 <ulink url='http://linux.yyz.us/patch-format.html'></ulink></para></listitem>
637 <listitem><para>Documentation/SubmittingPatches (in any linux 637 <listitem><para>Documentation/SubmittingPatches (in any linux
638 kernel source tree)</para></listitem> 638 kernel source tree)</para></listitem>
@@ -644,7 +644,8 @@
644 The messages used to commit changes are a large part of these standards. 644 The messages used to commit changes are a large part of these standards.
645 Consequently, be sure that the headers for each commit have the required information. 645 Consequently, be sure that the headers for each commit have the required information.
646 For information on how to follow the Yocto Project commit message standards, see the 646 For information on how to follow the Yocto Project commit message standards, see the
647 "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#how-to-submit-a-change'>How to Submit a Change</ulink>" section in The Yocto Project Development Manual. 647 "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a
648 Change</ulink>" section in The Yocto Project Development Manual.
648 </para> 649 </para>
649 650
650 <para> 651 <para>
@@ -746,7 +747,8 @@
746 </para> 747 </para>
747 748
748 <para> 749 <para>
749 The following commands illustrate how you can condense and merge two BSPs into a second SCM: 750 The following commands illustrate how you can condense and merge two BSPs into a
751 second SCM:
750 <literallayout class='monospaced'> 752 <literallayout class='monospaced'>
751 &gt; git checkout yocto/standard/common-pc/base 753 &gt; git checkout yocto/standard/common-pc/base
752 &gt; git merge yocto/standard/common-pc-64/base 754 &gt; git merge yocto/standard/common-pc-64/base
@@ -777,9 +779,9 @@
777 existing similar BSP. 779 existing similar BSP.
778 The information is introductory in nature and does not provide step-by-step examples. 780 The information is introductory in nature and does not provide step-by-step examples.
779 For detailed information on how to create a BSP given an existing similar BSP, see 781 For detailed information on how to create a BSP given an existing similar BSP, see
780 the "<ulink url='http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#dev-manual-bsp-appendix'>BSP Development Example</ulink>" appendix in The 782 the "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-bsp-appendix'>BSP Development
781 Yocto Project Development Manual, or see the 783 Example</ulink>" appendix in the Yocto Project Development Manual, or see the
782 <ulink url='https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>Transcript:_creating_one_generic_Atom_BSP_from_another</ulink> 784 <ulink url='&YOCTO_WIKI_URL;/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another'>Transcript:_creating_one_generic_Atom_BSP_from_another</ulink>
783 wiki page. 785 wiki page.
784 </para> 786 </para>
785 787
@@ -796,7 +798,7 @@
796 your BSP easier. 798 your BSP easier.
797 You can find all the BSPs that are supported and ship with the Yocto Project 799 You can find all the BSPs that are supported and ship with the Yocto Project
798 on the Yocto Project's Download page at 800 on the Yocto Project's Download page at
799 <ulink url='http://www.yoctoproject.org/download'></ulink>.</para></listitem> 801 <ulink url='&YOCTO_HOME_URL;/download'></ulink>.</para></listitem>
800 <listitem><para><emphasis>Be sure you have the Base BSP:</emphasis> 802 <listitem><para><emphasis>Be sure you have the Base BSP:</emphasis>
801 You need to either have the Yocto Project Git repository set up or download 803 You need to either have the Yocto Project Git repository set up or download
802 the tarball of the base BSP. 804 the tarball of the base BSP.
diff --git a/documentation/kernel-manual/kernel-manual.xml b/documentation/kernel-manual/kernel-manual.xml
index 398e800273..0f239d3e47 100644
--- a/documentation/kernel-manual/kernel-manual.xml
+++ b/documentation/kernel-manual/kernel-manual.xml
@@ -1,5 +1,6 @@
1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
3 4
4<book id='kernel-manual' lang='en' 5<book id='kernel-manual' lang='en'
5 xmlns:xi="http://www.w3.org/2003/XInclude" 6 xmlns:xi="http://www.w3.org/2003/XInclude"
@@ -51,7 +52,7 @@
51 </revhistory> 52 </revhistory>
52 53
53 <copyright> 54 <copyright>
54 <year>2010-2012</year> 55 <year>&COPYRIGHT_YEAR;</year>
55 <holder>Linux Foundation</holder> 56 <holder>Linux Foundation</holder>
56 </copyright> 57 </copyright>
57 58
@@ -63,9 +64,9 @@
63 <note> 64 <note>
64 Due to production processes, there could be differences between the Yocto Project 65 Due to production processes, there could be differences between the Yocto Project
65 documentation bundled in the release tarball and 66 documentation bundled in the release tarball and
66 <ulink url='http://www.yoctoproject.org/docs/latest/kernel-manual/kernel-manual.html'> 67 <ulink url='&YOCTO_DOCS_KERNEL_URL;'>
67 The Yocto Project Kernel Architecture and Use Manual</ulink> on 68 The Yocto Project Kernel Architecture and Use Manual</ulink> on
68 the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. 69 the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
69 For the latest version of this manual, see the manual on the website. 70 For the latest version of this manual, see the manual on the website.
70 </note> 71 </note>
71 </legalnotice> 72 </legalnotice>