2012-11-11 04:14:54 +01:00
|
|
|
// -*- mode:doc; -*-
|
2013-02-13 13:59:02 +01:00
|
|
|
// vim: set syntax=asciidoc:
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
[[pkg-build-steps]]
|
|
|
|
|
|
manual: high-level restructuring
The structure of the buildroot manual is not always clear. There is a large
number of chapters, and some chapters seem to overlap. The distinction
between general usage and developer information is not always clear.
This patch restructures the manual into four large parts:
- getting started
- user guide
- developer guide
- appendix
Except for the names of these parts, the section names are not yet changed.
Content-wise there are no changes yet either. This will be handled in
subsequent patches.
In order to achieve the introduction of a new level 'parts' above
'chapters', the section indicators (=, ==, ===, ...) of several sections
have to be moved one level down. Additionally, the leveloffset indication to
asciidoc has to be removed. Finally, to maintain more or less the same level
of detail in the table of contents, the toc.section.depth attribute is
reduced as well. Note that for some sections, less detail is visible now.
Signed-off-by: Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
2014-08-12 22:20:06 +02:00
|
|
|
==== Package-specific _make_ targets
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
Running +make <package>+ builds and installs that particular package
|
|
|
|
|
and its dependencies.
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
For packages relying on the Buildroot infrastructure, there are
|
2012-11-11 04:14:54 +01:00
|
|
|
numerous special make targets that can be called independently like
|
|
|
|
|
this:
|
|
|
|
|
|
|
|
|
|
------------
|
|
|
|
|
make <package>-<target>
|
|
|
|
|
------------
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
The package build targets are (in the order they are executed):
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
[width="90%",cols="^1,4",options="header"]
|
|
|
|
|
|===================================================
|
|
|
|
|
| command/target | Description
|
|
|
|
|
|
|
|
|
|
| +source+ | Fetch the source (download the tarball, clone
|
|
|
|
|
the source repository, etc)
|
|
|
|
|
|
|
|
|
|
| +depends+ | Build and install all dependencies required to
|
|
|
|
|
build the package
|
|
|
|
|
|
|
|
|
|
| +extract+ | Put the source in the package build directory
|
|
|
|
|
(extract the tarball, copy the source, etc)
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +patch+ | Apply the patches, if any
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +configure+ | Run the configure commands, if any
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +build+ | Run the compilation commands
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install-staging+ |
|
|
|
|
|
*target package:* Run the installation of the package in the
|
2012-11-27 12:59:17 +01:00
|
|
|
staging directory, if necessary
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install-target+ |
|
|
|
|
|
*target package:* Run the installation of the package in the
|
2012-11-27 12:59:17 +01:00
|
|
|
target directory, if necessary
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
| +install+ |
|
2012-11-27 12:59:17 +01:00
|
|
|
*target package:* Run the 2 previous installation commands
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
*host package:* Run the installation of the package in the host
|
|
|
|
|
directory
|
|
|
|
|
|
|
|
|
|
|===================================================
|
|
|
|
|
|
|
|
|
|
Additionally, there are some other useful make targets:
|
|
|
|
|
|
|
|
|
|
[width="90%",cols="^1,4",options="header"]
|
|
|
|
|
|===================================================
|
|
|
|
|
| command/target | Description
|
|
|
|
|
|
|
|
|
|
| +show-depends+ | Displays the dependencies required to build the
|
|
|
|
|
package
|
|
|
|
|
|
2014-02-23 16:04:39 +01:00
|
|
|
| +graph-depends+ | Generate a dependency graph of the package, in the
|
|
|
|
|
context of the current Buildroot configuration. See
|
|
|
|
|
xref:graph-depends[this section] for more details about dependency
|
|
|
|
|
graphs.
|
|
|
|
|
|
2012-11-11 04:14:54 +01:00
|
|
|
| +dirclean+ | Remove the whole package build directory
|
|
|
|
|
|
2014-11-28 16:25:05 +01:00
|
|
|
| +reinstall+ | Re-run the install commands
|
|
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +rebuild+ | Re-run the compilation commands - this only makes
|
|
|
|
|
sense when using the +OVERRIDE_SRCDIR+ feature or when you modified a file
|
|
|
|
|
directly in the build directory
|
2012-11-11 04:14:54 +01:00
|
|
|
|
2012-11-27 12:59:17 +01:00
|
|
|
| +reconfigure+ | Re-run the configure commands, then rebuild - this only
|
|
|
|
|
makes sense when using the +OVERRIDE_SRCDIR+ feature or when you modified a
|
|
|
|
|
file directly in the build directory
|
2012-11-11 04:14:54 +01:00
|
|
|
|
|
|
|
|
|===================================================
|
