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>
This commit is contained in:
Scott Rifenbark 2012-12-17 17:56:26 -06:00 committed by Richard Purdie
parent 6833ec86ac
commit d0858ccb33
5 changed files with 88 additions and 70 deletions

View File

@ -235,6 +235,20 @@ FIGURES = figures
STYLESHEET = $(DOC)/*.css STYLESHEET = $(DOC)/*.css
endif endif
ifeq ($(DOC),kernel-dev)
XSLTOPTS = --stringparam html.stylesheet kernel-dev-style.css \
--stringparam chapter.autolabel 1 \
--stringparam appendix.autolabel A \
--stringparam section.autolabel 1 \
--stringparam section.label.includes.component.label 1 \
--xinclude
ALLPREQ = html pdf tarball
TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png
MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf
FIGURES = figures
STYLESHEET = $(DOC)/*.css
endif
## ##
# These URI should be rewritten by your distribution's xml catalog to # These URI should be rewritten by your distribution's xml catalog to

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -2,76 +2,79 @@
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='kernel-doc-intro'> <chapter id='kernel-dev-intro'>
<title>Yocto Project Kernel Architecture and Use Manual</title> <title>Yocto Project Kernel Development Manual</title>
<section id='kernel-intro-section'> <section id='kernel-dev-introduction'>
<title>Introduction</title> <title>Introduction</title>
<para> <para>
The Yocto Project presents kernels as a fully patched, history-clean Git Regardless of how you intend to make use of the Yocto Project, chances are you
repositories. are going to need to work with the Linux kernel. The Yocto Project provides a
Each repository represents selected features, board support, powerful set of tools for managing Linux kernel sources and configuration data.
and configurations extensively tested by the Yocto Project. If you want to make a single configuration change, apply a couple of patches, or
Yocto Project kernels allow the end user to leverage community work with your own sources, the Yocto Project has tooling in place to help you
best practices to seamlessly manage the development, build and debug cycles. do it.
</para>
<para>
This manual describes Yocto Project kernels by providing information
on history, organization, benefits, and use.
The manual consists of two sections:
<itemizedlist>
<listitem><para><emphasis>Concepts:</emphasis> Describes concepts behind a kernel.
You will understand how a kernel is organized and why it is organized in
the way it is. You will understand the benefits of a kernel's organization
and the mechanisms used to work with the kernel and how to apply it in your
design process.</para></listitem>
<listitem><para><emphasis>Using a Kernel:</emphasis> Describes best practices
and "how-to" information
that lets you put a kernel to practical use.
Some examples are how to examine changes in a branch and how to
save kernel modifications.</para></listitem>
</itemizedlist>
</para> </para>
<para> <para>
For more information on the Linux kernel, see the following links: Each Yocto Project release introduces a new set of linux-yocto kernel recipes,
<itemizedlist> tracking the latest upstream developments and introducing newly supported
<listitem><para>The Linux Foundation's guide for kernel development platforms. In addition to the new kernel recipes, the previous recipes are
process - <ulink url='http://www.linuxfoundation.org/content/1-guide-kernel-development-process'></ulink></para></listitem> refreshed and supported for at least one additional release. As they align,
<listitem><para>A fairly encompassing guide on Linux kernel development - these previous releases are updated to include the latest from the LTSI project.
<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> Besides these recipes, a linux-yocto-dev recipe is available for working with
</itemizedlist> the very latest in upstream Linux kernel development as well as meta-data
development.
</para> </para>
<para> <para>
For more discussion on the Yocto Project kernel, you can see these sections If you do not maintain your own kernel sources and need to make only minimal
in the Yocto Project Development Manual: changes to the sources, these recipes provide a vetted base upon which to layer
your changes. Doing so allows you to benefit from the continual kernel
integration and testing performed during development of the Yocto Project.
</para>
<para>
If, instead, you have a very specific Linux kernel source tree and are unable to
align with one of the many official linux-yocto releases, an alternative
exists by which you can use the Yocto Project Linux kernel tools with your own
sources.
</para>
<para>
The sections that follow provide instructions for completing specific Linux
kernel development tasks. They assume familiarity with working with bitbake
recipes and basic open-source development tools. Understanding these concepts
will facilitate the process of working with the kernel recipes. If you find you
need some additional background, please be sure to review and understand the
following documentation:
<itemizedlist> <itemizedlist>
<listitem><para> <listitem><para><emphasis>Yocto Project Quick Start</emphasis>
"<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-overview'>Kernel Overview</ulink>"</para></listitem>
<listitem><para>
"<ulink url='&YOCTO_DOCS_DEV_URL;#kernel-modification-workflow'>Kernel Modification Workflow</ulink>"
</para></listitem> </para></listitem>
<listitem><para> <listitem><para><emphasis>Yocto Project Development Manual</emphasis>
"<ulink url='&YOCTO_DOCS_DEV_URL;#patching-the-kernel'>Patching the Kernel</ulink>"</para></listitem> <itemizedlist>
<listitem><para> <listitem><para><emphasis>4.3 Modifying Temporary Source Code</emphasis>
"<ulink url='&YOCTO_DOCS_DEV_URL;#configuring-the-kernel'>Configuring the Kernel</ulink>"</para></listitem> </para></listitem>
<listitem><para><emphasis>5.1 Understanding and Creating Layers</emphasis>
</para></listitem>
<listitem><para><emphasis>4.1.2 Modifying the Kernel</emphasis>
(This section should be retired, as well as 5.6, 5.7 - with this document
providing the necessary information)</para></listitem>
</itemizedlist></para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
For general information on the Yocto Project, visit the website at Finally, while this document focuses on the manual creation of recipes, patches,
<ulink url='&YOCTO_HOME_URL;'></ulink>. and configuration files, the Yocto Project BSP tools are available to automate
this process with existing content and work well to create the initial framework
and boilerplate code. For details, refer to the Yocto Project BSP Developer's
Guide.
</para> </para>
</section> </section>
</chapter> </chapter>
<!-- <!--
vim: expandtab tw=80 ts=4 vim: expandtab tw=80 ts=4

View File

@ -1,6 +1,6 @@
/* /*
Generic XHTML / DocBook XHTML CSS Stylesheet. Generic XHTML / DocBook XHTML CSS Stylesheet.
Browser wrangling and typographic design by Browser wrangling and typographic design by
Oyvind Kolas / pippin@gimp.org Oyvind Kolas / pippin@gimp.org
@ -42,7 +42,7 @@
body { body {
font-family: Verdana, Sans, sans-serif; font-family: Verdana, Sans, sans-serif;
min-width: 640px; min-width: 640px;
width: 80%; width: 80%;
margin: 0em auto; margin: 0em auto;
@ -118,7 +118,7 @@ h6 {
background-color: transparent; background-color: transparent;
background-repeat: no-repeat; background-repeat: no-repeat;
padding-top: 256px; padding-top: 256px;
background-image: url("figures/kernel-title.png"); background-image: url("figures/kernel-dev-title.png");
background-position: left top; background-position: left top;
margin-top: -256px; margin-top: -256px;
padding-right: 50px; padding-right: 50px;
@ -243,7 +243,7 @@ div.legalnotice p.legalnotice-title {
p { p {
line-height: 1.5em; line-height: 1.5em;
margin-top: 0em; margin-top: 0em;
} }
dl { dl {
@ -297,7 +297,7 @@ p a[id] {
padding: 0px; padding: 0px;
display: inline; display: inline;
background-image: none; background-image: none;
} }
a { a {
text-decoration: underline; text-decoration: underline;
@ -338,10 +338,10 @@ div.table p.title b{
font-weight: normal; font-weight: normal;
} }
.mediaobject .caption, .mediaobject .caption,
.mediaobject .caption p { .mediaobject .caption p {
text-align: center; text-align: center;
font-size: 80%; font-size: 80%;
padding-top: 0.5em; padding-top: 0.5em;
padding-bottom: 0.5em; padding-bottom: 0.5em;
} }
@ -604,7 +604,7 @@ b.keycap,
.keycap { .keycap {
border: 1px solid; border: 1px solid;
} }
div.navheader, div.heading{ div.navheader, div.heading{
border-bottom: 1px solid; border-bottom: 1px solid;
@ -675,10 +675,10 @@ hr {
} }
.note { .note {
background-color: #f0f0f2; background-color: #f0f0f2;
} }
.glossary dl dt, .glossary dl dt,
.variablelist dl dt, .variablelist dl dt,
.variablelist dl dt span.term { .variablelist dl dt span.term {
color: #044; color: #044;
@ -778,10 +778,10 @@ div.article .titlepage .title
} }
*/ */
div.preface .titlepage .title, div.preface .titlepage .title,
div.colophon .title, div.colophon .title,
div.chapter .titlepage .title, div.chapter .titlepage .title,
div.article .titlepage .title div.article .titlepage .title
{ {
} }
@ -942,8 +942,8 @@ table {
.tip, .tip,
.note { .note {
background: #f0f0f2; background: #f0f0f2;
color: #333; color: #333;
padding: 20px; padding: 20px;
margin: 20px; margin: 20px;
} }
@ -954,12 +954,12 @@ table {
margin: 0em; margin: 0em;
font-size: 2em; font-size: 2em;
font-weight: bold; font-weight: bold;
color: #333; color: #333;
} }
.tip a, .tip a,
.note a { .note a {
color: #333; color: #333;
text-decoration: underline; text-decoration: underline;
} }
@ -976,4 +976,3 @@ table {
font-size:large; font-size:large;
color: #00557D; color: #00557D;
} }

View File

@ -59,6 +59,7 @@
<xi:include href="kernel-dev-intro.xml"/> <xi:include href="kernel-dev-intro.xml"/>
<!--
<xi:include href="kernel-dev-common.xml"/> <xi:include href="kernel-dev-common.xml"/>
<xi:include href="kernel-dev-advanced.xml"/> <xi:include href="kernel-dev-advanced.xml"/>
@ -66,6 +67,7 @@
<xi:include href="kernel-dev-examples.xml"/> <xi:include href="kernel-dev-examples.xml"/>
<xi:include href="kernel-dev-faq.xml"/> <xi:include href="kernel-dev-faq.xml"/>
-->
<!-- <index id='index'> <!-- <index id='index'>
<title>Index</title> <title>Index</title>