diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-07-15 08:30:20 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-07-21 10:59:23 +0100 |
| commit | 387ed5934e851fc6f1d5758c62104d3a1fed1175 (patch) | |
| tree | f5ae8e08d6b108b50dc3747d3fd93398f503ff84 /documentation/dev-manual | |
| parent | 55d9b846ccbe85e9f6e89edfac5e3f2ac2d7b5c2 (diff) | |
| download | poky-387ed5934e851fc6f1d5758c62104d3a1fed1175.tar.gz | |
documentation/dev-manual/dev-manual-intro.xml: Initial content added.
New content from my working chapter. Previously this file was just a
copy of one of the adt-manual chapters.
(From yocto-docs rev: a50e69c19c23808d44ac4448b30394eedbbdbdab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 135 |
1 files changed, 103 insertions, 32 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 36387eeb6e..7562aa5fb2 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml | |||
| @@ -5,52 +5,123 @@ | |||
| 5 | 5 | ||
| 6 | <title>The Yocto Project Development Manual</title> | 6 | <title>The Yocto Project Development Manual</title> |
| 7 | 7 | ||
| 8 | <para> | ||
| 9 | WRITER NOTE: The goal of this manual is to provide an over-arching development guide for using the Yocto Project. | ||
| 10 | The intent is to give the reader the “big picture” around development. | ||
| 11 | Much of the information in the manual will be detailed in other manuals. | ||
| 12 | For example, detailed information on Git, repositories and open-source in general can be found in many places. | ||
| 13 | Another example is getting set up to use the Yocto Project, which our Yocto Project Quick Start covers. | ||
| 14 | However, this manual needs to at least address it. | ||
| 15 | One might ask “What becomes of the Poky Reference Manual?” | ||
| 16 | This manual, over time, needs to develop into a pure reference manual where all procedural information | ||
| 17 | eventually ends up in an appropriate guide. | ||
| 18 | A good example of information perfect for the Poky Reference Manual is the appendix on variable | ||
| 19 | definitions (glossary). | ||
| 20 | </para> | ||
| 21 | |||
| 8 | <section id='intro'> | 22 | <section id='intro'> |
| 9 | <title>Introduction</title> | 23 | <title>Introduction</title> |
| 24 | |||
| 10 | <para> | 25 | <para> |
| 11 | The Yocto Project presents the kernel as a fully patched, history-clean Git | 26 | Welcome to the Yocto Project Development Guide! |
| 12 | repository. | 27 | This guide provides an over-arching view of the development process within the Yocto Project. |
| 13 | The Git tree represents the selected features, board support, | 28 | This guide is just that – a guide. |
| 14 | and configurations extensively tested by Yocto Project. | 29 | It helps you understand the bigger picture involving development using the Yocto Project. |
| 15 | The Yocto Project kernel allows the end user to leverage community | ||
| 16 | best practices to seamlessly manage the development, build and debug cycles. | ||
| 17 | </para> | 30 | </para> |
| 31 | </section> | ||
| 32 | |||
| 33 | <section id='what-this-manual-provides'> | ||
| 34 | <title>What this Manual Provides</title> | ||
| 35 | |||
| 18 | <para> | 36 | <para> |
| 19 | This manual describes the Yocto Project kernel by providing information | 37 | The following list describes what you can get from this guide: |
| 20 | on its history, organization, benefits, and use. | ||
| 21 | The manual consists of two sections: | ||
| 22 | <itemizedlist> | 38 | <itemizedlist> |
| 23 | <listitem><para>Concepts - Describes concepts behind the kernel. | 39 | <listitem><para>A general idea of and references to information that lets you get set |
| 24 | You will understand how the kernel is organized and why it is organized in | 40 | up to develop using the Yocto Project.</para></listitem> |
| 25 | the way it is. You will understand the benefits of the kernel's organization | 41 | <listitem><para>Information to help developers that are new to the open source environment |
| 26 | and the mechanisms used to work with the kernel and how to apply it in your | 42 | and to the distributed revision control system Git, which the Yocto Project |
| 27 | design process.</para></listitem> | 43 | uses.</para></listitem> |
| 28 | <listitem><para>Using the Kernel - Describes best practices and "how-to" information | 44 | <listitem><para>An understanding of common end-to-end development models.</para></listitem> |
| 29 | that lets you put the kernel to practical use. Some examples are "How to Build a | 45 | <listitem><para>Development case overviews for both system development and user-space |
| 30 | Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel | 46 | applications.</para></listitem> |
| 31 | Modifications."</para></listitem> | 47 | <listitem><para>An overview and understanding of the emulation environment used with |
| 48 | the Yocto Project (QEMU).</para></listitem> | ||
| 49 | <listitem><para>A discussion of target-level analysis techniques, tools, tips, | ||
| 50 | and tricks.</para></listitem> | ||
| 51 | <listitem><para>Considerations for deploying your final product.</para></listitem> | ||
| 52 | <listitem><para>An understanding of basic kernel architecture and | ||
| 53 | concepts.</para></listitem> | ||
| 54 | <listitem><para>Information that will help you migrate an existing project to the | ||
| 55 | Yocto Project development environment.</para></listitem> | ||
| 32 | </itemizedlist> | 56 | </itemizedlist> |
| 33 | </para> | 57 | </para> |
| 58 | </section> | ||
| 59 | |||
| 60 | <section id='what-this-manual-does-not-provide'> | ||
| 61 | <title>What this Manual Does Not Provide</title> | ||
| 62 | |||
| 34 | <para> | 63 | <para> |
| 35 | For more information on the kernel, see the following links: | 64 | This manual will not give you the following: |
| 36 | <itemizedlist> | 65 | <itemizedlist> |
| 37 | <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> | 66 | <listitem><para>Step-by-step instructions when these instructions exist in other Yocto |
| 38 | <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> | 67 | Project documentation. |
| 39 | <listitem><para><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> | 68 | For example, The Application Development Toolkit (ADT) User’s Guide contains detailed |
| 69 | instruction on how to obtain and configure the Eclipse Yocto Plug-in.</para></listitem> | ||
| 70 | <listitem><para>Reference material. | ||
| 71 | This type of material resides in an appropriate reference manual. | ||
| 72 | For example, system variables are documented in the Poky Reference Manual.</para></listitem> | ||
| 73 | <listitem><para>Detailed public information that is not specific to the Yocto Project. | ||
| 74 | For example, exhaustive information on how to use Git is better covered in the public | ||
| 75 | domain than in this manual.</para></listitem> | ||
| 40 | </itemizedlist> | 76 | </itemizedlist> |
| 41 | <para> | ||
| 42 | You can find more information on Yocto Project by visiting the website at | ||
| 43 | <ulink url='http://www.yoctoproject.org'></ulink>. | ||
| 44 | </para> | ||
| 45 | </para> | 77 | </para> |
| 46 | </section> | 78 | </section> |
| 47 | 79 | ||
| 48 | 80 | <section id='other-information'> | |
| 49 | 81 | <title>Other Information</title> | |
| 50 | 82 | ||
| 51 | 83 | <para> | |
| 52 | 84 | Because this manual presents overview information for many different topics, you will | |
| 53 | 85 | need to supplement it with other information. | |
| 86 | The following list presents other sources of information you might find helpful: | ||
| 87 | <itemizedlist> | ||
| 88 | <listitem><para>The <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink> - The | ||
| 89 | home page for the Yocto Project | ||
| 90 | provides lots of information on the project as well as links to software | ||
| 91 | and documentation.</para></listitem> | ||
| 92 | <listitem><para>The <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'> | ||
| 93 | Yocto Project Quick Start</ulink> - This short document lets you get started | ||
| 94 | with the Yocto Project quickly and start building an image.</para></listitem> | ||
| 95 | <listitem><para>The <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'> | ||
| 96 | Yocto Project Reference Manual</ulink> - This manual is the complete reference | ||
| 97 | guide to the Yocto Project build component. | ||
| 98 | The manual also contains a reference chapter on Board Support Package (BSP) | ||
| 99 | layout.</para></listitem> | ||
| 100 | <listitem><para><ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html'> | ||
| 101 | Application Development Toolkit (ADT) User's Guide</ulink> - This guide provides | ||
| 102 | information that lets you get going with the ADT to develop projects using the | ||
| 103 | Yocto Project.</para></listitem> | ||
| 104 | <listitem><para><ulink url='http://www.yoctoproject.org/docs/1.1/bsp-guide/bsp-guide.html'> | ||
| 105 | Board Support Package (BSP) Developer's Guide</ulink> - This guide defines the | ||
| 106 | structure for BSP components. | ||
| 107 | Having a commonly understood structure encourages standardization.</para></listitem> | ||
| 108 | <listitem><para><ulink url='http://www.yoctoproject.org/docs/1.1/kernel-manual/kernel-manual.html'> | ||
| 109 | Yocto Project Kernel Architecture and Use Manual</ulink> - This manual | ||
| 110 | describes the architecture of the Yocto Project kernel and provides some work flow | ||
| 111 | examples.</para></listitem> | ||
| 112 | <listitem><para><ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> | ||
| 113 | Yocto Eclipse Plug-in</ulink> - A step-by-step instructional video that | ||
| 114 | demonstrates how an application developer uses Yocto Plug-in features within | ||
| 115 | the Eclipse IDE.</para></listitem> | ||
| 116 | <listitem><para><ulink url='http://wiki.yoctoproject.org/wiki/FAQ'>FAQ</ulink> - A | ||
| 117 | list of commonly asked questions and their answers.</para></listitem> | ||
| 118 | <listitem><para><ulink url='http://www.yoctoproject.org/download/yocto/yocto-project-1.0-release-notes-poky-5.0'> | ||
| 119 | Release Notes</ulink> - Features, updates and known issues for the current | ||
| 120 | release of the Yocto Project.</para></listitem> | ||
| 121 | </itemizedlist> | ||
| 122 | </para> | ||
| 123 | </section> | ||
| 124 | |||
| 54 | </chapter> | 125 | </chapter> |
| 55 | <!-- | 126 | <!-- |
| 56 | vim: expandtab tw=80 ts=4 | 127 | vim: expandtab tw=80 ts=4 |
