Re: [PATCH v4] doc: add AGENTS.md for AI-powered code review tools

Bruce Richardson
2026-01-20T17:35:57Z

On Fri, Jan 16, 2026 at 09:46:41AM -0800, Stephen Hemminger 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 <stephen@networkplumber.org>
> ---
>
> v4 - revise based on use in reviewing patchs
> get rid of false positives from variable declarations
> add checks for rte_malloc and rte_memcpy
>
>
> devtools/AGENTS.md | 939 +++++++++++++++++++++++++++++++++++++++++++++
> 1 file changed, 939 insertions(+)
> create mode 100644 devtools/AGENTS.md
>
I see you are putting this in the devtools directory. To have it picked up
automatically, should this not be put in the root directory?