Skip to contentSkip to conversation

qemu-img.texi: Describe data_file and data_file_raw

PATCH In review Han Han 4 participants 4 messages Oct 21, 2019 – Oct 28, 2019

lore
Share & tools
lore

Han Han

author
#0 lore raw

PATCH v2 1/1 qemu-img.texi: Describe data_file and data_file_raw

https://bugzilla.redhat.com/show_bug.cgi?id=1763105

---
 qemu-img.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)
qemu-img.texi +10 -0
index b5156d6316..983c6122f8 100644
@@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
 
+@item data_file
+File name of data file that is stored in the image and used as a default for
+opening the image. If the option is used, qcow2 file only stores the metadata
+for the image.
+
+@item data_file_raw
+This option requires @option{data_file}. If this option is set to @code{on},
+qemu will always keep the external data file consistent as a standalone
+read-only raw image. Default value is @code{off}.
+
 @end table
 
 @item Other
Signature · 1 line
2.20.1
Reviewed-by on v2 1/1
#1 lore raw
Quoted 19 lines · Han Han

https://bugzilla.redhat.com/show_bug.cgi?id=1763105

---
 qemu-img.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)
qemu-img.texi +3 -0
index b5156d6316..983c6122f8 100644
@@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
 
+@item data_file
+File name of data file that is stored in the image and used as a default for
+opening the image. If the option is used, qcow2 file only stores the metadata

qemu-img.texi file which is COW and has data blocks already, it couldn't be changed to NOCOW · line 778

Quoted 10 lines
qemu-img.texi +7 -0
+for the image.
+
+@item data_file_raw
+This option requires @option{data_file}. If this option is set to @code{on},
+qemu will always keep the external data file consistent as a standalone
+read-only raw image. Default value is @code{off}.
+
 @end table
 
 @item Other
#3 lore raw
In reply to Han Han
Quoted 12 lines · Han Han

https://bugzilla.redhat.com/show_bug.cgi?id=1763105

---
 qemu-img.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)
qemu-img.texi +0 -0
index b5156d6316..983c6122f8 100644

qemu-img.texi file which is COW and has data blocks already, it couldn't be changed to NOCOW · line 764

Quoted 2 lines
qemu-img.texi +0 -0
@@ -763,6 +763,16 @@ file which is COW and has data blocks already, it couldn't be changed to NOCOW
 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).

Usually, I try not to be pedantic about specific phrasing and the like, but this is going in the man page, so I suppose I have to be.

qemu-img.texi file which is COW and has data blocks already, it couldn't be changed to NOCOW · line 767

Quoted 2 lines
qemu-img.texi +2 -0
+@item data_file
+File name of data file that is stored in the image and used as a default for

This sounds a bit like the data file itself were stored in the image.

Also, I don’t think the bit about this being a default is necessary because several qcow2 creation options are in some way only defaults than can be overridden at runtime (like lazy_refcounts or backing_file).
So I don’t think there is a need to make a mention of that here.

qemu-img.texi file which is COW and has data blocks already, it couldn't be changed to NOCOW · line 769

Quoted 2 lines
qemu-img.texi +2 -0
+opening the image. If the option is used, qcow2 file only stores the metadata
+for the image.

Maybe:

Path to a file in which to store all guest data. If this option is used, the qcow2 file will only contain the image's metadata.

qemu-img.texi file which is COW and has data blocks already, it couldn't be changed to NOCOW · line 774

Quoted 5 lines
qemu-img.texi +5 -0
+
+@item data_file_raw
+This option requires @option{data_file}. If this option is set to @code{on},
+qemu will always keep the external data file consistent as a standalone
+read-only raw image. Default value is @code{off}.

For this paragraph OTOH I have absolutely no complaints. :-)

Max