File tree Expand file tree Collapse file tree 10 files changed +30
-14
lines changed Expand file tree Collapse file tree 10 files changed +30
-14
lines changed Original file line number Diff line number Diff line change @@ -22,7 +22,9 @@ is placed in `target/doc` in rustdoc's usual format.
22
22
23
23
{{#option "` --open ` " }}
24
24
Open the docs in a browser after building them. This will use your default
25
- browser unless you define another one in the ` BROWSER ` environment variable.
25
+ browser unless you define another one in the ` BROWSER ` environment variable
26
+ or use the [ ` doc.browser ` ] ( ../reference/config.html#docbrowser ) configuration
27
+ option.
26
28
{{/option}}
27
29
28
30
{{#option "` --no-deps ` " }}
Original file line number Diff line number Diff line change @@ -34,7 +34,9 @@ or the `build.rustdocflags` [config value](../reference/config.html).
34
34
35
35
{{#option "` --open ` " }}
36
36
Open the docs in a browser after building them. This will use your default
37
- browser unless you define another one in the ` BROWSER ` environment variable.
37
+ browser unless you define another one in the ` BROWSER ` environment variable
38
+ or use the [ ` doc.browser ` ] ( ../reference/config.html#docbrowser ) configuration
39
+ option.
38
40
{{/option}}
39
41
40
42
{{/options}}
Original file line number Diff line number Diff line change @@ -15,7 +15,9 @@ OPTIONS
15
15
--open
16
16
Open the docs in a browser after building them. This will use your
17
17
default browser unless you define another one in the BROWSER
18
- environment variable.
18
+ environment variable or use the doc.browser
19
+ <https://doc.rust-lang.org/cargo/reference/config.html#docbrowser>
20
+ configuration option.
19
21
20
22
--no-deps
21
23
Do not build documentation for dependencies.
Original file line number Diff line number Diff line change @@ -34,7 +34,9 @@ OPTIONS
34
34
--open
35
35
Open the docs in a browser after building them. This will use your
36
36
default browser unless you define another one in the BROWSER
37
- environment variable.
37
+ environment variable or use the doc.browser
38
+ <https://doc.rust-lang.org/cargo/reference/config.html#docbrowser>
39
+ configuration option.
38
40
39
41
Package Selection
40
42
By default, the package in the current working directory is selected.
Original file line number Diff line number Diff line change @@ -22,7 +22,9 @@ is placed in `target/doc` in rustdoc's usual format.
22
22
23
23
<dt class =" option-term " id =" option-cargo-doc---open " ><a class =" option-anchor " href =" #option-cargo-doc---open " ></a ><code >--open</code ></dt >
24
24
<dd class =" option-desc " >Open the docs in a browser after building them. This will use your default
25
- browser unless you define another one in the <code >BROWSER</code > environment variable.</dd >
25
+ browser unless you define another one in the <code >BROWSER</code > environment variable
26
+ or use the <a href =" ../reference/config.html#docbrowser " ><code >doc.browser</code ></a > configuration
27
+ option.</dd >
26
28
27
29
28
30
<dt class =" option-term " id =" option-cargo-doc---no-deps " ><a class =" option-anchor " href =" #option-cargo-doc---no-deps " ></a ><code >--no-deps</code ></dt >
Original file line number Diff line number Diff line change @@ -38,7 +38,9 @@ or the `build.rustdocflags` [config value](../reference/config.html).
38
38
39
39
<dt class =" option-term " id =" option-cargo-rustdoc---open " ><a class =" option-anchor " href =" #option-cargo-rustdoc---open " ></a ><code >--open</code ></dt >
40
40
<dd class =" option-desc " >Open the docs in a browser after building them. This will use your default
41
- browser unless you define another one in the <code >BROWSER</code > environment variable.</dd >
41
+ browser unless you define another one in the <code >BROWSER</code > environment variable
42
+ or use the <a href =" ../reference/config.html#docbrowser " ><code >doc.browser</code ></a > configuration
43
+ option.</dd >
42
44
43
45
44
46
</dl >
Original file line number Diff line number Diff line change @@ -67,7 +67,7 @@ incremental = true # whether or not to enable incremental compilation
67
67
dep-info-basedir = " …" # path for the base directory for targets in depfiles
68
68
pipelining = true # rustc pipelining
69
69
70
- [cargo- doc ]
70
+ [doc ]
71
71
browser = " chromium" # browser to use with `cargo doc --open`,
72
72
# overrides the `BROWSER` environment variable
73
73
@@ -400,11 +400,11 @@ directory.
400
400
Controls whether or not build pipelining is used. This allows Cargo to
401
401
schedule overlapping invocations of ` rustc ` in parallel when possible.
402
402
403
- #### ` [cargo- doc] `
403
+ #### ` [doc] `
404
404
405
- The ` [cargo- doc] ` table defines options for the [ ` cargo doc ` ] command.
405
+ The ` [doc] ` table defines options for the [ ` cargo doc ` ] command.
406
406
407
- ##### ` cargo- doc.browser`
407
+ ##### ` doc.browser `
408
408
409
409
This option sets the browser to be used by [ ` cargo doc ` ] , overriding the
410
410
` BROWSER ` environment variable when opening documentation with the ` --open `
Original file line number Diff line number Diff line change @@ -52,7 +52,7 @@ system:
52
52
detail.
53
53
* ` TERM ` — If this is set to ` dumb ` , it disables the progress bar.
54
54
* ` BROWSER ` — The web browser to execute to open documentation with [ `cargo
55
- doc` ]'s' ` --open` flag, see [ ` cargo- doc.browser`] for more details.
55
+ doc` ]'s' ` --open` flag, see [ ` doc.browser`] for more details.
56
56
* ` RUSTFMT ` — Instead of running ` rustfmt ` ,
57
57
[ ` cargo fmt ` ] ( https://github.com/rust-lang/rustfmt ) will execute this specified
58
58
` rustfmt ` instance instead.
@@ -134,7 +134,7 @@ supported environment variables are:
134
134
[ `build.incremental` ] : config.md#buildincremental
135
135
[ `build.dep-info-basedir` ] : config.md#builddep-info-basedir
136
136
[ `build.pipelining` ] : config.md#buildpipelining
137
- [ `cargo- doc.browser` ] : config.md#cargo- docbrowser
137
+ [ `doc.browser` ] : config.md#docbrowser
138
138
[ `cargo-new.name` ] : config.md#cargo-newname
139
139
[ `cargo-new.email` ] : config.md#cargo-newemail
140
140
[ `cargo-new.vcs` ] : config.md#cargo-newvcs
Original file line number Diff line number Diff line change @@ -16,7 +16,9 @@ is placed in \fBtarget/doc\fR in rustdoc's usual format.
16
16
\fB \-\- open \fR
17
17
.RS 4
18
18
Open the docs in a browser after building them. This will use your default
19
- browser unless you define another one in the \fB BROWSER \fR environment variable.
19
+ browser unless you define another one in the \fB BROWSER \fR environment variable
20
+ or use the \fI\f(BI doc.browser \fI\fR <https://doc.rust\- lang.org/cargo/reference/config.html#docbrowser> configuration
21
+ option.
20
22
.RE
21
23
.sp
22
24
\fB \-\- no \- deps \fR
Original file line number Diff line number Diff line change @@ -32,7 +32,9 @@ or the \fBbuild.rustdocflags\fR \fIconfig value\fR <https://doc.rust\-lang.org/c
32
32
\fB \-\- open \fR
33
33
.RS 4
34
34
Open the docs in a browser after building them. This will use your default
35
- browser unless you define another one in the \fB BROWSER \fR environment variable.
35
+ browser unless you define another one in the \fB BROWSER \fR environment variable
36
+ or use the \fI\f(BI doc.browser \fI\fR <https://doc.rust\- lang.org/cargo/reference/config.html#docbrowser> configuration
37
+ option.
36
38
.RE
37
39
.SS "Package Selection"
38
40
By default, the package in the current working directory is selected. The \fB \- p \fR
You can’t perform that action at this time.
0 commit comments