rust-lang / rust-lang/rust-clippy

Lint to detect unneeded `// CAST: ...` comments

Open
#15,964 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-lint G-Rust-for-Linux
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

What it does

The dual lint to the one(s) that require those comments: https://github.com/rust-lang/rust-clippy/issues/15963.

In other words, like unnecessary_safety_comment, but for // CAST: ... comments.

Note on pointer casts: currently in the kernel we sometimes use // CAST: ... for pointer casts via .cast() too, since those are dangerous too (even if already more restricted than as). We may want to extend this lint (or ideally have a separate one) to cover those too. This is particularly important for the dual lint.

Cc: @blyxyas @hcbarker

Advantage

No response

Drawbacks

No response

Example
// CAST: ...
f();

Should be written as:

f();
Comparison with existing lints

No response

Additional Context

For details and context, please see the dual lint linked above.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the linked dual issue, rust-clippy#15963, and the existing unnecessary_safety_comment lint referenced here. Determine how the new lint should identify redundant // CAST: ... comments, and clarify whether pointer casts through .cast() are included; done means the agreed cases are detected with corresponding lint tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.