From aeead1fe2d3c239eb0500790e153e9ffba517817 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 31 May 2013 07:36:26 +0300 Subject: [PATCH] dev-manual, ref-manual, poky.ent: Fixed broken Release Note scheme The URL naming convention for the YP Release Notes has changed. It now takes the following form: http://www.yoctoproject.org/download/yoctoproject-15-poky-1000 The above is an example for YP Release 1.5 and poky release 10.0.0. I have set up three new variables in the poky.ent file to somewhat automate the links in the docs to point to the location of a given set of release notes: 1. DISTRO_COMPRESSED - set to the DISTRO string with no period (e.g 15 for 1.5). 2. POKYVERSION_COMPRESSED - set to the poky version with no periods (e.g. 1000 for 10.0.0). 3. YOCTO_RELEASE_NOTES - set to the full-blown release note URL. I made two changes to existing links for the Release Notes. One was in the dev-manual and one was in the ref-manual. (From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-intro.xml | 31 +++++----- documentation/poky.ent | 5 +- documentation/ref-manual/usingpoky.xml | 56 +++++++++---------- 3 files changed, 48 insertions(+), 44 deletions(-) diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index ed1ab07fb1..e213d75950 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -18,11 +18,11 @@ Because much of the information in this manual is general, it contains many references to other sources where you can find more detail. - For example, you can find detailed information on Git, repositories, + For example, you can find detailed information on Git, repositories, and open source in general in many places on the Internet. - Another example specific to the Yocto Project is how to quickly - set up your host development system and build an image, which you - find in the + Another example specific to the Yocto Project is how to quickly + set up your host development system and build an image, which you + find in the Yocto Project Quick Start. By default, using the Yocto Project creates a Poky distribution. @@ -40,7 +40,7 @@ The Yocto Project Development Manual does, however, provide guidance and examples on how to change the kernel source code, - reconfigure the kernel, and develop an application using the + reconfigure the kernel, and develop an application using the popular Eclipse IDE. @@ -53,17 +53,17 @@ Information that lets you get set up to develop using the Yocto Project. - Information to help developers who are new to - the open source environment and to the distributed revision + Information to help developers who are new to + the open source environment and to the distributed revision control system Git, which the Yocto Project uses. - An understanding of common end-to-end + An understanding of common end-to-end development models and tasks. Information about common development tasks - generally used during image development for + generally used during image development for embedded devices. - Many references to other sources of related + Many references to other sources of related information. @@ -96,7 +96,7 @@ Other Information - Because this manual presents overview information for many different + Because this manual presents overview information for many different topics, supplemental information is recommended for full comprehension. The following list presents other sources of information you might find helpful: @@ -139,7 +139,8 @@ FAQ: A list of commonly asked questions and their answers. - Release Notes: Features, updates and known issues for the current + Release Notes: + Features, updates and known issues for the current release of the Yocto Project. @@ -148,8 +149,8 @@ Build Appliance: A virtual machine that - enables you to build and boot a custom embedded Linux image - with the Yocto Project using a non-Linux development system. + enables you to build and boot a custom embedded Linux image + with the Yocto Project using a non-Linux development system. For more information, see the Build Appliance page. @@ -166,7 +167,7 @@ for a Yocto Project Discussions mailing list. for a - Yocto Project Discussions mailing list about the + Yocto Project Discussions mailing list about the OpenEmbedded build system (Poky). diff --git a/documentation/poky.ent b/documentation/poky.ent index 7e12591a74..f6d4d41bc1 100644 --- a/documentation/poky.ent +++ b/documentation/poky.ent @@ -1,7 +1,9 @@ + - + + @@ -12,6 +14,7 @@ + diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 9a98b4560a..76291f4cd3 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -38,7 +38,7 @@ The build_dir is optional and specifies the directory the OpenEmbedded build system uses for the build - the Build Directory. - If you do not specify a Build Directory, it defaults to a directory + If you do not specify a Build Directory, it defaults to a directory named build in your current working directory. A common practice is to use a different Build Directory for different targets. For example, ~/build/x86 for a qemux86 @@ -117,11 +117,11 @@ - For discussions on debugging, see the + For discussions on debugging, see the "Debugging With the GNU Project Debugger (GDB) Remotely" - and + and "Working within Eclipse" - sections in the Yocto Project Development Manual. + sections in the Yocto Project Development Manual.
@@ -156,7 +156,7 @@ Some tasks exist, such as devshell, that are not part of the default build chain. If you wish to run a task that is not part of the default build chain, you can use the - -c option in BitBake. + -c option in BitBake. Here is an example: $ bitbake matchbox-desktop -c devshell @@ -180,7 +180,7 @@ - This sequence first builds and then recompiles + This sequence first builds and then recompiles matchbox-desktop. The last command reruns all tasks (basically the packaging tasks) after the compile. BitBake recognizes that the compile task was rerun and therefore @@ -240,7 +240,7 @@ build to fail. Following are known, host-specific problems. Be sure to always consult the - Release Notes + Release Notes for a look at all release-related issues. eglibc-initial fails to build: @@ -278,9 +278,9 @@
Variables - You can use the -e BitBake option to - display the resulting environment for a configuration - when you do not specify a package or for a specific package when + You can use the -e BitBake option to + display the resulting environment for a configuration + when you do not specify a package or for a specific package when you do specify the package. If you want to show the environment resulting from parsing a single recipe, use the -b recipename form. @@ -395,7 +395,7 @@ If you want to remove the psplash boot splashscreen, add psplash=false to the kernel command line. - Doing so prevents psplash from loading + Doing so prevents psplash from loading and thus allows you to see the console. It is also possible to switch out of the splashscreen by switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). @@ -505,7 +505,7 @@ At the top level, there is a metadata-revs file that lists the revisions of the repositories for the layers enabled - when the build was produced. + when the build was produced. The rest of the data splits into separate packages, images and sdk directories, the contents of which are @@ -560,11 +560,11 @@ system (e.g., Git), a file exists that lists source revisions that are specified in the recipe and lists the actual revisions used during the build. - Listed and actual revisions might differ when + Listed and actual revisions might differ when SRCREV - is set to - ${AUTOREV}. - Here is an example assuming + is set to + ${AUTOREV}. + Here is an example assuming buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev): # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" @@ -578,7 +578,7 @@ command to collect the stored SRCREV values from build history and report them in a format suitable for use in global configuration (e.g., local.conf - or a distro include file) to override floating + or a distro include file) to override floating AUTOREV values to a fixed set of revisions. Here is some example output from this command: @@ -592,14 +592,14 @@ SRCREV_pn-opkg = "649" - Here are some notes on using the + Here are some notes on using the buildhistory-collect-srcrevs command: - By default, only values where the + By default, only values where the SRCREV was not hardcoded (usually when AUTOREV was used) are reported. - Use the -a option to see all + Use the -a option to see all SRCREV values. The output statements might not have any effect @@ -726,13 +726,13 @@ See the following listing example for more information. The following information appears under - each of the host - and target directories - for the portions of the SDK that run on the host and + each of the host + and target directories + for the portions of the SDK that run on the host and on the target, respectively: depends.dot: - Dependency graph for the SDK that is + Dependency graph for the SDK that is compatible with graphviz. installed-package-names.txt: @@ -756,17 +756,17 @@ DISTRO_VERSION = 1.3+snapshot-20130327 SDK_NAME = poky-eglibc-i686-arm SDK_VERSION = 1.3+snapshot - SDKMACHINE = + SDKMACHINE = SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs - BAD_RECOMMENDATIONS = + BAD_RECOMMENDATIONS = SDKSIZE = 352712 Other than SDKSIZE, which is the total size of the files in the SDK in Kbytes, the name-value pairs are variables that might have influenced the content of the SDK. - This information is often useful when you are trying to - determine why a change in the package or file listings + This information is often useful when you are trying to + determine why a change in the package or file listings has occurred.