dev-manual, ref-manual: Moved source file sections

The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual.  These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds).  I have integrated that
information into the dev-manual where the information was also being
treated.

(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2018-01-03 12:56:07 -08:00
committed by Richard Purdie
parent 44ea6ded0e
commit 9f478d1358
2 changed files with 65 additions and 70 deletions

View File

@@ -278,9 +278,20 @@
<title>Accessing Source Repositories</title>
<para>
Yocto Project maintains upstream Git
Working from a copy of the upstream Yocto Project
<ulink url='&YOCTO_DOCS_REF_URL;#source-repositories'>Source Repositories</ulink>
that you can examine and access using a browser-based UI:
is the preferred method for obtaining and using a Yocto Project
release.
You can view the Yocto Project Source Repositories at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
In particular, you can find the
<filename>poky</filename> repository at
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/'></ulink>.
</para>
<para>
Use the following procedure to locate the latest upstream copy of
the <filename>poky</filename> Git repository:
<orderedlist>
<listitem><para>
<emphasis>Access Repositories:</emphasis>
@@ -290,8 +301,8 @@
repositories.
</para></listitem>
<listitem><para>
<emphasis>Select a Repository:</emphasis>
Click on any repository in which you are interested (e.g.
<emphasis>Select the Repository:</emphasis>
Click on the repository in which you are interested (i.e.
<filename>poky</filename>).
</para></listitem>
<listitem><para>
@@ -300,14 +311,11 @@
<ulink url='&YOCTO_DOCS_REF_URL;#git-commands-clone'>clone</ulink>
that repository (e.g.
<filename>&YOCTO_GIT_URL;/poky</filename>).
</para></listitem>
<listitem><para>
<emphasis>Examine Change History of the Repository:</emphasis>
At the top of the page, click on any branch in which you
might be interested (e.g.
<filename>&DISTRO_NAME_NO_CAP;</filename>).
You can then view the commit log or tree view for that
development branch.
<note>
For information on cloning a repository, see the
"<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>"
section.
</note>
</para></listitem>
</orderedlist>
</para>
@@ -319,12 +327,12 @@
<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.
Rather than Git repositories, these files are tarballs that
represent snapshots in time of a given component.
<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.
components is to use Git to clone the upstream repository and
work from within that locally cloned repository.
The procedure in this section exists should you desire a
tarball snapshot of any given component.
</note>
@@ -342,8 +350,8 @@
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.
early releases and exists now only for retroactive
completeness.
</note>
</para></listitem>
<listitem><para>
@@ -361,7 +369,7 @@
</para></listitem>
<listitem><para>
<emphasis>Download the Tarball:</emphasis>
Click a tarball to download and save a snapshot of a
Click the tarball to download and save a snapshot of the
given component.
</para></listitem>
</orderedlist>
@@ -398,7 +406,7 @@
</para></listitem>
<listitem><para>
<emphasis>Select the Type of Files:</emphasis>
Click the type of files you want (i.e "Build System",
Click the type of files you want such as "Build System",
"Tools", or "Board Support Packages (BSPs)".
</para></listitem>
<listitem><para>
@@ -410,6 +418,43 @@
</para>
</section>
<section id='accessing-nightly-builds'>
<title>Accessing Nightly Builds</title>
<para>
Yocto Project maintains an area for nightly builds that contains
tarball releases at <ulink url='&YOCTO_AB_NIGHTLY_URL;'/>.
These builds include Yocto Project releases, SDK installation
scripts, and experimental builds.
</para>
<para>
Should you ever want to access a nightly build of a particular
Yocto Project component, use the following procedure:
<orderedlist>
<listitem><para>
<emphasis>Access the Nightly Builds:</emphasis>
Open a browser and go to
<ulink url='&YOCTO_AB_NIGHTLY_URL;'/> to access the
Nightly Builds.
</para></listitem>
<listitem><para>
<emphasis>Select a Build:</emphasis>
Click on any build by date in which you are interested.
</para></listitem>
<listitem><para>
<emphasis>Find the Tarball:</emphasis>
Drill down to find the associated tarball.
</para></listitem>
<listitem><para>
<emphasis>Download the Tarball:</emphasis>
Click the tarball to download and save a snapshot of the
given component.
</para></listitem>
</orderedlist>
</para>
</section>
<section id='cloning-the-poky-repository'>
<title>Cloning the <filename>poky</filename> Repository</title>

View File

@@ -618,56 +618,6 @@
</section>
</section>
<section id='intro-getit'>
<title>Obtaining the Yocto Project</title>
<para>
The Yocto Project development team makes the Yocto Project available through a number
of methods:
<itemizedlist>
<listitem><para><emphasis>Source Repositories:</emphasis>
Working from a copy of the upstream
<filename>poky</filename> repository is the
preferred method for obtaining and using a Yocto Project
release.
You can view the Yocto Project Source Repositories at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>.
In particular, you can find the
<filename>poky</filename> repository at
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/'></ulink>.
</para></listitem>
<listitem><para><emphasis>Releases:</emphasis> Stable, tested
releases are available as tarballs through
<ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
<listitem><para><emphasis>Nightly Builds:</emphasis> These
tarball releases are available at
<ulink url='&YOCTO_AB_NIGHTLY_URL;'/>.
These builds include Yocto Project releases, SDK installation
scripts, and experimental builds.
</para></listitem>
<listitem><para><emphasis>Yocto Project Website:</emphasis> You can
find tarball releases of the Yocto Project and supported BSPs
at the
<ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
Along with these downloads, you can find lots of other
information at this site.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='intro-getit-dev'>
<title>Development Checkouts</title>
<para>
Development using the Yocto Project requires a local
<link linkend='source-directory'>Source Directory</link>.
You can set up the Source Directory by cloning a copy of the upstream
<link linkend='poky'>poky</link> Git repository.
For information on how to do this, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-yocto-project-source-files'>Working With Yocto Project Source Files</ulink>"
section in the Yocto Project Development Tasks Manual.
</para>
</section>
<section id='yocto-project-terms'>
<title>Yocto Project Terms</title>