jeans/motioneyeos
jeans/motioneyeos
1
0
Fork 0
mirror of https://github.com/motioneye-project/motioneyeos.git synced 2025-07-25 20:26:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: rework using.txt and update common-usage.txt

Browse Source 
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>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
This commit is contained in:
Samuel Martin 2012-11-11 03:14:44 +00:00 committed by Peter Korsgaard
parent 0119ef3778
commit a90382616c
2 changed files with 110 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
docs/manual/common-usage.txt
View File

@ -4,3 +4,98 @@ Daily use
--------- ---------
include::rebuilding-packages.txt[] 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
~~~~~~~~~~~~~~~~~~~~
As default, everything built by Buildroot is stored in the directory
+output+ in the buildroot tree.
Buildroot also 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.
+
Note that the uClibc configuration file can also be set from the
configuration interface, so through the Buildroot .config file; this
the actual recommended way of setting it.
+
* +BUSYBOX_CONFIG_FILE=<path/to/.config>+, path to
the Busybox configuration file.
+
Note that the Busybox configuration file can also be set from the
configuration interface, so through the Buildroot .config file; this
the actual recommended way of setting it.
+
* +BUILDROOT_DL_DIR+ to override the directory in which
Buildroot stores/retrieves downloaded files
+
Note that the Buildroot download directory can also be set from the
configuration interface, so through the Buildroot .config file; this
the actual recommended way of setting it.
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
--------------------

100
docs/manual/using.txt
View File

@ -5,8 +5,8 @@ Using Buildroot
Buildroot has a nice configuration tool similar to the one you can Buildroot has a nice configuration tool similar to the one you can
find in the http://www.kernel.org/[Linux kernel] or in find in the http://www.kernel.org/[Linux kernel] or in
http://www.busybox.net/[Busybox]. Note that you can (and should) build 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 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 and use Buildroot. The first step is to run the configuration
assistant: assistant:
@ -29,12 +29,11 @@ or
to run the Qt or GTK-based configurators. to run the Qt or GTK-based configurators.
All of these "make" commands will need to build a configuration All of these "make" commands will need to build a configuration
utility, so you may need to install "development" packages for utility (including the interface), so you may need to install
relevant libraries used by the configuration utilities. On Debian-like "development" packages for relevant libraries used by the
systems, the +libncurses5-dev+ package is required to use the configuration utilities. Check the xref:requirement[] to know what
'menuconfig' interface, +libqt4-dev+ is required to use the 'xconfig' Buildroot needs, and specifically the xref:requirement-optional[system requirements]
interface, and +libglib2.0-dev, libgtk2.0-dev and libglade2-dev+ are to get the dependencies of favorite interface.
needed to use the 'gconfig' interface.
For each menu entry in the configuration tool, you can find associated For each menu entry in the configuration tool, you can find associated
help that describes the purpose of the entry. help that describes the purpose of the entry.
@ -56,9 +55,9 @@ tell Buildroot to run each package compilation with +make -jN+.
This command will generally perform the following steps: This command will generally perform the following steps:
* Download source files (as required) * Download source files (as required)
* Configure, build and install the cross-compiling toolchain if an * Configure, build and install the cross-compiling toolchain using the
internal toolchain is used, or import a toolchain if an external appropriate toolchain backend is used, or simply import a toolchain
toolchain is used if an external toolchain
* Build/install selected target packages * Build/install selected target packages
* Build a kernel image, if selected * Build a kernel image, if selected
* Build a bootloader image, if selected * Build a bootloader image, if selected
@ -105,81 +104,12 @@ This directory contains several subdirectories:
* +toolchain/+ contains the build directories for the various * +toolchain/+ contains the build directories for the various
components of the cross-compilation toolchain. 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 More details about the "make" command usage are given in
all sources that you previously selected in the configurator xref:make-tips[].
('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
--------------------
Complying with opensource licenses Complying with opensource licenses
---------------------------------- ----------------------------------