Deprecate several flags in rustdoc by steveklabnik · Pull Request #44138 · rust-lang/rust

steveklabnik · 2017-08-28T23:33:35Z

cc @rust-lang/dev-tools @rust-lang/docs

This is a very basic PR to start deprecating some flags; rustdoc doesn't really have fancy output options like rustc does, so I went with eprintln!. Happy to change it if people feel that's not appropriate.

Also, I have no idea if we can or should write tests here, so I didn't try. If someone feels strongly about it, then let's do it, but given that the only outcome here is a side effect...

rust-highfive · 2017-08-28T23:33:48Z

r? @GuillaumeGomez

(rust_highfive has picked a reviewer for you, use r? to override)

Manishearth

r=me. Probs should use the colorful one over eprintln

Manishearth · 2017-08-28T23:34:50Z

steveklabnik · 2017-08-28T23:36:26Z

Probs should use the colorful one

What's "the colorful one"?

Manishearth · 2017-08-28T23:51:18Z

nvm, that's only available from within rustc and nontrivial to use without a Session

GuillaumeGomez · 2017-08-29T07:46:36Z

@bors: r=Manishearth

bors · 2017-08-29T07:46:38Z

📌 Commit 4cd5314 has been approved by Manishearth

frewsxcv · 2017-08-29T15:13:59Z

@bors rollup

…r=Manishearth Deprecate several flags in rustdoc Part of rust-lang#44136 cc @rust-lang/dev-tools @rust-lang/docs This is a very basic PR to start deprecating some flags; `rustdoc` doesn't really have fancy output options like `rustc` does, so I went with `eprintln!`. Happy to change it if people feel that's not appropriate. Also, I have no idea if we can or should write tests here, so I didn't try. If someone feels strongly about it, then let's do it, but given that the only outcome here is a side effect...

frewsxcv · 2017-08-29T17:34:43Z

@bors r-

https://travis-ci.org/rust-lang/rust/jobs/269657868

alexcrichton · 2017-08-30T14:40:24Z

Hm right now this just prints out "WARNING: this flag is considered deprecated", could it also print the flag as well?

In rust-lang/rust#44138 we are adding deprecations, and so it breaks these tests.

relax rustdoc tests This was asserting on the output directly, rather than just what it contains. In rust-lang/rust#44138 we are adding deprecations, and so it breaks these tests.

steveklabnik · 2017-08-30T17:09:13Z

Great, so this works with my Cargo PR.

@alexcrichton , what's the process for updating Cargo these days? It looks like it depends on a released version, I'm not sure what the protocol is for that.

Hm right now this just prints out "WARNING: this flag is considered deprecated", could it also print the flag as well?

Also happy to do that as well, alongside dropping the testing changes to the submodules.

alexcrichton · 2017-08-30T17:10:32Z

Oh you can just update the cargo submodule whenever on the master branch of rust, no worries!

steveklabnik · 2017-08-30T18:34:10Z

> rustdoc +local --no-defaults
WARNING: the 'no-defaults' flag is considered deprecated
WARNING: please see https://github.com/rust-lang/rust/issues/44136

🤘

steveklabnik · 2017-08-30T19:05:45Z

@alexcrichton https://travis-ci.org/rust-lang/rust/jobs/270119195#L772

what's the right way to resolve this? change it to 0.23?

alexcrichton · 2017-08-30T19:08:26Z

Probably rebase on top of #44154 and wait for that to land I think?

QuietMisdreavus · 2017-09-21T19:55:40Z

I'm also remembering #43949 (comment) where it didn't work for dev-tools in the past. >_>

steveklabnik · 2017-09-21T19:58:32Z

Okay well, sorry rfcbot i'm done fighting with you :)

ping the @rust-lang/dev-tools team for signoffs; here's some manual ticky boxes for you:

Primary sign-off here is "--document-private-items as the name of the flag for rustdoc to document private items". I'm open to suggestions.

killercup · 2017-09-23T13:20:23Z

LGTM

@klabnikatron reviewed

alexcrichton · 2017-09-28T14:23:45Z

@steveklabnik loos like the last remaining box here is @nrc whom I believe is on parental leave right now, although I doubt he'd object to this :)

michaelwoerister · 2017-10-02T20:27:24Z

We looked at this during dev-tools triage. As @alexcrichton says, I think this is good to go, @steveklabnik!

kennytm · 2017-10-15T14:46:27Z

Ping again @steveklabnik 🙂. I think the teams' decisions are "it is good to go". The remaining item is to get it tested, right?

steveklabnik · 2017-10-16T20:09:48Z

Sorry for the delay here, will get on this tomorrow!

Part of rust-lang#44136 Upgrades cargo due to rust-lang/cargo#4451

Fixesrust-lang#44136

steveklabnik · 2017-10-17T21:37:23Z

Okay; we don't have a great way to test the output here, but on @QuietMisdreavus 's suggestion, I've changed a few of the rustdoc tests to use the new flag. That gives us about as much coverage as the old flags did.

QuietMisdreavus · 2017-10-17T21:52:44Z

*drumroll*

@bors r+

bors · 2017-10-17T21:52:45Z

📌 Commit 045ce18 has been approved by QuietMisdreavus

…r=QuietMisdreavus Deprecate several flags in rustdoc Part of rust-lang#44136 cc @rust-lang/dev-tools @rust-lang/docs This is a very basic PR to start deprecating some flags; `rustdoc` doesn't really have fancy output options like `rustc` does, so I went with `eprintln!`. Happy to change it if people feel that's not appropriate. Also, I have no idea if we can or should write tests here, so I didn't try. If someone feels strongly about it, then let's do it, but given that the only outcome here is a side effect...

