summaryrefslogtreecommitdiffstats
path: root/docs/manual
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manual')
-rw-r--r--docs/manual/adding-packages-generic.txt3
-rw-r--r--docs/manual/adding-packages-virtual.txt15
-rw-r--r--docs/manual/common-usage.txt14
-rw-r--r--docs/manual/customize-packages.txt2
-rw-r--r--docs/manual/make-tips.txt3
-rw-r--r--docs/manual/manual.txt10
6 files changed, 36 insertions, 11 deletions
diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt
index f421651bb0..d3fa45b010 100644
--- a/docs/manual/adding-packages-generic.txt
+++ b/docs/manual/adding-packages-generic.txt
@@ -304,6 +304,9 @@ information is (assuming the package name is +libfoo+) :
a similar way, +HOST_LIBFOO_DEPENDENCIES+ lists the dependencies for
the current host package.
+* +LIBFOO_PROVIDES+ lists all the virtual packages +libfoo+ is an
+ implementation of. See xref:virtual-package-tutorial[].
+
* +LIBFOO_INSTALL_STAGING+ can be set to +YES+ or +NO+ (default). If
set to +YES+, then the commands in the +LIBFOO_INSTALL_STAGING_CMDS+
variables are executed to install the package into the staging
diff --git a/docs/manual/adding-packages-virtual.txt b/docs/manual/adding-packages-virtual.txt
index 1c1116f2bc..0cbe753682 100644
--- a/docs/manual/adding-packages-virtual.txt
+++ b/docs/manual/adding-packages-virtual.txt
@@ -39,7 +39,7 @@ In this file, we declare two options, +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+ and
+BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+, whose values will be used by the
providers.
-==== Virtual package's +*.mk+ file
+==== Virtual package's +.mk+ file
The +.mk+ for the virtual package should just evaluate the +virtual-package+ macro:
@@ -59,8 +59,7 @@ The ability to have target and host packages is also available, with the
==== Provider's +Config.in+ file
When adding a package as a provider, only the +Config.in+ file requires some
-modifications. The +*.mk+ file should follow the Buildroot infrastructure with
-no change at all.
+modifications.
The +Config.in+ file of the package 'some-provider', which provides the
functionalities of 'something-virtual', should contain:
@@ -84,6 +83,16 @@ On line 3, we select +BR2_PACKAGE_HAS_SOMETHING_VIRTUAL+, and on line 11, we
set the value of +BR2_PACKAGE_PROVIDES_SOMETHING_VIRTUAL+ to the name of the
provider, but only if it is selected.
+==== Provider's +.mk+ file
+
+The +.mk+ file should also declare an additional variable
++SOME_PROVIDER_PROVIDES+ to contain the names of all the virtual
+packages it is an implementation of:
+
+---------------------------
+01: SOME_PROVIDER_PROVIDES = something-virtual
+---------------------------
+
Of course, do not forget to add the proper build and runtime dependencies for
this package!
diff --git a/docs/manual/common-usage.txt b/docs/manual/common-usage.txt
index 3d5842d333..772982af5c 100644
--- a/docs/manual/common-usage.txt
+++ b/docs/manual/common-usage.txt
@@ -92,8 +92,8 @@ to +make+ or set in the environment:
build-time graphs
* +BR2_GRAPH_OUT+ to set the filetype of generated graphs, either +pdf+ (the
default), or +png+.
-* +BR2_GRAPH_DEPTH+ (an integer) to limit the depth of the dependency graph.
- The default, +0+, is to not limit the depth.
+* +BR2_GRAPH_DEPS_OPTS+ to pass extra options to the dependency graph; see
+ xref:graph-depends[] for the accepted options
An example that uses config files located in the toplevel directory and
in your $HOME:
@@ -198,6 +198,16 @@ supported.
BR2_GRAPH_OUT=svg make graph-depends
--------------------------------
+The +graph-depends+ behaviour can be controlled by setting options in the
++BR2_GRAPH_DEPS_OPTS+ environment variable. The accepted options are:
+
+* +--depth N+, +-d N+, to limit the dependency depth to +N+ levels. The
+ default, +0+, means no limit.
+
+--------------------------------
+BR2_GRAPH_DEPS_OPTS='-d 3' make graph-depends
+--------------------------------
+
=== Graphing the build duration
[[graph-duration]]
diff --git a/docs/manual/customize-packages.txt b/docs/manual/customize-packages.txt
index 6f70bdb43f..b4ed0b5a42 100644
--- a/docs/manual/customize-packages.txt
+++ b/docs/manual/customize-packages.txt
@@ -86,7 +86,7 @@ If the user has the +BR2_GLOBAL_PATCH_DIR+ configuration option set as
follows:
-----
-BR2_GLOBAL_PATCH_DIR="board/common-fooarch board/fooarch-board"
+BR2_GLOBAL_PATCH_DIR="board/common-fooarch/patches board/fooarch-board/patches"
-----
Then the patches would applied as follows for the Linux kernel:
diff --git a/docs/manual/make-tips.txt b/docs/manual/make-tips.txt
index 13609434e8..9fabb6f742 100644
--- a/docs/manual/make-tips.txt
+++ b/docs/manual/make-tips.txt
@@ -31,8 +31,7 @@ The result of the search shows the help message of the matching items.
Not all targets are always available,
some settings in the +.config+ file may hide some targets:
-* +busybox-menuconfig+ and +busybox-savedefconfig+ only work when
- +busybox+ is enabled;
+* +busybox-menuconfig+ only works when +busybox+ is enabled;
* +linux-menuconfig+ and +linux-savedefconfig+ only work when
+linux+ is enabled;
* +uclibc-menuconfig+ is only available when the uClibc C library is
diff --git a/docs/manual/manual.txt b/docs/manual/manual.txt
index 94259f70eb..bf89af9ee5 100644
--- a/docs/manual/manual.txt
+++ b/docs/manual/manual.txt
@@ -4,12 +4,16 @@
= The Buildroot user manual
:toc:
-Buildroot usage and documentation by Thomas Petazzoni. Contributions
-from Karsten Kruse, Ned Ludd, Martin Herren and others.
-
Buildroot {sys:echo $\{BR2_VERSION%%-git*\}} manual generated on {localdate}
{localtime} from git revision {sys:git rev-parse --short HEAD}
+The Buildroot manual is written by the Buildroot developers.
+It is licensed under the GNU General Public License, version 2. Refer to the
+http://git.buildroot.org/buildroot/tree/COPYING[COPYING] file in the Buildroot
+sources for the full text of this license.
+
+Copyright (C) 2004-2014 The Buildroot developers
+
image::logo.png[]
:leveloffset: 1
OpenPOWER on IntegriCloud