Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.
This repository has been archived by the owner on May 20, 2020. It is now read-only.

Flag: no defaults #139

Closed
steveklabnik opened this issue Aug 10, 2017 · 3 comments
Closed

Flag: no defaults #139

steveklabnik opened this issue Aug 10, 2017 · 3 comments

Comments

@steveklabnik
Copy link
Owner

This issue is part of #125

--no-defaults: don't run default passes

Using this flag looks like this:

$ rustdoc src/lib.rs --no-defaults

By default, rustdoc will run several passes over your code. This
removes those defaults, allowing you to use --passes to specify
exactly which passes you want.

For more details on passes, see the chapter on them.

See also --passes.


Should we keep this flag or not?

@steveklabnik
Copy link
Owner Author

We don't currently have the "passes" architecture, so I'm not sure this flag makes sense.

Existing usage, as far as I know, is mostly to use it in combination with --passes in order to document private things, which we can instead support more directly.

@steveklabnik
Copy link
Owner Author

We talked about this at the tools team meeting today and the intention is to remove this flag. Passes don't make much sense in new rustdoc.

@steveklabnik
Copy link
Owner Author

rust-lang/rust#44136 is the issue tracking the deprecation; it may or may not be removed, but it means we don't need to support it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant