[Buildroot] [PATCH v2 8/9] docs/manual: add allowed notations section for genimage.cfg files
Giulio Benetti
giulio.benetti at benettiengineering.com
Tue Nov 9 10:18:43 UTC 2021
Add allowed notations section for genimage.cfg files by specifying the
accepted suffix or prefix. Note that "K" has been decided to specify
KiloBytes as 1024 bytes. This has been done because in Buildroot the 90%
of the cases were using "K" and not "k".
Signed-off-by: Giulio Benetti <giulio.benetti at benettiengineering.com>
---
docs/manual/writing-rules.txt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/manual/writing-rules.txt b/docs/manual/writing-rules.txt
index 28cb0fe4f1..138c39db14 100644
--- a/docs/manual/writing-rules.txt
+++ b/docs/manual/writing-rules.txt
@@ -192,6 +192,11 @@ image sdimage.img {
* Filename must at least begin with genimage prefix and have the .cfg
extension to be easy to recognize.
+* Allowed notations for +offset+ and +size+ options are: +G+, +M+, +K+(not k).
+ If it's not possible to express a precise byte count with notations above
+ then use hexadecimal +0x+ prefix or, as last chance, the byte count.
+ In comments instead use +GB+, +MB+, +KB+(not kb) in place of +G+, +M+, +K+.
+
The +genimage.cfg+ files are the input for the genimage tool used in
Buildroot to generate the final image file(i.e. sdcard.img). For further
details about the _genimage_ language, refer to
--
2.25.1
More information about the buildroot
mailing list