kumquat-buildroot/docs
grante 0a62bb41ba docs: Clean up punctuation, grammar, usage, and typos.
Closes #795.

Signed-off-by: Grant Edwards <grant.b.edwards@gmail.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
2009-12-12 01:29:23 +01:00
..
images docs/images: remove unused busybox logo 2009-03-27 12:22:11 +00:00
about.html clarify license and fix website license link 2009-05-08 09:29:41 +02:00
buildroot.html docs: Clean up punctuation, grammar, usage, and typos. 2009-12-12 01:29:23 +01:00
copyright.txt docs/copyright.txt: ask people to contact the devs, not Erik 2009-08-03 22:55:25 +02:00
developer.html docs/: announce move to git 2009-05-03 22:11:33 +02:00
docs.html docs/docs.html: add link to doc for latest stable release as well 2009-11-15 22:33:24 +01:00
download.html update for 2009.11 2009-12-01 15:20:18 +01:00
footer.html docs/footer.html: ask people to mail the list instead of Erik 2009-01-15 14:50:11 +00:00
git.html use https for the bugtracker URLs 2009-06-04 11:58:58 +02:00
Glibc_vs_uClibc.html HTMLized glibc vs uclibc and added to docs 2008-03-07 13:34:02 +00:00
header.html use https for the bugtracker URLs 2009-06-04 11:58:58 +02:00
index.html docs/: show about.html as index page 2009-03-25 15:54:41 +00:00
lists.html docs/lists.html: adapt google search for lists.busybox.net 2009-11-15 13:52:42 +01:00
news.html docs/news.html: add 2009.11 annoucement mail 2009-12-01 15:46:00 +01:00
patches.html add some documentation about buildroot's patch system 2008-03-13 17:16:30 +00:00
README docs/README: ask people to mail the list instead of Erik 2009-01-15 14:50:07 +00:00
README.diskimage - add a sample README.diskimage for i386 2007-09-27 21:32:50 +00:00
stylesheet.css move docs to subdir 2004-12-27 19:01:52 +00:00
TESTING.html Add buildall script for testing many/most packages separately with build logs and documentation for this and mkpkg 2009-01-11 21:13:02 +00:00
U-boot.html docs: get rid of svn date keywords 2009-05-15 09:30:58 +02: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 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 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 linux26-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@uclibc.org