doc: virtio MAC/VLAN filtering is best effort

Message ID 20190918050050.5687-1-tiwei.bie@intel.com
State Accepted
Delegated to: Maxime Coquelin
Headers show
Series
  • doc: virtio MAC/VLAN filtering is best effort
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Tiwei Bie Sept. 18, 2019, 5 a.m.
Explicitly document that the MAC/VLAN filtering in virtio
is best effort to help users understand why unwanted packets
could still arrive.

Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
---
 doc/guides/nics/virtio.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Maxime Coquelin Sept. 27, 2019, 9:38 a.m. | #1
On 9/18/19 7:00 AM, Tiwei Bie wrote:
> Explicitly document that the MAC/VLAN filtering in virtio
> is best effort to help users understand why unwanted packets
> could still arrive.
> 
> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> ---
>  doc/guides/nics/virtio.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
Maxime Coquelin Sept. 27, 2019, 9:52 a.m. | #2
On 9/27/19 11:38 AM, Maxime Coquelin wrote:
> 
> 
> On 9/18/19 7:00 AM, Tiwei Bie wrote:
>> Explicitly document that the MAC/VLAN filtering in virtio
>> is best effort to help users understand why unwanted packets
>> could still arrive.
>>
>> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
>> ---
>>  doc/guides/nics/virtio.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> 
> Thanks,
> Maxime
> 
Applied to dpdk-next-virtio/master.

Thanks,
Maxime

Patch

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index bd0116176..fb378a4b9 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -56,7 +56,7 @@  In this release, the virtio PMD driver provides the basic functionality of packe
 *   Features of mac/vlan filter are supported, negotiation with vhost/backend are needed to support them.
     When backend can't support vlan filter, virtio app on guest should not enable vlan filter in order
     to make sure the virtio port is configured correctly. E.g. do not specify '--enable-hw-vlan' in testpmd
-    command line.
+    command line. Note that, mac/vlan filter is best effort: unwanted packets could still arrive.
 
 *   "RTE_PKTMBUF_HEADROOM" should be defined
     no less than "sizeof(struct virtio_net_hdr_mrg_rxbuf)", which is 12 bytes when mergeable or