summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-07-16 10:53:16 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-07-17 10:54:11 +0100
commit2db4088ceddd65892c718363592c398d37a82d5c (patch)
tree02b6505223c457e5f2416792215ec0bb08fb2a74 /documentation
parent695420417f7cf51297dc23861ab60860eba48ca2 (diff)
downloadpoky-2db4088ceddd65892c718363592c398d37a82d5c.tar.gz
documentation: converted ref-images and ref-features to chapters
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-imagese" and "ref-features" appendices to chapters and made any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-prepare.xml2
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml2
-rw-r--r--documentation/dev-manual/dev-manual-model.xml9
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml4
-rw-r--r--documentation/dev-manual/dev-manual-start.xml5
-rw-r--r--documentation/poky-ref-manual/introduction.xml8
-rw-r--r--documentation/poky-ref-manual/ref-features.xml6
-rw-r--r--documentation/poky-ref-manual/ref-images.xml8
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml2
-rw-r--r--documentation/poky-ref-manual/usingpoky.xml4
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml5
11 files changed, 28 insertions, 27 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 0cda17846c..845c783d24 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -371,7 +371,7 @@
371 and are ideal for experimentation using Yocto Project. 371 and are ideal for experimentation using Yocto Project.
372 For information on the image types you can build using the OpenEmbedded build system, 372 For information on the image types you can build using the OpenEmbedded build system,
373 see the 373 see the
374 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in 374 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
375 The Yocto Project Reference Manual. 375 The Yocto Project Reference Manual.
376 </para> 376 </para>
377 377
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index d24838a54b..686d47ec4b 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1713,7 +1713,7 @@
1713 It also allows you to perform post-mortem style analysis of program crashes. 1713 It also allows you to perform post-mortem style analysis of program crashes.
1714 GDB is available as a package within the Yocto Project and by default is 1714 GDB is available as a package within the Yocto Project and by default is
1715 installed in sdk images. 1715 installed in sdk images.
1716 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix 1716 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" appendix
1717 in the Yocto Project Reference Manual for a description of these images. 1717 in the Yocto Project Reference Manual for a description of these images.
1718 You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>. 1718 You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>.
1719 </para> 1719 </para>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index c70aba313e..12a62f467d 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -197,8 +197,8 @@
197 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> 197 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
198 <para>The build process supports several types of images to satisfy different needs. 198 <para>The build process supports several types of images to satisfy different needs.
199 See the 199 See the
200 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix 200 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
201 in The Yocto Project Reference Manual for information on 201 in the Yocto Project Reference Manual for information on
202 supported images.</para></listitem> 202 supported images.</para></listitem>
203 </orderedlist> 203 </orderedlist>
204 </para> 204 </para>
@@ -501,9 +501,8 @@
501 You can find more information on BitBake 501 You can find more information on BitBake
502 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> 502 <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
503 <para>The build process supports several types of images to satisfy different needs. 503 <para>The build process supports several types of images to satisfy different needs.
504 See the appendix 504 See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
505 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" in 505 the Yocto Project Reference Manual for information on supported images.</para></listitem>
506 The Yocto Project Reference Manual for information on supported images.</para></listitem>
507 <listitem><para><emphasis>Make your configuration changes available 506 <listitem><para><emphasis>Make your configuration changes available
508 in the kernel layer</emphasis>: Up to this point, all the configuration changes to the 507 in the kernel layer</emphasis>: Up to this point, all the configuration changes to the
509 kernel have been done and tested iteratively. 508 kernel have been done and tested iteratively.
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index bf343b4605..d39c445051 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -292,8 +292,8 @@
292 Images are the binary output that run on specific hardware and for specific 292 Images are the binary output that run on specific hardware and for specific
293 use cases. 293 use cases.
294 For a list of the supported image types that the Yocto Project provides, see the 294 For a list of the supported image types that the Yocto Project provides, see the
295 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" 295 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
296 appendix in The Yocto Project Reference Manual.</para></listitem> 296 chapter in the Yocto Project Reference Manual.</para></listitem>
297 <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, 297 <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core,
298 a BSP, or an application stack. 298 a BSP, or an application stack.
299 For a discussion on BSP Layers, see the 299 For a discussion on BSP Layers, see the
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 5ba7b0bf3b..8cc7283196 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -293,8 +293,9 @@
293 <para> 293 <para>
294 Another option you have to get started is to use pre-built binaries. 294 Another option you have to get started is to use pre-built binaries.
295 The Yocto Project provides many types of binaries with each release. 295 The Yocto Project provides many types of binaries with each release.
296 See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> 296 See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>
297 section for descriptions of the types of binaries that ship with a Yocto Project 297 chapter in the Yocto Project Reference Manual
298 for descriptions of the types of binaries that ship with a Yocto Project
298 release. 299 release.
299 </para> 300 </para>
300 301
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index d2225f8556..27ee6ec039 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -61,12 +61,12 @@
61 <link linkend='ref-classes'>Classes</link>:</emphasis> 61 <link linkend='ref-classes'>Classes</link>:</emphasis>
62 This chapter describes the classes used in the Yocto Project.</para></listitem> 62 This chapter describes the classes used in the Yocto Project.</para></listitem>
63 <listitem><para><emphasis> 63 <listitem><para><emphasis>
64 <link linkend='ref-images'>Reference: Images</link>:</emphasis> 64 <link linkend='ref-images'>Images</link>:</emphasis>
65 This appendix describes the standard images that the Yocto Project supports. 65 This chapter describes the standard images that the Yocto Project supports.
66 </para></listitem> 66 </para></listitem>
67 <listitem><para><emphasis> 67 <listitem><para><emphasis>
68 <link linkend='ref-features'>Reference: Features</link>:</emphasis> 68 <link linkend='ref-features'>Features</link>:</emphasis>
69 This appendix describes mechanisms for creating distribution, machine, and image 69 This chapter describes mechanisms for creating distribution, machine, and image
70 features during the build process using the OpenEmbedded build system.</para></listitem> 70 features during the build process using the OpenEmbedded build system.</para></listitem>
71 <listitem><para><emphasis> 71 <listitem><para><emphasis>
72 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis> 72 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis>
diff --git a/documentation/poky-ref-manual/ref-features.xml b/documentation/poky-ref-manual/ref-features.xml
index 58db94e295..bdf29a2596 100644
--- a/documentation/poky-ref-manual/ref-features.xml
+++ b/documentation/poky-ref-manual/ref-features.xml
@@ -1,8 +1,8 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > 3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4 4
5<appendix id='ref-features'> 5<chapter id='ref-features'>
6 <title>Reference: Features</title> 6 <title>Reference: Features</title>
7 7
8 <para> 8 <para>
@@ -157,7 +157,7 @@
157 </itemizedlist> 157 </itemizedlist>
158 </para> 158 </para>
159 </section> 159 </section>
160</appendix> 160</chapter>
161 161
162<!-- 162<!--
163vim: expandtab tw=80 ts=4 spell spelllang=en_gb 163vim: expandtab tw=80 ts=4 spell spelllang=en_gb
diff --git a/documentation/poky-ref-manual/ref-images.xml b/documentation/poky-ref-manual/ref-images.xml
index 0ffea5d19f..d1ff6d0144 100644
--- a/documentation/poky-ref-manual/ref-images.xml
+++ b/documentation/poky-ref-manual/ref-images.xml
@@ -1,9 +1,9 @@
1<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" 2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > 3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4 4
5<appendix id='ref-images'> 5<chapter id='ref-images'>
6 <title>Reference: Images</title> 6 <title>Images</title>
7 7
8 <para> 8 <para>
9 The OpenEmbedded build process supports several types of images to satisfy different needs. 9 The OpenEmbedded build process supports several types of images to satisfy different needs.
@@ -127,7 +127,7 @@
127 "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename> 127 "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
128 file or wherever appropriate and then build the desired image as normal. 128 file or wherever appropriate and then build the desired image as normal.
129 </tip> 129 </tip>
130</appendix> 130</chapter>
131<!-- 131<!--
132vim: expandtab tw=80 ts=4 132vim: expandtab tw=80 ts=4
133--> 133-->
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 6807c5c309..aabe9e767c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -785,7 +785,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
785 Typically, you configure this variable in image recipes. 785 Typically, you configure this variable in image recipes.
786 Note that you can add extra features to the image by using the 786 Note that you can add extra features to the image by using the
787 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. 787 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
788 See the "<link linkend="ref-features-image">Reference: Images</link>" section for the 788 See the "<link linkend="ref-features-image">Images</link>" chapter for the
789 list of features present in images built by the OpenEmbedded build system.</para> 789 list of features present in images built by the OpenEmbedded build system.</para>
790 </glossdef> 790 </glossdef>
791 </glossentry> 791 </glossentry>
diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml
index 121650cd54..f2bd411a54 100644
--- a/documentation/poky-ref-manual/usingpoky.xml
+++ b/documentation/poky-ref-manual/usingpoky.xml
@@ -62,13 +62,13 @@
62 Or, the target can be the name of a recipe for a specific piece of software such as 62 Or, the target can be the name of a recipe for a specific piece of software such as
63 <application>busybox</application>. 63 <application>busybox</application>.
64 For more details about the images the OpenEmbedded build system supports, see the 64 For more details about the images the OpenEmbedded build system supports, see the
65 "<link linkend="ref-images">Reference: Images</link>" appendix. 65 "<link linkend="ref-images">Images</link>" chapter.
66 </para> 66 </para>
67 67
68 <note> 68 <note>
69 Building an image without GNU Public License Version 3 (GPLv3) components is 69 Building an image without GNU Public License Version 3 (GPLv3) components is
70 only supported for minimal and base images. 70 only supported for minimal and base images.
71 See the "<link linkend='ref-images'>Reference: Images</link>" appendix for more information. 71 See the "<link linkend='ref-images'>Images</link>" chapter for more information.
72 </note> 72 </note>
73 </section> 73 </section>
74 74
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 7cb61e405e..c01d5a6236 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -637,8 +637,9 @@
637 Where: 637 Where:
638 &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile: 638 &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
639 lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk. 639 lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk.
640 For information on these types of image profiles, see 640 For information on these types of image profiles, see the
641 <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual. 641 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
642 in the Yocto Project Reference Manual.
642 643
643 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 644 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
644 x86, x86-64, ppc, mips, or arm. 645 x86, x86-64, ppc, mips, or arm.