[dpdk-dev,v2] doc: update overview

Message ID 1459824850-8236-1-git-send-email-wenzhuo.lu@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Wenzhuo Lu April 5, 2016, 2:54 a.m. UTC
  Update the overview.rst for e1000, igb, ixgbe.

v2:
- Some "X"s are put in the wrong place, correct it.

Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 doc/guides/nics/overview.rst | 94 ++++++++++++++++++++++----------------------
 1 file changed, 47 insertions(+), 47 deletions(-)
  

Comments

Thomas Monjalon April 6, 2016, 8:25 a.m. UTC | #1
2016-04-05 10:54, Wenzhuo Lu:
> Update the overview.rst for e1000, igb, ixgbe.
> 
> v2:
> - Some "X"s are put in the wrong place, correct it.
> 
> Signed-off-by: Wenzhuo Lu <wenzhuo.lu@intel.com>

Applied, thanks
  
Thomas Monjalon April 6, 2016, 8:26 a.m. UTC | #2
2016-04-05 10:54, Wenzhuo Lu:
> Update the overview.rst for e1000, igb, ixgbe.
[...]
>     stats per queue              X                                             X

You have not filled stats per queue. Is it because of an issue
with queue_stats_mapping?

[...]
>     usage doc                    X                                             X
>     design doc
>     perf doc

Do you plan to complete the docs for these drivers?
  
Wenzhuo Lu April 7, 2016, 1:34 a.m. UTC | #3
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, April 6, 2016 4:27 PM
> To: Lu, Wenzhuo
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v2] doc: update overview
> 
> 2016-04-05 10:54, Wenzhuo Lu:
> > Update the overview.rst for e1000, igb, ixgbe.
> [...]
> >     stats per queue              X                                             X
> 
> You have not filled stats per queue. Is it because of an issue with
> queue_stats_mapping?
I didn't know it means this function. I'll create a patch to update it. Thanks.

> 
> [...]
> >     usage doc                    X                                             X
> >     design doc
> >     perf doc
> 
> Do you plan to complete the docs for these drivers?
Sure, we'll try the enrich the docs.
  
Thomas Monjalon April 7, 2016, 7:38 a.m. UTC | #4
2016-04-07 01:34, Lu, Wenzhuo:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > >     stats per queue              X                                             X
> > 
> > You have not filled stats per queue. Is it because of an issue with
> > queue_stats_mapping?
> I didn't know it means this function. I'll create a patch to update it. Thanks.

Excuse me, I'm confusing you.
The "stats per queue" features means the function rte_eth_stats_get()
fills the arrays q_*.
  
Wenzhuo Lu April 7, 2016, 8:17 a.m. UTC | #5
Hi Thomas,

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, April 7, 2016 3:38 PM
> To: Lu, Wenzhuo
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v2] doc: update overview
> 
> 2016-04-07 01:34, Lu, Wenzhuo:
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > >     stats per queue              X                                             X
> > >
> > > You have not filled stats per queue. Is it because of an issue with
> > > queue_stats_mapping?
> > I didn't know it means this function. I'll create a patch to update it. Thanks.
> 
> Excuse me, I'm confusing you.
> The "stats per queue" features means the function rte_eth_stats_get() fills the
> arrays q_*.
NP. I missed this part, because I assumed it is a specific API like rte_eth_queue_stats_get. Did not notice the stats are included in rte_eth_stats_get.
I've sent another patch for this mistake.
  

Patch

diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst
index 542479a..6c53826 100644
--- a/doc/guides/nics/overview.rst
+++ b/doc/guides/nics/overview.rst
@@ -86,62 +86,62 @@  Most of these differences are summarized below.
                                           e   e       e   e   e                     e
                                           c   c       c   c   c                     c
    ==================== = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
-   link status                  X       X X                                   X X
-   link status event                    X X                                     X
+   link status                  X X     X X     X   X X X X                   X X
+   link status event              X     X X     X   X X                         X
    queue status event                                                           X
