qemu-options: Texinfo and --help fixes

[Qemu-devel] [PATCH 6/8] qemu-options: Polish section "TPM device options"

Posted by Markus Armbruster 8 years, 4 months ago

Cc: Stefan Berger <stefanb@linux.vnet.ibm.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qemu-options.hx | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 8568ee388c..615cb230ab 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2915,19 +2915,18 @@ The general form of a TPM device option is:
 
 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
 @findex -tpmdev
-Backend type must be:
-@option{passthrough}.
 
 The specific backend type will determine the applicable options.
 The @code{-tpmdev} option creates the TPM backend and requires a
 @code{-device} option that specifies the TPM frontend interface model.
 
-Options to each backend are described below.
+Use @code{-tpmdev help} to print all available TPM backend types.
 
-Use 'help' to print all available TPM backend types.
-@example
-qemu -tpmdev help
-@end example
+@end table
+
+The available backends are:
+
+@table @option
 
 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
 
@@ -2966,10 +2965,11 @@ To create a passthrough TPM use the following two options:
 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
 @code{tpmdev=tpm0} in the device option.
 
+ETEXI
+
+STEXI
 @end table
-
 ETEXI
-
 DEFHEADING()
 
 #endif
-- 
2.13.6

Re: [Qemu-devel] [PATCH 6/8] qemu-options: Polish section "TPM device options"

Posted by Eric Blake 8 years, 4 months ago

On 10/02/2017 09:03 AM, Markus Armbruster wrote:
> Cc: Stefan Berger <stefanb@linux.vnet.ibm.com>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qemu-options.hx | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
> 
Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

Re: [Qemu-devel] [PATCH 6/8] qemu-options: Polish section "TPM device options"

Posted by Marc-André Lureau 8 years, 4 months ago

On Mon, Oct 2, 2017 at 4:03 PM, Markus Armbruster <armbru@redhat.com> wrote:
> Cc: Stefan Berger <stefanb@linux.vnet.ibm.com>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>



> ---
>  qemu-options.hx | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 8568ee388c..615cb230ab 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -2915,19 +2915,18 @@ The general form of a TPM device option is:
>
>  @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
>  @findex -tpmdev
> -Backend type must be:
> -@option{passthrough}.
>
>  The specific backend type will determine the applicable options.
>  The @code{-tpmdev} option creates the TPM backend and requires a
>  @code{-device} option that specifies the TPM frontend interface model.
>
> -Options to each backend are described below.
> +Use @code{-tpmdev help} to print all available TPM backend types.
>
> -Use 'help' to print all available TPM backend types.
> -@example
> -qemu -tpmdev help
> -@end example
> +@end table
> +
> +The available backends are:
> +
> +@table @option
>
>  @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
>
> @@ -2966,10 +2965,11 @@ To create a passthrough TPM use the following two options:
>  Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
>  @code{tpmdev=tpm0} in the device option.
>
> +ETEXI
> +
> +STEXI
>  @end table
> -
>  ETEXI
> -
>  DEFHEADING()
>
>  #endif
> --
> 2.13.6
>
>



-- 
Marc-André Lureau