blob: 0e0bfed6e5af4d78a3e5271cd22444f824e46e02 [file] [log] [blame]
Brad Bishop316dfdd2018-06-25 12:45:53 -04001<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
Andrew Geissler475cb722020-07-10 16:00:51 -05004<!--SPDX-License-Identifier: CC-BY-2.0-UK-->
Brad Bishop316dfdd2018-06-25 12:45:53 -04005
6<chapter id='overview-manual-intro'>
7
8<title>The Yocto Project Overview and Concepts Manual</title>
9 <section id='overview-manual-welcome'>
10 <title>Welcome</title>
11
12 <para>
13 Welcome to the Yocto Project Overview and Concepts Manual!
14 This manual introduces the Yocto Project by providing concepts,
15 software overviews, best-known-methods (BKMs), and any other
16 high-level introductory information suitable for a new Yocto
17 Project user.
18 </para>
19
20 <para>
21 The following list describes what you can get from this manual:
22 <itemizedlist>
23 <listitem><para>
24 <emphasis><link linkend='overview-yp'>Introducing the Yocto Project</link>:</emphasis>
25 This chapter provides an introduction to the Yocto
26 Project.
27 You will learn about features and challenges of the
28 Yocto Project, the layer model, components and tools,
29 development methods, the
30 <ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink>
31 reference distribution, the OpenEmbedded build system
32 workflow, and some basic Yocto terms.
33 </para></listitem>
34 <listitem><para>
35 <emphasis><link linkend='overview-development-environment'>The Yocto Project Development Environment</link>:</emphasis>
36 This chapter helps you get started understanding the
37 Yocto Project development environment.
38 You will learn about open source, development hosts,
39 Yocto Project source repositories, workflows using Git
40 and the Yocto Project, a Git primer, and information
41 about licensing.
42 </para></listitem>
43 <listitem><para>
44 <emphasis><link linkend='overview-manual-concepts'>Yocto Project Concepts</link>:</emphasis>
45 This chapter presents various concepts regarding the
46 Yocto Project.
47 You can find conceptual information about components,
48 development, cross-toolchains, and so forth.
49 </para></listitem>
50 </itemizedlist>
51 </para>
52
53 <para>
54 This manual does not give you the following:
55 <itemizedlist>
56 <listitem><para>
57 <emphasis>Step-by-step Instructions for Development Tasks:</emphasis>
58 Instructional procedures reside in other manuals within
59 the Yocto Project documentation set.
60 For example, the
61 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>
62 provides examples on how to perform various development
63 tasks.
64 As another example, the
65 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
66 manual contains detailed instructions on how to install an
67 SDK, which is used to develop applications for target
68 hardware.
69 </para></listitem>
70 <listitem><para>
71 <emphasis>Reference Material:</emphasis>
72 This type of material resides in an appropriate reference
73 manual.
74 For example, system variables are documented in the
75 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
76 As another example, the
77 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>
78 contains reference information on BSPs.
79 </para></listitem>
80 <listitem><para>
81 <emphasis>Detailed Public Information Not Specific to the
82 Yocto Project:</emphasis>
83 For example, exhaustive information on how to use the
84 Source Control Manager Git is better covered with Internet
85 searches and official Git Documentation than through the
86 Yocto Project documentation.
87 </para></listitem>
88 </itemizedlist>
89 </para>
90 </section>
91
92 <section id='overview-manual-other-information'>
93 <title>Other Information</title>
94
95 <para>
96 Because this manual presents information for many different
97 topics, supplemental information is recommended for full
98 comprehension.
99 For additional introductory information on the Yocto Project, see
100 the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
101 If you want to build an image with no knowledge of Yocto Project
102 as a way of quickly testing it out, see the
103 <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>
104 document.
105 For a comprehensive list of links and other documentation, see the
106 "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>"
107 section in the Yocto Project Reference Manual.
108 </para>
109 </section>
110</chapter>
111<!--
112vim: expandtab tw=80 ts=4
113-->