Remove `doc(include)` #85457

jyn514 · 2021-05-19T01:55:20Z

This nightly feature is redundant now that extended_key_value_attributes is stable (#83366). @rust-lang/rustdoc not sure if you think this needs FCP; there was already an FCP in #82539, but technically it was for deprecating, not removing the feature altogether.

This should not be merged before #83366.

cc @petrochenkov

rust-highfive · 2021-05-19T01:55:23Z

Some changes occurred in src/tools/clippy.

cc @rust-lang/clippy

rust-highfive · 2021-05-19T01:55:24Z

r? @estebank

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

jyn514 · 2021-05-19T01:56:59Z

src/tools/clippy/clippy_lints/src/missing_doc.rs

        let has_doc = attrs.iter().any(|a| {
-            a.is_doc_comment() || a.doc_str().is_some() || a.value_str().is_some() || Self::has_include(a.meta())
+            a.is_doc_comment() || a.doc_str().is_some() || a.value_str().is_some()
        });


FYI @rust-lang/clippy you should probably be using rustc_lint::builtin::has_doc instead; this has a false positive and also counts things like #[path = "x"] as doc-comments (because you only check value_str().is_some(), not the name of the attribute). Also in general it seems nice to have all the logic in one place.

Looks like a nice cleanup opportunity on the Clippy side! has_doc would just have to be made public

Sure thing, you could do both at the same time in a PR to rust-lang/rust :)

I opened an issue: rust-lang/rust-clippy#7247

GuillaumeGomez · 2021-05-19T09:09:06Z

This nightly feature is redundant now that extended_key_value_attributes is stable (#83366). @rust-lang/rustdoc not sure if you think this needs FCP; there was already an FCP in #82539, but technically it was for deprecating, not removing the feature altogether.

This is a nightly feature, so I'd say that the FCP is unneeded here.

jyn514 · 2021-05-19T17:32:10Z

@GuillaumeGomez do you mind reviewing the rustdoc changes? They should be pretty simple since it's just deleted code.

Oh, I need to add a diagnostic test for suggesting doc = include_str!, let me write that up first.

GuillaumeGomez · 2021-05-19T17:45:05Z

Oh, I need to add a diagnostic test for suggesting doc = include_str!, let me write that up first.

Not sure this is needed though. But as you prefer. Ping me once you want me to review.

compiler/rustc_passes/src/check_attr.rs

src/test/rustdoc/external-doc.rs

src/test/ui/rustdoc/doc-include-suggestion.fixed

jyn514 · 2021-06-04T12:40:47Z

@GuillaumeGomez this is ready for a second round of review

GuillaumeGomez · 2021-06-04T13:54:10Z

Thanks for this! This was a long awaited removal. :)

@bors: r+

bors · 2021-06-04T13:54:11Z

📌 Commit 15fec1f has been approved by GuillaumeGomez

bors · 2021-06-05T03:36:32Z

⌛ Testing commit 15fec1f with merge 2c10688...

bors · 2021-06-05T06:17:11Z

☀️ Test successful - checks-actions
Approved by: GuillaumeGomez
Pushing 2c10688 to master...

doc(include) was removed in rust-lang/rust#85457. Tests should now run on on both nightly and stable.

doc(include) was removed in rust-lang/rust#85457. Tests should now run on on both nightly and stable. (cherry picked from commit d96bfa2)

doc(include) was removed in rust-lang/rust#85457. Tests should now run on on both nightly and stable.

Move resolve_path to rustc_builtin_macros and make it private Fixing a FIXME introduced by `@jyn514` in rust-lang#85457

jyn514 added the T-rustdoc label May 19, 2021

rust-highfive assigned estebank May 19, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 19, 2021

jyn514 commented May 19, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

jyn514 force-pushed the remove-doc-include branch from cafde1d to 2ffb63e Compare May 19, 2021 02:08

This comment has been minimized.

Sign in to view

jyn514 force-pushed the remove-doc-include branch 2 times, most recently from 7f2812e to 19b8603 Compare May 19, 2021 03:33

This comment has been minimized.

Sign in to view

camsteffen mentioned this pull request May 19, 2021

Use rustc_lint::builtin::has_doc rust-lang/rust-clippy#7247

Closed

jyn514 force-pushed the remove-doc-include branch from 19b8603 to ff01bd3 Compare May 19, 2021 15:56

jyn514 force-pushed the remove-doc-include branch from ff01bd3 to 903a183 Compare May 19, 2021 19:06

This comment has been minimized.

Sign in to view

jyn514 force-pushed the remove-doc-include branch from 903a183 to f616e6b Compare May 19, 2021 19:18

This comment has been minimized.

Sign in to view

jyn514 force-pushed the remove-doc-include branch 2 times, most recently from 11c6f97 to 2a68d67 Compare May 19, 2021 19:55

