On Mon, 26 Jan 2026 10:40:18 -0800 Stephen Hemminger <[email protected]> wrote:
> Add a structured reference document that enables AI code review tools > to validate DPDK contributions against project standards. This document > consolidates requirements from multiple sources into a machine-readable > format optimized for automated validation workflows. > > The AGENTS.md file synthesizes guidelines from: > - DPDK Contributing Code documentation (patches.rst) > - DPDK Coding Style guidelines (coding_style.rst) > - DPDK validation scripts (check-git-log.sh, checkpatches.sh) > - Linux kernel patch submission process > - SPDX License Identifier specification > - DPDK Coccinelle scripts (cocci) > - common items spotted on mailing list review > > Key sections include: > - SPDX license and copyright header requirements > - Commit message format with precise limits (60 char subject, > 75 char body) and tag ordering rules > - C coding style including explicit comparison requirements > - Forbidden tokens table derived from checkpatches.sh > - API tag placement rules for experimental and internal APIs > - Patch validation checklists with severity levels > > The forbidden tokens section documents restrictions on deprecated > atomics, logging functions, threading APIs, and compiler built-ins > that are checked by the existing checkpatches.sh infrastructure. > > Severity levels (error/warning/info) align with the exit codes and > messaging from check-git-log.sh and checkpatches.sh to help automated > tools prioritize feedback appropriately. > > References: > - https://doc.dpdk.org/guides/contributing/patches.html > - https://doc.dpdk.org/guides/contributing/coding_style.html > - devtools/check-git-log.sh > - devtools/checkpatches.sh > - devtools/cocci/ > > Signed-off-by: Stephen Hemminger <[email protected]> > --- Rather than one potentially huge file, I am thinking that breaking it into bits and putting it a directory similar to https://github.com/masoncl/review-prompts/blob/main/README.md Maybe review-tools/ directory at top level.
