Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

man pages are out of date #5729

Closed
ehuss opened this issue Jul 15, 2018 · 2 comments · Fixed by #6405
Closed

man pages are out of date #5729

ehuss opened this issue Jul 15, 2018 · 2 comments · Fixed by #6405
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@ehuss
Copy link
Contributor

ehuss commented Jul 15, 2018

Someone on IRC noticed that the cargo man pages are a little out of date or wrong. In particular, cargo-bench documents a --release flag that does not exist. Browsing through some of the other entries I see a few that are also out of date. It might be worthwhile to review all of them and bring them up-to-date.
@ehuss
Copy link
Contributor Author

ehuss commented Aug 5, 2018

Note: I'm preferring to wait and see what the wg-cli group comes up with. They have a prototype that will generate man pages from the CLI help, so maybe we'll be able to use that.

@dwijnand
Copy link
Member

dwijnand commented Aug 7, 2018

Here's the upstream (clap) issue for auto-generating man pages: clap-rs/clap#552

@ehuss ehuss added the A-documenting-cargo-itself Area: Cargo's documentation label Nov 18, 2018
@ehuss ehuss mentioned this issue Dec 9, 2018
Merged
bors added a commit that referenced this issue Dec 17, 2018
@bors
Auto merge of #6405 - ehuss:new-man, r=alexcrichton
bd5b21e 
New man pages.

This is a rewrite and update of the man pages. This also adds them to the website documentation. They are now in Asciidoc format to make it easy to output multiple formats and have decent formatting. There is a Makefile with instructions on how to rebuild the man pages.

Closes #5729.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

New man pages. ehuss/cargo
2 participants
@ehuss @dwijnand