]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
documentation: converted ref-images and ref-features to chapters
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Mon, 16 Jul 2012 17:53:16 +0000 (10:53 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Tue, 17 Jul 2012 09:54:11 +0000 (10:54 +0100)
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>
documentation/adt-manual/adt-prepare.xml
documentation/dev-manual/dev-manual-common-tasks.xml
documentation/dev-manual/dev-manual-model.xml
documentation/dev-manual/dev-manual-newbie.xml
documentation/dev-manual/dev-manual-start.xml
documentation/poky-ref-manual/introduction.xml
documentation/poky-ref-manual/ref-features.xml
documentation/poky-ref-manual/ref-images.xml
documentation/poky-ref-manual/ref-variables.xml
documentation/poky-ref-manual/usingpoky.xml
documentation/yocto-project-qs/yocto-project-qs.xml

index 0cda17846c978dd3472dc13bf1dd272f8b5311e9..845c783d24db0632b04553d02a6f8391b4420aba 100644 (file)
             and are ideal for experimentation using Yocto Project.
             For information on the image types you can build using the OpenEmbedded build system, 
             see the
-            "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in  
+            "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in  
             The Yocto Project Reference Manual.
         </para>
 
index d24838a54b83b31213a58d75c311a8805db73513..686d47ec4bf32fb41e5b152c0dcae4efbc7036fa 100644 (file)
             It also allows you to perform post-mortem style analysis of program crashes. 
             GDB is available as a package within the Yocto Project and by default is 
             installed in sdk images.
-            See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix 
+            See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" appendix 
             in the Yocto Project Reference Manual for a description of these images. 
             You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>.
         </para>
index c70aba313ebe580e85e1b00f52949780a44fa58f..12a62f467dae4e484a250ce79fc7621ac4dd2915 100644 (file)
                     <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
                     <para>The build process supports several types of images to satisfy different needs.  
                     See the 
-                    "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix 
-                    in The Yocto Project Reference Manual for information on 
+                    "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter 
+                    in the Yocto Project Reference Manual for information on 
                     supported images.</para></listitem>
             </orderedlist>
         </para>
                         You can find more information on BitBake 
                         <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
                         <para>The build process supports several types of images to satisfy different needs.  
-                        See the appendix
-                        "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" in 
-                        The Yocto Project Reference Manual for information on supported images.</para></listitem>
+                        See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in 
+                        the Yocto Project Reference Manual for information on supported images.</para></listitem>
                     <listitem><para><emphasis>Make your configuration changes available
                         in the kernel layer</emphasis>:  Up to this point, all the configuration changes to the 
                         kernel have been done and tested iteratively.  
index bf343b4605817042f8837877eb52fdc676d9bba4..d39c4450519da4cabc77bead70d242b4fdb5389f 100644 (file)
                 Images are the binary output that run on specific hardware and for specific
                 use cases.
                 For a list of the supported image types that the Yocto Project provides, see the
-                "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>"
-                appendix in The Yocto Project Reference Manual.</para></listitem>
+                "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
+                chapter in the Yocto Project Reference Manual.</para></listitem>
             <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, 
                 a BSP, or an application stack.
                 For a discussion on BSP Layers, see the 
index 5ba7b0bf3b1dc4c1a76ed1c123a2698e7caa15ad..8cc7283196213e93b0989e4e492ebe40d187aa86 100644 (file)
     <para>
         Another option you have to get started is to use pre-built binaries. 
         The Yocto Project provides many types of binaries with each release. 
-        See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>
-        section for descriptions of the types of binaries that ship with a Yocto Project
+        See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>
+        chapter in the Yocto Project Reference Manual
+        for descriptions of the types of binaries that ship with a Yocto Project
         release.
     </para>
 
index d2225f85561eca539f7446d6956732e2607d1d65..27ee6ec039bc14b0c446725c7fea1d3bab200d0f 100644 (file)
                 <link linkend='ref-classes'>Classes</link>:</emphasis> 
                 This chapter describes the classes used in the Yocto Project.</para></listitem>
             <listitem><para><emphasis>
-                <link linkend='ref-images'>Reference: Images</link>:</emphasis> 
-                This appendix describes the standard images that the Yocto Project supports.
+                <link linkend='ref-images'>Images</link>:</emphasis> 
+                This chapter describes the standard images that the Yocto Project supports.
                 </para></listitem>
             <listitem><para><emphasis>
-                <link linkend='ref-features'>Reference: Features</link>:</emphasis> 
-                This appendix describes mechanisms for creating distribution, machine, and image 
+                <link linkend='ref-features'>Features</link>:</emphasis> 
+                This chapter describes mechanisms for creating distribution, machine, and image 
                 features during the build process using the OpenEmbedded build system.</para></listitem>
             <listitem><para><emphasis>
                 <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis> 
index 58db94e2950a1e82b14483d73ec0039e2e3b0957..bdf29a2596286bce5cc298977fc123e27a0ac033 100644 (file)
@@ -1,8 +1,8 @@
-<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
 [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
-<appendix id='ref-features'>
+<chapter id='ref-features'>
     <title>Reference: Features</title>
 
     <para>
             </itemizedlist>
         </para>
     </section>
-</appendix>
+</chapter>
 
 <!-- 
 vim: expandtab tw=80 ts=4 spell spelllang=en_gb
index 0ffea5d19f323d0530ddaacdfcb8b5c255b43dab..d1ff6d01447dd6679e8e34242fa854b481cb9fd3 100644 (file)
@@ -1,9 +1,9 @@
-<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
 [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
-<appendix id='ref-images'>
-    <title>Reference: Images</title>
+<chapter id='ref-images'>
+    <title>Images</title>
 
     <para>
         The OpenEmbedded build process supports several types of images to satisfy different needs.  
         "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
         file or wherever appropriate and then build the desired image as normal.
     </tip>
-</appendix>
+</chapter>
 <!-- 
 vim: expandtab tw=80 ts=4 
 -->
index 6807c5c309bcf00cedea826d40f6b473e6585e55..aabe9e767c356618a5dfd55c1d7f9bb3d54e5ce1 100644 (file)
@@ -785,7 +785,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
                 Typically, you configure this variable in image recipes.
                 Note that you can add extra features to the image by using the
                 <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable.
-                See the "<link linkend="ref-features-image">Reference: Images</link>" section for the 
+                See the "<link linkend="ref-features-image">Images</link>" chapter for the 
                 list of features present in images built by the OpenEmbedded build system.</para>
             </glossdef>
         </glossentry>
index 121650cd54a736f19aaae2d2685472518b1c49dc..f2bd411a54a18c4c8755a58386a99624447da82d 100644 (file)
             Or, the target can be the name of a recipe for a specific piece of software such as 
             <application>busybox</application>. 
             For more details about the images the OpenEmbedded build system supports, see the 
-            "<link linkend="ref-images">Reference: Images</link>" appendix.
+            "<link linkend="ref-images">Images</link>" chapter.
         </para>
 
         <note>
             Building an image without GNU Public License Version 3 (GPLv3) components is 
             only supported for minimal and base images.
-            See the "<link linkend='ref-images'>Reference: Images</link>" appendix for more information.
+            See the "<link linkend='ref-images'>Images</link>" chapter for more information.
         </note>
     </section>
 
index 7cb61e405ee12a01526a4f2f3f1e554a716275ed..c01d5a62365d304614924a7728a398e922f2c1f4 100644 (file)
      Where:
          &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
                    lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk.
-                   For information on these types of image profiles, see
-                   <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual.
+                   For information on these types of image profiles, see the
+                   "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
+                   in the Yocto Project Reference Manual.
 
          &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 
                 x86, x86-64, ppc, mips, or arm.