[dpdk-dev] [PATCH] doc: add a user guidance document for igb

[dpdk-dev] [PATCH] doc: add a user guidance document for igb

[Wei Zhao]

From: wei zhao <wei.zhao1@intel.com>

This patch add a user guidance document specific for igb nic.
By now, a doc like ixgbe.rst is also needed by igb nic. So this
patch add igb.rst to record important information about igb, like
feature supported and known issues.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
---
 doc/guides/nics/igb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 doc/guides/nics/igb.rst

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
new file mode 100644
index 0000000..4a87c19
--- /dev/null
+++ b/doc/guides/nics/igb.rst
@@ -0,0 +1,53 @@
+..  BSD LICENSE
+    Copyright(c) 2018 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+IGB Poll Mode Driver
+======================
+
+The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
+
+Features
+--------
+
+Features of the IGB PMD are:
+
+
+Limitations or Known issues
+---------------------------
+
+
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82576EB 10 Gigabit Ethernet Controller
+- Intel 82580EB 10 Gigabit Ethernet Controller
+- Intel 82580DB 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller I210
+- Intel Ethernet Controller I350
-- 
2.9.3

[dpdk-dev] [PATCH v2] doc: add a user guidance document for igb

[Wei Zhao]

This patch add a user guidance document specific for igb nic.
By now, a doc like ixgbe.rst is also needed by igb nic. So this
patch add igb.rst to record important information about igb, like
feature supported and known issues.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>

---

v2:
change the length of punctuation style for comment.
---
 doc/guides/nics/igb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 doc/guides/nics/igb.rst

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
new file mode 100644
index 0000000..fa6d7a5
--- /dev/null
+++ b/doc/guides/nics/igb.rst
@@ -0,0 +1,53 @@
+..  BSD LICENSE
+    Copyright(c) 2018 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+IGB Poll Mode Driver
+====================
+
+The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
+
+Features
+--------
+
+Features of the IGB PMD are:
+
+
+Limitations or Known issues
+---------------------------
+
+
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82576EB 10 Gigabit Ethernet Controller
+- Intel 82580EB 10 Gigabit Ethernet Controller
+- Intel 82580DB 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller I210
+- Intel Ethernet Controller I350
-- 
2.9.3

Re: [dpdk-dev] [PATCH v2] doc: add a user guidance document for igb

[Mcnamara, John]

> -----Original Message-----
> From: Zhao1, Wei
> Sent: Wednesday, January 31, 2018 8:47 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Lu, Wenzhuo
> <wenzhuo.lu@intel.com>; Zhao1, Wei <wei.zhao1@intel.com>
> Subject: [PATCH v2] doc: add a user guidance document for igb
> 
> This patch add a user guidance document specific for igb nic.
> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch add
> igb.rst to record important information about igb, like feature supported
> and known issues.

Hi,

Thanks for the doc. It is something we should have had a while ago.
Some comments below.

> +..  BSD LICENSE
> +    Copyright(c) 2018 Intel Corporation. All rights reserved.
> +    All rights reserved.
> +

You should probably use an SPDX header here.



> +IGB Poll Mode Driver
> +====================
> +
> +The IGB PMD (librte_pmd_e1000) provides poll mode driver support.

Maybe use something a bit more descriptive here like:

The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for
Intel 1GbE nics.



> +
> +Features
> +--------
> +
> +Features of the IGB PMD are:

Could you fill in some of these as a bullet list like:

Features of the IGB PMD are:

* VLAN
* VxLAN
* IEEE 1588
* etc.

The rest of the doc looks good.

John

[dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Wei Zhao]

This patch add a user guidance document specific for igb nic.
By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
add igb.rst to record important information about igb, like feature
supported and known issues.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>

---

v2:
-change code indentation style.

