blob: 0f7370a96d7d85d177c661ac663ab8cb38228cf3 [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
Andrew Geissler5199d832021-09-24 16:47:35 -050010Welcome to the Yocto Project Development Tasks Manual. This manual
Andrew Geisslerc9f78652020-09-18 14:11:35 -050011provides relevant procedures necessary for developing in the Yocto
12Project environment (i.e. developing embedded Linux images and
Andrew Geissler5199d832021-09-24 16:47:35 -050013user-space applications that run on targeted devices). This manual groups
Andrew Geisslerc9f78652020-09-18 14:11:35 -050014related 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
Andrew Geissler5199d832021-09-24 16:47:35 -050019- Procedures that help you get going with the Yocto Project; for
Andrew Geisslerc9f78652020-09-18 14:11:35 -050020 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
Andrew Geissler5199d832021-09-24 16:47:35 -050027 images and applications using the Yocto Project, such as
28 creating a new layer, customizing an image, writing a new recipe,
Andrew Geisslerc9f78652020-09-18 14:11:35 -050029 and so forth.
30
31This manual does not provide the following:
32
Andrew Geissler5199d832021-09-24 16:47:35 -050033- 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
Andrew Geissler5199d832021-09-24 16:47:35 -050038- Reference or conceptual material: This type of material resides in an
39 appropriate reference manual. As an 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
Andrew Geissler5199d832021-09-24 16:47:35 -050042- Detailed public information not specific to the Yocto Project: For
43 example, exhaustive information on how to use the Git version
44 control system is better covered with Internet searches and official Git
45 documentation than through the Yocto Project documentation.
Andrew Geisslerc9f78652020-09-18 14:11:35 -050046
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.