diff options
Diffstat (limited to 'documentation/dev-manual/dev-manual-intro.rst')
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.rst | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst new file mode 100644 index 0000000000..3225c6ca45 --- /dev/null +++ b/documentation/dev-manual/dev-manual-intro.rst | |||
@@ -0,0 +1,61 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-2.0-UK | ||
2 | |||
3 | ****************************************** | ||
4 | The Yocto Project Development Tasks Manual | ||
5 | ****************************************** | ||
6 | |||
7 | .. _dev-welcome: | ||
8 | |||
9 | Welcome | ||
10 | ======= | ||
11 | |||
12 | Welcome to the Yocto Project Development Tasks Manual! This manual | ||
13 | provides relevant procedures necessary for developing in the Yocto | ||
14 | Project environment (i.e. developing embedded Linux images and | ||
15 | user-space applications that run on targeted devices). The manual groups | ||
16 | related procedures into higher-level sections. Procedures can consist of | ||
17 | high-level steps or low-level steps depending on the topic. | ||
18 | |||
19 | This manual provides the following: | ||
20 | |||
21 | - Procedures that help you get going with the Yocto Project. For | ||
22 | example, procedures that show you how to set up a build host and work | ||
23 | with the Yocto Project source repositories. | ||
24 | |||
25 | - Procedures that show you how to submit changes to the Yocto Project. | ||
26 | Changes can be improvements, new features, or bug fixes. | ||
27 | |||
28 | - Procedures related to "everyday" tasks you perform while developing | ||
29 | images and applications using the Yocto Project. For example, | ||
30 | procedures to create a layer, customize an image, write a new recipe, | ||
31 | and so forth. | ||
32 | |||
33 | This manual does not provide the following: | ||
34 | |||
35 | - Redundant Step-by-step Instructions: For example, the | ||
36 | :doc:`../sdk-manual/sdk-manual` manual contains detailed | ||
37 | instructions on how to install an SDK, which is used to develop | ||
38 | applications for target hardware. | ||
39 | |||
40 | - Reference or Conceptual Material: This type of material resides in an | ||
41 | appropriate reference manual. For example, system variables are | ||
42 | documented in the :doc`../ref-manual/ref-manual`. | ||
43 | |||
44 | - Detailed Public Information Not Specific to the Yocto Project: For | ||
45 | example, exhaustive information on how to use the Source Control | ||
46 | Manager Git is better covered with Internet searches and official Git | ||
47 | Documentation than through the Yocto Project documentation. | ||
48 | |||
49 | Other Information | ||
50 | ================= | ||
51 | |||
52 | Because this manual presents information for many different topics, | ||
53 | supplemental information is recommended for full comprehension. For | ||
54 | introductory information on the Yocto Project, see the | ||
55 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no | ||
56 | knowledge of Yocto Project as a way of quickly testing it out, see the | ||
57 | :doc:`../brief-yoctoprojectqs/brief-yoctoprojectqs` document. | ||
58 | |||
59 | For a comprehensive list of links and other documentation, see the | ||
60 | ":ref:`ref-manual/resources:links and related documentation`" | ||
61 | section in the Yocto Project Reference Manual. | ||