binman: Add support for passing arguments to entries

[oweals/u-boot.git] / tools / binman / README

diff --git a/tools/binman/README b/tools/binman/README
index df88819a1c398a0ff205b789d4912dcb7f770806..d60c7fd6a3ecd145ca66177b476af1b18ae3a7ae 100644 (file)
--- a/tools/binman/README
+++ b/tools/binman/README
@@ -615,6 +615,26 @@ each entry is also shown, in bytes (hex). The indentation shows the entries
 nested inside their sections.
 
 
+Passing command-line arguments to entries
+-----------------------------------------
+
+Sometimes it is useful to pass binman the value of an entry property from the
+command line. For example some entries need access to files and it is not
+always convenient to put these filenames in the image definition (device tree).
+
+The-a option supports this:
+
+    -a<prop>=<value>
+
+where
+
+    <prop> is the property to set
+    <value> is the value to set it to
+
+Not all properties can be provided this way. Only some entries support it,
+typically for filenames.
+
+
 Code coverage
 -------------