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

[Bruce Richardson <bruce.richardson@intel.com>]

On Tue, Mar 24, 2026 at 11:03:37PM +0000, Talluri Chaitanyababu wrote:
> 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.
> ---

This doc still needs a lot of rework, and possibly merging with the igb and
igc driver docs.

However, this small patch is an improvement, so I think I'll take it into
next-net-intel for this release. One small change I'd suggest below, let me
know if I'm ok to take this on apply.

/Bruce

>  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 reference to igc here is strange when it is not mentioned above
alongside igc. Would it be better to put it in brackets with a mention that
it's 2.5G (no not part of the 1G driver list). If you want I can rephrase
this on apply as:

"The ``igb`` (and ``igc`` for 2.5G) PMDs are built from the same e1000 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
>