bugprone-argument-comment

[Jacobfaib]

Description

closes

Checklist

• New or existing tests cover these changes.
• The documentation is up to date with these changes.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: b72a913d-93c5-43fd-a9de-075fc2a15c7b

📥 Commits

Reviewing files that changed from the base of the PR and between 087f1bf and 0a5451c.

📒 Files selected for processing (1)

• .clang-tidy

---

Note: CodeRabbit is enabled on this repository as a convenience for maintainers
and contributors. Use your best judgment when considering its review comments and
suggestions — a suggested change may be inadequate, unnecessary, or safe to ignore.
Contributors are not expected to address every comment. Human reviews are what
ultimately matter for merging.

Summary

This PR adds a comprehensive .clang-tidy configuration file to the repository root, establishing clang-tidy linting rules for the NVIDIA CCCL project.

Changes

The PR introduces a new .clang-tidy configuration file (324 lines) that:

• Enables core check families: Enables broad categories of checks including performance-*, modernize-*, readability-*, bugprone-*, and various other clang-tidy check families
• Disables specific problematic checks: Selectively disables numerous checks that are either too noisy, incompatible with GPU code, redundant with other checks, or project-specific incompatibilities (e.g., -cppcoreguidelines-pro-type-reinterpret-cast, -readability-convert-member-functions-to-static, -google-upgrade-googletest-case)
• Configures check-specific options: Includes detailed configuration for individual checks with parameters such as:
  • bugprone-argument-comment options (marked as "needs discussion" but with full configuration already in place)
  • Magic number allowances for digits 0-9
  • Reserved identifier patterns for _CCCL prefixed identifiers
  • Type ignore patterns for performance checks

Key Notes

• The bugprone-argument-comment check is currently disabled with the comment "We probably want this eventually, but needs discussion"
• Despite being disabled, comprehensive configuration options are pre-configured for this check, indicating preparation for future enablement
• The configuration carefully balances enabling useful checks while filtering out false positives and check behaviors incompatible with GPU/CUDA code patterns

Minimal Impact

• No changes to exported or public APIs
• Configuration-only file addition

Walkthrough

A single TODO comment line is inserted at line 51 of .clang-tidy within the "REMOVE ME" section, noting that a pending change "probably" needs to happen eventually but requires further discussion first. No linting rules or configuration values are modified.

Changes

clang-tidy TODO annotation

Layer / File(s)	Summary
TODO comment in REMOVE ME block .clang-tidy	Adds one comment line at line 51 noting the item needs discussion before any action is taken; no rules or config values are changed.

Possibly related PRs

• NVIDIA/cccl#9467: Modifies the same .clang-tidy "TODO: BEGIN REMOVE ME" section by adjusting bugprone-* check states and related CheckOptions, directly adjacent to where this comment is inserted.

Suggested reviewers

• jrhemstad
• miscco

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

🥳 CI Workflow Results

🟩 Finished in 56m 08s: Pass: 100%/1 | Total: 56m 08s | Max: 56m 08s | Hits: 0%/0

See results here.