]> git.proxmox.com Git - cargo.git/commitdiff
Mention `[patch]` config in "Overriding Dependencies"
authorEric Huss <eric@huss.org>
Sat, 9 Jul 2022 00:09:23 +0000 (17:09 -0700)
committerEric Huss <eric@huss.org>
Sat, 9 Jul 2022 00:09:23 +0000 (17:09 -0700)
src/doc/src/reference/overriding-dependencies.md

index 9dd402a1fe5edd5cb0eef4374bada8782c325dfd..504811d5bba5af318aa995d67be1ff327b9e7f70 100644 (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