-   Rx interrupt                         X X X X
-   queue start/stop             X   X   X X X X                               X
-   MTU update                   X   X
-   jumbo frame                  X   X   X X X X
-   scattered Rx                 X   X   X X X X                               X
-   LRO
-   TSO                          X   X   X X X X
-   promiscuous mode             X       X X X X                               X
-   allmulticast mode            X       X X X X                               X
-   unicast MAC filter                   X X X X
+   Rx interrupt                   X     X X X X X X X X X X
+   queue start/stop             X   X   X X X X     X X                       X
+   MTU update                   X X X           X   X X X X
+   jumbo frame                  X X X   X X X X X   X X X X
+   scattered Rx                 X X X   X X X X X X X X X X                   X
+   LRO                                              X X X X
+   TSO                          X   X   X X X X X X X X X X
+   promiscuous mode             X X     X X X X X X X X                       X
+   allmulticast mode            X X     X X X X X X X X X X                   X
+   unicast MAC filter             X     X X X X X X X X X X
    multicast MAC filter                 X X X X
-   RSS hash                     X   X   X X X X
-   RSS key update                   X   X X X X
-   RSS reta update                  X   X X X X
-   VMDq                                 X X
-   SR-IOV                           X   X X
-   DCB                                  X X
-   VLAN filter                          X X X X
-   ethertype filter                     X X
-   n-tuple filter
-   SYN filter
-   tunnel filter                        X X
-   flexible filter
+   RSS hash                     X   X   X X X X X   X X X X
+   RSS key update                   X   X X X X X   X X X X
+   RSS reta update                  X   X X X X X   X X X X
+   VMDq                                 X X     X   X X
+   SR-IOV                           X   X X     X   X X
+   DCB                                  X X     X   X X
+   VLAN filter                    X     X X X X X X X X X X
+   ethertype filter                     X X     X   X X
+   n-tuple filter                               X   X X
+   SYN filter                                   X   X X
+   tunnel filter                        X X         X X
+   flexible filter                              X
    hash filter                          X X X X
-   flow director                        X X
-   flow control                 X       X X
-   rate limitation
-   traffic mirroring                    X X
-   CRC offload                  X   X   X   X
-   VLAN offload                 X   X   X   X
-   QinQ offload                         X   X
-   L3 checksum offload          X   X   X   X
-   L4 checksum offload          X   X   X   X
-   inner L3 checksum                X   X   X
-   inner L4 checksum                X   X   X
-   packet type parsing          X       X   X
-   timesync                             X X
-   basic stats                  X   X   X X X X                               X X
-   extended stats                   X   X X X X
+   flow director                        X X         X X
+   flow control                 X X     X X     X   X X
+   rate limitation                                  X X
+   traffic mirroring                    X X         X X
+   CRC offload                  X X X   X   X   X X X   X
+   VLAN offload                 X X X   X   X   X X X   X
+   QinQ offload                   X     X   X   X X X   X
+   L3 checksum offload          X X X   X   X   X X X   X
+   L4 checksum offload          X X X   X   X   X X X   X
+   inner L3 checksum                X   X   X       X   X
+   inner L4 checksum                X   X   X       X   X
+   packet type parsing          X       X   X   X X X   X
+   timesync                             X X     X   X X
+   basic stats                  X X X   X X X X X X X X X X                   X X
+   extended stats                   X   X X X X X X X X X X
    stats per queue              X                                             X
-   EEPROM dump
-   registers dump
-   multiprocess aware                   X X X X
-   BSD nic_uio                  X       X X X X
-   Linux UIO                    X   X   X X X X
-   Linux VFIO                   X       X X X X
+   EEPROM dump                                  X   X X
+   registers dump                               X X X X X X
+   multiprocess aware                   X X X X     X X X X
+   BSD nic_uio                  X X     X X X X X X X X X X
+   Linux UIO                    X X X   X X X X X X X X X X
+   Linux VFIO                   X X     X X X X X X X X X X
    other kdrv                                                                 X
    ARMv7
    ARMv8
    Power8
    TILE-Gx
-   x86-32                       X   X   X X X X                                 X
-   x86-64                       X   X   X X X X                               X X
+   x86-32                       X X X   X X X X X X X X X X                     X
+   x86-64                       X X X   X X X X X X X X X X                   X X
    usage doc                    X                                             X
    design doc
    perf doc