diff options
author | Isis Lovecruft <isis@torproject.org> | 2018-03-14 21:02:05 +0000 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2018-03-21 17:04:28 -0400 |
commit | 97993943755fb1670fca6d216565adb69db2687b (patch) | |
tree | 847b71a2e4805e8d085a03bba87845e75196cb9a /doc/HACKING | |
parent | f9ccb2543d3387e42f20ea52900609af9bc2a922 (diff) | |
download | tor-97993943755fb1670fca6d216565adb69db2687b.tar.gz tor-97993943755fb1670fca6d216565adb69db2687b.zip |
maint: Add script for vendoring/updating Rust dependencies.
* ADD documentation for usage both inside the script and in
doc/HACKING/CodingStandardsRust.md
* FIXES part of #25310: https://bugs.torproject.org/25310
Diffstat (limited to 'doc/HACKING')
-rw-r--r-- | doc/HACKING/CodingStandardsRust.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/HACKING/CodingStandardsRust.md b/doc/HACKING/CodingStandardsRust.md index 915d37e006..7c6405e624 100644 --- a/doc/HACKING/CodingStandardsRust.md +++ b/doc/HACKING/CodingStandardsRust.md @@ -81,6 +81,26 @@ Currently, Tor requires that you use the latest stable Rust version. At some point in the future, we will freeze on a given stable Rust version, to ensure backward compatibility with stable distributions that ship it. + Updating/Adding Dependencies +------------------------------ + +To add/remove/update dependencies, first add your dependencies, +exactly specifying their versions, into the appropriate *crate-level* +`Cargo.toml` in `src/rust/` (i.e. *not* `/src/rust/Cargo.toml`, but +instead the one for your crate). Also, investigate whether your +dependency has any optional dependencies which are unnecessary but are +enabled by default. If so, you'll likely be able to enable/disable +them via some feature, e.g.: + +```toml +[dependencies] +foo = { version = "1.0.0", default-features = false } +``` + +Next, run `/scripts/maint/updateRustDependencies.sh`. Then, go into +`src/ext/rust` and commit the changes to the `tor-rust-dependencies` +repo. + Documentation --------------- |