summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-manual/kernel-doc-intro.xml
blob: c3fde6c731e5df6b5398e582a5a470b7a034d371 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<chapter id='kernel-doc-intro'>

<title>Yocto Project Kernel Architecture and Use Manual</title>

<section id='book-intro'>
    <title>Introduction</title>
    <para>
        The Yocto Project presents the kernel as a fully patched, history-clean Git
        repository. 
        The Git tree represents the selected features, board support,
        and configurations extensively tested by the Yocto Project. 
        The Yocto Project kernel allows the end user to leverage community
        best practices to seamlessly manage the development, build and debug cycles.
    </para>
    <para>
        This manual describes the Yocto Project kernel by providing information
        on its history, organization, benefits, and use.
        The manual consists of two sections:
        <itemizedlist>
            <listitem><para><emphasis>Concepts:</emphasis> Describes concepts behind the kernel.
                You will understand how the kernel is organized and why it is organized in 
                the way it is.  You will understand the benefits of the 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 the Kernel:</emphasis> Describes best practices 
                and "how-to" information
                that lets you put the 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>
        For more information on the Linux kernel, see the following links:
        <itemizedlist>
            <listitem><para>The Linux Foundation's guide for kernel development
                process - <ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem>
<!--            <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> -->
            <listitem><para>A fairly emcompassing guide on Linux kernel development - 
                <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> 
        </itemizedlist>
    </para>

    <para>
        For more discussion on the Yocto Project kernel, you can see these sections
        in <ulink url='&YOCTO_DOCS_DEV_URL;'>The Yocto Project Development Manual</ulink>:
        <itemizedlist>
            <listitem><para>
                "<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>
            <listitem><para> 
                "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-kernel-appendix'>Kernel Modification Example</ulink>"</para></listitem>
        </itemizedlist>
    </para>

    <para> 
        For general information on the Yocto Project, visit the website at
        <ulink url='&YOCTO_HOME_URL;'></ulink>.
    </para>
</section>







</chapter>
<!--
vim: expandtab tw=80 ts=4
-->