Skip to content

Create rustdoc_internals feature gate - #90420

Merged
bors merged 4 commits into
rust-lang:masterfrom
GuillaumeGomez:rustdoc-internals-feature
Nov 25, 2021
Merged

Create rustdoc_internals feature gate#90420
bors merged 4 commits into
rust-lang:masterfrom
GuillaumeGomez:rustdoc-internals-feature

Conversation

@GuillaumeGomez

@GuillaumeGomezGuillaumeGomez commented Oct 30, 2021

Copy link
Copy Markdown
Member

As suggested by @camelidhere, since doc_keyword and doc_primitive aren't meant to be stabilized, we could put them behind a same feature flag.

This is pretty much what it would look like (needs to update the tests too).

The tracking issue is #90418.

What do you think @rust-lang/rustdoc ?

@GuillaumeGomezGuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. requires-nightly This issue requires a nightly compiler in some way. When possible, use a F-* label instead. labels Oct 30, 2021
@rust-highfive

rust-highfive commented Oct 30, 2021

Copy link
Copy Markdown
Contributor

r? @michaelwoerister

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Oct 30, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@camelid

camelid commented Oct 30, 2021

Copy link
Copy Markdown
Member

r? @camelid

camelid
camelid reviewed Oct 30, 2021
View reviewed changes
Comment threadcompiler/rustc_feature/src/active.rs Outdated
Comment threadcompiler/rustc_ast_passes/src/feature_gate.rs Outdated
@camelidcamelid 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 Oct 30, 2021
@jyn514

jyn514 commented Oct 30, 2021

Copy link
Copy Markdown
Member

This seems ... kind of unnecessary to me? We can document on the tracking issues that these aren't meant to be stabilized, I don't think it also needs to be in the source code of everything using them. And as you've noticed the logic for doc_primitive is pretty different from that of doc_keyword, so I don't think it's particularly useful to combine them.

@camelid

camelid commented Oct 30, 2021•
edited
Loading

Copy link
Copy Markdown
Member

This seems ... kind of unnecessary to me? We can document on the tracking issues that these aren't meant to be stabilized, I don't think it also needs to be in the source code of everything using them.

The standard library often uses the naming convention of X_internals to indicate that something is perma-unstable. Whereas, #![feature(doc_keyword)] doesn't give any indication that it's only meant for internal use. People don't necessarily look at tracking issues, so IMO it's best to indicate in the feature name that something is internal-only. Another example is #[rustc_layout(debug)] which is under the feature-gate rustc_attrs, not something like debug_layout.

If merging the feature gates would be too complicated, I'm okay to leave them separate, but I would prefer to merge them and make it clear in the name that they are internal-only.

I don't think it also needs to be in the source code of everything using them.

They're only used in the standard library and rustdoc IIUC, and this would reduce the number of feature gates necessary?

@jyn514

jyn514 commented Oct 30, 2021

Copy link
Copy Markdown
Member

Hmm, ok, seems reasonable.

@jyn514jyn514 mentioned this pull request Oct 30, 2021
Merged
@bors

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from e2a9da8 to 10039e2CompareNovember 8, 2021 15:28
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from 10039e2 to dc4ab79CompareNovember 8, 2021 16:28
camelid
camelid reviewed Nov 8, 2021
View reviewed changes
Comment threadsrc/test/ui/feature-gates/feature-gate-rustdoc_internals.stderr Outdated
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from dc4ab79 to 081e0cfCompareNovember 8, 2021 19:00
@GuillaumeGomez
GuillaumeGomez marked this pull request as ready for review November 8, 2021 19:00
@GuillaumeGomez

GuillaumeGomez commented Nov 8, 2021

Copy link
Copy Markdown
MemberAuthor

Updated the message and set the PR as ready to review.

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from 081e0cf to e8a9813CompareNovember 8, 2021 22:33
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from e8a9813 to bcd821eCompareNovember 9, 2021 09:42
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from bcd821e to 987b6daCompareNovember 9, 2021 10:27
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from 6041272 to ce7f8a0CompareNovember 19, 2021 22:23
@GuillaumeGomez

GuillaumeGomez commented Nov 19, 2021

Copy link
Copy Markdown
MemberAuthor

Done!

camelid
camelid approved these changes Nov 21, 2021
View reviewed changes

@camelidcamelid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Left a few comments. r=me after fixing those.

Comment threadcompiler/rustc_feature/src/active.rs Outdated
Comment on lines 164 to 165

@camelidcamelidNov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is in the wrong section; it should be next to doc_notable_trait.

@camelidcamelidNov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also, can you create an actual tracking issue? We shouldn't just link to this PR.

Comment threadcompiler/rustc_feature/src/removed.rs Outdated

@camelidcamelidNov 21, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit:

Suggested change
/// Allows using doc(primitive) without a future-incompat warning
/// Allows using `doc(primitive)` without a future-incompat warning

@camelidcamelid 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 Nov 21, 2021
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from ce7f8a0 to 5dbcc0cCompareNovember 21, 2021 21:09
@GuillaumeGomez

GuillaumeGomez commented Nov 21, 2021•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Also, can you create an actual tracking issue? We shouldn't just link to this PR.

It does link to the tracking issue. Unless I missed something?

Otherwise, I updated following your comments.

@camelid

camelid commented Nov 21, 2021

Copy link
Copy Markdown
Member

Sorry, maybe GitHub glitched and showed me the wrong page. Tracking issue looks good to me.

@camelidcamelid 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 Nov 21, 2021
camelid
camelid approved these changes Nov 24, 2021
View reviewed changes

@camelidcamelid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

r=me with these two comments fixed

Comment threadcompiler/rustc_feature/src/active.rs Outdated
Comment threadcompiler/rustc_feature/src/removed.rs Outdated
@camelidcamelid 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 Nov 24, 2021
@GuillaumeGomez
GuillaumeGomezforce-pushed the rustdoc-internals-feature branch from 5dbcc0c to 9447d1fCompareNovember 24, 2021 20:57
@GuillaumeGomez

GuillaumeGomez commented Nov 24, 2021

Copy link
Copy Markdown
MemberAuthor

@camelid Your comments made perfect sense (and I have no clue how I messed up the indent...). Updated!

@camelid

camelid commented Nov 24, 2021

Copy link
Copy Markdown
Member

Thanks!

@bors r+ rollup

@bors

bors commented Nov 24, 2021

Copy link
Copy Markdown
Collaborator

📌 Commit 9447d1f has been approved by camelid

@borsbors 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 Nov 24, 2021
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Nov 24, 2021
@GuillaumeGomez
Rollup merge ofrust-lang#90420- GuillaumeGomez:rustdoc-internals-fe…
f52f0e5
…ature, r=camelid
Create rustdoc_internals feature gate
As suggested by `@camelid` [here](rust-lang#90398 (comment)), since `doc_keyword` and `doc_primitive` aren't meant to be stabilized, we could put them behind a same feature flag.
This is pretty much what it would look like (needs to update the tests too).
The tracking issue is rust-lang#90418.
What do you think `@rust-lang/rustdoc` ?
This was referenced Nov 24, 2021
Closed
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 24, 2021
@bors
Auto merge ofrust-lang#91203- GuillaumeGomez:rollup-kwtqvb1, r=Guil…
d2c24aa
…laumeGomez
Rollup of 7 pull requests
Successful merges:
- rust-lang#89542 (Partially stabilize `duration_consts_2`)
- rust-lang#90044 (Restrict aarch64 outline atomics to glibc for now.)
- rust-lang#90420 (Create rustdoc_internals feature gate)
- rust-lang#91075 (Reduce prominence of item-infos)
- rust-lang#91151 (Fix test in std::process on android)
- rust-lang#91179 (Fix more <a> color)
- rust-lang#91199 (rustdoc: Add test for mixing doc comments and attrs)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit a6a1d7c into rust-lang:masterNov 25, 2021
@rustbotrustbot added this to the 1.58.0 milestone Nov 25, 2021
@GuillaumeGomez
GuillaumeGomez deleted the rustdoc-internals-feature branch November 25, 2021 09:04
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@camelidcamelidcamelid approved these changes
+1 more reviewer
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@camelidcamelid

Labels

requires-nightlyThis issue requires a nightly compiler in some way. When possible, use a F-* label instead.S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.58.0

Development

Successfully merging this pull request may close these issues.

8 participants

@GuillaumeGomez@rust-highfive@rust-log-analyzer@camelid@jyn514@bors@michaelwoerister@rustbot