Skip to content

Standardize manpage markup #22832

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.

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

Merged
merged 2 commits into from
Mar 10, 2015
Merged

Standardize manpage markup #22832

merged 2 commits into from
Mar 10, 2015

Conversation

anguslees
Copy link
Contributor

Use consistent markup between rust and rustdoc manpages. Avoid use of
the troublesome unquoted '-' troff character.

Use consistent markup between rust and rustdoc manpages.  Avoid use of
the troublesome unquoted '-' troff character.
@rust-highfive
Copy link
Contributor

r? @brson

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

@nagisa
Copy link
Member

nagisa commented Feb 26, 2015

You capitalise value variables for many attributes in codegen section. While this is indeed somewhat of a convention in CLI help outputs and, therefore, manpages, I think we should try to keep man page’s and rustc’s -C help output (which has the same value variable names lowercase) consistent.

👍 for other changes.

@anguslees
Copy link
Contributor Author

@nagisa: thanks. I'll note that the options were already upper-cased in rustc.1 - in this change I just also uppercased the options in rustdoc.1. I am of course fine with lower-casing the whole lot instead.

@nagisa
Copy link
Member

nagisa commented Feb 26, 2015

@anguslees
Copy link
Contributor Author

@nagisa oh I see! yes, they would indeed make more sense if they were lowercased. Patch up shortly...

This is more consistent with `rustc -C help` output.
@brson
Copy link
Contributor

brson commented Mar 9, 2015

@bors rollup r+

Nice attention to detail.

@bors
Copy link
Collaborator

bors commented Mar 9, 2015

@bors r=brson 9093e23

Manishearth added a commit to Manishearth/rust that referenced this pull request Mar 10, 2015
 Use consistent markup between rust and rustdoc manpages.  Avoid use of
the troublesome unquoted '-' troff character.
@bors bors merged commit 9093e23 into rust-lang:master Mar 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants