Refactor `rustc_attr_data_structures` documentation #142082

xizheyin · 2025-06-05T14:10:07Z

I was reading through AttributeKind and realized that attributes like InlineAttr didn't appear in it, however, I found them in rustc_codegen_ssa and understood why (guessing).

There's almost no overall documentation for this crate, I've added the organized documentation at the top of lib.rs, and I've grouped the Attributes into two categories: AttributeKind that run all through the compiler, and the ones that are only used in codegen_ssa, such as InlineAttr, OptimizeAttr, InstructionSetAttr.

Also, I've added documentation for AttributeKind that further explains why attributes like InlineAttr don't appear in it, with examples for each variant.

r? @jdonszelmann

rustbot · 2025-06-05T14:10:14Z

Some changes occurred in compiler/rustc_attr_data_structures

cc @jdonszelmann

compiler/rustc_attr_data_structures/src/attributes.rs

jdonszelmann

As per my previous comments, won't approve this PR for the time being despite it having some good changes.

compiler/rustc_attr_data_structures/src/attributes.rs

compiler/rustc_attr_data_structures/src/lib.rs

xizheyin

I also remove the comments in variants of AttributeKind.
@rustbot ready

compiler/rustc_attr_data_structures/src/attributes.rs

jdonszelmann · 2025-06-12T10:53:16Z

@rustbot author

rustbot · 2025-06-12T10:53:20Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

xizheyin · 2025-06-12T11:32:03Z

@rustbot ready

jdonszelmann · 2025-06-12T12:38:25Z

likely to conflict (minorly) with #138164, let's wait for that to merge (or preemptively rebase ontop of it). It's in the queue, judging by the state of which it'll take an hour or 8 for that to get through. Will look again tonight (european time)

xizheyin · 2025-06-13T05:21:54Z

Seems to not conflict with #138164, let me rebase it.

compiler/rustc_attr_data_structures/src/lib.rs

Signed-off-by: xizheyin <[email protected]>

xizheyin

@rustbot ready

xizheyin · 2025-06-15T12:05:44Z

compiler/rustc_attr_data_structures/src/lib.rs

+//! Data structures for representing parsed attributes in the Rust compiler.
+//! For detailed documentation about attribute processing,
+//! see [rustc_attr_parsing](https://doc.rust-lang.org/nightly/nightly-rustc/rustc_attr_parsing/index.html).
+


I remove all of other docs.

jdonszelmann · 2025-06-15T12:07:28Z

@bors r+ rollup

bors · 2025-06-15T12:07:31Z

📌 Commit 1ac89f1 has been approved by jdonszelmann

It is now in the queue for this repository.

jdonszelmann · 2025-06-15T12:07:56Z

@bors r- oh let's wait for CI, a bit too enthusiastic

xizheyin · 2025-06-15T13:49:23Z

haha, all the checks passed.

jdonszelmann · 2025-06-15T14:46:26Z

@bors r+

bors · 2025-06-15T14:46:28Z

📌 Commit 1ac89f1 has been approved by jdonszelmann

It is now in the queue for this repository.

…s, r=jdonszelmann Refactor `rustc_attr_data_structures` documentation I was reading through `AttributeKind` and realized that attributes like `InlineAttr` didn't appear in it, however, I found them in `rustc_codegen_ssa` and understood why (guessing). There's almost no overall documentation for this crate, I've added the organized documentation at the top of `lib.rs`, and I've grouped the Attributes into two categories: `AttributeKind` that run all through the compiler, and the ones that are only used in `codegen_ssa`, such as `InlineAttr`, `OptimizeAttr`, `InstructionSetAttr`. Also, I've added documentation for `AttributeKind` that further explains why attributes like `InlineAttr` don't appear in it, with examples for each variant. r? `@jdonszelmann`

Rollup of 7 pull requests Successful merges: - #138237 (Get rid of `EscapeDebugInner`.) - #140809 (Reduce special casing for the panic runtime) - #141990 (Implement send_signal for unix child processes) - #142082 (Refactor `rustc_attr_data_structures` documentation) - #142125 (Stabilize "file_lock" feature) - #142528 (clarify `rustc_do_not_const_check` comment) - #142530 (use `if let` guards where possible) r? `@ghost` `@rustbot` modify labels: rollup

