diff options
author | Simon Glass <sjg@chromium.org> | 2020-10-26 17:40:09 -0600 |
---|---|---|
committer | Simon Glass <sjg@chromium.org> | 2020-10-29 14:42:59 -0600 |
commit | f90d906a275f85e7077d9a30ab82b20676b54645 (patch) | |
tree | ecce3b12a7a78d5ebcd90223e330719f9c2f6872 /tools/binman/README | |
parent | ef439ed191a0655a86f5b4035cec9cc57e97d8b1 (diff) | |
download | u-boot-f90d906a275f85e7077d9a30ab82b20676b54645.tar.gz |
binman: Expand docs and test for padding
Padding becomes part of the entry once the image is written out, but
within binman the entry contents does not include the padding. Add
documentation to make this clear, as well as a test.
Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'tools/binman/README')
-rw-r--r-- | tools/binman/README | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/tools/binman/README b/tools/binman/README index fbcfdc77c3..0433cabce4 100644 --- a/tools/binman/README +++ b/tools/binman/README @@ -290,14 +290,20 @@ size: pad-before: Padding before the contents of the entry. Normally this is 0, meaning - that the contents start at the beginning of the entry. This can be - offset the entry contents a little. Defaults to 0. + that the contents start at the beginning of the entry. This can be used + to offset the entry contents a little. While this does not affect the + contents of the entry within binman itself (the padding is performed + only when its parent section is assembled), the end result will be that + the entry starts with the padding bytes, so may grow. Defaults to 0. pad-after: Padding after the contents of the entry. Normally this is 0, meaning that the entry ends at the last byte of content (unless adjusted by other properties). This allows room to be created in the image for - this entry to expand later. Defaults to 0. + this entry to expand later. While this does not affect the contents of + the entry within binman itself (the padding is performed only when its + parent section is assembled), the end result will be that the entry ends + with the padding bytes, so may grow. Defaults to 0. align-size: This sets the alignment of the entry size. For example, to ensure |