From cc98404a318dd8e1f102eec8a6ec493299008359 Mon Sep 17 00:00:00 2001 From: Martin Banky Date: Tue, 12 Oct 2010 15:17:55 -0700 Subject: buildroot.html: Fix grammer and punctuation Also, clarified some of the information given. Signed-off-by: Martin Banky Signed-off-by: Peter Korsgaard --- docs/buildroot.html | 241 +++++++++++++++++++++++++++------------------------- 1 file changed, 123 insertions(+), 118 deletions(-) (limited to 'docs/buildroot.html') diff --git a/docs/buildroot.html b/docs/buildroot.html index 5eff1baf6..ae0b524a8 100644 --- a/docs/buildroot.html +++ b/docs/buildroot.html @@ -94,7 +94,7 @@

You might wonder why such a tool is needed when you can compile gcc, binutils, uClibc and all - the other tools by hand. Of course doing so is possible. But, dealing with + the other tools by hand. Of course doing so is possible but, dealing with all of the configure options and problems of every gcc or binutils version is very time-consuming and uninteresting. Buildroot automates this process through the use of Makefiles and has a @@ -111,7 +111,7 @@

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

+ available, if you want more bleeding edge.

Releases are available at http://buildroot.net/downloads/.

@@ -121,7 +121,7 @@ and previous snapshots are also available at http://buildroot.net/downloads/snapshots/.

-

To download Buildroot using Git you can simply follow +

To download Buildroot using Git, you can simply follow the rules described on the "Accessing Git" page (http://buildroot.net/git.html) of the Buildroot website @@ -166,7 +166,7 @@ the libncurses5-dev package is required to use the menuconfig interface, libqt3-mt-dev is required to use the xconfig interface, and libglib2.0-dev, libgtk2.0-dev - and libglade2-dev are needed to used the gconfig interface.

+ and libglade2-dev are needed to use the gconfig interface.

For each menu entry in the configuration tool, you can find associated help that describes the purpose of the entry.

@@ -218,10 +218,10 @@ libraries and applications for the target that depend on other libraries. -
  • target/ which contains almost the root - filesystem for the target: everything needed is present except the - device files in /dev/ (Buildroot can't create them - because Buildroot doesn't run as root and does not want to run as +
  • target/ which contains almost the complete + root filesystem for the target: everything needed is present except + the device files in /dev/ (Buildroot can't create them + because Buildroot doesn't run as root and doesn't want to run as root). Therefore, this directory should not be used on your target. Instead, you should use one of the images built in the images/ directory. If you need an extracted image of the @@ -229,10 +229,12 @@ generated in images/ and extract it as root.
    Compared to staging/, target/ contains only the files and libraries needed to run the selected target applications: - the development files (headers, etc.) are not present.
    • + the development files (headers, etc.) are not present, unless the + development files in target filesystem option is selected. +
  • host/ contains the installation of tools compiled for - the host that are needed for the proper execution of Buildroot except + the host that are needed for the proper execution of Buildroot, except for the cross-compilation toolchain which is installed under staging/.
    • @@ -287,13 +289,13 @@

    Environment variables

    -

    Buildroot also honors some environment variables when they are passed +

    Buildroot also honors some environment variables, when they are passed to make or set in the environment:

    @@ -368,10 +370,10 @@ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD

    Busybox is very configurable, and you may want to customize it. You can follow these simple steps to - do so. This method isn't optimal, but it's simple and it works:

    + do so. This method isn't optimal, but it's simple, and it works:

      -
    1. Do an initial compilation of Buildroot with busybox without +
    2. Do an initial compilation of Buildroot, with busybox, without trying to customize it.
    3. Invoke make busybox-menuconfig. @@ -382,8 +384,8 @@ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD

    Otherwise, you can simply change the - package/busybox/busybox-<version>.config file if you - know the options you want to change without using the configuration tool. + package/busybox/busybox-<version>.config file, if you + know the options you want to change, without using the configuration tool.

    If you want to use an existing config file for busybox, then see @@ -391,8 +393,8 @@ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD

    Customizing the uClibc configuration

    -

    Just like BusyBox, uClibc offers a lot of +

    Just like BusyBox, + uClibc offers a lot of configuration options. They allow you to select various functionalities depending on your needs and limitations.

    @@ -420,7 +422,7 @@ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD

    Otherwise, you can simply change toolchain/uClibc/uClibc.config or - toolchain/uClibc/uClibc.config-locale without running + toolchain/uClibc/uClibc.config-locale, without running the configuration assistant.

    If you want to use an existing config file for uclibc, then see @@ -428,11 +430,12 @@ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD

    Customizing the Linux kernel configuration

    -

    The Linux kernel configuration can be customized just like BusyBox and uClibc - using make linux26-menuconfig. Make sure you have - enabled the kernel build in make menuconfig first. - Once done, run make to (re)build everything.

    +

    The Linux kernel configuration can be customized just like + BusyBox and + uClibc using make linux26-menuconfig + . Make sure you have enabled the kernel build in make + menuconfig first. Once done, run make to (re)build + everything.

    If you want to use an existing config file for Linux, then see section environment variables.

    @@ -501,13 +504,13 @@ $(ZLIB_DIR)/libz.a: $(ZLIB_DIR)/.configured output/build/zlib-version/libz.a.

    Note that most packages, if not all, will progressively be - ported over the generic or the autotools infrastructure, making it + ported over to the generic or autotools infrastructure, making it much easier to rebuild individual packages.

    How Buildroot works

    As mentioned above, Buildroot is basically a set of Makefiles that - downloads, configures and compiles software with the correct options. It + download, configure, and compile software with the correct options. It also includes patches for various software packages — mainly the ones involved in the cross-compilation tool chain (gcc, binutils and uClibc).

    @@ -632,7 +635,7 @@ endif BOARD_PATH variable set to target/device/yourcompany/project-foobar as it will simplify further definitions. Then, the file might define - one or several of the following variables: + one or more of the following variables: