Skip to content

Commit af53559

Browse files
authored
Link the rustc-dev-guide CLI chapter. (#384)
1 parent 0d0e89b commit af53559

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/compiler/new_option.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,16 @@ Once you've written up the proposal, you can [open a MCP](https://github.com/rus
4747

4848
Naturally your new option will also have to be implemented. You can implement the option and open up a PR. Often, this implementation work actually happens **before** the MCP is created, and that's fine -- we'll just ask you to open an MCP with the write-up.
4949

50+
See the [Command-line Arguments] chapter in the rustc dev guide for guidelines on how to name and define a new argument.
51+
5052
A few notes that are sometimes overlooked:
5153

5254
* Many options begin as "unstable" options, either because they use `-Z` or because they require `-Zunstable-options` to use.
5355
* You should document the option. Often this documentation can just be copied from the MCP text. Where you add this documentation depends on whether the option is available on stable Rust:
5456
* If it is unstable, then document the option in the [Unstable Book](https://doc.rust-lang.org/nightly/unstable-book/index.html), whose sources are in [src/doc/unstable-book](https://github.com/rust-lang/rust/tree/master/src/doc/unstable-book).
5557
* Once the option is stabilized, it should be documented in the [Rustc book](https://doc.rust-lang.org/rustc/index.html), whose sources as in [src/doc/rustc](https://github.com/rust-lang/rust/tree/master/src/doc/rustc).
5658

59+
[Command-line Arguments]: https://rustc-dev-guide.rust-lang.org/cli.html
5760

5861
## Stabilization and tracking issue
5962

0 commit comments

Comments
 (0)