]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
tools: Clean up the vol-resize man page
authorJohn Ferlan <jferlan@redhat.com>
Mon, 12 Mar 2018 20:26:40 +0000 (16:26 -0400)
committerJohn Ferlan <jferlan@redhat.com>
Thu, 15 Mar 2018 21:11:42 +0000 (17:11 -0400)
Instead of appearing as one long paragraph, split the output to list
each command option on its own line for better readability.

Signed-off-by: John Ferlan <jferlan@redhat.com>
tools/virsh.pod

index 761199396ceec49dabee1e4ed2f91f6c97e7b890..9d69a75244e1f8ed6c72df6e2f93a668fb0c5645 100644 (file)
@@ -4265,17 +4265,29 @@ the first volume found by the path will be used.
 [I<--allocate>] [I<--delta>] [I<--shrink>]
 
 Resize the capacity of the given volume, in bytes.
+
+I<vol-name-or-key-or-path> is the name or key or path of the volume
+to resize.
+
+I<capacity> is a scaled integer (see B<NOTES> above) for the volume,
+which defaults to bytes if there is no suffix.
+
 I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
-is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
-to resize.  The new capacity might be sparse unless I<--allocate> is
-specified.  Normally, I<capacity> is the new size, but if I<--delta>
-is present, then it is added to the existing size.  Attempts to shrink
-the volume will fail unless I<--shrink> is present; I<capacity> cannot
-be negative unless I<--shrink> is provided, but a negative sign is not
-necessary. I<capacity> is a scaled integer (see B<NOTES> above), which
-defaults to bytes if there is no suffix.  This command is only safe
-for storage volumes not in use by an active guest; see also
-B<blockresize> for live resizing.
+is in. If the volume name is provided instead of the key or path, then
+providing the pool is necessary to find the volume to be uploaded into;
+otherwise, the first volume found by the key or path will be used.
+
+The new I<capacity> might be sparse unless I<--allocate> is specified.
+
+Normally, I<capacity> is the new size, but if I<--delta>
+is present, then it is added to the existing size.
+
+Attempts to shrink the volume will fail unless I<--shrink> is present.
+The I<capacity> cannot be negative unless I<--shrink> is provided, but
+a negative sign is not necessary.
+
+This command is only safe for storage volumes not in use by an active
+guest; see also B<blockresize> for live resizing.
 
 =back