[Qemu-devel] [PATCH] Fix formatting of documentation

[Qemu-devel] [PATCH] Fix formatting of documentation

[Stefan Weil]

[-- Attachment #1: Type: text/plain, Size: 96 bytes --]

Hi,

this patch fixes warnings from "make info". Please apply it to svn trunk.

Thanks,
Stefan


[-- Attachment #2: qemu-nbd.patch --]
[-- Type: text/x-diff, Size: 1515 bytes --]

Fix formatting for documentation of nbd command line options.

Signed-off-by: Stefan Weil <weil@mail.berlios.de> 

Index: qemu-nbd.texi
===================================================================
--- qemu-nbd.texi	(Revision 5283)
+++ qemu-nbd.texi	(Arbeitskopie)
@@ -11,21 +11,21 @@
 @c man end
 
 @c man begin OPTIONS
-@table @var
-@item filename
+@table @option
+@item @var{filename}
  is a disk image filename
-@item -p, --port=PORT
-  port to listen on (default `1024')
-@item -o, --offset=OFFSET
+@item -p, --port=@var{port}
+  port to listen on (default @samp{1024})
+@item -o, --offset=@var{offset}
   offset into the image
-@item -b, --bind=IFACE
-  interface to bind to (default `0.0.0.0')
-@item -k, --socket=PATH
-  Use a unix socket with path PATH
+@item -b, --bind=@var{iface}
+  interface to bind to (default @samp{0.0.0.0})
+@item -k, --socket=@var{path}
+  Use a unix socket with path @var{path}
 @item -r, --read-only
   export read-only
-@item -P, --partition=NUM
-  only expose partition NUM
+@item -P, --partition=@var{num}
+  only expose partition @var{num}
 @item -s, --snapshot
   use snapshot file
 @item -n, --nocache
@@ -34,8 +34,8 @@
   connect FILE to NBD device DEV
 @item -d, --disconnect
   disconnect the specified device
-@item -e, --shared=NUM
-  device can be shared by NUM clients (default '1')
+@item -e, --shared=@var{num}
+  device can be shared by @var{num} clients (default @samp{1})
 @item -t, --persistent
   don't exit on the last connection
 @item -v, --verbose

Re: [Qemu-devel] [PATCH] Fix formatting of documentation

[Anthony Liguori]

Stefan Weil wrote:
> Hi,
>
> this patch fixes warnings from "make info". Please apply it to svn trunk.
>   

Applied.  Thanks.

Regards,

Anthony Liguori

> Thanks,
> Stefan
>
>