Add config-based path shorthands #9144
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @Eh2406 (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
When doing local development, users may wish to specify many `path`
dependencies that all live in the same local directory. If that local
directory is not a short distance from the `Cargo.toml`, this can get
unwieldy.
This patch introduces the notion of path "prefixes", which are defined
in `.cargo/config.toml`:
```toml
[path]
devdir = "/home/jon/dev/rust/"
```
Which can then be used as the root for path dependencies. For example:
```toml
foo = { path = "devdir::foo" }
bar = { path = "devdir::bar" }
baz = { path = "devdir::ws/baz" }
```
would fetch `foo` from `/home/jon/dev/rust/foo`, `bar` from
`/home/jon/dev/rust/bar`, and `baz` from `/home/jon/dev/rust/ws/baz`.
This feature also serves as a convenient way for external build systems
to mask build-dependent paths from the user. Consider a build system
that vendors first-party dependencies into
```
/home/user/workplace/feature-1/build/first-party-package/first-party-package-1.0/x86_64/dev/build/private/rust-vendored/
```
Instead of requiring users to hard-code that path, or the relative
equivalent, into their `Cargo.toml`, the build-system can instead
produce a project-local `.cargo/config.toml` that defines that path as
`path.vendored`, and the user can then use vendored dependencies using
```toml
foo = { path = "vendored::foo" }
```
jonhoo
force-pushed
the
path-shorthand
branch
from
1bd96d2 to
e1ac615
Compare
|
This is a very interesting approach! So far I think I like the idea. I think it will need an RFC before we can stabilize, and Team sign off before we merge. |
|
I'd be happy to write up an RFC if there's a rough consensus from the team that an approach like this might be acceptable! |
|
I had some time and wrote RFC 3074. |
|
☔ The latest upstream changes (presumably #9175) made this pull request unmergeable. Please resolve the merge conflicts. |
|
☔ The latest upstream changes (presumably #8825) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Closing as there is now an open RFC for this. Feel free to reopen after that has been accepted. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When doing local development, users may wish to specify many
pathdependencies that all live in the same local directory. If that local
directory is not a short distance from the
Cargo.toml, this can getunwieldy.
This patch introduces the notion of path "prefixes", which are defined
in
.cargo/config.toml:Which can then be used as the root for path dependencies. For example:
would fetch
foofrom/home/jon/dev/rust/foo,barfrom/home/jon/dev/rust/bar, andbazfrom/home/jon/dev/rust/ws/baz.This feature also serves as a convenient way for external build systems
to mask build-dependent paths from the user. Consider a build system
that vendors first-party dependencies into
Instead of requiring users to hard-code that path, or the relative
equivalent, into their
Cargo.toml, the build-system can insteadproduce a project-local
.cargo/config.tomlthat defines that path asbase.vendored, and the user can then use vendored dependencies using