summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-17 17:56:26 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:05 +0000
commitd0858ccb33a68d4bd2b34159e71bb2489f9c4728 (patch)
tree5d52f7634218c54a0631624c2b5a291cce270c57
parent6833ec86ac84d24e05ed3712f6cfcdb38a4dd01a (diff)
downloadpoky-d0858ccb33a68d4bd2b34159e71bb2489f9c4728.tar.gz
kernel-dev: Updates to get the new kernel-dev manual to make
These changes were to the intro chapter to introduce the DocBook form, the Makefile to introduce the new manual, the figure used for the title had to be updated, the root manual .XML file needed changed, and the style sheet. The manual now makes with just the raw text for Darren's intro section. (From yocto-docs rev: 1bceb7bdd4fe5773c11c7ddbdae00554680bbf6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/Makefile14
-rw-r--r--documentation/kernel-dev/figures/kernel-dev-title.pngbin27810 -> 13453 bytes
-rw-r--r--documentation/kernel-dev/kernel-dev-intro.xml101
-rw-r--r--documentation/kernel-dev/kernel-dev-style.css37
-rw-r--r--documentation/kernel-dev/kernel-dev.xml2
5 files changed, 86 insertions, 68 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index 1ab74fc61a..7c3d16ec04 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -235,6 +235,20 @@ FIGURES = figures
235STYLESHEET = $(DOC)/*.css 235STYLESHEET = $(DOC)/*.css
236endif 236endif
237 237
238ifeq ($(DOC),kernel-dev)
239XSLTOPTS = --stringparam html.stylesheet kernel-dev-style.css \
240 --stringparam chapter.autolabel 1 \
241 --stringparam appendix.autolabel A \
242 --stringparam section.autolabel 1 \
243 --stringparam section.label.includes.component.label 1 \
244 --xinclude
245ALLPREQ = html pdf tarball
246TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png
247MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
248FIGURES = figures
249STYLESHEET = $(DOC)/*.css
250endif
251
238 252
239## 253##
240# These URI should be rewritten by your distribution's xml catalog to 254# These URI should be rewritten by your distribution's xml catalog to
diff --git a/documentation/kernel-dev/figures/kernel-dev-title.png b/documentation/kernel-dev/figures/kernel-dev-title.png
index 1cb989f34a..7a8dd54372 100644
--- a/documentation/kernel-dev/figures/kernel-dev-title.png
+++ b/documentation/kernel-dev/figures/kernel-dev-title.png
Binary files differ
diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml
index c1cc22bb7a..68fac80ac7 100644
--- a/documentation/kernel-dev/kernel-dev-intro.xml
+++ b/documentation/kernel-dev/kernel-dev-intro.xml
@@ -2,76 +2,79 @@
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[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4 4
5<chapter id='kernel-doc-intro'> 5<chapter id='kernel-dev-intro'>
6 6
7<title>Yocto Project Kernel Architecture and Use Manual</title> 7<title>Yocto Project Kernel Development Manual</title>
8 8
9<section id='kernel-intro-section'> 9<section id='kernel-dev-introduction'>
10 <title>Introduction</title> 10 <title>Introduction</title>
11
11 <para> 12 <para>
12 The Yocto Project presents kernels as a fully patched, history-clean Git 13 Regardless of how you intend to make use of the Yocto Project, chances are you
13 repositories. 14are going to need to work with the Linux kernel. The Yocto Project provides a
14 Each repository represents selected features, board support, 15powerful set of tools for managing Linux kernel sources and configuration data.
15 and configurations extensively tested by the Yocto Project. 16If you want to make a single configuration change, apply a couple of patches, or
16 Yocto Project kernels allow the end user to leverage community 17work with your own sources, the Yocto Project has tooling in place to help you
17 best practices to seamlessly manage the development, build and debug cycles. 18do it.
18 </para> 19 </para>
20
19 <para> 21 <para>
20 This manual describes Yocto Project kernels by providing information 22 Each Yocto Project release introduces a new set of linux-yocto kernel recipes,
21 on history, organization, benefits, and use. 23tracking the latest upstream developments and introducing newly supported
22 The manual consists of two sections: 24platforms. In addition to the new kernel recipes, the previous recipes are
23 <itemizedlist> 25refreshed and supported for at least one additional release. As they align,
24 <listitem><para><emphasis>Concepts:</emphasis> Describes concepts behind a kernel. 26these previous releases are updated to include the latest from the LTSI project.
25 You will understand how a kernel is organized and why it is organized in 27Besides these recipes, a linux-yocto-dev recipe is available for working with
26 the way it is. You will understand the benefits of a kernel's organization 28the very latest in upstream Linux kernel development as well as meta-data
27 and the mechanisms used to work with the kernel and how to apply it in your 29development.
28 design process.</para></listitem>
29 <listitem><para><emphasis>Using a Kernel:</emphasis> Describes best practices
30 and "how-to" information
31 that lets you put a kernel to practical use.
32 Some examples are how to examine changes in a branch and how to
33 save kernel modifications.</para></listitem>
34 </itemizedlist>
35 </para> 30 </para>
36 31
37 <para> 32 <para>
38 For more information on the Linux kernel, see the following links: 33 If you do not maintain your own kernel sources and need to make only minimal
39 <itemizedlist> 34changes to the sources, these recipes provide a vetted base upon which to layer
40 <listitem><para>The Linux Foundation's guide for kernel development 35your changes. Doing so allows you to benefit from the continual kernel
41 process - <ulink url='http://www.linuxfoundation.org/content/1-guide-kernel-development-process'></ulink></para></listitem> 36integration and testing performed during development of the Yocto Project.
42 <listitem><para>A fairly encompassing guide on Linux kernel development -
43 <ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem>
44 </itemizedlist>
45 </para> 37 </para>
46 38
47 <para> 39 <para>
48 For more discussion on the Yocto Project kernel, you can see these sections 40 If, instead, you have a very specific Linux kernel source tree and are unable to
49 in the Yocto Project Development Manual: 41align with one of the many official linux-yocto releases, an alternative
42exists by which you can use the Yocto Project Linux kernel tools with your own
43sources.
44 </para>
45
46 <para>
47 The sections that follow provide instructions for completing specific Linux
48kernel development tasks. They assume familiarity with working with bitbake
49recipes and basic open-source development tools. Understanding these concepts
50will facilitate the process of working with the kernel recipes. If you find you
51need some additional background, please be sure to review and understand the
52following documentation:
50 <itemizedlist> 53 <itemizedlist>
51 <listitem><para> 54 <listitem><para><emphasis>Yocto Project Quick Start</emphasis>
52 "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-overview'>Kernel Overview</ulink>"</para></listitem>
53 <listitem><para>
54 "<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification Workflow</ulink>"
55 </para></listitem> 55 </para></listitem>
56 <listitem><para> 56 <listitem><para><emphasis>Yocto Project Development Manual</emphasis>
57 "<ulink url='&YOCTO_DOCS_DEV_URL;#patching-the-kernel'>Patching the Kernel</ulink>"</para></listitem> 57 <itemizedlist>
58 <listitem><para> 58 <listitem><para><emphasis>4.3 Modifying Temporary Source Code</emphasis>
59 "<ulink url='&YOCTO_DOCS_DEV_URL;#configuring-the-kernel'>Configuring the Kernel</ulink>"</para></listitem> 59 </para></listitem>
60 <listitem><para><emphasis>5.1 Understanding and Creating Layers</emphasis>
61 </para></listitem>
62 <listitem><para><emphasis>4.1.2 Modifying the Kernel</emphasis>
63 (This section should be retired, as well as 5.6, 5.7 - with this document
64 providing the necessary information)</para></listitem>
65 </itemizedlist></para></listitem>
60 </itemizedlist> 66 </itemizedlist>
61 </para> 67 </para>
62 68
63 <para> 69 <para>
64 For general information on the Yocto Project, visit the website at 70 Finally, while this document focuses on the manual creation of recipes, patches,
65 <ulink url='&YOCTO_HOME_URL;'></ulink>. 71and configuration files, the Yocto Project BSP tools are available to automate
72this process with existing content and work well to create the initial framework
73and boilerplate code. For details, refer to the Yocto Project BSP Developer's
74Guide.
66 </para> 75 </para>
67</section> 76</section>
68 77
69
70
71
72
73
74
75</chapter> 78</chapter>
76<!-- 79<!--
77vim: expandtab tw=80 ts=4 80vim: expandtab tw=80 ts=4
diff --git a/documentation/kernel-dev/kernel-dev-style.css b/documentation/kernel-dev/kernel-dev-style.css
index a90d4af291..52be14388d 100644
--- a/documentation/kernel-dev/kernel-dev-style.css
+++ b/documentation/kernel-dev/kernel-dev-style.css
@@ -1,6 +1,6 @@
1/* 1/*
2 Generic XHTML / DocBook XHTML CSS Stylesheet. 2 Generic XHTML / DocBook XHTML CSS Stylesheet.
3 3
4 Browser wrangling and typographic design by 4 Browser wrangling and typographic design by
5 Oyvind Kolas / pippin@gimp.org 5 Oyvind Kolas / pippin@gimp.org
6 6
@@ -42,7 +42,7 @@
42 42
43body { 43body {
44 font-family: Verdana, Sans, sans-serif; 44 font-family: Verdana, Sans, sans-serif;
45 45
46 min-width: 640px; 46 min-width: 640px;
47 width: 80%; 47 width: 80%;
48 margin: 0em auto; 48 margin: 0em auto;
@@ -118,7 +118,7 @@ h6 {
118 background-color: transparent; 118 background-color: transparent;
119 background-repeat: no-repeat; 119 background-repeat: no-repeat;
120 padding-top: 256px; 120 padding-top: 256px;
121 background-image: url("figures/kernel-title.png"); 121 background-image: url("figures/kernel-dev-title.png");
122 background-position: left top; 122 background-position: left top;
123 margin-top: -256px; 123 margin-top: -256px;
124 padding-right: 50px; 124 padding-right: 50px;
@@ -243,7 +243,7 @@ div.legalnotice p.legalnotice-title {
243p { 243p {
244 line-height: 1.5em; 244 line-height: 1.5em;
245 margin-top: 0em; 245 margin-top: 0em;
246 246
247} 247}
248 248
249dl { 249dl {
@@ -297,7 +297,7 @@ p a[id] {
297 padding: 0px; 297 padding: 0px;
298 display: inline; 298 display: inline;
299 background-image: none; 299 background-image: none;
300} 300}
301 301
302a { 302a {
303 text-decoration: underline; 303 text-decoration: underline;
@@ -338,10 +338,10 @@ div.table p.title b{
338 font-weight: normal; 338 font-weight: normal;
339} 339}
340 340
341.mediaobject .caption, 341.mediaobject .caption,
342.mediaobject .caption p { 342.mediaobject .caption p {
343 text-align: center; 343 text-align: center;
344 font-size: 80%; 344 font-size: 80%;
345 padding-top: 0.5em; 345 padding-top: 0.5em;
346 padding-bottom: 0.5em; 346 padding-bottom: 0.5em;
347} 347}
@@ -604,7 +604,7 @@ b.keycap,
604.keycap { 604.keycap {
605 border: 1px solid; 605 border: 1px solid;
606} 606}
607 607
608 608
609div.navheader, div.heading{ 609div.navheader, div.heading{
610 border-bottom: 1px solid; 610 border-bottom: 1px solid;
@@ -675,10 +675,10 @@ hr {
675} 675}
676 676
677.note { 677.note {
678 background-color: #f0f0f2; 678 background-color: #f0f0f2;
679} 679}
680 680
681.glossary dl dt, 681.glossary dl dt,
682.variablelist dl dt, 682.variablelist dl dt,
683.variablelist dl dt span.term { 683.variablelist dl dt span.term {
684 color: #044; 684 color: #044;
@@ -778,10 +778,10 @@ div.article .titlepage .title
778} 778}
779*/ 779*/
780 780
781div.preface .titlepage .title, 781div.preface .titlepage .title,
782div.colophon .title, 782div.colophon .title,
783div.chapter .titlepage .title, 783div.chapter .titlepage .title,
784div.article .titlepage .title 784div.article .titlepage .title
785{ 785{
786} 786}
787 787
@@ -942,8 +942,8 @@ table {
942 942
943.tip, 943.tip,
944.note { 944.note {
945 background: #f0f0f2; 945 background: #f0f0f2;
946 color: #333; 946 color: #333;
947 padding: 20px; 947 padding: 20px;
948 margin: 20px; 948 margin: 20px;
949} 949}
@@ -954,12 +954,12 @@ table {
954 margin: 0em; 954 margin: 0em;
955 font-size: 2em; 955 font-size: 2em;
956 font-weight: bold; 956 font-weight: bold;
957 color: #333; 957 color: #333;
958} 958}
959 959
960.tip a, 960.tip a,
961.note a { 961.note a {
962 color: #333; 962 color: #333;
963 text-decoration: underline; 963 text-decoration: underline;
964} 964}
965 965
@@ -976,4 +976,3 @@ table {
976 font-size:large; 976 font-size:large;
977 color: #00557D; 977 color: #00557D;
978} 978}
979
diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml
index 82a9e2ff5c..ab8f45366c 100644
--- a/documentation/kernel-dev/kernel-dev.xml
+++ b/documentation/kernel-dev/kernel-dev.xml
@@ -59,6 +59,7 @@
59 59
60 <xi:include href="kernel-dev-intro.xml"/> 60 <xi:include href="kernel-dev-intro.xml"/>
61 61
62<!--
62 <xi:include href="kernel-dev-common.xml"/> 63 <xi:include href="kernel-dev-common.xml"/>
63 64
64 <xi:include href="kernel-dev-advanced.xml"/> 65 <xi:include href="kernel-dev-advanced.xml"/>
@@ -66,6 +67,7 @@
66 <xi:include href="kernel-dev-examples.xml"/> 67 <xi:include href="kernel-dev-examples.xml"/>
67 68
68 <xi:include href="kernel-dev-faq.xml"/> 69 <xi:include href="kernel-dev-faq.xml"/>
70-->
69 71
70<!-- <index id='index'> 72<!-- <index id='index'>
71 <title>Index</title> 73 <title>Index</title>