e2image: Add image consistency information and -f option to manpage

Message ID 1380575965-9668-1-git-send-email-cmaiolino@redhat.com
State Superseded, archived
Headers show

Commit Message

Carlos Maiolino Sept. 30, 2013, 9:19 p.m.
Adds information regarding image consistency when using e2image on a read-write
filesystem and about -f option used now to force the image creation of a
read-write filesystem

Signed-off-by: Carlos Maiolino <cmaiolino@redhat.com>
 misc/e2image.8.in | 12 ++++++++++++
 1 file changed, 12 insertions(+)


diff --git a/misc/e2image.8.in b/misc/e2image.8.in
index 84b9729..eb22f42 100644
--- a/misc/e2image.8.in
+++ b/misc/e2image.8.in
@@ -30,6 +30,18 @@  recovering catastrophically corrupted filesystems.  In the future,
 e2fsck will be enhanced to be able to use the image file to help
 recover a badly damaged filesystem.
+When getting an image to be used for debugging purposes, is necessary that the
+filesystem be unmounted or in a Read-Only state, to ensure the image-file will
+be in a consistent state. Although, it's possible to force an image-file
+creation using the 
+.B -f
+option. For images saved for metadata backup purposes (to be restored with
+.B -I
+.B e2image
+will be backing up only statically located metadata blocks, so, images taken
+from a read-write filesystem are not completely useless, and, although recommended, there is no real need to run it on a Read-Only or unmounted filesystem.
 .I image-file
 is \-, then the output of