rjw | 1f88458 | 2022-01-06 17:20:42 +0800 | [diff] [blame^] | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
| 4 | |
| 5 | <chapter id='dev-manual-intro'> |
| 6 | |
| 7 | <title>The Yocto Project Development Tasks Manual</title> |
| 8 | <section id='dev-welcome'> |
| 9 | <title>Welcome</title> |
| 10 | |
| 11 | <para> |
| 12 | Welcome to the Yocto Project Development Tasks Manual! |
| 13 | This manual provides relevant procedures necessary for developing |
| 14 | in the Yocto Project environment (i.e. developing embedded Linux |
| 15 | images and user-space applications that run on targeted devices). |
| 16 | The manual groups related procedures into higher-level sections. |
| 17 | Procedures can consist of high-level steps or low-level steps |
| 18 | depending on the topic. |
| 19 | </para> |
| 20 | |
| 21 | <para> |
| 22 | This manual provides the following: |
| 23 | <itemizedlist> |
| 24 | <listitem><para> |
| 25 | Procedures that help you get going with the Yocto Project. |
| 26 | For example, procedures that show you how to set up |
| 27 | a build host and work with the Yocto Project |
| 28 | source repositories. |
| 29 | </para></listitem> |
| 30 | <listitem><para> |
| 31 | Procedures that show you how to submit changes to the |
| 32 | Yocto Project. |
| 33 | Changes can be improvements, new features, or bug |
| 34 | fixes. |
| 35 | </para></listitem> |
| 36 | <listitem><para> |
| 37 | Procedures related to "everyday" tasks you perform while |
| 38 | developing images and applications using the Yocto |
| 39 | Project. |
| 40 | For example, procedures to create a layer, customize an |
| 41 | image, write a new recipe, and so forth. |
| 42 | </para></listitem> |
| 43 | </itemizedlist> |
| 44 | </para> |
| 45 | |
| 46 | <para> |
| 47 | This manual does not provide the following: |
| 48 | <itemizedlist> |
| 49 | <listitem><para> |
| 50 | Redundant Step-by-step Instructions: |
| 51 | For example, the |
| 52 | <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> |
| 53 | manual contains detailed instructions on how to install an |
| 54 | SDK, which is used to develop applications for target |
| 55 | hardware. |
| 56 | </para></listitem> |
| 57 | <listitem><para> |
| 58 | Reference or Conceptual Material: |
| 59 | This type of material resides in an appropriate reference |
| 60 | manual. |
| 61 | For example, system variables are documented in the |
| 62 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. |
| 63 | </para></listitem> |
| 64 | <listitem><para> |
| 65 | Detailed Public Information Not Specific to the |
| 66 | Yocto Project: |
| 67 | For example, exhaustive information on how to use the |
| 68 | Source Control Manager Git is better covered with Internet |
| 69 | searches and official Git Documentation than through the |
| 70 | Yocto Project documentation. |
| 71 | </para></listitem> |
| 72 | </itemizedlist> |
| 73 | </para> |
| 74 | </section> |
| 75 | |
| 76 | <section id='other-information'> |
| 77 | <title>Other Information</title> |
| 78 | |
| 79 | <para> |
| 80 | Because this manual presents information for many different |
| 81 | topics, supplemental information is recommended for full |
| 82 | comprehension. |
| 83 | For introductory information on the Yocto Project, see the |
| 84 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. |
| 85 | If you want to build an image with no knowledge of Yocto Project |
| 86 | as a way of quickly testing it out, see the |
| 87 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> |
| 88 | document. |
| 89 | </para> |
| 90 | |
| 91 | <para> |
| 92 | For a comprehensive list of links and other documentation, see the |
| 93 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" |
| 94 | section in the Yocto Project Reference Manual. |
| 95 | </para> |
| 96 | |
| 97 | <para> |
| 98 | </para> |
| 99 | </section> |
| 100 | </chapter> |
| 101 | <!-- |
| 102 | vim: expandtab tw=80 ts=4 |
| 103 | --> |