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

Become flag-compatible with existing rustdoc #125

Open
steveklabnik opened this issue Aug 10, 2017 · 7 comments
Open

Become flag-compatible with existing rustdoc #125

steveklabnik opened this issue Aug 10, 2017 · 7 comments

Comments

@steveklabnik
Copy link
Owner

https://github.com/rust-lang/rust/blob/master/src/doc/rustdoc/src/command-line-arguments.md describes the flags that current rustdoc accepts. For each flag, we should:

  1. Decide if we want to keep the flag or not
  2. For the ones we may not keep, implement them, but issue a warning
  3. For the ones we do, implement them!

I'm going to make an isssue per flag, as we should have those discussions individually.

@euclio
Copy link
Contributor

euclio commented Aug 10, 2017

I think there's a bit of an mismatch between the fact that old rustdoc allows documenting individual files while the new rustdoc expects a crate with Cargo.toml. How do we want to handle that?

Another way of putting it is that the old rustdoc expects to be wrapped by cargo, while the new rustdoc expects to wrap cargo.

@steveklabnik
Copy link
Owner Author

@euclio that deserves to be its own ticket; we should deal with it as well. If you don't open one by Monday, I will 😄

@ncharlton02
Copy link
Contributor

ncharlton02 commented Aug 11, 2017

Should this be its own milestone? It will proably make it easier to track all of these flag issues 😀

@steveklabnik
Copy link
Owner Author

Maybe; for now, I've put this one on the relevant milestone. So that'd be like, a sub-milestone. IDK 😄

@hjr3
Copy link
Contributor

hjr3 commented Nov 30, 2017

Some of these flags, such as library-path, moved from being a flag at the top level to being a flag for the build subcommand. I started down an approach to throw an error telling the user the flag moved. Another example is that --test is now a subcommand test. Do we want to provide this level of error message or do we think people will figure it out on their own?

@steveklabnik
Copy link
Owner Author

Telling them the flag moved seems good 👍

@hjr3
Copy link
Contributor

hjr3 commented Dec 3, 2017

I probably need to chat with some folks in IRC about how we want these flags to work. See #141 (comment) which discusses how --test-args should work. I also now wonder if --output should be under the build subcommand or at the top level with --manifest-path. See my implementation #216 to make sure my flag infrastructure PR worked.

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

4 participants