[buildroot-mgba.git] / docs / README

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 sortof
    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!

 -Erik

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: [email protected]
Commit	Line	Data
ffde94bd EA	1	To build and use the buildroot stuff, do the following:
ffde94bd EA	2
2a7d563e	3	1) run 'make menuconfig'
957a598c	4	2) select the packages you wish to compile
c7af927d EA	5	3) run 'make'
c7af927d EA	6	4) wait while it compiles
957a598c EA	7	5) Use your shiny new root filesystem. Depending on which sortof
	8	root filesystem you selected, you may want to loop mount it,
	9	chroot into it, nfs mount it on your target device, burn it
	10	to flash, or whatever is appropriate for your target system.
c7af927d EA	11
c7af927d EA	12	You do not need to be root to build or run buildroot. Have fun!
ffde94bd EA	13
	14	-Erik
	15
1d9fa600 BRF	16	Offline build:
	17	==============
	18
	19	In order to do an offline-build (not connected to the net), fetch all
	20	selected source by issuing a
	21	$ make source
	22
	23	before you disconnect.
	24	If your build-host is never connected, then you have to copy buildroot
	25	and your toplevel .config to a machine that has an internet-connection
	26	and issue "make source" there, then copy the content of your dl/ dir to
	27	the build-host.
	28
d1b1b4ee PK	29	Building out-of-tree:
	30	=====================
	31
	32	Buildroot supports building out of tree with a syntax similar
	33	to the Linux kernel. To use it, add O=<directory> to the
	34	make command line, E.G.:
	35
	36	$ make O=/tmp/build
	37
cd7459b4	38	And all the output files (including .config) will be located under /tmp/build.
d1b1b4ee	39
05a2211c BRF	40	More finegrained configuration:
	41	===============================
	42
	43	You can specify a config-file for uClibc:
	44	$ make UCLIBC_CONFIG_FILE=/my/uClibc.config
	45
673ee97c BRF	46	And you can specify a config-file for busybox:
	47	$ make BUSYBOX_CONFIG_FILE=/my/busybox.config
	48
fccd6603	49	To use a non-standard host-compiler (if you do not have 'gcc'),
05a2211c BRF	50	make sure that the compiler is in your PATH and that the library paths are
	51	setup properly, if your compiler is built dynamically:
	52	$ make HOSTCC=gcc-4.3.orig HOSTCXX=gcc-4.3-mine
	53
	54	Depending on your configuration, there are some targets you can use to
	55	use menuconfig of certain packages. This includes:
176afdb3	56	$ make HOSTCC=gcc-4.3 linux-menuconfig
05a2211c BRF	57	$ make HOSTCC=gcc-4.3 uclibc-menuconfig
	58	$ make HOSTCC=gcc-4.3 busybox-menuconfig
	59
9d40356a PK	60	Please feed suggestions, bug reports, insults, and bribes back to the
9d40356a PK	61	buildroot mailing list: [email protected]