development/cargo
development/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo synced 2024-08-25 02:25:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #10836 - ehuss:patch-config-docs, r=weihanglo

Browse source 
Mention `[patch]` config in "Overriding Dependencies"

The "Overriding Dependencies" chapter is the primary documentation for the `[patch]` table, but it does not mention that `[patch]` also works in config files. This adds a note to mention this option.

cc https://github.com/rust-lang/cargo/issues/10832#issuecomment-1177647089
This commit is contained in:
bors 2022-07-09 14:48:50 +00:00
parent f4fad79a93 1ac40e2524
commit b1dd22e668
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/doc/src/reference/overriding-dependencies.md
View file

@ -266,6 +266,12 @@ git = 'https://github.com/example/baz'
baz = { git = 'https://github.com/example/patched-baz', branch = 'my-branch' }
```
> **Note**: The `[patch]` table can also be specified as a [configuration
> option](config.md), such as in a `.cargo/config.toml` file or a CLI option
> like `--config 'patch.crates-io.rand.path="rand"'`. This can be useful for
> local-only changes that you don't want to commit, or temporarily testing a
> patch.
The `[patch]` table is made of dependency-like sub-tables. Each key after
`[patch]` is a URL of the source that is being patched, or the name of a
registry. The name `crates-io` may be used to override the default registry