docs: update info regarding resize of raw_image

This commit adds additional explanations and warnings regarding newly discovered compatibility issues between e2fsprogs used by host and yocto. Signed-off-by: Ruslan Shymkevych <[email protected]> Acked-by: Volodymyr Babchuk <[email protected]>
xen-troops · Jan 7, 2025 · 1ce6e3c · 1ce6e3c
1 parent a5ab328
commit 1ce6e3c
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/rouge.rst b/docs/rouge.rst
@@ -249,7 +249,14 @@ resulting image.
 :code:`size` is optional. If it is omitted, `rouge` will use size of
 file. If provided :code:`size` is smaller than file size, `rouge` will
 stop with an error. If provided :code:`size` is bigger than file size,
-`rouge` will try to resize the file to match :code:`size`.
+`rouge` will try to resize the file to match :code:`size`. This rule
+applies to ext2..ext4 format now.
+Note that host tools perform resizing, and you may meet some
+compatibility issues if the newer tools generate the ext4 image.
+For example, if the ext4 image is generated by the yocto scarthgap
+with e2fsprogs 1.47, then such image can be resized only on the host
+with Ubuntu 23+. The lower versions of Ubuntu have e2fsprogs that
+can't resize such image.
 
 :code:`resize` is optional. If set to :code:`false`, it will prevent
 `rouge` from resizing the image to the size of the block. This is