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>

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 
+            Another example specific to the Yocto Project is how to quickly
-            set up your host development system and build an image, which you 
+            set up your host development system and build an image, which you
-            find in the 
+            find in the
             <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
             <note>
                 By default, using the Yocto Project creates a Poky distribution.
@@ -40,7 +40,7 @@
         <para>
             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 <trademark class='trade'>Eclipse</trademark> IDE.
         </para>
     </section>
@@ -53,17 +53,17 @@
             <itemizedlist>
                 <listitem><para>Information that lets you get set
                     up to develop using the Yocto Project.</para></listitem>
-                <listitem><para>Information to help developers who are new to 
+                <listitem><para>Information to help developers who are new to
-                    the open source environment and to the distributed revision 
+                    the open source environment and to the distributed revision
                     control system Git, which the Yocto Project uses.
                     </para></listitem>
-                <listitem><para>An understanding of common end-to-end 
+                <listitem><para>An understanding of common end-to-end
                     development models and tasks.</para></listitem>
                 <listitem><para>Information about common development tasks
-                    generally used during image development for 
+                    generally used during image development for
                     embedded devices.
                     </para></listitem>
-                <listitem><para>Many references to other sources of related 
+                <listitem><para>Many references to other sources of related
                     information.</para></listitem>
             </itemizedlist>
         </para>
@@ -96,7 +96,7 @@
         <title>Other Information</title>
 
         <para>
-            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 @@
                     <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
                     A list of commonly asked questions and their answers.</para></listitem>
                 <listitem><para><emphasis>
-                    <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
+                    <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>:</emphasis>
+                    Features, updates and known issues for the current
                     release of the Yocto Project.</para></listitem>
                 <listitem><para><emphasis>
                     <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>
@@ -148,8 +149,8 @@
                 <listitem><para><emphasis>
                     <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'>
                     Build Appliance</ulink>:</emphasis> A virtual machine that
-                    enables you to build and boot a custom embedded Linux image 
+                    enables you to build and boot a custom embedded Linux image
-                    with the Yocto Project using a non-Linux development system. 
+                    with the Yocto Project using a non-Linux development system.
                     For more information, see the
                     <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink>
                     page.
@@ -166,7 +167,7 @@
                         <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a
                             Yocto Project Discussions mailing list.</para></listitem>
                         <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a
-                            Yocto Project Discussions mailing list about the 
+                            Yocto Project Discussions mailing list about the
                             OpenEmbedded build system (Poky).
                             </para></listitem>
                         <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>

documentation/poky.ent

@@ -1,7 +1,9 @@
 <!ENTITY DISTRO "1.5">
+<!ENTITY DISTRO_COMPRESSED "15">
 <!ENTITY DISTRO_NAME "tbd">
 <!ENTITY YOCTO_DOC_VERSION "1.5">
-<!ENTITY POKYVERSION "tbd">
+<!ENTITY POKYVERSION "10.0.0">
+<!ENTITY POKYVERSION_COMPRESSED "1000">
 <!ENTITY YOCTO_POKY "poky-&DISTRO_NAME;-&POKYVERSION;">
 <!ENTITY COPYRIGHT_YEAR "2010-2013">
 <!ENTITY YOCTO_DL_URL "http://downloads.yoctoproject.org">
@@ -12,6 +14,7 @@
 <!ENTITY YOCTO_AB_URL "http://autobuilder.yoctoproject.org">
 <!ENTITY YOCTO_GIT_URL "http://git.yoctoproject.org">
 <!ENTITY YOCTO_ADTREPO_URL "http://adtrepo.yoctoproject.org">
+<!ENTITY YOCTO_RELEASE_NOTES "&YOCTO_HOME_URL;/download/yocto-project-&DISTRO_COMPRESSED;-poky-&POKYVERSION_COMPRESSED;">
 <!ENTITY OE_HOME_URL "http://www.openembedded.org">
 <!ENTITY OE_LISTS_URL "http://lists.linuxtogo.org/cgi-bin/mailman">
 <!ENTITY OE_DOCS_URL "http://docs.openembedded.org">

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 
+            You can use the <filename>-e</filename> BitBake option to
-            display the resulting environment for a configuration 
+            display the resulting environment for a configuration
-            when you do not specify a package or for a specific package when 
+            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 
+                is set to
-                <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. 
+                <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>.
-                Here is an example assuming 
+                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> 
+                        each of the <filename>host</filename>
-                        and <filename>target</filename> directories 
+                        and <filename>target</filename> directories
-                        for the portions of the SDK that run on the host and 
+                        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 
+                This information is often useful when you are trying to
-                determine why a change in the package or file listings 
+                determine why a change in the package or file listings
                 has occurred.
             </para>
         </section>