sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

yocto-project-qs: Updated the "Super User" section for no tarballs 

Fixes [YOCTO #5368]

Partial fix for this issue.  This section had two options for
setting up the Source Directory (tarball and cloned repo).  I
removed the tarball option.

Also, I did some routine formatting as well as verified that
the example runs on a more recent Linux distro.  Previously, the
example was confirmed and stated that it ran on 10.04 Ubuntu.
Well, this distro is not even in the supported list any longer
so I ran it on a 12.04 Ubuntu machine and stated that.

(From yocto-docs rev: 1203e083ec8f7ac91bd832a27273ab4afc5aa4c8)

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-10-24 08:42:21 -07:00 committed by Richard Purdie
parent 458cc5cc21
commit 524f1f5bf8
1 changed files with 41 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
documentation/yocto-project-qs/yocto-project-qs.xml
View File

@ -804,29 +804,23 @@
</footnote>
gives you a minimal description of how to use the Yocto Project to build images
for a BeagleBoard xM starting from scratch.
The steps were performed on a 64-bit Ubuntu 10.04 system.
The steps were performed on a 64-bit Ubuntu 12.04 system.
</para>
<section id='getting-yocto'>
<title>Getting the Yocto Project</title>
<para>
Set up your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
one of two ways:
<itemizedlist>
<listitem><para><emphasis>Tarball:</emphasis>
Use if you want the latest stable release:
<literallayout class='monospaced'>
$ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
$ tar xvjf &YOCTO_POKY_TARBALL;
</literallayout></para></listitem>
<listitem><para><emphasis>Git Repository:</emphasis>
Use if you want to work with cutting edge development content:
<literallayout class='monospaced'>
Set up your
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
by using Git to clone the <filename>poky</filename> poky
repository and then check out the release branch:
<literallayout class='monospaced'>
$ cd ~
$ git clone git://git.yoctoproject.org/poky
</literallayout></para></listitem>
</itemizedlist>
The remainder of the section assumes the Git repository method.
$ cd poky
$ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
</literallayout>
</para>
</section>
@ -835,7 +829,8 @@
<para>
You need some packages for everything to work.
Rather than duplicate them here, look at the "<link linkend='packages'>The Packages</link>"
Rather than duplicate them here, look at the
"<link linkend='packages'>The Packages</link>"
section earlier in this quick start.
</para>
</section>
@ -844,17 +839,18 @@
<title>Initializing the Build Environment</title>
<para>
From the parent directory your
From the root directory of your
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
initialize your environment and provide a meaningful
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
name:
<literallayout class='monospaced'>
$ source poky/&OE_INIT_FILE; mybuilds
$ source &OE_INIT_FILE; mybuilds
</literallayout>
At this point, the <filename>mybuilds</filename> directory has been created for you
and it is now your current working directory.
If you don't provide your own directory name it defaults to <filename>build</filename>,
At this point, the <filename>mybuilds</filename> directory has
been created for you and it is now your current working directory.
If you don't provide your own directory name,
it defaults to <filename>build</filename>,
which is inside the Source Directory.
</para>
</section>
@ -863,18 +859,21 @@
<title>Configuring the local.conf File</title>
<para>
Initializing the build environment creates a <filename>conf/local.conf</filename> configuration file
Initializing the build environment creates a
<filename>conf/local.conf</filename> configuration file
in the Build Directory.
You need to manually edit this file to specify the machine you are building and to optimize
your build time.
You need to manually edit this file to specify the machine you
are building and to optimize your build time.
Here are the minimal changes to make:
<literallayout class='monospaced'>
BB_NUMBER_THREADS = "8"
PARALLEL_MAKE = "-j 8"
MACHINE ?= "beagleboard"
</literallayout>
Briefly, set <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
and <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to
Briefly, set
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
and
<ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to
twice your host processor's number of cores.
</para>
@ -924,9 +923,10 @@
<title>Building the Image</title>
<para>
At this point, you need to select an image to build for the BeagleBoard xM.
If this is your first build using the Yocto Project, you should try the smallest and simplest
image:
At this point, you need to select an image to build for the
BeagleBoard xM.
If this is your first build using the Yocto Project, you should try
the smallest and simplest image:
<literallayout class='monospaced'>
$ bitbake core-image-minimal
</literallayout>
@ -936,15 +936,18 @@
<para>
Here are some variations on the build process that could be helpful:
<itemizedlist>
<listitem><para>Fetch all the necessary sources without starting the build:
<listitem><para>Fetch all the necessary sources without starting
the build:
<literallayout class='monospaced'>
$ bitbake -c fetchall core-image-minimal
</literallayout>
This variation guarantees that you have all the sources for that BitBake target
should you disconnect from the net and want to do the build later offline.
</para></listitem>
<listitem><para>Specify to continue the build even if BitBake encounters an error.
By default, BitBake aborts the build when it encounters an error.
This variation guarantees that you have all the sources for
that BitBake target should you disconnect from the net and
want to do the build later offline.</para></listitem>
<listitem><para>Specify to continue the build even if BitBake
encounters an error.
By default, BitBake aborts the build when it encounters an
error.
This command keeps a faulty build going:
<literallayout class='monospaced'>
$ bitbake -k core-image-minimal
@ -953,7 +956,8 @@
</para>
<para>
Once you have your image, you can take steps to load and boot it on the target hardware.
Once you have your image, you can take steps to load and boot it on
the target hardware.
</para>
</section>
</section>