| Message ID | 20171002140307.5292-8-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | qemu-options: Texinfo and --help fixes | expand |
On 10/02/2017 09:03 AM, Markus Armbruster wrote: > Cc: Paolo Bonzini <pbonzini@redhat.com> > CC: Marc-André Lureau <marcandre.lureau@redhat.com> > Signed-off-by: Markus Armbruster <armbru@redhat.com> > --- > qemu-options.hx | 15 ++++++++------- > 1 file changed, 8 insertions(+), 7 deletions(-) > Reviewed-by: Eric Blake <eblake@redhat.com>
On Mon, Oct 2, 2017 at 4:03 PM, Markus Armbruster <armbru@redhat.com> wrote: > Cc: Paolo Bonzini <pbonzini@redhat.com> > CC: Marc-André Lureau <marcandre.lureau@redhat.com> > Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > qemu-options.hx | 15 ++++++++------- > 1 file changed, 8 insertions(+), 7 deletions(-) > > diff --git a/qemu-options.hx b/qemu-options.hx > index 615cb230ab..b792c65149 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -2492,11 +2492,6 @@ ETEXI > DEFHEADING() > > DEFHEADING(Character device options:) > -STEXI > - > -The general form of a character device option is: > -@table @option > -ETEXI > > DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, > "-chardev help\n" > @@ -2542,6 +2537,9 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, > ) > > STEXI > + > +The general form of a character device option is: > +@table @option > @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] > @findex -chardev > Backend is one of: > @@ -2565,7 +2563,7 @@ Backend is one of: > @option{spiceport}. > The specific backend will determine the applicable options. > > -Use "-chardev help" to print all available chardev backend types. > +Use @code{-chardev help} to print all available chardev backend types. > > All devices must have an id, which can be any string up to 127 characters long. > It is used to uniquely identify this device in other command line directives. > @@ -2620,8 +2618,11 @@ to a file to record all data transmitted via the backend. The @option{logappend} > option controls whether the log file will be truncated or appended to when > opened. > > -Further options to each backend are described below. > +@end table > > +The available backends are: > + > +@table @option > @item -chardev null ,id=@var{id} > A void device. This device will not emit any data, and will drop any data it > receives. The null backend does not take any options. > -- > 2.13.6 > >
diff --git a/qemu-options.hx b/qemu-options.hx index 615cb230ab..b792c65149 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -2492,11 +2492,6 @@ ETEXI DEFHEADING() DEFHEADING(Character device options:) -STEXI - -The general form of a character device option is: -@table @option -ETEXI DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, "-chardev help\n" @@ -2542,6 +2537,9 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, ) STEXI + +The general form of a character device option is: +@table @option @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] @findex -chardev Backend is one of: @@ -2565,7 +2563,7 @@ Backend is one of: @option{spiceport}. The specific backend will determine the applicable options. -Use "-chardev help" to print all available chardev backend types. +Use @code{-chardev help} to print all available chardev backend types. All devices must have an id, which can be any string up to 127 characters long. It is used to uniquely identify this device in other command line directives. @@ -2620,8 +2618,11 @@ to a file to record all data transmitted via the backend. The @option{logappend} option controls whether the log file will be truncated or appended to when opened. -Further options to each backend are described below. +@end table +The available backends are: + +@table @option @item -chardev null ,id=@var{id} A void device. This device will not emit any data, and will drop any data it receives. The null backend does not take any options.
Cc: Paolo Bonzini <pbonzini@redhat.com> CC: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qemu-options.hx | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-)