diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2017-06-13 10:10:51 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2017-06-14 10:19:25 +0100 |
| commit | ed0ecc7b76698707529dcc3a765c037b7976de93 (patch) | |
| tree | f46d071118145312237c6f7cc88deb1480fdf8a3 /documentation/ref-manual/introduction.xml | |
| parent | 741dddf11ae899eec6ed710daf005551f304563b (diff) | |
| download | poky-ed0ecc7b76698707529dcc3a765c037b7976de93.tar.gz | |
dev-manual, ref-manual: Reorganized "Other Information"
Fixes [YOCTO #11630]
The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual. This is not the correct
place for this type of reference information. I have moved that
list to the ref-manual where it should be. The dev-manual now
simply provides a link into that section.
(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/introduction.xml')
| -rw-r--r-- | documentation/ref-manual/introduction.xml | 139 |
1 files changed, 89 insertions, 50 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index cec23b6039..7423467150 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml | |||
| @@ -44,75 +44,114 @@ | |||
| 44 | <para> | 44 | <para> |
| 45 | This reference manual consists of the following: | 45 | This reference manual consists of the following: |
| 46 | <itemizedlist> | 46 | <itemizedlist> |
| 47 | <listitem><para><emphasis> | 47 | <listitem><para> |
| 48 | <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> | 48 | <emphasis> |
| 49 | Provides an overview of the components that make up the Yocto Project | 49 | <link linkend='usingpoky'>Using the Yocto Project</link>: |
| 50 | followed by information about debugging images created in the Yocto Project. | 50 | </emphasis> |
| 51 | Provides an overview of the components that make up the Yocto | ||
| 52 | Project followed by information about debugging images created | ||
| 53 | in the Yocto Project. | ||
| 51 | </para></listitem> | 54 | </para></listitem> |
| 52 | <listitem><para><emphasis> | 55 | <listitem><para> |
| 53 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:</emphasis> | 56 | <emphasis> |
| 57 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>: | ||
| 58 | </emphasis> | ||
| 54 | Provides a more detailed look at the Yocto Project development | 59 | Provides a more detailed look at the Yocto Project development |
| 55 | environment within the context of development. | 60 | environment within the context of development. |
| 56 | </para></listitem> | 61 | </para></listitem> |
| 57 | <listitem><para><emphasis> | 62 | <listitem><para> |
| 58 | <link linkend='technical-details'>Technical Details</link>:</emphasis> | 63 | <emphasis> |
| 59 | Describes fundamental Yocto Project components as well as an explanation | 64 | <link linkend='technical-details'>Technical Details</link>: |
| 60 | behind how the Yocto Project uses shared state (sstate) cache to speed build time. | 65 | </emphasis> |
| 66 | Describes fundamental Yocto Project components as well as an | ||
| 67 | explanation behind how the Yocto Project uses shared state | ||
| 68 | (sstate) cache to speed build time. | ||
| 61 | </para></listitem> | 69 | </para></listitem> |
| 62 | <listitem><para><emphasis> | 70 | <listitem><para> |
| 63 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>:</emphasis> | 71 | <emphasis> |
| 72 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>: | ||
| 73 | </emphasis> | ||
| 64 | Describes release-specific information that helps you move from | 74 | Describes release-specific information that helps you move from |
| 65 | one Yocto Project Release to another. | 75 | one Yocto Project Release to another. |
| 66 | </para></listitem> | 76 | </para></listitem> |
| 67 | <listitem><para><emphasis> | 77 | <listitem><para> |
| 68 | <link linkend='ref-structure'>Directory Structure</link>:</emphasis> | 78 | <emphasis> |
| 69 | Describes the | 79 | <link linkend='ref-structure'>Directory Structure</link>: |
| 70 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> created | 80 | </emphasis> Describes the |
| 71 | either by unpacking a released Yocto Project tarball on your host development system, | 81 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> |
| 72 | or by cloning the upstream | 82 | created either by unpacking a released Yocto Project tarball on |
| 73 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. | 83 | your host development system, or by cloning the upstream |
| 84 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> | ||
| 85 | Git repository. | ||
| 74 | </para></listitem> | 86 | </para></listitem> |
| 75 | <listitem><para><emphasis> | 87 | <listitem><para> |
| 76 | <link linkend='ref-classes'>Classes</link>:</emphasis> | 88 | <emphasis> |
| 77 | Describes the classes used in the Yocto Project.</para></listitem> | 89 | <link linkend='ref-classes'>Classes</link>: |
| 78 | <listitem><para><emphasis> | 90 | </emphasis> |
| 79 | <link linkend='ref-tasks'>Tasks</link>:</emphasis> | 91 | Describes the classes used in the Yocto Project. |
| 92 | </para></listitem> | ||
| 93 | <listitem><para> | ||
| 94 | <emphasis> | ||
| 95 | <link linkend='ref-tasks'>Tasks</link>: | ||
| 96 | </emphasis> | ||
| 80 | Describes the tasks defined by the OpenEmbedded build system. | 97 | Describes the tasks defined by the OpenEmbedded build system. |
| 81 | </para></listitem> | 98 | </para></listitem> |
| 82 | <listitem><para><emphasis> | 99 | <listitem><para> |
| 83 | <link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>:</emphasis> | 100 | <emphasis> |
| 101 | <link linkend='ref-devtool-reference'><filename>devtool</filename> Quick Reference</link>: | ||
| 102 | </emphasis> | ||
| 84 | Provides a quick reference for the <filename>devtool</filename> | 103 | Provides a quick reference for the <filename>devtool</filename> |
| 85 | command. | 104 | command. |
| 86 | </para></listitem> | 105 | </para></listitem> |
| 87 | <listitem><para><emphasis> | 106 | <listitem><para> |
| 88 | <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>:</emphasis> | 107 | <emphasis> |
| 108 | <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>: | ||
| 109 | </emphasis> | ||
| 89 | Lists and describes QA warning and error messages. | 110 | Lists and describes QA warning and error messages. |
| 90 | </para></listitem> | 111 | </para></listitem> |
| 91 | <listitem><para><emphasis> | 112 | <listitem><para> |
| 92 | <link linkend='ref-images'>Images</link>:</emphasis> | 113 | <emphasis> |
| 114 | <link linkend='ref-images'>Images</link>: | ||
| 115 | </emphasis> | ||
| 93 | Describes the standard images that the Yocto Project supports. | 116 | Describes the standard images that the Yocto Project supports. |
| 94 | </para></listitem> | 117 | </para></listitem> |
| 95 | <listitem><para><emphasis> | 118 | <listitem><para> |
| 96 | <link linkend='ref-features'>Features</link>:</emphasis> | 119 | <emphasis> |
| 97 | Describes mechanisms for creating distribution, machine, and image | 120 | <link linkend='ref-features'>Features</link>: |
| 98 | features during the build process using the OpenEmbedded build system.</para></listitem> | 121 | </emphasis> |
| 99 | <listitem><para><emphasis> | 122 | Describes mechanisms for creating distribution, machine, and |
| 100 | <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis> | 123 | image features during the build process using the OpenEmbedded |
| 101 | Presents most variables used by the OpenEmbedded build system, which | 124 | build system. |
| 102 | uses BitBake. | 125 | </para></listitem> |
| 103 | Entries describe the function of the variable and how to apply them. | 126 | <listitem><para> |
| 127 | <emphasis> | ||
| 128 | <link linkend='ref-variables-glos'>Variables Glossary</link>: | ||
| 129 | </emphasis> | ||
| 130 | Presents most variables used by the OpenEmbedded build system, | ||
| 131 | which uses BitBake. | ||
| 132 | Entries describe the function of the variable and how to | ||
| 133 | apply them. | ||
| 134 | </para></listitem> | ||
| 135 | <listitem><para> | ||
| 136 | <emphasis> | ||
| 137 | <link linkend='ref-varlocality'>Variable Context</link>: | ||
| 138 | </emphasis> | ||
| 139 | Provides variable locality or context. | ||
| 140 | </para></listitem> | ||
| 141 | <listitem><para> | ||
| 142 | <emphasis> | ||
| 143 | <link linkend='faq'>FAQ</link>: | ||
| 144 | </emphasis> | ||
| 145 | Provides answers for commonly asked questions in the Yocto | ||
| 146 | Project development environment. | ||
| 147 | </para></listitem> | ||
| 148 | <listitem><para> | ||
| 149 | <emphasis> | ||
| 150 | <link linkend='resources'>Contributions and Additional Information</link>: | ||
| 151 | </emphasis> | ||
| 152 | Provides an overview of methods by which you can | ||
| 153 | contribute to and participate in the Yocto Project. | ||
| 104 | </para></listitem> | 154 | </para></listitem> |
| 105 | <listitem><para><emphasis> | ||
| 106 | <link linkend='ref-varlocality'>Variable Context</link>:</emphasis> | ||
| 107 | Provides variable locality or context.</para></listitem> | ||
| 108 | <listitem><para><emphasis> | ||
| 109 | <link linkend='faq'>FAQ</link>:</emphasis> | ||
| 110 | Provides answers for commonly asked questions in the Yocto Project | ||
| 111 | development environment.</para></listitem> | ||
| 112 | <listitem><para><emphasis> | ||
| 113 | <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis> | ||
| 114 | Provides guidance on how you can contribute back to the Yocto | ||
| 115 | Project.</para></listitem> | ||
| 116 | </itemizedlist> | 155 | </itemizedlist> |
| 117 | </para> | 156 | </para> |
| 118 | </section> | 157 | </section> |