diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index 945c83e2c3..8c94009335 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -10,96 +10,67 @@ Welcome to the Yocto Project Development Manual! - This manual provides information on how to use the Yocto Project to - develop embedded Linux images and user-space applications that - run on targeted devices. - The manual provides an overview of image, kernel, and - user-space application development using the Yocto Project. - Because much of the information in this manual is general, it - contains many references to other sources where you can find more - detail. - For example, you can find detailed information on Git, repositories, - and open source in general in many places on the Internet. - Another example specific to the Yocto Project is how to quickly - set up your host development system and build an image, which you - find in the - Yocto Project Quick Start. + This manual provides relevant procedures necessary for developing + in the Yocto Project environment (i.e. developing embedded Linux + images and user-space applications that run on targeted devices). + The manual groups related procedures into higher-level sections. + Procedures can consist of high-level steps or low-level steps + depending on the topic. + You can find conceptual information related to a procedure by + following appropriate links to the Yocto Project Reference + Manual. - - The Yocto Project Development Manual does, however, provide - guidance and examples on how to change the kernel source code, - reconfigure the kernel, and develop an application using - devtool. - - - - By default, using the Yocto Project creates a Poky distribution. - However, you can create your own distribution by providing key - Metadata. - A good example is Angstrom, which has had a distribution - based on the Yocto Project since its inception. - Other examples include commercial distributions like - Wind River Linux, - Mentor Embedded Linux, - ENEA Linux - and others. - See the "Creating Your Own Distribution" - section for more information. - - - -
- What This Manual Provides - The following list describes what you can get from this manual: - Information that lets you get set - up to develop using the Yocto Project. - Information to help developers who are new to - the open source environment and to the distributed revision - control system Git, which the Yocto Project uses. + + Setup Procedures: + Procedures that show you how to set + up a Yocto Project Development environment and how + to accomplish the change workflow through logging + defects and submitting changes. - An understanding of common end-to-end - development models and tasks. - Information about common development tasks - generally used during image development for - embedded devices. + + Emulation Procedures: + Procedures that show you how to use the + Yocto Project integrated QuickEMUlator (QEMU), which lets + you simulate running on hardware an image you have built + using the OpenEmbedded build system. - Information on using the Yocto Project - integration of the QuickEMUlator (QEMU), which lets you - simulate running on hardware an image you have built using - the OpenEmbedded build system. + + Common Procedures: + Procedures related to "everyday" tasks you perform while + developing images and applications using the Yocto + Project. - Many references to other sources of related - information. -
- -
- What this Manual Does Not Provide This manual will not give you the following: - Step-by-step instructions when those instructions exist in other Yocto - Project documentation: + + Redundant Step-by-step Instructions: For example, the Yocto Project Software Development Kit (SDK) Developer's Guide - manual contains detailed instructions on how to install an + contains detailed instructions on how to install an SDK, which is used to develop applications for target hardware. - Reference material: + + Reference or Conceptual Material: This type of material resides in an appropriate reference manual. For example, system variables are documented in the Yocto Project Reference Manual. - Detailed public information that is not specific to the Yocto Project: - For example, exhaustive information on how to use Git is covered better through the - Internet than in this manual. + + Detailed Public Information Not Specific to the + Yocto Project: + For example, exhaustive information on how to use the + Source Control Manager Git is better covered with Internet + searches and official Git Documentation than through the + Yocto Project documentation. @@ -112,10 +83,22 @@ Because this manual presents information for many different topics, supplemental information is recommended for full comprehension. - See the + For introductory information on the Yocto Project, see the + Yocto Project Backgrounders + on the + Yocto Project Website. + You can find an introductory to using the Yocto Project by working + through the + Yocto Project Quick Start. + + + + For a comprehensive list of links and other documentation, see the "Links and Related Documentation" - section in the Yocto Project Reference Manual for helpful - sources. + section in the Yocto Project Reference Manual. + + +
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index aab0eaa9e0..98b3ca828c 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -12,29 +12,25 @@ Welcome to the Yocto Project Reference Manual. This manual provides reference information for the current release of the Yocto Project. - The Yocto Project is an open-source collaboration project focused - on embedded Linux developers. - Amongst other things, the Yocto Project uses the OpenEmbedded build - system, which is based on the Poky project, to construct complete - Linux images. - - - - This reference manual is best used after you have an understanding + This manual is best used after you have an understanding of the basics of the Yocto Project. - The manual is not meant to be read as a starting point to the - Yocto Project. + The manual is neither meant to be read as a starting point to the + Yocto Project nor read from start to finish. Use this manual to find concepts, variable definitions, class - descriptions, and so forth. - The manual augments working with the Yocto Project during application - and kernel development. + descriptions, and so forth as needed during the course of using + the Yocto Project. - The Yocto Project Reference Manual does not provide "how-to", - task-oriented information. - You can find complete introductory and getting started information - on the Yocto Project by reading the + For introductory information on the Yocto Project, see the + Yocto Project Backgrounders + on the + Yocto Project Website. + + + + You can find an introductory to using the Yocto Project by working + through the Yocto Project Quick Start. You can find "how-to" information in the Yocto Project Development Manual. @@ -47,124 +43,37 @@ -
System Requirements