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> <title>What You Need and How You Get It</title>
<para> <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> </para>
<itemizedlist> <itemizedlist>
@ -210,8 +211,8 @@
<listitem><para>Python 2.7.3 or greater excluding Python <listitem><para>Python 2.7.3 or greater excluding Python
3.x, which is not supported.</para></listitem> 3.x, which is not supported.</para></listitem>
</itemizedlist> </itemizedlist>
Earlier releases of Python are known to not work and the system Earlier releases of Python are known to not work and the
does not support Python 3 at this time. system does not support Python 3 at this time.
If your system does not meet any of these three listed If your system does not meet any of these three listed
version requirements, you can version requirements, you can
take steps to prepare the system so that you can still use the build take steps to prepare the system so that you can still use the build
@ -331,26 +332,30 @@
<title>Yocto Project Release</title> <title>Yocto Project Release</title>
<para> <para>
You can download the latest Yocto Project release by going to the It is recommended that you get the latest Yocto Project files
<ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink> by setting up (cloning in
clicking "Downloads" in the navigation pane to the left to view all <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> terms) a local
available Yocto Project releases. copy of the
Current and archived releases are available for download to the <filename>poky</filename> Git repository on your host development
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
system. system.
Doing so allows you to contribute back to the Yocto Project project. 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 For information on how to get set up using this method, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
Project Release</ulink>" item in the Yocto Project Development Manual. Project Release</ulink>" item in the Yocto Project Development Manual.
</para> </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>
</section> </section>
@ -364,10 +369,14 @@
<itemizedlist> <itemizedlist>
<listitem> <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>
<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> </listitem>
</itemizedlist> </itemizedlist>
@ -400,13 +409,16 @@
recommend having at least 100GB of free disk space. recommend having at least 100GB of free disk space.
</para></note> </para></note>
<note><para> <note>
By default, the build process searches for source code using a pre-determined order <para>
through a set of locations. By default, the build process searches for source code using
If you encounter problems with the build process finding and downloading source code, see the a pre-determined order through a set of locations.
"<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 If you encounter problems with the build process finding and
firewall or proxy server?</ulink>" in the Yocto Project Reference Manual. downloading source code, see the
</para></note> "<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> <para>
<literallayout class='monospaced'> <literallayout class='monospaced'>
@ -417,16 +429,19 @@
</literallayout> </literallayout>
</para> </para>
<tip><para> <tip>
To help conserve disk space during builds, you can add the following statement <para>
to your project's configuration file, which for this example To help conserve disk space during builds, you can add the
is <filename>&YOCTO_POKY;/build/conf/local.conf</filename>. following statement to your project's configuration file,
Adding this statement deletes the work directory used for building a package which for this example is
once the package is built. <filename>poky/build/conf/local.conf</filename>.
<literallayout class='monospaced'> Adding this statement deletes the work directory used for
building a package once the package is built.
<literallayout class='monospaced'>
INHERIT += "rm_work" INHERIT += "rm_work"
</literallayout> </literallayout>
</para></tip> </para>
</tip>
<itemizedlist> <itemizedlist>
<listitem><para>In the previous example, the first command uses <listitem><para>In the previous example, the first command uses
@ -495,7 +510,7 @@
You can control this configuration by using the 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. <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 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. section in the Yocto Project Reference Manual.
</para> </para>