[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v2 2/3] qemu-nbd: Minor texi updates
From: |
Sitsofe Wheeler |
Subject: |
[Qemu-devel] [PATCH v2 2/3] qemu-nbd: Minor texi updates |
Date: |
Tue, 5 Jan 2016 07:33:31 +0000 |
- Change some spacing.
- Add disconnect usage to synopsis.
- Highlight the command and its options in the synopsis.
- Fix up the grammar in the description.
- Move filename variable description out of the option table.
- Add a description of the dev variable.
- Remove duplicate entry for --format.
- Reword --discard documentation.
- Add --detect-zeroes documentation.
- Add reference to qemu man page to see also section.
Signed-off-by: Sitsofe Wheeler <address@hidden>
---
qemu-nbd.texi | 34 ++++++++++++++++++++++------------
1 file changed, 22 insertions(+), 12 deletions(-)
diff --git a/qemu-nbd.texi b/qemu-nbd.texi
index 26cc985..5331d69 100644
--- a/qemu-nbd.texi
+++ b/qemu-nbd.texi
@@ -1,19 +1,23 @@
@example
@c man begin SYNOPSIS
-usage: qemu-nbd [OPTION]... @var{filename}
address@hidden [OPTION]... @var{filename}
+
address@hidden @option{-d} @var{dev}
@c man end
@end example
@c man begin DESCRIPTION
-Export QEMU disk image using NBD protocol.
+Export a QEMU disk image using the NBD protocol.
@c man end
@c man begin OPTIONS
address@hidden is a disk image filename.
+
address@hidden is an NBD device.
+
@table @option
address@hidden @var{filename}
-is a disk image filename
@item -p, address@hidden
port to listen on (default @samp{10809})
@item -o, address@hidden
@@ -22,8 +26,9 @@ offset into the image
interface to bind to (default @samp{0.0.0.0})
@item -k, address@hidden
Use a unix socket with path @var{path}
address@hidden -f, address@hidden
-Set image format as @var{format}
address@hidden -f, address@hidden
+force the use of the block driver for format @var{fmt} instead of
+auto-detecting
@item -r, --read-only
export read-only
@item -P, address@hidden
@@ -44,17 +49,22 @@ the emulator's @code{-drive cache=...} option for allowed
values.
choose asynchronous I/O mode between @samp{threads} (the default)
and @samp{native} (Linux only).
@item address@hidden
-toggles whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
-requests are ignored or passed to the filesystem. The default is no
-(@samp{--discard=ignore}).
+controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
+requests are ignored or passed to the filesystem. @var{discard} is one of
address@hidden (or @samp{off}), @samp{unmap} (or @samp{on}). The default is
address@hidden
address@hidden address@hidden
+enables the automatic conversion of plain zero writes by the OS to
+driver-specific optimized zero write commands. @var{detect-zeroes} is one of
address@hidden, @samp{on} or @samp{unmap}. @samp{unmap}
+converts a zero write to an unmap operation and can only be used if
address@hidden is set to @samp{unmap}. The default is @samp{off}.
@item -c, address@hidden
connect @var{filename} to NBD device @var{dev}
@item -d, --disconnect
disconnect the specified device
@item -e, address@hidden
device can be shared by @var{num} clients (default @samp{1})
address@hidden -f, address@hidden
-force block driver for format @var{fmt} instead of auto-detecting
@item -t, --persistent
don't exit on the last connection
@item -v, --verbose
@@ -79,7 +89,7 @@ warranty; not even for MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.
@c man end
@c man begin SEEALSO
-qemu-img(1)
+qemu(1), qemu-img(1)
@c man end
@end ignore
--
2.4.3