[Qemu-devel] [PATCH RFC 5/5] net/dump: Add documentation

[Thomas Huth <thuth@redhat.com>]

Add a short description for the command line options.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-options.hx | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 390e055..21cf129 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1578,7 +1578,10 @@ DEF("net", HAS_ARG, QEMU_OPTION_net,
 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)
+    "                packets by interval. interval scale: microsecond\n"
+    "-netfilter dump,id=str,netdev=str,file=f[,maxlen=n,chain=in|out|all]\n"
+    "                dump network traffic to file 'f' (max n bytes per packet)\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
@@ -1984,10 +1987,12 @@ qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,sha
      -device virtio-net-pci,netdev=net0
 @end example
 
-@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
-Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
-At most @var{len} bytes (64k by default) per packet are stored. The file format is
-libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
+@item -netfilter dump,id=@var{idstr},netdev=@var{dev},file=@var{file}[,maxlen=@var{len},chain=in|out|all]
+@itemx -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
+Dump network traffic on netdev @var{dev} (or VLAN @var{n} reciprocally) to
+file @var{file} (@file{qemu-vlan0.pcap} for '-net dump' by default).
+At most @var{len} bytes (64k by default) per packet are stored. The file format
+is libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
 
 @item -net none
 Indicate that no network devices should be configured. It is used to
-- 
1.8.3.1