[gnome-continuous-yocto/gnomeostree-3.28-rocko: 6688/8267] dev-manual, ref-manual: Added section on index of releases procedure



commit 576af718e62d42040e12c72f37ad4a4d1c24660b
Author: Scott Rifenbark <srifenbark gmail com>
Date:   Thu Jun 22 10:47:55 2017 -0700

    dev-manual, ref-manual: Added section on index of releases procedure
    
    Fixes [YOCTO #11630]
    
    I have added a new procedure on using the Index of Releases area
    to get snapshots of various tarballs.  I recommend that is not
    the way you usually want to get files as using Git is recommended.
    The section exists for completeness.
    
    In the ref-manual, I cross-reference the procedures from the
    associated conceptual areas.
    
    (From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483)
    
    Signed-off-by: Scott Rifenbark <srifenbark gmail com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 documentation/dev-manual/dev-manual-start.xml      |   57 ++++++++++++++++++-
 .../ref-manual/ref-development-environment.xml     |    7 +++
 2 files changed, 61 insertions(+), 3 deletions(-)
---
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 48f49e0..e7049f9 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -270,13 +270,13 @@
         </note>
     </para>
 
-    <section id='viewing-source-repositories-using-your-browser'>
-        <title>Viewing Source Repositories Using Your Browser</title>
+    <section id='accessing-source-repositories'>
+        <title>Accessing Source Repositories</title>
 
         <para>
             Yocto Project maintains upstream Git
             <ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>
-            that you can examine using a browser-based UI:
+            that you can examine and access using a browser-based UI:
             <orderedlist>
                 <listitem><para>
                     Open a browser and go to
@@ -305,6 +305,57 @@
         </para>
     </section>
 
+    <section id='accessing-index-of-releases'>
+        <title>Accessing Index of Releases</title>
+
+        <para>
+            Yocto Project maintains an Index of Releases area that contains
+            related files that contribute to the Yocto Project.
+            Rather than Git repositories, these files represent snapshot
+            tarballs.
+            <note><title>Tip</title>
+                The recommended method for accessing Yocto Project
+                components is to use Git to clone a repository and work from
+                within that local repository.
+                The procedure in this section exists should you desire a
+                tarball snapshot of any given component.
+            </note>
+            <orderedlist>
+                <listitem><para>
+                    Open a browser and go to
+                    <ulink url='&YOCTO_DL_URL;/releases'></ulink> to access the
+                    Index of Releases.
+                    The list represents released components (e.g.
+                    <filename>eclipse-plugin</filename>,
+                    <filename>sato</filename>, and so on).
+                    <note>
+                        The <filename>yocto</filename> directory contains the
+                        full array of released Poky tarballs.
+                        The <filename>poky</filename> directory in the
+                        Index of Releases was historically used for very
+                        early releases and exists for retroactive
+                        completeness only.
+                    </note>
+                    </para></listitem>
+                <listitem><para>
+                    Click on any released component in which you are interested
+                    (e.g. <filename>yocto</filename>).
+                    </para></listitem>
+                <listitem><para>
+                    Drill down to find the associated tarball.
+                    For example, click on <filename>yocto-2.3</filename> to
+                    view files associated with the Yocto Project 2.3
+                    release (e.g. <filename>poky-pyro-17.0.0tar.bz2</filename>,
+                    which is the released Poky tarball).
+                    </para></listitem>
+                <listitem><para>
+                    Click a tarball to download and save a snapshot of a
+                    given component.
+                    </para></listitem>
+            </orderedlist>
+        </para>
+    </section>
+
     <section id='cloning-the-poky-repository'>
         <title>Cloning the <filename>poky</filename> Repository</title>
 
diff --git a/documentation/ref-manual/ref-development-environment.xml 
b/documentation/ref-manual/ref-development-environment.xml
index e47b183..b640f44 100644
--- a/documentation/ref-manual/ref-development-environment.xml
+++ b/documentation/ref-manual/ref-development-environment.xml
@@ -687,6 +687,10 @@
 
                 <para>
                 <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" />
+                For steps on how to view and access these upstream Git
+                repositories, see the
+                "<ulink url='&YOCTO_DOCS_DEV_URL;#accessing-source-repositories'>Accessing Source 
Repositories</ulink>"
+                Section in the Yocto Project Development Manual.
                 </para></listitem>
             <listitem><para><anchor id='index-downloads' />
                 <emphasis>
@@ -703,6 +707,9 @@
 
                 <para>
                 <imagedata fileref="figures/index-downloads.png" align="center" width="6in" depth="3.5in" />
+                For steps on how to view and access these files, see the
+                "<ulink url='&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases'>Accessing Index of 
Releases</ulink>"
+                section in the Yocto Project Development Manual.
                 </para></listitem>
             <listitem><para>
                 <emphasis>"Downloads" page for the


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]