Openembedded.org - User contributions [en]

OEandYourDistro

2008-10-19T17:30:24Z

Excogitation: Undo revision 729 by 91.82.174.186 (Talk) because of spam

See [[RequiredSoftware]] for the list of the software required by Openembedded.

= Using OpenEmbedded on Linux systems =

== deb-based distributions ==

The easiest way is via [http://blog.leggewie.org/?p=39 apt-get'able Openembedded] which will pull the OE meta-data for you and keep it up-to-date. Plus, it makes sure all necessary software for cross-compilation is installed. Easy as 1-2-3.

=== Debian ===

==== Mandatory packages ====

It is possible that not all software is available in a recent enough version for etch. Try backports if necessary.

apt-get install ccache sed wget cvs subversion git-core monotone \
coreutils unzip texi2html texinfo libsdl1.2-dev docbook-utils \
gawk python-pysqlite2 diffstat help2man

'''Git'''

On debian you may have to run

update-alternatives --config git (as root)

and select /usr/bin/git-scm to provide git instead of /usr/bin/git.transition. This is not necessary in sid

==== Complementary packages ====

<pre><nowiki>
apt-get install libxml2-utils xmlto python-psyco
</nowiki></pre>

OPTIONAL: these packages and their dependencies need to be installed in order to build the bitbake documentation (warning: over 160MB of installed packages).

<pre><nowiki>
apt-get install docbook
</nowiki></pre>
This package is necessary to build some packages (in particular the esound documentation needs it).

=== Ubuntu ===

Ubuntu is based on Debian and instructions above for [[#deb-based distributions|Debian]] apply here as well. Make sure that you have the universe repositories in your apt configuration.

* Check that /bin/sh (ls -l /bin/sh) is not symbolically linked to dash. "dash" is a POSIX compliant shell that is much smaller than "bash" -- however some broken shell scripts still make use of bash extensions while calling into /bin/sh. To work around this issue call "''sudo dpkg-reconfigure dash''" and select No when it asks you to install dash as /bin/sh.
* You can also install Psyco Python JIT compiler to speed up BitBake. Psyco works on 32-bit x86 platforms only. "''aptitude install python-psyco''
* If you are using Ubuntu version prior to 7.04, you might need to install Monotone [http://www.venge.net/monotone/downloads/monotone-0.40.tar.gz straight from www.monotone.ca], since Monotone shipped with the distribution is not recent enough.

== rpm-based distributions ==

=== Mandriva Linux ===

Follow the Debian instructions, only using `urpmi` instead of `apt-get install`. Also, `ccache` is not an official Mandriva package. You can find it in the contrib section of any Mandriva mirror or seach for it using the Mandriva Club rpm database [http://rpms.mandrakeclub.com]. You may need libpythonV.V-devel for bitbake setup instead of python-dev.
If you're building a 2.6 kernel, you also need the glibc-static-devel package.

with Mandriva Linux 2006, you need to issue the following command:

<pre><nowiki>
urpmi python python-devel python-psyco ccache patch m4 sed bison make wget bzip2 \
cvs gawk glibc-devel gcc-c++ subversion sharutils coreutils docbook-utils openjade \
quilt pcre-devel unzip
</nowiki></pre>

=== openSUSE instructions ===
Install monotone using [http://software.opensuse.org/search?baseproject=ALL&p=1&q=monotone One-Click Install]

Then use zypper to install the rest:

zypper in subversion monotone git python help2man diffstat wget gcc gcc-c++ libstdc++ glibc-devel

These packages may be useful as well: ccache, bison and [http://software.opensuse.org/search?baseproject=ALL&p=1&q=gcc33 gcc33] (for faster build using ASSUME_PROVIDED), gtk2-devel (in case your build will fail on missing gdk-pixbuf-csource), bc (for collie kernel), ncurses-devel (if you want to call kernel menuconfig). python psyco package is optional.

=== Fedora ===

==== Fedora Core 2/3 ====
Much of the following is probably already installed, but you can check with the following commands. You may want to use the yum.conf located at http://www.fedorafaq.org/. Note, this has not been tested yes as I am in the process of setting up a development environment.

<pre><nowiki> yum install python patch m4 sed make docbook* openjade glibc-devel xmlto</nowiki></pre>

* `yum install ccache` (not required, also not a FC3 package)

* psyco: Download psyco-1.4-src.tar.gz (or later) and extract it. Go to the psycho top-level directory and run: `python setup.py install`.

* patch: FC3 default version should be enough. Optionally, install SuSe 9.1 package of it.

==== Fedora Core 4 ====
Almost all required packages for Openembedded are available in Fedora Core 4 and the Fedora Extras for Core 4. You can download them from <http://download.fedora.redhat.com/pub/fedora/linux/core> and <http://download.fedora.redhat.com/pub/fedora/linux/extras>. Check <http://download.fedora.redhat.com/pub/fedora/linux/core/updates/4> for updates on the Core 4 packages.

Apart from the usual (native) development packages like gcc and binutils, you should check that you have the following RPM's installed:

* bison
* ccache (not required, but advised to speed up building)
* docbook* packages
* libpcre
* m4
* make
* openjade
* patch
* PyQt
* python
* python-psyco
* sed
* xmlto
* quilt (not required as OE builds it by itself, but install it if you want to use gquilt)

Use apt, synaptic, up2date or yum to automagically retrieve these packages or download and install them manually (lots of work).

==== Fedora Core 5/6 ====

Commands I used to install OE pre-requisites on FC5/6

This long command will ensure all pre-requisites are installed (patch is 2.5.4, not 2.5.9, but appears to work).

<pre><nowiki>
su -c "yum install python m4 make wget curl ftp cvs monotone subversion tar bzip2 gzip unzip python-psyco ccache perl texinfo texi2html diffstat openjade docbook-style-dsssl docbook-style-xsl docbook-dtds docbook-utils sed bison bc glibc-devel gcc binutils pcre pcre-devel git quilt groff linuxdoc-tools patch gcc gcc-c++ python-sqlite2 help2man"
</nowiki></pre>

or download the metapackage http://www.openembedded.org/dl/packages/rpm/openembedded-essential-1.1-1.noarch.rpm (may be out of date).

then do

<pre><nowiki>
su -c "yum localinstall openembedded-essential-1.1-1.noarch.rpm"
</nowiki></pre>

Update - By some reports monotone 0.32 may be required for some purposes and Fedora Extras currently has 0.31. I downloaded the tarball from http://www.venge.net/monotone/ and rebuilt tthe package by modifying monotone.spec from the Extras src.rpm - YMMV.

Update 2007/04/03 - As of this date, FC6 Extras is offering Monotone 0.33.

There are also rpm and src.rpm packages of bitbake 1.6.2 at http://www.openembedded.org/dl/packages/rpm/ pending a later version in Extras, currently 1.6.0.

Update - Current FC6 version is patch-2.5.4-29.2.2 as of this writing and works-for-me (see revision history for build instructions if current patch does not work for you).

I didn't install SGML tools. Please add if you know how

Update - Since about 2002 sgml-tools has apparently been replaced by linuxdoc-tools for FC.

==== Fedora 7 ====

This long command will ensure all pre-requisites are installed (patch is 2.5.4, not 2.5.9, but appears to work).

<pre><nowiki>
su -c "yum install python m4 make wget curl ftp cvs monotone subversion tar bzip2 gzip unzip python-psyco ccache perl texinfo texi2html diffstat openjade docbook-style-dsssl docbook-style-xsl docbook-dtds docbook-utils sed bison bc glibc-devel gcc binutils pcre pcre-devel git quilt groff linuxdoc-tools patch linuxdoc-tools gcc gcc-c++ help2man"
</nowiki></pre>

(if this is hard to copy from this HTML page, go to edit mode and copy from editor)

=== CentOS 4.4 / Red Hat Enterprise Linux 4 ===
May also work for true EL4 or Scientific Linux - another RHEL rebuild

Even with several optional and 3rd party yum repos enabled (centosplus, kbsingh, RPMforge/Dag, Dries) a number of required packages are too old or unavailable for CentOS4. [It should be possible to use other package managers including apt/synaptic, up2date, and smart to get the required packages. The following assumes yum.]

I re-built the following SRPMS (with "$ rpmbuild --rebuild ..."):
* monotone-0.32-1.src.rpm (latest tarball from http://www.venge.net/monotone/ + modified spec from monotone-0.31-2.fc7.src.rpm)
* boost-1.33.1-10.fc5.src.rpm
* bitbake-1.6.2-1.src.rpm (Latest tarball from http://developer.berlios.de/projects/bitbake/ + modified spec from bitbake-1.6.0-2.fc7.src.rpm)

Might also want to try the rpm and src.rpm packages of bitbake 1.6.2 at http://www.openembedded.org/dl/packages/rpm/ - I have not.

Extra requirements for the builds included rpmdevtools, xmlto, and lynx.

I put packages in a local repo so I can do "yum install ...", otherwise can do "yum localinstall foo.1.2.3.noarch.rpm ...". It may be necessary to temporarily set "gpgcheck=0" in /etc/yum.conf to avoid complaints about unsigned packages.

For EL4 texi2html is available from the tetex package, currently tetex-2.0.2-22.EL4.7

Note that the the metapackage http://www.openembedded.org/dl/packages/rpm/openembedded-essential-1.1-1.noarch.rpm
should work except that it depends on texi2html.

Instead as root do

<pre><nowiki>
# yum install bison ccache coreutils cvs docbook-utils gawk git-core monotone \
python quilt rpmlib sed subversion tetex texinfo unzip wget
</nowiki></pre>

I ended up with the following set of relevant packages after several iterations of building/updating to get "bitbake nano" to complete successfully:

* python-2.3.4-14.3
* m4-1.4.1-16
* make-3.80-6.EL4
* wget-1.10.2-0.40E
* curl-7.12.1-8.rhel4
* ftp-0.17-22
* cvs-1.11.17-9.RHEL4
* monotone-0.32-1
* subversion-1.4.3-0.1.el4.rf
* tar-1.14-12.RHEL4
* bzip2-1.0.2-13.EL4.3
* gzip-1.3.3-16.rhel4
* unzip-5.51-7
* python-psyco-1.5-3.el4.kb
* ccache-2.4-1.2.el4.rf
* perl-5.8.5-36.RHEL4
* texinfo-4.7-5.el4.2
* tetex-2.0.2-22.EL4.7
* diffstat-1.34-0_6.el4.at
* openjade-1.3.2-16_9.el4.at
* docbook-style-dsssl-1.78-4
* docbook-style-xsl-1.65.1-2
* docbook-dtds-1.0-25
* docbook-utils-0.6.14-4
* sed-4.1.2-5.EL4
* bison-1.875c-2
* bc-1.06-17.1
* glibc-devel-2.3.4-2.25
* gcc-3.4.6-3
* binutils-2.15.92.0.2-21
* pcre-4.5-3.2.RHEL4
* pcre-devel-4.5-3.2.RHEL4
* git-1.4.4.2-2.el4.kb
* bitbake-1.6.2-1

== other Linux distributions ==

=== Gentoo instructions ===

On Gentoo 2008.0 the bitbake package is masked, so you'll need to update /etc/portage/package.keywords.

<pre><nowiki>
echo 'dev-embedded/bitbake ~x86' >> /etc/portage/package.keywords
</nowiki></pre>

<pre><nowiki>
emerge -n \
bitbake \
psyco \
ccache \
patch \
make \
sed \
dev-lang/python \
m4 \
bison \
cvs \
openjade \
quilt \
sgmltools-lite \
docbook-xml-dtd \
docbook-dsssl-stylesheets \
xmlto \
docbook-sgml-utils \
libpcre \
boost \
subversion \
monotone \
texi2html
</nowiki></pre>

=== Ark Linux 2007.1 ===
[http://www.arklinux.org/ Ark Linux] is a modern distribution well suited for Openembedded development. Footprint only 2.1G.

Required steps:

1) install required packages
<pre><nowiki>
apt-get install devel-core diffstat texi2html cvs subversion git texinfo psyco monotone python-devel python-encodings python-sqlite
</nowiki></pre>

2) upgrade
<pre><nowiki>
apt-get update
apt-get upgrade

The following packages will be REPLACED:
texi2html (by tetex-texi2html)
The following NEW packages will be installed:
tetex-texi2html
</nowiki></pre>

3) help2man

help2man is missing from the ArkLinux repositories. The [http://www.gnu.org/software/help2man/ sources] must be configured, compiled and installed. The compilation of help2man requires the installation of some additional packages:

apt-get install gettext-devel gettext-tools perl-Locale-gettext

4) finally create your OE tree and provide bitbake (see [[Getting Started]] instructions)

=== Arch Linux (Duke) ===

Most of the packages are available in the repositories.

<pre><nowiki>
sudo pacman -S psyco ccache patch make sed python m4 bison cvs quilt sgmltools-lite docbook-xml xmlto pcre boost monotone jade git texinfo
</nowiki></pre>

In Arch Linux the install command is in /bin/install. Since most of Linux distribution assume that install is located in /usr/bin/install, you have to create a symlink:

<pre><nowiki>
sudo ln -s /bin/install /usr/bin/install
</nowiki></pre>

You can build BitBake by using this PKGBUILD:
<pre><nowiki>
pkgname=bitbake
pkgver=1.8.4
pkgrel=1
pkgdesc="A simple tool for task execution derived from Gentoo's portage"
url="http://developer.berlios.de/projects/bitbake/"
arch=('i686')
license=('GPL' 'custom')
depends=('python')
source=(http://download.berlios.de/bitbake/${pkgname}-${pkgver}.tar.gz)
md5sums=('508d9a61c635d469be8facc95151158b')

build() {
cd ${startdir}/src/${pkgname}-${pkgver}
python setup.py install --root=${startdir}/pkg

# Install vim extensions
install -D -m644 ${startdir}/src/${pkgname}-${pkgver}/contrib/vim/ftdetect/bitbake.vim \
${startdir}/pkg/usr/share/vim/ftplugin/bitbake.vim
install -D -m644 ${startdir}/src/${pkgname}-${pkgver}/contrib/vim/syntax/bitbake.vim \
${startdir}/pkg/usr/share/vim/syntax/bitbake.vim

# Handle MIT license
install -D -m644 ${startdir}/src/${pkgname}-${pkgver}/doc/COPYING.MIT \
${startdir}/pkg/usr/share/licenses/${pkgname}/COPYING.MIT
}
</nowiki></pre>

= Using OpenEmbedded on FreeBSD and other NON Linux Systems =

to be done, maybe there is some information in the [http://oe.linuxtog.org/wiki old wiki]

== FreeBSD ==

* Python == /usr/ports/lang/python
* GNU Patch == /usr/ports/devel/patch
* GNU m4 == /usr/ports/devel/m4
* GNU make == /usr/ports/devel/gmake
* wget == /usr/ports/ftp/wget
* Psyco JIT Compiler == /usr/ports/devel/py-psyco
* ccache == /usr/ports/devel/ccache
* GNU sed == /usr/ports/textproc/gsed
* Bison == /usr/ports/devel/bison
* GCC 2.95.3 == /usr/ports/lang/gcc295
* bc == already in FreeBSD
* PyQt == /usr/ports/x11-toolkits/py-qt
* glibc headers (ignore)
* subversion == /usr/ports/devel/subversion
* git == /usr/ports/devel/git
* pcre == /usr/ports/devel/pcre

Ports has also has these: fileutils, jade, docbook, dsssl-docbook-modular, sgmltools

== Using OpenEmbedded on Mac OS X ==

to be done, maybe there is some information in the [http://oe.linuxtog.org/wiki old wiki]

= Using OpenEmbedded on Windows/Cygwin Systems =

Building Openembedded on Windows is currently unsupported, but [http://oe.linuxtogo.org/wiki/BuildOnCygwin work is in progress] to support buidling of meta-toolchain.bb on Windows/Cygwin hosts.

Getting started with OE-Classic

2008-10-03T20:50:40Z

Excogitation: added a link to the Git page

== Note for OpenMoko Developers ==

[http://www.openmoko.org/ Openmoko] has its own version of BitBake. Openmoko provides their [http://wiki.openmoko.org/wiki/MokoMakefile own setup instructions].

= Introduction =

This page tells you how to get started with Openembedded, i.e. how to install OE and start building packages. Before you proceed, please look at the important bits of [[RequiredSoftware]] that must be installed on your system.

'''IMPORTANT NOTES''': this guide assumes that:

* the base directory of your Openembedded environment is '''/stuff/'''
(As a normal user, you probably want to substitute this with /home/myuser/oe/stuff)
* you selected the '''org.openembedded.dev''' development branch

'''You do not have to be root''' to build packages or distributions with Openembedded. It is even recommended '''to always work as user, not as root'''.

<nowiki>org.openembedded.dev</nowiki> is a development branch, therefore your build will be based on the contents of this development branch which may not be what you intended. See [[DevelopmentBranches]] for other available branches including versioned branches. You might want to use the stable branch, which is called <nowiki>org.openembedded.stable</nowiki>.
One general-purpose distro is Angstrom, well mantained in both stable and development branches. More information about the angstrom project can be found on [http://www.angstrom-distribution.org/ Angstrom homepage]

Again, for the rest of these notes, replace '''/stuff/''' with the base directory of your Openembedded environment and '''org.openembedded.dev''' with the name of the branch that you selected.

= Setting up the toolchain and doing a build =

== Directory Structure ==
The base directory of your Openembedded environment (<nowiki>/stuff/</nowiki>) is the location where sources will be checked out (or unpacked).

* You must choose a location with '''no symlinks above it'''

* If you work in a chrooted environment it is highly recommended to 'su - <username>' after you have chrooted. Otherwise compilation may fail because ccache needs a valid <nowiki>$HOME</nowiki> - which is set when using a user account.

To create the directory structure:

<pre><nowiki>
$ mkdir -p /stuff/build/conf
$ cd /stuff/
</nowiki></pre>

== Obtaining BitBake ==
To start using OE, you must first obtain the build tool it needs: <nowiki>bitbake</nowiki>

It is recommended to run bitbake without installing it, as a sibling directory of <nowiki>org.openembedded.dev/</nowiki> and <nowiki>build/</nowiki> directories. Indeed, as bitbake is written in python it does not need compilation for being used. You'll just have to set the PATH variable so that the [[BitBake]] tools are accessible (see [[#Setup the environment|Setup the environment]] section).

===Using packages===

There is a BitBake package available for more and more distros - see [[OEandYourDistro]].

===Using releases===

Visit [http://developer.berlios.de/projects/bitbake/ BitBake homepage] and download tarball with latest release. For normal usage we suggest using 1.8.x (stable branch) versions. Unpack it to '''/stuff/bitbake/'''.

===Using Subversion===

Go to the base directory of your Openembedded environment and checkout bitbake:
<pre><nowiki>
$ cd /stuff/
$ svn co svn://svn.berlios.de/bitbake/branches/bitbake-1.8/ bitbake</nowiki></pre>
'''NOTE:''' for proxy handling, see [http://subversion.tigris.org/faq.html#proxy SVN FAQ]

==== Updating bitbake ====

Bitbake is being revised fairly often. Periodically it's a good idea to check the repository of [http://svn.berlios.de/viewcvs/bitbake/branches/ bitbake stable branches] to see if a new stable branch is available or if the current branch has been revised. Compare your existing bitbake directory with the latest bitbake branch in the repository. Your existing bitbake branch and its 'last changed revision' number can be found as follows:
<pre><nowiki>
$ cd /stuff/bitbake; svn info
</nowiki></pre>

If there is a new stable branch, you will want to move or delete your existing bitbake directory and repeat the process listed above under "To obtain bitbake". If there is no new branch, it is easy to update bitbake:
<pre><nowiki>
$ cd /stuff/bitbake; svn update
</nowiki></pre>

== Obtaining OpenEmbedded using Monotone ==

''Note: '''OpenEmbedded is in the process of [http://wiki.openembedded.net/index.php/Git moving to git].''' This section will soon be '''obsolete''' and should be replaced. The git repository is at git://git.openembedded.net/org.openembedded.dev.git''

Next, you'll need to obtain the actual Openembedded database. The OE database store all the OE metadata: build classes, configuration files, and packages. Then you can extract from this database the development branch(es) you want.

The Openembedded database is a [http://www.venge.net/monotone/ Monotone] database, which is the current SCM (Source Code Management) system for Openembedded. You can find monotone binaries and documentation at [http://www.venge.net/monotone/ Monotone official site].

To obtain Openembedded:
# Install [http://www.venge.net/monotone/ Monotone] 0.3x (if you have to use an older version of Monotone because of libboost problems, then refer to the [http://www.openembedded.org/user-manual&dpage=ch03s02 Manual] for additional hints).
# Go to the base directory of your Openembedded environment
$ cd /stuff/
# Download and bunzip2 the OE database snapshot. '''Note: Unfortunately some monotone versions differ in database format. Check [http://www.openembedded.org/snapshots Snapshots] and download the one matching your monotone version.'''
$ wget http://www.openembedded.org/snapshots/OE.mtn.bz2
$ bunzip2 -d OE.mtn.bz2
This is the database you'll be using for all the work.

If you run into a problem at this stage, check to make sure you have version 0.32 (or newer) of monotone installed.

If you get further troubles in using monotone, there are two ways out:

* use the [http://openembedded.org/snapshots/ latest OE snapshot]
* use a static monotone image

Then you can checkout your local copy of the Openembedded tree.
$ cd /stuff
$ mtn --db=/stuff/OE.mtn checkout --branch=org.openembedded.dev
This extracts directories and files relating to the selected branch from the OE.mtn database and places them under <nowiki>/stuff/branchname</nowiki> (i.e. in <nowiki>/stuff/org.openembedded.dev</nowiki> in this guide)

If at this stage you get an error that the branch you want to check out has multiple heads, you should do a ''mtn pull'' to update it, and if it isn't fixed '''after pulling''', notify one of the developers to merge it. You should select one head and continue with this howto.

'''Note''': As stated in the introduction, you can of course checkout other branches instead of <nowiki>org.openembedded.dev</nowiki>. See [[DevelopmentBranches]] for more details about existing branches.

=== Updating OE ===
The .dev branch of OE is updated very frequently (as much as several times an hour). The distro branches are not updated as much but still fairly often. It seems good practice to update your OE tree at least daily. To do this, first update your repository's local database (for .dev branch in this example):
$ mtn --db=/stuff/OE.mtn pull monotone.openembedded.org org.openembedded.dev

Then update the branch(es) you are using. This will update the contents of the files in the local database. For example:
$ cd /stuff/org.openembedded.dev && mtn update
$ cd /stuff/org.openembedded.dreambox && mtn update

You may find the [http://www.monotone.ca/docs/CVS-Phrasebook.html#CVS-Phrasebook Monotone PhraseBook] handy for further information on how to use Monotone.

If monotone.openembedded.net is down you can use the following backup monotone servers:

* monotone.nslu2-linux.org
* opensource.wolfsonmicro.com

These mirrors are synchronized at least twice per hour.

== Create local configuration ==
It's now time to create your local configuration.
While you could copy the default local.conf.sample like that:

<pre><nowiki>
$ cd /stuff/
$ cp org.openembedded.dev/conf/local.conf.sample build/conf/local.conf
$ vi build/conf/local.conf
</nowiki></pre>

It is actually recommended to start smaller and keep local.conf.sample in the background and add entries from there step-by-step as you understand and need them. Please, do not just edit build/conf/local.conf.sample but actually READ it.

For building a .dev branch, in your <nowiki>local.conf</nowiki> file, you should have at least the following three entries. Example for the Angstrom distribution and the Openmoko gta01 machine:
<pre><nowiki>
BBFILES = "/stuff/org.openembedded.dev/packages/*/*.bb"
DISTRO = "angstrom-2008.1"
MACHINE = "om-gta01"
</nowiki></pre>

== Setup the environment ==
One of the four command sets below will need to be run every time you open a terminal for development. (You can automate this in ~/.profile, /etc/profile, or perhaps use a script to set the necessary variables for using [[BitBake]].)

If you followed the recommendation above to use an uninstalled [[BitBake]]:
<pre><nowiki>
$ export BBPATH=/stuff/build:/stuff/org.openembedded.dev
$ export PATH=/stuff/bitbake/bin:$PATH
</nowiki></pre>

If you installed [[BitBake]]:
<pre><nowiki>
$ export BBPATH=/stuff/build:/stuff/org.openembedded.dev
</nowiki></pre>

Alternative syntax for those using the tcsh shell (e.g FreeBSD):
<pre><nowiki>
$ setenv PATH "/stuff/bitbake/bin:"$PATH
$ setenv BBPATH "/stuff/build:/stuff/org.openembedded.dev:"$BBPATH
</nowiki></pre>

== Start building ==
The primary interface to the build system is the <nowiki>bitbake</nowiki> command (see the bitbake users manual). <nowiki>bitbake</nowiki> will download and patch stuff from the network, so it helps if you are on a well connected machine.

Note that you should issue all bitbake commands from inside of the <nowiki>build/</nowiki> directory, or you should override TMPDIR to point elsewhere (by default it goes to <nowiki>tmp/</nowiki> relative to the directory you run the tools in).

Here are some example invocations:

Building a single package (e.g. nano):

<pre><nowiki>
$ bitbake nano
</nowiki></pre>

Building package sets (e.g. task-base):

<pre><nowiki>
$ bitbake task-base
</nowiki></pre>

''Special note for'' <nowiki>task-base</nowiki>: you may need additional setup for building this very one task. More details in [[ZaurusKernels]]

Building a group of packages and deploying them into a rootfs image:

GPE:

<pre><nowiki>
$ bitbake gpe-image
</nowiki></pre>

OPIE:

<pre><nowiki>
$ bitbake opie-image
</nowiki></pre>

('''NOTE:''' kergoth says it will take about 4GB of disk space to build an opie or gpe image for one architecture)

See the /stuff/org.openembedded.dev/packages/meta/ directory if you're curious about what meta/task and image targets exist.

Building every package in the repository ('''NOTE:''' This will take a ''very'' long time and needs approx. 35 GB disk space):

<pre><nowiki>
$ bitbake world
</nowiki></pre>

Building a single package, bypassing the long parse step (and therefore its dependencies--use with care):

<pre><nowiki>
$ bitbake -b /stuff/org.openembedded.dev/packages/blah/blah.bb
</nowiki></pre>

See [[UsefulTargets]] for a description of some of the more useful meta-packages. You will typically need at least one of the base images (<nowiki>bootstrap-image</nowiki>, <nowiki>opie-image</nowiki> or <nowiki>gpe-image</nowiki>), and if and only if you're building for an [http://wiki.openzaurus.org/Main_Page OpenZaurus] target requiring an installer image (such as C3000), an additional <nowiki>pivotboot-image</nowiki>.

Output of the build process (temporary files, log files and the binaries) all ends up in the <nowiki>tmp</nowiki> directory. Most interesting is probably the <nowiki>tmp/work/</nowiki> directory. Just have a look around the [[DirectoryStructure]].

Images generated by building package groups like <nowiki>opie-im.mtnage</nowiki> or <nowiki>pivotboot-image</nowiki> are placed in the <nowiki>tmp/deploy/images/</nowiki> directory. Individual ipkg packages are put in <nowiki>tmp/deploy/ipk</nowiki>.

== Adding Packages ==
# Create [[bbfile]].
# Try building it locally.
# Fix eventual problems.
# Send .[[bbfile]] or an [[OePatch]] to the [http://www.openembedded.org/contact openembedded mailing list].

= Problems =
Try to solve problems first by checking that you have done everything right, that nothing has changed from this description and that you have the latest code (see [[MonotonePhraseBook]]). Look also in the log file (referenced in any error message you will receive). If you still have problems, try checking [[PossibleFailures]] and [http://www.openembedded.org/wiki/OeFaq#builderrors common build errors].
Above links are dead, you can try the [[:Category:FAQ]]. If problems persist, ask on [[IRC]] or in the [http://www.openembedded.org/contact openembedded mailing list].

The Openembedded metadata is changing constantly. This implies several things:

# Once you have a "known good" version that works well on your system, keep it! To update, clone a new copy; don't overwrite that working version until it's known to be safe.
# To resolve build problems, "mtn pull ; mtn update" is your good friend. Many times, the issues will already be fixed in the current tree.
# Not all metadata updates cause the local caches to update correctly. Sometimes you'll need to remove the ".../tmp" work directory and rebuild from scratch.
# Similar issues apply to the package sources you download.

= Portability issues =
Make sure to set <nowiki>TARGET_OS</nowiki> to something other than linux in local.conf if your host isn't linux.

GNU extensions to tools are often required. Symlink GNU patch, make, and cp (from fileutils), chmod, sed, find, tar, awk into your OE development path.

FreeBSD 4 users: Perl 5.0 is too old. A more recent perl must be available as <nowiki>/usr/bin/perl</nowiki>. Unfortunately just having more recent perl in the path isn't good enough. Some scripts are hard-coded for <nowiki>/usr/bin/perl</nowiki>. You can test for which perl you're using by typing perl -v. see /usr/ports/UPDATING for instructions on updating perl. Don't forget to do a use.perl port as instructed in /usr/ports/UPDATING

FreeBSD users: Set <nowiki>BUILD_OS</nowiki> in local.conf to freebsdN where N is your major version number. At least the cross gcc wants this.

FreeBSD users: The build process of glibc uses a very long command line at some places. Increase ARG_MAX to at least 131072, by editing /usr/sys/sys/syslimits.h and recompile your kernel (and reboot).

= Productivity notes =
Use the interactive bitbake mode ("bitbake -i") to speed up work when debugging or developing .bb files. Remember to run "parse" at the prompt first. Go!

If you want to save some compile time or are interested in additional tweaks to local.conf take a look at the [[AdvancedConfiguration]] page.