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

Add some guidelines on the CLI. #717

Merged
merged 3 commits into from
May 27, 2020
Merged

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented May 27, 2020

This provides some guidelines on CLI flags. I'm sure there is more to say here, but this is a start. Sourced from rustc-ux-guidelines, rust-lang/rust#70729, and my own experience.

@ehuss
Copy link
Contributor Author

ehuss commented May 27, 2020

cc @petrochenkov who has recently been messing with CLI flags. If you want to add anything, I'd be happy to include it.

Copy link
Member

@chrissimpkins chrissimpkins left a comment

Choose a reason for hiding this comment

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

👍

src/cli.md Outdated Show resolved Hide resolved
src/cli.md Outdated Show resolved Hide resolved
src/SUMMARY.md Outdated
@@ -29,6 +29,7 @@
- [Emitting Errors and other Diagnostics](diagnostics.md)
- [`LintStore`](./diagnostics/lintstore.md)
- [Diagnostic Codes](./diagnostics/diagnostic-codes.md)
- [Command-line arguments](./cli.md)
Copy link
Member

Choose a reason for hiding this comment

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

I would suggest moving this to the top of Part 3, next to the rustc-driver chapter.

ehuss and others added 2 commits May 27, 2020 09:21
Co-authored-by: Chris Simpkins <git.simpkins@gmail.com>
Co-authored-by: Who? Me?! <mark-i-m@users.noreply.github.com>
Copy link
Member

@mark-i-m mark-i-m left a comment

Choose a reason for hiding this comment

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

Thanks!

@mark-i-m mark-i-m merged commit 6e2b70c into rust-lang:master May 27, 2020
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this pull request May 29, 2020
…omatsakis

Remove rustc-ux-guidelines

This is now in the rustc-dev-guide:
* rust-lang/rustc-dev-guide#716
* rust-lang/rustc-dev-guide#717

This is a public page, but it was not linked to anywhere, so I think it is safe to remove. Google searches don't show it being used anywhere.
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.

3 participants