diff options
Diffstat (limited to 'documentation/ref-manual/introduction.xml')
-rw-r--r-- | documentation/ref-manual/introduction.xml | 173 |
1 files changed, 41 insertions, 132 deletions
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 @@ | |||
12 | Welcome to the Yocto Project Reference Manual. | 12 | Welcome to the Yocto Project Reference Manual. |
13 | This manual provides reference information for the current release | 13 | This manual provides reference information for the current release |
14 | of the Yocto Project. | 14 | of the Yocto Project. |
15 | The Yocto Project is an open-source collaboration project focused | 15 | This manual is best used after you have an understanding |
16 | on embedded Linux developers. | 16 | of the basics of the Yocto Project. |
17 | Amongst other things, the Yocto Project uses the OpenEmbedded build | 17 | The manual is neither meant to be read as a starting point to the |
18 | system, which is based on the Poky project, to construct complete | 18 | Yocto Project nor read from start to finish. |
19 | Linux images. | 19 | Use this manual to find concepts, variable definitions, class |
20 | descriptions, and so forth as needed during the course of using | ||
21 | the Yocto Project. | ||
20 | </para> | 22 | </para> |
21 | 23 | ||
22 | <para> | 24 | <para> |
23 | This reference manual is best used after you have an understanding | 25 | For introductory information on the Yocto Project, see the |
24 | of the basics of the Yocto Project. | 26 | <ulink url='&YOCTO_HOME_URL;/ecosystem/yocto-project-backgrounders'>Yocto Project Backgrounders</ulink> |
25 | The manual is not meant to be read as a starting point to the | 27 | on the |
26 | Yocto Project. | 28 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. |
27 | Use this manual to find concepts, variable definitions, class | ||
28 | descriptions, and so forth. | ||
29 | The manual augments working with the Yocto Project during application | ||
30 | and kernel development. | ||
31 | </para> | 29 | </para> |
32 | 30 | ||
33 | <para> | 31 | <para> |
34 | The Yocto Project Reference Manual does not provide "how-to", | 32 | You can find an introductory to using the Yocto Project by working |
35 | task-oriented information. | 33 | through the |
36 | You can find complete introductory and getting started information | ||
37 | on the Yocto Project by reading the | ||
38 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | 34 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. |
39 | You can find "how-to" information in the | 35 | You can find "how-to" information in the |
40 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. | 36 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. |
@@ -47,124 +43,37 @@ | |||
47 | </para> | 43 | </para> |
48 | </section> | 44 | </section> |
49 | 45 | ||
50 | <!-- | 46 | <section id='ref-yp-intro'> |
51 | <section id='intro-manualoverview'> | 47 | <title>Yocto Project Introduction</title> |
52 | <title>Documentation Overview</title> | 48 | |
53 | <para> | 49 | <para> |
54 | This reference manual consists of the following: | 50 | The Yocto Project is an open-source collaboration project whose |
55 | <itemizedlist> | 51 | focus is for developers of embedded Linux systems. |
56 | <listitem><para> | 52 | Among other things, the Yocto Project uses a build host based |
57 | <emphasis> | 53 | on the OpenEmbedded (OE) project, which uses the |
58 | <link linkend='usingpoky'>Using the Yocto Project</link>: | 54 | <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> |
59 | </emphasis> | 55 | tool, to construct complete Linux images. |
60 | Provides an overview of the components that make up the Yocto | 56 | The BitBake and OE components are combined together to form |
61 | Project followed by information about debugging images created | 57 | a reference build host, historically known as |
62 | in the Yocto Project. | 58 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> |
63 | </para></listitem> | 59 | (<emphasis>Pah</emphasis>-kee). |
64 | <listitem><para> | 60 | </para> |
65 | <emphasis> | 61 | |
66 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>: | 62 | <para> |
67 | </emphasis> | 63 | By default, using the Yocto Project creates a Poky distribution. |
68 | Provides a more detailed look at the Yocto Project development | 64 | However, you can create your own distribution by providing key |
69 | environment within the context of development. | 65 | <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>. |
70 | </para></listitem> | 66 | A good example is Angstrom, which has had a distribution |
71 | <listitem><para> | 67 | based on the Yocto Project since its inception. |
72 | <emphasis> | 68 | Other examples include commercial distributions like |
73 | <link linkend='technical-details'>Technical Details</link>: | 69 | <ulink url='https://www.yoctoproject.org/organization/wind-river-systems'>Wind River Linux</ulink>, |
74 | </emphasis> | 70 | <ulink url='https://www.yoctoproject.org/organization/mentor-graphics'>Mentor Embedded Linux</ulink>, |
75 | Describes fundamental Yocto Project components as well as an | 71 | <ulink url='https://www.yoctoproject.org/organization/enea-ab'>ENEA Linux</ulink> |
76 | explanation behind how the Yocto Project uses shared state | 72 | and <ulink url='https://www.yoctoproject.org/ecosystem/member-organizations'>others</ulink>. |
77 | (sstate) cache to speed build time. | 73 | See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-your-own-distribution'>Creating Your Own Distribution</ulink>" |
78 | </para></listitem> | 74 | section in the Yocto Project Development Manual for more information. |
79 | <listitem><para> | ||
80 | <emphasis> | ||
81 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>: | ||
82 | </emphasis> | ||
83 | Describes release-specific information that helps you move from | ||
84 | one Yocto Project Release to another. | ||
85 | </para></listitem> | ||
86 | <listitem><para> | ||
87 | <emphasis> | ||
88 | <link linkend='ref-structure'>Directory Structure</link>: | ||
89 | </emphasis> Describes the | ||
90 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | ||
91 | created either by unpacking a released Yocto Project tarball on | ||
92 | your host development system, or by cloning the upstream | ||
93 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> | ||
94 | Git repository. | ||
95 | </para></listitem> | ||
96 | <listitem><para> | ||
97 | <emphasis> | ||
98 | <link linkend='ref-classes'>Classes</link>: | ||
99 | </emphasis> | ||
100 | Describes the classes used in the Yocto Project. | ||
101 | </para></listitem> | ||
102 | <listitem><para> | ||
103 | <emphasis> | ||
104 | <link linkend='ref-tasks'>Tasks</link>: | ||
105 | </emphasis> | ||
106 | Describes the tasks defined by the OpenEmbedded build system. | ||
107 | </para></listitem> | ||
108 | <listitem><para> | ||
109 | <emphasis> | ||
110 | <link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>: | ||
111 | </emphasis> | ||
112 | Provides a quick reference for the <filename>devtool</filename> | ||
113 | command. | ||
114 | </para></listitem> | ||
115 | <listitem><para> | ||
116 | <emphasis> | ||
117 | <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>: | ||
118 | </emphasis> | ||
119 | Lists and describes QA warning and error messages. | ||
120 | </para></listitem> | ||
121 | <listitem><para> | ||
122 | <emphasis> | ||
123 | <link linkend='ref-images'>Images</link>: | ||
124 | </emphasis> | ||
125 | Describes the standard images that the Yocto Project supports. | ||
126 | </para></listitem> | ||
127 | <listitem><para> | ||
128 | <emphasis> | ||
129 | <link linkend='ref-features'>Features</link>: | ||
130 | </emphasis> | ||
131 | Describes mechanisms for creating distribution, machine, and | ||
132 | image features during the build process using the OpenEmbedded | ||
133 | build system. | ||
134 | </para></listitem> | ||
135 | <listitem><para> | ||
136 | <emphasis> | ||
137 | <link linkend='ref-variables-glos'>Variables Glossary</link>: | ||
138 | </emphasis> | ||
139 | Presents most variables used by the OpenEmbedded build system, | ||
140 | which uses BitBake. | ||
141 | Entries describe the function of the variable and how to | ||
142 | apply them. | ||
143 | </para></listitem> | ||
144 | <listitem><para> | ||
145 | <emphasis> | ||
146 | <link linkend='ref-varlocality'>Variable Context</link>: | ||
147 | </emphasis> | ||
148 | Provides variable locality or context. | ||
149 | </para></listitem> | ||
150 | <listitem><para> | ||
151 | <emphasis> | ||
152 | <link linkend='faq'>FAQ</link>: | ||
153 | </emphasis> | ||
154 | Provides answers for commonly asked questions in the Yocto | ||
155 | Project development environment. | ||
156 | </para></listitem> | ||
157 | <listitem><para> | ||
158 | <emphasis> | ||
159 | <link linkend='resources'>Contributions and Additional Information</link>: | ||
160 | </emphasis> | ||
161 | Provides an overview of methods by which you can | ||
162 | contribute to and participate in the Yocto Project. | ||
163 | </para></listitem> | ||
164 | </itemizedlist> | ||
165 | </para> | 75 | </para> |
166 | </section> | 76 | </section> |
167 | --> | ||
168 | 77 | ||
169 | <section id='intro-requirements'> | 78 | <section id='intro-requirements'> |
170 | <title>System Requirements</title> | 79 | <title>System Requirements</title> |