Skip to content

Commit

Permalink
Auto merge of #10836 - ehuss:patch-config-docs, r=weihanglo
Browse files Browse the repository at this point in the history
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 #10832 (comment)
  • Loading branch information
bors committed Jul 9, 2022
2 parents f4fad79 + 1ac40e2 commit b1dd22e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/doc/src/reference/overriding-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b1dd22e

Please sign in to comment.