summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-16 10:47:21 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:34 +0100
commit222824948893d10b1183b38b1593a9bb13de63c7 (patch)
tree185aebfca2347ad0b240cb00852ccc33c77aa7aa /documentation
parent51c74acdadae6a84763e1f0ff623d664c9abb0a3 (diff)
downloadpoky-222824948893d10b1183b38b1593a9bb13de63c7.tar.gz
dev-manual: Updated intro chapter
The chapter was not the best given the new nature of the manual. I added better introductory wording. (From yocto-docs rev: cb4695575c0105e0cd5e50c2132e98553babe147) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml35
1 files changed, 16 insertions, 19 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index d8f4466391..f457c8033a 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -16,33 +16,29 @@
16 The manual groups related procedures into higher-level sections. 16 The manual groups related procedures into higher-level sections.
17 Procedures can consist of high-level steps or low-level steps 17 Procedures can consist of high-level steps or low-level steps
18 depending on the topic. 18 depending on the topic.
19 You can find conceptual information related to a procedure by
20 following appropriate links to the Yocto Project Reference
21 Manual.
22 </para> 19 </para>
23 20
24 <para> 21 <para>
25 The following list describes what you can get from this manual: 22 The following list describes what you can get from this manual:
26 <itemizedlist> 23 <itemizedlist>
27 <listitem><para> 24 <listitem><para>
28 <emphasis>Setup Procedures:</emphasis> 25 Procedures that help you get going with the Yocto Project.
29 Procedures that show you how to set 26 For example, procedures that show you how to set up
30 up a Yocto Project Development environment and how 27 a build host and work with the Yocto Project
31 to accomplish the change workflow through logging 28 source repositories.
32 defects and submitting changes.
33 </para></listitem> 29 </para></listitem>
34 <listitem><para> 30 <listitem><para>
35 <emphasis>Emulation Procedures:</emphasis> 31 Procedures that show you how to submit changes to the
36 Procedures that show you how to use the 32 Yocto Project.
37 Yocto Project integrated QuickEMUlator (QEMU), which lets 33 Changes can be improvements, new features, or bug
38 you simulate running on hardware an image you have built 34 fixes.
39 using the OpenEmbedded build system.
40 </para></listitem> 35 </para></listitem>
41 <listitem><para> 36 <listitem><para>
42 <emphasis>Common Procedures:</emphasis>
43 Procedures related to "everyday" tasks you perform while 37 Procedures related to "everyday" tasks you perform while
44 developing images and applications using the Yocto 38 developing images and applications using the Yocto
45 Project. 39 Project.
40 For example, procedures to create a layer, customize an
41 image, write a new recipe, and so forth.
46 </para></listitem> 42 </para></listitem>
47 </itemizedlist> 43 </itemizedlist>
48 </para> 44 </para>
@@ -51,7 +47,7 @@
51 This manual will not give you the following: 47 This manual will not give you the following:
52 <itemizedlist> 48 <itemizedlist>
53 <listitem><para> 49 <listitem><para>
54 <emphasis>Redundant Step-by-step Instructions:</emphasis> 50 Redundant Step-by-step Instructions:
55 For example, the 51 For example, the
56 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> 52 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink>
57 manual contains detailed instructions on how to install an 53 manual contains detailed instructions on how to install an
@@ -59,14 +55,15 @@
59 hardware. 55 hardware.
60 </para></listitem> 56 </para></listitem>
61 <listitem><para> 57 <listitem><para>
62 <emphasis>Reference or Conceptual Material:</emphasis> 58 Reference or Conceptual Material:
63 This type of material resides in an appropriate reference manual. 59 This type of material resides in an appropriate reference
60 manual.
64 For example, system variables are documented in the 61 For example, system variables are documented in the
65 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. 62 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.
66 </para></listitem> 63 </para></listitem>
67 <listitem><para> 64 <listitem><para>
68 <emphasis>Detailed Public Information Not Specific to the 65 Detailed Public Information Not Specific to the
69 Yocto Project:</emphasis> 66 Yocto Project:
70 For example, exhaustive information on how to use the 67 For example, exhaustive information on how to use the
71 Source Control Manager Git is better covered with Internet 68 Source Control Manager Git is better covered with Internet
72 searches and official Git Documentation than through the 69 searches and official Git Documentation than through the