xref: /OK3568_Linux_fs/yocto/poky/documentation/dev-manual/intro.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun******************************************
4*4882a593SmuzhiyunThe Yocto Project Development Tasks Manual
5*4882a593Smuzhiyun******************************************
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunWelcome
8*4882a593Smuzhiyun=======
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunWelcome to the Yocto Project Development Tasks Manual. This manual
11*4882a593Smuzhiyunprovides relevant procedures necessary for developing in the Yocto
12*4882a593SmuzhiyunProject environment (i.e. developing embedded Linux images and
13*4882a593Smuzhiyunuser-space applications that run on targeted devices). This manual groups
14*4882a593Smuzhiyunrelated procedures into higher-level sections. Procedures can consist of
15*4882a593Smuzhiyunhigh-level steps or low-level steps depending on the topic.
16*4882a593Smuzhiyun
17*4882a593SmuzhiyunThis manual provides the following:
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun-  Procedures that help you get going with the Yocto Project; for
20*4882a593Smuzhiyun   example, procedures that show you how to set up a build host and work
21*4882a593Smuzhiyun   with the Yocto Project source repositories.
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun-  Procedures that show you how to submit changes to the Yocto Project.
24*4882a593Smuzhiyun   Changes can be improvements, new features, or bug fixes.
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun-  Procedures related to "everyday" tasks you perform while developing
27*4882a593Smuzhiyun   images and applications using the Yocto Project, such as
28*4882a593Smuzhiyun   creating a new layer, customizing an image, writing a new recipe,
29*4882a593Smuzhiyun   and so forth.
30*4882a593Smuzhiyun
31*4882a593SmuzhiyunThis manual does not provide the following:
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun-  Redundant step-by-step instructions: For example, the
34*4882a593Smuzhiyun   :doc:`/sdk-manual/index` manual contains detailed
35*4882a593Smuzhiyun   instructions on how to install an SDK, which is used to develop
36*4882a593Smuzhiyun   applications for target hardware.
37*4882a593Smuzhiyun
38*4882a593Smuzhiyun-  Reference or conceptual material: This type of material resides in an
39*4882a593Smuzhiyun   appropriate reference manual. As an example, system variables are
40*4882a593Smuzhiyun   documented in the :doc:`/ref-manual/index`.
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun-  Detailed public information not specific to the Yocto Project: For
43*4882a593Smuzhiyun   example, exhaustive information on how to use the Git version
44*4882a593Smuzhiyun   control system is better covered with Internet searches and official Git
45*4882a593Smuzhiyun   documentation than through the Yocto Project documentation.
46*4882a593Smuzhiyun
47*4882a593SmuzhiyunOther Information
48*4882a593Smuzhiyun=================
49*4882a593Smuzhiyun
50*4882a593SmuzhiyunBecause this manual presents information for many different topics,
51*4882a593Smuzhiyunsupplemental information is recommended for full comprehension. For
52*4882a593Smuzhiyunintroductory information on the Yocto Project, see the
53*4882a593Smuzhiyun:yocto_home:`Yocto Project Website <>`. If you want to build an image with no
54*4882a593Smuzhiyunknowledge of Yocto Project as a way of quickly testing it out, see the
55*4882a593Smuzhiyun:doc:`/brief-yoctoprojectqs/index` document.
56*4882a593Smuzhiyun
57*4882a593SmuzhiyunFor a comprehensive list of links and other documentation, see the
58*4882a593Smuzhiyun":ref:`ref-manual/resources:links and related documentation`"
59*4882a593Smuzhiyunsection in the Yocto Project Reference Manual.
60