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 <[email protected]> > --- > 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 >
