Skip to content

fix(pre-commit): normalize SPDX handling #3081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bdice wants to merge 1 commit into
base: main
Choose a base branch
from
+1 −1
Open

fix(pre-commit): normalize SPDX handling #3081

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cpp/.clang-format
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ BreakConstructorInitializers: BeforeColon
BreakInheritanceList: BeforeColon
BreakStringLiterals: true
ColumnLimit: 100
CommentPragmas: '^ ?[*]? ?(IWYU pragma:|SPDX-)'
CommentPragmas: '(IWYU pragma:|SPDX-)'

@coderabbitai coderabbitai Bot Jul 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

tmp=$(mktemp --suffix=.cc)
trap 'rm -f "$tmp"' EXIT

cat >"$tmp" <<'EOF'
/* This ordinary comment mentions SPDX- in prose and should remain reflowable. */
void f();
EOF

clang-format --version
clang-format -style=file -assume-filename=cpp/comment-pragmas.cc "$tmp"

Repository: NVIDIA/raft

Length of output: 200

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

printf '--- cpp/.clang-format ---\n'
sed -n '1,120p' cpp/.clang-format

printf '\n--- references to CommentPragmas / clang-format ---\n'
rg -n "CommentPragmas|clang-format|-style=file" -S . --glob '!**/.git/**'

Repository: NVIDIA/raft

Length of output: 240

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

python3 - <<'PY'
import re
samples = [
    "/* This ordinary comment mentions SPDX- in prose and should remain reflowable. */",
    "// SPDX-123",
    "// This documents SPDX- headers",
    "/* IWYU pragma: keep */",
    "/* note: IWYU pragma: keep in prose */",
]

patterns = {
    "unanchored": r"(IWYU pragma:|SPDX-)",
    "anchored_original": r"^(IWYU pragma:|SPDX-)",
    "proposed": r"^ *[*]? *(IWYU pragma:|SPDX-)",
}

for name, pat in patterns.items():
    rx = re.compile(pat)
    print(f"[{name}] {pat}")
    for s in samples:
        print(f"  {bool(rx.search(s))}  {s}")
    print()
PY

Repository: NVIDIA/raft

Length of output: 966

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

printf '--- cpp/.clang-format ---\n'
cat -n cpp/.clang-format | sed -n '1,120p'

printf '\n--- references to CommentPragmas / clang-format ---\n'
rg -n "CommentPragmas|clang-format|-style=file" -S . --glob '!**/.git/**'

Repository: NVIDIA/raft

Length of output: 240

🌐 Web query:

clang-format CommentPragmas regex matched against comment text leading // stripped before matching

💡 Result:

In clang-format, the CommentPragmas regular expression is matched against the text of the comment after the leading comment markers (such as // or /*) and any associated whitespace have been stripped [1][2]. When clang-format processes comments, it uses the CommentPragmas regex to identify lines that should not be reflowed or split into multiple lines [3][4][5]. The source code implementation of the breakable token logic indicates that for line comments, the content is analyzed after the comment marker is removed [1][2]. Specifically, internal logic such as that found in BreakableComment and related classes handles the matching process by evaluating the content of the comment line against the provided regex, effectively ignoring the comment indicator itself [1][6]. It is important to note that while CommentPragmas prevents clang-format from breaking or reflowing these comments, it does not prevent the formatter from adjusting the indentation of the comment to align with the surrounding code [5]. As a result, even if a comment matches the CommentPragmas regex, it may still be moved or re-indented by clang-format if the surrounding code structure changes [5].

Citations:

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

# Read the relevant formatter setting and any in-repo pragma examples.
sed -n '50,70p' cpp/.clang-format
printf '\n--- pragma examples ---\n'
rg -n "IWYU pragma:|SPDX-" cpp -S

Repository: NVIDIA/raft

Length of output: 50368

Keep CommentPragmas anchored to the start of the comment text. Clang-format strips the comment marker before applying this regex, so removing ^ makes incidental prose containing SPDX- or IWYU pragma: act like a pragma and skip reflow.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cpp/.clang-format` at line 59, Update the CommentPragmas regex in the
clang-format configuration to anchor both recognized pragmas at the start of the
comment text, preserving the existing IWYU pragma and SPDX matches while
preventing incidental prose from being treated as a pragma.

CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
# Kept the below 2 to be the same as `IndentWidth` to keep everything uniform
Expand Down
Loading