From 2db4088ceddd65892c718363592c398d37a82d5c Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 16 Jul 2012 10:53:16 -0700 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-prepare.xml | 2 +- documentation/dev-manual/dev-manual-common-tasks.xml | 2 +- documentation/dev-manual/dev-manual-model.xml | 9 ++++----- documentation/dev-manual/dev-manual-newbie.xml | 4 ++-- documentation/dev-manual/dev-manual-start.xml | 5 +++-- documentation/poky-ref-manual/introduction.xml | 8 ++++---- documentation/poky-ref-manual/ref-features.xml | 6 +++--- documentation/poky-ref-manual/ref-images.xml | 8 ++++---- documentation/poky-ref-manual/ref-variables.xml | 2 +- documentation/poky-ref-manual/usingpoky.xml | 4 ++-- documentation/yocto-project-qs/yocto-project-qs.xml | 5 +++-- 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 @@ and are ideal for experimentation using Yocto Project. For information on the image types you can build using the OpenEmbedded build system, see the - "Reference: Images" appendix in + "Images" chapter in The Yocto Project Reference Manual. 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 @@ 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 "Reference: Images" appendix + See the "Images" appendix in the Yocto Project Reference Manual for a description of these images. You can find information on GDB at . 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 @@ here. The build process supports several types of images to satisfy different needs. See the - "Reference: Images" appendix - in The Yocto Project Reference Manual for information on + "Images" chapter + in the Yocto Project Reference Manual for information on supported images. @@ -501,9 +501,8 @@ You can find more information on BitBake here. The build process supports several types of images to satisfy different needs. - See the appendix - "Reference: Images" in - The Yocto Project Reference Manual for information on supported images. + See the "Images" chapter in + the Yocto Project Reference Manual for information on supported images. Make your configuration changes available in the kernel layer: Up to this point, all the configuration changes to the 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 @@ 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 - "Reference: Images" - appendix in The Yocto Project Reference Manual. + "Images" + chapter in the Yocto Project Reference Manual. Layer: A collection of recipes representing the core, a BSP, or an application stack. 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 @@ 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 Reference: Images - section for descriptions of the types of binaries that ship with a Yocto Project + See the Images + chapter in the Yocto Project Reference Manual + for descriptions of the types of binaries that ship with a Yocto Project release. 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 @@ Classes: This chapter describes the classes used in the Yocto Project. - Reference: Images: - This appendix describes the standard images that the Yocto Project supports. + Images: + This chapter describes the standard images that the Yocto Project supports. - Reference: Features: - This appendix describes mechanisms for creating distribution, machine, and image + Features: + This chapter describes mechanisms for creating distribution, machine, and image features during the build process using the OpenEmbedded build system. Reference: Variables Glossary: 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 @@ - %poky; ] > - + Reference: Features @@ -157,7 +157,7 @@ - + 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}", \ Typically, you configure this variable in image recipes. Note that you can add extra features to the image by using the EXTRA_IMAGE_FEATURES variable. - See the "Reference: Images" section for the + See the "Images" chapter for the list of features present in images built by the OpenEmbedded build system. 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 @@ Or, the target can be the name of a recipe for a specific piece of software such as busybox. For more details about the images the OpenEmbedded build system supports, see the - "Reference: Images" appendix. + "Images" chapter. Building an image without GNU Public License Version 3 (GPLv3) components is only supported for minimal and base images. - See the "Reference: Images" appendix for more information. + See the "Images" chapter for more information. 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 @@ Where: <profile> 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 - Reference: Images in the Yocto Project Reference Manual. + For information on these types of image profiles, see the + "Images" chapter + in the Yocto Project Reference Manual. <arch> is a string representing the target architecture: x86, x86-64, ppc, mips, or arm.