v3:
-add more details for igb feature.
---
 doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 doc/guides/nics/igb.rst

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
new file mode 100644
index 0000000..0171622
--- /dev/null
+++ b/doc/guides/nics/igb.rst
@@ -0,0 +1,38 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2017 Intel Corporation.
+
+IGB Poll Mode Driver
+====================
+
+The IGB PMD (``librte_pmd_e1000``) provides poll mode driver
+support for Intel 1GbE nics.
+
+Features
+--------
+
+Features of the IGB PMD are:
+
+* Multiple queues for TX and RX
+* Receiver Side Scaling (RSS)
+* MAC/VLAN filtering
+* Packet type information
+* Double VLAN
+* IEEE 1588
+* TSO offload
+* Checksum offload
+* TCP segmentation offload
+* Jumbo frames supported
+
+
+Limitations or Known issues
+---------------------------
+
+
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82576EB 10 Gigabit Ethernet Controller
+- Intel 82580EB 10 Gigabit Ethernet Controller
+- Intel 82580DB 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller I210
+- Intel Ethernet Controller I350
-- 
2.9.3

Re: [dpdk-dev] [PATCH v2] doc: add a user guidance document for igb

[Zhao1, Wei]

Hi,  John

A new v3 commit.
https://dpdk.org/dev/patchwork/patch/34863/


> -----Original Message-----
> From: Mcnamara, John
> Sent: Thursday, February 1, 2018 5:14 PM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
> Subject: RE: [PATCH v2] doc: add a user guidance document for igb
> 
> 
> 
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Wednesday, January 31, 2018 8:47 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Lu, Wenzhuo
> > <wenzhuo.lu@intel.com>; Zhao1, Wei <wei.zhao1@intel.com>
> > Subject: [PATCH v2] doc: add a user guidance document for igb
> >
> > This patch add a user guidance document specific for igb nic.
> > By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
> > add igb.rst to record important information about igb, like feature
> > supported and known issues.
> 
> Hi,
> 
> Thanks for the doc. It is something we should have had a while ago.
> Some comments below.
> 
> > +..  BSD LICENSE
> > +    Copyright(c) 2018 Intel Corporation. All rights reserved.
> > +    All rights reserved.
> > +
> 
> You should probably use an SPDX header here.
> 
> 
> 
> > +IGB Poll Mode Driver
> > +====================
> > +
> > +The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
> 
> Maybe use something a bit more descriptive here like:
> 
> The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for
> Intel 1GbE nics.
> 
> 
> 
> > +
> > +Features
> > +--------
> > +
> > +Features of the IGB PMD are:
> 
> Could you fill in some of these as a bullet list like:
> 
> Features of the IGB PMD are:
> 
> * VLAN
> * VxLAN
> * IEEE 1588
> * etc.
> 
> The rest of the doc looks good.
> 
> John
> 

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Mcnamara, John]

> -----Original Message-----
> From: Zhao1, Wei
> Sent: Friday, February 2, 2018 3:30 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
> <wei.zhao1@intel.com>
> Subject: [PATCH v3] doc: add a user guidance document for igb
> 
> This patch add a user guidance document specific for igb nic.
> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch add
> igb.rst to record important information about igb, like feature supported
> and known issues.
> 


Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Zhang, Helin]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Monday, February 5, 2018 5:35 PM
> To: Zhao1, Wei; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb
> 
> 
> 
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Friday, February 2, 2018 3:30 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
> > <wei.zhao1@intel.com>
> > Subject: [PATCH v3] doc: add a user guidance document for igb
> >
> > This patch add a user guidance document specific for igb nic.
> > By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
> > add igb.rst to record important information about igb, like feature
> > supported and known issues.
> >
> 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
Applied to dpdk-next-net-intel, with commit log modifications. Thanks!

/Helin
> 

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Ferruh Yigit]

On 2/2/2018 3:29 AM, Wei Zhao wrote:
> This patch add a user guidance document specific for igb nic.
> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
> add igb.rst to record important information about igb, like feature
> supported and known issues.
> 
> Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
> 
> ---
> 
> v2:
> -change code indentation style.
> 
> v3:
> -add more details for igb feature.
> ---
>  doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++

This file is not in the index, so you won't able select file from side bar and
will be very hard to access this document unless you know the url, also
producing a warning for same thing:

.../doc/guides/nics/igb.rst: WARNING: document isn't included in any toctree

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Mcnamara, John]

> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Thursday, February 8, 2018 11:39 AM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
> igb
> 
> On 2/2/2018 3:29 AM, Wei Zhao wrote:
> > This patch add a user guidance document specific for igb nic.
> > By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
> > add igb.rst to record important information about igb, like feature
> > supported and known issues.
> >
> > Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
> >
> > ---
> >
> > v2:
> > -change code indentation style.
> >
> > v3:
> > -add more details for igb feature.
> > ---
> >  doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
> 
> This file is not in the index, so you won't able select file from side bar
> and will be very hard to access this document unless you know the url,
> also producing a warning for same thing:
> 
> .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
> toctree


I missed that in the review. Can you fix that in the merge?

John

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Ferruh Yigit]

On 2/8/2018 12:27 PM, Mcnamara, John wrote:
>> -----Original Message-----
>> From: Yigit, Ferruh
>> Sent: Thursday, February 8, 2018 11:39 AM
>> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
>> Cc: Mcnamara, John <john.mcnamara@intel.com>
>> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
>> igb
>>
>> On 2/2/2018 3:29 AM, Wei Zhao wrote:
>>> This patch add a user guidance document specific for igb nic.
>>> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
>>> add igb.rst to record important information about igb, like feature
>>> supported and known issues.
>>>
>>> Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
>>>
>>> ---
>>>
>>> v2:
>>> -change code indentation style.
>>>
>>> v3:
>>> -add more details for igb feature.
>>> ---
>>>  doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
>>
>> This file is not in the index, so you won't able select file from side bar
>> and will be very hard to access this document unless you know the url,
>> also producing a warning for same thing:
>>
>> .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
>> toctree
> 
> 
> I missed that in the review. Can you fix that in the merge?

I can, let me do it.

> 
> John
> 

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Ferruh Yigit]

On 2/7/2018 7:12 AM, Zhang, Helin wrote:
> 
> 
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
>> Sent: Monday, February 5, 2018 5:35 PM
>> To: Zhao1, Wei; dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb
>>
>>
>>
>>> -----Original Message-----
>>> From: Zhao1, Wei
>>> Sent: Friday, February 2, 2018 3:30 AM
>>> To: dev@dpdk.org
>>> Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
>>> <wei.zhao1@intel.com>
>>> Subject: [PATCH v3] doc: add a user guidance document for igb
>>>
>>> This patch add a user guidance document specific for igb nic.
>>> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
>>> add igb.rst to record important information about igb, like feature
>>> supported and known issues.
>>>
>>
>>
>> Acked-by: John McNamara <john.mcnamara@intel.com>
> Applied to dpdk-next-net-intel, with commit log modifications. Thanks!

Pulled from next-net-intel, "igb" added to index.rst while merging to next-net.

Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

[Zhao1, Wei]

> -----Original Message-----
> From: Mcnamara, John
> Sent: Thursday, February 8, 2018 8:27 PM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>; Zhao1, Wei
> <wei.zhao1@intel.com>; dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
> igb
> 
> > -----Original Message-----
> > From: Yigit, Ferruh
> > Sent: Thursday, February 8, 2018 11:39 AM
> > To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>
> > Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document
> > for igb
> >
> > On 2/2/2018 3:29 AM, Wei Zhao wrote:
> > > This patch add a user guidance document specific for igb nic.
> > > By now, a doc like ixgbe.rst is also needed by igb nic. So this
> > > patch add igb.rst to record important information about igb, like
> > > feature supported and known issues.
> > >
> > > Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
> > >
> > > ---
> > >
> > > v2:
> > > -change code indentation style.
> > >
> > > v3:
> > > -add more details for igb feature.
> > > ---
> > >  doc/guides/nics/igb.rst | 38
> ++++++++++++++++++++++++++++++++++++++
> >
> > This file is not in the index, so you won't able select file from side
> > bar and will be very hard to access this document unless you know the
> > url, also producing a warning for same thing:
> >
> > .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
> > toctree
> 
> 
> I missed that in the review. Can you fix that in the merge?
> 
> John

Oh, I know the process of upload  document this time,  I have missed that.