PUBLIC_REPOS
/
buildroot
зеркало из git://git.buildroot.net/buildroot


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093
							<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <title>Buildroot - Usage and documentation</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>

<body>
  <div class="main">
    <div class="titre">
      <h1>Buildroot</h1>
    </div>

    <p><a href="http://buildroot.net/">Buildroot</a>
    usage and documentation by Thomas Petazzoni. Contributions from
    Karsten Kruse, Ned Ludd, Martin Herren and others. </p>

    <ul>

      <li><a href="#about">About Buildroot</a></li>
      <li><a href="#download">Obtaining Buildroot</a></li>
      <li><a href="#using">Using Buildroot</a></li>
      <li><a href="#custom_targetfs">Customizing the generated target filesystem</a></li>
      <li><a href="#custom_busybox">Customizing the Busybox
      configuration</a></li>
      <li><a href="#custom_uclibc">Customizing the uClibc
      configuration</a></li>
      <li><a href="#rebuilding_packages">Understanding how to rebuild packages</a></li>
      <li><a href="#buildroot_innards">How Buildroot works</a></li>
      <li><a href="#using_toolchain">Using the uClibc toolchain
      outside Buildroot</a></li>
      <li><a href="#external_toolchain">Use an external toolchain</a></li>
      <li><a href="#downloaded_packages">Location of downloaded packages</a>
      </li>
      <li><a href="#add_software">Extending Buildroot with more
      Software</a></li>
      <li><a href="#board_support">Creating your own board support</a></li>
      <li><a href="#links">Resources</a></li>
    </ul>

    <h2><a name="about" id="about"></a>About Buildroot</h2>

    <p>Buildroot is a set of Makefiles and patches that allow to
    easily generate a cross-compilation toolchain, a root filesystem
    and a Linux kernel image for your target. Buildroot can be used
    for either one, two or all of these options, independently.</p>

    <p>Buildroot is useful mainly for people working with embedded systems.
    Embedded systems often use processors that are not the regular x86
    processors everyone is used to have on his PC. It can be PowerPC
    processors, MIPS processors, ARM processors, etc. </p>

    <p>A compilation toolchain is the set of tools that allows to
    compile code for your system. It consists of a compiler (in our
    case, <code>gcc</code>), binary utils like assembler and linker
    (in our case, <code>binutils</code>) and a C standard library (for
    example <a href="http://www.gnu.org/software/libc/libc.html">GNU
    Libc</a>, <a href="http://www.uclibc.org/">uClibc</a> or <a
    href="http://www.fefe.de/dietlibc/">dietlibc</a>). The system
    installed on your development station certainly already has a
    compilation toolchain that you can use to compile application that
    runs on your system. If you're using a PC, your compilation
    toolchain runs on an x86 processor and generates code for a x86
    processor. Under most Linux systems, the compilation toolchain
    uses the GNU libc as C standard library.  This compilation
    toolchain is called the &quot;host compilation toolchain&quot;, and more
    generally, the machine on which it is running, and on which you're
    working is called the &quot;host system&quot;. The compilation toolchain
    is provided by your distribution, and Buildroot has nothing to do
    with it. </p>

    <p>As said above, the compilation toolchain that comes with your system
    runs and generates code for the processor of your host system. As your
    embedded system has a different processor, you need a cross-compilation
    toolchain: it's a compilation toolchain that runs on your host system but
    that generates code for your target system (and target processor). For
    example, if your host system uses x86 and your target system uses ARM, the
    regular compilation toolchain of your host runs on x86 and generates code
    for x86, while the cross-compilation toolchain runs on x86 and generates
    code for ARM. </p>

    <p>Even if your embedded system uses a x86 processor, you might interested
    in Buildroot, for two reasons:</p>

    <ul>
      <li>The compilation toolchain of your host certainly uses the GNU Libc
      which is a complete but huge C standard library. Instead of using GNU
      Libc on your target system, you can use uClibc which is a tiny C standard
      library. If you want to use this C library, then you need a compilation
      toolchain to generate binaries linked with it. Buildroot can do it for
      you. </li>

      <li>Buildroot automates the building of a root filesystem with all needed
      tools like busybox. It makes it much easier than doing it by hand. </li>
    </ul>

    <p>You might wonder why such a tool is needed when you can compile
    <code>gcc</code>, <code>binutils</code>, uClibc and all the tools by hand.
    Of course, doing so is possible. But dealing with all configure options,
    with all problems of every <code>gcc</code> or <code>binutils</code>
    version it very time-consuming and uninteresting. Buildroot automates this
    process through the use of Makefiles, and has a collection of patches for
    each <code>gcc</code> and <code>binutils</code> version to make them work
    on most architectures. </p>

    <p>Moreover, Buildroot provides an infrastructure for reproducing
    the build process of your embedded root filesystem. Being able to
    reproduce the build process will be useful when a component needs
    to be patched or updated, or when another person is supposed to
    take over the project.</p>

    <h2><a name="download" id="download"></a>Obtaining Buildroot</h2>

    <p>Buildroot releases are made approximately every 3
    months. Direct Git access and daily snapshots are also
    available if you want more bleeding edge.</p>

    <p>Releases are available at <a
    href="http://buildroot.net/downloads/">http://buildroot.net/downloads/</a>.</p>

    <p>The latest snapshot is always available at <a
    href="http://buildroot.net/downloads/snapshots/buildroot-snapshot.tar.bz2">http://buildroot.net/downloads/snapshots/buildroot-snapshot.tar.bz2</a>,
    and previous snapshots are also available at <a
    href="http://buildroot.net/downloads/snapshots/">http://buildroot.net/downloads/snapshots/</a>. </p>

    <p>To download Buildroot using Git, you can simply follow
    the rules described on the &quot;Accessing Git&quot;-page (<a href=
    "http://buildroot.net/git.html">http://buildroot.net/git.html</a>)
    of the Buildroot website (<a href=
    "http://buildroot.net">http://buildroot.net</a>), and download
    <code>buildroot</code> from Git. For the impatient, here's a quick
    recipe:</p>

 <pre>
 $ git clone git://git.buildroot.net/buildroot
</pre>

    <h2><a name="using" id="using"></a>Using Buildroot</h2>

    <p>Buildroot has a nice configuration tool similar to the one you can find
    in the Linux Kernel (<a href=
    "http://www.kernel.org/">http://www.kernel.org/</a>) or in Busybox
    (<a href="http://www.busybox.org/">http://www.busybox.org/</a>). Note that
    you can build everything as a normal user. There is no need to be root to
    configure and use Buildroot. The first step is to run the configuration
    assistant:</p>

<pre>
 $ make menuconfig
</pre>

<p>to run the curses-based configurator, or</p>

<pre>
 $ make xconfig
</pre>

    <p>to run the Qt3-based configurator. On Debian-like systems, the
    <code>libncurses5-dev</code> package is required to use the
    <i>menuconfig</i> interface, and the <code>libqt3-mt-dev</code> is
    required to use the <i>xconfig</i> interface.</p>

    <p>For each entry of the configuration tool, you can find associated help
    that describes the purpose of the entry. </p>

    <p>Once everything is configured, the configuration tool has generated a
    <code>.config</code> file that contains the description of your
    configuration. It will be used by the Makefiles to do what's needed. </p>


    <p>Let's go:</p>

<pre>
 $ make
</pre>

    <p>This command will download, configure and compile all the
    selected tools, and finally generate a toolchain, a root
    filesystem image and a kernel image (or only one of these
    elements, depending on the configuration).</p>

    <p>Buildroot output is stored in a single directory,
    <code>output/</code>. This directory contains several
    subdirectories:</p>

    <ul>

      <li><code>images/</code> where all the images (kernel image,
      bootloader and root filesystem images) are stored.</li>

      <li><code>build/</code> where all the components are built
      (tools needed to run Buildroot on the host and packages compiled
      for the target). The <code>build/</code> directory contains one
      subdirectory for each of these components. The toolchain
      components are however built in a separate directory.</li>

      <li><code>staging/</code> which contains a hierarchy similar to
      a root filesystem hierarchy. This directory contains the
      installation of cross-compilation toolchain and all the
      userspace packages selected for the target. However, this
      directory is <i>not</i> intended to be the root filesystem for
      the target: it contains a lot of development files, unstripped
      binaries and libraries, that make it far too big for an embedded
      system.</li>

      <li><code>target/<code> which contains the root filesystem for
      the target. Only the necessary files to run the libraries and
      applications are installed in this directory. However,
      <code>target/dev/</code> doesn't contain the device files, as
      creating device files requires the root access. The device files
      only exist in the root filesystem image produced by
      Buildroot.</li>

      <li><code>host/</code> contains the installation of tools
      compiled for the host that are needed for the proper execution
      of Buildroot.</li>

      <li><code>toolchain/</code> contains the build directories for
      the various components of the cross-compilation toolchain.</li>

    </ul>

    <h3><a name="offline_builds" id="offline_builds"></a>
    Offline builds</h3>

    <p>If you intend to do an offline-build and just want to download
    all sources that you previously selected in the configurator
    (<i>menuconfig</i> or <i>xconfig</i>) then issue:</p>
<pre>
 $ make source
</pre>
    <p>You can now disconnect or copy the content of your <code>dl</code>
    directory to the build-host. </p>

    <h3><a name="building_out_of_tree" id="building_out_of_tree"></a>
    Building out-of-tree</h3>

    <p>Buildroot supports building out of tree with a syntax similar
    to the Linux kernel. To use it, add O=&lt;directory&gt; to the
    make command line, E.G.:</p>

<pre>
 $ make O=/tmp/build
</pre>

    <p>And all the output files will be located under
    <code>/tmp/build</code>.</p>

    <h3><a name="environment_variables" id="environment_variables"></a>
    Environment variables</h3>

    <p>Buildroot optionally honors some environment variables that are passed
    to <code>make</code> :</p>
    <ul>
    <li><code>HOSTCXX</code>, the host C++ compiler to use</li>
    <li><code>HOSTCC</code>, the host C compiler to use</li>
    <li><code>UCLIBC_CONFIG_FILE=&lt;path/to/.config&gt;</code>, path
    to the uClibc configuration file to use to compile uClibc if an
    internal toolchain is selected</li>
    <li><code>BUSYBOX_CONFIG_FILE=&lt;path/to/.config&gt;</code>, path
    to the Busybox configuration file</li>
    <li><code>BUILDROOT_COPYTO</code>, an additional location at which
    the binary images of the root filesystem, kernel, etc. built by
    Buildroot are copied</li>
    <li><code>BUILDROOT_DL_DIR</code> to override the directory in
    which Buildroot stores/retrieves downloaded files</li>
    </ul>

    <p>An example that uses config files located in the toplevel directory and
    in your $HOME:</p>
<pre>
$ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config
</pre>

    <p>If you want to use a compiler other than the default <code>gcc</code>
    or <code>g++</code> for building helper-binaries on your host, then do</p>
<pre>
$ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
</pre>

    <p>If you want the result of your build to be copied to another directory
    like /tftpboot for downloading to a board using tftp, then you
    can use BUILDROOT_COPYTO to specify your location</p>
    <p>Typically, this is set in your ~/.bashrc file

<pre>
$ export BUILDROOT_COPYTO=/tftpboot
</pre>

    <h2><a name="custom_targetfs" id="custom_targetfs"></a>Customizing the
    generated target filesystem</h2>

    <p>There are a few ways to customize the resulting target filesystem:</p>

    <ul>
      <li>Customize the target filesystem directly, and rebuild the image. The
      target filesystem is available under <code>output/target/</code>.
      You can simply make your changes here, and run make afterwards, which will
      rebuild the target filesystem image. This method allows to do everything
      on the target filesystem, but if you decide to completely rebuild your
      toolchain and tools, these changes will be lost. </li>

      <li>Customize the target filesystem skeleton, available under
      <code>target/generic/target_skeleton/</code>. You can customize
      configuration files or other stuff here. However, the full file hierarchy
      is not yet present, because it's created during the compilation process.
      So you can't do everything on this target filesystem skeleton, but
      changes to it remain even if you completely rebuild the cross-compilation
      toolchain and the tools. <br />
      You can also customize the <code>target/generic/device_table.txt</code>
      file which is used by the tools that generate the target filesystem image
      to properly set permissions and create device nodes. The
      <code>target/generic/skel.tar.gz</code> file contains the main
      directories of a root filesystem and there is no obvious reason for which
      it should be changed. These main directories are in an tarball inside of
      inside the skeleton because it contains symlinks that would be broken
      otherwise. <br />
      These customizations are deployed into
      <code>output/target/</code> just before the actual image
      is made. So simply rebuilding the image by running
      make should propagate any new changes to the image. </li>

      <li>Add support for your own target in Buildroot so that you
      have your own target skeleton, see <a href="#board_support">this
      section</a> for details</li>

      <li>In Buildroot configuration, you can specify the path to a
      post-build script that gets called <i>after</i> Buildroot built
      all the selected software, but <i>before</i> the the rootfs
      packages are assembled. The destination root filesystem folder
      is given as first argument to this script, and this script can
      then be used to copy programs, static data or any other needed
      file to your target filesystem.<br/>You should, however, use
      that feature with care. Whenever you find that a certain package
      generates wrong or unneeded files, you should rather fix than
      package than working around it with a cleanup script.</li>

      <li>A special package, <i>customize</i>, stored in
      <code>package/customize</code> can be used. You can put all the
      files that you want to see in the final target root filesystem
      in <code>package/customize/source</code>, and then enable this
      special package from the configuration system.</li>

    </ul>

    <h2><a name="custom_busybox" id="custom_busybox"></a>Customizing the
    Busybox configuration</h2>

    <p><a href="http://www.busybox.net/">Busybox</a> is very configurable, and
    you may want to customize it. You can
    follow these simple steps to do it. It's not an optimal way, but it's
    simple and it works. </p>

    <ol>
      <li>Make a first compilation of buildroot with busybox without trying to
      customize it. </li>

      <li>Invoke <code>make busybox-menuconfig</code>.
      The nice configuration tool appears and you can
      customize everything. </li>

      <li>Run the compilation of buildroot again. </li>
    </ol>

    <p>Otherwise, you can simply change the
    <code>package/busybox/busybox-&lt;version&gt;.config</code> file if you
    know the options you want to change without using the configuration tool.
    </p>
    <p>If you want to use an existing config file for busybox, then see
    section <a href="#environment_variables">environment variables</a>. </p>

    <h2><a name="custom_uclibc" id="custom_uclibc"></a>Customizing the uClibc
    configuration</h2>

    <p>Just like <a href="#custom_busybox">BusyBox</a>, <a
    href="http://www.uclibc.org/">uClibc</a> offers a lot of
    configuration options. They allow to select various
    functionalities, depending on your needs and limitations. </p>

    <p>The easiest way to modify the configuration of uClibc is to
    follow these steps :</p>

    <ol>

      <li>Make a first compilation of buildroot without trying to
      customize uClibc. </li>

      <li>Invoke <code>make uclibc-menuconfig</code>.
      The nice configuration assistant, similar to
      the one used in the Linux Kernel or in Buildroot appears. Make
      your configuration as appropriate. </li>

      <li>Copy the <code>.config</code> file to
      <code>toolchain/uClibc/uClibc.config</code> or
      <code>toolchain/uClibc/uClibc.config-locale</code>. The former
      is used if you haven't selected locale support in Buildroot
      configuration, and the latter is used if you have selected
      locale support. </li>

      <li>Run the compilation of Buildroot again</li>

    </ol>

    <p>Otherwise, you can simply change
    <code>toolchain/uClibc/uClibc.config</code> or
    <code>toolchain/uClibc/uClibc.config-locale</code> without running
    the configuration assistant. </p>

    <p>If you want to use an existing config file for uclibc, then see
    section <a href="#environment_variables">environment variables</a>. </p>

    <h2><a name="#rebuilding_packages"
    id="rebuilding_packages">Understanding how to rebuild
    packages</a></h2>

    <p>One of the most common question and issue about Buildroot
    encountered by users is how to rebuild a given package or how to
    remove a package without rebuilding everything from scratch.</p>

    <p>Removing a package is currently unsupported by Buildroot
    without rebuilding from scratch. This is because Buildroot doesn't
    keep track of which package installs what files in the
    <code>output/staging</code> and <code>output/target</code>
    directories. However, implement clean package removal is on the
    TODO-list of Buildroot developers.</p>

    <p>To rebuild a single package from scratch, the easiest way is to
    remove its build directory in <code>output/build</code>. Buildroot
    will then re-extract, re-configure, re-compile and re-install this
    package from scratch.</p>

    <p>However, if you don't want to rebuild the package completely
    from scratch, a better understanding of the Buildroot internals is
    needed. Internally, to keep track of which steps have been done
    and which steps remains to be done, Buildroot maintains stamps
    files (i.e, empty files that just tell whether this or this action
    has been done). The problem is that these stamps files are not
    uniformely named and handled by the different packages, so some
    understanding of the particular package is needed.</p>

    <p>For packages relying on the <i>autotools</i> Buildroot
    infrastructure (see <a href="#add_software">this section</a> for
    details), the following stamps files are interesting:</p>

    <ul>

      <li><code>output/build/packagename-version/.stamp_configured</code>. If
      removed, Buildroot will trigger the recompilation of the package
      from the configuration step (execution of
      <code>./configure</code>)</li>

      <li><code>output/build/packagename-version/.stamp_built</code>. If
      removed, Buildroot will trigger the recompilation of the package
      from the compilation step (execution of <code>make</code>)</li>

    </ul>

    <p>For other packages, an analysis of the specific
    <i>package.mk</i> file is needed. For example, the zlib Makefile
    looks like:</p>

    <pre>
$(ZLIB_DIR)/.configured: $(ZLIB_DIR)/.patched
        (cd $(ZLIB_DIR); rm -rf config.cache; \
                        [...]
        )
        touch $@

$(ZLIB_DIR)/libz.a: $(ZLIB_DIR)/.configured
        $(MAKE) -C $(ZLIB_DIR) all libz.a
        touch -c $@
    </pre>

    <p>So, if you want to trigger the reconfiguration, you need to
    remove <code>output/build/zlib-version/.configured</code> and if
    you want to trigger only the recompilation, you need to remove
    <code>output/build/zlib-version/libz.a</code>.</p>

    <h2><a name="buildroot_innards" id="buildroot_innards"></a>How Buildroot
    works</h2>

    <p>As said above, Buildroot is basically a set of Makefiles that download,
    configure and compiles software with the correct options. It also includes
    some patches for various software, mainly the ones involved in the
    cross-compilation tool chain (<code>gcc</code>, <code>binutils</code> and
    uClibc). </p>

    <p>There is basically one Makefile per software, and they are named with
    the <code>.mk</code> extension. Makefiles are split into four
    sections:</p>

    <ul>
      <li><b>project</b> (in the <code>project/</code> directory) contains
      the Makefiles and associated files for all software related to the
      building several root file systems in the same buildroot tree. </li>

      <li><b>toolchain</b> (in the <code>toolchain/</code> directory) contains
      the Makefiles and associated files for all software related to the
      cross-compilation toolchain : <code>binutils</code>, <code>ccache</code>,
      <code>gcc</code>, <code>gdb</code>, <code>kernel-headers</code> and
      <code>uClibc</code>. </li>

      <li><b>package</b> (in the <code>package/</code> directory) contains the
      Makefiles and associated files for all user-space tools that Buildroot
      can compile and add to the target root filesystem. There is one
      sub-directory per tool. </li>

      <li><b>target</b> (in the <code>target</code> directory) contains the
      Makefiles and associated files for software related to the generation of
      the target root filesystem image. Four types of filesystems are supported
      : ext2, jffs2, cramfs and squashfs. For each of them, there's a
      sub-directory with the required files. There is also a
      <code>default/</code> directory that contains the target filesystem
      skeleton. </li>
    </ul>

    <p>Each directory contains at least 2 files :</p>

    <ul>
      <li><code>something.mk</code> is the Makefile that downloads, configures,
      compiles and installs the software <code>something</code>. </li>

      <li><code>Config.in</code> is a part of the configuration tool
      description file. It describes the option related to the current
      software. </li>

    </ul>

    <p>The main Makefile do the job through the following steps (once the
    configuration is done) :</p>

    <ol>

      <li>Create all the output directories: <code>staging</code>,
      <code>target</code>, <code>build</code>, <code>stamps</code>,
      etc. in the output directory (<code>output/</code> by default,
      another value can be specified using <code>O=</code>)</li>

      <li>Generate all the targets listed in the
      <code>BASE_TARGETS</code> variable. When an internal toolchain
      is used, it means generating the cross-compilation
      toolchain. When an external toolchain is used, it means checking
      the features of the external toolchain and importing it into the
      Buildroot environment.</li>

      <li>Generate all the targets listed in the <code>TARGETS</code>
      variable. This variable is filled by all the individual
      components Makefiles. So, generating all these targets will
      trigger the compilation of the userspace packages (libraries,
      programs), the kernel, the bootloader and the generation of the
      root filesystem images, depending on the configuration.</li>

    </ol>

    <h2><a name="board_support" id="board_support"></a>
    Creating your own board support</h2>

    <p>Creating your own board support in Buildroot allows you to have
    a convenient place to store the Busybox, uClibc, kernel
    configurations, your target filesystem skeleton, and a Buildroot
    configuration that match your project.</p>

    <p>Follow these steps to integrate your board in Buildroot:</p>

    <ol>

      <li>Create a new directory in <code>target/device/</code>, named
      after your company or organization</li>

      <li>Add a line <code>source
      "target/device/yourcompany/Config.in"</code> in
      <code>target/device/Config.in</code> so that your board appears
      in the configuration system</li>

      <li>In <code>target/device/yourcompany/</code>, create a
      directory for your project. This way, you'll be able to store
      several projects of your company/organization inside
      Buildroot.</li>

      <li>Create a <code>target/device/yourcompany/Config.in</code>
      file that looks like the following:

      <pre>
menuconfig BR2_TARGET_COMPANY
       bool "Company projects"

if BR2_TARGET_COMPANY

config BR2_TARGET_COMPANY_PROJECT_FOOBAR
       bool "Support for Company project Foobar"
       help
         This option enables support for Company project Foobar

endif
      </pre>

      Of course, customize the different values to match your
      company/organization and your project. This file will create a
      menu entry that contains the different projects of your
      company/organization.</li>

      <li>Create a <code>target/device/yourcompany/Makefile.in</code>
      file that looks like the following:

      <pre>
ifeq ($(BR2_TARGET_COMPANY_PROJECT_FOOBAR),y)
include target/device/yourcompany/project-foobar/Makefile.in
endif
      </pre>
      </li>

      <li>Now, create the
      <code>target/device/yourcompany/project-foobar/Makefile.in</code>
      file. It is first recommended to define a
      <code>BOARD_PATH</code> variable set to
      <code>target/device/yourcompany/project-foobar</code>, as it
      will simplify further definitions. Then, the file might define
      one or several of the following variables:

      <ul>

	<li><code>TARGET_SKELETON</code> to a directory that contains
	the target skeleton for your project. If this variable is
	defined, this target skeleton will be used instead of the
	default one. If defined, the convention is to define it to
	<code>$(BOARD_PATH)/target_skeleton</code>, so that the target
	skeletonn is stored in the board specific directory.</li>

	<li><code>TARGET_DEVICE_TABLE</code> to a file that contains
	the target device table, i.e the list of device files (in
	<code>/dev/</code>) created by the root filesystem building
	procedure. If this variable is defined, the given device table
	will be used instead of the default one. If defined, the
	convention is to define it to
	<code>$(BOARD_PATH)/target_device_table.txt</code>. See
	<code>target/generic/device_table.txt</code> for an example
	file.</li>

      </ul>

      </li>

      <li>Then, in the
      <code>target/device/yourcompany/project-foobar/</code>
      directory, you can store configuration files for the kernel,
      for Busybox or uClibc.

      You can furthermore create one or more preconfigured configuration
      files, referencing those files. These config files are named
      <code>something_defconfig</config> and are stored in the toplevel
      <code>configs/</code> directory. Your users will then be able
      to run <code>make something_defconfig</code> and get the right
      configuration for your project</li>

    </ol>

    <h2><a name="using_toolchain" id="using_toolchain"></a>Using the
    generated toolchain outside Buildroot</h2>

    <p>You may want to compile your own programs or other software
    that are not packaged in Buildroot. In order to do this, you can
    use the toolchain that was generated by Buildroot. </p>

    <p>The toolchain generated by Buildroot by default is located in
    <code>output/staging/</code>. The simplest way to use it
    is to add <code>output/staging/usr/bin/</code> to your PATH
    environnement variable, and then to use
    <code>ARCH-linux-gcc</code>, <code>ARCH-linux-objdump</code>,
    <code>ARCH-linux-ld</code>, etc. </p>

    <p>The easiest way is of course to add the
    <code>output/staging/usr/bin/</code> directory to your PATH
    environment variable.</p>

     <p><b>Important</b> : do not try to move a gcc-3.x toolchain to an other
     directory, it won't work. There are some hardcoded paths in the
     <i>gcc</i> configuration. If you are using a current gcc-4.x, it
     is possible to relocate the toolchain, but then
     <code>--sysroot</code> must be passed every time the compiler is
     called to tell where the libraries and header files are, which
     might be cumbersome.</p>

     <p>It is also possible to generate the Buildroot toolchain in
     another directory than <code>build/staging</code> using the
     <code>Build options -&gt; Toolchain and header file
     location</code> option. This could be useful if the toolchain
     must be shared with other users.</p>

    <h2><a name="downloaded_packages"
    id="downloaded_packages"></a>Location of downloaded packages</h2>

    <p>It might be useful to know that the various tarballs that are
    downloaded by the <i>Makefiles</i> are all stored in the
    <code>DL_DIR</code> which by default is the <code>dl</code>
    directory. It's useful for example if you want to keep a complete
    version of Buildroot which is know to be working with the
    associated tarballs. This will allow you to regenerate the
    toolchain and the target filesystem with exactly the same
    versions. </p>

    <p>If you maintain several buildroot trees, it might be better to have
    a shared download location. This can be accessed by creating a symbolic link
    from the <code>dl</code> directory to the shared download location. </p>

    <p>I.E:</p>

<pre>
ln -s &lt;shared download location&gt; dl
</pre>

    <p>Another way of accessing a shared download location is to
    create the <code>BUILDROOT_DL_DIR</code> environment variable.
    If this is set, then the value of DL_DIR in the project is
    overridden. The following line should be added to
    <code>&quot;~/.bashrc&quot;</code>. <p>

<pre>
export BUILDROOT_DL_DIR &lt;shared download location&gt;
</pre>

    <h2><a name="external_toolchain" id="external_toolchain"></a>Using
    an external toolchain</h2>

<p>It might be useful not to use the toolchain generated by
Buildroot, for example if you already have a toolchain that is known
to work for your specific CPU, or if the toolchain generation feature
of Buildroot is not sufficiently flexible for you (for example if you
need to generate a system with <i>glibc</i> instead of
<i>uClibc</i>). Buildroot supports using an <i>external
toolchain</i>.</p>

<p>To enable the use of an external toolchain, go in the
<code>Toolchain</code> menu, and&nbsp;:</p>

<ul>
  <li>Select the <code>External binary toolchain</code> toolchain
  type</li>
  <li>Adjust the <code>External toolchain path</code>
  appropriately. It should be set to a path where a bin/ directory
  contains your cross-compiling tools</li>
  <li>Adjust the <code>External toolchain prefix</code>, so that the
  prefix, suffixed with <code>-gcc</code> or <code>-ld</code> will
  correspond to your cross-compiling tools</li>
</ul>

<p>If you are using an external toolchain based on <i>uClibc</i>, the
<code>Core C library from the external toolchain</code> and
<code>Libraries to copy from the external toolchain</code> options
should already have correct values. However, if your external
toolchain is based on <i>glibc</i>, you'll have to change these values
according to your cross-compiling toolchain.</p>

<p>To generate external toolchains, we recommend using <a
href="http://ymorin.is-a-geek.org/dokuwiki/projects/crosstool">Crosstool-NG</a>.
It allows to generate toolchains based on <i>uClibc</i>, <i>glibc</i>
and <i>eglibc</i> for a wide range of architectures, and has good
community support.</p>

    <h2><a name="add_software" id="add_software"></a>Extending Buildroot with
    more software</h2>

    <p>This section will only consider the case in which you want to
    add user-space software. </p>

    <h3>Package directory</h3>

    <p>First of all, create a directory under the <code>package</code>
    directory for your software, for example <code>foo</code>. </p>

    <h3><code>Config.in</code> file</h3>

    <p>Then, create a file named <code>Config.in</code>. This file
    will contain the portion of options description related to our
    <code>foo</code> software that will be used and displayed in the
    configuration tool. It should basically contain :</p>

<pre>
config BR2_PACKAGE_FOO
        bool "foo"
        help
	  This is a comment that explains what foo is.

	  http://foosoftware.org/foo/
</pre>

    <p>Of course, you can add other options to configure particular
    things in your software. </p>
    <p>Finally you have to add your new <code>foo/Config.in</code> to
    <code>package/Config.in</code>. The files included there are
    <em>sorted alphabetically</em> per category and are <em>NOT</em>
    supposed to contain anything but the <em>bare</em> name of the package.</p>
<pre>
if !BR2_PACKAGE_BUSYBOX_HIDE_OTHERS
source "package/procps/Config.in"
endif
</pre>
   <p><strong>Note:</strong><br>
   Generally all packages should live <em>directly</em> in the
   <code>package</code> directory to make it easier to find them.
   </p>
   <h3>The real <i>Makefile</i></h3>

   <p>Finally, here's the hardest part. Create a file named
   <code>foo.mk</code>. It will contain the <i>Makefile</i> rules that
   are in charge of downloading, configuring, compiling and installing
   the software.</p>

   <p>Two types of <i>Makefiles</i> can be written&nbsp;:</p>

   <ul>
    <li>Makefiles for autotools-based (autoconf, automake, etc.)
    softwares, are very easy to write thanks to the infrastructure
    available in <code>package/Makefile.autotools.in</code>.</li>
    <li>Makefiles for other types of packages are a little bit more
    complex to write.</li>
   </ul>

   <p>First, let's see how to write a <i>Makefile</i> for an
   autotools-based package, with an example&nbsp;:</p>

<pre>
     <a name="ex1line1" id="ex1line1">1</a>  #############################################################
     <a name="ex1line2" id="ex1line2">2</a>  #
     <a name="ex1line3" id="ex1line3">3</a>  # foo
     <a name="ex1line4" id="ex1line4">4</a>  #
     <a name="ex1line5" id="ex1line5">5</a>  #############################################################
     <a name="ex1line6" id="ex1line6">6</a>  FOO_VERSION:=1.0
     <a name="ex1line7" id="ex1line7">7</a>  FOO_SOURCE:=foo-$(FOO_VERSION).tar.gz
     <a name="ex1line8" id="ex1line8">8</a>  FOO_SITE:=http://www.foosoftware.org/downloads
     <a name="ex1line9" id="ex1line9">9</a>  FOO_INSTALL_STAGING = YES
     <a name="ex1line10" id="ex1line10">10</a>  FOO_INSTALL_TARGET = YES
     <a name="ex1line11" id="ex1line11">11</a>  FOO_CONF_OPT =  --enable-shared
     <a name="ex1line12" id="ex1line12">12</a>  FOO_DEPENDENCIES = libglib2 host-pkgconfig
     <a name="ex1line13" id="ex1line13">13</a>  $(eval $(call AUTOTARGETS,package,foo))
</pre>

    <p>On <a href="#ex1line6">line 6</a>, we declare the version of
    the package. On line <a href="#ex1line7">7</a> and <a
    href="#ex1line8">8</a>, we declare the name of the tarball and the
    location of the tarball on the Web. Buildroot will automatically
    download the tarball from this location.</p>

    <p>On <a href="#ex1line9">line 9</a>, we tell Buildroot to install
    the application to the staging directory. The staging directory,
    located in <code>output/staging/</code> is the directory
    where all the packages are installed, including their
    documentation, etc. By default, packages are installed in this
    location using the <code>make install</code> command.</p>

    <p>On <a href="#ex1line10">line 10</a>, we tell Buildroot to also
    install the application to the target directory. This directory
    contains what will become the root filesystem running on the
    target. Usually, we try not to install the documentation, and to
    install stripped versions of the binary. By default, packages are
    installed in this location using the <code>make
    install-strip</code> command.</p>

    <p>On <a href="#ex1line11">line 11</a>, we tell Buildroot to pass
    a custom configure option, that will be passed to the
    <code>./configure</code> script before configuring and building
    the package.</p>

    <p>On <a href="#ex1line12">line 12</a>, we declare our
    dependencies, so that they are built before the build process of
    our package starts.</p>

    <p>Finally, on line <a href="#ex1line13">line 13</a>, we invoke
    the <code>package/Makefile.autotools.in</code> magic to get things
    working.</p>

    <p>For more details about the available variables and options, see
    the comment at the top of
    <code>package/Makefile.autotools.in</code> and the examples in all
    the available packages.</p>

    <p>The second solution, suitable for every type of package, looks
    like this&nbsp;:</p>


<pre>
     <a name="ex2line1" id="ex2line1">1</a>  #############################################################
     <a name="ex2line2" id="ex2line2">2</a>  #
     <a name="ex2line3" id="ex2line3">3</a>  # foo
     <a name="ex2line4" id="ex2line4">4</a>  #
     <a name="ex2line5" id="ex2line5">5</a>  #############################################################
     <a name="ex2line6" id="ex2line6">6</a>  FOO_VERSION:=1.0
     <a name="ex2line7" id="ex2line7">7</a>  FOO_SOURCE:=foo-$(FOO_VERSION).tar.gz
     <a name="ex2line8" id="ex2line8">8</a>  FOO_SITE:=http://www.foosoftware.org/downloads
     <a name="ex2line9" id="ex2line9">9</a>  FOO_DIR:=$(BUILD_DIR)/foo-$(FOO_VERSION)
    <a name="ex2line10" id="ex2line10">10</a>  FOO_BINARY:=foo
    <a name="ex2line11" id="ex2line11">11</a>  FOO_TARGET_BINARY:=usr/bin/foo
    <a name="ex2line12" id="ex2line12">12</a>
    <a name="ex2line13" id="ex2line13">13</a>  $(DL_DIR)/$(FOO_SOURCE):
    <a name="ex2line14" id="ex2line14">14</a>          $(call DOWNLOAD,$(FOO_SITE),$(FOO_SOURCE))
    <a name="ex2line15" id="ex2line15">15</a>
    <a name="ex2line16" id="ex2line16">16</a>  $(FOO_DIR)/.source: $(DL_DIR)/$(FOO_SOURCE)
    <a name="ex2line17" id="ex2line17">17</a>          $(ZCAT) $(DL_DIR)/$(FOO_SOURCE) | tar -C $(BUILD_DIR) $(TAR_OPTIONS) -
    <a name="ex2line18" id="ex2line18">18</a>          touch $@
    <a name="ex2line19" id="ex2line19">19</a>
    <a name="ex2line20" id="ex2line20">20</a>  $(FOO_DIR)/.configured: $(FOO_DIR)/.source
    <a name="ex2line21" id="ex2line21">21</a>          (cd $(FOO_DIR); rm -rf config.cache; \
    <a name="ex2line22" id="ex2line22">22</a>                  $(TARGET_CONFIGURE_OPTS) \
    <a name="ex2line23" id="ex2line23">23</a>                  $(TARGET_CONFIGURE_ARGS) \
    <a name="ex2line24" id="ex2line24">24</a>                  ./configure \
    <a name="ex2line25" id="ex2line25">25</a>                  --target=$(GNU_TARGET_NAME) \
    <a name="ex2line26" id="ex2line26">26</a>                  --host=$(GNU_TARGET_NAME) \
    <a name="ex2line27" id="ex2line27">27</a>                  --build=$(GNU_HOST_NAME) \
    <a name="ex2line28" id="ex2line28">28</a>                  --prefix=/usr \
    <a name="ex2line29" id="ex2line29">29</a>                  --sysconfdir=/etc \
    <a name="ex2line30" id="ex2line30">30</a>          )
    <a name="ex2line31" id="ex2line31">31</a>          touch $@
    <a name="ex2line32" id="ex2line32">32</a>
    <a name="ex2line33" id="ex2line33">33</a>  $(FOO_DIR)/$(FOO_BINARY): $(FOO_DIR)/.configured
    <a name="ex2line34" id="ex2line34">34</a>          $(MAKE) CC=$(TARGET_CC) -C $(FOO_DIR)
    <a name="ex2line35" id="ex2line35">35</a>
    <a name="ex2line36" id="ex2line36">36</a>  $(TARGET_DIR)/$(FOO_TARGET_BINARY): $(FOO_DIR)/$(FOO_BINARY)
    <a name="ex2line37" id="ex2line37">37</a>          $(MAKE) DESTDIR=$(TARGET_DIR) -C $(FOO_DIR) install-strip
    <a name="ex2line38" id="ex2line38">38</a>          rm -Rf $(TARGET_DIR)/usr/man
    <a name="ex2line39" id="ex2line39">39</a>
    <a name="ex2line40" id="ex2line40">40</a>  foo: uclibc ncurses $(TARGET_DIR)/$(FOO_TARGET_BINARY)
    <a name="ex2line41" id="ex2line41">41</a>
    <a name="ex2line42" id="ex2line42">42</a>  foo-source: $(DL_DIR)/$(FOO_SOURCE)
    <a name="ex2line43" id="ex2line43">43</a>
    <a name="ex2line44" id="ex2line44">44</a>  foo-clean:
    <a name="ex2line45" id="ex2line45">45</a>          $(MAKE) prefix=$(TARGET_DIR)/usr -C $(FOO_DIR) uninstall
    <a name="ex2line46" id="ex2line46">46</a>          -$(MAKE) -C $(FOO_DIR) clean
    <a name="ex2line47" id="ex2line47">47</a>
    <a name="ex2line48" id="ex2line48">48</a>  foo-dirclean:
    <a name="ex2line49" id="ex2line49">49</a>          rm -rf $(FOO_DIR)
    <a name="ex2line50" id="ex2line50">50</a>
    <a name="ex2line51" id="ex2line51">51</a> #############################################################
    <a name="ex2line52" id="ex2line52">52</a> #
    <a name="ex2line53" id="ex2line53">53</a> # Toplevel Makefile options
    <a name="ex2line54" id="ex2line54">54</a> #
    <a name="ex2line55" id="ex2line55">55</a> #############################################################
    <a name="ex2line56" id="ex2line56">56</a> ifeq ($(BR2_PACKAGE_FOO),y)
    <a name="ex2line57" id="ex2line57">57</a> TARGETS+=foo
    <a name="ex2line58" id="ex2line58">58</a> endif

</pre>

    <p>First of all, this <i>Makefile</i> example works for a single
    binary software. For other software such as libraries or more
    complex stuff with multiple binaries, it should be adapted. Look at
    the other <code>*.mk</code> files in the <code>package</code>
    directory. </p>

    <p>At lines <a href="#ex2line6">6-11</a>, a couple of useful variables are
    defined :</p>

    <ul>

     <li><code>FOO_VERSION</code> : The version of <i>foo</i> that
     should be downloaded. </li>

     <li><code>FOO_SOURCE</code> : The name of the tarball of
     <i>foo</i> on the download website of FTP site. As you can see
     <code>FOO_VERSION</code> is used. </li>

     <li><code>FOO_SITE</code> : The HTTP or FTP site from which
     <i>foo</i> archive is downloaded. It must include the complete
     path to the directory where <code>FOO_SOURCE</code> can be
     found. </li>

     <li><code>FOO_DIR</code> : The directory into which the software
     will be configured and compiled. Basically, it's a subdirectory
     of <code>BUILD_DIR</code> which is created upon decompression of
     the tarball. </li>

     <li><code>FOO_BINARY</code> : Software binary name. As said
     previously, this is an example for a single binary software. </li>

     <li><code>FOO_TARGET_BINARY</code> : The full path of the binary
     inside the target filesystem. </li>

    </ul>

    <p>Lines <a href="#ex2line13">13-14</a> defines a target that downloads the
    tarball from the remote site to the download directory
    (<code>DL_DIR</code>). </p>

    <p>Lines <a href="#ex2line16">16-18</a> defines a target and associated rules
    that uncompress the downloaded tarball. As you can see, this target
    depends on the tarball file, so that the previous target (line
    <a href="#ex2line13">13-14</a>) is called before executing the rules of the
    current target. Uncompressing is followed by <i>touching</i> a hidden file
    to mark the software has having been uncompressed. This trick is
    used everywhere in Buildroot <i>Makefile</i> to split steps
    (download, uncompress, configure, compile, install) while still
    having correct dependencies. </p>

    <p>Lines <a href="#ex2line20">20-31</a> defines a target and associated rules
    that configures the software. It depends on the previous target (the
    hidden <code>.source</code> file) so that we are sure the software has
    been uncompressed. In order to configure it, it basically runs the
    well-known <code>./configure</code> script. As we may be doing
    cross-compilation, <code>target</code>, <code>host</code> and
    <code>build</code> arguments are given. The prefix is also set to
    <code>/usr</code>, not because the software will be installed in
    <code>/usr</code> on your host system, but in the target
    filesystem. Finally it creates a <code>.configured</code> file to
    mark the software as configured. </p>

    <p>Lines <a href="#ex2line33">33-34</a> defines a target and a rule that
    compiles the software. This target will create the binary file in the
    compilation directory, and depends on the software being already
    configured (hence the reference to the <code>.configured</code>
    file). It basically runs <code>make</code> inside the source
    directory. </p>

    <p>Lines <a href="#ex2line36">36-38</a> defines a target and associated rules
    that install the software inside the target filesystem. It depends on the
    binary file in the source directory, to make sure the software has
    been compiled. It uses the <code>install-strip</code> target of the
    software <code>Makefile</code> by passing a <code>DESTDIR</code>
    argument, so that the <code>Makefile</code> doesn't try to install
    the software inside host <code>/usr</code> but inside target
    <code>/usr</code>. After the installation, the
    <code>/usr/man</code> directory inside the target filesystem is
    removed to save space. </p>

    <p>Line <a href="#ex2line40">40</a> defines the main target of the software,
    the one that will be eventually be used by the top level
    <code>Makefile</code> to download, compile, and then install
    this package. This target should first of all depends on all
    needed dependecies of the software (in our example,
    <i>uclibc</i> and <i>ncurses</i>), and also depend on the
    final binary. This last dependency will call all previous
    dependencies in the correct order. </p>

    <p>Line <a href="#ex2line42">42</a> defines a simple target that only
    downloads the code source. This is not used during normal operation of
    Buildroot, but is needed if you intend to download all required sources at
    once for later offline build. Note that if you add a new package providing
    a <code>foo-source</code> target is <i>mandatory</i> to support
    users that wish to do offline-builds. Furthermore it eases checking
    if all package-sources are downloadable. </p>

    <p>Lines <a href="#ex2line44">44-46</a> define a simple target to clean the
    software build by calling the <i>Makefiles</i> with the appropriate option.
    The <code>-clean</code> target should run <code>make clean</code>
    on $(BUILD_DIR)/package-version and MUST uninstall all files of the
    package from $(STAGING_DIR) and from $(TARGET_DIR). </p>

    <p>Lines <a href="#ex2line48">48-49</a> define a simple target to completely
    remove the directory in which the software was uncompressed, configured and
    compiled. The <code>-dirclean</code> target MUST completely rm $(BUILD_DIR)/
    package-version. </p>

    <p>Lines <a href="#ex2line51">51-58</a> adds the target <code>foo</code> to
    the list of targets to be compiled by Buildroot by first checking if
    the configuration option for this package has been enabled
    using the configuration tool, and if so then &quot;subscribes&quot;
    this package to be compiled by adding it to the TARGETS
    global variable.  The name added to the TARGETS global
    variable is the name of this package's target, as defined on
    line <a href="#ex2line40">40</a>, which is used by Buildroot to download,
    compile, and then install this package. </p>


    <h3>Conclusion</h3>

    <p>As you can see, adding a software to buildroot is simply a
    matter of writing a <i>Makefile</i> using an already existing
    example and to modify it according to the compilation process of
    the software. </p>

    <p>If you package software that might be useful for other persons,
    don't forget to send a patch to Buildroot developers !</p>

     <h2><a name="links" id="links"></a>Resources</h2>

    <p>To learn more about Buildroot you can visit these
    websites:</p>

    <ul>
      <li><a href="http://www.uclibc.org/">http://www.uclibc.org/</a></li>
      <li><a href="http://www.busybox.net/">http://www.busybox.net/</a></li>
    </ul>
  </div>
<!--
       <a href="http://validator.w3.org/check?uri=referer"><img
       border="0" height="31" width="88"
       src="images/valid-html401.png"
       alt="Valid HTML"></img></a>
-->

</body>
</html>