From 387ed5934e851fc6f1d5758c62104d3a1fed1175 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 15 Jul 2011 08:30:20 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-intro.xml | 135 ++++++++++++++++++++------ 1 file changed, 103 insertions(+), 32 deletions(-) (limited to 'documentation') 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 @@ The Yocto Project Development Manual + + WRITER NOTE: The goal of this manual is to provide an over-arching development guide for using the Yocto Project. + The intent is to give the reader the “big picture” around development. + Much of the information in the manual will be detailed in other manuals. + For example, detailed information on Git, repositories and open-source in general can be found in many places. + Another example is getting set up to use the Yocto Project, which our Yocto Project Quick Start covers. + However, this manual needs to at least address it. + One might ask “What becomes of the Poky Reference Manual?” + This manual, over time, needs to develop into a pure reference manual where all procedural information + eventually ends up in an appropriate guide. + A good example of information perfect for the Poky Reference Manual is the appendix on variable + definitions (glossary). + +
Introduction + - 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 Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. + Welcome to the Yocto Project Development Guide! + This guide provides an over-arching view of the development process within the Yocto Project. + This guide is just that – a guide. + It helps you understand the bigger picture involving development using the Yocto Project. +
+ +
+ What this Manual Provides + - This manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: + The following list describes what you can get from this guide: - Concepts - 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. - Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications." + A general idea of and references to information that lets you get set + up to develop using the Yocto Project. + Information to help developers that are new to the open source environment + and to the distributed revision control system Git, which the Yocto Project + uses. + An understanding of common end-to-end development models. + Development case overviews for both system development and user-space + applications. + An overview and understanding of the emulation environment used with + the Yocto Project (QEMU). + A discussion of target-level analysis techniques, tools, tips, + and tricks. + Considerations for deploying your final product. + An understanding of basic kernel architecture and + concepts. + Information that will help you migrate an existing project to the + Yocto Project development environment. +
+ +
+ What this Manual Does Not Provide + - For more information on the kernel, see the following links: + This manual will not give you the following: - - - + Step-by-step instructions when these instructions exist in other Yocto + Project documentation. + For example, The Application Development Toolkit (ADT) User’s Guide contains detailed + instruction on how to obtain and configure the Eclipse Yocto Plug-in. + Reference material. + This type of material resides in an appropriate reference manual. + For example, system variables are documented in the Poky Reference Manual. + Detailed public information that is not specific to the Yocto Project. + For example, exhaustive information on how to use Git is better covered in the public + domain than in this manual. - - You can find more information on Yocto Project by visiting the website at - . -
- - - - - - +
+ Other Information + + + Because this manual presents overview information for many different topics, you will + need to supplement it with other information. + The following list presents other sources of information you might find helpful: + + The Yocto Project Website - The + home page for the Yocto Project + provides lots of information on the project as well as links to software + and documentation. + The + Yocto Project Quick Start - This short document lets you get started + with the Yocto Project quickly and start building an image. + The + Yocto Project Reference Manual - This manual is the complete reference + guide to the Yocto Project build component. + The manual also contains a reference chapter on Board Support Package (BSP) + layout. + + Application Development Toolkit (ADT) User's Guide - This guide provides + information that lets you get going with the ADT to develop projects using the + Yocto Project. + + Board Support Package (BSP) Developer's Guide - This guide defines the + structure for BSP components. + Having a commonly understood structure encourages standardization. + + Yocto Project Kernel Architecture and Use Manual - This manual + describes the architecture of the Yocto Project kernel and provides some work flow + examples. + + Yocto Eclipse Plug-in - A step-by-step instructional video that + demonstrates how an application developer uses Yocto Plug-in features within + the Eclipse IDE. + FAQ - A + list of commonly asked questions and their answers. + + Release Notes - Features, updates and known issues for the current + release of the Yocto Project. + + +
+