From ef3b230abf31ccbc9114957b2c15f9a49c01ae81 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 16 May 2018 10:47:21 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-intro.xml | 35 ++++++++++++--------------- 1 file changed, 16 insertions(+), 19 deletions(-) (limited to 'documentation/dev-manual') 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 @@ The manual groups related procedures into higher-level sections. Procedures can consist of high-level steps or low-level steps depending on the topic. - You can find conceptual information related to a procedure by - following appropriate links to the Yocto Project Reference - Manual. The following list describes what you can get from this manual: - Setup Procedures: - Procedures that show you how to set - up a Yocto Project Development environment and how - to accomplish the change workflow through logging - defects and submitting changes. + Procedures that help you get going with the Yocto Project. + For example, procedures that show you how to set up + a build host and work with the Yocto Project + source repositories. - Emulation Procedures: - Procedures that show you how to use the - Yocto Project integrated QuickEMUlator (QEMU), which lets - you simulate running on hardware an image you have built - using the OpenEmbedded build system. + Procedures that show you how to submit changes to the + Yocto Project. + Changes can be improvements, new features, or bug + fixes. - Common Procedures: Procedures related to "everyday" tasks you perform while developing images and applications using the Yocto Project. + For example, procedures to create a layer, customize an + image, write a new recipe, and so forth. @@ -51,7 +47,7 @@ This manual will not give you the following: - Redundant Step-by-step Instructions: + Redundant Step-by-step Instructions: For example, the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual contains detailed instructions on how to install an @@ -59,14 +55,15 @@ hardware. - Reference or Conceptual Material: - This type of material resides in an appropriate reference manual. + Reference or Conceptual Material: + This type of material resides in an appropriate reference + manual. For example, system variables are documented in the Yocto Project Reference Manual. - Detailed Public Information Not Specific to the - Yocto Project: + Detailed Public Information Not Specific to the + Yocto Project: For example, exhaustive information on how to use the Source Control Manager Git is better covered with Internet searches and official Git Documentation than through the -- cgit v1.2.3-54-g00ecf