Preparation for linting every markdown file in the tree: surround the
sign-off example in AGENTS.md with the blank lines the linter wants,
and flatten the RELEASING.md table of contents - its single top-level
entry only repeated the document title, and the nested indentation
tripped the linter's list-indent rule under kramdown.
While at it, replace the literal Signed-off-by example with the
'git commit -s' command that produces it. checkpatch validates
anything shaped like a signature tag on any patch line - added,
removed and context lines alike - so any patch touching these lines
trips 'Unrecognized email address' on the $(git config ...)
placeholders. Documenting the command instead keeps trailer-shaped
text out of the file entirely, with no checkpatch exceptions needed.
Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Automation agents contributing to QDL need a single, machine-oriented
reference for how to build, test, and format their changes. Scattering
this information across the README and CONTRIBUTING.md makes it easy for
agents to miss the project conventions.
Add AGENTS.md consolidating the build prerequisites, the pre-commit
build and check targets, the Linux kernel coding style requirement, the
subsystem-tagged commit convention with a mandatory rationale body, the
ASCII-only rule for code, docs, and commit messages, and the mandatory
S-o-b trailer. It points back to CONTRIBUTING.md so the two stay
in sync.
Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Igor Opaniuk