summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2022-02-08 11:50:02 -0700
committerSimon Glass <sjg@chromium.org>2022-02-22 10:05:44 -0700
commit98e0de3fb788cfd9b895840982a15dfcbe460920 (patch)
tree9e287315e436ccc751d0bb40453dc4b644949e33 /tools
parentdbe17c0008cfdbcde4ffa3a9c411e25a01553847 (diff)
binman: Tidy up the docs a little with fit
Add a few quotes and clarify the data property. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'tools')
-rw-r--r--tools/binman/entries.rst15
-rw-r--r--tools/binman/etype/fit.py15
2 files changed, 16 insertions, 14 deletions
diff --git a/tools/binman/entries.rst b/tools/binman/entries.rst
index c4aa5fffe8..053e1d7838 100644
--- a/tools/binman/entries.rst
+++ b/tools/binman/entries.rst
@@ -554,10 +554,10 @@ For example, this creates an image containing a FIT with U-Boot SPL::
};
U-Boot supports creating fdt and config nodes automatically. To do this,
-pass an of-list property (e.g. -a of-list=file1 file2). This tells binman
-that you want to generates nodes for two files: file1.dtb and file2.dtb
-The fit,fdt-list property (see above) indicates that of-list should be used.
-If the property is missing you will get an error.
+pass an `of-list` property (e.g. `-a of-list=file1 file2`). This tells
+binman that you want to generates nodes for two files: `file1.dtb` and
+`file2.dtb`. The `fit,fdt-list` property (see above) indicates that
+`of-list` should be used. If the property is missing you will get an error.
Then add a 'generator node', a node with a name starting with '@'::
@@ -569,10 +569,11 @@ Then add a 'generator node', a node with a name starting with '@'::
};
};
-This tells binman to create nodes fdt-1 and fdt-2 for each of your two
+This tells binman to create nodes `fdt-1` and `fdt-2` for each of your two
files. All the properties you specify will be included in the node. This
node acts like a template to generate the nodes. The generator node itself
does not appear in the output - it is replaced with what binman generates.
+A 'data' property is created with the contents of the FDT file.
You can create config nodes in a similar way::
@@ -586,8 +587,8 @@ You can create config nodes in a similar way::
};
};
-This tells binman to create nodes config-1 and config-2, i.e. a config for
-each of your two files.
+This tells binman to create nodes `config-1` and `config-2`, i.e. a config
+for each of your two files.
Available substitutions for '@' nodes are:
diff --git a/tools/binman/etype/fit.py b/tools/binman/etype/fit.py
index 2657e6c9d2..d3e61c4ad2 100644
--- a/tools/binman/etype/fit.py
+++ b/tools/binman/etype/fit.py
@@ -48,10 +48,10 @@ class Entry_fit(Entry_section):
};
U-Boot supports creating fdt and config nodes automatically. To do this,
- pass an of-list property (e.g. -a of-list=file1 file2). This tells binman
- that you want to generates nodes for two files: file1.dtb and file2.dtb
- The fit,fdt-list property (see above) indicates that of-list should be used.
- If the property is missing you will get an error.
+ pass an `of-list` property (e.g. `-a of-list=file1 file2`). This tells
+ binman that you want to generates nodes for two files: `file1.dtb` and
+ `file2.dtb`. The `fit,fdt-list` property (see above) indicates that
+ `of-list` should be used. If the property is missing you will get an error.
Then add a 'generator node', a node with a name starting with '@'::
@@ -63,10 +63,11 @@ class Entry_fit(Entry_section):
};
};
- This tells binman to create nodes fdt-1 and fdt-2 for each of your two
+ This tells binman to create nodes `fdt-1` and `fdt-2` for each of your two
files. All the properties you specify will be included in the node. This
node acts like a template to generate the nodes. The generator node itself
does not appear in the output - it is replaced with what binman generates.
+ A 'data' property is created with the contents of the FDT file.
You can create config nodes in a similar way::
@@ -80,8 +81,8 @@ class Entry_fit(Entry_section):
};
};
- This tells binman to create nodes config-1 and config-2, i.e. a config for
- each of your two files.
+ This tells binman to create nodes `config-1` and `config-2`, i.e. a config
+ for each of your two files.
Available substitutions for '@' nodes are: