| Andrew Geissler | f034379 | 2020-11-18 10:42:21 -0600 | [diff] [blame] | 1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK |
| Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 2 | |
| 3 | ****************************************** |
| 4 | The Yocto Project Development Tasks Manual |
| 5 | ****************************************** |
| 6 | |
| Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 7 | Welcome |
| 8 | ======= |
| 9 | |
| 10 | Welcome to the Yocto Project Development Tasks Manual! This manual |
| 11 | provides relevant procedures necessary for developing in the Yocto |
| 12 | Project environment (i.e. developing embedded Linux images and |
| 13 | user-space applications that run on targeted devices). The manual groups |
| 14 | related procedures into higher-level sections. Procedures can consist of |
| 15 | high-level steps or low-level steps depending on the topic. |
| 16 | |
| 17 | This 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 | |
| 31 | This manual does not provide the following: |
| 32 | |
| 33 | - Redundant Step-by-step Instructions: For example, the |
| Andrew Geissler | 09209ee | 2020-12-13 08:44:15 -0600 | [diff] [blame^] | 34 | :doc:`/sdk-manual/index` manual contains detailed |
| Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 35 | 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 Geissler | 09209ee | 2020-12-13 08:44:15 -0600 | [diff] [blame^] | 40 | documented in the :doc:`/ref-manual/index`. |
| Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 41 | |
| 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 | |
| 47 | Other Information |
| 48 | ================= |
| 49 | |
| 50 | Because this manual presents information for many different topics, |
| 51 | supplemental information is recommended for full comprehension. For |
| 52 | introductory information on the Yocto Project, see the |
| 53 | :yocto_home:`Yocto Project Website <>`. If you want to build an image with no |
| 54 | knowledge of Yocto Project as a way of quickly testing it out, see the |
| Andrew Geissler | 09209ee | 2020-12-13 08:44:15 -0600 | [diff] [blame^] | 55 | :doc:`/brief-yoctoprojectqs/index` document. |
| Andrew Geissler | c9f7865 | 2020-09-18 14:11:35 -0500 | [diff] [blame] | 56 | |
| 57 | For a comprehensive list of links and other documentation, see the |
| 58 | ":ref:`ref-manual/resources:links and related documentation`" |
| 59 | section in the Yocto Project Reference Manual. |