From 0f00914578740f4b4ca5216544d512e297610961 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 21 Jun 2017 15:07:41 -0700 Subject: documentation: Reorganized YP introduction material. This material was being replicated across the Quick Start, dev-manual, and ref-manual. I have created a single point in the ref-manual that collects the disparate information that existed. I deleted the entire section in the dev-manual since that book is converting to a procedure manual and the very front of the manual adequately mentions YP and provides pointers to where the user can get more information. The QS provides a more complete introduction of YP since it is a QS. (From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-start.xml | 48 ++-------------------- documentation/ref-manual/introduction.xml | 41 +++++++++++++----- .../yocto-project-qs/yocto-project-qs.xml | 8 +++- 3 files changed, 42 insertions(+), 55 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 31567319d4..7644362210 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -7,53 +7,13 @@ Getting Started with the Yocto Project - This chapter introduces the Yocto Project and gives you an idea of what you need to get started. - You can find enough information to set up your development host and build or use images for - hardware supported by the Yocto Project by reading the + This chapter provides procedures related to getting set up to use the + Yocto Project. + For a more front-to-end process that takes you from minimally preparing + a build host through building an image, see the Yocto Project Quick Start. - - The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides - some higher-level concepts you might want to consider. - - -
- Introducing the Yocto Project - - - The Yocto Project is an open-source collaboration project focused on embedded Linux development. - The project currently provides a build system that is - referred to as the - OpenEmbedded build system - in the Yocto Project documentation. - The Yocto Project provides various ancillary tools for the embedded developer - and also features the Sato reference User Interface, which is optimized for - stylus-driven, low-resolution screens. - - - - You can use the OpenEmbedded build system, which uses - BitBake, - to develop complete Linux - images and associated user-space applications for architectures based - on ARM, MIPS, PowerPC, x86 and x86-64. - - By default, using the Yocto Project creates a Poky distribution. - However, you can create your own distribution by providing key - Metadata. - See the "Creating Your Own Distribution" - section for more information. - - While the Yocto Project does not provide a strict testing framework, - it does provide or generate for you artifacts that let you perform target-level and - emulated testing and debugging. - Additionally, if you are an Eclipse - IDE user, you can install an Eclipse Yocto Plug-in to allow you to - develop within that familiar environment. - -
-
Getting Set Up diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 98b3ca828c..473afb53ad 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -49,20 +49,41 @@ The Yocto Project is an open-source collaboration project whose focus is for developers of embedded Linux systems. - Among other things, the Yocto Project uses a build host based - on the OpenEmbedded (OE) project, which uses the - BitBake - tool, to construct complete Linux images. - The BitBake and OE components are combined together to form - a reference build host, historically known as - Poky - (Pah-kee). + Among other things, the Yocto Project uses an + OpenEmbedded build system. + The build system, which is based on the OpenEmbedded (OE) project and + uses the + BitBake tool, constructs complete + Linux images for architectures based on ARM, MIPS, PowerPC, x86 and + x86-64. + + Historically, the OpenEmbedded build system, which is the + combination of BitBake and OE components, formed a reference + build host that was known as + "Poky" (Pah-kee). + The term "Poky", as used throughout the Yocto Project Documentation + set, can have different meanings. + + The Yocto Project provides various ancillary tools for the embedded + developer and also features the Sato reference User Interface, which + is optimized for stylus-driven, low-resolution screens. + + + + While the Yocto Project does not provide a strict testing framework, + it does provide or generate for you artifacts that let you perform + target-level and emulated testing and debugging. + Additionally, if you are an + Eclipse IDE user, you can + install an Eclipse Yocto Plug-in to allow you to develop within that + familiar environment. - By default, using the Yocto Project creates a Poky distribution. + By default, using the Yocto Project to build an image creates a Poky + distribution. However, you can create your own distribution by providing key - Metadata. + 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 diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 197ddd53cb..285d326334 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml @@ -64,7 +64,7 @@ tool, to construct complete Linux images. The BitBake and OE components are combined together to form a reference build host, historically known as - Poky + Poky (Pah-kee). @@ -101,6 +101,12 @@ For more detailed information on the Yocto Project, you can reference these resources: + + Yocto Project Backgrounders: + The + Yocto Project Backgrounder + provides introductory information on the Yocto Project. + Website: The -- cgit v1.2.3-54-g00ecf