Skip to content

Commit 4403332

Browse files
committed
Auto merge of rust-lang#14145 - ehuss:config-summary, r=Muscraft
Docs: Update config summary to include missing keys. The summary at the top of the config chapter is intended to include all of the config keys to provide an overview of all the different options available. A few keys were missing, so this adds those missing keys.
2 parents ec77aa9 + 1fac750 commit 4403332

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/doc/src/reference/config.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ rustdocflags = ["…", "…"] # custom flags to pass to rustdoc
7676
incremental = true # whether or not to enable incremental compilation
7777
dep-info-basedir = "" # path for the base directory for targets in depfiles
7878

79+
[credential-alias]
80+
# Provides a way to define aliases for credential providers.
81+
my-alias = ["/usr/bin/cargo-credential-example", "--argument", "value", "--flag"]
82+
7983
[doc]
8084
browser = "chromium" # browser to use with `cargo doc --open`,
8185
# overrides the `BROWSER` environment variable
@@ -142,10 +146,16 @@ rpath = false # Sets the rpath linking option.
142146
[registries.<name>] # registries other than crates.io
143147
index = "" # URL of the registry index
144148
token = "" # authentication token for the registry
149+
credential-provider = "cargo:token" # The credential provider for this registry.
150+
151+
[registries.crates-io]
152+
protocol = "sparse" # The protocol to use to access crates.io.
145153

146154
[registry]
147155
default = "" # name of the default registry
148156
token = "" # authentication token for crates.io
157+
credential-provider = "cargo:token" # The credential provider for crates.io.
158+
global-credential-providers = ["cargo:token"] # The credential providers to use by default.
149159

150160
[source.<name>] # source definition and replacement
151161
replace-with = "" # replace this source with the given named source
@@ -1001,7 +1011,7 @@ See [Registry Authentication](registry-authentication.md) for more information.
10011011

10021012
#### `registries.crates-io.protocol`
10031013
* Type: string
1004-
* Default: `sparse`
1014+
* Default: `"sparse"`
10051015
* Environment: `CARGO_REGISTRIES_CRATES_IO_PROTOCOL`
10061016

10071017
Specifies the protocol used to access crates.io. Allowed values are `git` or `sparse`.

0 commit comments

Comments
 (0)