qemu-options: Texinfo and --help fixes

[Qemu-devel] [PATCH 2/8] qemu-options: Fix markup of -netdev l2tpv3

Posted by Markus Armbruster 8 years, 4 months ago

The table of option parameters lacks @table and @end table.  The
parameters become items in the enclosing table of options.  Screwed up
when l2tpv3 was added in commit 3fb69aa.  Fix the obvious way.

Cc: Jason Wang <jasowang@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qemu-options.hx | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/qemu-options.hx b/qemu-options.hx
index 0fed2fc009..39f0e1b990 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2367,6 +2367,7 @@ two systems. It is present in routers, firewalls and the Linux kernel
 
 This transport allows a VM to communicate to another VM, router or firewall directly.
 
+@table @option
 @item src=@var{srcaddr}
     source address (mandatory)
 @item dst=@var{dstaddr}
@@ -2394,6 +2395,7 @@ draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
 networks which have packet reorder.
 @item offset=@var{offset}
     Add an extra offset between header and data
+@end table
 
 For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
 on the remote Linux host 1.2.3.4:
-- 
2.13.6

Re: [Qemu-devel] [PATCH 2/8] qemu-options: Fix markup of -netdev l2tpv3

Posted by Eric Blake 8 years, 4 months ago

On 10/02/2017 09:03 AM, Markus Armbruster wrote:
> The table of option parameters lacks @table and @end table.  The
> parameters become items in the enclosing table of options.  Screwed up
> when l2tpv3 was added in commit 3fb69aa.  Fix the obvious way.
> 
> Cc: Jason Wang <jasowang@redhat.com>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qemu-options.hx | 2 ++
>  1 file changed, 2 insertions(+)
> 

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 2/8] qemu-options: Fix markup of -netdev l2tpv3

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:
> The table of option parameters lacks @table and @end table.  The
> parameters become items in the enclosing table of options.  Screwed up
> when l2tpv3 was added in commit 3fb69aa.  Fix the obvious way.
>
> Cc: Jason Wang <jasowang@redhat.com>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

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


> ---
>  qemu-options.hx | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 0fed2fc009..39f0e1b990 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -2367,6 +2367,7 @@ two systems. It is present in routers, firewalls and the Linux kernel
>
>  This transport allows a VM to communicate to another VM, router or firewall directly.
>
> +@table @option
>  @item src=@var{srcaddr}
>      source address (mandatory)
>  @item dst=@var{dstaddr}
> @@ -2394,6 +2395,7 @@ draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
>  networks which have packet reorder.
>  @item offset=@var{offset}
>      Add an extra offset between header and data
> +@end table
>
>  For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
>  on the remote Linux host 1.2.3.4:
> --
> 2.13.6
>
>



-- 
Marc-André Lureau