diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-04-12 10:52:45 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-05-24 17:16:12 +0100 |
| commit | c555881ac8e62e1bc1ddd9e0337e0c70a560b3b6 (patch) | |
| tree | 80925d3cd31d9fe7e0b6692cd9ea39fb3e947146 /documentation/overview-manual/overview-manual-intro.xml | |
| parent | 4fd8b39b243f1b0d49971c233a5db2b09f1a2048 (diff) | |
| download | poky-c555881ac8e62e1bc1ddd9e0337e0c70a560b3b6.tar.gz | |
poky.ent: Added YOCTO_DOCS_OM_URL entity
The variabe for the "getting-started" manual goes away and is
replaced by this one for the new "overview-manual."
(From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-intro.xml')
| -rw-r--r-- | documentation/overview-manual/overview-manual-intro.xml | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/documentation/overview-manual/overview-manual-intro.xml b/documentation/overview-manual/overview-manual-intro.xml new file mode 100644 index 0000000000..2976f7c1b6 --- /dev/null +++ b/documentation/overview-manual/overview-manual-intro.xml | |||
| @@ -0,0 +1,111 @@ | |||
| 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='overview-manual-intro'> | ||
| 6 | |||
| 7 | <title>The Yocto Project Overview and Concepts Manual</title> | ||
| 8 | <section id='overview-manual-welcome'> | ||
| 9 | <title>Welcome</title> | ||
| 10 | |||
| 11 | <para> | ||
| 12 | Welcome to the Yocto Project Overview and Concepts Manual! | ||
| 13 | This manual introduces the Yocto Project by providing concepts, | ||
| 14 | software overviews, best-known-methods (BKMs), and any other | ||
| 15 | high-level introductory information suitable for a new Yocto | ||
| 16 | Project user. | ||
| 17 | </para> | ||
| 18 | |||
| 19 | <para> | ||
| 20 | The following list describes what you can get from this manual: | ||
| 21 | <itemizedlist> | ||
| 22 | <listitem><para> | ||
| 23 | <emphasis><link linkend='overview-yp'>Introducing the Yocto Project</link>:</emphasis> | ||
| 24 | This chapter provides an introduction to the Yocto | ||
| 25 | Project. | ||
| 26 | You will learn about features and challenges of the | ||
| 27 | Yocto Project, the layer model, components and tools, | ||
| 28 | development methods, the Poky reference distribution, | ||
| 29 | the OpenEmbedded build system workflow, and some basic | ||
| 30 | Yocto terms. | ||
| 31 | </para></listitem> | ||
| 32 | <listitem><para> | ||
| 33 | <emphasis><link linkend='overview-development-environment'>The Yocto Project Development Environment</link>:</emphasis> | ||
| 34 | This chapter helps you get started understanding the | ||
| 35 | Yocto Project development environment. | ||
| 36 | You will learn about open source, development hosts, | ||
| 37 | Yocto Project source repositories, workflows using Git | ||
| 38 | and the Yocto Project, a Git primer, and information | ||
| 39 | about licensing. | ||
| 40 | </para></listitem> | ||
| 41 | </itemizedlist> | ||
| 42 | </para> | ||
| 43 | |||
| 44 | <para> | ||
| 45 | This manual does not give you the following: | ||
| 46 | <itemizedlist> | ||
| 47 | <listitem><para> | ||
| 48 | <emphasis>Step-by-step Instructions for Development Tasks:</emphasis> | ||
| 49 | Instructional procedures reside in other manuals within | ||
| 50 | the Yocto Project documentation set. | ||
| 51 | For example, the | ||
| 52 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink> | ||
| 53 | provides examples on how to perform various development | ||
| 54 | tasks. | ||
| 55 | As another example, the | ||
| 56 | <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 | ||
| 58 | SDK, which is used to develop applications for target | ||
| 59 | hardware. | ||
| 60 | </para></listitem> | ||
| 61 | <listitem><para> | ||
| 62 | <emphasis>Reference Material:</emphasis> | ||
| 63 | This type of material resides in an appropriate reference | ||
| 64 | manual. | ||
| 65 | For example, system variables are documented in the | ||
| 66 | <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>. | ||
| 67 | As another example, the | ||
| 68 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink> | ||
| 69 | contains reference information on BSPs. | ||
| 70 | </para></listitem> | ||
| 71 | <listitem><para> | ||
| 72 | <emphasis>Detailed Public Information Not Specific to the | ||
| 73 | Yocto Project:</emphasis> | ||
| 74 | For example, exhaustive information on how to use the | ||
| 75 | Source Control Manager Git is better covered with Internet | ||
| 76 | searches and official Git Documentation than through the | ||
| 77 | Yocto Project documentation. | ||
| 78 | </para></listitem> | ||
| 79 | </itemizedlist> | ||
| 80 | </para> | ||
| 81 | </section> | ||
| 82 | |||
| 83 | <section id='overview-manual-other-information'> | ||
| 84 | <title>Other Information</title> | ||
| 85 | |||
| 86 | <para> | ||
| 87 | Because this manual presents information for many different | ||
| 88 | topics, supplemental information is recommended for full | ||
| 89 | comprehension. | ||
| 90 | For additional introductory information on the Yocto Project, see | ||
| 91 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. | ||
| 92 | If you want to build an image with no knowledge of Yocto Project | ||
| 93 | as a way of quickly testing it out, see the | ||
| 94 | <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> | ||
| 95 | document. | ||
| 96 | </para> | ||
| 97 | |||
| 98 | <para> | ||
| 99 | For a comprehensive list of links and other documentation, see the | ||
| 100 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-links-and-related-documentation'>Links and Related Documentation</ulink>" | ||
| 101 | section in the Yocto Project Reference Manual. | ||
| 102 | For a paper showing how to set up and run a quick build using the | ||
| 103 | Yocto Project, see the | ||
| 104 | "<ulink url='&YOCTO_DOCS_BRIEF_URL;'>My First Yocto Project Build</ulink>" | ||
| 105 | paper. | ||
| 106 | </para> | ||
| 107 | </section> | ||
| 108 | </chapter> | ||
| 109 | <!-- | ||
| 110 | vim: expandtab tw=80 ts=4 | ||
| 111 | --> | ||
