summaryrefslogtreecommitdiffstats
path: root/docs/manual/common-usage.txt
diff options
context:
space:
mode:
authorYann E. MORIN <yann.morin.1998@free.fr>2014-05-16 23:05:13 +0200
committerPeter Korsgaard <peter@korsgaard.com>2014-05-17 23:36:06 +0200
commit287a88286b0e5335438955f8acc6f3abbfe5c1a2 (patch)
treed0d70787da3cdd6b5b207b4dfeff239811a3606d /docs/manual/common-usage.txt
parent3ab9774f234946552df041a3d1459fd21a2d982d (diff)
downloadbuildroot-287a88286b0e5335438955f8acc6f3abbfe5c1a2.tar.gz
buildroot-287a88286b0e5335438955f8acc6f3abbfe5c1a2.zip
graph-depends: rename the variable to pass the max depth
There will soon be new options to the graph-depends script, which we can only sanely pass via environment variables. Currently, we use such an environment variable to pass the maximum depth of the dependency graph; the name of that variable is explicit that it contains just the depth. However, there has been so far no release of Buildroot which would make use of that variable, so no user should have come to rely on it. Rename that variable so it is less specific, and more generic, so it can be used to pass more options to graph-depends. Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr> Cc: Thomas Petazzoni <thomas.petazzoni@free-electrons.com> Cc: Maxime Hadjinlian <maxime.hadjinlian@gmail.com> Cc: Samuel Martin <s.martin49@gmail.com> Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
Diffstat (limited to 'docs/manual/common-usage.txt')
-rw-r--r--docs/manual/common-usage.txt14
1 files changed, 12 insertions, 2 deletions
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]]
OpenPOWER on IntegriCloud