[PATCH 11/11] tools: Clean up the vol-resize man page

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxx>
---
 tools/virsh.pod | 32 ++++++++++++++++++++++----------
 1 file changed, 22 insertions(+), 10 deletions(-)

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 366a628f9..d3ae7bb5d 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -4264,17 +4264,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
 
-- 
2.13.6

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list



[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux