[PATCH] doc: improve e1000 driver documentation

[PATCH] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Update e1000 driver docs to cover all Intel 1G devices,
including emulated e1000 and real hardware,
and group related drivers (igb, igc) for clarity."

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---
 doc/guides/nics/e1000em.rst | 47 +++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index ed4f57e9c6..b2e09cd673 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -1,6 +1,53 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
+Intel 1G Network Drivers (e1000, igb, igc)
+==========================================
+
+Overview
+--------
+
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit
+Ethernet controller families. These include:
+
+*   e1000 – Intel 8254x family devices, including QEMU e1000 emulation.
+*   e1000e – Intel PRO/1000 PCI‑Express family (82563/6/7, 82571/2/3/4/7/8/9,
+             82583 and I217/I218/I219-based adapters).
+
+These drivers follow similar design principles and capabilities and are grouped
+here for clarity.
+
+Supported Hardware
+------------------
+
+E1000 Devices
+~~~~~~~~~~~~~
+
+The e1000 Linux base driver supports the Intel® PRO/1000 PCI and PCI‑X
+family of Gigabit Ethernet controllers. Supported devices include:
+
+*   Intel 82540, 82541, 82545, 82546
+*   QEMU ``e1000`` emulated NIC
+
+E1000e Devices
+~~~~~~~~~~~~~~
+
+The e1000e Linux base driver supports the Intel PRO/1000 PCI‑Express family
+including:
+
+*   82563/82566/82567 series
+*   82571/82572/82573/82574/82577/82578/82579 series
+*   82583-based adapters
+*   I217, I218 and I219 Gigabit Network Connections
+
+Driver Notes
+~~~~~~~~~~~~
+
+*   e1000 – supports PCI/PCI‑X Gigabit adapters.
+*   e1000e – supports PCI‑Express Gigabit adapters.
+
+Both drivers are widely used across physical and virtualized environments.
+
 Driver for VM Emulated Devices
 ==============================
 
-- 
2.43.0

Re: [PATCH] doc: improve e1000 driver documentation

[Bruce Richardson]

On Mon, Feb 16, 2026 at 07:55:04PM +0000, Talluri Chaitanyababu wrote:
> Update e1000 driver docs to cover all Intel 1G devices,
> including emulated e1000 and real hardware,
> and group related drivers (igb, igc) for clarity."
> 

I think this doc needs a lot more work, but this is a good start. See
comments inline below.

/Bruce

> Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
> ---
>  doc/guides/nics/e1000em.rst | 47 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
> 
> diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
> index ed4f57e9c6..b2e09cd673 100644
> --- a/doc/guides/nics/e1000em.rst
> +++ b/doc/guides/nics/e1000em.rst
> @@ -1,6 +1,53 @@
>  ..  SPDX-License-Identifier: BSD-3-Clause
>      Copyright(c) 2010-2014 Intel Corporation.
>  
> +Intel 1G Network Drivers (e1000, igb, igc)
> +==========================================

I don't think you want to have igb and igc in the title here, since they
still have their own sections in the doc. Just use the title "Intel 1G
Network Driver" or perhaps even just "E1000 Poll Mode Driver" which would
match the title of many other sections. Rather than having igb/igc in the
title, you can instead start the section with a NOTE block saying that igb
and igc driver are included in the e1000 driver binary.

When renaming the section, though, one additional thing that needs to be
taken care of, is that you need to move the section in the index list so
that all sections remain in alphabetical order.

> +
> +Overview
> +--------
> +
> +DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit
> +Ethernet controller families. These include:
> +
> +*   e1000 – Intel 8254x family devices, including QEMU e1000 emulation.
> +*   e1000e – Intel PRO/1000 PCI‑Express family (82563/6/7, 82571/2/3/4/7/8/9,
> +             82583 and I217/I218/I219-based adapters).
> +
> +These drivers follow similar design principles and capabilities and are grouped
> +here for clarity.

When doing up the documentation, rather than wrapping lines at an 80 or 100
characters, it's recommended to wrap lines at punctuation marks, even if it
means longer lines. Each sentence should start on a new line - the rst
processing to html will rejoin the lines properly into paragraphs.

> +
> +Supported Hardware
> +------------------
> +
> +E1000 Devices
> +~~~~~~~~~~~~~
> +
> +The e1000 Linux base driver supports the Intel® PRO/1000 PCI and PCI‑X
> +family of Gigabit Ethernet controllers. Supported devices include:
> +
> +*   Intel 82540, 82541, 82545, 82546
> +*   QEMU ``e1000`` emulated NIC
> +
> +E1000e Devices
> +~~~~~~~~~~~~~~
> +
> +The e1000e Linux base driver supports the Intel PRO/1000 PCI‑Express family
> +including:
> +
> +*   82563/82566/82567 series
> +*   82571/82572/82573/82574/82577/82578/82579 series
> +*   82583-based adapters
> +*   I217, I218 and I219 Gigabit Network Connections
> +

I don't think we need these 2 sections, it repeats information given in the
overview section above.

> +Driver Notes
> +~~~~~~~~~~~~
> +
> +*   e1000 – supports PCI/PCI‑X Gigabit adapters.
> +*   e1000e – supports PCI‑Express Gigabit adapters.
> +
> +Both drivers are widely used across physical and virtualized environments.
> +

Probably unnecessary also.

>  Driver for VM Emulated Devices
>  ==============================
>  

> -- 
> 2.43.0
> 

[PATCH v2] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Update e1000 driver docs to cover all Intel 1G devices,
including emulated e1000 and real hardware.

v2: Addressed review comments.

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---
 doc/guides/nics/e1000em.rst | 47 +++++++------------------------------
 1 file changed, 8 insertions(+), 39 deletions(-)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index b2e09cd673..c0fc4fe685 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -1,52 +1,21 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-Intel 1G Network Drivers (e1000, igb, igc)
-==========================================
+E1000 Poll Mode Driver
+======================
 
 Overview
 --------
 
-DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit
-Ethernet controller families. These include:
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
+These include:
 
-*   e1000 – Intel 8254x family devices, including QEMU e1000 emulation.
-*   e1000e – Intel PRO/1000 PCI‑Express family (82563/6/7, 82571/2/3/4/7/8/9,
-             82583 and I217/I218/I219-based adapters).
+*   e1000 – Intel 8254x family devices, including QEMU ``e1000`` emulation.
+*   e1000e – Intel PRO/1000 PCI‑Express family (82563/6/7, 82571/2/3/4/7/8/9, 82583 and I217/I218/I219-based adapters).
 
-These drivers follow similar design principles and capabilities and are grouped
-here for clarity.
+.. note::
 
-Supported Hardware
-------------------
-
-E1000 Devices
-~~~~~~~~~~~~~
-
-The e1000 Linux base driver supports the Intel® PRO/1000 PCI and PCI‑X
-family of Gigabit Ethernet controllers. Supported devices include:
-
-*   Intel 82540, 82541, 82545, 82546
-*   QEMU ``e1000`` emulated NIC
-
-E1000e Devices
-~~~~~~~~~~~~~~
-
-The e1000e Linux base driver supports the Intel PRO/1000 PCI‑Express family
-including:
-
-*   82563/82566/82567 series
-*   82571/82572/82573/82574/82577/82578/82579 series
-*   82583-based adapters
-*   I217, I218 and I219 Gigabit Network Connections
-
-Driver Notes
-~~~~~~~~~~~~
-
-*   e1000 – supports PCI/PCI‑X Gigabit adapters.
-*   e1000e – supports PCI‑Express Gigabit adapters.
-
-Both drivers are widely used across physical and virtualized environments.
+   The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
 
 Driver for VM Emulated Devices
 ==============================
-- 
2.43.0

Re: [PATCH v3] doc: improve e1000 driver documentation

[Stephen Hemminger]

On Fri, 20 Feb 2026 21:15:13 +0000
Talluri Chaitanyababu <chaitanyababux.talluri@intel.com> wrote:

> Update e1000 driver docs to cover all Intel 1G devices,
> including emulated e1000 and real hardware.
> 
> v3: Resolved apply patch failure.
> 
> Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>

Pointed AI review at this patch, and the overall e1000 driver documentation.

Here's my review of the patch against the existing documentation:

---

**Patch:** `[PATCH v3] doc: improve e1000 driver documentation`
**Author:** Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>

**Summary:** The patch prepends a new top-level section "E1000 Poll Mode Driver" with an "Overview" subsection to `e1000em.rst`, but there are several issues.

---

**Structural / RST Issues**

The patch inserts a new top-level title ("E1000 Poll Mode Driver", underlined with `=`) before the existing top-level title ("Driver for VM Emulated Devices", also underlined with `=`). RST doesn't allow two sections at the same heading level in a document without one being nested under the other. This creates a document with two competing top-level headings, which is likely to confuse Sphinx and render incorrectly. The patch should either replace the existing title or restructure so "Driver for VM Emulated Devices" becomes a subsection beneath the new top-level heading.

**Content Accuracy**

The note in the new section states: *"The `igb` and `igc` PMDs are built from the same driver binary but are documented in separate sections for clarity."* This is misleading. `igb` is a Linux kernel driver, not a DPDK PMD, and `igc` similarly refers to a kernel driver (for I225/I226). DPDK's 1G PMD for real hardware uses the `e1000` driver. The note should be removed or corrected — as written it introduces inaccurate information.

**Scope vs. Commit Message**

The commit message says "Update e1000 driver docs to cover all Intel 1G devices, including emulated e1000 and real hardware," but the patch only adds 16 lines of overview text and doesn't actually document real hardware (PCI IDs, configuration, feature support, etc.). The commit message overclaims what the patch delivers.

**Content of the Overview**

The bullet point for `e1000e` lists an extensive range of adapters (82563/6/7, 82571/2/3/4/7/8/9, 82583, I217/I218/I219) but the existing file is entirely focused on emulated/VM devices. Mixing in details about `e1000e` physical hardware here, without corresponding documentation for those devices, leaves the overview incomplete and potentially confusing to readers.

**Minor Style Issues**

The note uses a Unicode non-breaking hyphen (`‑`) in "PCI‑Express" rather than a regular hyphen or the conventional "PCIe" abbreviation. This can cause rendering or copy-paste issues and should use standard ASCII.

**Existing Document Issues (pre-patch)**

Since you asked for a documentation review of the file as well, a few pre-existing issues worth noting:

