Skip to content

Commit faa0094

Browse files
committed
Update man page with the new options
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
1 parent 34d6800 commit faa0094

File tree

2 files changed

+83
-56
lines changed

2 files changed

+83
-56
lines changed

man/rustc.1

+79-52
Original file line numberDiff line numberDiff line change
@@ -12,75 +12,54 @@ This program is a compiler for the Rust language, available at
1212
.SH OPTIONS
1313

1414
.TP
15-
\fB\-\-crate-name NAME\fR
16-
Specify the name of the crate being built
17-
.TP
18-
\fB\-\-crate-type=[bin|lib|dylib|rlib|staticlib]\fR
19-
Configure the flavor of rust crate that is generated (default `bin`)
15+
\fB\-h\fR, \fB\-\-help\fR
16+
Display the help message
2017
.TP
2118
\fB\-\-cfg\fR SPEC
2219
Configure the compilation environment
2320
.TP
24-
\fB\-\-emit=[asm,ir,bc,obj,link]\fR
25-
Configure the output that rustc will produce
26-
.TP
27-
\fB\-h\fR, \fB\-\-help\fR
28-
Display this message
29-
.TP
3021
\fB\-L\fR PATH
3122
Add a directory to the library search path
3223
.TP
33-
\fB\-\-no\-trans\fR
34-
Run all passes except translation; no output
24+
\fB\-l\fR NAME[:KIND]
25+
Link the generated crate(s) to the specified native library NAME. The optional
26+
KIND can be one of, static, dylib, or framework. If omitted, dylib is assumed.
3527
.TP
36-
\fB\-\-no\-analysis\fR
37-
Parse and expand the source, but run no analysis and produce no output
28+
\fB\-\-crate-type\fR [bin|lib|rlib|dylib|staticlib]
29+
Comma separated list of types of crates for the compiler to emit
3830
.TP
39-
\fB\-g\fR
40-
Emit DWARF debug information into object files generated.
31+
\fB\-\-crate-name NAME\fR
32+
Specify the name of the crate being built
4133
.TP
42-
\fB\-\-debuginfo\fR LEVEL
43-
Emit DWARF debug info to the objects created: 0 = no debug info, 1 =
44-
line-tables only (for stacktraces and breakpoints), 2 = full debug
45-
info with variable and type information (same as -g).
34+
\fB\-\-emit\fR [asm|llvm-bc|llvm-ir|obj|link|dep-info]
35+
Configure the output that rustc will produce
36+
.TP
37+
\fB\-\-print\fR [crate-name|output-file-names|sysroot]
38+
Comma separated list of compiler information to print on stdout
39+
.TP
40+
\fB\-g\fR
41+
Equivalent to \fI\-C\fR debuginfo=2
4642
.TP
4743
\fB\-O\fR
48-
Equivalent to \fI\-\-opt\-level=2\fR
44+
Equivalent to \fI\-C\fR opt-level=2
4945
.TP
5046
\fB\-o\fR FILENAME
51-
Write output to <filename>. Ignored if more than one --emit is specified.
52-
.TP
53-
\fB\-\-opt\-level\fR LEVEL
54-
Optimize with possible levels 0-3
47+
Write output to <filename>. Ignored if multiple \fI\-\-emit\fR outputs are
48+
specified.
5549
.TP
5650
\fB\-\-out\-dir\fR DIR
57-
Write output to compiler-chosen filename in <dir>. Ignored if -o is specified.
58-
(default the current directory)
59-
.TP
60-
\fB\-\-parse\-only\fR
61-
Parse only; do not compile, assemble, or link
51+
Write output to compiler-chosen filename in <dir>. Ignored if \fI\-o\fR is
52+
specified. Defaults to the current directory.
6253
.TP
63-
\fB\-\-pretty\fR [TYPE]
64-
Pretty-print the input instead of compiling; valid types are: normal
65-
(un-annotated source), expanded (crates expanded), typed (crates
66-
expanded, with type annotations), identified (fully parenthesized,
67-
AST nodes and blocks with IDs), or flowgraph=<nodeid> (graphviz
68-
formatted flowgraph for node)
69-
.TP
70-
\fB\-\-dep-info\fR [FILENAME]
71-
Output dependency info to <filename> after compiling, in a format suitable
72-
for use by Makefiles.
73-
.TP
74-
\fB\-\-sysroot\fR PATH
75-
Override the system root
54+
\fB\-\-explain\fR OPT
55+
Provide a detailed explanation of an error message
7656
.TP
7757
\fB\-\-test\fR
7858
Build a test harness
7959
.TP
8060
\fB\-\-target\fR TRIPLE
81-
Target triple cpu-manufacturer-kernel[-os] to compile for (see
82-
http://sources.redhat.com/autobook/autobook/autobook_17.html
83-
for details)
61+
Target triple cpu-manufacturer-kernel[-os] to compile for (see chapter 3.4 of
62+
http://www.sourceware.org/autobook/ for details)
8463
.TP
8564
\fB\-W\fR help
8665
Print 'lint' options and default settings
@@ -97,15 +76,30 @@ Set lint denied
9776
\fB\-F\fR OPT, \fB\-\-forbid\fR OPT
9877
Set lint forbidden
9978
.TP
100-
\fB\-Z\fR FLAG
101-
Set internal debugging options. Use "-Z help" to print available options.
102-
.TP
10379
\fB\-C\fR FLAG[=VAL], \fB\-\-codegen\fR FLAG[=VAL]
10480
Set a codegen-related flag to the value specified. Use "-C help" to print
10581
available flags. See CODEGEN OPTIONS below
10682
.TP
107-
\fB\-v\fR, \fB\-\-version\fR
83+
\fB\-V\fR, \fB\-\-version\fR
10884
Print version info and exit
85+
.TP
86+
\fB\-v\fR, \fB\-\-verbose\fR
87+
Use verbose output
88+
.TP
89+
\fB\-\-extern\fR NAME=PATH
90+
Specify where an external rust library is located
91+
.TP
92+
\fB\-\-sysroot\fR PATH
93+
Override the system root
94+
.TP
95+
\fB\-Z\fR FLAG
96+
Set internal debugging options. Use "-Z help" to print available options.
97+
.TP
98+
\fB\-\-color\fR auto|always|never
99+
Configure coloring of output:
100+
auto = colorize, if output goes to a tty (default);
101+
always = always colorize output;
102+
never = never colorize output
109103

110104
.SH CODEGEN OPTIONS
111105

@@ -121,6 +115,9 @@ objects.
121115
A space-separated list of extra arguments to pass to the linker when the linker
122116
is invoked.
123117
.TP
118+
\fBlto\fR
119+
Perform LLVM link-time optimizations.
120+
.TP
124121
\fBtarget-cpu\fR=help
125122
Selects a target processor. If the value is 'help', then a list of available
126123
CPUs is printed.
@@ -167,8 +164,38 @@ Prefers dynamic linking to static linking.
167164
\fBno-integrated-as\fR
168165
Force usage of an external assembler rather than LLVM's integrated one.
169166
.TP
167+
\fBno-redzone\fR
168+
Disable the use of the redzone.
169+
.TP
170170
\fBrelocation-model\fR=[pic,static,dynamic-no-pic]
171-
The relocation model to use. (default: pic)
171+
The relocation model to use. (Default: pic)
172+
.TP
173+
\fBcode-model\fR=[small,kernel,medium,large]
174+
Choose the code model to use.
175+
.TP
176+
\fBmetadata\fR=val
177+
Metadata to mangle symbol names with.
178+
.TP
179+
\fBextra-filename\fR=val
180+
Extra data to put in each output filename.
181+
.TP
182+
\fBcodegen-units\fR=val
183+
Divide crate into N units to optimize in parallel.
184+
.TP
185+
\fBremark\fR=val
186+
Print remarks for these optimization passes (space separated, or "all").
187+
.TP
188+
\fBno-stack-check\fR
189+
Disable checks for stack exhaustion (a memory-safety hazard!).
190+
.TP
191+
\fBdebuginfo\fR=val
192+
Debug info emission level:
193+
0 = no debug info;
194+
1 = line-tables only (for stacktraces and breakpoints);
195+
2 = full debug info with variable and type information.
196+
.TP
197+
\fBopt-level\fR=val
198+
Optimize with possible levels 0-3
172199

173200
.SH "EXAMPLES"
174201
To build an executable from a source file with a main function:

src/librustc/session/config.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -664,17 +664,17 @@ pub fn short_optgroups() -> Vec<getopts::OptGroup> {
664664
assumed.", "NAME[:KIND]"),
665665
optmulti("", "crate-type", "Comma separated list of types of crates
666666
for the compiler to emit",
667-
"[bin|lib|rlib|dylib|staticlib|dep-info]"),
667+
"[bin|lib|rlib|dylib|staticlib]"),
668668
optopt("", "crate-name", "Specify the name of the crate being built",
669669
"NAME"),
670670
optmulti("", "emit", "Comma separated list of types of output for \
671671
the compiler to emit",
672-
"[asm|llvm-bc|llvm-ir|obj|link]"),
672+
"[asm|llvm-bc|llvm-ir|obj|link|dep-info]"),
673673
optmulti("", "print", "Comma separated list of compiler information to \
674674
print on stdout",
675675
"[crate-name|output-file-names|sysroot]"),
676-
optflag("g", "", "Equivalent to --debuginfo=2"),
677-
optflag("O", "", "Equivalent to --opt-level=2"),
676+
optflag("g", "", "Equivalent to -C debuginfo=2"),
677+
optflag("O", "", "Equivalent to -C opt-level=2"),
678678
optopt("o", "", "Write output to <filename>", "FILENAME"),
679679
optopt("", "out-dir", "Write output to compiler-chosen filename \
680680
in <dir>", "DIR"),

0 commit comments

Comments
 (0)