…s, r=jdonszelmann Refactor `rustc_attr_data_structures` documentation I was reading through `AttributeKind` and realized that attributes like `InlineAttr` didn't appear in it, however, I found them in `rustc_codegen_ssa` and understood why (guessing). There's almost no overall documentation for this crate, I've added the organized documentation at the top of `lib.rs`, and I've grouped the Attributes into two categories: `AttributeKind` that run all through the compiler, and the ones that are only used in `codegen_ssa`, such as `InlineAttr`, `OptimizeAttr`, `InstructionSetAttr`. Also, I've added documentation for `AttributeKind` that further explains why attributes like `InlineAttr` don't appear in it, with examples for each variant. r? ``@jdonszelmann``

Rollup of 8 pull requests Successful merges: - #140809 (Reduce special casing for the panic runtime) - #142082 (Refactor `rustc_attr_data_structures` documentation) - #142125 (Stabilize "file_lock" feature) - #142373 (Fix Debug for Location) - #142414 (ignore `run-make` tests that need `std` on targets without `std`) - #142416 (Assorted bootstrap cleanups (step 2)) - #142431 (Add initial version of snapshot tests to bootstrap) - #142528 (clarify `rustc_do_not_const_check` comment) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 12 pull requests Successful merges: - #141639 (Expose discriminant values in stable_mir) - #142082 (Refactor `rustc_attr_data_structures` documentation) - #142125 (Stabilize "file_lock" feature) - #142236 (Add documentation for `PathBuf`'s `FromIterator` and `Extend` impls) - #142373 (Fix Debug for Location) - #142416 (Assorted bootstrap cleanups (step 2)) - #142431 (Add initial version of snapshot tests to bootstrap) - #142450 (Add documentation on top of `rustc_middle/src/query/mod.rs`) - #142528 (clarify `rustc_do_not_const_check` comment) - #142530 (use `if let` guards where possible) - #142561 (Remove an `njn:` comment accidentaly left behind.) - #142566 (Fix `-nopt` CI jobs) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of #142082 - xizheyin:rustc_attr_data_structures, r=jdonszelmann Refactor `rustc_attr_data_structures` documentation I was reading through `AttributeKind` and realized that attributes like `InlineAttr` didn't appear in it, however, I found them in `rustc_codegen_ssa` and understood why (guessing). There's almost no overall documentation for this crate, I've added the organized documentation at the top of `lib.rs`, and I've grouped the Attributes into two categories: `AttributeKind` that run all through the compiler, and the ones that are only used in `codegen_ssa`, such as `InlineAttr`, `OptimizeAttr`, `InstructionSetAttr`. Also, I've added documentation for `AttributeKind` that further explains why attributes like `InlineAttr` don't appear in it, with examples for each variant. r? ```@jdonszelmann```

Rollup of 12 pull requests Successful merges: - rust-lang#141639 (Expose discriminant values in stable_mir) - rust-lang#142082 (Refactor `rustc_attr_data_structures` documentation) - rust-lang#142125 (Stabilize "file_lock" feature) - rust-lang#142236 (Add documentation for `PathBuf`'s `FromIterator` and `Extend` impls) - rust-lang#142373 (Fix Debug for Location) - rust-lang#142416 (Assorted bootstrap cleanups (step 2)) - rust-lang#142431 (Add initial version of snapshot tests to bootstrap) - rust-lang#142450 (Add documentation on top of `rustc_middle/src/query/mod.rs`) - rust-lang#142528 (clarify `rustc_do_not_const_check` comment) - rust-lang#142530 (use `if let` guards where possible) - rust-lang#142561 (Remove an `njn:` comment accidentaly left behind.) - rust-lang#142566 (Fix `-nopt` CI jobs) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 12 pull requests Successful merges: - rust-lang/rust#141639 (Expose discriminant values in stable_mir) - rust-lang/rust#142082 (Refactor `rustc_attr_data_structures` documentation) - rust-lang/rust#142125 (Stabilize "file_lock" feature) - rust-lang/rust#142236 (Add documentation for `PathBuf`'s `FromIterator` and `Extend` impls) - rust-lang/rust#142373 (Fix Debug for Location) - rust-lang/rust#142416 (Assorted bootstrap cleanups (step 2)) - rust-lang/rust#142431 (Add initial version of snapshot tests to bootstrap) - rust-lang/rust#142450 (Add documentation on top of `rustc_middle/src/query/mod.rs`) - rust-lang/rust#142528 (clarify `rustc_do_not_const_check` comment) - rust-lang/rust#142530 (use `if let` guards where possible) - rust-lang/rust#142561 (Remove an `njn:` comment accidentaly left behind.) - rust-lang/rust#142566 (Fix `-nopt` CI jobs) r? `@ghost` `@rustbot` modify labels: rollup

