1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 13:09:50 +00:00

documentation: dev-manual - Edits to setup part of example

Minor edits to the part of the example that sets up for the
first core-image-minimal build.  Put in the variable to use
for the build environment setup script, updated some changed
output from some of the commands, etc.

(From yocto-docs rev: 0b4b2ddf9a78a9d6d218ed9a6f0acd3e876d9581)

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
2012-10-04 10:13:42 -07:00
committed by Richard Purdie
parent c1261f843e
commit 0a4f7521bb
2 changed files with 48 additions and 19 deletions
@@ -76,16 +76,18 @@
<listitem><para><emphasis>Local Source Directory:</emphasis> <listitem><para><emphasis>Local Source Directory:</emphasis>
This area contains all the metadata that supports building images This area contains all the metadata that supports building images
using the OpenEmbedded build system. using the OpenEmbedded build system.
In this example, the Source Directory also In this example, the
contains the build directory, which contains the configuration directory <link linkend='source-directory'>Source Directory</link> also
contains the
<link linkend='build-directory'>Build Directory</link>,
which contains the configuration directory
that lets you control the build. that lets you control the build.
Also in this example, the Source Directory contains local copies of the Also in this example, the Source Directory contains local copies of the
<filename>poky-extras</filename> Git repository.</para> <filename>poky-extras</filename> Git repository.</para>
<para>See the bulleted item <para>See the bulleted item
"<link linkend='local-yp-release'>Yocto Project Release</link>" "<link linkend='local-yp-release'>Yocto Project Release</link>"
for information on how to get these files on your local system.</para></listitem> for information on how to get these files on your local system.</para></listitem>
<listitem><para><emphasis>Local copies of the<filename>poky-extras</filename> <listitem><para><emphasis>Local copies of the&nbsp;<filename>poky-extras</filename>&nbsp;Git Repository:</emphasis>
Git Repository:</emphasis>
This area contains the <filename>meta-kernel-dev</filename> layer, This area contains the <filename>meta-kernel-dev</filename> layer,
which is where you make changes that append the kernel build recipes. which is where you make changes that append the kernel build recipes.
You edit <filename>.bbappend</filename> files to locate your You edit <filename>.bbappend</filename> files to locate your
@@ -132,7 +134,9 @@
<title>Setting Up the Local Source Directory</title> <title>Setting Up the Local Source Directory</title>
<para> <para>
You can set up the Source Directory through tarball extraction or by You can set up the
<link linkend='source-directory'>Source Directory</link>
through tarball extraction or by
cloning the <filename>poky</filename> Git repository. cloning the <filename>poky</filename> Git repository.
This example uses <filename>poky</filename> as the root directory of the This example uses <filename>poky</filename> as the root directory of the
local Source Directory. local Source Directory.
@@ -179,11 +183,12 @@
Because this example uses the Yocto Project &DISTRO; Release code Because this example uses the Yocto Project &DISTRO; Release code
named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename> named "&DISTRO_NAME;", which maps to the <filename>&DISTRO_NAME;</filename>
branch in the repository, you need to be sure you are using that branch in the repository, you need to be sure you are using that
branch for <filename>poky-extra</filename>. branch for <filename>poky-extras</filename>.
The following commands create and checkout the local The following commands create and checkout the local
branch you are using for the <filename>&DISTRO_NAME;</filename> branch you are using for the <filename>&DISTRO_NAME;</filename>
branch: branch:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ cd ~/poky/poky-extras
$ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME;
Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin. Branch &DISTRO_NAME; set up to track remote branch &DISTRO_NAME; from origin.
Switched to a new branch '&DISTRO_NAME;' Switched to a new branch '&DISTRO_NAME;'
@@ -195,7 +200,7 @@
<title>Setting Up the Bare Clone and its Copy</title> <title>Setting Up the Bare Clone and its Copy</title>
<para> <para>
This example modifies the <filename>linux-yocto-3.2</filename> kernel. This example modifies the <filename>linux-yocto-3.4</filename> kernel.
Thus, you need to create a bare clone of that kernel and then make a copy of the Thus, you need to create a bare clone of that kernel and then make a copy of the
bare clone. bare clone.
See the bulleted item See the bulleted item
@@ -207,17 +212,16 @@
The bare clone exists for the kernel build tools and simply as the receiving end The bare clone exists for the kernel build tools and simply as the receiving end
of <filename>git push</filename> of <filename>git push</filename>
commands after you make edits and commits inside the copy of the clone. commands after you make edits and commits inside the copy of the clone.
The copy (<filename>my-linux-yocto-3.2-work</filename> in this example) has to have The copy (<filename>my-linux-yocto-3.4-work</filename> in this example) has to have
a local branch created and checked out for your work. a local branch created and checked out for your work.
This example uses <filename>common-pc-base</filename> as the local branch. This example uses <filename>common-pc-base</filename> as the local branch.
The following commands create and checkout the branch: The following commands create and checkout the branch:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ cd ~/my-linux-yocto-3.2-work $ cd ~/my-linux-yocto-3.4-work
$ git checkout -b common-pc-base origin/standard/default/common-pc/base $ git checkout -b standard-common-pc-base origin/standard/common-pc/base
Checking out files: 100% (532/532), done. Branch standard-common-pc-base set up to track remote branch
Branch common-pc-base set up to track remote branch standard/common-pc/base from origin.
standard/default/common-pc/base from origin. Switched to a new branch 'standard-common-pc-base'
Switched to a new branch 'common-pc-base'
</literallayout> </literallayout>
</para> </para>
</section> </section>
@@ -249,11 +253,36 @@
If necessary, the script creates the build directory: If necessary, the script creates the build directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ cd ~/poky $ cd ~/poky
$ source oe-init-build-env $ source &OE_INIT_FILE;
You had no conf/local.conf file. This configuration file has therefore been
created for you with some default values. You may wish to edit it to use a
different MACHINE (target hardware) or enable parallel build options to take
advantage of multiple cores for example. See the file for more information as
common configuration options are commented.
### Shell environment set up for builds. ### The Yocto Project has extensive documentation about OE including a reference manual
which can be found at:
http://yoctoproject.org/documentation
You can now run 'bitbake &lt;target&gt;' For more information about OpenEmbedded see their website:
http://www.openembedded.org/
You had no conf/bblayers.conf file. The configuration file has been created for
you with some default values. To add additional metadata layers into your
configuration please add entries to this file.
The Yocto Project has extensive documentation about OE including a reference manual
which can be found at:
http://yoctoproject.org/documentation
For more information about OpenEmbedded see their website:
http://www.openembedded.org/
### Shell environment set up for builds. ###
You can now run 'bitbake &lt;target&gt;>'
Common targets are: Common targets are:
core-image-minimal core-image-minimal
@@ -152,8 +152,8 @@
<para>Now create a clone of the bare clone just created: <para>Now create a clone of the bare clone just created:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work $ git clone linux-yocto-3.4.git my-linux-yocto-3.4-work
Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.4-work/.git/ Cloning into 'my-linux-yocto-3.4-work'...
Checking out files: 100% (37619/37619), done. done.
</literallayout></para></listitem> </literallayout></para></listitem>
<listitem id='poky-extras-repo'><para><emphasis> <listitem id='poky-extras-repo'><para><emphasis>
The <filename>poky-extras</filename> Git Repository</emphasis>: The <filename>poky-extras</filename> Git Repository</emphasis>: