From 5424dc46b719a86d94578ab260798c21bc42ea7e Mon Sep 17 00:00:00 2001 From: steveklabnik Date: Fri, 6 Apr 2018 09:32:57 -0400 Subject: [PATCH] write headings for command line arguments --- src/doc/rustc/src/SUMMARY.md | 2 +- src/doc/rustc/src/command-line-arguments.md | 57 +++++++++++++++++++ .../rustc/src/command-line-arguments/index.md | 1 - 3 files changed, 58 insertions(+), 2 deletions(-) create mode 100644 src/doc/rustc/src/command-line-arguments.md delete mode 100644 src/doc/rustc/src/command-line-arguments/index.md diff --git a/src/doc/rustc/src/SUMMARY.md b/src/doc/rustc/src/SUMMARY.md index 197ff6ac410..ba70c745327 100644 --- a/src/doc/rustc/src/SUMMARY.md +++ b/src/doc/rustc/src/SUMMARY.md @@ -1,7 +1,7 @@ # The Rustc Book - [What is rustc?](what-is-rustc.md) -- [Command-line arguments](command-line-arguments/index.md) +- [Command-line arguments](command-line-arguments.md) - [Lints](lints/index.md) - [Lint levels](lints/levels.md) - [Lint Groups](lints/groups.md) diff --git a/src/doc/rustc/src/command-line-arguments.md b/src/doc/rustc/src/command-line-arguments.md new file mode 100644 index 00000000000..7ea3e806e4a --- /dev/null +++ b/src/doc/rustc/src/command-line-arguments.md @@ -0,0 +1,57 @@ +# Command-line arguments + +Here's a list of command-line arguments to `rustc` and what they do. + +## `-h`/`--help`: get help + +## `--cfg`: configure the compilation environment + +## `-L`: add a directory to the library search path. + +## `-l`: link the generated crate to a native library + +## `--crate-type`: a list of types of crates for the compiler to emit + +## `--crate-name`: specify the name of the crate being built + +## `--emit`: emit output other than a crate + +## `--print`: print compiler information + +## `-g`: include debug information + +## `-O`: optimize your code + +## `-o`: filename of the output + +## `--out-dir`: directory to write the output in + +## `--explain`: provide a detailed explanation of an error message + +## `--test`: build a test harness + +## `--target`: select a target triple to build + +## `-W`: set lint warnings + +## `-A`: set lint allowed + +## `-D`: set lint denied + +## `-F`: set lint forbidden + +## `--cap-lints`: set the most restrictive lint level + +## `-C`/`--codegen`: code generation options + +## `-V`/`--verision`: print a version + +## `-v`/`--verbose`: use verbose output + +## `--extern`: specify where an external library is located + +## `--sysroot`: Override the system root + +## `--error-format`: control how errors are produced + +## `--color`: configur coloring of output \ No newline at end of file diff --git a/src/doc/rustc/src/command-line-arguments/index.md b/src/doc/rustc/src/command-line-arguments/index.md deleted file mode 100644 index 162c0e48d4e..00000000000 --- a/src/doc/rustc/src/command-line-arguments/index.md +++ /dev/null @@ -1 +0,0 @@ -# Command-line arguments