sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2012-07-16 10:53:16 -07:00 committed by Richard Purdie
parent 695420417f
commit 2db4088ced
11 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/adt-manual/adt-prepare.xml
View File

@ -371,7 +371,7 @@
and are ideal for experimentation using Yocto Project. and are ideal for experimentation using Yocto Project.
For information on the image types you can build using the OpenEmbedded build system, For information on the image types you can build using the OpenEmbedded build system,
see the 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. The Yocto Project Reference Manual.
</para> </para>

2
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -1713,7 +1713,7 @@
It also allows you to perform post-mortem style analysis of program crashes. 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 GDB is available as a package within the Yocto Project and by default is
installed in sdk images. 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. 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/"/>. You can find information on GDB at <ulink url="http://sourceware.org/gdb/"/>.
</para> </para>

9
documentation/dev-manual/dev-manual-model.xml
View File

@ -197,8 +197,8 @@
<ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
<para>The build process supports several types of images to satisfy different needs. <para>The build process supports several types of images to satisfy different needs.
See the See the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
in The Yocto Project Reference Manual for information on in the Yocto Project Reference Manual for information on
supported images.</para></listitem> supported images.</para></listitem>
</orderedlist> </orderedlist>
</para> </para>
@ -501,9 +501,8 @@
You can find more information on BitBake You can find more information on BitBake
<ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para> <ulink url='&BITBAKE_DOCS_URL;'>here</ulink>.</para>
<para>The build process supports several types of images to satisfy different needs. <para>The build process supports several types of images to satisfy different needs.
See the appendix See the "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter in
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" in the Yocto Project Reference Manual for information on supported images.</para></listitem>
The Yocto Project Reference Manual for information on supported images.</para></listitem>
<listitem><para><emphasis>Make your configuration changes available <listitem><para><emphasis>Make your configuration changes available
in the kernel layer</emphasis>: Up to this point, all the configuration changes to the in the kernel layer</emphasis>: Up to this point, all the configuration changes to the
kernel have been done and tested iteratively. kernel have been done and tested iteratively.

4
documentation/dev-manual/dev-manual-newbie.xml
View File

@ -292,8 +292,8 @@
Images are the binary output that run on specific hardware and for specific Images are the binary output that run on specific hardware and for specific
use cases. use cases.
For a list of the supported image types that the Yocto Project provides, see the 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>" "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
appendix in The Yocto Project Reference Manual.</para></listitem> chapter in the Yocto Project Reference Manual.</para></listitem>
<listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core, <listitem><para id='layer'><emphasis>Layer:</emphasis> A collection of recipes representing the core,
a BSP, or an application stack. a BSP, or an application stack.
For a discussion on BSP Layers, see the For a discussion on BSP Layers, see the

5
documentation/dev-manual/dev-manual-start.xml
View File

@ -293,8 +293,9 @@
<para> <para>
Another option you have to get started is to use pre-built binaries. Another option you have to get started is to use pre-built binaries.
The Yocto Project provides many types of binaries with each release. The Yocto Project provides many types of binaries with each release.
See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> See the <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>
section for descriptions of the types of binaries that ship with a Yocto Project chapter in the Yocto Project Reference Manual
for descriptions of the types of binaries that ship with a Yocto Project
release. release.
</para> </para>

8
documentation/poky-ref-manual/introduction.xml
View File

@ -61,12 +61,12 @@
<link linkend='ref-classes'>Classes</link>:</emphasis> <link linkend='ref-classes'>Classes</link>:</emphasis>
This chapter describes the classes used in the Yocto Project.</para></listitem> This chapter describes the classes used in the Yocto Project.</para></listitem>
<listitem><para><emphasis> <listitem><para><emphasis>
<link linkend='ref-images'>Reference: Images</link>:</emphasis> <link linkend='ref-images'>Images</link>:</emphasis>
This appendix describes the standard images that the Yocto Project supports. This chapter describes the standard images that the Yocto Project supports.
</para></listitem> </para></listitem>
<listitem><para><emphasis> <listitem><para><emphasis>
<link linkend='ref-features'>Reference: Features</link>:</emphasis> <link linkend='ref-features'>Features</link>:</emphasis>
This appendix describes mechanisms for creating distribution, machine, and image This chapter describes mechanisms for creating distribution, machine, and image
features during the build process using the OpenEmbedded build system.</para></listitem> features during the build process using the OpenEmbedded build system.</para></listitem>
<listitem><para><emphasis> <listitem><para><emphasis>
<link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis> <link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis>

6
documentation/poky-ref-manual/ref-features.xml
View 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" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<appendix id='ref-features'> <chapter id='ref-features'>
<title>Reference: Features</title> <title>Reference: Features</title>
<para> <para>
@ -157,7 +157,7 @@
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
</appendix> </chapter>
<!-- <!--
vim: expandtab tw=80 ts=4 spell spelllang=en_gb vim: expandtab tw=80 ts=4 spell spelllang=en_gb

8
documentation/poky-ref-manual/ref-images.xml
View 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" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<appendix id='ref-images'> <chapter id='ref-images'>
<title>Reference: Images</title> <title>Images</title>
<para> <para>
The OpenEmbedded build process supports several types of images to satisfy different needs. The OpenEmbedded build process supports several types of images to satisfy different needs.
@ -127,7 +127,7 @@
"live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename> "live" to <filename>IMAGE_FSTYPES</filename> within the <filename>local.conf</filename>
file or wherever appropriate and then build the desired image as normal. file or wherever appropriate and then build the desired image as normal.
</tip> </tip>
</appendix> </chapter>
<!-- <!--
vim: expandtab tw=80 ts=4 vim: expandtab tw=80 ts=4
--> -->

2
documentation/poky-ref-manual/ref-variables.xml
View File

@ -785,7 +785,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \
Typically, you configure this variable in image recipes. Typically, you configure this variable in image recipes.
Note that you can add extra features to the image by using the 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. <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> list of features present in images built by the OpenEmbedded build system.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>

4
documentation/poky-ref-manual/usingpoky.xml
View File

@ -62,13 +62,13 @@
Or, the target can be the name of a recipe for a specific piece of software such as Or, the target can be the name of a recipe for a specific piece of software such as
<application>busybox</application>. <application>busybox</application>.
For more details about the images the OpenEmbedded build system supports, see the 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> </para>
<note> <note>
Building an image without GNU Public License Version 3 (GPLv3) components is Building an image without GNU Public License Version 3 (GPLv3) components is
only supported for minimal and base images. 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> </note>
</section> </section>

5
documentation/yocto-project-qs/yocto-project-qs.xml
View File

@ -637,8 +637,9 @@
Where: Where:
&lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile: &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. 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 For information on these types of image profiles, see the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual. "<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: &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
x86, x86-64, ppc, mips, or arm. x86, x86-64, ppc, mips, or arm.