Rollup of 10 pull requests - Successful merges: #44138, #45082, #45098, #45181, #45217, #45281, #45325, #45326, #45340, #45354 - Failed merges:

…=GuillaumeGomez rustdoc: deprecate `#![doc(passes, plugins, no_default_passes)]` Closesrust-lang#48164 Blocked on rust-lang#50541 - this includes those changes, which were necessary to create the UI test cc rust-lang#44136 Turns out, there were special attributes to mess with rustdoc passes and plugins! Who knew! Since we deprecated the CLI flags for this functionality, it makes sense that we do the same for the attributes. This PR also introduces a `#![doc(document_private_items)]` attribute, to match the `--document-private-items` flag introduced in rust-lang#44138 when the passes/plugins flags were deprecated. I haven't done a search to see whether these attributes are being used at all, but if the flags were any indication, i don't expect to see any users of these.

rust-highfive assigned GuillaumeGomez Aug 28, 2017

Manishearth approved these changes Aug 28, 2017
View reviewed changes

Comment threadsrc/librustdoc/lib.rs Outdated
ManishearthAug 28, 2017
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.
Nl at eof

steveklabnik force-pushed the rustdoc-deprecations branch from 7497e31 to 36f52d9Compare August 28, 2017 23:36

steveklabnik force-pushed the rustdoc-deprecations branch from 36f52d9 to 4cd5314Compare August 28, 2017 23:53

frewsxcv mentioned this pull request Aug 29, 2017
Rollup of 9 pull requests #44155
Closed

frewsxcv mentioned this pull request Aug 29, 2017
Rollup of 8 pull requests #44156
Closed

arielb1 added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Aug 29, 2017

steveklabnik mentioned this pull request Aug 30, 2017
relax rustdoc tests rust-lang/cargo#4451
Merged

steveklabnik added a commit to steveklabnik/cargo that referenced this pull request Aug 30, 2017
Don't use deprecated rustdoc flags in tests
b1e8298
In rust-lang/rust#44138 we are adding deprecations, and so it breaks these tests.

steveklabnik force-pushed the rustdoc-deprecations branch from e85918f to 6438b9bCompare August 30, 2017 15:28

steveklabnik force-pushed the rustdoc-deprecations branch from 6438b9b to 377907cCompare August 30, 2017 18:33

alexcrichton added S-waiting-on-team and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 28, 2017

kennytm 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-team labels Oct 15, 2017

steveklabnik added 2 commits October 17, 2017 10:54

Deprecate several flags in rustdoc
4adf6ae
Part of rust-lang#44136 Upgrades cargo due to rust-lang/cargo#4451

Create a new flag, --document-private-items
aad8787
Fixesrust-lang#44136

steveklabnik force-pushed the rustdoc-deprecations branch from e5eafce to 0b31319Compare October 17, 2017 17:54

modify tests to use new flag
045ce18

steveklabnik force-pushed the rustdoc-deprecations branch from 0b31319 to 045ce18Compare October 17, 2017 19:39

kennytm 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 Oct 18, 2017

kennytm mentioned this pull request Oct 18, 2017
Rollup of 10 pull requests #45368
Merged

bors added a commit that referenced this pull request Oct 18, 2017
Auto merge of#45368- kennytm:rollup, r=kennytm
b796087
Rollup of 10 pull requests - Successful merges: #44138, #45082, #45098, #45181, #45217, #45281, #45325, #45326, #45340, #45354 - Failed merges:

alexcrichton merged commit 045ce18 into rust-lang:masterOct 18, 2017

steveklabnik deleted the rustdoc-deprecations branch October 25, 2017 18:29

hobofan mentioned this pull request Jan 17, 2018
cargo doc: add option to document private types rust-lang/cargo#1520
Closed

QuietMisdreavus mentioned this pull request May 11, 2018
rustdoc: deprecate #![doc(passes, plugins, no_default_passes)]#50669
Merged

QuietMisdreavus mentioned this pull request Jul 9, 2018
Remove rustdoc's plugins feature #52194
Merged

Uh oh!

Uh oh!

Conversation

steveklabnik commented Aug 28, 2017

Uh oh!

rust-highfive commented Aug 28, 2017

Uh oh!

Manishearth left a comment

Choose a reason for hiding this comment

Uh oh!

ManishearthAug 28, 2017

Choose a reason for hiding this comment

Uh oh!

steveklabnik commented Aug 28, 2017

Uh oh!

Manishearth commented Aug 28, 2017

Uh oh!

GuillaumeGomez commented Aug 29, 2017

Uh oh!

bors commented Aug 29, 2017

Uh oh!

frewsxcv commented Aug 29, 2017

Uh oh!

frewsxcv commented Aug 29, 2017

Uh oh!

alexcrichton commented Aug 30, 2017

Uh oh!

steveklabnik commented Aug 30, 2017

Uh oh!

alexcrichton commented Aug 30, 2017

Uh oh!

steveklabnik commented Aug 30, 2017

Uh oh!

steveklabnik commented Aug 30, 2017

Uh oh!

alexcrichton commented Aug 30, 2017

Uh oh!

QuietMisdreavus commented Sep 21, 2017

Uh oh!

steveklabnik commented Sep 21, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

killercup commented Sep 23, 2017

Uh oh!

alexcrichton commented Sep 28, 2017

Uh oh!

michaelwoerister commented Oct 2, 2017

Uh oh!

kennytm commented Oct 15, 2017

Uh oh!

steveklabnik commented Oct 16, 2017

Uh oh!

steveklabnik commented Oct 17, 2017

Uh oh!

QuietMisdreavus commented Oct 17, 2017

Uh oh!

bors commented Oct 17, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

14 participants

steveklabnik commented Sep 21, 2017•
edited
Loading