summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/usingpoky.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-05-31 07:36:26 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-31 08:19:21 +0100
commitaeead1fe2d3c239eb0500790e153e9ffba517817 (patch)
tree702b182de5a71a8bd1668e8616a5e7d52b350cc2 /documentation/ref-manual/usingpoky.xml
parent2944e0738336edb66d5272fa2e38b382ec101193 (diff)
downloadpoky-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.xml56
1 files changed, 28 insertions, 28 deletions
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 @@
38 The <filename>build_dir</filename> is optional and specifies the directory the 38 The <filename>build_dir</filename> is optional and specifies the directory the
39 OpenEmbedded build system uses for the build - 39 OpenEmbedded build system uses for the build -
40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 40 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
41 If you do not specify a Build Directory, it defaults to a directory 41 If you do not specify a Build Directory, it defaults to a directory
42 named <filename>build</filename> in your current working directory. 42 named <filename>build</filename> in your current working directory.
43 A common practice is to use a different Build Directory for different targets. 43 A common practice is to use a different Build Directory for different targets.
44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> 44 For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename>
@@ -117,11 +117,11 @@
117 </para> 117 </para>
118 118
119 <para> 119 <para>
120 For discussions on debugging, see the 120 For discussions on debugging, see the
121 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" 121 "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
122 and 122 and
123 "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working within Eclipse</ulink>" 123 "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working within Eclipse</ulink>"
124 sections in the Yocto Project Development Manual. 124 sections in the Yocto Project Development Manual.
125 </para> 125 </para>
126 126
127 <section id='usingpoky-debugging-taskfailures'> 127 <section id='usingpoky-debugging-taskfailures'>
@@ -156,7 +156,7 @@
156 Some tasks exist, such as <filename>devshell</filename>, that are not part of the 156 Some tasks exist, such as <filename>devshell</filename>, that are not part of the
157 default build chain. 157 default build chain.
158 If you wish to run a task that is not part of the default build chain, you can use the 158 If you wish to run a task that is not part of the default build chain, you can use the
159 <filename>-c</filename> option in BitBake. 159 <filename>-c</filename> option in BitBake.
160 Here is an example: 160 Here is an example:
161 <literallayout class='monospaced'> 161 <literallayout class='monospaced'>
162 $ bitbake matchbox-desktop -c devshell 162 $ bitbake matchbox-desktop -c devshell
@@ -180,7 +180,7 @@
180 </para> 180 </para>
181 181
182 <para> 182 <para>
183 This sequence first builds and then recompiles 183 This sequence first builds and then recompiles
184 <filename>matchbox-desktop</filename>. 184 <filename>matchbox-desktop</filename>.
185 The last command reruns all tasks (basically the packaging tasks) after the compile. 185 The last command reruns all tasks (basically the packaging tasks) after the compile.
186 BitBake recognizes that the <filename>compile</filename> task was rerun and therefore 186 BitBake recognizes that the <filename>compile</filename> task was rerun and therefore
@@ -240,7 +240,7 @@
240 build to fail. 240 build to fail.
241 Following are known, host-specific problems. 241 Following are known, host-specific problems.
242 Be sure to always consult the 242 Be sure to always consult the
243 <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'>Release Notes</ulink> 243 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>
244 for a look at all release-related issues. 244 for a look at all release-related issues.
245 <itemizedlist> 245 <itemizedlist>
246 <listitem><para><emphasis><filename>eglibc-initial</filename> fails to build</emphasis>: 246 <listitem><para><emphasis><filename>eglibc-initial</filename> fails to build</emphasis>:
@@ -278,9 +278,9 @@
278 <section id='usingpoky-debugging-variables'> 278 <section id='usingpoky-debugging-variables'>
279 <title>Variables</title> 279 <title>Variables</title>
280 <para> 280 <para>
281 You can use the <filename>-e</filename> BitBake option to 281 You can use the <filename>-e</filename> BitBake option to
282 display the resulting environment for a configuration 282 display the resulting environment for a configuration
283 when you do not specify a package or for a specific package when 283 when you do not specify a package or for a specific package when
284 you do specify the package. 284 you do specify the package.
285 If you want to show the environment resulting from parsing a single 285 If you want to show the environment resulting from parsing a single
286 recipe, use the <filename>-b recipename</filename> form. 286 recipe, use the <filename>-b recipename</filename> form.
@@ -395,7 +395,7 @@
395 <listitem><para>If you want to remove the <filename>psplash</filename> 395 <listitem><para>If you want to remove the <filename>psplash</filename>
396 boot splashscreen, 396 boot splashscreen,
397 add <filename>psplash=false</filename> to the kernel command line. 397 add <filename>psplash=false</filename> to the kernel command line.
398 Doing so prevents <filename>psplash</filename> from loading 398 Doing so prevents <filename>psplash</filename> from loading
399 and thus allows you to see the console. 399 and thus allows you to see the console.
400 It is also possible to switch out of the splashscreen by 400 It is also possible to switch out of the splashscreen by
401 switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). 401 switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus).
@@ -505,7 +505,7 @@
505 505
506 <para>At the top level, there is a <filename>metadata-revs</filename> file 506 <para>At the top level, there is a <filename>metadata-revs</filename> file
507 that lists the revisions of the repositories for the layers enabled 507 that lists the revisions of the repositories for the layers enabled
508 when the build was produced. 508 when the build was produced.
509 The rest of the data splits into separate 509 The rest of the data splits into separate
510 <filename>packages</filename>, <filename>images</filename> and 510 <filename>packages</filename>, <filename>images</filename> and
511 <filename>sdk</filename> directories, the contents of which are 511 <filename>sdk</filename> directories, the contents of which are
@@ -560,11 +560,11 @@
560 system (e.g., Git), a file exists that lists source revisions 560 system (e.g., Git), a file exists that lists source revisions
561 that are specified in the recipe and lists the actual revisions 561 that are specified in the recipe and lists the actual revisions
562 used during the build. 562 used during the build.
563 Listed and actual revisions might differ when 563 Listed and actual revisions might differ when
564 <link linkend='var-SRCREV'><filename>SRCREV</filename></link> 564 <link linkend='var-SRCREV'><filename>SRCREV</filename></link>
565 is set to 565 is set to
566 <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. 566 <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>.
567 Here is an example assuming 567 Here is an example assuming
568 <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>): 568 <filename>buildhistory/packages/emenlow-poky-linux/linux-yocto/latest_srcrev</filename>):
569 <literallayout class='monospaced'> 569 <literallayout class='monospaced'>
570 # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf" 570 # SRCREV_machine = "b5c37fe6e24eec194bb29d22fdd55d73bcc709bf"
@@ -578,7 +578,7 @@
578 command to collect the stored <filename>SRCREV</filename> values 578 command to collect the stored <filename>SRCREV</filename> values
579 from build history and report them in a format suitable for use in 579 from build history and report them in a format suitable for use in
580 global configuration (e.g., <filename>local.conf</filename> 580 global configuration (e.g., <filename>local.conf</filename>
581 or a distro include file) to override floating 581 or a distro include file) to override floating
582 <filename>AUTOREV</filename> values to a fixed set of revisions. 582 <filename>AUTOREV</filename> values to a fixed set of revisions.
583 Here is some example output from this command: 583 Here is some example output from this command:
584 <literallayout class='monospaced'> 584 <literallayout class='monospaced'>
@@ -592,14 +592,14 @@
592 SRCREV_pn-opkg = "649" 592 SRCREV_pn-opkg = "649"
593 </literallayout> 593 </literallayout>
594 <note> 594 <note>
595 Here are some notes on using the 595 Here are some notes on using the
596 <filename>buildhistory-collect-srcrevs</filename> command: 596 <filename>buildhistory-collect-srcrevs</filename> command:
597 <itemizedlist> 597 <itemizedlist>
598 <listitem><para>By default, only values where the 598 <listitem><para>By default, only values where the
599 <filename>SRCREV</filename> was 599 <filename>SRCREV</filename> was
600 not hardcoded (usually when <filename>AUTOREV</filename> 600 not hardcoded (usually when <filename>AUTOREV</filename>
601 was used) are reported. 601 was used) are reported.
602 Use the <filename>-a</filename> option to see all 602 Use the <filename>-a</filename> option to see all
603 <filename>SRCREV</filename> values. 603 <filename>SRCREV</filename> values.
604 </para></listitem> 604 </para></listitem>
605 <listitem><para>The output statements might not have any effect 605 <listitem><para>The output statements might not have any effect
@@ -726,13 +726,13 @@
726 See the following listing example for more information. 726 See the following listing example for more information.
727 </para></listitem> 727 </para></listitem>
728 <listitem><para>The following information appears under 728 <listitem><para>The following information appears under
729 each of the <filename>host</filename> 729 each of the <filename>host</filename>
730 and <filename>target</filename> directories 730 and <filename>target</filename> directories
731 for the portions of the SDK that run on the host and 731 for the portions of the SDK that run on the host and
732 on the target, respectively: 732 on the target, respectively:
733 <itemizedlist> 733 <itemizedlist>
734 <listitem><para><filename>depends.dot:</filename> 734 <listitem><para><filename>depends.dot:</filename>
735 Dependency graph for the SDK that is 735 Dependency graph for the SDK that is
736 compatible with <filename>graphviz</filename>. 736 compatible with <filename>graphviz</filename>.
737 </para></listitem> 737 </para></listitem>
738 <listitem><para><filename>installed-package-names.txt:</filename> 738 <listitem><para><filename>installed-package-names.txt:</filename>
@@ -756,17 +756,17 @@
756 DISTRO_VERSION = 1.3+snapshot-20130327 756 DISTRO_VERSION = 1.3+snapshot-20130327
757 SDK_NAME = poky-eglibc-i686-arm 757 SDK_NAME = poky-eglibc-i686-arm
758 SDK_VERSION = 1.3+snapshot 758 SDK_VERSION = 1.3+snapshot
759 SDKMACHINE = 759 SDKMACHINE =
760 SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs 760 SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs
761 BAD_RECOMMENDATIONS = 761 BAD_RECOMMENDATIONS =
762 SDKSIZE = 352712 762 SDKSIZE = 352712
763 </literallayout> 763 </literallayout>
764 Other than <filename>SDKSIZE</filename>, which is the 764 Other than <filename>SDKSIZE</filename>, which is the
765 total size of the files in the SDK in Kbytes, the 765 total size of the files in the SDK in Kbytes, the
766 name-value pairs are variables that might have influenced the 766 name-value pairs are variables that might have influenced the
767 content of the SDK. 767 content of the SDK.
768 This information is often useful when you are trying to 768 This information is often useful when you are trying to
769 determine why a change in the package or file listings 769 determine why a change in the package or file listings
770 has occurred. 770 has occurred.
771 </para> 771 </para>
772 </section> 772 </section>