[dpdk-dev] [PATCH 2/2] mbuf: improve API doc for tunnel Tx offloads

[Thomas Monjalon]

23/04/2018 10:14, Olivier Matz:
> On Fri, Apr 20, 2018 at 02:13:24AM +0200, Thomas Monjalon wrote:
> > + * These flags can be used with PKT_TX_TCP_SEG for TSO, or PKT_TX_xxx_CKSUM.
> > + * The mbuf fields for inner and outer header lengths may be required:
> 
> may be -> are
> 
> > + * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len.
> 
> and tso_segsz for TSO.

>From a HW point of view, some header lengths may be omitted if they are
guessed by the HW.
But you are right, from an API point of view, we should require them,
no matter what is the underlying hardware.

So the sentence becomes:
 * The mbuf fields for inner and outer header lengths are required:
 * outer_l2_len, outer_l3_len, l2_len, l3_len, l4_len and tso_segsz for TSO.