This comment has been minimized.

Sign in to view

jyn514 mentioned this pull request May 20, 2021

invalid_doc_attributes cannot be allowed or denied #85497

Closed

jyn514 force-pushed the remove-doc-include branch from 2a68d67 to 95cc6b9 Compare May 20, 2021 02:51

This comment has been minimized.

Sign in to view

jyn514 force-pushed the remove-doc-include branch from 95cc6b9 to d40e9aa Compare May 20, 2021 03:30

This comment has been minimized.

Sign in to view

GuillaumeGomez reviewed May 20, 2021

View reviewed changes

compiler/rustc_passes/src/check_attr.rs Show resolved Hide resolved

GuillaumeGomez reviewed May 20, 2021

View reviewed changes

src/test/rustdoc/external-doc.rs Show resolved Hide resolved

GuillaumeGomez reviewed May 20, 2021

View reviewed changes

src/test/ui/rustdoc/doc-include-suggestion.fixed Outdated Show resolved Hide resolved

jyn514 force-pushed the remove-doc-include branch from 70a79cc to 4b5b26b Compare May 25, 2021 00:18

This comment has been minimized.

Sign in to view

Remove doc(include)

15fec1f

jyn514 force-pushed the remove-doc-include branch from 4b5b26b to 15fec1f Compare June 4, 2021 12:06

GuillaumeGomez approved these changes Jun 4, 2021

View reviewed changes

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 4, 2021

bors added the merged-by-bors This PR was explicitly merged by bors. label Jun 5, 2021

bors merged commit 2c10688 into rust-lang:master Jun 5, 2021

rustbot added this to the 1.54.0 milestone Jun 5, 2021

jyn514 deleted the remove-doc-include branch June 5, 2021 12:17

nathanregner mentioned this pull request Jun 10, 2021

Fix README doctests on latest nightly (#175) elastic/elasticsearch-rs#176

Merged

russcam pushed a commit to elastic/elasticsearch-rs that referenced this pull request Jun 18, 2021

Fix README doctests on latest nightly (#175) (#176)

d96bfa2

doc(include) was removed in rust-lang/rust#85457. Tests should now run on on both nightly and stable.

jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Jun 22, 2021

This was referenced Jun 26, 2021

feature external_doc reports wrong test origins in doc tests #60996

Closed

feature external_doc not traversed by rustfmt #60997

Closed

russcam pushed a commit to elastic/elasticsearch-rs that referenced this pull request Jun 29, 2021

Fix README doctests on latest nightly (#175) (#176)

809ae1e

doc(include) was removed in rust-lang/rust#85457. Tests should now run on on both nightly and stable.

rami3l mentioned this pull request Jul 24, 2021

Replace doc(include) due to feature removal clap-rs/clap#2618

Closed

2 tasks

Badel2 mentioned this pull request Mar 26, 2022

Move resolve_path to rustc_builtin_macros and make it private #95335

Merged

Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 27, 2022

Rollup merge of rust-lang#95335 - Badel2:resolve-path, r=Dylan-DPC

979c8e8

Move resolve_path to rustc_builtin_macros and make it private Fixing a FIXME introduced by `@jyn514` in rust-lang#85457

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `doc(include)` #85457

Remove `doc(include)` #85457

jyn514 commented May 19, 2021 •

edited

Loading

rust-highfive commented May 19, 2021

rust-highfive commented May 19, 2021

jyn514 May 19, 2021 •

edited

Loading

phansch May 19, 2021

jyn514 May 19, 2021

camsteffen May 19, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez commented May 19, 2021

jyn514 commented May 19, 2021

GuillaumeGomez commented May 19, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jyn514 commented Jun 4, 2021

GuillaumeGomez commented Jun 4, 2021

bors commented Jun 4, 2021

bors commented Jun 5, 2021

bors commented Jun 5, 2021

Remove doc(include) #85457

Remove doc(include) #85457

Conversation

jyn514 commented May 19, 2021 • edited Loading

rust-highfive commented May 19, 2021

rust-highfive commented May 19, 2021

jyn514 May 19, 2021 • edited Loading

Choose a reason for hiding this comment

phansch May 19, 2021

Choose a reason for hiding this comment

jyn514 May 19, 2021

Choose a reason for hiding this comment

camsteffen May 19, 2021

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

GuillaumeGomez commented May 19, 2021

jyn514 commented May 19, 2021

GuillaumeGomez commented May 19, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

jyn514 commented Jun 4, 2021

GuillaumeGomez commented Jun 4, 2021

bors commented Jun 4, 2021

bors commented Jun 5, 2021

bors commented Jun 5, 2021

Remove `doc(include)` #85457

Remove `doc(include)` #85457

jyn514 commented May 19, 2021 •

edited

Loading

jyn514 May 19, 2021 •

edited

Loading