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.

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

Update the manual page with new options #20129

Merged
merged 1 commit into from
Dec 23, 2014
Merged

Conversation

nagisa
Copy link
Member

@nagisa nagisa commented Dec 22, 2014

This pull request updates the rustc manual page to represent current state of rustc option handling better. Moved the apparently deprecated options (#19900) to their own section and added all the new codegen options.

A bit unrelatedly, I also updated description of -O and -g flags to point to the new codegen options rather than old, deprecated ones.

Fixes #20111.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @huonw (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. The way Github handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see CONTRIBUTING.md for more information.

@nagisa
Copy link
Member Author

nagisa commented Dec 22, 2014

cc @alexcrichton you'll probably be interested in this.

.TP
\fB\-\-out\-dir\fR DIR
Write output to compiler-chosen filename in <dir>. Ignored if -o is specified.
(default the current directory)
Write output to compiler-chosen filename in <dir>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why did you remove the additional sentences "Ignored if -o is specified. (default the current directory)" ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I was sure I saw rustc throw an error if both these flags were specified.

@alexcrichton
Copy link
Member

Thanks @nagisa!

@nagisa
Copy link
Member Author

nagisa commented Dec 22, 2014

I think this is ready now and represents current rustc state well.

r? @alexcrichton

(do I need to squash the commits or @bors will handle it?)

@rust-highfive rust-highfive assigned alexcrichton and unassigned huonw Dec 22, 2014
@alexcrichton
Copy link
Member

Looks great, thanks @nagisa! Could you squash as well? @bors just merges the PR as-is.

This pull request updates the rustc manual page to represent post-rust-lang#19900
state of rustc options better.

A bit unrelatedly, --help output is changed to fix some issues too:
  * -g and -O descriptions were changed from deprected flags to the new
    codegen flags.
  * dep-info value was moved from crate-type to emit flag.

Fixes rust-lang#20111
Fixes rust-lang#20131
@nagisa
Copy link
Member Author

nagisa commented Dec 22, 2014

Done.

alexcrichton added a commit to alexcrichton/rust that referenced this pull request Dec 22, 2014
This pull request updates the rustc manual page to represent current state of rustc option handling better. Moved the apparently deprecated options (rust-lang#19900) to their own section and added all the new codegen options.

A bit unrelatedly, I also updated description of `-O` and `-g` flags to point to the new codegen options rather than old, deprecated ones.

Fixes rust-lang#20111.
@bors bors merged commit faa0094 into rust-lang:master Dec 23, 2014
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.

--emit=ir is listed as valid choice in manual, but rustc does not accept it anymore
6 participants