ref-manual: New section on building buildtools tarball

Fixes YOCTO #4753

This is the main change to address this bug.  It is a new section
that describes how the user can get a buildtools tarball if their
system does not meet the proper Git, tar, and Python versioning.

(From yocto-docs rev: 0493a55c85f050ba29f605ab727e557849242bae)

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 2013-06-28 16:33:28 +03:00 committed by Richard Purdie
parent 222a9cfa34
commit c56c79fd35
1 changed files with 72 additions and 0 deletions

View File

@ -290,6 +290,78 @@
</para>
</section>
</section>
<section id='required-git-tar-and-python-versions'>
<title>Required Git, tar, and Python Versions</title>
<para>
In order to use the build system, your host development system
must meet the following version requirements for Git, tar, and
Python:
<itemizedlist>
<listitem><para>Git 1.7.5 or greater</para></listitem>
<listitem><para>tar 1.24 or greater</para></listitem>
<listitem><para>Python 2.7.3 or greater</para></listitem>
</itemizedlist>
</para>
<para>
If your host development system does not meet all these requirements,
you can resolve this by either downloading a pre-built tarball
containing these tools, or building such a tarball on another
system.
Regardless of the method, once you have the tarball you simply
install it somewhere on you system, such as a directory in your
home directory, and then source the envirnoment script provided,
which adds the tools into <filename>PATH</filename>.
Doing so gives you working versions of Git, tar, Python and
<filename>chrpath</filename>.
</para>
<para>
If downloading a pre-built tarball, locate the
<filename>*.sh</filename> at [NEED A PATH HERE from Beth].
</para>
<para>
If building your own tarball, do so using this command:
<literallayout class='monospaced'>
$ bitbake buildtools-tarball
</literallayout>
<note>
The <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>
variable determines whether you build tools for a 32-bit
or 64-bit system.
</note>
Once the build completes, you can find the file that installs the
the tools in <filename>tmp/deploy/sdk</filename> of the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
The file used to install the tarball has the string "buildtools"
in the name.
</para>
<para>
After you have either built the tarball or downloaded it, you need
to install it.
Install the tools by executing the <filename>*.sh</filename> file.
During execution, a prompt appears that allows you to choose the
installation directory.
For example, you could choose the following:
<literallayout class='monospaced'>
/home/your-username/sdk
</literallayout>
</para>
<para>
The final step before you can actually use the tools is to source
the tools environment with a command like the following:
<literallayout class='monospaced'>
$ source /home/your-username/sdk/environment-setup-i586-poky-linux
</literallayout>
Of course, you need to supply your installation directory and be
sure to use the right file (i.e. i585 or x86-64).
</para>
</section>
</section>
<section id='intro-getit'>