Re: [Qemu-devel] [PATCH v7 RESEND 10/11] filter/buffer: update command description and help

[Thomas Huth <thuth@redhat.com>]

On 21/08/15 00:43, Yang Hongyang wrote:
> now that we have a buffer netfilter, update the command
> description and help.
> 
> Signed-off-by: Yang Hongyang <yanghy@cn.fujitsu.com>
> CC: Luiz Capitulino <lcapitulino@redhat.com>
> CC: Markus Armbruster <armbru@redhat.com>
> ---
>  hmp-commands.hx | 2 +-
>  qemu-options.hx | 5 ++++-
>  qmp-commands.hx | 2 +-
>  3 files changed, 6 insertions(+), 3 deletions(-)
...
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 0d52d02..eeaf2a1 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1575,7 +1575,10 @@ DEF("net", HAS_ARG, QEMU_OPTION_net,
>      "socket][,vlan=n][,option][,option][,...]\n"
>      "                old way to initialize a host network interface\n"
>      "                (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
> -DEF("netfilter", HAS_ARG, QEMU_OPTION_netfilter, "", QEMU_ARCH_ALL)
> +DEF("netfilter", HAS_ARG, QEMU_OPTION_netfilter,
> +    "-netfilter buffer,id=str,netdev=str[,chain=in|out|all,interval=n]\n"
> +    "                buffer netdev in/out packets. if interval provided, will release\n"
> +    "                packets by interval. interval scale: microsecond\n", QEMU_ARCH_ALL)
>  STEXI
>  @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
>  @findex -net

Could you maybe also add some more explicit description for the filter
to the TEXI section (i.e. between the above STEXI and the ETEXI later in
this file)? That could be really helpful for the users when they look
for information about this option in the User's Documentation (see
http://qemu.weilnetz.de/qemu-doc.html for a generated version for example)

 Thomas