Skip to contentSkip to conversation

doc: add a user guidance document for igb

PATCH Superseded Wei Zhao 4 participants 12 messages Jan 31, 2018 – Feb 13, 2018

lore
Share & tools
lore

Wei Zhao

author
#0 lore raw

PATCH 1/1 doc: add a user guidance document for igb

From: wei zhao <[email protected]>

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.

---
 doc/guides/nics/igb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 doc/guides/nics/igb.rst
doc/guides/nics/igb.rst new file +53 -0
new file mode 100644
index 0000000..4a87c19
@@ -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
Signature · 1 line
2.9.3
author
#1 lore raw

PATCH v2 1/1 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.

---

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
doc/guides/nics/igb.rst new file +53 -0
new file mode 100644
index 0000000..fa6d7a5
@@ -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
Signature · 1 line
2.9.3
#2 lore raw
Quoted 10 lines

-----Original Message-----
From: Zhao1, Wei
Sent: Wednesday, January 31, 2018 8:47 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Lu, Wenzhuo <[email protected]>; Zhao1, Wei <[email protected]>
Subject: [PATCH v2] doc: add a user guidance document for igb

Quoted 4 lines

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.

doc/guides/nics/igb.rst line 4

Quoted 4 lines

+.. BSD LICENSE

doc/guides/nics/igb.rst new file +3 -0
+    Copyright(c) 2018 Intel Corporation. All rights reserved.
+    All rights reserved.
+

You should probably use an SPDX header here.

doc/guides/nics/igb.rst line 34

Quoted 4 lines
doc/guides/nics/igb.rst new file +4 -0
+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.

doc/guides/nics/igb.rst line 39

Quoted 5 lines
doc/guides/nics/igb.rst new file +5 -0
+
+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

author
#3 lore raw

Hi, John

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

Quoted 67 lines

-----Original Message-----
From: Mcnamara, John
Sent: Thursday, February 1, 2018 5:14 PM
To: Zhao1, Wei <[email protected]>; [email protected]
Cc: Lu, Wenzhuo <[email protected]>
Subject: RE: [PATCH v2] doc: add a user guidance document for igb

Quoted 8 lines

-----Original Message-----
From: Zhao1, Wei
Sent: Wednesday, January 31, 2018 8:47 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Lu, Wenzhuo <[email protected]>; Zhao1, Wei <[email protected]>
Subject: [PATCH v2] doc: add a user guidance document for igb

Quoted 4 lines

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.

doc/guides/nics/igb.rst line 4

Quoted 4 lines

+.. BSD LICENSE

doc/guides/nics/igb.rst new file +3 -0
+    Copyright(c) 2018 Intel Corporation. All rights reserved.
+    All rights reserved.
+

You should probably use an SPDX header here.

doc/guides/nics/igb.rst line 34

Quoted 4 lines
doc/guides/nics/igb.rst new file +4 -0
+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.

doc/guides/nics/igb.rst line 39

Quoted 5 lines
doc/guides/nics/igb.rst new file +5 -0
+
+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

author
#4 lore raw

PATCH v3 1/1 doc: add a user guidance document for igb

In reply to 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.

---

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
doc/guides/nics/igb.rst new file +38 -0
new file mode 100644
index 0000000..0171622
@@ -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
Signature · 1 line
2.9.3
Acked-by on v3 1/1
#5 lore raw
Quoted 10 lines

-----Original Message-----
From: Zhao1, Wei
Sent: Friday, February 2, 2018 3:30 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Zhao1, Wei <[email protected]>
Subject: [PATCH v3] doc: add a user guidance document for igb

Quoted 5 lines

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.

Applied
#6 lore raw
Quoted 18 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Mcnamara, John
Sent: Monday, February 5, 2018 5:35 PM
To: Zhao1, Wei; [email protected]
Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 8 lines

-----Original Message-----
From: Zhao1, Wei
Sent: Friday, February 2, 2018 3:30 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Zhao1, Wei <[email protected]>
Subject: [PATCH v3] doc: add a user guidance document for igb

Quoted 8 lines
Quoted 5 lines

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.

Applied to dpdk-next-net-intel, with commit log modifications. Thanks!

/Helin

Quoted 1 line
#7 lore raw
Quoted 25 lines · Helin
Quoted 25 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Mcnamara, John
Sent: Monday, February 5, 2018 5:35 PM
To: Zhao1, Wei; [email protected]
Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 13 lines

-----Original Message-----
From: Zhao1, Wei
Sent: Friday, February 2, 2018 3:30 AM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Zhao1, Wei <[email protected]>
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.

Quoted 2 lines
Quoted 1 line

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.

#8 lore raw
In reply to Wei Zhao
Quoted 9 lines · 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.

---

Quoted 7 lines

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

#9 lore raw
Quoted 30 lines

-----Original Message-----
From: Yigit, Ferruh
Sent: Thursday, February 8, 2018 11:39 AM
To: Zhao1, Wei <[email protected]>; [email protected]
Cc: Mcnamara, John <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 9 lines · 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.

---

Quoted 7 lines

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:

Quoted 2 lines

.../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

#10 lore raw
Quoted 30 lines · John
Quoted 30 lines

-----Original Message-----
From: Yigit, Ferruh
Sent: Thursday, February 8, 2018 11:39 AM
To: Zhao1, Wei <[email protected]>; [email protected]
Cc: Mcnamara, John <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 9 lines · 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.

---

Quoted 7 lines

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:

Quoted 5 lines
Quoted 2 lines

.../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.

Quoted 3 lines

John

author
#11 lore raw
In reply to Mcnamara, John
Quoted 41 lines

-----Original Message-----
From: Mcnamara, John
Sent: Thursday, February 8, 2018 8:27 PM
To: Yigit, Ferruh <[email protected]>; Zhao1, Wei <[email protected]>; [email protected]
Subject: RE: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 18 lines

-----Original Message-----
From: Yigit, Ferruh
Sent: Thursday, February 8, 2018 11:39 AM
To: Zhao1, Wei <[email protected]>; [email protected]
Cc: Mcnamara, John <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Quoted 9 lines · 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.

---

Quoted 7 lines
Quoted 7 lines

v2:
-change code indentation style.

v3:
-add more details for igb feature.

---
 doc/guides/nics/igb.rst | 38

++++++++++++++++++++++++++++++++++++++

Quoted 5 lines

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:

Quoted 7 lines
Quoted 2 lines

.../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.