Lint all markdown files and extend the release documentation - #292
Merged
igoropaniuk merged 4 commits intoJul 21, 2026
Conversation
igoropaniuk
force-pushed
the
chore/markdownlint-all
branch
from
July 20, 2026 07:18
2dff98f to
ac8d282
Compare
quic-kdybcio
left a comment
quic-kdybcio
left a comment
There was a problem hiding this comment.
The release process updates look good
| # Signed-off-by example (AGENTS.md), whose $(git config ...) | ||
| # placeholders are flagged as unrecognized addresses. Missing | ||
| # sign-offs are still enforced through MISSING_SIGN_OFF. | ||
| --ignore BAD_SIGN_OFF |
There was a problem hiding this comment.
Can we scope this to the offending file only?
There was a problem hiding this comment.
Or is this still an issue now that you moved it into a comment?
Contributor
Author
There was a problem hiding this comment.
I've just dropped that line from AGENTS.md
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>
The markdown lint wrapper names README.md and docs/ explicitly, so documents like AGENTS.md, CONTRIBUTING.md and RELEASING.md have never been linted and accumulated findings silently. Derive the file list from git ls-files instead, excluding CHANGELOG.md - generated by the release process, where long release-note URLs and per-release repeated section headers are part of the format - and CLAUDE.md, a symlink to the already-linted AGENTS.md. New documents are picked up automatically. Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
Describe the kernel-style stable branches (qdl-X.Y.y) agreed for shipping urgent fixes independently of master: cut the branch from the release tag immediately after tagging, backport fixes that landed on master with cherry-pick -x through stable-targeted pull requests (CI runs on those unchanged), and cut point releases (vX.Y.Z) from the branch with the same flow as a normal release. Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
The WSL2 section carries a typographic apostrophe and em dashes; project documentation is plain ASCII (see AGENTS.md). Replace them with their ASCII equivalents. Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
igoropaniuk
force-pushed
the
chore/markdownlint-all
branch
from
July 21, 2026 12:18
ac8d282 to
89bfed3
Compare
quic-kdybcio
approved these changes
Jul 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation housekeeping in four small steps:
scripts: lint every tracked markdown file- the markdown-lint wrapper named README.md and docs/ explicitly, so AGENTS.md, CONTRIBUTING.md and RELEASING.md were never linted. The file list now comes from git ls-files '*.md', picking up new documents automatically. Two documented exclusions: CHANGELOG.md (generated by the release flow; long release-note URLs and per-release repeated headers are part of the format) and CLAUDE.md (a symlink to the already-linted AGENTS.md).doc: fix markdown lint findings in AGENTS.md and RELEASING.md- the findings the wider net caught: a missing blank line around a code fence, and the RELEASING table of contents flattened (its single top-level entry only repeated the document title).doc: document stable branch maintenance in RELEASING.md- the kernel-style qdl-X.Y.y stable branches: cut the branch from the release tag right after tagging, backport master-first fixes with cherry-pick -x via stable-targeted PRs (CI runs on those unchanged), and cut point releases (vX.Y.Z) from the branch using the normal release flow.README: replace non-ASCII punctuation- a typographic apostrophe and em dashes that slipped into the WSL2 section; project documentation is plain ASCII per AGENTS.md.