blob: 23c848e870c4e5facb22b5cb59ed9aeb45b2aee8 [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 Development Tasks Manual
5******************************************
6
Andrew Geisslerc9f78652020-09-18 14:11:35 -05007Welcome
8=======
9
10Welcome to the Yocto Project Development Tasks Manual! This manual
11provides relevant procedures necessary for developing in the Yocto
12Project environment (i.e. developing embedded Linux images and
13user-space applications that run on targeted devices). The manual groups
14related procedures into higher-level sections. Procedures can consist of
15high-level steps or low-level steps depending on the topic.
16
17This manual provides the following:
18
19- Procedures that help you get going with the Yocto Project. For
20 example, procedures that show you how to set up a build host and work
21 with the Yocto Project source repositories.
22
23- Procedures that show you how to submit changes to the Yocto Project.
24 Changes can be improvements, new features, or bug fixes.
25
26- Procedures related to "everyday" tasks you perform while developing
27 images and applications using the Yocto Project. For example,
28 procedures to create a layer, customize an image, write a new recipe,
29 and so forth.
30
31This manual does not provide the following:
32
33- Redundant Step-by-step Instructions: For example, the
Andrew Geissler09209ee2020-12-13 08:44:15 -060034 :doc:`/sdk-manual/index` manual contains detailed
Andrew Geisslerc9f78652020-09-18 14:11:35 -050035 instructions on how to install an SDK, which is used to develop
36 applications for target hardware.
37
38- Reference or Conceptual Material: This type of material resides in an
39 appropriate reference manual. For example, system variables are
Andrew Geissler09209ee2020-12-13 08:44:15 -060040 documented in the :doc:`/ref-manual/index`.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050041
42- Detailed Public Information Not Specific to the Yocto Project: For
43 example, exhaustive information on how to use the Source Control
44 Manager Git is better covered with Internet searches and official Git
45 Documentation than through the Yocto Project documentation.
46
47Other Information
48=================
49
50Because this manual presents information for many different topics,
51supplemental information is recommended for full comprehension. For
52introductory information on the Yocto Project, see the
53:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
54knowledge of Yocto Project as a way of quickly testing it out, see the
Andrew Geissler09209ee2020-12-13 08:44:15 -060055:doc:`/brief-yoctoprojectqs/index` document.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050056
57For a comprehensive list of links and other documentation, see the
58":ref:`ref-manual/resources:links and related documentation`"
59section in the Yocto Project Reference Manual.