yocto-project-qs: Added recommendation for cloning YP bits.

I re-cast the section where we describe getting a copy of of the
Yocto Project such that we recommend cloning poky now.

Aside from this change, I found some other minor tweaks that needing
fixing.

(From yocto-docs rev: f10fc4afabddce8bd6296e83c4fecbbbd4683140)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2014-03-13 14:52:34 -06:00 committed by Richard Purdie
parent 65cef19e8a
commit 35e026504e
1 changed files with 51 additions and 36 deletions

View File

@ -159,7 +159,8 @@
<title>What You Need and How You Get It</title>
<para>
You need these things to develop in the Yocto Project environment:
You need these things to develop projects in the Yocto Project
environment:
</para>
<itemizedlist>
@ -210,8 +211,8 @@
<listitem><para>Python 2.7.3 or greater excluding Python
3.x, which is not supported.</para></listitem>
</itemizedlist>
Earlier releases of Python are known to not work and the system
does not support Python 3 at this time.
Earlier releases of Python are known to not work and the
system does not support Python 3 at this time.
If your system does not meet any of these three listed
version requirements, you can
take steps to prepare the system so that you can still use the build
@ -331,26 +332,30 @@
<title>Yocto Project Release</title>
<para>
You can download the latest Yocto Project release by going to the
<ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>
clicking "Downloads" in the navigation pane to the left to view all
available Yocto Project releases.
Current and archived releases are available for download to the
right.
Nightly and developmental builds are also maintained at
<ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
However, for this document a released version of Yocto Project is used.
</para>
<para>
You can also get the Yocto Project files you need by setting up (cloning in Git terms)
a local copy of the <filename>poky</filename> Git repository on your host development
It is recommended that you get the latest Yocto Project files
by setting up (cloning in
<ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> terms) a local
copy of the
<filename>poky</filename> Git repository on your host development
system.
Doing so allows you to contribute back to the Yocto Project project.
For information on how to get set up using this method, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
Project Release</ulink>" item in the Yocto Project Development Manual.
</para>
<para>
You can also get the Yocto Project Files by downloading
Yocto Project releases from the
<ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
From the website, you just click "Downloads" in the navigation pane
to the left to display all Yocto Project downloads.
Current and archived releases are available for download.
Nightly and developmental builds are also maintained at
<ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
However, for this document a released version of Yocto Project is used.
</para>
</section>
</section>
@ -364,10 +369,14 @@
<itemizedlist>
<listitem>
<para>Build an image and run it in the QEMU emulator</para>
<para>
Build an image and run it in the QEMU emulator.
</para>
</listitem>
<listitem>
<para>Use a pre-built image and run it in the QEMU emulator</para>
<para>
Use a pre-built image and run it in the QEMU emulator.
</para>
</listitem>
</itemizedlist>
@ -400,13 +409,16 @@
recommend having at least 100GB of free disk space.
</para></note>
<note><para>
By default, the build process searches for source code using a pre-determined order
through a set of locations.
If you encounter problems with the build process finding and downloading source code, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my
firewall or proxy server?</ulink>" in the Yocto Project Reference Manual.
</para></note>
<note>
<para>
By default, the build process searches for source code using
a pre-determined order through a set of locations.
If you encounter problems with the build process finding and
downloading source code, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?</ulink>"
entry in the Yocto Project Reference Manual FAQ.
</para>
</note>
<para>
<literallayout class='monospaced'>
@ -417,16 +429,19 @@
</literallayout>
</para>
<tip><para>
To help conserve disk space during builds, you can add the following statement
to your project's configuration file, which for this example
is <filename>&YOCTO_POKY;/build/conf/local.conf</filename>.
Adding this statement deletes the work directory used for building a package
once the package is built.
<literallayout class='monospaced'>
<tip>
<para>
To help conserve disk space during builds, you can add the
following statement to your project's configuration file,
which for this example is
<filename>poky/build/conf/local.conf</filename>.
Adding this statement deletes the work directory used for
building a package once the package is built.
<literallayout class='monospaced'>
INHERIT += "rm_work"
</literallayout>
</para></tip>
</literallayout>
</para>
</tip>
<itemizedlist>
<listitem><para>In the previous example, the first command uses
@ -495,7 +510,7 @@
You can control this configuration by using the
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
For additional package manager selection information, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'><filename>package*.bbclass</filename></ulink>"
section in the Yocto Project Reference Manual.
</para>