blob: f457c8033a056340336b50a390d4e56bb6930f5a [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001<!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
Brad Bishopd7bf8c12018-02-25 22:55:05 -05007<title>The Yocto Project Development Tasks Manual</title>
8 <section id='dev-welcome'>
9 <title>Welcome</title>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050010
11 <para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050012 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.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019 </para>
20
21 <para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050022 The following list describes what you can get from this manual:
23 <itemizedlist>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050024 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -040025 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.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050029 </para></listitem>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050030 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -040031 Procedures that show you how to submit changes to the
32 Yocto Project.
33 Changes can be improvements, new features, or bug
34 fixes.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050035 </para></listitem>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050036 <listitem><para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050037 Procedures related to "everyday" tasks you perform while
38 developing images and applications using the Yocto
39 Project.
Brad Bishop316dfdd2018-06-25 12:45:53 -040040 For example, procedures to create a layer, customize an
41 image, write a new recipe, and so forth.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050042 </para></listitem>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050043 </itemizedlist>
44 </para>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050045
46 <para>
47 This manual will not give you the following:
48 <itemizedlist>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050049 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -040050 Redundant Step-by-step Instructions:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050051 For example, the
Brad Bishopd7bf8c12018-02-25 22:55:05 -050052 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050053 manual contains detailed instructions on how to install an
54 SDK, which is used to develop applications for target
55 hardware.
56 </para></listitem>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050057 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -040058 Reference or Conceptual Material:
59 This type of material resides in an appropriate reference
60 manual.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050061 For example, system variables are documented in the
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050062 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
63 </para></listitem>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050064 <listitem><para>
Brad Bishop316dfdd2018-06-25 12:45:53 -040065 Detailed Public Information Not Specific to the
66 Yocto Project:
Brad Bishopd7bf8c12018-02-25 22:55:05 -050067 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.
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050071 </para></listitem>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050072 </itemizedlist>
73 </para>
74 </section>
75
76 <section id='other-information'>
77 <title>Other Information</title>
78
79 <para>
Brad Bishopd7bf8c12018-02-25 22:55:05 -050080 Because this manual presents information for many different
Patrick Williamsc124f4f2015-09-15 14:41:29 -050081 topics, supplemental information is recommended for full
82 comprehension.
Brad Bishopd7bf8c12018-02-25 22:55:05 -050083 For introductory information on the Yocto Project, see the
84 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
Brad Bishop316dfdd2018-06-25 12:45:53 -040085 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.
Brad Bishopd7bf8c12018-02-25 22:55:05 -050089 </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>
Patrick Williamsc124f4f2015-09-15 14:41:29 -050098 </para>
99 </section>
100</chapter>
101<!--
102vim: expandtab tw=80 ts=4
103-->