[dpdk-dev] [PATCH] examples/l3fwd: update documentation

Mcnamara, John john.mcnamara at intel.com
Fri Jun 24 17:47:02 CEST 2016


> -----Original Message-----
> From: Xing, Beilei
> Sent: Thursday, June 23, 2016 10:05 AM
> To: Mcnamara, John <john.mcnamara at intel.com>
> Cc: dev at dpdk.org; Xing, Beilei <beilei.xing at intel.com>
> Subject: [PATCH] examples/l3fwd: update documentation
> 
> Update l3fwd documentation with -E, -L and --eth-dest options.
> 

Hi,

Thanks for the doc fixes.


The usage example just before this should also be updated to add these
(and a few other) missing options. Something like:

    ./l3fwd [EAL options] -- -p PORTMASK
                             [-P]
                             [-E]
                             [-L]
                             --config(port,queue,lcore)[,(port,queue,lcore)]
                             [--eth-dest=X,MM:MM:MM:MM:MM:MM]
                             [--enable-jumbo]
                             [--max-pkt-len PKTLEN]]
                             [--no-numa]
                             [--hash-entry-num]
                             [--ipv6]
                             [--parse-ptype]



> +*   -E: enable exact match

The options would look better in fixed width quotes:

    * ``-E:`` Enable exact match.


> +*   --parse-ptype: optional, set it if use software way to analyze packet
> type. Without this option, HW will check packet type.

Maybe better as:

    * ``--parse-ptype:`` Optional, set to use software to analyze packet type. Without this option, hardware will check the packet type.

Note, the l3fwd main.c usage should also be updated to add these options
and fix missing (and incorrect) options. I'll send you a patch for that
and you can integrate it with your changes.

John



More information about the dev mailing list