diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-05-31 07:36:26 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-05-31 08:19:21 +0100 |
commit | aeead1fe2d3c239eb0500790e153e9ffba517817 (patch) | |
tree | 702b182de5a71a8bd1668e8616a5e7d52b350cc2 /documentation/ref-manual/usingpoky.xml | |
parent | 2944e0738336edb66d5272fa2e38b382ec101193 (diff) | |
download | ast2050-yocto-poky-aeead1fe2d3c239eb0500790e153e9ffba517817.zip ast2050-yocto-poky-aeead1fe2d3c239eb0500790e153e9ffba517817.tar.gz |
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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/usingpoky.xml')
-rw-r--r-- | documentation/ref-manual/usingpoky.xml | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index 9a98b45..76291f4 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -38,7 +38,7 @@ The <filename>build_dir</filename> is optional and specifies the directory the OpenEmbedded build system uses for the build - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. - 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 <filename>build</filename> in your current working directory. A common practice is to use a different Build Directory for different targets. For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> @@ -117,11 +117,11 @@ </para> <para> - For discussions on debugging, see the + For discussions on debugging, see the "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" - and + and "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working within Eclipse</ulink>" - sections in the Yocto Project Development Manual. + sections in the Yocto Project Development Manual. </para> <section id='usingpoky-debugging-taskfailures'> @@ -156,7 +156,7 @@ Some tasks exist, such as <filename>devshell</filename>, 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 - <filename>-c</filename> option in BitBake. + <filename>-c</filename> option in BitBake. Here is an example: <literallayout class='monospaced'> $ bitbake matchbox-desktop -c devshell @@ -180,7 +180,7 @@ </para> <para> - This sequence first builds and then recompiles + This sequence first builds and then recompiles <filename>matchbox-desktop</filename>. The last command reruns all tasks (basically the packaging tasks) after the compile. BitBake recognizes that the <filename>compile</filename> task was rerun and therefore @@ -240,7 +240,7 @@ build to fail. Following are known, host-specific problems. Be sure to always consult the - <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'>Release Notes</ulink> + <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink> for a look at all release-related issues. <itemizedlist> <listitem><para><emphasis><filename>eglibc-initial</filename> fails to build</emphasis>: @@ -278,9 +278,9 @@ <section id='usingpoky-debugging-variables'> <title>Variables</title> <para> - You can use the <filename>-e</filename> 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 <filename>-e</filename> 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 <filename>-b recipename</filename> form. @@ -395,7 +395,7 @@ <listitem><para>If you want to remove the <filename>psplash</filename> boot splashscreen, add <filename>psplash=false</filename> to the kernel command line. - Doing so prevents <filename>psplash</filename> from loading + Doing so prevents <filename>psplash</filename> 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 @@ <para>At the top level, there is a <filename>metadata-revs</filename> 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 <filename>packages</filename>, <filename>images</filename> and <filename>sdk</filename> 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 <link linkend='var-SRCREV'><filename>SRCREV</filename></link> - is set to - <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. - Here is an example assuming + is set to + <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. + Here is an example assuming <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>): <literallayout class='monospaced'> # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" @@ -578,7 +578,7 @@ command to collect the stored <filename>SRCREV</filename> values from build history and report them in a format suitable for use in global configuration (e.g., <filename>local.conf</filename> - or a distro include file) to override floating + or a distro include file) to override floating <filename>AUTOREV</filename> values to a fixed set of revisions. Here is some example output from this command: <literallayout class='monospaced'> @@ -592,14 +592,14 @@ SRCREV_pn-opkg = "649" </literallayout> <note> - Here are some notes on using the + Here are some notes on using the <filename>buildhistory-collect-srcrevs</filename> command: <itemizedlist> - <listitem><para>By default, only values where the + <listitem><para>By default, only values where the <filename>SRCREV</filename> was not hardcoded (usually when <filename>AUTOREV</filename> was used) are reported. - Use the <filename>-a</filename> option to see all + Use the <filename>-a</filename> option to see all <filename>SRCREV</filename> values. </para></listitem> <listitem><para>The output statements might not have any effect @@ -726,13 +726,13 @@ See the following listing example for more information. </para></listitem> <listitem><para>The following information appears under - each of the <filename>host</filename> - and <filename>target</filename> directories - for the portions of the SDK that run on the host and + each of the <filename>host</filename> + and <filename>target</filename> directories + for the portions of the SDK that run on the host and on the target, respectively: <itemizedlist> <listitem><para><filename>depends.dot:</filename> - Dependency graph for the SDK that is + Dependency graph for the SDK that is compatible with <filename>graphviz</filename>. </para></listitem> <listitem><para><filename>installed-package-names.txt:</filename> @@ -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 </literallayout> Other than <filename>SDKSIZE</filename>, 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. </para> </section> |