- The document is severely outdated — it references Fedora 14/18, QEMU 0.14.0/0.15.1, KVM setup instructions from around 2011–2012, and kernel version 2.6.25. These sections should either be updated or removed.
- Line 60 has a broken code block: `tar xzf qemu-kvm-release.tar.gz cd qemu-kvm-release` — the `cd` command is on the same line as `tar`, missing a newline.
- The hyperlinks on lines 53, 81, 95–99 use the old `http://` scheme and some point to domains that are likely stale (sourceforge KVM project, `qemu.weilnetz.de`).
- Line 90: "The Qemu" should be "QEMU" (it's an acronym, always uppercase in DPDK docs).
- Lines 113, 114, 120: em-dashes used as list bullets (`—`) are non-standard RST; they should use standard `*` bullets or proper RST definition lists.

---

**Recommendation:** NAK in current form. The structural RST problem (duplicate top-level headings) and the factually inaccurate note about `igb`/`igc` need to be fixed before this can be applied. The commit message also needs to be scoped down to match what the patch actually does.

[PATCH v3] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Update e1000 driver docs to cover all Intel 1G devices,
including emulated e1000 and real hardware.

v3: Resolved apply patch failure.

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---
 doc/guides/nics/e1000em.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index ed4f57e9c6..c0fc4fe685 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -1,6 +1,22 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
+E1000 Poll Mode Driver
+======================
+
+Overview
+--------
+
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
+These include:
+
+*   e1000 – Intel 8254x family devices, including QEMU ``e1000`` emulation.
+*   e1000e – Intel PRO/1000 PCI‑Express family (82563/6/7, 82571/2/3/4/7/8/9, 82583 and I217/I218/I219-based adapters).
+
+.. note::
+
+   The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
+
 Driver for VM Emulated Devices
 ==============================
 
-- 
2.43.0

Re: [PATCH v3] doc: improve e1000 driver documentation

[Bruce Richardson]

On Fri, Feb 20, 2026 at 09:19:45AM -0800, Stephen Hemminger wrote:
> On Fri, 20 Feb 2026 21:15:13 +0000
> Talluri Chaitanyababu <chaitanyababux.talluri@intel.com> wrote:
> 
> > Update e1000 driver docs to cover all Intel 1G devices,
> > including emulated e1000 and real hardware.
> > 
> > v3: Resolved apply patch failure.
> > 
> > Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
> 
> Pointed AI review at this patch, and the overall e1000 driver documentation.
> 

I think the review is overly negative, but it does highlight some stuff
that should be fixed either in this patch or a different one.

> Here's my review of the patch against the existing documentation:
> 
> ---
> 
> **Patch:** `[PATCH v3] doc: improve e1000 driver documentation`
> **Author:** Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
> 
> **Summary:** The patch prepends a new top-level section "E1000 Poll Mode Driver" with an "Overview" subsection to `e1000em.rst`, but there are several issues.
> 
> ---
> 
> **Structural / RST Issues**
> 
> The patch inserts a new top-level title ("E1000 Poll Mode Driver", underlined with `=`) before the existing top-level title ("Driver for VM Emulated Devices", also underlined with `=`). RST doesn't allow two sections at the same heading level in a document without one being nested under the other. This creates a document with two competing top-level headings, which is likely to confuse Sphinx and render incorrectly. The patch should either replace the existing title or restructure so "Driver for VM Emulated Devices" becomes a subsection beneath the new top-level heading.
> 

This needs to be fixed in this patch.

> **Content Accuracy**
> 
> The note in the new section states: *"The `igb` and `igc` PMDs are built from the same driver binary but are documented in separate sections for clarity."* This is misleading. `igb` is a Linux kernel driver, not a DPDK PMD, and `igc` similarly refers to a kernel driver (for I225/I226). DPDK's 1G PMD for real hardware uses the `e1000` driver. The note should be removed or corrected — as written it introduces inaccurate information.
> 

I disagree with this. I think the content here is correct so far as it
goes, but maybe we need to expand and clarify a little?

> **Scope vs. Commit Message**
> 
> The commit message says "Update e1000 driver docs to cover all Intel 1G devices, including emulated e1000 and real hardware," but the patch only adds 16 lines of overview text and doesn't actually document real hardware (PCI IDs, configuration, feature support, etc.). The commit message overclaims what the patch delivers.
> 
> **Content of the Overview**
> 
> The bullet point for `e1000e` lists an extensive range of adapters (82563/6/7, 82571/2/3/4/7/8/9, 82583, I217/I218/I219) but the existing file is entirely focused on emulated/VM devices. Mixing in details about `e1000e` physical hardware here, without corresponding documentation for those devices, leaves the overview incomplete and potentially confusing to readers.
> 

Yes, this needs to be fixed, but not necessarily in this patch.

> **Minor Style Issues**
> 
> The note uses a Unicode non-breaking hyphen (`‑`) in "PCI‑Express" rather than a regular hyphen or the conventional "PCIe" abbreviation. This can cause rendering or copy-paste issues and should use standard ASCII.
> 

Needs fixing.

> **Existing Document Issues (pre-patch)**
> 
> Since you asked for a documentation review of the file as well, a few pre-existing issues worth noting:
> 
> - The document is severely outdated — it references Fedora 14/18, QEMU 0.14.0/0.15.1, KVM setup instructions from around 2011–2012, and kernel version 2.6.25. These sections should either be updated or removed.
> - Line 60 has a broken code block: `tar xzf qemu-kvm-release.tar.gz cd qemu-kvm-release` — the `cd` command is on the same line as `tar`, missing a newline.
> - The hyperlinks on lines 53, 81, 95–99 use the old `http://` scheme and some point to domains that are likely stale (sourceforge KVM project, `qemu.weilnetz.de`).
> - Line 90: "The Qemu" should be "QEMU" (it's an acronym, always uppercase in DPDK docs).
> - Lines 113, 114, 120: em-dashes used as list bullets (`—`) are non-standard RST; they should use standard `*` bullets or proper RST definition lists.
> 
> ---

These issue do need to be fixed, but again, not necessarily in this patch.
It would be good after this patch is respun to have a follow-up patch or
patchset cleaning up the rest of the doc.

Marking patch as "changes requested" in patchwork, because of the things I
highlight above that need fixing.

/Bruce

[PATCH v3] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Add an overview of the e1000 driver for Intel 1G devices.

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---
v3:
* Fixed RST structure, single top-level title.
* Used ASCII "PCIe".
* Adjusted commit message to match content.

v2: Addressed review comments.
---
 doc/guides/nics/e1000em.rst | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index ed4f57e9c6..95ff68cb9b 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -1,9 +1,22 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2010-2014 Intel Corporation.
+    Copyright(c) 2010-2026 Intel Corporation.
 
 Driver for VM Emulated Devices
 ==============================
 
+E1000 Poll Mode Driver
+----------------------
+
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
+These include:
+
+*   e1000 – Intel 8254x family devices, including QEMU ``e1000`` emulation.
+*   e1000e – Intel PRO/1000 PCIe family.
+
+.. note::
+
+   The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
+
 The DPDK EM poll mode driver supports the following emulated devices:
 
 *   qemu-kvm emulated Intel® 82540EM Gigabit Ethernet Controller (qemu e1000 device)
-- 
2.43.0

[PATCH v4] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Add an overview of the e1000 driver for Intel 1G devices.

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---
v4:
* Fixed RST structure, single top-level title.
* Used ASCII "PCIe".
* Adjusted commit message to match content.

v3: Resolved apply patch failure.

v2: Addressed review comments.
---
 doc/guides/nics/e1000em.rst | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index ed4f57e9c6..95ff68cb9b 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -1,9 +1,22 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2010-2014 Intel Corporation.
+    Copyright(c) 2010-2026 Intel Corporation.
 
 Driver for VM Emulated Devices
 ==============================
 
+E1000 Poll Mode Driver
+----------------------
+
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
+These include:
+
+*   e1000 – Intel 8254x family devices, including QEMU ``e1000`` emulation.
+*   e1000e – Intel PRO/1000 PCIe family.
+
+.. note::
+
+   The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
+
 The DPDK EM poll mode driver supports the following emulated devices:
 
 *   qemu-kvm emulated Intel® 82540EM Gigabit Ethernet Controller (qemu e1000 device)
-- 
2.43.0

Re: [PATCH v4] doc: improve e1000 driver documentation

[Bruce Richardson]

On Fri, Feb 27, 2026 at 04:21:59PM +0000, Talluri Chaitanyababu wrote:
> Add an overview of the e1000 driver for Intel 1G devices.
> 
> Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
> ---
> v4:
> * Fixed RST structure, single top-level title.
> * Used ASCII "PCIe".
> * Adjusted commit message to match content.
> 
> v3: Resolved apply patch failure.
> 
> v2: Addressed review comments.
> ---
>  doc/guides/nics/e1000em.rst | 15 ++++++++++++++-
>  1 file changed, 14 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
> index ed4f57e9c6..95ff68cb9b 100644
> --- a/doc/guides/nics/e1000em.rst
> +++ b/doc/guides/nics/e1000em.rst
> @@ -1,9 +1,22 @@
>  ..  SPDX-License-Identifier: BSD-3-Clause
> -    Copyright(c) 2010-2014 Intel Corporation.
> +    Copyright(c) 2010-2026 Intel Corporation.

Not an issue here, but FYI we don't generally update the copyright lines in
DPDK patches, we used to do so but in recent years community practice has
largely been to not do so..

>  
>  Driver for VM Emulated Devices
>  ==============================
>  
> +E1000 Poll Mode Driver
> +----------------------
> +
> +DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
> +These include:
> +
> +*   e1000 – Intel 8254x family devices, including QEMU ``e1000`` emulation.
> +*   e1000e – Intel PRO/1000 PCIe family.

We still have naming issues here where we have a mismatch between
documentation and code.

Specifically, if we run the pmdinfo script to see what is provided by the
librte_net_e1000.so file we get nothing listed that is just e1000 and no
mention of e1000e either:

$ ./usertools/dpdk-pmdinfo.py build/drivers/librte_net_e1000.so | grep name
    "name": "net_igc",
    "name": "net_e1000_igb_vf",
    "name": "net_e1000_igb",
    "name": "net_e1000_em",


> +
> +.. note::
> +
> +   The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
> +
>  The DPDK EM poll mode driver supports the following emulated devices:

Presumably "DPDK EM" is e1000_em.

As part of cleanup of this doc, can you perhaps work to make the doc names
and the code names consistent and clear? We may want to look to rename some
of the drivers in the code here.

>  
>  *   qemu-kvm emulated Intel® 82540EM Gigabit Ethernet Controller (qemu e1000 device)
> -- 
> 2.43.0
> 

[PATCH v5] doc: improve e1000 driver documentation

[Talluri Chaitanyababu]

Add an overview of the e1000 driver for Intel 1G devices.

Signed-off-by: Talluri Chaitanyababu <chaitanyababux.talluri@intel.com>
---

v5:
* Aligned PMD names with code.
* Fixed wording for clarity.

v4:
* Fixed RST structure, single top-level title.
* Used ASCII "PCIe".
* Adjusted commit message to match content.

v3: Resolved apply patch failure.

v2: Addressed review comments.
---
 doc/guides/nics/e1000em.rst | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/doc/guides/nics/e1000em.rst b/doc/guides/nics/e1000em.rst
index ed4f57e9c6..a101b54020 100644
--- a/doc/guides/nics/e1000em.rst
+++ b/doc/guides/nics/e1000em.rst
@@ -4,7 +4,20 @@
 Driver for VM Emulated Devices
 ==============================
 
-The DPDK EM poll mode driver supports the following emulated devices:
+E1000 Poll Mode Driver
+----------------------
+
+DPDK provides several poll mode drivers (PMDs) supporting Intel 1 Gigabit ethernet controller families.
+These include:
+
+*   e1000_em – Intel 8254x family devices, including QEMU ``e1000`` emulation.
+*   e1000_igb – Intel PRO/1000 PCIe family.
+
+.. note::
+
+    The ``igb`` and ``igc`` PMDs are built from the same driver binary but are documented in separate sections for clarity.
+
+The e1000_em poll mode driver supports the following emulated devices:
 
 *   qemu-kvm emulated Intel® 82540EM Gigabit Ethernet Controller (qemu e1000 device)
 
-- 
2.43.0