rust-lang / rust-lang/rustc-dev-guide
Describe how to swap in local modified crate
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
Recently while working on rustc I mused that a certain task would have been easier if I could have plugged in a different version of the ena crate.
It is probably easy to do this in general. @nikomatsakis says they do it by modifying Cargo.toml in an appropriate fashion. Perhaps even a patch there would work.
But in any case, it would be good to document the process.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the issue's Cargo.toml suggestion and the linked Cargo documentation on patching dependencies. Document how a rustc contributor can substitute a locally modified version of the ena crate, including the relevant Cargo.toml configuration. Done means the rustc-dev-guide explains the process clearly enough to follow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 43/100