Update tapv2 documentation 05/13105/3
authorIan Wells <iawells@cisco.com>
Mon, 18 Jun 2018 20:53:17 +0000 (13:53 -0700)
committerFlorin Coras <florin.coras@gmail.com>
Fri, 22 Jun 2018 02:59:35 +0000 (02:59 +0000)
The documentation in the API file says that 0xffff == 'no interface
ID specified' but the code tests against ~(u32)0.

Change-Id: I5cd83d876c3ad4f53a5b01463299d4fcb806ea98
Signed-off-by: Ian Wells <iawells@cisco.com>
src/vnet/devices/tap/tapv2.api

index 167b7a6..e65102c 100644 (file)
@@ -24,7 +24,7 @@ option version = "2.0.0";
 /** \brief Initialize a new tap interface with the given paramters
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param id - interface id, 0xffff means auto
+    @param id - interface id, 0xffffffff means auto
     @param use_random_mac - let the system generate a unique mac address
     @param mac_address - mac addr to assign to the interface if use_radom not set
     @param tx_ring_sz - the number of entries of TX ring