Document `#![register_tool]` by jyn514 · Pull Request #138586 · rust-lang/rust

jyn514 · 2025-03-17T02:28:05Z

rustbot · 2025-03-17T02:28:09Z

rustbot has assigned @ehuss.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

jyn514 · 2025-03-17T02:30:13Z

+
+`register_tool` also allows configuring lint levels for external tools.
+
+Tool attributes are only meant for ignorable attributes. If your code *changes* meaning when the attribute is present, it should not use a tool attribute (because it cannot be compiled with anything other than the external tool, and in a sense is a fork of the language).


this bit really belongs in an RFC, not here. i will try to make an RFC in the new few months.

jyn514 · 2025-03-17T02:33:35Z

+#![feature(register_tool)]
+#![register_tool(c2rust)]
+
+#[c2rust::header_src = "/home/user/some/workspace/foobar/bar.h:5"]
+pub mod bar_h {


@kkysen are you ok with me mentioning c2rust in the official docs here?

You can also just use some kind of stub tool name 🤷

Sure, I think so. @thedataking, this is fine, right?

You can also just use some kind of stub tool name 🤷
i think giving an example that shows how the attribute is useful is better than just shoving in foo/bar everywhere. motivating examples, and all that.
(of course it doesn't need to be c2rust specifically; i'm happy to find some other external tool if Per doesn't want it mentioned here.)

For what it's worth, I think it'd be very cool to mention c2rust here.

Sure, I think so. @thedataking, this is fine, right?
Definitely fine. Please go ahead @jyn514.

jyn514 · 2025-03-17T02:33:48Z

+#![feature(register_tool)]
+#![register_tool(bevy)]
+#![deny(bevy::duplicate_bevy_dependencies)]


i've already asked @alice-i-cecile about this example, she said mentioning bevy is fine.

Note that this lint / tool doesn't exist yet, but I think it's a very clear example of where this might be useful.

Note that this lint / tool doesn't exist yet, but I think it's a very clear example of where this might be useful.
This specific lint comes in the 0.2.0 release, but yea it's not an official bevy tool yet.

jieyouxu

Thanks, looks good. One tiny nit but r=me with or without.

alice-i-cecile

Good stuff; the c2rust section in particular is much clearer to me now.

jieyouxu · 2025-03-17T09:28:24Z

Thanks!
@bors r+ rollup

bors · 2025-03-17T09:28:26Z

📌 Commit 10bc5ac has been approved by jieyouxu

It is now in the queue for this repository.

Rollup of 9 pull requests Successful merges: - rust-lang#136355 (Add `*_value` methods to proc_macro lib) - rust-lang#137621 (Add std support to cygwin target) - rust-lang#137793 (Stablize anonymous pipe) - rust-lang#138341 (std: Mention clone-on-write mutation in Arc<T>) - rust-lang#138517 (Improve upvar analysis for deref of child capture) - rust-lang#138584 (Update Rust Foundation links in Readme) - rust-lang#138586 (Document `#![register_tool]`) - rust-lang#138590 (Flatten and simplify some control flow 🫓) - rust-lang#138592 (update change entry for rust-lang#137147) r? `@ghost` `@rustbot` modify labels: rollup

DaAlbrecht

Thank you so much for the mention of the bevy lint tool!

DaAlbrecht · 2025-03-17T13:07:50Z

+#![feature(register_tool)]
+#![register_tool(bevy)]
+#![deny(bevy::duplicate_bevy_dependencies)]


Note that this lint / tool doesn't exist yet, but I think it's a very clear example of where this might be useful.
This specific lint comes in the 0.2.0 release, but yea it's not an official bevy tool yet.

Rollup merge of rust-lang#138586 - jyn514:doc-register-tool, r=jieyouxu Document `#![register_tool]` cc rust-lang#66079

BD103 · 2025-03-17T21:18:19Z

Thanks for doing this, this is really cool! If you want any help writing the RFC, I'd be glad to assist, although it would be my first time. :)

jhpratt · 2025-03-18T03:53:29Z

still in the queue after being merged

@bors r-

jyn514 · 2025-03-18T06:42:00Z

@jhpratt this pr has not been merged ??

jhpratt · 2025-03-18T06:45:06Z

@jyn514 It was merged as part of #138595. It is present on master and is indicated as merged by GitHub in multiple places.

I noticed it when I created #138636 and saw that a number of PRs had already been merged.

jieyouxu · 2025-03-18T06:46:52Z

Yeah, bors sometimes has its own ideas...

jyn514 · 2025-03-18T06:47:59Z

oh lmao the github app was showing me a cached version of the pr, incredible

jhpratt · 2025-03-18T06:48:26Z

🤦

rustbot assigned ehuss Mar 17, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Mar 17, 2025

jyn514 commented Mar 17, 2025
View reviewed changes

alice-i-cecile reviewed Mar 17, 2025
View reviewed changes

Comment threadsrc/doc/unstable-book/src/language-features/register-tool.md

jieyouxu approved these changes Mar 17, 2025
View reviewed changes

Comment threadsrc/doc/unstable-book/src/language-features/register-tool.md Outdated

alice-i-cecile reviewed Mar 17, 2025
View reviewed changes

Comment threadsrc/doc/unstable-book/src/language-features/register-tool.md Outdated

alice-i-cecile reviewed Mar 17, 2025
View reviewed changes

Comment threadsrc/doc/unstable-book/src/language-features/register-tool.md Outdated

jyn514 force-pushed the doc-register-tool branch 3 times, most recently from ae1fe37 to e390be7Compare March 17, 2025 02:48

alice-i-cecile approved these changes Mar 17, 2025
View reviewed changes

This comment has been minimized.
Sign in to view

Document #![register_tool]
10bc5ac

jyn514 force-pushed the doc-register-tool branch from e390be7 to 10bc5acCompare March 17, 2025 05:16

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 17, 2025

jhpratt mentioned this pull request Mar 17, 2025
Rollup of 9 pull requests #138595
Merged

DaAlbrecht approved these changes Mar 17, 2025
View reviewed changes

bors merged commit 47d0c6b into rust-lang:masterMar 17, 2025

rustbot added this to the 1.87.0 milestone Mar 17, 2025

rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Mar 17, 2025
Unrolled build forrust-lang#138586
fcd734f
Rollup merge of rust-lang#138586 - jyn514:doc-register-tool, r=jieyouxu Document `#![register_tool]` cc rust-lang#66079

jieyouxu assigned jieyouxu and unassigned ehuss Mar 17, 2025

jyn514 deleted the doc-register-tool branch March 17, 2025 21:39

jhpratt mentioned this pull request Mar 18, 2025
Rollup of 12 pull requests #138636
Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Mar 18, 2025

alice-i-cecile mentioned this pull request Mar 18, 2025
Release bevy_lint v0.2.0 TheBevyFlock/bevy_cli#308
Merged

DaAlbrecht mentioned this pull request Mar 26, 2025
Enable internal rustc lints TheBevyFlock/bevy_cli#316
Merged


		`register_tool` also allows configuring lint levels for external tools.

		Tool attributes are only meant for ignorable attributes. If your code changes meaning when the attribute is present, it should not use a tool attribute (because it cannot be compiled with anything other than the external tool, and in a sense is a fork of the language).

Uh oh!

Uh oh!

Conversation

jyn514 commented Mar 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Mar 17, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jieyouxuMar 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thedatakingMar 17, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jieyouxu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alice-i-cecile left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

jieyouxu commented Mar 17, 2025

Uh oh!

bors commented Mar 17, 2025

Uh oh!

DaAlbrecht left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BD103 commented Mar 17, 2025

Uh oh!

jhpratt commented Mar 18, 2025

Uh oh!

jyn514 commented Mar 18, 2025

Uh oh!

jhpratt commented Mar 18, 2025

Uh oh!

jieyouxu commented Mar 18, 2025

Uh oh!

jyn514 commented Mar 18, 2025

Uh oh!

jhpratt commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

jyn514 commented Mar 17, 2025•
edited
Loading

jieyouxuMar 17, 2025•
edited
Loading

thedatakingMar 17, 2025•
edited
Loading