rustbot assigned jdonszelmann Jun 5, 2025

rustbot added A-attributes Area: Attributes (`#[…]`, `#![…]`) 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 Jun 5, 2025

xizheyin force-pushed the rustc_attr_data_structures branch from ff9276d to 1cf957f Compare June 5, 2025 14:16

xizheyin commented Jun 5, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/attributes.rs Show resolved Hide resolved

jdonszelmann requested changes Jun 6, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/attributes.rs Outdated Show resolved Hide resolved

compiler/rustc_attr_data_structures/src/attributes.rs Outdated Show resolved Hide resolved

compiler/rustc_attr_data_structures/src/lib.rs Outdated Show resolved Hide resolved

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jun 6, 2025

xizheyin force-pushed the rustc_attr_data_structures branch from 1cf957f to b867d3e Compare June 6, 2025 14:10

xizheyin commented Jun 6, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/attributes.rs Show resolved Hide resolved

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 6, 2025

jdonszelmann reviewed Jun 12, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/attributes.rs Outdated Show resolved Hide resolved

jdonszelmann reviewed Jun 12, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/attributes.rs Outdated Show resolved Hide resolved

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jun 12, 2025

xizheyin force-pushed the rustc_attr_data_structures branch from b867d3e to c269af8 Compare June 12, 2025 11:30

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 12, 2025

xizheyin force-pushed the rustc_attr_data_structures branch from c269af8 to 4ef6670 Compare June 13, 2025 05:24

jdonszelmann reviewed Jun 13, 2025

View reviewed changes

compiler/rustc_attr_data_structures/src/lib.rs Show resolved Hide resolved

rustbot 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-review Status: Awaiting review from the assignee but also interested parties. labels Jun 13, 2025

Refactor rustc_attr_data_structures documentation

1ac89f1

Signed-off-by: xizheyin <[email protected]>

xizheyin force-pushed the rustc_attr_data_structures branch from 88e5e54 to 1ac89f1 Compare June 15, 2025 12:04

xizheyin commented Jun 15, 2025

View reviewed changes

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 15, 2025

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 Jun 15, 2025

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 Jun 15, 2025

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 15, 2025

tgross35 mentioned this pull request Jun 16, 2025

Rollup of 7 pull requests #142558

Closed

tgross35 mentioned this pull request Jun 16, 2025

Rollup of 8 pull requests #142564

Closed

Kobzol mentioned this pull request Jun 16, 2025

Rollup of 12 pull requests #142574

Merged

bors merged commit 3795658 into rust-lang:master Jun 16, 2025
10 checks passed

rustbot added this to the 1.89.0 milestone Jun 16, 2025

Refactor rustc_attr_data_structures documentation #142082

Refactor rustc_attr_data_structures documentation #142082

Conversation

xizheyin commented Jun 5, 2025

Uh oh!

rustbot commented Jun 5, 2025

Uh oh!

Uh oh!

jdonszelmann left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xizheyin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jdonszelmann commented Jun 12, 2025

Uh oh!

rustbot commented Jun 12, 2025

Uh oh!

xizheyin commented Jun 12, 2025

Uh oh!

jdonszelmann commented Jun 12, 2025

Uh oh!

xizheyin commented Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

xizheyin left a comment

Choose a reason for hiding this comment

Uh oh!

xizheyin Jun 15, 2025

Choose a reason for hiding this comment

Uh oh!

jdonszelmann commented Jun 15, 2025

Uh oh!

bors commented Jun 15, 2025

Uh oh!

jdonszelmann commented Jun 15, 2025

Uh oh!

xizheyin commented Jun 15, 2025

Uh oh!

jdonszelmann commented Jun 15, 2025

Uh oh!

bors commented Jun 15, 2025

Uh oh!

Uh oh!

Uh oh!

Refactor `rustc_attr_data_structures` documentation #142082

Refactor `rustc_attr_data_structures` documentation #142082

xizheyin commented Jun 13, 2025 •

edited

Loading