Skip to contentSkip to conversation

doc/guides/nics: split pcap_ring into separate documentation files

PATCH Applied Stephen Hemminger 1 participant 2 messages Jan 8 – Feb 10

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc/guides/nics: split pcap_ring into separate documentation files

The documentation had combined to unrelated drivers together. Use AI to split into two separate files:
pcap.rst for the pcap PMD and ring.rst for the ring PMD.

Changes to pcap.rst:
- Use "pcap" consistently instead of mixed "libpcap/pcap/PCAP" naming
- Remove Linux-specific references; document support for Linux, FreeBSD, and Windows
- Add reference to upstream libpcap documentation
- Add multi-queue support section explaining queue count determination and file handle limitations
- Use ``--vdev=net_pcap0`` format consistently
- Remove deprecated rte_eth_from_pcaps() API section
- Improve technical documentation style throughout

Changes to ring.rst:
- Use ``--vdev=net_ring0`` format consistently
- Fix inconsistent "Rings-based/Ring-based" naming
- Retain rte_eth_from_rings() API section with usage examples
- Improve technical documentation style throughout

---
 doc/guides/nics/index.rst     |   3 +-
 doc/guides/nics/pcap.rst      | 220 +++++++++++++++++++++++
 doc/guides/nics/pcap_ring.rst | 318 ----------------------------------
 doc/guides/nics/ring.rst      | 116 +++++++++++++
 4 files changed, 338 insertions(+), 319 deletions(-)
 create mode 100644 doc/guides/nics/pcap.rst
 delete mode 100644 doc/guides/nics/pcap_ring.rst
 create mode 100644 doc/guides/nics/ring.rst
doc/guides/nics/index.rst +2 -1
index b00ed998c5..cb818284fe 100644
@@ -60,10 +60,11 @@ Network Interface Controller Drivers
     null
     octeon_ep
     octeontx
-    pcap_ring
+    pcap
     pfe
     qede
     r8169
+    ring
     rnp
     sfc_efx
     softnic
doc/guides/nics/pcap.rst new file +220 -0

220 lines not on this page · raw message

doc/guides/nics/pcap_ring.rst deleted +0 -318

318 lines not on this page · raw message

doc/guides/nics/ring.rst new file +116 -0

116 lines not on this page · raw message

Signature · 1 line
2.51.0
author Applied
#1 lore raw
Quoted 15 lines · On Thu, 8 Jan 2026 12:24:41 -0800 Stephen Hemminger…

The documentation had combined to unrelated drivers together. Use AI to split into two separate files:
pcap.rst for the pcap PMD and ring.rst for the ring PMD.

Changes to pcap.rst:
- Use "pcap" consistently instead of mixed "libpcap/pcap/PCAP" naming
- Remove Linux-specific references; document support for Linux, FreeBSD, and Windows
- Add reference to upstream libpcap documentation
- Add multi-queue support section explaining queue count determination and file handle limitations
- Use ``--vdev=net_pcap0`` format consistently
- Remove deprecated rte_eth_from_pcaps() API section
- Improve technical documentation style throughout

Quoted 7 lines

Changes to ring.rst:
- Use ``--vdev=net_ring0`` format consistently
- Fix inconsistent "Rings-based/Ring-based" naming
- Retain rte_eth_from_rings() API section with usage examples
- Improve technical documentation style throughout

Queued to next-net