Re: [dpdk-dev] [PATCH v2] doc: add known issue about promiscuous mode for I40e VF

["Mcnamara, John" <john.mcnamara@intel.com>]

> -----Original Message-----
> From: Guo, Jia
> Sent: Tuesday, July 26, 2016 3:24 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: dev@dpdk.org; Guo, Jia <jia.guo@intel.com>
> Subject: [PATCH v2] doc: add known issue about promiscuous mode for I40e
> VF
> 
> When use i40e linux kernel driver as host driver and DPDK handler the i40e
> VF, the promiscuous mode doesn't work in i40e VF. It is not supported by
> DPDK i40e VF driver right now.
> 
> Signed-off-by: Jeff Guo <jia.guo@intel.com>
> ---
> v1->v2:
> - add singned-off and modify some format
> 
>  doc/guides/rel_notes/known_issues.rst | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/known_issues.rst
> b/doc/guides/rel_notes/known_issues.rst
> index 5ec1987..e907c22 100644
> --- a/doc/guides/rel_notes/known_issues.rst
> +++ b/doc/guides/rel_notes/known_issues.rst
> @@ -620,3 +620,25 @@ The last EAL argument is replaced by the program name
> in argv[]
> 
>  **Driver/Module**:
>     Environment Abstraction Layer (EAL).
> +
> +
> +I40e VF can't receive the promiscuous unicast/multicast/broadcast packet.
> +---------------------------------------------------------

The underline here is too short and generates a warning:

    doc/guides/rel_notes/known_issues.rst:626: WARNING: Title underline too short.

    I40e VF can't receive the promiscuous unicast/multicast/broadcast packet.
    ---------------------------------------------------------

> +
> +**Description**:
> +   Use i40e linux kernel driver PF generate VF, and run testpmd, set
> Promiscuous mode and
> +   All multicast mode to be enabled, then send packet with unknown
> destination MAC address
> +   to VF, but VF can't receive the packet.


The text style and tense doesn't match the rest of the doc. I would suggest
something like:

   
I40e VF may not receive packets in promiscuous mode
---------------------------------------------------

**Description**:
   Promiscuous mode is not supported by the DPDK i40e VF driver when using the
   i40e Linux kernel driver as host driver.

**Implication**:
   The i40e VF does not receive packets when the destination MAC address is unknown.

**Resolution/Workaround**:
   Use a destination MAC address that matches the VF.

**Affected Environment/Platform**:
   All.

**Driver/Module**:
   Poll Mode Driver (PMD).