* [RFC] devtools: rewrite doc vs code check in Python
@ 2026-09-23 18:42 Stephen Hemminger
2026-09-23 18:44 ` Stephen Hemminger
2026-09-23 19:19 ` Thomas Monjalon
0 siblings, 2 replies; 8+ messages in thread
From: Stephen Hemminger @ 2026-09-23 18:42 UTC (permalink / raw)
To: dev; +Cc: Stephen Hemminger, Aaron Conole, Thomas Monjalon, Anatoly Burakov
The existing check-doc-vs-code.sh only compares rte_flow items and
actions, and only for drivers whose directory matches the ini name,
so none of the drivers under net/intel are checked.
Replace it and parse-flow-support.sh with a Python script covering
the whole NIC feature matrix:
- ini syntax: unknown rows, invalid values, duplicates, row order
- rte_flow items and actions, keeping the bnxt and dpaa2 exceptions
- feature rows against eth_dev_ops, fast-path ops, offload and
capability flags, including full (Y) vs partial (P) support
- ops that only return -ENOTSUP
- OS and architecture rows against meson.build and its dependencies
- incomplete operation sets, e.g. start without stop,
or Rx timestamp without read_clock
- rows requiring another row in the same ini
Drivers sharing a directory (PF/VF, e1000/igb/igc) are matched
by their own eth_dev_ops instance or source files.
Given a git reference, only drivers changed since the reference
are checked, and findings already present at the reference are
not reported, so existing documentation gaps do not fail CI.
Documented but not implemented is an error. Implemented but not
documented, and incomplete operation sets, are warnings.
Option -v adds notes such as platforms meson allows but the ini
does not list. Option -g prints ini rows derived from driver code.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
.github/workflows/build.yml | 2 +-
MAINTAINERS | 3 +-
devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
devtools/check-doc-vs-code.sh | 84 --
devtools/parse-flow-support.sh | 92 --
doc/guides/contributing/new_driver.rst | 4 +-
doc/guides/contributing/patches.rst | 27 +
doc/guides/nics/features.rst | 5 +
8 files changed, 1169 insertions(+), 180 deletions(-)
create mode 100755 devtools/check-doc-vs-code.py
delete mode 100755 devtools/check-doc-vs-code.sh
delete mode 100755 devtools/parse-flow-support.sh
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 1ea5f92e51..ed89043ffd 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -29,7 +29,7 @@ jobs:
git remote add upstream ${{ env.REF_GIT_REPO }}
git fetch upstream ${{ env.REF_GIT_BRANCH }}
failed=
- devtools/check-doc-vs-code.sh upstream/${{ env.REF_GIT_BRANCH }} || failed=true
+ devtools/check-doc-vs-code.py upstream/${{ env.REF_GIT_BRANCH }} || failed=true
devtools/check-meson.py || failed=true
devtools/check-spdx-tag.sh || failed=true
[ -z "$failed" ]
diff --git a/MAINTAINERS b/MAINTAINERS
index 186cc82b39..bc118ad540 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -88,7 +88,7 @@ F: MAINTAINERS
F: devtools/build-dict.sh
F: devtools/check-abi.sh
F: devtools/check-abi-version.sh
-F: devtools/check-doc-vs-code.sh
+F: devtools/check-doc-vs-code.py
F: devtools/check-dup-includes.sh
F: devtools/check-maintainers.sh
F: devtools/check-forbidden-tokens.awk
@@ -100,7 +100,6 @@ F: devtools/get-maintainer.sh
F: devtools/git-log-fixes.sh
F: devtools/load-devel-config
F: devtools/mailmap-ctl.py
-F: devtools/parse-flow-support.sh
F: devtools/process-iwyu.py
F: devtools/update-patches.py
F: devtools/libabigail.abignore
diff --git a/devtools/check-doc-vs-code.py b/devtools/check-doc-vs-code.py
new file mode 100755
index 0000000000..4cafb739f1
--- /dev/null
+++ b/devtools/check-doc-vs-code.py
@@ -0,0 +1,1132 @@
+#!/usr/bin/env python3
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2026 Stephen Hemminger
+
+"""
+Check that the NIC feature matrix (doc/guides/nics/features/*.ini)
+agrees with the driver code in drivers/net.
+
+Checks:
+ - ini syntax: unknown rows, invalid values, duplicates, row order
+ - rte_flow items and actions referenced in code vs documented
+ - feature rows vs eth_dev_ops, fast-path ops, offload and capability flags
+ - full (Y) vs partial (P) support
+ - OS and architecture rows vs meson.build (including dependencies)
+ - incomplete operation sets (start without stop, timestamp without clock)
+ - inconsistent rows within one ini (QinQ without VLAN, ...)
+
+Severity:
+ error row documented without matching code, platform excluded by
+ meson, rte_flow mismatch, invalid ini content
+ warning code without a documented row, Y where code is partial,
+ incomplete operation set, row order
+ info (-v) P where code looks complete, platform meson allows
+ but the ini does not list
+
+With a git reference, only drivers changed since that reference are
+checked, and findings already present at the reference are not
+reported. Exit status is 1 if any error is reported.
+
+The mapping of rows to code is the RULES table in this script.
+"""
+
+import argparse
+import os
+import re
+import subprocess
+import sys
+import tempfile
+from collections import namedtuple
+from fnmatch import fnmatch
+
+ROOT = os.path.realpath(os.path.join(os.path.dirname(__file__), '..'))
+NET = 'drivers/net'
+FEATURES = 'doc/guides/nics/features'
+
+ERROR, WARNING, INFO = 0, 1, 2
+LEVEL_NAME = ('error', 'warning', 'info')
+
+# ---------------------------------------------------------------------------
+# Mapping of ini files to driver code.
+#
+# dir: driver directory relative to drivers/net
+# ops: regex selecting eth_dev_ops instances that belong to this ini
+# files: globs of source files belonging to this ini (default all)
+# shared: code is not specific to this ini
+# 'ops' - only the selected eth_dev_ops are specific, so undocumented
+# features are reported only when backed by an op
+# 'all' - nothing is specific, undocumented features are not reported
+# ---------------------------------------------------------------------------
+Driver = namedtuple('Driver', 'dir ops files shared')
+Driver.__new__.__defaults__ = (None, None, None)
+
+DRIVERS = {
+ 'afpacket': Driver('af_packet'),
+ 'cnxk': Driver('cnxk', ops=r'cnxk_eth_dev_ops'),
+ 'cnxk_vec': Driver('cnxk', ops=r'cnxk_eth_dev_ops', shared='all'),
+ 'cnxk_vf': Driver('cnxk', ops=r'cnxk_eth_dev_ops', shared='all'),
+ 'cxgbe': Driver('cxgbe', ops=r'cxgbe_eth_dev_ops'),
+ 'cxgbevf': Driver('cxgbe', ops=r'cxgbevf_', shared='ops'),
+ 'e1000': Driver('intel/e1000', ops=r'eth_em_ops',
+ files='e1000_*|em_*|base/*'),
+ 'enetc': Driver('enetc', ops=r'enetc_ops$',
+ files='enetc_*|enetc.h|base/*'),
+ 'enetc4': Driver('enetc', ops=r'enetc4_ops$',
+ files='enetc4_ethdev.c|enetc_rxtx.c|enetc.h|base/*'),
+ 'enetc4_vf': Driver('enetc', ops=r'enetc4_vf_ops',
+ files='enetc4_*|enetc_rxtx.c|enetc.h|base/*',
+ shared='ops'),
+ 'failsafe': Driver('failsafe', shared='ops'),
+ 'fm10k_vf': Driver('intel/fm10k', shared='all'),
+ 'hns3': Driver('hns3', ops=r'hns3_eth_dev_ops'),
+ 'hns3_vf': Driver('hns3', ops=r'hns3vf_', shared='ops'),
+ 'ice': Driver('intel/ice', ops=r'ice_eth_dev_ops',
+ files='[!i]*|ice_[!d]*|ice_diagnose.c'),
+ 'ice_dcf': Driver('intel/ice', ops=r'ice_dcf_',
+ files='ice_dcf*|ice_rxtx*|base/*', shared='ops'),
+ 'igb': Driver('intel/e1000', ops=r'eth_igb_ops',
+ files='e1000_*|igb_*|base/*'),
+ 'igb_vf': Driver('intel/e1000', ops=r'igbvf_',
+ files='e1000_*|igb_*|base/*', shared='ops'),
+ 'igc': Driver('intel/e1000', ops=r'eth_igc_ops',
+ files='igc_*|e1000_*|base/*'),
+ 'ixgbe': Driver('intel/ixgbe', ops=r'ixgbe_eth_dev_ops'),
+ 'ixgbe_vf': Driver('intel/ixgbe', ops=r'ixgbevf_', shared='ops'),
+ 'ngbe': Driver('ngbe', ops=r'ngbe_eth_dev_ops'),
+ 'ngbe_vf': Driver('ngbe', ops=r'ngbevf_', shared='ops'),
+ 'qede': Driver('qede', ops=r'qede_eth_dev_ops'),
+ 'qede_vf': Driver('qede', ops=r'qede_eth_vf_', shared='ops'),
+ 'txgbe': Driver('txgbe', ops=r'txgbe_eth_dev_ops'),
+ 'txgbe_vf': Driver('txgbe', ops=r'txgbevf_', shared='ops'),
+}
+
+# driver directories that have no ini on purpose
+NO_INI = {'intel/common', 'vdev_netvsc'}
+
+# ---------------------------------------------------------------------------
+# Evidence of a feature in code.
+# op: eth_dev_ops member set to non-NULL in a selected ops instance
+# fp: rte_eth_dev fast-path member assigned
+# tok: regex found in code (comments and strings removed)
+# A group is satisfied when any of its alternatives is.
+# ---------------------------------------------------------------------------
+Ev = namedtuple('Ev', 'kind names')
+
+
+def op(*names):
+ return Ev('op', names)
+
+
+def fp(*names):
+ return Ev('fp', names)
+
+
+def tok(*names):
+ return Ev('tok', names)
+
+
+def rx(name):
+ return tok(r'\bRTE_ETH_RX_OFFLOAD_' + name + r'\b')
+
+
+def tx(name):
+ return tok(r'\bRTE_ETH_TX_OFFLOAD_' + name + r'\b')
+
+
+def capa(name):
+ return tok(r'\bRTE_ETH_DEV_CAPA_' + name + r'\b')
+
+
+# req: groups needed for full support; some but not all = partial
+# code2doc: report when code has it and doc does not
+# strict: documented without code is an error, else a warning
+# (used where the features.rst definition is known to be unclear)
+Rule = namedtuple('Rule', 'req code2doc strict')
+Rule.__new__.__defaults__ = (True, True)
+
+RULES = {
+ 'Speed capabilities': Rule([tok(r'\bspeed_capa\b')]),
+ 'Link speed configuration': Rule([tok(r'\blink_speeds\b')],
+ code2doc=False),
+ 'Link status': Rule([op('link_update')]),
+ 'Link status event': Rule([tok(r'\bRTE_ETH_DEV_INTR_LSC\b',
+ r'\bRTE_PCI_DRV_INTR_LSC\b')]),
+ 'Removal event': Rule([tok(r'\bRTE_ETH_DEV_INTR_RMV\b',
+ r'\bRTE_PCI_DRV_INTR_RMV\b',
+ r'\bRTE_ETH_EVENT_INTR_RMV\b')]),
+ 'Queue status event': Rule([tok(r'\bRTE_ETH_EVENT_QUEUE_STATE\b')]),
+ 'Rx interrupt': Rule([op('rx_queue_intr_enable'),
+ op('rx_queue_intr_disable')]),
+ 'Lock-free Tx queue': Rule([tx('MT_LOCKFREE')]),
+ 'Fast mbuf free': Rule([tx('MBUF_FAST_FREE')]),
+ 'Free Tx mbuf on demand': Rule([op('tx_done_cleanup')]),
+ 'Queue start/stop': Rule([op('rx_queue_start'), op('rx_queue_stop'),
+ op('tx_queue_start'), op('tx_queue_stop')]),
+ 'Runtime Rx queue setup': Rule([capa('RUNTIME_RX_QUEUE_SETUP')]),
+ 'Runtime Tx queue setup': Rule([capa('RUNTIME_TX_QUEUE_SETUP')]),
+ 'Runtime queue setup': Rule([capa('RUNTIME_RX_QUEUE_SETUP'),
+ capa('RUNTIME_TX_QUEUE_SETUP')]),
+ 'Shared Rx queue': Rule([capa('RXQ_SHARE')]),
+ 'Burst mode info': Rule([op('rx_burst_mode_get'),
+ op('tx_burst_mode_get')]),
+ 'Power mgmt address monitor': Rule([op('get_monitor_addr')]),
+ 'MTU update': Rule([op('mtu_set')]),
+ 'Buffer split on Rx': Rule([rx('BUFFER_SPLIT')]),
+ 'Selective Rx': Rule([tok(r'\bselective_rx\b')]),
+ 'Scattered Rx': Rule([rx('SCATTER')]),
+ 'LRO': Rule([rx('TCP_LRO')]),
+ 'TSO': Rule([tx('TCP_TSO')]),
+ 'Promiscuous mode': Rule([op('promiscuous_enable'),
+ op('promiscuous_disable')]),
+ 'Allmulticast mode': Rule([op('allmulticast_enable'),
+ op('allmulticast_disable')]),
+ 'Unicast MAC filter': Rule([op('mac_addr_add'), op('mac_addr_remove')]),
+ 'Multicast MAC filter': Rule([op('set_mc_addr_list')]),
+ 'RSS hash': Rule([tok(r'\bRTE_ETH_RX_OFFLOAD_RSS_HASH\b',
+ r'\bflow_type_rss_offloads\s*\|?=\s*(?!0\s*;)')]),
+ 'RSS key update': Rule([op('rss_hash_update'), op('rss_hash_conf_get')]),
+ 'RSS reta update': Rule([op('reta_update'), op('reta_query')]),
+ 'Inner RSS': Rule([tok(r'\bRTE_ETH_RSS_LEVEL_\w+',
+ r'\brss\w*(->|\.)level\b')], code2doc=False),
+ 'VMDq': Rule([tok(r'\bRTE_ETH_MQ_RX_VMDQ_ONLY\b', r'\bvmdq_rx_conf\b')],
+ code2doc=False),
+ 'DCB': Rule([op('get_dcb_info')]),
+ 'VLAN filter': Rule([op('vlan_filter_set')]),
+ 'Flow control': Rule([op('flow_ctrl_get'), op('flow_ctrl_set')]),
+ 'Rate limitation': Rule([op('set_queue_rate_limit')]),
+ 'Congestion management': Rule([op('cman_info_get'),
+ op('cman_config_set'),
+ op('cman_config_get')]),
+ 'Traffic manager': Rule([op('tm_ops_get')]),
+ 'Inline crypto': Rule(
+ [tok(r'\bRTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO\b')]),
+ 'Inline protocol': Rule(
+ [tok(r'\bRTE_SECURITY_ACTION_TYPE_INLINE_PROTOCOL\b')]),
+ 'CRC offload': Rule([rx('KEEP_CRC')]),
+ 'VLAN offload': Rule([tok(r'\bRTE_ETH_RX_OFFLOAD_VLAN_STRIP\b',
+ r'\bRTE_ETH_RX_OFFLOAD_VLAN\b'),
+ tx('VLAN_INSERT')]),
+ 'QinQ offload': Rule([tok(r'\bRTE_ETH_RX_OFFLOAD_QINQ_STRIP\b',
+ r'\bRTE_ETH_RX_OFFLOAD_VLAN_EXTEND\b'),
+ tx('QINQ_INSERT')]),
+ 'FEC': Rule([op('fec_get_capability'), op('fec_get'), op('fec_set')]),
+ 'IP reassembly': Rule([op('ip_reassembly_capability_get'),
+ op('ip_reassembly_conf_get'),
+ op('ip_reassembly_conf_set')]),
+ 'L3 checksum offload': Rule([tok(r'\bRTE_ETH_RX_OFFLOAD_IPV4_CKSUM\b',
+ r'\bRTE_ETH_RX_OFFLOAD_CHECKSUM\b'),
+ tx('IPV4_CKSUM')]),
+ 'L4 checksum offload': Rule([tok(r'\bRTE_ETH_RX_OFFLOAD_UDP_CKSUM\b',
+ r'\bRTE_ETH_RX_OFFLOAD_CHECKSUM\b'),
+ tok(r'\bRTE_ETH_RX_OFFLOAD_TCP_CKSUM\b',
+ r'\bRTE_ETH_RX_OFFLOAD_CHECKSUM\b'),
+ tx('UDP_CKSUM'), tx('TCP_CKSUM')]),
+ 'Timestamp offload': Rule([rx('TIMESTAMP')]),
+ 'MACsec offload': Rule([rx('MACSEC_STRIP'), tx('MACSEC_INSERT')]),
+ 'Inner L3 checksum': Rule([rx('OUTER_IPV4_CKSUM'),
+ tx('OUTER_IPV4_CKSUM')], strict=False),
+ 'Inner L4 checksum': Rule([rx('OUTER_UDP_CKSUM'), tx('OUTER_UDP_CKSUM')],
+ strict=False),
+ 'Packet type parsing': Rule([op('dev_supported_ptypes_get')]),
+ 'Timesync': Rule([op('timesync_enable'), op('timesync_disable'),
+ op('timesync_read_rx_timestamp'),
+ op('timesync_read_tx_timestamp'),
+ op('timesync_adjust_time'), op('timesync_read_time'),
+ op('timesync_write_time')]),
+ 'Rx descriptor status': Rule([fp('rx_descriptor_status')]),
+ 'Tx descriptor status': Rule([fp('tx_descriptor_status')]),
+ 'Descriptor status': Rule([fp('rx_descriptor_status'),
+ fp('tx_descriptor_status')]),
+ 'Tx queue count': Rule([fp('tx_queue_count')]),
+ 'Basic stats': Rule([op('stats_get')]),
+ 'Extended stats': Rule([op('xstats_get'), op('xstats_get_names')]),
+ 'Stats per queue': Rule([tok(r'\bq_[io](packets|bytes)\b',
+ r'\bRTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS\b')],
+ strict=False),
+ 'FW version': Rule([op('fw_version_get')]),
+ 'EEPROM dump': Rule([op('get_eeprom_length'), op('get_eeprom')]),
+ 'Module EEPROM dump': Rule([op('get_module_info'),
+ op('get_module_eeprom')]),
+ 'Registers dump': Rule([op('get_reg')]),
+ 'LED': Rule([op('dev_led_on'), op('dev_led_off')]),
+ 'Multiprocess aware': Rule([tok(r'\bRTE_PROC_SECONDARY\b',
+ r'\bRTE_PROC_PRIMARY\b',
+ r'\brte_eal_process_type\s*\(')],
+ code2doc=False),
+}
+
+# rows with no code equivalent
+UNCHECKED = {'Usage doc', 'Design doc', 'Perf doc', 'SR-IOV'}
+
+# rows implied by another row in the same ini: (row, needs one of)
+DOC_IMPLIES = [
+ ('Selective Rx', ['Buffer split on Rx']),
+ ('Link status event', ['Link status']),
+ ('RSS key update', ['RSS hash']),
+ ('RSS reta update', ['RSS hash']),
+ ('Inner RSS', ['RSS hash']),
+ ('QinQ offload', ['VLAN offload']),
+ ('Inner L3 checksum', ['L3 checksum offload']),
+ ('Inner L4 checksum', ['L4 checksum offload']),
+ ('Stats per queue', ['Basic stats']),
+]
+
+# ops that only make sense together
+OP_PAIRS = [
+ ('rx_queue_start', 'rx_queue_stop'),
+ ('tx_queue_start', 'tx_queue_stop'),
+ ('dev_set_link_up', 'dev_set_link_down'),
+ ('promiscuous_enable', 'promiscuous_disable'),
+ ('allmulticast_enable', 'allmulticast_disable'),
+ ('rx_queue_intr_enable', 'rx_queue_intr_disable'),
+ ('dev_led_on', 'dev_led_off'),
+ ('timesync_enable', 'timesync_disable'),
+ ('mac_addr_add', 'mac_addr_remove'),
+ ('udp_tunnel_port_add', 'udp_tunnel_port_del'),
+ ('xstats_enable', 'xstats_disable'),
+ ('hairpin_bind', 'hairpin_unbind'),
+ ('xstats_get', 'xstats_get_names'),
+ ('xstats_get_by_id', 'xstats_get_names_by_id'),
+]
+
+# (have, needs, message): one-way dependencies
+CODE_IMPLIES = [(op(a), op(b), None) for a, b in OP_PAIRS] + \
+ [(op(b), op(a), None) for a, b in OP_PAIRS] + \
+ [(op(a), op(b), None) for a, b in [
+ ('timesync_read_rx_timestamp', 'timesync_enable'),
+ ('timesync_read_tx_timestamp', 'timesync_enable'),
+ ('timesync_adjust_time', 'timesync_read_time'),
+ ('timesync_write_time', 'timesync_read_time'),
+ ('stats_get', 'stats_reset'),
+ ('flow_ctrl_set', 'flow_ctrl_get'),
+ ('reta_update', 'reta_query'),
+ ('rss_hash_update', 'rss_hash_conf_get'),
+ ('fec_set', 'fec_get'),
+ ('fec_set', 'fec_get_capability'),
+ ('get_eeprom', 'get_eeprom_length'),
+ ('set_eeprom', 'get_eeprom_length'),
+ ('get_module_eeprom', 'get_module_info'),
+ ('cman_config_set', 'cman_info_get'),
+ ('cman_config_set', 'cman_config_get'),
+ ('cman_config_set', 'cman_config_init'),
+ ('ip_reassembly_conf_set', 'ip_reassembly_capability_get'),
+ ('ip_reassembly_conf_set', 'ip_reassembly_conf_get'),
+ ('priority_flow_ctrl_queue_config',
+ 'priority_flow_ctrl_queue_info_get'),
+ ('rx_hairpin_queue_setup', 'hairpin_cap_get'),
+ ('tx_hairpin_queue_setup', 'hairpin_cap_get'),
+ ('rx_queue_avail_thresh_set', 'rx_queue_avail_thresh_query'),
+ ('speed_lanes_set', 'speed_lanes_get_capa'),
+ ]] + [
+ (op('timesync_enable'), op('timesync_read_time'),
+ 'Timesync without timesync_read_time, no way to read device clock'),
+ (rx('TIMESTAMP'), op('read_clock'),
+ 'Rx timestamp offload without read_clock, no way to read NIC clock'),
+ (rx('TIMESTAMP'), tok(r'\brte_mbuf_dyn_rx_timestamp_register\s*\('),
+ 'Rx timestamp offload without rte_mbuf_dyn_rx_timestamp_register()'),
+ (tx('SEND_ON_TIMESTAMP'), op('read_clock'),
+ 'Tx send on timestamp without read_clock, no way to read NIC clock'),
+ (tx('SEND_ON_TIMESTAMP'),
+ tok(r'\brte_mbuf_dyn_tx_timestamp_register\s*\('),
+ 'Tx send on timestamp without rte_mbuf_dyn_tx_timestamp_register()'),
+ (tok(r'\bRTE_ETH_DEV_INTR_LSC\b', r'\bRTE_PCI_DRV_INTR_LSC\b'),
+ op('link_update'), 'LSC interrupt without link_update'),
+ (rx('VLAN_FILTER'), op('vlan_filter_set'),
+ 'VLAN filter offload without vlan_filter_set'),
+ (rx('BUFFER_SPLIT'), tok(r'\brx_n?seg\b'),
+ 'buffer split offload without rx_seg handling'),
+]
+
+OS_ROWS = ('FreeBSD', 'Linux', 'Windows')
+ARCH_ROWS = {
+ 'x86-64': ('x86', 'x86_64', {'RTE_ARCH_X86', 'RTE_ARCH_X86_64',
+ 'RTE_ARCH_64'}),
+ 'x86-32': ('x86', 'x86', {'RTE_ARCH_X86', 'RTE_ARCH_I686',
+ 'RTE_ARCH_32'}),
+ 'ARMv8': ('arm', 'aarch64', {'RTE_ARCH_ARM64', 'RTE_ARCH_64'}),
+ 'ARMv7': ('arm', 'arm', {'RTE_ARCH_ARM', 'RTE_ARCH_ARMv7',
+ 'RTE_ARCH_32'}),
+ 'Power8': ('ppc', 'ppc64', {'RTE_ARCH_PPC_64', 'RTE_ARCH_64'}),
+ 'LoongArch64': ('loongarch', 'loongarch64', {'RTE_ARCH_LOONGARCH',
+ 'RTE_ARCH_64'}),
+ 'rv64': ('riscv', 'riscv64', {'RTE_ARCH_RISCV', 'RTE_ARCH_64'}),
+}
+
+# rte_flow exceptions carried over from parse-flow-support.sh:
+# driver -> (file, marker on following line, extra excluded tokens)
+FLOW_EXCLUDE = {
+ 'bnxt': ('tf_ulp/ulp_rte_handler_tbl.c', 'TYPE_NOT_SUPPORTED',
+ {'RTE_FLOW_ACTION_TYPE_SHARED'}),
+ 'dpaa2': ('dpaa2_flow.c', 'Skip this', set()),
+}
+FLOW_IGNORE = {'void', 'indirect', 'end'}
+
+
+# ---------------------------------------------------------------------------
+# ini parsing
+# ---------------------------------------------------------------------------
+class Ini:
+ def __init__(self, path):
+ self.path = path
+ self.sections = {} # name -> list of (key, value, line)
+ section = None
+ with open(path, encoding='utf-8') as f:
+ for lineno, line in enumerate(f, 1):
+ line = line.strip()
+ if not line or line[0] in ';#':
+ continue
+ if line.startswith('['):
+ section = line.strip('[]')
+ self.sections.setdefault(section, [])
+ continue
+ if section is None or '=' not in line:
+ continue
+ key, _, value = line.partition('=')
+ self.sections[section].append((key.strip(), value.strip(),
+ lineno))
+
+ def rows(self, section):
+ return {k.lower(): v for k, v, _ in self.sections.get(section, [])}
+
+
+# ---------------------------------------------------------------------------
+# C source scanning
+# ---------------------------------------------------------------------------
+C_STRIP = re.compile(r'//[^\n]*|/\*.*?\*/|"(?:\\.|[^"\\\n])*"'
+ r"|'(?:\\.|[^'\\\n])*'", re.S)
+IF0 = re.compile(r'^\s*#\s*if\s+0\b.*?^\s*#\s*(endif|else)\b', re.S | re.M)
+
+
+def strip_c(text):
+ def repl(m):
+ s = m.group(0)
+ if s.startswith('/'):
+ return ' ' if s.startswith('//') else '\n' * s.count('\n') or ' '
+ return s[0] * 2
+ return IF0.sub('', C_STRIP.sub(repl, text))
+
+
+def match_brace(text, start):
+ """return index after the brace matching text[start] == '{'"""
+ depth = 0
+ for i in range(start, len(text)):
+ c = text[i]
+ if c == '{':
+ depth += 1
+ elif c == '}':
+ depth -= 1
+ if depth == 0:
+ return i + 1
+ return len(text)
+
+
+OPS_DECL = re.compile(r'struct\s+eth_dev_ops\s+(\w+)\s*(\[\s*\w*\s*\])?'
+ r'\s*=\s*\{')
+MEMBER = re.compile(r'\.\s*(\w+)\s*=\s*([^,}]+)')
+FP_MEMBERS = ('rx_descriptor_status', 'tx_descriptor_status',
+ 'rx_queue_count', 'tx_queue_count', 'tx_pkt_prepare')
+FP_ASSIGN = {m: re.compile(m + r'\s*=\s*(\w+)') for m in FP_MEMBERS}
+NULL_VALUES = {'NULL', '0'}
+STUB_BODY = re.compile(r'^(?:(?:RTE_SET_USED\s*\([^;]*\)|\(\s*void\s*\)\s*\w+'
+ r'|\w*LOG\w*\s*\([^;]*\))\s*;\s*)*'
+ r'return\s*-?\s*\(?\s*(ENOTSUP|ENOSYS|EOPNOTSUPP)'
+ r'\s*\)?\s*;\s*$', re.S)
+
+
+FUNC_DEF = re.compile(r'^(?:[A-Za-z_][\w \t*]*[\s*])?(\w+)\s*\([^;{}]*\)\s*\{',
+ re.M)
+
+
+class Code:
+ """Facts extracted from the sources of one driver (or a subset)."""
+
+ def __init__(self, path, files=None, ops_filter=None):
+ self.path = path
+ self.texts = {}
+ for root, _, names in os.walk(path):
+ for name in sorted(names):
+ if not name.endswith(('.c', '.h')):
+ continue
+ full = os.path.join(root, name)
+ rel = os.path.relpath(full, path)
+ if files and not any(fnmatch(rel, g)
+ for g in files.split('|')):
+ continue
+ with open(full, encoding='utf-8', errors='replace') as f:
+ self.texts[rel] = strip_c(f.read())
+ self.text = '\n'.join(self.texts.values())
+ self.found = {}
+ self.funcs = None
+ self.ops = {} # member -> function name
+ self.ops_structs = set()
+ self.fp = {}
+ self._parse_ops(ops_filter)
+ self._parse_fp()
+ self.stubs = {m: f for m, f in self.ops.items() if self._is_stub(f)}
+
+ def _parse_ops(self, ops_filter):
+ for m in OPS_DECL.finditer(self.text):
+ name = m.group(1)
+ if ops_filter and not re.search(ops_filter, name):
+ continue
+ self.ops_structs.add(name)
+ body = self.text[m.end() - 1:match_brace(self.text, m.end() - 1)]
+ for member, value in MEMBER.findall(body):
+ value = value.strip()
+ if value not in NULL_VALUES:
+ self.ops.setdefault(member, value)
+ # runtime assignment to a known ops instance
+ for name in self.ops_structs:
+ if self.text.count(name) < 2:
+ continue
+ pat = re.escape(name) + r'\s*(?:\.|->)\s*(\w+)\s*=\s*([^;=][^;]*);'
+ for m in re.finditer(pat, self.text):
+ value = m.group(2).strip()
+ if self.text[m.start() - 1:m.start()].isidentifier():
+ continue
+ if value not in NULL_VALUES:
+ self.ops.setdefault(m.group(1), value)
+
+ def _parse_fp(self):
+ for member, pat in FP_ASSIGN.items():
+ for m in pat.finditer(self.text):
+ before = self.text[:m.start()].rstrip()[-2:]
+ if (before[-1:] == '.' or before == '->') \
+ and m.group(1) not in NULL_VALUES:
+ self.fp.setdefault(member, m.group(1))
+ break
+
+ def _find(self, pattern):
+ """regex search; a leading \\bIDENT is matched as a literal"""
+ m = re.match(r'\\b(\w+)', pattern)
+ if not m:
+ return re.search(pattern, self.text) is not None
+ lit = m.group(1)
+ if lit not in self.text:
+ return False
+ for m in re.finditer(re.escape(lit) + pattern[m.end():], self.text):
+ if not self.text[m.start() - 1:m.start()].isidentifier():
+ return True
+ return False
+
+ def _is_stub(self, func):
+ if self.funcs is None:
+ self.funcs = {}
+ for key, text in self.texts.items():
+ for m in FUNC_DEF.finditer(text):
+ self.funcs.setdefault(m.group(1), (key, m.end() - 1))
+ if func not in self.funcs:
+ return False
+ key, start = self.funcs[func]
+ text = self.texts[key]
+ body = text[start + 1:match_brace(text, start) - 1].strip()
+ return bool(STUB_BODY.match(body))
+
+ def _search(self, pattern):
+ if pattern not in self.found:
+ self.found[pattern] = self._find(pattern)
+ return self.found[pattern]
+
+ def has(self, ev, precise_only=False):
+ if ev.kind == 'op':
+ return any(n in self.ops and n not in self.stubs
+ for n in ev.names)
+ if precise_only:
+ return None
+ if ev.kind == 'fp':
+ return any(n in self.fp for n in ev.names)
+ return any(self._search(n) for n in ev.names)
+
+ def tokens(self, prefix):
+ return {m.group(0) for m in re.finditer(prefix + r'\w+', self.text)
+ if not self.text[m.start() - 1:m.start()].isidentifier()}
+
+
+# ---------------------------------------------------------------------------
+# meson.build evaluation for OS/arch support
+# ---------------------------------------------------------------------------
+class Undecidable(Exception):
+ pass
+
+
+class MesonConf:
+ def __init__(self, keys):
+ self.keys = keys
+
+ def _check(self, key):
+ if not key.startswith('RTE_ARCH_') or key == 'RTE_ARCH':
+ raise Undecidable(key)
+
+ def get(self, key, *_):
+ self._check(key)
+ return key in self.keys
+
+ def has(self, key):
+ self._check(key)
+ return key in ('RTE_ARCH_64', 'RTE_ARCH_32') or key in self.keys
+
+
+class MesonHost:
+ def __init__(self, cpu):
+ self.cpu = cpu
+
+ def cpu_family(self):
+ return self.cpu
+
+
+MESON_TOKEN = re.compile(r"\s+|'[^']*'|\d+|[A-Za-z_]\w*|==|!=|[().,]")
+MESON_NAMES = {'is_linux', 'is_freebsd', 'is_windows', 'arch_subdir',
+ 'dpdk_conf', 'host_machine', 'cpu_family', 'get', 'has',
+ 'startswith', 'and', 'or', 'not', 'true', 'false'}
+
+
+def meson_eval(expr, env):
+ """Evaluate a meson condition for a platform, None if not decidable."""
+ pos = 0
+ out = []
+ while pos < len(expr):
+ m = MESON_TOKEN.match(expr, pos)
+ if not m:
+ return None
+ t = m.group(0)
+ pos = m.end()
+ if re.fullmatch(r'[A-Za-z_]\w*', t):
+ if t not in MESON_NAMES:
+ return None
+ t = {'true': 'True', 'false': 'False'}.get(t, t)
+ out.append(t)
+ try:
+ return bool(eval(''.join(out), {'__builtins__': {}}, env))
+ except (Undecidable, AttributeError, NameError, SyntaxError, TypeError):
+ return None
+
+
+def meson_statements(path):
+ """Parse meson.build into a tree of if/foreach blocks and statements."""
+ with open(path, encoding='utf-8') as f:
+ raw = f.read().splitlines()
+ lines = []
+ buf = ''
+ for line in raw:
+ line = re.sub(r"#(?=(?:[^']*'[^']*')*[^']*$).*", '', line).strip()
+ buf = (buf + ' ' + line).strip()
+ if buf.count('(') + buf.count('[') > buf.count(')') + buf.count(']'):
+ continue
+ if buf:
+ lines.append(buf)
+ buf = ''
+
+ def block(i, end_words):
+ nodes = []
+ while i < len(lines):
+ line = lines[i]
+ word = line.split(None, 1)[0]
+ if word in end_words:
+ return nodes, i
+ if word == 'if':
+ branches = []
+ cond = line[2:].strip()
+ orelse = None
+ while True:
+ body, i = block(i + 1, ('elif', 'else', 'endif'))
+ if orelse is not None:
+ orelse = body
+ else:
+ branches.append((cond, body))
+ word = lines[i].split(None, 1)[0] if i < len(lines) \
+ else 'endif'
+ if word == 'elif':
+ cond = lines[i][4:].strip()
+ elif word == 'else':
+ orelse = []
+ else:
+ break
+ nodes.append(('if', branches, orelse or []))
+ elif word == 'foreach':
+ _, i = block(i + 1, ('endforeach',))
+ else:
+ nodes.append(('stmt', line))
+ i += 1
+ return nodes, i
+
+ return block(0, ())[0]
+
+
+class Meson:
+ def __init__(self, root):
+ self.root = root
+ self.trees = {}
+ self.cache = {}
+
+ def _tree(self, path):
+ if path not in self.trees:
+ self.trees[path] = meson_statements(path) \
+ if os.path.exists(path) else []
+ return self.trees[path]
+
+ def _dep_path(self, dep):
+ if '_' in dep:
+ cls, name = dep.split('_', 1)
+ base = os.path.join(self.root, 'drivers', cls)
+ for cand in (os.path.join(base, name),
+ os.path.join(base, 'intel', name)):
+ if os.path.isdir(cand):
+ return cand
+ cand = os.path.join(self.root, 'lib', dep)
+ return cand if os.path.isdir(cand) else None
+
+ def _run(self, nodes, env, state):
+ for node in nodes:
+ if node[0] == 'if':
+ taken = False
+ unknown = False
+ for cond, body in node[1]:
+ v = meson_eval(cond, env)
+ if v is None:
+ unknown = True
+ elif v:
+ taken = True
+ if not self._run(body, env, state):
+ return False
+ break
+ if not taken and not unknown:
+ if not self._run(node[2], env, state):
+ return False
+ continue
+ stmt = node[1]
+ m = re.match(r'build\s*=\s*(.*)$', stmt)
+ if m:
+ if meson_eval(m.group(1), env) is False:
+ state['build'] = False
+ continue
+ m = re.match(r'deps\s*\+?=\s*(.*)$', stmt)
+ if m:
+ state['deps'].update(re.findall(r"'([\w]+)'", m.group(1)))
+ continue
+ if stmt.startswith('subdir_done()'):
+ return False
+ return True
+
+ def buildable(self, path, platform, env, seen=()):
+ key = (path, platform)
+ if key in self.cache:
+ return self.cache[key]
+ state = {'build': True, 'deps': set()}
+ self._run(self._tree(os.path.join(path, 'meson.build')), env, state)
+ result = (state['build'], None if state['build'] else
+ os.path.relpath(path, self.root))
+ if result[0]:
+ for dep in sorted(state['deps']):
+ dpath = self._dep_path(dep)
+ if not dpath or dpath in seen or dpath == path:
+ continue
+ ok, why = self.buildable(dpath, platform, env,
+ seen + (path,))
+ if not ok:
+ result = (False, why)
+ break
+ self.cache[key] = result
+ return result
+
+
+def platform_env(os_name, arch):
+ subdir, cpu, keys = ARCH_ROWS[arch]
+ return {'is_linux': os_name == 'Linux',
+ 'is_freebsd': os_name == 'FreeBSD',
+ 'is_windows': os_name == 'Windows',
+ 'arch_subdir': subdir,
+ 'dpdk_conf': MesonConf(keys),
+ 'host_machine': MesonHost(cpu)}
+
+
+def platform_support(meson, path):
+ """row -> (buildable, blocking component)"""
+ res = {}
+ for os_name in OS_ROWS:
+ res[os_name] = meson.buildable(path, os_name,
+ platform_env(os_name, 'x86-64'))
+ for arch in ARCH_ROWS:
+ res[arch] = meson.buildable(path, 'Linux-' + arch,
+ platform_env('Linux', arch))
+ return res
+
+
+# ---------------------------------------------------------------------------
+# checks
+# ---------------------------------------------------------------------------
+class Report(list):
+ def __call__(self, level, name, msg):
+ self.append((name, level, msg))
+
+ def keys(self):
+ # line numbers move when unrelated rows change
+ return {(n, lvl, re.sub(r'^line \d+: ', '', m)) for n, lvl, m in self}
+
+
+def support(code, rule, precise_only):
+ """return 'Y', 'P', '' or None (not decidable)"""
+ hits = [code.has(ev, precise_only) for ev in rule.req]
+ if None in hits:
+ return None
+ if all(hits):
+ return 'Y'
+ return 'P' if any(hits) else ''
+
+
+def ev_str(ev):
+ """readable form of the evidence patterns"""
+ def clean(pat):
+ pat = re.sub(r'\(\?!.*?\)|\\s\*|\\b|\\\|\?=|\\s\*\\\(', '', pat)
+ pat = re.sub(r'\\w[+*]', '*', pat)
+ pat = pat.replace('(->|\\.)', '.')
+ pat = re.sub(r'.\?', '', pat).replace('\\', '')
+ return pat.rstrip('=( ')
+ return '|'.join(clean(n) for n in ev.names)
+
+
+def misplaced(order):
+ """indexes not in a longest increasing subsequence of order"""
+ best = [1] * len(order)
+ prev = [-1] * len(order)
+ for i, v in enumerate(order):
+ for j in range(i):
+ if order[j] < v and best[j] + 1 > best[i]:
+ best[i], prev[i] = best[j] + 1, j
+ keep = set()
+ i = max(range(len(order)), key=best.__getitem__, default=-1)
+ while i >= 0:
+ keep.add(i)
+ i = prev[i]
+ return [i for i in range(len(order)) if i not in keep]
+
+
+def check_ini_syntax(name, ini, default, report):
+ for section, entries in ini.sections.items():
+ valid = [k.lower() for k, _, _ in default.sections.get(section, [])]
+ if section not in default.sections:
+ report(ERROR, name, 'unknown section [%s]' % section)
+ continue
+ seen = set()
+ known = []
+ for key, value, lineno in entries:
+ k = key.lower()
+ if k not in valid:
+ report(ERROR, name, 'line %d: unknown row "%s" in [%s]'
+ % (lineno, key, section))
+ continue
+ if k in seen:
+ report(ERROR, name, 'line %d: duplicate row "%s"'
+ % (lineno, key))
+ seen.add(k)
+ allowed = ('Y', 'P', 'I') if section == 'rte_flow actions' \
+ else ('Y', 'P')
+ if value and value not in allowed:
+ report(ERROR, name, 'line %d: invalid value "%s" for "%s"'
+ % (lineno, value, key))
+ known.append((valid.index(k), lineno, key))
+ bad = misplaced([idx for idx, _, _ in known])
+ if bad:
+ rows = ', '.join('"%s"' % known[i][2] for i in bad)
+ report(WARNING, name, 'line %d: %s not in default.ini order'
+ % (known[bad[0]][1], rows))
+
+
+def check_flow(name, drv, code, ini, report):
+ if drv.shared:
+ return
+ excluded = set()
+ exc = FLOW_EXCLUDE.get(os.path.basename(drv.dir))
+ if exc:
+ # the marker may be a comment, so scan the raw file
+ fname, marker, extra = exc
+ excluded |= extra
+ with open(os.path.join(code.path, fname), encoding='utf-8') as f:
+ raw = f.read().splitlines()
+ for cur, nxt in zip(raw, raw[1:]):
+ if marker in nxt:
+ excluded |= set(re.findall(
+ r'\bRTE_FLOW_(?:ITEM|ACTION)_TYPE_\w+', cur))
+
+ has_flow_ops = 'flow_ops_get' in code.ops
+ for kind in ('item', 'action'):
+ prefix = 'RTE_FLOW_%s_TYPE_' % kind.upper()
+ in_code = {t[len(prefix):].lower() for t in code.tokens(prefix)
+ if t not in excluded}
+ in_code -= FLOW_IGNORE
+ in_doc = {k for k, v in ini.rows('rte_flow %ss' % kind).items()}
+ for t in sorted(in_code - in_doc):
+ report(ERROR, name, 'rte_flow %s %s not documented' % (kind, t))
+ for t in sorted(in_doc - in_code):
+ report(ERROR, name, 'rte_flow %s %s documented, not in code'
+ % (kind, t))
+ if in_doc and not has_flow_ops and code.ops:
+ report(ERROR, name, 'rte_flow %ss documented without flow_ops_get'
+ % kind)
+
+
+def check_features(name, drv, code, ini, default, report):
+ rows = ini.rows('Features')
+ for row, _, _ in default.sections.get('Features', []):
+ rule = RULES.get(row)
+ if rule is None:
+ continue
+ doc = rows.get(row.lower(), '')[:1]
+ have = support(code, rule, False)
+ if drv.shared == 'all':
+ exact = None
+ elif drv.shared == 'ops':
+ exact = support(code, rule, True)
+ else:
+ exact = have
+
+ if doc and have == '':
+ stub = [n for ev in rule.req if ev.kind == 'op'
+ for n in ev.names if n in code.stubs]
+ why = '%s only returns an error' % ', '.join(stub) if stub \
+ else 'no ' + ' or '.join(ev_str(ev) for ev in rule.req)
+ report(ERROR if rule.strict else WARNING, name,
+ '"%s" documented, %s' % (row, why))
+ continue
+ if not doc:
+ if have and rule.code2doc and exact:
+ report(WARNING, name, '"%s" implemented, not documented%s'
+ % (row, '' if have == 'Y' else ' (partial)'))
+ continue
+ if doc == 'Y' and have == 'P':
+ missing = [ev_str(ev) for ev in rule.req
+ if not code.has(ev)]
+ report(WARNING, name, '"%s" documented Y, partial in code '
+ '(missing %s)' % (row, ', '.join(missing)))
+ elif doc == 'P' and have == 'Y' and not drv.shared:
+ report(INFO, name, '"%s" documented P, all of %s present'
+ % (row, ', '.join(ev_str(ev) for ev in rule.req)))
+
+ present = {k for k, v in rows.items() if v}
+ valid = {k.lower() for k, _, _ in default.sections.get('Features', [])}
+ for row, needs in DOC_IMPLIES:
+ needs = [n for n in needs if n.lower() in valid]
+ if row.lower() in present and needs and \
+ not present.intersection(n.lower() for n in needs):
+ report(WARNING, name, '"%s" documented without "%s"'
+ % (row, '" or "'.join(needs)))
+
+
+def check_code(name, drv, code, report):
+ for member, func in sorted(code.stubs.items()):
+ report(WARNING, name, '%s = %s only returns an error, leave it NULL'
+ % (member, func))
+ for have, need, msg in CODE_IMPLIES:
+ if drv.shared and (have.kind, need.kind) != ('op', 'op'):
+ continue
+ if need.kind == 'op' and any(n in code.stubs for n in need.names):
+ continue
+ if code.has(have) and not code.has(need):
+ report(WARNING, name, msg or '%s without %s'
+ % (ev_str(have), ev_str(need)))
+
+
+def check_platform(name, drv, ini, meson, report):
+ rows = ini.rows('Features')
+ sup = platform_support(meson, os.path.join(meson.root, NET, drv.dir))
+ for row, (ok, why) in sup.items():
+ doc = rows.get(row.lower(), '')
+ if doc and not ok:
+ report(ERROR, name, '"%s" documented, build disabled by %s'
+ % (row, why))
+ elif not doc and ok and not drv.shared:
+ report(INFO, name, '"%s" not documented, meson allows build'
+ % row)
+ if not any(rows.get(r.lower()) for r in OS_ROWS):
+ report(WARNING, name, 'no OS documented')
+ if not any(rows.get(r.lower()) for r in ARCH_ROWS):
+ report(WARNING, name, 'no architecture documented')
+
+
+def driver_for(root, ini_name):
+ drv = DRIVERS.get(ini_name)
+ if drv:
+ return drv
+ for cand in (ini_name, 'intel/' + ini_name):
+ if os.path.isdir(os.path.join(root, NET, cand)):
+ return Driver(cand)
+ return None
+
+
+def all_inis(root):
+ return sorted(f[:-4] for f in os.listdir(os.path.join(root, FEATURES))
+ if f.endswith('.ini') and f != 'default.ini')
+
+
+def all_dirs(root):
+ dirs = []
+ net = os.path.join(root, NET)
+ for d in sorted(os.listdir(net)):
+ if d == 'intel':
+ dirs += ['intel/' + s for s in sorted(os.listdir(
+ os.path.join(net, d)))
+ if os.path.isdir(os.path.join(net, d, s))]
+ elif os.path.isdir(os.path.join(net, d)):
+ dirs.append(d)
+ return dirs
+
+
+def git(*args):
+ try:
+ return subprocess.run(['git', '-C', ROOT] + list(args), check=True,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE).stdout
+ except subprocess.CalledProcessError as e:
+ sys.exit(e.stderr.decode().strip())
+
+
+def changed_inis(ref):
+ """ini names affected by changes since ref, None for all"""
+ files = git('diff', '--name-only', ref + '...HEAD').decode().split()
+ myself = os.path.relpath(os.path.realpath(__file__), ROOT)
+ if any(f in (FEATURES + '/default.ini', myself) for f in files):
+ return None
+ inis = set()
+ dir_to_inis = {}
+ for n in all_inis(ROOT):
+ drv = driver_for(ROOT, n)
+ if drv:
+ dir_to_inis.setdefault(drv.dir, set()).add(n)
+ for f in files:
+ m = re.match(re.escape(FEATURES) + r'/(\w+)\.ini$', f)
+ if m:
+ inis.add(m.group(1))
+ continue
+ for d, names in dir_to_inis.items():
+ if f.startswith('%s/%s/' % (NET, d)):
+ inis |= names
+ return sorted(inis)
+
+
+def extract_ref(ref, inis, dest):
+ """write the files needed to check inis at ref into dest"""
+ dirs = {driver_for(ROOT, n).dir for n in inis if driver_for(ROOT, n)}
+ paths = [FEATURES, ':(glob)drivers/**/meson.build',
+ ':(glob)lib/*/meson.build']
+ paths += [NET + '/' + d for d in sorted(dirs)
+ if git('ls-tree', '-d', ref, NET + '/' + d).strip()]
+ tar = git('archive', '--format=tar', ref, '--', *paths)
+ subprocess.run(['tar', '-x', '-C', dest], input=tar, check=True)
+
+
+def check(root, inis, report, full=False):
+ features = os.path.join(root, FEATURES)
+ default = Ini(os.path.join(features, 'default.ini'))
+ meson = Meson(root)
+ for row, _, _ in default.sections.get('Features', []):
+ if row not in RULES and row not in UNCHECKED and \
+ row not in OS_ROWS and row not in ARCH_ROWS:
+ report(INFO, 'default.ini', 'no rule for "%s"' % row)
+ if full:
+ mapped = {driver_for(root, n).dir for n in inis
+ if driver_for(root, n)}
+ for d in all_dirs(root):
+ if d not in mapped and d not in NO_INI:
+ report(WARNING, d, 'no features ini')
+ for name in inis:
+ path = os.path.join(features, name + '.ini')
+ if not os.path.exists(path):
+ continue
+ drv = driver_for(root, name)
+ ini = Ini(path)
+ check_ini_syntax(name, ini, default, report)
+ if drv is None:
+ report(ERROR, name, 'no driver directory')
+ continue
+ code = Code(os.path.join(root, NET, drv.dir), drv.files, drv.ops)
+ check_flow(name, drv, code, ini, report)
+ check_features(name, drv, code, ini, default, report)
+ if drv.shared != 'all':
+ check_code(name, drv, code, report)
+ check_platform(name, drv, ini, meson, report)
+
+
+def generate(name):
+ """print a suggested ini from the code"""
+ drv = driver_for(ROOT, name)
+ if not drv:
+ sys.exit('%s: no driver directory' % name)
+ default = Ini(os.path.join(ROOT, FEATURES, 'default.ini'))
+ path = os.path.join(ROOT, NET, drv.dir)
+ code = Code(path, drv.files, drv.ops)
+ sup = platform_support(Meson(ROOT), path)
+ print(';\n; Supported features of the \'%s\' network poll mode driver.'
+ '\n;\n; Refer to default.ini for the full list of available PMD '
+ 'features.\n;\n[Features]' % name)
+ for row, _, _ in default.sections['Features']:
+ if row in sup:
+ val = 'Y' if sup[row][0] else ''
+ elif row in RULES:
+ val = support(code, RULES[row], False)
+ else:
+ continue
+ if val:
+ print('%-20s = %s' % (row, val))
+ for kind in ('item', 'action'):
+ prefix = 'RTE_FLOW_%s_TYPE_' % kind.upper()
+ toks = sorted({t[len(prefix):].lower() for t in code.tokens(prefix)}
+ - FLOW_IGNORE)
+ if toks:
+ print('\n[rte_flow %ss]' % kind)
+ for t in toks:
+ print('%-20s = Y' % t)
+
+
+def main():
+ ap = argparse.ArgumentParser(
+ description=__doc__,
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ epilog='''examples:
+ %(prog)s check all drivers
+ %(prog)s origin/main check what this branch introduces
+ %(prog)s -q -d ice errors for one ini
+ %(prog)s -g ice ini rows supported by the code''')
+ ap.add_argument('ref', nargs='?',
+ help='check drivers changed since this git ref, '
+ 'report only what is new')
+ ap.add_argument('-d', '--driver', action='append', default=[],
+ help='check only this ini name (repeatable)')
+ ap.add_argument('-g', '--generate', metavar='DRIVER',
+ help='print ini content derived from code')
+ ap.add_argument('-q', '--quiet', action='store_true',
+ help='report errors only')
+ ap.add_argument('-v', '--verbose', action='store_true',
+ help='report informational notes too')
+ args = ap.parse_args()
+
+ if args.generate:
+ generate(args.generate)
+ return 0
+
+ report = Report()
+ if args.ref:
+ inis = args.driver or changed_inis(args.ref)
+ if inis is None:
+ inis = all_inis(ROOT)
+ check(ROOT, inis, report)
+ if report:
+ old = Report()
+ with tempfile.TemporaryDirectory() as tmp:
+ extract_ref(args.ref, inis, tmp)
+ check(tmp, inis, old)
+ known = old.keys()
+ report = [r for r in report
+ if (r[0], r[1], re.sub(r'^line \d+: ', '', r[2]))
+ not in known]
+ else:
+ inis = args.driver or all_inis(ROOT)
+ check(ROOT, inis, report, full=not args.driver)
+
+ level = ERROR if args.quiet else INFO if args.verbose else WARNING
+ for name, lvl, msg in report:
+ if lvl <= level:
+ print('%s: %s: %s' % (name, LEVEL_NAME[lvl], msg))
+ return 1 if any(lvl == ERROR for _, lvl, _ in report) else 0
+
+
+if __name__ == '__main__':
+ sys.exit(main())
diff --git a/devtools/check-doc-vs-code.sh b/devtools/check-doc-vs-code.sh
deleted file mode 100755
index c58c239c87..0000000000
--- a/devtools/check-doc-vs-code.sh
+++ /dev/null
@@ -1,84 +0,0 @@
-#! /bin/sh -e
-# SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2021 Mellanox Technologies, Ltd
-
-# Check whether doc & code are in sync.
-# Optional argument: check only what changed since a commit.
-trusted_commit=$1 # example: origin/main
-
-selfdir=$(dirname $(readlink -f $0))
-rootdir=$(readlink -f $selfdir/..)
-
-# speed up by ignoring Unicode details
-export LC_COLLATE=C
-
-result=0
-error() # <message>
-{
- echo "$*"
- result=$(($result + 1))
-}
-
-changed_files()
-{
- [ -n "$files" ] ||
- files=$(git diff-tree --name-only -r $trusted_commit..)
- echo "$files"
-}
-
-has_code_change() # <pattern>
-{
- test -n "$(git log --format='%h' -S"$1" $trusted_commit..)"
-}
-
-has_file_change() # <pattern>
-{
- changed_files | grep -q "$1"
-}
-
-changed_net_drivers()
-{
- net_paths='drivers/net/|doc/guides/nics/features/'
- [ -n "$drivers" ] ||
- drivers=$(changed_files |
- sed -rn "s,^($net_paths)([^./]*).*,\2,p" |
- sort -u)
- echo "$drivers"
-}
-
-all_net_drivers()
-{
- find $rootdir/drivers/net -mindepth 1 -maxdepth 1 -type d |
- sed 's,.*/,,' |
- sort
-}
-
-check_rte_flow() # <driver>
-{
- code=$rootdir/drivers/net/$1
- doc=$rootdir/doc/guides/nics/features/$1.ini
- [ -d $code ] || return 0
- [ -f $doc ] || return 0
- report=$($selfdir/parse-flow-support.sh $code $doc)
- if [ -n "$report" ]; then
- error "rte_flow doc out of sync for $1"
- echo "$report" | sed 's,^,\t,'
- fi
-}
-
-if [ -z "$trusted_commit" ]; then
- # check all
- for driver in $(all_net_drivers); do
- check_rte_flow $driver
- done
- exit $result
-fi
-
-# find what changed and check
-if has_code_change 'RTE_FLOW_.*_TYPE_' ||
- has_file_change 'doc/guides/nics/features'; then
- for driver in $(changed_net_drivers); do
- check_rte_flow $driver
- done
-fi
-exit $result
diff --git a/devtools/parse-flow-support.sh b/devtools/parse-flow-support.sh
deleted file mode 100755
index 44b4cecafd..0000000000
--- a/devtools/parse-flow-support.sh
+++ /dev/null
@@ -1,92 +0,0 @@
-#! /bin/sh -e
-# SPDX-License-Identifier: BSD-3-Clause
-# Copyright 2021 Mellanox Technologies, Ltd
-
-# Parse rte_flow support of a driver directory,
-# and optionally show difference with a doc file in .ini format.
-
-dir=$1 # drivers/net/foo
-ref=$2 # doc/guides/nics/features/foo.ini
-
-if [ -z "$dir" ]; then
- echo "directory argument is required" >&2
- exit 1
-fi
-
-# test git-grep for -o (--only-matching) option
-if ! git grep -qo git -- $0 >/dev/null 2>&1; then
- echo "git version >= 2.19 is required" >&2
- exit 1
-fi
-
-# sorting order
-export LC_COLLATE=C
-
-# exclude exceptions
-exclude() # <pattern>
-{
- case $(basename $dir) in
- bnxt)
- filter=$(sed -n "/$1/{N;/TYPE_NOT_SUPPORTED/P;}" \
- $dir/tf_ulp/ulp_rte_handler_tbl.c |
- grep -wo "$1[[:alnum:]_]*" | sort -u |
- tr '\n' '|' | sed 's,.$,\n,')
- exceptions='RTE_FLOW_ACTION_TYPE_SHARED'
- grep -vE "$filter" | grep -vE $exceptions;;
- dpaa2)
- filter=$(sed -n "/$1/{N;/Skip this/P;}" \
- $dir/dpaa2_flow.c |
- grep -wo "$1[[:alnum:]_]*" | sort -u |
- tr '\n' '|' | sed 's,.$,\n,')
- [ "$1" = 'RTE_FLOW_ITEM_TYPE_' -a -z "$filter" ] && cat ||
- grep -vE "$filter";;
- *) cat
- esac
-}
-
-# include exceptions
-include() # <pattern>
-{
- case $(basename $dir) in
- esac
-}
-
-# generate INI section
-list() # <title> <pattern>
-{
- echo "[$1]"
- git grep -who "$2[[:alnum:]_]*" $dir |
- (exclude $2; include $2) | sort -u |
- awk 'sub(/'$2'/, "") {printf "%-20s = Y\n", tolower($0)}'
-}
-
-rte_flow_support() # <category>
-{
- title="rte_flow $1s"
- pattern=$(echo "RTE_FLOW_$1_TYPE_" | awk '{print toupper($0)}')
- list "$title" "$pattern" | grep -vwE 'void|indirect|end'
-}
-
-if [ -z "$ref" ]; then # generate full tables
- rte_flow_support item
- echo
- rte_flow_support action
- exit 0
-fi
-
-# compare with reference input
-rte_flow_compare() # <category>
-{
- section="rte_flow $1s]"
- {
- rte_flow_support $1
- sed -n "/$section/,/]/p" "$ref" | sed '/^$/d'
- } |
- sed '/]/d' | # ignore section title
- sed 's, *=.*,,' | # ignore value (better in doc than generated one)
- sort | uniq -u | # show differences
- sed "s,^,$1 ," # prefix with category name
-}
-
-rte_flow_compare item
-rte_flow_compare action
diff --git a/doc/guides/contributing/new_driver.rst b/doc/guides/contributing/new_driver.rst
index e7f7695752..2c74c933c9 100644
--- a/doc/guides/contributing/new_driver.rst
+++ b/doc/guides/contributing/new_driver.rst
@@ -97,6 +97,8 @@ Split patches following this approach:
* Organize each patch logically as a new feature.
* Run test tools per patch (See :ref:`contrib_tool_list`).
* Update relevant documentation and `<driver>.ini` file with each patch.
+ ``devtools/check-doc-vs-code.py -g <driver>`` prints the rows
+ that the driver code supports, as a starting point.
The following order in the patch series is as suggested below.
@@ -207,7 +209,7 @@ Run the following test tools per patch in a patch series:
* `checkpatches.sh`
* `check-git-log.sh`
* `check-meson.py`
-* `check-doc-vs-code.sh`
+* `check-doc-vs-code.py`
* `check-spdx-tag.sh`
* Build documentation and validate how output looks
* Optionally run ``review-patch.py`` for AI-assisted review
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index f4996fd195..dace3a5205 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -513,6 +513,33 @@ The script usage is::
For both scripts, the -n option specifies a number of commits from HEAD,
and the -r option specifies a ``git log`` range.
+.. _contrib_check_doc_vs_code:
+
+When a patch changes a network driver or its features file,
+check that the NIC feature tables (see :doc:`/nics/overview`)
+match the driver code using the ``check-doc-vs-code.py`` script::
+
+ devtools/check-doc-vs-code.py origin/main
+
+With a git reference, only drivers changed since that reference are checked,
+and only findings not already present at the reference are reported.
+Without a reference, all drivers are checked.
+
+Errors are features documented without matching code,
+platforms excluded by the build, and rte_flow mismatches.
+Warnings are features implemented but not documented,
+full support documented where the code is partial,
+and incomplete sets of operations such as a queue start without stop.
+The script exits with an error status only if errors are reported.
+
+The script usage is::
+
+ check-doc-vs-code.py [-h] [-d DRIVER] [-g DRIVER] [-q] [-v] [ref]
+
+The -d option restricts the check to one features file,
+and the -g option prints the features derived from the driver code,
+as a starting point for a new driver.
+
Additionally, when contributing to the DTS tool, check patches using
the ``dts-check-format.sh`` script in the ``devtools`` directory of the DPDK repo.
Running the script requires extra :ref:`Python dependencies <dts_deps>`.
diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index 43eda7867d..dff6dfa7f4 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -22,6 +22,11 @@ for cases where provided data can't be represented simply by a function.
``[related]`` : Related API with that feature.
+The feature tables in ``doc/guides/nics/features/`` are checked against
+the driver code by ``devtools/check-doc-vs-code.py``,
+based on the structs and flags listed below.
+See :ref:`the contributing guide <contrib_check_doc_vs_code>` for usage.
+
.. _nic_features_speed_capabilities:
--
2.53.0
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-23 18:42 [RFC] devtools: rewrite doc vs code check in Python Stephen Hemminger
@ 2026-09-23 18:44 ` Stephen Hemminger
2026-09-23 19:19 ` Thomas Monjalon
1 sibling, 0 replies; 8+ messages in thread
From: Stephen Hemminger @ 2026-09-23 18:44 UTC (permalink / raw)
To: dev; +Cc: Aaron Conole, Thomas Monjalon, Anatoly Burakov
On Wed, 23 Sep 2026 11:42:07 -0700
Stephen Hemminger <stephen@networkplumber.org> wrote:
> The existing check-doc-vs-code.sh only compares rte_flow items and
> actions, and only for drivers whose directory matches the ini name,
> so none of the drivers under net/intel are checked.
>
> Replace it and parse-flow-support.sh with a Python script covering
> the whole NIC feature matrix:
> - ini syntax: unknown rows, invalid values, duplicates, row order
> - rte_flow items and actions, keeping the bnxt and dpaa2 exceptions
> - feature rows against eth_dev_ops, fast-path ops, offload and
> capability flags, including full (Y) vs partial (P) support
> - ops that only return -ENOTSUP
> - OS and architecture rows against meson.build and its dependencies
> - incomplete operation sets, e.g. start without stop,
> or Rx timestamp without read_clock
> - rows requiring another row in the same ini
>
> Drivers sharing a directory (PF/VF, e1000/igb/igc) are matched
> by their own eth_dev_ops instance or source files.
>
> Given a git reference, only drivers changed since the reference
> are checked, and findings already present at the reference are
> not reported, so existing documentation gaps do not fail CI.
>
> Documented but not implemented is an error. Implemented but not
> documented, and incomplete operation sets, are warnings.
> Option -v adds notes such as platforms meson allows but the ini
> does not list. Option -g prints ini rows derived from driver code.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
This tool finds lots of incorrect/missing stuff:
bonding: warning: no features ini
null: warning: no features ini
ring: warning: no features ini
softnic: warning: no features ini
af_xdp: warning: no OS documented
afpacket: warning: line 9: "MTU update" not in default.ini order
afpacket: warning: "Scattered Rx" implemented, not documented
afpacket: warning: "VLAN offload" implemented, not documented
afpacket: warning: "Timestamp offload" implemented, not documented
afpacket: warning: Rx timestamp offload without read_clock, no way to read NIC clock
afpacket: warning: no OS documented
afpacket: warning: no architecture documented
ark: warning: "Link status" implemented, not documented
ark: warning: "Link status event" implemented, not documented
ark: warning: "MTU update" implemented, not documented
ark: error: "Scattered Rx" documented, no RTE_ETH_RX_OFFLOAD_SCATTER
ark: warning: "Unicast MAC filter" implemented, not documented
ark: warning: "Timestamp offload" implemented, not documented
ark: warning: Rx timestamp offload without read_clock, no way to read NIC clock
ark: warning: Rx timestamp offload without rte_mbuf_dyn_rx_timestamp_register()
atlantic: warning: line 23: "MACsec offload" not in default.ini order
atlantic: warning: "Rx interrupt" implemented, not documented
atlantic: warning: "TSO" implemented, not documented
atlantic: warning: "Multicast MAC filter" implemented, not documented
avp: error: "Scattered Rx" documented, no RTE_ETH_RX_OFFLOAD_SCATTER
avp: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
avp: warning: "QinQ offload" implemented, not documented (partial)
avp: warning: VLAN filter offload without vlan_filter_set
axgbe: warning: "MTU update" implemented, not documented
axgbe: warning: "Unicast MAC filter" implemented, not documented
axgbe: warning: "Multicast MAC filter" implemented, not documented
axgbe: warning: "Flow control" implemented, not documented
axgbe: warning: "VLAN offload" implemented, not documented
axgbe: warning: "QinQ offload" implemented, not documented
axgbe: warning: "Packet type parsing" implemented, not documented
axgbe: warning: "Timesync" implemented, not documented
axgbe: warning: "Rx descriptor status" implemented, not documented
axgbe: warning: "Tx descriptor status" implemented, not documented
axgbe: warning: "Extended stats" implemented, not documented
axgbe: warning: "Stats per queue" implemented, not documented
axgbe: warning: "Registers dump" implemented, not documented
bnx2x: warning: "Allmulticast mode" implemented, not documented
bnx2x: warning: stats_get without stats_reset
bnxt: warning: line 40: "VLAN offload" not in default.ini order
bnxt: warning: line 64: "ipv4", "ipv6" not in default.ini order
bnxt: warning: "Removal event" implemented, not documented
bnxt: warning: "Buffer split on Rx" implemented, not documented
bnxt: warning: "QinQ offload" implemented, not documented
bnxt: warning: "Timestamp offload" implemented, not documented
bnxt: warning: "Inner L4 checksum" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM)
bnxt: warning: Rx timestamp offload without read_clock, no way to read NIC clock
cnxk: warning: line 10: "SR-IOV", "Multiprocess aware", "Link status", "Link status event", "Fast mbuf free", "Free Tx mbuf on demand", "Queue start/stop", "Flow control", "Scattered Rx", "Timestamp offload", "Extended stats" not in default.ini order
cnxk: warning: "LRO" implemented, not documented
cnxk: warning: "Rate limitation" implemented, not documented
cnxk: warning: "CRC offload" implemented, not documented
cnxk: warning: "VLAN offload" implemented, not documented
cnxk: warning: "QinQ offload" implemented, not documented
cnxk: warning: "IP reassembly" implemented, not documented (partial)
cnxk: warning: "MACsec offload" implemented, not documented
cnxk: warning: ip_reassembly_conf_get = cn10k_nix_reassembly_conf_get only returns an error, leave it NULL
cnxk: warning: Tx send on timestamp without rte_mbuf_dyn_tx_timestamp_register()
cnxk: warning: VLAN filter offload without vlan_filter_set
cnxk_vec: warning: line 10: "SR-IOV", "Multiprocess aware", "Link status", "Link status event", "Fast mbuf free", "Free Tx mbuf on demand", "Queue start/stop", "Flow control", "Extended stats" not in default.ini order
cnxk_vf: warning: line 10: "Multiprocess aware", "Link status", "Link status event", "Fast mbuf free", "Free Tx mbuf on demand", "Queue start/stop", "Scattered Rx", "Extended stats" not in default.ini order
cpfl: error: "Speed capabilities" documented, no speed_capa
cpfl: warning: "Fast mbuf free" implemented, not documented
cpfl: warning: "CRC offload" implemented, not documented
cpfl: warning: "VLAN offload" implemented, not documented
cpfl: warning: "QinQ offload" implemented, not documented
cpfl: warning: "Inner L3 checksum" implemented, not documented
cpfl: warning: "Timesync" implemented, not documented (partial)
cpfl: warning: "Extended stats" implemented, not documented
cpfl: warning: Rx timestamp offload without read_clock, no way to read NIC clock
cpfl: warning: Rx timestamp offload without rte_mbuf_dyn_rx_timestamp_register()
cpfl: warning: VLAN filter offload without vlan_filter_set
cxgbe: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
cxgbe: warning: "Stats per queue" documented, no q_[io](packets|bytes)|RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS
cxgbevf: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
cxgbevf: warning: "Stats per queue" documented, no q_[io](packets|bytes)|RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS
cxgbevf: warning: stats_get without stats_reset
dpaa: warning: line 23: "Timestamp offload" not in default.ini order
dpaa: warning: "Rx interrupt" implemented, not documented
dpaa: warning: "Lock-free Tx queue" implemented, not documented
dpaa: warning: "Fast mbuf free" implemented, not documented
dpaa: warning: "RSS key update" implemented, not documented
dpaa: error: "Timestamp offload" documented, no RTE_ETH_RX_OFFLOAD_TIMESTAMP
dpaa: warning: "Inner L3 checksum" implemented, not documented
dpaa: warning: no OS documented
dpaa2: warning: line 10: "Burst mode info", "MTU update", "Timestamp offload" not in default.ini order
dpaa2: warning: "Lock-free Tx queue" implemented, not documented
dpaa2: warning: "Fast mbuf free" implemented, not documented
dpaa2: error: "Queue start/stop" documented, no rx_queue_start or rx_queue_stop or tx_queue_start or tx_queue_stop
dpaa2: warning: "RSS key update" implemented, not documented
dpaa2: warning: "VLAN offload" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_VLAN_STRIP|RTE_ETH_RX_OFFLOAD_VLAN)
dpaa2: warning: "Inner L3 checksum" implemented, not documented
dpaa2: warning: "Inner L4 checksum" implemented, not documented (partial)
dpaa2: warning: "Stats per queue" implemented, not documented
dpaa2: warning: Rx timestamp offload without read_clock, no way to read NIC clock
e1000: error: rte_flow item eth documented, not in code
e1000: error: rte_flow item ipv4 documented, not in code
e1000: error: rte_flow item ipv6 documented, not in code
e1000: error: rte_flow item raw documented, not in code
e1000: error: rte_flow item sctp documented, not in code
e1000: error: rte_flow item tcp documented, not in code
e1000: error: rte_flow item udp documented, not in code
e1000: error: rte_flow items documented without flow_ops_get
e1000: error: rte_flow action drop documented, not in code
e1000: error: rte_flow action queue documented, not in code
e1000: error: rte_flow action rss documented, not in code
e1000: error: rte_flow actions documented without flow_ops_get
e1000: error: "Free Tx mbuf on demand" documented, no tx_done_cleanup
e1000: warning: "Multicast MAC filter" implemented, not documented
e1000: error: "QinQ offload" documented, no RTE_ETH_RX_OFFLOAD_QINQ_STRIP|RTE_ETH_RX_OFFLOAD_VLAN_EXTEND or RTE_ETH_TX_OFFLOAD_QINQ_INSERT
e1000: warning: "LED" implemented, not documented
ena: warning: "Speed capabilities" implemented, not documented
ena: warning: "Timestamp offload" implemented, not documented
ena: warning: "Stats per queue" implemented, not documented
ena: warning: stats_get without stats_reset
ena: warning: Rx timestamp offload without read_clock, no way to read NIC clock
enetc: warning: line 7: "Packet type parsing", "Basic stats", "MTU update", "Queue start/stop" not in default.ini order
enetc4: warning: line 7: "Link status event", "RSS hash", "L3 checksum offload", "L4 checksum offload", "CRC offload", "Queue start/stop", "Scattered Rx" not in default.ini order
enetc4: error: "Speed capabilities" documented, no speed_capa
enetc4: error: "Link status event" documented, no RTE_ETH_DEV_INTR_LSC|RTE_PCI_DRV_INTR_LSC
enetc4: error: "Allmulticast mode" documented, no allmulticast_enable or allmulticast_disable
enetc4: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
enetc4: error: "VLAN filter" documented, no vlan_filter_set
enetc4_vf: warning: line 9: "Speed capabilities", "Link status", "RSS hash", "L3 checksum offload", "L4 checksum offload", "CRC offload", "Queue start/stop", "Scattered Rx" not in default.ini order
enetc4_vf: error: "Speed capabilities" documented, no speed_capa
enetc4_vf: warning: "MTU update" implemented, not documented
enetc4_vf: warning: "Unicast MAC filter" implemented, not documented (partial)
enetc4_vf: warning: mac_addr_add without mac_addr_remove
enetfec: warning: "Link status" implemented, not documented
enetfec: warning: "Promiscuous mode" documented Y, partial in code (missing promiscuous_disable)
enetfec: warning: "Allmulticast mode" implemented, not documented (partial)
enetfec: warning: "CRC offload" implemented, not documented
enetfec: warning: "VLAN offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_VLAN_INSERT)
enetfec: warning: "L3 checksum offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_IPV4_CKSUM)
enetfec: warning: "L4 checksum offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_UDP_CKSUM, RTE_ETH_TX_OFFLOAD_TCP_CKSUM)
enetfec: warning: promiscuous_enable without promiscuous_disable
enetfec: warning: allmulticast_enable without allmulticast_disable
enetfec: warning: stats_get without stats_reset
enic: warning: line 72: "queue" not in default.ini order
enic: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
enic: warning: "Inner L3 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM)
enic: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
failsafe: warning: "RSS key update" implemented, not documented (partial)
failsafe: warning: "Extended stats" implemented, not documented
failsafe: warning: rss_hash_update without rss_hash_conf_get
failsafe: warning: no OS documented
fm10k: error: "Multicast MAC filter" documented, no set_mc_addr_list
fm10k: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
fm10k: warning: "QinQ offload" implemented, not documented (partial)
fm10k_vf: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
gve: error: "Speed capabilities" documented, no speed_capa
gve: warning: "LRO" implemented, not documented
gve: warning: "L3 checksum offload" implemented, not documented
gve: warning: "Extended stats" implemented, not documented
hinic: warning: line 14: "LRO", "CRC offload", "Flow control", "ARMv8" not in default.ini order
hinic: error: "Queue start/stop" documented, no rx_queue_start or rx_queue_stop or tx_queue_start or tx_queue_stop
hinic: error: "Inner RSS" documented, no RTE_ETH_RSS_LEVEL_*|rss*.level
hinic: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
hinic: warning: "Inner L3 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM)
hinic: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
hinic3: warning: line 17: "LRO", "ARMv8" not in default.ini order
hinic3: error: "Speed capabilities" documented, no speed_capa
hinic3: error: "Link speed configuration" documented, no link_speeds
hinic3: warning: "Link status event" implemented, not documented
hinic3: error: "Runtime Rx queue setup" documented, no RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP
hinic3: error: "Runtime Tx queue setup" documented, no RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP
hinic3: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
hinic3: error: "QinQ offload" documented, no RTE_ETH_RX_OFFLOAD_QINQ_STRIP|RTE_ETH_RX_OFFLOAD_VLAN_EXTEND or RTE_ETH_TX_OFFLOAD_QINQ_INSERT
hinic3: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
hinic3: error: "Packet type parsing" documented, no dev_supported_ptypes_get
hns3: warning: line 16: "Fast mbuf free", "Free Tx mbuf on demand", "LRO", "Module EEPROM dump", "Timesync", "Timestamp offload" not in default.ini order
hns3: warning: "Power mgmt address monitor" implemented, not documented
hns3: warning: "QinQ offload" implemented, not documented
hns3: warning: "Stats per queue" documented, no q_[io](packets|bytes)|RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS
hns3: warning: Rx timestamp offload without read_clock, no way to read NIC clock
hns3_vf: warning: line 14: "Free Tx mbuf on demand", "LRO", "Rx descriptor status" not in default.ini order
hns3_vf: warning: "Power mgmt address monitor" implemented, not documented
hns3_vf: warning: "DCB" implemented, not documented
hns3_vf: warning: "Stats per queue" documented, no q_[io](packets|bytes)|RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS
hns3_vf: warning: "FW version" implemented, not documented
i40e: warning: line 54: "ARMv8", "Power8" not in default.ini order
i40e: warning: "Free Tx mbuf on demand" implemented, not documented
i40e: warning: "MTU update" implemented, not documented
i40e: warning: "EEPROM dump" implemented, not documented
i40e: warning: "Registers dump" implemented, not documented
i40e: warning: "LED" implemented, not documented
iavf: warning: "Link status event" implemented, not documented
iavf: warning: "Fast mbuf free" implemented, not documented
iavf: warning: "Timesync" implemented, not documented (partial)
iavf: warning: Rx timestamp offload without read_clock, no way to read NIC clock
ice: warning: line 14: "FEC", "DCB" not in default.ini order
ice: error: rte_flow item l2tpv2 not documented
ice: error: rte_flow item ppp not documented
ice: warning: "Inner L4 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM)
ice: warning: "EEPROM dump" implemented, not documented
ice_dcf: warning: line 18: "RSS reta update", "RSS key update", "MTU update", "Promiscuous mode", "Allmulticast mode", "Unicast MAC filter", "VLAN filter", "Traffic manager", "VLAN offload", "Basic stats", "Power mgmt address monitor" not in default.ini order
ice_dcf: warning: "Link status" implemented, not documented
ice_dcf: warning: "Free Tx mbuf on demand" implemented, not documented
ice_dcf: warning: "Multicast MAC filter" implemented, not documented
ice_dcf: warning: "Packet type parsing" implemented, not documented
idpf: warning: line 23: "Packet type parsing" not in default.ini order
idpf: error: "Speed capabilities" documented, no speed_capa
idpf: warning: "Fast mbuf free" implemented, not documented
idpf: warning: "CRC offload" implemented, not documented
idpf: warning: "Inner L3 checksum" implemented, not documented (partial)
idpf: warning: "Extended stats" implemented, not documented
idpf: warning: Rx timestamp offload without read_clock, no way to read NIC clock
igb: error: rte_flow item eth not documented
igb: error: rte_flow item ipv4 not documented
igb: error: rte_flow item ipv6 not documented
igb: error: rte_flow item raw not documented
igb: error: rte_flow item sctp not documented
igb: error: rte_flow item tcp not documented
igb: error: rte_flow item udp not documented
igb: error: rte_flow action drop not documented
igb: error: rte_flow action queue not documented
igb: error: rte_flow action rss not documented
igb: warning: "Free Tx mbuf on demand" implemented, not documented
igb: warning: "Burst mode info" implemented, not documented
igb: error: "DCB" documented, no get_dcb_info
igb: warning: "QinQ offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_QINQ_INSERT)
igb: warning: "LED" implemented, not documented
igb_vf: error: "Rx interrupt" documented, no rx_queue_intr_enable or rx_queue_intr_disable
igb_vf: warning: "Free Tx mbuf on demand" implemented, not documented
igb_vf: warning: "Burst mode info" implemented, not documented
igb_vf: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
igb_vf: warning: "Multicast MAC filter" implemented, not documented
igb_vf: warning: "QinQ offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_QINQ_INSERT)
igc: warning: line 10: "FW version", "LED", "Packet type parsing", "Rx descriptor status", "Tx descriptor status", "Rx interrupt", "Flow control", "RSS key update", "RSS reta update", "VLAN filter", "VLAN offload" not in default.ini order
igc: warning: "Free Tx mbuf on demand" implemented, not documented
igc: warning: "QinQ offload" implemented, not documented (partial)
igc: warning: "Timestamp offload" implemented, not documented
igc: warning: Rx timestamp offload without rte_mbuf_dyn_rx_timestamp_register()
ionic: warning: line 25: "VLAN offload" not in default.ini order
ionic: error: "LRO" documented, no RTE_ETH_RX_OFFLOAD_TCP_LRO
ionic: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
ionic: warning: "Inner L3 checksum" implemented, not documented (partial)
ionic: warning: "Inner L4 checksum" implemented, not documented (partial)
ipn3ke: error: "Link status event" documented, no RTE_ETH_DEV_INTR_LSC|RTE_PCI_DRV_INTR_LSC
ipn3ke: error: "Rx interrupt" documented, no rx_queue_intr_enable or rx_queue_intr_disable
ipn3ke: warning: "Fast mbuf free" implemented, not documented
ipn3ke: warning: "MTU update" implemented, not documented
ipn3ke: error: "Scattered Rx" documented, no RTE_ETH_RX_OFFLOAD_SCATTER
ipn3ke: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
ipn3ke: error: "Multicast MAC filter" documented, no set_mc_addr_list
ipn3ke: error: "RSS hash" documented, no RTE_ETH_RX_OFFLOAD_RSS_HASH|flow_type_rss_offloads
ipn3ke: error: "RSS key update" documented, no rss_hash_update or rss_hash_conf_get
ipn3ke: error: "RSS reta update" documented, no reta_update or reta_query
ipn3ke: error: "VMDq" documented, no RTE_ETH_MQ_RX_VMDQ_ONLY|vmdq_rx_conf
ipn3ke: error: "DCB" documented, no get_dcb_info
ipn3ke: error: "VLAN filter" documented, no vlan_filter_set
ipn3ke: error: "Flow control" documented, no flow_ctrl_get or flow_ctrl_set
ipn3ke: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
ipn3ke: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
ipn3ke: error: "Packet type parsing" documented, no dev_supported_ptypes_get
ipn3ke: error: "Timesync" documented, no timesync_enable or timesync_disable or timesync_read_rx_timestamp or timesync_read_tx_timestamp or timesync_adjust_time or timesync_read_time or timesync_write_time
ipn3ke: error: "Rx descriptor status" documented, no rx_descriptor_status
ipn3ke: error: "Tx descriptor status" documented, no tx_descriptor_status
ipn3ke: error: "FW version" documented, no fw_version_get
ipn3ke: error: "Module EEPROM dump" documented, no get_module_info or get_module_eeprom
ipn3ke: warning: VLAN filter offload without vlan_filter_set
ixgbe: warning: "Fast mbuf free" implemented, not documented
ixgbe: warning: "Free Tx mbuf on demand" implemented, not documented
ixgbe: warning: "Burst mode info" implemented, not documented
ixgbe: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
ixgbe: warning: "LED" implemented, not documented
ixgbe_vf: warning: "Free Tx mbuf on demand" implemented, not documented
ixgbe_vf: warning: "Burst mode info" implemented, not documented
ixgbe_vf: warning: "Multicast MAC filter" implemented, not documented
ixgbe_vf: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
mana: warning: line 15: "MTU update" not in default.ini order
mana: warning: "RSS key update" implemented, not documented
mana: warning: "VLAN offload" implemented, not documented
mana: warning: "Packet type parsing" implemented, not documented
mana: warning: "Stats per queue" implemented, not documented
memif: warning: "Stats per queue" implemented, not documented
memif: warning: no OS documented
mlx4: error: "Queue start/stop" documented, no rx_queue_start or rx_queue_stop or tx_queue_start or tx_queue_stop
mlx4: warning: "Inner L3 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM)
mlx4: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
mlx5: warning: line 103: "represented_port" not in default.ini order
mlx5: warning: line 135: "queue" not in default.ini order
mlx5: error: "Flow control" documented, flow_ctrl_get, flow_ctrl_set only returns an error
mlx5: warning: "Inner L3 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM)
mlx5: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
mlx5: error: "Module EEPROM dump" documented, get_module_info, get_module_eeprom only returns an error
mlx5: warning: dev_set_link_down = mlx5_set_link_down only returns an error, leave it NULL
mlx5: warning: dev_set_link_up = mlx5_set_link_up only returns an error, leave it NULL
mlx5: warning: flow_ctrl_get = mlx5_dev_get_flow_ctrl only returns an error, leave it NULL
mlx5: warning: flow_ctrl_set = mlx5_dev_set_flow_ctrl only returns an error, leave it NULL
mlx5: warning: get_module_eeprom = mlx5_get_module_eeprom only returns an error, leave it NULL
mlx5: warning: get_module_info = mlx5_get_module_info only returns an error, leave it NULL
mlx5: warning: udp_tunnel_port_add without udp_tunnel_port_del
mvneta: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
mvneta: warning: no OS documented
mvpp2: warning: "Queue start/stop" implemented, not documented (partial)
mvpp2: error: "Multicast MAC filter" documented, no set_mc_addr_list
mvpp2: warning: "RSS key update" implemented, not documented
mvpp2: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
mvpp2: warning: "Stats per queue" implemented, not documented
mvpp2: warning: no OS documented
nbl: warning: "Link status" implemented, not documented
nbl: warning: "Link status event" implemented, not documented
nbl: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
nbl: warning: "RSS hash" implemented, not documented
netvsc: warning: line 15: "Extended stats", "MTU update" not in default.ini order
netvsc: warning: "Link status event" implemented, not documented
netvsc: warning: "Removal event" implemented, not documented
netvsc: error: "Scattered Rx" documented, no RTE_ETH_RX_OFFLOAD_SCATTER
netvsc: warning: "TSO" implemented, not documented
netvsc: warning: "Multicast MAC filter" implemented, not documented
netvsc: warning: "RSS hash" implemented, not documented
netvsc: warning: "RSS key update" implemented, not documented
netvsc: warning: "RSS reta update" implemented, not documented
netvsc: warning: "VLAN offload" implemented, not documented
netvsc: warning: "L3 checksum offload" implemented, not documented
netvsc: warning: "L4 checksum offload" implemented, not documented
netvsc: warning: "Packet type parsing" implemented, not documented
netvsc: warning: "Rx descriptor status" implemented, not documented
netvsc: warning: "Tx descriptor status" implemented, not documented
nfb: warning: "MTU update" implemented, not documented
nfb: warning: "FEC" implemented, not documented (partial)
nfb: error: "Extended stats" documented, no xstats_get or xstats_get_names
nfb: warning: fec_set without fec_get_capability
nfb: warning: Rx timestamp offload without read_clock, no way to read NIC clock
nfp: warning: line 15: "TSO", "Multiprocess aware" not in default.ini order
nfp: warning: line 68: "port_id" not in default.ini order
nfp: error: "Queue start/stop" documented, no rx_queue_start or rx_queue_stop or tx_queue_start or tx_queue_stop
nfp: warning: "Burst mode info" implemented, not documented
nfp: warning: "Inline crypto" implemented, not documented
nfp: warning: "Inline protocol" implemented, not documented
nfp: warning: "QinQ offload" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_QINQ_INSERT)
nfp: warning: "Extended stats" implemented, not documented
nfp: warning: "FW version" implemented, not documented
ngbe: warning: "Inner L3 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM
ngbe: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
ngbe_vf: warning: line 8: "Unicast MAC filter", "Multicast MAC filter", "Free Tx mbuf on demand" not in default.ini order
ngbe_vf: error: "LRO" documented, no RTE_ETH_RX_OFFLOAD_TCP_LRO
ngbe_vf: error: "Inline crypto" documented, no RTE_SECURITY_ACTION_TYPE_INLINE_CRYPTO
ngbe_vf: warning: "Inner L3 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM
ngbe_vf: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
ntnic: warning: line 7: "FW version", "MTU update" not in default.ini order
ntnic: warning: "Promiscuous mode" implemented, not documented (partial)
ntnic: warning: "Unicast MAC filter" documented Y, partial in code (missing mac_addr_remove)
ntnic: warning: "Stats per queue" implemented, not documented
ntnic: warning: promiscuous_enable without promiscuous_disable
ntnic: warning: mac_addr_add without mac_addr_remove
octeon_ep: warning: line 11: "Basic stats", "Link status", "MTU update", "Multiprocess aware" not in default.ini order
octeon_ep: warning: "Scattered Rx" implemented, not documented
octeon_ep: warning: "Stats per queue" implemented, not documented
octeontx: warning: line 20: "CRC offload", "Flow control" not in default.ini order
octeontx: error: "Link status event" documented, no RTE_ETH_DEV_INTR_LSC|RTE_PCI_DRV_INTR_LSC
octeontx: warning: "Fast mbuf free" implemented, not documented
octeontx: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
octeontx: error: "VLAN offload" documented, no RTE_ETH_RX_OFFLOAD_VLAN_STRIP|RTE_ETH_RX_OFFLOAD_VLAN or RTE_ETH_TX_OFFLOAD_VLAN_INSERT
octeontx: warning: "Inner L4 checksum" documented Y, partial in code (missing RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM)
pcap: warning: line 13: "VLAN offload" not in default.ini order
pcap: warning: "Scattered Rx" implemented, not documented
pfe: warning: line 12: "MTU update", "Promiscuous mode", "Allmulticast mode" not in default.ini order
pfe: warning: "Allmulticast mode" documented Y, partial in code (missing allmulticast_disable)
pfe: warning: allmulticast_enable without allmulticast_disable
pfe: warning: stats_get without stats_reset
qede: warning: line 33: "SR-IOV" not in default.ini order
qede: warning: "Link status event" implemented, not documented
qede: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
qede: warning: "Rx descriptor status" implemented, not documented
qede: warning: "FW version" implemented, not documented
qede_vf: warning: line 34: "LRO", "TSO" not in default.ini order
qede_vf: error: "Flow control" documented, no flow_ctrl_get or flow_ctrl_set
qede_vf: warning: "FW version" implemented, not documented
r8169: warning: "Free Tx mbuf on demand" implemented, not documented
r8169: error: "Flow control" documented, no flow_ctrl_get or flow_ctrl_set
r8169: warning: "VLAN offload" implemented, not documented
rnp: warning: line 10: "Packet type parsing", "L3 checksum offload", "L4 checksum offload", "Inner L3 checksum", "Inner L4 checksum", "Basic stats", "Stats per queue", "Extended stats", "MTU update", "VLAN filter", "VLAN offload", "QinQ offload", "Scattered Rx", "TSO" not in default.ini order
rnp: warning: "Fast mbuf free" implemented, not documented
rnp: warning: "Burst mode info" implemented, not documented
rnp: error: "Inner RSS" documented, no RTE_ETH_RSS_LEVEL_*|rss*.level
rnp: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
sfc: warning: line 79: "queue" not in default.ini order
sxe2: warning: line 17: "Queue start/stop", "MTU update", "TSO", "Promiscuous mode", "Allmulticast mode", "Unicast MAC filter", "RSS hash", "RSS key update", "RSS reta update", "VLAN filter", "Inline crypto", "Packet type parsing", "Timesync" not in default.ini order
sxe2: warning: line 79: "port_id" not in default.ini order
sxe2: error: "Link status event" documented, no RTE_ETH_DEV_INTR_LSC|RTE_PCI_DRV_INTR_LSC
sxe2: warning: "Removal event" implemented, not documented
sxe2: warning: "LRO" implemented, not documented
sxe2: warning: "Multicast MAC filter" implemented, not documented
sxe2: error: "Timesync" documented, no timesync_enable or timesync_disable or timesync_read_rx_timestamp or timesync_read_tx_timestamp or timesync_adjust_time or timesync_read_time or timesync_write_time
sxe2: warning: "Stats per queue" implemented, not documented
sxe2: warning: Rx timestamp offload without read_clock, no way to read NIC clock
tap: warning: "TSO" implemented, not documented
tap: warning: "RSS key update" implemented, not documented (partial)
tap: warning: "Stats per queue" implemented, not documented
tap: warning: rss_hash_update without rss_hash_conf_get
thunderx: warning: "Fast mbuf free" implemented, not documented
thunderx: warning: "Promiscuous mode" documented Y, partial in code (missing promiscuous_disable)
thunderx: error: "Allmulticast mode" documented, no allmulticast_enable or allmulticast_disable
thunderx: error: "CRC offload" documented, no RTE_ETH_RX_OFFLOAD_KEEP_CRC
thunderx: warning: "Inner L3 checksum" implemented, not documented (partial)
thunderx: warning: promiscuous_enable without promiscuous_disable
txgbe: warning: "Free Tx mbuf on demand" implemented, not documented
txgbe: warning: "FEC" implemented, not documented
txgbe: warning: "MACsec offload" implemented, not documented
txgbe: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
txgbe_vf: warning: line 8: "Unicast MAC filter", "Multicast MAC filter", "Free Tx mbuf on demand" not in default.ini order
txgbe_vf: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
vhost: warning: line 9: "Queue status event" not in default.ini order
vhost: warning: "Link status event" implemented, not documented
vhost: warning: "Rx interrupt" implemented, not documented
vhost: warning: "Power mgmt address monitor" implemented, not documented
vhost: warning: "VLAN offload" implemented, not documented
vhost: warning: "Stats per queue" implemented, not documented
vhost: warning: no OS documented
virtio: warning: line 22: "Extended stats", "MTU update" not in default.ini order
virtio: warning: "Burst mode info" implemented, not documented
virtio: warning: "Power mgmt address monitor" implemented, not documented
virtio: warning: "LRO" implemented, not documented
virtio: warning: "TSO" implemented, not documented
virtio: error: "Multicast MAC filter" documented, no set_mc_addr_list
virtio: warning: "VLAN offload" implemented, not documented
virtio: warning: "L4 checksum offload" implemented, not documented
vmxnet3: warning: "Rx interrupt" implemented, not documented
vmxnet3: warning: "Scattered Rx" implemented, not documented
vmxnet3: error: "Unicast MAC filter" documented, no mac_addr_add or mac_addr_remove
vmxnet3: warning: "RSS reta update" implemented, not documented
vmxnet3: warning: "L3 checksum offload" implemented, not documented (partial)
vmxnet3: warning: "FW version" implemented, not documented
xsc: warning: "Speed capabilities" implemented, not documented
xsc: error: "Link status event" documented, no RTE_ETH_DEV_INTR_LSC|RTE_PCI_DRV_INTR_LSC
xsc: error: "RSS reta update" documented, no reta_update or reta_query
xsc: warning: "FEC" documented Y, partial in code (missing fec_get_capability)
xsc: warning: "Timestamp offload" implemented, not documented
xsc: warning: "Inner L3 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_IPV4_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM
xsc: warning: "Inner L4 checksum" documented, no RTE_ETH_RX_OFFLOAD_OUTER_UDP_CKSUM or RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM
xsc: warning: fec_set without fec_get_capability
xsc: warning: Rx timestamp offload without read_clock, no way to read NIC clock
xsc: warning: Rx timestamp offload without rte_mbuf_dyn_rx_timestamp_register()
zxdh: warning: line 7: "Linux", "x86-64", "ARMv8", "SR-IOV", "Multiprocess aware", "Scattered Rx", "Promiscuous mode", "Allmulticast mode", "RSS hash", "RSS reta update", "Inner RSS", "Basic stats", "Stats per queue", "MTU update", "LRO", "TSO" not in default.ini order
zxdh: warning: line 50: "count" not in default.ini order
zxdh: warning: "Speed capabilities" implemented, not documented
zxdh: warning: "Rx interrupt" implemented, not documented
zxdh: error: "Multicast MAC filter" documented, no set_mc_addr_list
zxdh: warning: "RSS key update" implemented, not documented
zxdh: warning: "L4 checksum offload" implemented, not documented
zxdh: warning: "Inner L4 checksum" documented Y, partial in code (missing RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM)
zxdh: warning: "Packet type parsing" implemented, not documented
zxdh: warning: "Inner L4 checksum" documented without "L4 checksum offload"
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-23 18:42 [RFC] devtools: rewrite doc vs code check in Python Stephen Hemminger
2026-09-23 18:44 ` Stephen Hemminger
@ 2026-09-23 19:19 ` Thomas Monjalon
2026-09-23 20:11 ` Stephen Hemminger
2026-09-23 20:54 ` Stephen Hemminger
1 sibling, 2 replies; 8+ messages in thread
From: Thomas Monjalon @ 2026-09-23 19:19 UTC (permalink / raw)
To: Stephen Hemminger; +Cc: dev, Aaron Conole, Anatoly Burakov
23/09/2026 20:42, Stephen Hemminger:
> The existing check-doc-vs-code.sh only compares rte_flow items and
> actions, and only for drivers whose directory matches the ini name,
> so none of the drivers under net/intel are checked.
>
> Replace it and parse-flow-support.sh with a Python script covering
> the whole NIC feature matrix:
[...]
> devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> devtools/check-doc-vs-code.sh | 84 --
> devtools/parse-flow-support.sh | 92 --
> doc/guides/contributing/new_driver.rst | 4 +-
> doc/guides/contributing/patches.rst | 27 +
> doc/guides/nics/features.rst | 5 +
> 8 files changed, 1169 insertions(+), 180 deletions(-)
> create mode 100755 devtools/check-doc-vs-code.py
> delete mode 100755 devtools/check-doc-vs-code.sh
> delete mode 100755 devtools/parse-flow-support.sh
Thanks for working on it.
My concern is how easy it is to maintain for all contributors
having to insert their rules and exceptions?
It is replacing less 200 lines with more than 1000 lines
so it looks a lot more complex.
It is probably fully generated by AI?
Can we make it simpler?
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-23 19:19 ` Thomas Monjalon
@ 2026-09-23 20:11 ` Stephen Hemminger
2026-09-23 20:54 ` Stephen Hemminger
1 sibling, 0 replies; 8+ messages in thread
From: Stephen Hemminger @ 2026-09-23 20:11 UTC (permalink / raw)
To: Thomas Monjalon; +Cc: dev, Aaron Conole, Anatoly Burakov
On Wed, 23 Sep 2026 21:19:45 +0200
Thomas Monjalon <thomas@monjalon.net> wrote:
> 23/09/2026 20:42, Stephen Hemminger:
> > The existing check-doc-vs-code.sh only compares rte_flow items and
> > actions, and only for drivers whose directory matches the ini name,
> > so none of the drivers under net/intel are checked.
> >
> > Replace it and parse-flow-support.sh with a Python script covering
> > the whole NIC feature matrix:
> [...]
> > devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> > devtools/check-doc-vs-code.sh | 84 --
> > devtools/parse-flow-support.sh | 92 --
> > doc/guides/contributing/new_driver.rst | 4 +-
> > doc/guides/contributing/patches.rst | 27 +
> > doc/guides/nics/features.rst | 5 +
> > 8 files changed, 1169 insertions(+), 180 deletions(-)
> > create mode 100755 devtools/check-doc-vs-code.py
> > delete mode 100755 devtools/check-doc-vs-code.sh
> > delete mode 100755 devtools/parse-flow-support.sh
>
> Thanks for working on it.
>
> My concern is how easy it is to maintain for all contributors
> having to insert their rules and exceptions?
The result doesn't have to be nothing. I would rather not keep track
of exceptions in the script.
> It is replacing less 200 lines with more than 1000 lines
> so it looks a lot more complex.
> It is probably fully generated by AI?
> Can we make it simpler?
I will look into it, should be table driven and more split up.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-23 19:19 ` Thomas Monjalon
2026-09-23 20:11 ` Stephen Hemminger
@ 2026-09-23 20:54 ` Stephen Hemminger
2026-09-24 7:33 ` Bruce Richardson
1 sibling, 1 reply; 8+ messages in thread
From: Stephen Hemminger @ 2026-09-23 20:54 UTC (permalink / raw)
To: Thomas Monjalon; +Cc: dev, Aaron Conole, Anatoly Burakov
On Wed, 23 Sep 2026 21:19:45 +0200
Thomas Monjalon <thomas@monjalon.net> wrote:
> 23/09/2026 20:42, Stephen Hemminger:
> > The existing check-doc-vs-code.sh only compares rte_flow items and
> > actions, and only for drivers whose directory matches the ini name,
> > so none of the drivers under net/intel are checked.
> >
> > Replace it and parse-flow-support.sh with a Python script covering
> > the whole NIC feature matrix:
> [...]
> > devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> > devtools/check-doc-vs-code.sh | 84 --
> > devtools/parse-flow-support.sh | 92 --
> > doc/guides/contributing/new_driver.rst | 4 +-
> > doc/guides/contributing/patches.rst | 27 +
> > doc/guides/nics/features.rst | 5 +
> > 8 files changed, 1169 insertions(+), 180 deletions(-)
> > create mode 100755 devtools/check-doc-vs-code.py
> > delete mode 100755 devtools/check-doc-vs-code.sh
> > delete mode 100755 devtools/parse-flow-support.sh
>
> Thanks for working on it.
>
> My concern is how easy it is to maintain for all contributors
> having to insert their rules and exceptions?
>
> It is replacing less 200 lines with more than 1000 lines
> so it looks a lot more complex.
> It is probably fully generated by AI?
> Can we make it simpler?
>
>
The other suggestion would be to git rid of the .ini file method
of generating this feature matrix in doc and just have python script
generate it. Prefer a single source of truth, less work
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-23 20:54 ` Stephen Hemminger
@ 2026-09-24 7:33 ` Bruce Richardson
2026-09-24 8:36 ` Thomas Monjalon
0 siblings, 1 reply; 8+ messages in thread
From: Bruce Richardson @ 2026-09-24 7:33 UTC (permalink / raw)
To: Stephen Hemminger; +Cc: Thomas Monjalon, dev, Aaron Conole, Anatoly Burakov
On Wed, Sep 23, 2026 at 01:54:30PM -0700, Stephen Hemminger wrote:
> On Wed, 23 Sep 2026 21:19:45 +0200
> Thomas Monjalon <thomas@monjalon.net> wrote:
>
> > 23/09/2026 20:42, Stephen Hemminger:
> > > The existing check-doc-vs-code.sh only compares rte_flow items and
> > > actions, and only for drivers whose directory matches the ini name,
> > > so none of the drivers under net/intel are checked.
> > >
> > > Replace it and parse-flow-support.sh with a Python script covering
> > > the whole NIC feature matrix:
> > [...]
> > > devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> > > devtools/check-doc-vs-code.sh | 84 --
> > > devtools/parse-flow-support.sh | 92 --
> > > doc/guides/contributing/new_driver.rst | 4 +-
> > > doc/guides/contributing/patches.rst | 27 +
> > > doc/guides/nics/features.rst | 5 +
> > > 8 files changed, 1169 insertions(+), 180 deletions(-)
> > > create mode 100755 devtools/check-doc-vs-code.py
> > > delete mode 100755 devtools/check-doc-vs-code.sh
> > > delete mode 100755 devtools/parse-flow-support.sh
> >
> > Thanks for working on it.
> >
> > My concern is how easy it is to maintain for all contributors
> > having to insert their rules and exceptions?
> >
> > It is replacing less 200 lines with more than 1000 lines
> > so it looks a lot more complex.
> > It is probably fully generated by AI?
> > Can we make it simpler?
> >
> >
>
> The other suggestion would be to git rid of the .ini file method
> of generating this feature matrix in doc and just have python script
> generate it. Prefer a single source of truth, less work
+1, I was just going to suggest that when I saw the discussion on this
script.
In case of autogeneration, for cases like "partial" support, we can have a
well-defined comment tag or similar in the code to mark it.
/Bruce
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-24 7:33 ` Bruce Richardson
@ 2026-09-24 8:36 ` Thomas Monjalon
2026-09-24 15:31 ` Stephen Hemminger
0 siblings, 1 reply; 8+ messages in thread
From: Thomas Monjalon @ 2026-09-24 8:36 UTC (permalink / raw)
To: Stephen Hemminger, Bruce Richardson; +Cc: dev, Aaron Conole, Anatoly Burakov
24/09/2026 09:33, Bruce Richardson:
> On Wed, Sep 23, 2026 at 01:54:30PM -0700, Stephen Hemminger wrote:
> > On Wed, 23 Sep 2026 21:19:45 +0200
> > Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > > 23/09/2026 20:42, Stephen Hemminger:
> > > > The existing check-doc-vs-code.sh only compares rte_flow items and
> > > > actions, and only for drivers whose directory matches the ini name,
> > > > so none of the drivers under net/intel are checked.
> > > >
> > > > Replace it and parse-flow-support.sh with a Python script covering
> > > > the whole NIC feature matrix:
> > > [...]
> > > > devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> > > > devtools/check-doc-vs-code.sh | 84 --
> > > > devtools/parse-flow-support.sh | 92 --
> > > > doc/guides/contributing/new_driver.rst | 4 +-
> > > > doc/guides/contributing/patches.rst | 27 +
> > > > doc/guides/nics/features.rst | 5 +
> > > > 8 files changed, 1169 insertions(+), 180 deletions(-)
> > > > create mode 100755 devtools/check-doc-vs-code.py
> > > > delete mode 100755 devtools/check-doc-vs-code.sh
> > > > delete mode 100755 devtools/parse-flow-support.sh
> > >
> > > Thanks for working on it.
> > >
> > > My concern is how easy it is to maintain for all contributors
> > > having to insert their rules and exceptions?
> > >
> > > It is replacing less 200 lines with more than 1000 lines
> > > so it looks a lot more complex.
> > > It is probably fully generated by AI?
> > > Can we make it simpler?
> > >
> > >
> >
> > The other suggestion would be to git rid of the .ini file method
> > of generating this feature matrix in doc and just have python script
> > generate it. Prefer a single source of truth, less work
>
> +1, I was just going to suggest that when I saw the discussion on this
> script.
> In case of autogeneration, for cases like "partial" support, we can have a
> well-defined comment tag or similar in the code to mark it.
I agree with this direction.
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [RFC] devtools: rewrite doc vs code check in Python
2026-09-24 8:36 ` Thomas Monjalon
@ 2026-09-24 15:31 ` Stephen Hemminger
0 siblings, 0 replies; 8+ messages in thread
From: Stephen Hemminger @ 2026-09-24 15:31 UTC (permalink / raw)
To: Thomas Monjalon; +Cc: Bruce Richardson, dev, Aaron Conole, Anatoly Burakov
On Thu, 24 Sep 2026 10:36:42 +0200
Thomas Monjalon <thomas@monjalon.net> wrote:
> 24/09/2026 09:33, Bruce Richardson:
> > On Wed, Sep 23, 2026 at 01:54:30PM -0700, Stephen Hemminger wrote:
> > > On Wed, 23 Sep 2026 21:19:45 +0200
> > > Thomas Monjalon <thomas@monjalon.net> wrote:
> > >
> > > > 23/09/2026 20:42, Stephen Hemminger:
> > > > > The existing check-doc-vs-code.sh only compares rte_flow items and
> > > > > actions, and only for drivers whose directory matches the ini name,
> > > > > so none of the drivers under net/intel are checked.
> > > > >
> > > > > Replace it and parse-flow-support.sh with a Python script covering
> > > > > the whole NIC feature matrix:
> > > > [...]
> > > > > devtools/check-doc-vs-code.py | 1132 ++++++++++++++++++++++++
> > > > > devtools/check-doc-vs-code.sh | 84 --
> > > > > devtools/parse-flow-support.sh | 92 --
> > > > > doc/guides/contributing/new_driver.rst | 4 +-
> > > > > doc/guides/contributing/patches.rst | 27 +
> > > > > doc/guides/nics/features.rst | 5 +
> > > > > 8 files changed, 1169 insertions(+), 180 deletions(-)
> > > > > create mode 100755 devtools/check-doc-vs-code.py
> > > > > delete mode 100755 devtools/check-doc-vs-code.sh
> > > > > delete mode 100755 devtools/parse-flow-support.sh
> > > >
> > > > Thanks for working on it.
> > > >
> > > > My concern is how easy it is to maintain for all contributors
> > > > having to insert their rules and exceptions?
> > > >
> > > > It is replacing less 200 lines with more than 1000 lines
> > > > so it looks a lot more complex.
> > > > It is probably fully generated by AI?
> > > > Can we make it simpler?
> > > >
> > > >
> > >
> > > The other suggestion would be to git rid of the .ini file method
> > > of generating this feature matrix in doc and just have python script
> > > generate it. Prefer a single source of truth, less work
> >
> > +1, I was just going to suggest that when I saw the discussion on this
> > script.
> > In case of autogeneration, for cases like "partial" support, we can have a
> > well-defined comment tag or similar in the code to mark it.
>
> I agree with this direction.
>
The plan AI generated is:
# DPDK NIC feature matrix: generator concept
Handoff note for resuming in a new session.
Branch `doc`, worktree /home/shemminger/DPDK/doc.
## The idea
Today the NIC feature matrix is a **hand-maintained cache of facts that are
already knowable from the code**. That is what produced ~448 doc-vs-code
findings: the cache went stale.
Replace it. Instead of checking docs against code, **generate the doc output
from the code** using the same rules.
Split the current `devtools/check-doc-vs-code.py` into two tools with
genuinely different jobs:
1. **generator** — code -> RST table directly. No `.ini` files at all.
2. **`check-ethdev-ops`** — a linter for *driver code* self-consistency.
Nothing to do with docs.
The second tool matters because many current "findings" are **not doc bugs and
cannot be fixed by editing docs**:
ena: stats_get without stats_reset
ntnic: mac_addr_add without mac_addr_remove
pfe: allmulticast_enable without allmulticast_disable
mlx5: flow_ctrl_get only returns an error, leave it NULL
nfb: fec_set without fec_get_capability
xsc: Rx timestamp offload without read_clock
Those are driver defects. The `OP_PAIRS` and `CODE_IMPLIES` tables already in
the script are `check-ethdev-ops` in embryo — lift them out roughly as-is.
## Current pipeline
code -> (75 hand-maintained .ini) -> conf.py -> RST table
- `doc/guides/conf.py:168` `generate_overview_table()`, called **22 times**
across **8 device classes**.
- Feature dirs: nics, bbdevs, vdpadevs, regexdevs, compressdevs, gpus,
cryptodevs, eventdevs.
- **Only nics has rules.** The other 7 classes have no code-derivation rules,
so `conf.py` must keep the ini path for them. Two mechanisms will coexist
unless that is also tackled. This is an open scoping question.
## Is the nics table fully derivable? Yes (measured)
Features 78 rows: 68 via RULES + 10 platform via meson -> 0 uncovered
rte_flow items 68 rows: scan RTE_FLOW_ITEM_TYPE_* tokens
rte_flow actions 66 rows: scan RTE_FLOW_ACTION_TYPE_* tokens
`check-doc-vs-code.py -g <driver>` already generates a full ini and runs
cleanly for all 75 drivers. The machinery largely exists.
## CRITICAL: naive generation REGRESSES the docs
Generated vs committed across all 75 inis: **only 1/75 match**.
Totals: **+811 rows / -165 rows / ~160 value changes.**
Three distinct causes, each needing a fix before output is publishable:
### 1. Platform rows (~300 bogus additions)
Generator adds `LoongArch64` to 66 drivers, `rv64` to 65, `Power8` to 61,
`ARMv7` to 54 — solely because meson does not *exclude* them.
**"Not forbidden to build" != "supported".** Publishing this asserts tested
support that does not exist. Counter-example already in tree: `af_xdp.ini`
deliberately lists only `x86-64` though meson allows every arch.
Fix: treat meson as an *upper bound* only; keep explicit per-driver platform
claims. Do not assert support from absence of exclusion.
### 2. Non-derivable rows silently deleted
`Usage doc` x38, `SR-IOV` x22 (also `Design doc`, `Perf doc`).
These are the script's `UNCHECKED` set — no code equivalent exists.
Pure information loss. **They need a home.** (Open question below.)
### 3. Partial support flattened: P -> Y, 160 times
Generator cannot express partial support:
`eth` P->Y x19, `vlan` P->Y x14, `Speed capabilities` P->Y x13,
`L4 checksum offload` P->Y x11.
`RULES` already models requirement groups and `support()` already computes
partial (some-but-not-all groups matched) — **generation just discards it.**
Fix: propagate P instead of flattening. Verified real case: igb `eth = P` is
correct and the generator would clobber it to `Y`.
## Open questions for the user
1. **Where do non-derivable facts live?** (`Usage doc`, `Design doc`,
`Perf doc`, `SR-IOV`, tested-platform claims.) Options: small per-driver
override file; annotation in driver source; or drop those rows entirely.
2. **Scope across the other 7 device classes** — nics-only generation leaves
two mechanisms in `conf.py`.
## Also deferred: DRIVERS[] table is brittle (user-flagged)
Hardcoded ini-name -> source-path map in the script.
- `driver_for()` falls back to `(name, 'intel/'+name)` — only ONE vendor dir is
special-cased. A new vendor subdir, or a driver moving into one, **silently
stops being checked**: no error, just no coverage. Worst failure mode for a
linter. `ipn3ke` only works today via that fallback (`intel/ipn3ke`).
- `all_dirs()` hardcodes the same `intel` special case.
- 24/27 entries exist only to disambiguate PF/VF sharing one directory.
Idea: derive the directory from meson/driver registration and recurse vendor
subdirs generically; keep `DRIVERS[]` only for genuine PF/VF ops-regex cases.
**If the table becomes generated documentation rather than a lint heuristic,
this must be solid first.**
## Verified facts worth not re-deriving
- `Code.__init__` walks the **whole** driver dir and concatenates all `.c`/`.h`,
so multi-file drivers are handled by default. Blind spot is only the 9
`DRIVERS[]` entries that narrow the *file set* via `files=`
(e1000, igb, igb_vf, igc, enetc, enetc4, enetc4_vf, ice, ice_dcf).
The other entries use `ops=` only, which still reads every file.
- **Rule adopted:** before deleting a doc row, grep the whole driver directory
for the symbol, not just the globbed subset. If it exists outside the glob
it is a script bug (defer); if absent everywhere the row is genuinely wrong.
- e1000/igb rte_flow was NOT a script bug: `flow_ops_get` and all 7 flow items
exist only in igb (`igb_flow.c`); em has none. Rows were in the wrong file.
The *shared* header `e1000_ethdev.h` declaring `eth_igb_tx_done_cleanup` is
why e1000 wrongly claimed "Free Tx mbuf on demand" — multi-file layout was
the *cause* of the doc errors, not an obstacle to finding them.
## Commit conventions (verified against DPDK's own checkers)
Always run: `./devtools/check-git-log.sh -nN && ./devtools/checkpatches.sh -nN`
- A title containing "fix" **requires** a `Fixes:` tag or check-git-log fails.
Generate with:
`git log -1 --abbrev=12 --format='Fixes: %h ("%s")' <sha>`
- Doc feature-matrix fixes in history also carry `Cc: stable@dpdk.org`.
- Avoiding the word "fix" (e.g. "doc/af_packet: update feature matrix") is
legitimate when there is no single culprit commit to blame.
- Find the culprit for a doc row: `git log -S'<row text>' -- <ini path>`
## Work already committed on branch `doc` (9 patches, all checker-clean)
7d85396ec1 net/af_packet: support reading device clock <- real code fix
41f385c391 doc/af_packet: update feature matrix
cffcad6ad2 doc: fix e1000 and igb feature matrix
3718164550 doc/axgbe: update feature matrix
doc/mana, doc/memif, doc/pcap, doc/octeon_ep, doc/vhost
Drivers now reporting zero findings: afpacket, e1000, igb, axgbe, mana, memif,
pcap, octeon_ep, vhost.
Recommendation: **keep these.** The af_packet `read_clock` is a genuine code
fix, and the doc ones are correct under either design and shrink the eventual
generated diff.
Uncommitted: nothing. A partial batch (ena, nfb, thunderx, enetfec, pfe,
ntnic, bnx2x) was deliberately **not** applied pending this redesign.
## Constraints from the user
- Drivers with no ini today (bonding, null, ring, softnic): **do not create one.**
- Prefer updating docs over changing drivers; if both, one patch each.
- One patch per driver.
- First pass: fix what is clearly fixable, do not force ambiguous cases.
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2026-09-24 15:31 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-09-23 18:42 [RFC] devtools: rewrite doc vs code check in Python Stephen Hemminger
2026-09-23 18:44 ` Stephen Hemminger
2026-09-23 19:19 ` Thomas Monjalon
2026-09-23 20:11 ` Stephen Hemminger
2026-09-23 20:54 ` Stephen Hemminger
2026-09-24 7:33 ` Bruce Richardson
2026-09-24 8:36 ` Thomas Monjalon
2026-09-24 15:31 ` Stephen Hemminger
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox