[Qemu-devel] [PATCH] docs: Style the command and its options in the synopsis

[Qemu-devel] [PATCH] docs: Style the command and its options in the synopsis

[Sitsofe Wheeler]

Signed-off-by: Sitsofe Wheeler <sitsofe@yahoo.com>
---
 fsdev/virtfs-proxy-helper.texi | 2 +-
 qemu-doc.texi                  | 8 ++++----
 qemu-ga.texi                   | 2 +-
 qemu-img.texi                  | 2 +-
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/fsdev/virtfs-proxy-helper.texi b/fsdev/virtfs-proxy-helper.texi
index e60e3b9..9a25d7e 100644
--- a/fsdev/virtfs-proxy-helper.texi
+++ b/fsdev/virtfs-proxy-helper.texi
@@ -1,6 +1,6 @@
 @example
 @c man begin SYNOPSIS
-usage: virtfs-proxy-helper options
+@command{virtfs-proxy-helper} @var{options}
 @c man end
 @end example
 
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 7bc3882..ca4d9de 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -259,7 +259,7 @@ Linux should boot and give you a prompt.
 
 @example
 @c man begin SYNOPSIS
-usage: qemu-system-i386 [options] [@var{disk_image}]
+@command{qemu-system-i386} [@var{options}] [@var{disk_image}]
 @c man end
 @end example
 
@@ -1406,7 +1406,7 @@ no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
 This USB device implements the USB Transport Layer of HCI.  Example
 usage:
 @example
-qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
+@command{qemu-system-i386} [...@var{OPTIONS}...] @option{-usbdevice} bt:hci,vlan=3 @option{-bt} device:keyboard,vlan=3
 @end example
 @end table
 
@@ -2755,7 +2755,7 @@ qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
 @subsection Command line options
 
 @example
-usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
+@command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
 @end example
 
 @table @option
@@ -2897,7 +2897,7 @@ qemu-sparc64 /bin/ls
 @subsection Command line options
 
 @example
-usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
+@command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
 @end example
 
 @table @option
diff --git a/qemu-ga.texi b/qemu-ga.texi
index 536a9b5..0e53bf6 100644
--- a/qemu-ga.texi
+++ b/qemu-ga.texi
@@ -1,6 +1,6 @@
 @example
 @c man begin SYNOPSIS
-usage: qemu-ga [OPTIONS]
+@command{qemu-ga} [@var{OPTIONS}]
 @c man end
 @end example
 
diff --git a/qemu-img.texi b/qemu-img.texi
index 55c6be3..7163a10 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -1,6 +1,6 @@
 @example
 @c man begin SYNOPSIS
-usage: qemu-img command [command options]
+@command{qemu-img} @var{command} [@var{command} @var{options}]
 @c man end
 @end example
 
-- 
2.4.3

Re: [Qemu-devel] [PATCH] docs: Style the command and its options in the synopsis

[Paolo Bonzini]

On 13/01/2016 21:50, Sitsofe Wheeler wrote:
> Signed-off-by: Sitsofe Wheeler <sitsofe@yahoo.com>
> ---
>  fsdev/virtfs-proxy-helper.texi | 2 +-
>  qemu-doc.texi                  | 8 ++++----
>  qemu-ga.texi                   | 2 +-
>  qemu-img.texi                  | 2 +-
>  4 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/fsdev/virtfs-proxy-helper.texi b/fsdev/virtfs-proxy-helper.texi
> index e60e3b9..9a25d7e 100644
> --- a/fsdev/virtfs-proxy-helper.texi
> +++ b/fsdev/virtfs-proxy-helper.texi
> @@ -1,6 +1,6 @@
>  @example
>  @c man begin SYNOPSIS
> -usage: virtfs-proxy-helper options
> +@command{virtfs-proxy-helper} @var{options}
>  @c man end
>  @end example
>  
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 7bc3882..ca4d9de 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -259,7 +259,7 @@ Linux should boot and give you a prompt.
>  
>  @example
>  @c man begin SYNOPSIS
> -usage: qemu-system-i386 [options] [@var{disk_image}]
> +@command{qemu-system-i386} [@var{options}] [@var{disk_image}]
>  @c man end
>  @end example
>  
> @@ -1406,7 +1406,7 @@ no type is given, the HCI logic corresponds to @code{-bt hci,vlan=0}.
>  This USB device implements the USB Transport Layer of HCI.  Example
>  usage:
>  @example
> -qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
> +@command{qemu-system-i386} [...@var{OPTIONS}...] @option{-usbdevice} bt:hci,vlan=3 @option{-bt} device:keyboard,vlan=3
>  @end example
>  @end table
>  
> @@ -2755,7 +2755,7 @@ qemu-i386 /usr/local/qemu-i386/wine/bin/wine \
>  @subsection Command line options
>  
>  @example
> -usage: qemu-i386 [-h] [-d] [-L path] [-s size] [-cpu model] [-g port] [-B offset] [-R size] program [arguments...]
> +@command{qemu-i386} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-cpu} @var{model}] [@option{-g} @var{port}] [@option{-B} @var{offset}] [@option{-R} @var{size}] @var{program} [@var{arguments}...]
>  @end example
>  
>  @table @option
> @@ -2897,7 +2897,7 @@ qemu-sparc64 /bin/ls
>  @subsection Command line options
>  
>  @example
> -usage: qemu-sparc64 [-h] [-d] [-L path] [-s size] [-bsd type] program [arguments...]
> +@command{qemu-sparc64} [@option{-h]} [@option{-d]} [@option{-L} @var{path}] [@option{-s} @var{size}] [@option{-bsd} @var{type}] @var{program} [@var{arguments}...]
>  @end example
>  
>  @table @option
> diff --git a/qemu-ga.texi b/qemu-ga.texi
> index 536a9b5..0e53bf6 100644
> --- a/qemu-ga.texi
> +++ b/qemu-ga.texi
> @@ -1,6 +1,6 @@
>  @example
>  @c man begin SYNOPSIS
> -usage: qemu-ga [OPTIONS]
> +@command{qemu-ga} [@var{OPTIONS}]
>  @c man end
>  @end example
>  
> diff --git a/qemu-img.texi b/qemu-img.texi
> index 55c6be3..7163a10 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -1,6 +1,6 @@
>  @example
>  @c man begin SYNOPSIS
> -usage: qemu-img command [command options]
> +@command{qemu-img} @var{command} [@var{command} @var{options}]
>  @c man end
>  @end example
>  
> 

Queued, thanks.

Paolo