blob: a8091771f4d10618ec1b590373ac85b0beab4136 [file] [log] [blame]
Andrew Geisslerf0343792020-11-18 10:42:21 -06001.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
Andrew Geisslerc9f78652020-09-18 14:11:35 -05002
3**********************************************
4The Yocto Project Overview and Concepts Manual
5**********************************************
6
Andrew Geisslerc9f78652020-09-18 14:11:35 -05007Welcome
8=======
9
10Welcome to the Yocto Project Overview and Concepts Manual! This manual
11introduces the Yocto Project by providing concepts, software overviews,
12best-known-methods (BKMs), and any other high-level introductory
13information suitable for a new Yocto Project user.
14
William A. Kennington IIIac69b482021-06-02 12:28:27 -070015Here is what you can get from this manual:
Andrew Geisslerc9f78652020-09-18 14:11:35 -050016
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050017- :ref:`overview-manual/yp-intro:introducing the yocto project`\ *:*
18 This chapter provides an introduction to the Yocto Project. You will learn
19 about features and challenges of the Yocto Project, the layer model,
Andrew Geisslerc9f78652020-09-18 14:11:35 -050020 components and tools, development methods, the
21 :term:`Poky` reference distribution, the
22 OpenEmbedded build system workflow, and some basic Yocto terms.
23
Andrew Geissler3b8a17c2021-04-15 15:55:55 -050024- :ref:`overview-manual/development-environment:the yocto project development environment`\ *:*
25 This chapter helps you get started understanding the Yocto Project
26 development environment. You will learn about open source, development hosts,
Andrew Geisslerc9f78652020-09-18 14:11:35 -050027 Yocto Project source repositories, workflows using Git and the Yocto
28 Project, a Git primer, and information about licensing.
29
Andrew Geissler09209ee2020-12-13 08:44:15 -060030- :doc:`/overview-manual/concepts` *:* This
Andrew Geisslerc9f78652020-09-18 14:11:35 -050031 chapter presents various concepts regarding the Yocto Project. You
32 can find conceptual information about components, development,
33 cross-toolchains, and so forth.
34
35This manual does not give you the following:
36
37- *Step-by-step Instructions for Development Tasks:* Instructional
38 procedures reside in other manuals within the Yocto Project
Andrew Geissler09209ee2020-12-13 08:44:15 -060039 documentation set. For example, the :doc:`/dev-manual/index`
Andrew Geisslerc9f78652020-09-18 14:11:35 -050040 provides examples on how to perform
41 various development tasks. As another example, the
Andrew Geissler09209ee2020-12-13 08:44:15 -060042 :doc:`/sdk-manual/index` manual contains detailed
Andrew Geisslerc9f78652020-09-18 14:11:35 -050043 instructions on how to install an SDK, which is used to develop
44 applications for target hardware.
45
46- *Reference Material:* This type of material resides in an appropriate
47 reference manual. For example, system variables are documented in the
Andrew Geissler09209ee2020-12-13 08:44:15 -060048 :doc:`/ref-manual/index`. As another
49 example, the :doc:`/bsp-guide/index` contains reference information on
Andrew Geisslerc9f78652020-09-18 14:11:35 -050050 BSPs.
51
52- *Detailed Public Information Not Specific to the Yocto Project:* For
53 example, exhaustive information on how to use the Source Control
54 Manager Git is better covered with Internet searches and official Git
55 Documentation than through the Yocto Project documentation.
56
Andrew Geisslerc9f78652020-09-18 14:11:35 -050057Other Information
58=================
59
60Because this manual presents information for many different topics,
61supplemental information is recommended for full comprehension. For
62additional introductory information on the Yocto Project, see the
63:yocto_home:`Yocto Project Website <>`. If you want to build an image
64with no knowledge of Yocto Project as a way of quickly testing it out,
Andrew Geissler09209ee2020-12-13 08:44:15 -060065see the :doc:`/brief-yoctoprojectqs/index` document.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050066For a comprehensive list of links and other documentation, see the
67":ref:`Links and Related
68Documentation <resources-links-and-related-documentation>`"
69section in the Yocto Project Reference Manual.