Go to file
Thomas De Schampheleire 569db40574 manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.

This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix

Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.

In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.

Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-17 21:09:52 +02:00
arch toolchain: Add config option for atomic intrinsics 2014-08-03 11:20:47 +02:00
board qemu/aarch64-virt: add new sample config 2014-08-07 22:17:37 +02:00
boot package: remove the trailing slash sign from <PKG>_SITE variable 2014-07-31 23:17:46 +02:00
configs configs/{atngw100, atstk100x}: fix build of AVR32 defconfigs 2014-08-17 09:13:34 +02:00
docs manual: high-level restructuring 2014-08-17 21:09:52 +02:00
fs linux: remove support of linux26-* targets 2014-07-29 23:47:03 +02:00
linux linux: bump default to version 3.16.1 2014-08-15 10:17:10 +02:00
package package/nut: fix parallel install 2014-08-17 21:00:19 +02:00
support dependencies: Reject gcj in BR2_NEEDS_HOST_JAVA check 2014-08-17 21:01:10 +02:00
system system: move tz setup outside of default skeleton clause 2014-07-27 22:37:16 +02:00
toolchain toolchain: add 3.16 choice for headers 2014-08-04 09:46:41 +02:00
.defconfig buildroot: get rid of s390 support 2009-01-12 14:36:14 +00:00
.gitignore update gitignore 2013-05-04 12:41:55 +02:00
CHANGES CHANGES: update with recent changes 2014-08-17 09:44:53 +02:00
Config.in google-breakpad: integration into Makefile and Config.in 2014-07-31 23:10:19 +02:00
Config.in.legacy busybox: support only one version 2014-07-10 16:40:38 +02:00
COPYING clarify license and fix website license link 2009-05-08 09:29:41 +02:00
Makefile Makefile: unconditionally include pkg-utils.mk 2014-08-16 09:29:59 +02:00
Makefile.legacy Makefile.legacy: fix recursive invocation with BUILDROOT_DL_DIR and _CONFIG 2014-02-11 08:14:57 +01:00
README docs: Move README file to root 2014-03-03 21:28:39 +01:00

To build and use the buildroot stuff, do the following:

1) run 'make menuconfig'
2) select the packages you wish to compile
3) run 'make'
4) wait while it compiles
5) Use your shiny new root filesystem. Depending on which sort of
    root filesystem you selected, you may want to loop mount it,
    chroot into it, nfs mount it on your target device, burn it
    to flash, or whatever is appropriate for your target system.

You do not need to be root to build or run buildroot.  Have fun!

Offline build:
==============

In order to do an offline-build (not connected to the net), fetch all
selected source by issuing a
$ make source

before you disconnect.
If your build-host is never connected, then you have to copy buildroot
and your toplevel .config to a machine that has an internet-connection
and issue "make source" there, then copy the content of your dl/ dir to
the build-host.

Building out-of-tree:
=====================

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

$ make O=/tmp/build

And all the output files (including .config) will be located under /tmp/build.

More finegrained configuration:
===============================

You can specify a config-file for uClibc:
$ make UCLIBC_CONFIG_FILE=/my/uClibc.config

And you can specify a config-file for busybox:
$ make BUSYBOX_CONFIG_FILE=/my/busybox.config

To use a non-standard host-compiler (if you do not have 'gcc'),
make sure that the compiler is in your PATH and that the library paths are
setup properly, if your compiler is built dynamically:
$ make HOSTCC=gcc-4.3.orig HOSTCXX=gcc-4.3-mine

Depending on your configuration, there are some targets you can use to
use menuconfig of certain packages. This includes:
$ make HOSTCC=gcc-4.3 linux-menuconfig
$ make HOSTCC=gcc-4.3 uclibc-menuconfig
$ make HOSTCC=gcc-4.3 busybox-menuconfig

Please feed suggestions, bug reports, insults, and bribes back to the
buildroot mailing list: buildroot@buildroot.org