[PATCH 18/24] binman: Tidy up the docs a little with fit
Simon Glass
sjg at chromium.org
Tue Feb 8 19:50:02 CET 2022
Add a few quotes and clarify the data property.
Signed-off-by: Simon Glass <sjg at chromium.org>
---
tools/binman/entries.rst | 15 ++++++++-------
tools/binman/etype/fit.py | 15 ++++++++-------
2 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/tools/binman/entries.rst b/tools/binman/entries.rst
index b32dc58933..d4a1f333dc 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 b159844960..bf84246904 100644
--- a/tools/binman/etype/fit.py
+++ b/tools/binman/etype/fit.py
@@ -47,10 +47,10 @@ class Entry_fit(Entry):
};
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 '@'::
@@ -62,10 +62,11 @@ class Entry_fit(Entry):
};
};
- 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::
@@ -79,8 +80,8 @@ class Entry_fit(Entry):
};
};
- 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:
--
2.35.0.263.gb82422642f-goog
More information about the U-Boot
mailing list