Skip to content

Commit 3115dd6

Browse files
committed
Auto merge of #11350 - hi-rustin:rustin-patch-sparse-docs, r=ehuss
Add `registries.crates-io.protocol` docs ### What does this PR try to resolve? close #11343. Add `registries.crates-io.protocol` docs to explain this unstable option.
2 parents 0a979d3 + 92dd6f3 commit 3115dd6

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

src/doc/src/reference/unstable.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -787,14 +787,14 @@ the command line) target.
787787
* Tracking Issue: [#9096](https://github.com/rust-lang/cargo/pull/9096)
788788
* Original Pull Request: [#9992](https://github.com/rust-lang/cargo/pull/9992)
789789

790-
Allow Cargo packages to depend on `bin`, `cdylib`, and `staticlib` crates,
790+
Allow Cargo packages to depend on `bin`, `cdylib`, and `staticlib` crates,
791791
and use the artifacts built by those crates at compile time.
792792

793793
Run `cargo` with `-Z bindeps` to enable this functionality.
794794

795795
**Example:** use _cdylib_ artifact in build script
796796

797-
The `Cargo.toml` in the consuming package, building the `bar` library as `cdylib`
797+
The `Cargo.toml` in the consuming package, building the `bar` library as `cdylib`
798798
for a specific build target…
799799

800800
```toml
@@ -842,6 +842,13 @@ crates, which can save significant time and bandwidth.
842842

843843
The format of the sparse index is identical to a checkout of a git-based index.
844844

845+
The `registries.crates-io.protocol` config option can be used to set the default protocol
846+
for crates.io. This option requires `-Z sparse-registry` to be enabled.
847+
848+
* `sparse` — Use sparse index.
849+
* `git` — Use git index.
850+
* If the option is unset, it will be sparse index if `-Z sparse-registry` is enabled, otherwise it will be git index.
851+
845852
### publish-timeout
846853
* Tracking Issue: [11222](https://github.com/rust-lang/cargo/issues/11222)
847854

@@ -1376,7 +1383,7 @@ for more information.
13761383
### Workspace Inheritance
13771384

13781385
Workspace Inheritance has been stabilized in the 1.64 release.
1379-
See [workspace.package](workspaces.md#the-package-table),
1380-
[workspace.dependencies](workspaces.md#the-dependencies-table),
1386+
See [workspace.package](workspaces.md#the-package-table),
1387+
[workspace.dependencies](workspaces.md#the-dependencies-table),
13811388
and [inheriting-a-dependency-from-a-workspace](specifying-dependencies.md#inheriting-a-dependency-from-a-workspace)
13821389
for more information.

0 commit comments

Comments
 (0)