mirror of
https://github.com/rust-lang/cargo
synced 2024-08-28 19:59:27 +00:00
Auto merge of #9747 - lf-:document-pathandargs-doc-browser, r=ehuss
doc: Clarify [doc].browser docs, document PathAndArgs better I was talking to someone who was confused about the [doc].browser value type as it related to using a path with a space in it, and it seemed like this area needed clarification in general.
This commit is contained in:
commit
0a24beb34e
|
@ -203,6 +203,20 @@ runner = "foo" # Searches `PATH` for `foo`.
|
|||
directory = "vendor"
|
||||
```
|
||||
|
||||
### Executable paths with arguments
|
||||
|
||||
Some Cargo commands invoke external programs, which can be configured as a path
|
||||
and some number of arguments.
|
||||
|
||||
The value may be an array of strings like `['/path/to/program', 'somearg']` or
|
||||
a space-separated string like `'/path/to/program somearg'`. If the path to the
|
||||
executable contains a space, the list form must be used.
|
||||
|
||||
If Cargo is passing other arguments to the program such as a path to open or
|
||||
run, they will be passed after the last specified argument in the value of an
|
||||
option of this format. If the specified program does not have path separators,
|
||||
Cargo will search `PATH` for its executable.
|
||||
|
||||
### Credentials
|
||||
|
||||
Configuration values with sensitive information are stored in the
|
||||
|
@ -425,6 +439,10 @@ The `[doc]` table defines options for the [`cargo doc`] command.
|
|||
|
||||
##### `doc.browser`
|
||||
|
||||
* Type: string or array of strings ([program path and args])
|
||||
* Default: `BROWSER` environment variable, or, if that is missing,
|
||||
opening the link in a system specific way
|
||||
|
||||
This option sets the browser to be used by [`cargo doc`], overriding the
|
||||
`BROWSER` environment variable when opening documentation with the `--open`
|
||||
option.
|
||||
|
@ -856,7 +874,7 @@ Specifies the linker which is passed to `rustc` (via [`-C linker`]) when the
|
|||
`<triple>` is being compiled for. By default, the linker is not overridden.
|
||||
|
||||
##### `target.<triple>.runner`
|
||||
* Type: string or array of strings (program path and args)
|
||||
* Type: string or array of strings ([program path and args])
|
||||
* Default: none
|
||||
* Environment: `CARGO_TARGET_<triple>_RUNNER`
|
||||
|
||||
|
@ -865,12 +883,6 @@ executed by invoking the specified runner with the actual executable passed as
|
|||
an argument. This applies to [`cargo run`], [`cargo test`] and [`cargo bench`]
|
||||
commands. By default, compiled executables are executed directly.
|
||||
|
||||
The value may be an array of strings like `['/path/to/program', 'somearg']` or
|
||||
a space-separated string like `'/path/to/program somearg'`. The arguments will
|
||||
be passed to the runner with the executable to run as the last argument. If
|
||||
the runner program does not have path separators, it will search `PATH` for
|
||||
the runner executable.
|
||||
|
||||
##### `target.<cfg>.runner`
|
||||
|
||||
This is similar to the [target runner](#targettriplerunner), but using
|
||||
|
@ -977,6 +989,7 @@ Sets the width for progress bar.
|
|||
[toml]: https://toml.io/
|
||||
[incremental compilation]: profiles.md#incremental
|
||||
[profile]: profiles.md
|
||||
[program path with args]: #executable-paths-with-arguments
|
||||
[libcurl format]: https://ec.haxx.se/usingcurl-proxies.html
|
||||
[source replacement]: source-replacement.md
|
||||
[revision]: https://git-scm.com/docs/gitrevisions
|
||||
|
|
Loading…
Reference in a new issue