diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-21 15:07:41 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-07-12 00:28:13 +0100 |
| commit | 0f00914578740f4b4ca5216544d512e297610961 (patch) | |
| tree | ebf6d60b6a6d96acc96675a1e3977364759018a0 /documentation | |
| parent | d6c3c579d0702958aefe6aa4e1ed60e5b0f24f46 (diff) | |
| download | poky-0f00914578740f4b4ca5216544d512e297610961.tar.gz | |
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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 48 | ||||
| -rw-r--r-- | documentation/ref-manual/introduction.xml | 41 | ||||
| -rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 8 |
3 files changed, 42 insertions, 55 deletions
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 @@ | |||
| 7 | <title>Getting Started with the Yocto Project</title> | 7 | <title>Getting Started with the Yocto Project</title> |
| 8 | 8 | ||
| 9 | <para> | 9 | <para> |
| 10 | This chapter introduces the Yocto Project and gives you an idea of what you need to get started. | 10 | This chapter provides procedures related to getting set up to use the |
| 11 | You can find enough information to set up your development host and build or use images for | 11 | Yocto Project. |
| 12 | hardware supported by the Yocto Project by reading the | 12 | For a more front-to-end process that takes you from minimally preparing |
| 13 | a build host through building an image, see the | ||
| 13 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 14 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. |
| 14 | </para> | 15 | </para> |
| 15 | 16 | ||
| 16 | <para> | ||
| 17 | The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides | ||
| 18 | some higher-level concepts you might want to consider. | ||
| 19 | </para> | ||
| 20 | |||
| 21 | <section id='introducing-the-yocto-project'> | ||
| 22 | <title>Introducing the Yocto Project</title> | ||
| 23 | |||
| 24 | <para> | ||
| 25 | The Yocto Project is an open-source collaboration project focused on embedded Linux development. | ||
| 26 | The project currently provides a build system that is | ||
| 27 | referred to as the | ||
| 28 | <ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded build system</ulink> | ||
| 29 | in the Yocto Project documentation. | ||
| 30 | The Yocto Project provides various ancillary tools for the embedded developer | ||
| 31 | and also features the Sato reference User Interface, which is optimized for | ||
| 32 | stylus-driven, low-resolution screens. | ||
| 33 | </para> | ||
| 34 | |||
| 35 | <para> | ||
| 36 | You can use the OpenEmbedded build system, which uses | ||
| 37 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink>, | ||
| 38 | to develop complete Linux | ||
| 39 | images and associated user-space applications for architectures based | ||
| 40 | on ARM, MIPS, PowerPC, x86 and x86-64. | ||
| 41 | <note> | ||
| 42 | By default, using the Yocto Project creates a Poky distribution. | ||
| 43 | However, you can create your own distribution by providing key | ||
| 44 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>. | ||
| 45 | See the "<link linkend='creating-your-own-distribution'>Creating Your Own Distribution</link>" | ||
| 46 | section for more information. | ||
| 47 | </note> | ||
| 48 | While the Yocto Project does not provide a strict testing framework, | ||
| 49 | it does provide or generate for you artifacts that let you perform target-level and | ||
| 50 | emulated testing and debugging. | ||
| 51 | Additionally, if you are an <trademark class='trade'>Eclipse</trademark> | ||
| 52 | IDE user, you can install an Eclipse Yocto Plug-in to allow you to | ||
| 53 | develop within that familiar environment. | ||
| 54 | </para> | ||
| 55 | </section> | ||
| 56 | |||
| 57 | <section id='getting-setup'> | 17 | <section id='getting-setup'> |
| 58 | <title>Getting Set Up</title> | 18 | <title>Getting Set Up</title> |
| 59 | 19 | ||
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 @@ | |||
| 49 | <para> | 49 | <para> |
| 50 | The Yocto Project is an open-source collaboration project whose | 50 | The Yocto Project is an open-source collaboration project whose |
| 51 | focus is for developers of embedded Linux systems. | 51 | focus is for developers of embedded Linux systems. |
| 52 | Among other things, the Yocto Project uses a build host based | 52 | Among other things, the Yocto Project uses an |
| 53 | on the OpenEmbedded (OE) project, which uses the | 53 | <link linkend='build-system-term'>OpenEmbedded build system</link>. |
| 54 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> | 54 | The build system, which is based on the OpenEmbedded (OE) project and |
| 55 | tool, to construct complete Linux images. | 55 | uses the |
| 56 | The BitBake and OE components are combined together to form | 56 | <link linkend='bitbake-term'>BitBake</link> tool, constructs complete |
| 57 | a reference build host, historically known as | 57 | Linux images for architectures based on ARM, MIPS, PowerPC, x86 and |
| 58 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> | 58 | x86-64. |
| 59 | (<emphasis>Pah</emphasis>-kee). | 59 | <note> |
| 60 | Historically, the OpenEmbedded build system, which is the | ||
| 61 | combination of BitBake and OE components, formed a reference | ||
| 62 | build host that was known as | ||
| 63 | "<link linkend='poky'>Poky</link>" (<emphasis>Pah</emphasis>-kee). | ||
| 64 | The term "Poky", as used throughout the Yocto Project Documentation | ||
| 65 | set, can have different meanings. | ||
| 66 | </note> | ||
| 67 | The Yocto Project provides various ancillary tools for the embedded | ||
| 68 | developer and also features the Sato reference User Interface, which | ||
| 69 | is optimized for stylus-driven, low-resolution screens. | ||
| 70 | </para> | ||
| 71 | |||
| 72 | <para> | ||
| 73 | While the Yocto Project does not provide a strict testing framework, | ||
| 74 | it does provide or generate for you artifacts that let you perform | ||
| 75 | target-level and emulated testing and debugging. | ||
| 76 | Additionally, if you are an | ||
| 77 | <trademark class='trade'>Eclipse</trademark> IDE user, you can | ||
| 78 | install an Eclipse Yocto Plug-in to allow you to develop within that | ||
| 79 | familiar environment. | ||
| 60 | </para> | 80 | </para> |
| 61 | 81 | ||
| 62 | <para> | 82 | <para> |
| 63 | By default, using the Yocto Project creates a Poky distribution. | 83 | By default, using the Yocto Project to build an image creates a Poky |
| 84 | distribution. | ||
| 64 | However, you can create your own distribution by providing key | 85 | However, you can create your own distribution by providing key |
| 65 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>. | 86 | <link link='metadata'>Metadata</link>. |
| 66 | A good example is Angstrom, which has had a distribution | 87 | A good example is Angstrom, which has had a distribution |
| 67 | based on the Yocto Project since its inception. | 88 | based on the Yocto Project since its inception. |
| 68 | Other examples include commercial distributions like | 89 | 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 @@ | |||
| 64 | tool, to construct complete Linux images. | 64 | tool, to construct complete Linux images. |
| 65 | The BitBake and OE components are combined together to form | 65 | The BitBake and OE components are combined together to form |
| 66 | a reference build host, historically known as | 66 | a reference build host, historically known as |
| 67 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> | 67 | <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink> |
| 68 | (<emphasis>Pah</emphasis>-kee). | 68 | (<emphasis>Pah</emphasis>-kee). |
| 69 | </para> | 69 | </para> |
| 70 | 70 | ||
| @@ -102,6 +102,12 @@ | |||
| 102 | reference these resources: | 102 | reference these resources: |
| 103 | <itemizedlist> | 103 | <itemizedlist> |
| 104 | <listitem><para> | 104 | <listitem><para> |
| 105 | <emphasis>Yocto Project Backgrounders:</emphasis> | ||
| 106 | The | ||
| 107 | <ulink url='&YOCTO_HOME_URL;/ecosystem/yocto-project-backgrounders'>Yocto Project Backgrounder</ulink> | ||
| 108 | provides introductory information on the Yocto Project. | ||
| 109 | </para></listitem> | ||
| 110 | <listitem><para> | ||
| 105 | <emphasis>Website:</emphasis> | 111 | <emphasis>Website:</emphasis> |
| 106 | The | 112 | The |
| 107 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> | 113 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> |
