From: Samuel Martin <s.martin49@gmail.com>
To: buildroot@busybox.net
Subject: [Buildroot] [PATCH v2 04/11] manual: rework using.txt and update common-usage.txt
Date: Sun, 13 May 2012 12:38:14 +0200 [thread overview]
Message-ID: <1336905501-9757-5-git-send-email-s.martin49@gmail.com> (raw)
In-Reply-To: <1336905501-9757-1-git-send-email-s.martin49@gmail.com>
From: Samuel MARTIN <s.martin49@gmail.com>
Consider the second chapter: "starting-up", as a tutorial.
Assuming that, using.txt only contains the very first commands used to get
configure and build its very first target system.
So, the following subsection from using.txt have been to common-usage.txt:
- Offline builds
- Building out-of-tree
- Environment variables
Signed-off-by: Samuel Martin <s.martin49@gmail.com>
diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
index ff8543f..dde1ab0 100644
--- a/docs/manual/common-usage.txt
+++ b/docs/manual/common-usage.txt
@@ -2,3 +2,80 @@ Daily use
---------
include::rebuilding-packages.txt[]
+
+Offline builds
+~~~~~~~~~~~~~~
+
+If you intend to do an offline build and just want to download
+all sources that you previously selected in the configurator
+('menuconfig', 'xconfig' or 'gconfig'), then issue:
+
+--------------------
+ $ make source
+--------------------
+
+You can now disconnect or copy the content of your +dl+
+directory 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:
+
+--------------------
+ $ make O=/tmp/build
+--------------------
+
+Or:
+
+--------------------
+ $ cd /tmp/build; make O=$PWD -C path/to/buildroot
+--------------------
+
+All the output files will be located under +/tmp/build+.
+
+When using out-of-tree builds, the Buildroot +.config+ and temporary
+files are also stored in the output directory. This means that you can
+safely run multiple builds in parallel using the same source tree as
+long as they use unique output directories.
+
+For ease of use, Buildroot generates a Makefile wrapper in the output
+directory - So after the first run, you no longer need to pass +O=..+
+and +-C ..+, simply run (in the output directory):
+
+--------------------
+ $ make <target>
+--------------------
+
+[[env-vars]]
+
+Environment variables
+~~~~~~~~~~~~~~~~~~~~~
+
+Buildroot also honors some environment variables, when they are passed
+to +make+ or set in the environment:
+
+* +HOSTCXX+, the host C++ compiler to use
+* +HOSTCC+, the host C compiler to use
+* +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to
+ the uClibc configuration file, used to compile uClibc, if an
+ internal toolchain is being built
+* +BUSYBOX_CONFIG_FILE=<path/to/.config>+, path to
+ the Busybox configuration file
+* +BUILDROOT_DL_DIR+ to override the directory in which
+ Buildroot stores/retrieves downloaded files
+
+An example that uses config files located in the toplevel directory and
+in your $HOME:
+
+--------------------
+ $ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config
+--------------------
+
+If you want to use a compiler other than the default +gcc+
+or +g+++ for building helper-binaries on your host, then do
+
+--------------------
+ $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
+--------------------
diff --git a/docs/manual/using.txt b/docs/manual/using.txt
index 88dc58c..2945098 100644
--- a/docs/manual/using.txt
+++ b/docs/manual/using.txt
@@ -3,8 +3,8 @@ Using Buildroot
Buildroot has a nice configuration tool similar to the one you can
find in the http://www.kernel.org/[Linux kernel] or in
-http://www.busybox.net/[Busybox]. Note that you can (and should) build
-everything as a normal user. There is no need to be root to configure
+http://www.busybox.net/[Busybox]. Note that you can *and should 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:
@@ -27,12 +27,11 @@ or
to run the Qt or GTK-based configurators.
All of these "make" commands will need to build a configuration
-utility, so you may need to install "development" packages for
-relevant libraries used by the configuration utilities. On Debian-like
-systems, the +libncurses5-dev+ package is required to use the
-'menuconfig' interface, +libqt4-dev+ is required to use the 'xconfig'
-interface, and +libglib2.0-dev, libgtk2.0-dev and libglade2-dev+ are
-needed to use the 'gconfig' interface.
+utility (including the interface), so you may need to install
+"development" packages for relevant libraries used by the
+configuration utilities. Check the xref:requirement[] to know what
+Buildroot needs, and specifically the xref:requirement-optional[system requirements]
+to get the dependencies of favourite interface.
For each menu entry in the configuration tool, you can find associated
help that describes the purpose of the entry.
@@ -54,9 +53,9 @@ tell Buildroot to run each package compilation with +make -jN+.
This command will generally perform the following steps:
* Download source files (as required)
-* Configure, build and install the cross-compiling toolchain if an
- internal toolchain is used, or import a toolchain if an external
- toolchain is used
+* Configure, build and install the cross-compiling toolchain using the
+ appropiate toolchain backend is used, or simply import a toolchain
+ if an external toolchain is used
* Build/install selected target packages
* Build a kernel image, if selected
* Build a bootloader image, if selected
@@ -103,78 +102,9 @@ This directory contains several subdirectories:
* +toolchain/+ contains the build directories for the various
components of the cross-compilation toolchain.
-Offline builds
---------------
+These commands, +make menuconfig|gconfig|xconfig+ and +make+, are the
+basic ones that allow to easily and quickly generate images fitting
+your needs, with all the supports and applications you enabled.
-If you intend to do an offline build and just want to download
-all sources that you previously selected in the configurator
-('menuconfig', 'xconfig' or 'gconfig'), then issue:
-
---------------------
- $ make source
---------------------
-
-You can now disconnect or copy the content of your +dl+
-directory 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:
-
---------------------
- $ make O=/tmp/build
---------------------
-
-Or:
-
---------------------
- $ cd /tmp/build; make O=$PWD -C path/to/buildroot
---------------------
-
-All the output files will be located under +/tmp/build+.
-
-When using out-of-tree builds, the Buildroot +.config+ and temporary
-files are also stored in the output directory. This means that you can
-safely run multiple builds in parallel using the same source tree as
-long as they use unique output directories.
-
-For ease of use, Buildroot generates a Makefile wrapper in the output
-directory - So after the first run, you no longer need to pass +O=..+
-and +-C ..+, simply run (in the output directory):
-
---------------------
- $ make <target>
---------------------
-
-Environment variables
----------------------
-[[env-vars]]
-
-Buildroot also honors some environment variables, when they are passed
-to +make+ or set in the environment:
-
-* +HOSTCXX+, the host C++ compiler to use
-* +HOSTCC+, the host C compiler to use
-* +UCLIBC_CONFIG_FILE=<path/to/.config>+, path to
- the uClibc configuration file, used to compile uClibc, if an
- internal toolchain is being built
-* +BUSYBOX_CONFIG_FILE=<path/to/.config>+, path to
- the Busybox configuration file
-* +BUILDROOT_DL_DIR+ to override the directory in which
- Buildroot stores/retrieves downloaded files
-
-An example that uses config files located in the toplevel directory and
-in your $HOME:
-
---------------------
- $ make UCLIBC_CONFIG_FILE=uClibc.config BUSYBOX_CONFIG_FILE=$HOME/bb.config
---------------------
-
-If you want to use a compiler other than the default +gcc+
-or +g+++ for building helper-binaries on your host, then do
-
---------------------
- $ make HOSTCXX=g++-4.3-HEAD HOSTCC=gcc-4.3-HEAD
---------------------
+More details about the "make" command usages are given in
+xref:make-tips[].
--
1.7.10.2
next prev parent reply other threads:[~2012-05-13 10:38 UTC|newest]
Thread overview: 53+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-20 23:09 [Buildroot] [PATCH 00/11] RFC: Manual content reorganization Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 01/11] manual: rework the whole documentation stub Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 02/11] manual: rework introduction.txt and update embedded-basics.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 03/11] manual: update prerequisite.txt Samuel MARTIN
2012-03-20 23:29 ` Thomas Petazzoni
2012-03-20 23:09 ` [Buildroot] [PATCH 04/11] manual: rework using.txt and update common-usage.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 05/11] manual: update make-tips.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 06/11] manual: update working-with.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 07/11] manual: update troubleshooting.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 08/11] manual: rework the intro of customize-rootfs.txt Samuel MARTIN
2012-03-20 23:09 ` [Buildroot] [PATCH 09/11] manual: update writing-rules.txt Samuel MARTIN
2012-03-20 23:10 ` [Buildroot] [PATCH 10/11] manual: update get-involved.txt Samuel MARTIN
2012-03-20 23:10 ` [Buildroot] [PATCH 11/11] manual: update contribute.txt Samuel MARTIN
2012-03-25 21:50 ` [Buildroot] [PATCH 00/11] RFC: Manual content reorganization Arnout Vandecappelle
2012-04-15 10:56 ` Samuel Martin
2012-04-25 20:23 ` Samuel Martin
2012-04-28 14:41 ` Arnout Vandecappelle
2012-05-06 21:04 ` Peter Korsgaard
2012-05-07 15:39 ` Samuel Martin
2012-05-12 23:18 ` Arnout Vandecappelle
2012-05-13 10:38 ` [Buildroot] [PATCH v2 " Samuel Martin
2012-05-13 10:38 ` [Buildroot] [PATCH v2 01/11] manual: rework the whole documentation stub Samuel Martin
2012-05-16 11:45 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 02/11] manual: rework introduction.txt and add embedded-basics.txt Samuel Martin
2012-05-16 11:50 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 03/11] manual: add prerequisite.txt Samuel Martin
2012-05-16 16:32 ` Thomas De Schampheleire
2012-05-16 21:45 ` Samuel Martin
2012-05-17 6:53 ` Thomas De Schampheleire
2012-05-13 10:38 ` Samuel Martin [this message]
2012-05-16 16:47 ` [Buildroot] [PATCH v2 04/11] manual: rework using.txt and update common-usage.txt Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 05/11] manual: add make-tips.txt Samuel Martin
2012-05-16 16:55 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 06/11] manual: update working-with.txt Samuel Martin
2012-05-16 17:00 ` Thomas De Schampheleire
2012-05-17 10:02 ` Samuel Martin
2012-05-13 10:38 ` [Buildroot] [PATCH v2 07/11] manual: rework the intro of customize-rootfs.txt Samuel Martin
2012-05-16 17:02 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 08/11] manual: add troubleshooting.txt Samuel Martin
2012-05-16 17:04 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 09/11] manual: add writing-rules.txt Samuel Martin
2012-05-13 14:12 ` Yegor Yefremov
2012-05-16 17:15 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 10/11] manual: add get-involved.txt Samuel Martin
2012-05-13 11:25 ` Yegor Yefremov
2012-05-16 17:21 ` Thomas De Schampheleire
2012-05-13 10:38 ` [Buildroot] [PATCH v2 11/11] manual: add contribute.txt Samuel Martin
2012-05-13 12:16 ` Yegor Yefremov
2012-05-16 17:24 ` Thomas De Schampheleire
2012-08-01 20:43 ` [Buildroot] [PATCH 00/11] RFC: Manual content reorganization Thomas Petazzoni
2012-08-05 14:59 ` Samuel Martin
2012-11-09 21:25 ` Arnout Vandecappelle
2012-11-09 22:45 ` Samuel Martin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1336905501-9757-5-git-send-email-s.martin49@gmail.com \
--to=s.martin49@gmail.com \
--cc=buildroot@busybox.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox