From: Simon Glass <sjg@chromium.org>
Date: Thu, 10 Nov 2022 02:14:49 +0000 (-0700)
Subject: binman: Add a separate section about environment variables
X-Git-Url: http://git.dujemihanovic.xyz/img/sics.gif?a=commitdiff_plain;h=85760a690d828616207b13c6148a27d5f0723485;p=u-boot.git

binman: Add a separate section about environment variables

These are documented in various several sections. Add a new section that
mentions them all in one place so it is easier to see what environment
variables can be used to control U-Boot's use of binman.

Signed-off-by: Simon Glass <sjg@chromium.org>
Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---

diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst
index 16508d6ba5..92b21b1c01 100644
--- a/tools/binman/binman.rst
+++ b/tools/binman/binman.rst
@@ -1246,6 +1246,8 @@ You can also replace just a selection of entries::
     $ binman replace -i image.bin "*u-boot*" -I indir
 
 
+.. _`BinmanLogging`:
+
 Logging
 -------
 
@@ -1416,6 +1418,8 @@ what happens in this stage.
 final step.
 
 
+.. _`External tools`:
+
 External tools
 --------------
 
@@ -1437,6 +1441,8 @@ a space-separated list of paths to search, e.g.::
    BINMAN_TOOLPATHS="/tools/g12a /tools/tegra" binman ...
 
 
+.. _`External blobs`:
+
 External blobs
 --------------
 
@@ -1494,6 +1500,30 @@ Binman produces the following exit codes:
     and will return an exit status of 0 instead.
 
 
+U-Boot environment variables for binman
+---------------------------------------
+
+The U-Boot Makefile supports various environment variables to control binman.
+All of these are set within the Makefile and result in passing various
+environment variables (or make flags) to binman:
+
+BINMAN_DEBUG
+    Enables backtrace debugging by adding a `-D` argument. See
+    :ref:`BinmanLogging`.
+
+BINMAN_INDIRS
+    Sets the search path for input files used by binman by adding one or more
+    `-I` arguments. See :ref:`External blobs`.
+
+BINMAN_TOOLPATHS
+    Sets the search path for external tool used by binman by adding one or more
+    `--toolpath` arguments. See :ref:`External tools`.
+
+BINMAN_VERBOSE
+    Sets the logging verbosity of binman by adding a `-v` argument. See
+    :ref:`BinmanLogging`.
+
+
 Error messages
 --------------