summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-05-31 07:54:47 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-05-31 08:19:26 +0100
commitd78df944e71950d65319fe1fe9f17b0510bb7be0 (patch)
tree8c5c17ef70ec556bb08a090a17ea099844c3a026 /documentation
parentecdd2ec8f47f8f32d3d7c1d83687db65e0801401 (diff)
downloadpoky-d78df944e71950d65319fe1fe9f17b0510bb7be0.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: 437de3f8e299cb040e2a3ceb283aa2d055b605f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml29
-rw-r--r--documentation/poky.ent3
-rw-r--r--documentation/ref-manual/usingpoky.xml54
3 files changed, 45 insertions, 41 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index b0d6386fea..2189c3a8ff 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -18,11 +18,11 @@
18 Because much of the information in this manual is general, it 18 Because much of the information in this manual is general, it
19 contains many references to other sources where you can find more 19 contains many references to other sources where you can find more
20 detail. 20 detail.
21 For example, you can find detailed information on Git, repositories, 21 For example, you can find detailed information on Git, repositories,
22 and open source in general in many places on the Internet. 22 and open source in general in many places on the Internet.
23 Another example specific to the Yocto Project is how to quickly 23 Another example specific to the Yocto Project is how to quickly
24 set up your host development system and build an image, which you 24 set up your host development system and build an image, which you
25 find in the 25 find in the
26 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. 26 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
27 <note> 27 <note>
28 By default, using the Yocto Project creates a Poky distribution. 28 By default, using the Yocto Project creates a Poky distribution.
@@ -40,7 +40,7 @@
40 <para> 40 <para>
41 The Yocto Project Development Manual does, however, provide 41 The Yocto Project Development Manual does, however, provide
42 guidance and examples on how to change the kernel source code, 42 guidance and examples on how to change the kernel source code,
43 reconfigure the kernel, and develop an application using the 43 reconfigure the kernel, and develop an application using the
44 popular <trademark class='trade'>Eclipse</trademark> IDE. 44 popular <trademark class='trade'>Eclipse</trademark> IDE.
45 </para> 45 </para>
46 </section> 46 </section>
@@ -53,17 +53,17 @@
53 <itemizedlist> 53 <itemizedlist>
54 <listitem><para>Information that lets you get set 54 <listitem><para>Information that lets you get set
55 up to develop using the Yocto Project.</para></listitem> 55 up to develop using the Yocto Project.</para></listitem>
56 <listitem><para>Information to help developers who are new to 56 <listitem><para>Information to help developers who are new to
57 the open source environment and to the distributed revision 57 the open source environment and to the distributed revision
58 control system Git, which the Yocto Project uses. 58 control system Git, which the Yocto Project uses.
59 </para></listitem> 59 </para></listitem>
60 <listitem><para>An understanding of common end-to-end 60 <listitem><para>An understanding of common end-to-end
61 development models and tasks.</para></listitem> 61 development models and tasks.</para></listitem>
62 <listitem><para>Information about common development tasks 62 <listitem><para>Information about common development tasks
63 generally used during image development for 63 generally used during image development for
64 embedded devices. 64 embedded devices.
65 </para></listitem> 65 </para></listitem>
66 <listitem><para>Many references to other sources of related 66 <listitem><para>Many references to other sources of related
67 information.</para></listitem> 67 information.</para></listitem>
68 </itemizedlist> 68 </itemizedlist>
69 </para> 69 </para>
@@ -138,7 +138,8 @@
138 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis> 138 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
139 A list of commonly asked questions and their answers.</para></listitem> 139 A list of commonly asked questions and their answers.</para></listitem>
140 <listitem><para><emphasis> 140 <listitem><para><emphasis>
141 <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'>Release Notes</ulink>:</emphasis> Features, updates and known issues for the current 141 <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
142 Features, updates and known issues for the current
142 release of the Yocto Project.</para></listitem> 143 release of the Yocto Project.</para></listitem>
143 <listitem><para><emphasis> 144 <listitem><para><emphasis>
144 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'> 145 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>
@@ -147,8 +148,8 @@
147 <listitem><para><emphasis> 148 <listitem><para><emphasis>
148 <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'> 149 <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'>
149 Build Appliance</ulink>:</emphasis> A virtual machine that 150 Build Appliance</ulink>:</emphasis> A virtual machine that
150 enables you to build and boot a custom embedded Linux image 151 enables you to build and boot a custom embedded Linux image
151 with the Yocto Project using a non-Linux development system. 152 with the Yocto Project using a non-Linux development system.
152 For more information, see the 153 For more information, see the
153 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink> 154 <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink>
154 page. 155 page.
@@ -165,7 +166,7 @@
165 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a 166 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a
166 Yocto Project Discussions mailing list.</para></listitem> 167 Yocto Project Discussions mailing list.</para></listitem>
167 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a 168 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a
168 Yocto Project Discussions mailing list about the 169 Yocto Project Discussions mailing list about the
169 OpenEmbedded build system (Poky). 170 OpenEmbedded build system (Poky).
170 </para></listitem> 171 </para></listitem>
171 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> 172 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
diff --git a/documentation/poky.ent b/documentation/poky.ent
index c1e9de0645..454eefc853 100644
--- a/documentation/poky.ent
+++ b/documentation/poky.ent
@@ -1,7 +1,9 @@
1<!ENTITY DISTRO "1.4.1"> 1<!ENTITY DISTRO "1.4.1">
2<!ENTITY DISTRO_COMPRESSED "141">
2<!ENTITY DISTRO_NAME "dylan"> 3<!ENTITY DISTRO_NAME "dylan">
3<!ENTITY YOCTO_DOC_VERSION "1.4.1"> 4<!ENTITY YOCTO_DOC_VERSION "1.4.1">
4<!ENTITY POKYVERSION "9.0.1"> 5<!ENTITY POKYVERSION "9.0.1">
6<!ENTITY POKYVERSION_COMPRESSED "901">
5<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;"> 7<!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;">
6<!ENTITY COPYRIGHT_YEAR "2010-2013"> 8<!ENTITY COPYRIGHT_YEAR "2010-2013">
7<!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org"> 9<!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org">
@@ -12,6 +14,7 @@
12<!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org"> 14<!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org">
13<!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org"> 15<!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org">
14<!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org"> 16<!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org">
17<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/download/yocto-project-&DISTRO_COMPRESSED;-poky-&POKYVERSION_COMPRESSED;">
15<!ENTITY OE_HOME_URL "http://www.openembedded.org"> 18<!ENTITY OE_HOME_URL "http://www.openembedded.org">
16<!ENTITY OE_LISTS_URL "http://lists.linuxtogo.org/cgi-bin/mailman"> 19<!ENTITY OE_LISTS_URL "http://lists.linuxtogo.org/cgi-bin/mailman">
17<!ENTITY OE_DOCS_URL "http://docs.openembedded.org"> 20<!ENTITY OE_DOCS_URL "http://docs.openembedded.org">
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index d27d6f7a5e..7e05a908a8 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -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>