Skip to content

document that the rustc tool namespace is reserved #1821

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.

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

Closed
wants to merge 1 commit into from

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented May 9, 2025

this section in the reference is not quite right; or at least is an incomplete summary. here is a more detailed explanation of what's currently implemented:

Tool Lints Attributes
clippy
rustfmt
miri
rust_analyzer
rustdoc
rustc ✅ (with -Z unstable-options)
diagnostic

i'm not sure how to write that up, and it doesn't belong in the attributes section anyway, so i've just added this short snippet.

thanks to @BD103 for putting together the pretty markdown table.
cc rust-lang/rfcs#3808

this section in the reference is not quite right; or at least is an
incomplete summary. here is a more detailed explanation of what's
currently implemented:

|Tool|Lints|Attributes|
|-|-|-|
|`clippy`|✅|✅|
|`rustfmt`|❌|✅|
|`miri`|❌|✅|
|`rust_analyzer`|❌|✅|
|`rustdoc`|✅|❌|
|`rustc`|✅ (with `-Z unstable-options`)|❌|
|`diagnostic`|❌|✅|

i'm not sure how to write that up, and it doesn't belong in the
attributes section anyway, so i've just added this short snippet.
@rustbot rustbot added the S-waiting-on-review Status: The marked PR is awaiting review from a maintainer label May 9, 2025
@jyn514
Copy link
Member Author

jyn514 commented May 9, 2025

i think it would be good to make the lints and attributes consistent; i think it would be confusing to reserve one but not the other. but that's a policy decision, not a documentation issue.

@traviscross
Copy link
Contributor

traviscross commented May 20, 2025

Thanks for the PR. Maybe we misunderstand the intent here -- and if so, please feel free to clarify -- but we don't generally document unstable features in the Reference, and there's no way on stable Rust to use tools other than those that we've allowed, so it doesn't really mean anything to reserve a namespace in that context. So we'll close this out.

@jyn514
Copy link
Member Author

jyn514 commented May 21, 2025

hmm, ok. i will make this part of the pr that documents #![register_tool], once that's stabilized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: The marked PR is awaiting review from a maintainer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants