Skip to content

rustdoc-json: Add test for #[optimize(..)] #142916

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 24, 2025
Merged

rustdoc-json: Add test for #[optimize(..)] #142916

merged 1 commit into from
Jun 24, 2025
+13 −0

Conversation

aDotInTheVoid
Copy link
Member

@rustbot rustbot added A-rustdoc-json Area: Rustdoc JSON backend S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jun 23, 2025
@rustbot
Copy link
Collaborator

rustbot commented Jun 23, 2025

These commits modify tests/rustdoc-json.
rustdoc-json is a public (but unstable) interface.

Please ensure that if you've changed the output:

  • It's intentional.
  • The FORMAT_VERSION in src/librustdoc-json-types is bumped if necessary.

cc @aDotInTheVoid, @obi1kenobi

@aDotInTheVoid aDotInTheVoid added the F-optimize_attribute `#![feature(optimize_attribute)]` label Jun 23, 2025
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-cloud-vms rust-cloud-vms bot force-pushed the you-can-trip-on-my-optimizer branch from b813851 to bec2679 Compare June 23, 2025 17:23
@jdonszelmann
Copy link
Contributor

What makes the test for this attr specifically useful? Since a bunch of them are changing which don't necessarily have tests either?

@jdonszelmann
Copy link
Contributor

Don't get me wrong, not against more tests, was just wondering about specifically this one

@aDotInTheVoid
Copy link
Member Author

I wrote it while working on rust-lang/rustdoc-types@33243c4, and wanted to see what exactly the difference was. It will also be useful for when #141358 happens.

GuillaumeGomez
GuillaumeGomez reviewed Jun 24, 2025
View reviewed changes
tests/rustdoc-json/attrs/optimize.rs
@@ -0,0 +1,13 @@
#![feature(optimize_attribute)]

//@ is "$.index[?(@.name=='speed')].attrs" '["#[attr = Optimize(Speed)]"]'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the display of the inner value supposed to be like that? Shouldn't it be speed?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the debug printing of attributes, which mirrors their semantic strucure in HIR, not their semantic structure.

See https://doc.rust-lang.org/nightly/nightly-rustc/rustc_attr_data_structures/enum.OptimizeAttr.html and https://doc.rust-lang.org/nightly/nightly-rustc/rustc_attr_data_structures/enum.AttributeKind.html#variant.Optimize

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See also

rust/tests/rustdoc-json/attrs/inline.rs

Lines 1 to 3 in e4b9d01

//@ is "$.index[?(@.name=='just_inline')].attrs" '["#[attr = Inline(Hint)]"]'
#[inline]
pub fn just_inline() {}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. How attributes are displayed is incoherent though, which isn't great. For example:

attrs/repr_align.rs:3://@ is "$.index[?(@.name=='Aligned')].attrs" '["#[repr(align(4))]"]'
attrs/export_name_2024.rs:7://@ is "$.index[?(@.name=='example')].attrs" '["#[export_name = \"altered\"]"]'
attrs/repr_c.rs:13://@ is "$.index[?(@.name=='ReprCUnion')].attrs" '["#[repr(C)]"]'
attrs/repr_packed.rs:6://@ is "$.index[?(@.name=='Packed')].attrs" '["#[repr(packed(1))]"]'
keyword_private.rs:8://@ is   "$.index[?(@.name=='foo')].attrs" '["#[doc(keyword = \"match\")]"]'

Some of them are "code-like" and other represent the internal type representation in rustc, which is subject to change. Do we plan to uniform it at some point?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. The code-like ones are either unstructured attributes, or have special handling in rustdoc.

#142936 moves to rustdoc-json not representing attributes as strings, but with a enum.

As part of #131229, all attributes are moving to being structured, but this is a gradual process.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went through #142936. Feel very relieved. Attributes are declared in rustdoc-json-types so they can't change unexpectedly. Very good idea!

GuillaumeGomez
GuillaumeGomez reviewed Jun 24, 2025
View reviewed changes
tests/rustdoc-json/attrs/optimize.rs
#[optimize(size)]
pub fn size() {}

//@ is "$.index[?(@.name=='none')].attrs" '["#[attr = Optimize(DoNotOptimize)]"]'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Especially in this case.

@aDotInTheVoid aDotInTheVoid mentioned this pull request Jun 24, 2025
Merged
@GuillaumeGomez
Copy link
Member

Thanks!

@bors r+ rollup

@bors
Copy link
Collaborator

bors commented Jun 24, 2025

📌 Commit bec2679 has been approved by GuillaumeGomez

It is now in the queue for this repository.

@bors 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 24, 2025
@GuillaumeGomez GuillaumeGomez mentioned this pull request Jun 24, 2025
Merged
bors added a commit that referenced this pull request Jun 24, 2025
@bors
Auto merge of #142962 - GuillaumeGomez:rollup-do1coji, r=GuillaumeGomez
3129d37 
Rollup of 7 pull requests

Successful merges:

 - #137268 (Allow comparisons between `CStr`, `CString`, and `Cow<CStr>`.)
 - #142704 (Remove the deprecated unstable `concat_idents!` macro)
 - #142742 ([win][aarch64] Fix linking statics on Arm64EC, take 2)
 - #142843 (Enable reproducible-build-2 for Windows MSVC)
 - #142916 (rustdoc-json: Add test for `#[optimize(..)]`)
 - #142919 (rustdoc-json: Add test for `#[cold]`)
 - #142944 (Stats output tweaks)

Failed merges:

 - #142825 (Port `#[track_caller]` to the new attribute system)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 4cdf492 into rust-lang:master Jun 24, 2025
10 checks passed
@rustbot rustbot added this to the 1.90.0 milestone Jun 24, 2025
rust-timer added a commit that referenced this pull request Jun 24, 2025
@rust-timer
Unrolled build for #142916
03725e4 
Rollup merge of #142916 - aDotInTheVoid:you-can-trip-on-my-optimizer, r=GuillaumeGomez

rustdoc-json: Add test for `#[optimize(..)]`

Follow up to #138291

CC `@jdonszelmann`

r? `@GuillaumeGomez`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GuillaumeGomez GuillaumeGomez GuillaumeGomez approved these changes

Assignees

@GuillaumeGomez GuillaumeGomez

Labels
A-rustdoc-json Area: Rustdoc JSON backend F-optimize_attribute `#![feature(optimize_attribute)]` S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.90.0
Development

Successfully merging this pull request may close these issues.
6 participants
@aDotInTheVoid @rustbot @rust-log-analyzer @jdonszelmann @GuillaumeGomez @bors