tor-commits March 2018

tor-commits@lists.torproject.org

15 participants
1430 discussions

[tor/maint-0.3.3] doc: Document our current rough-draft policy on Rust dependencies.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit f9ccb2543d3387e42f20ea52900609af9bc2a922 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 14 20:59:16 2018 +0000 doc: Document our current rough-draft policy on Rust dependencies. * FIXES #25310: https://bugs.torproject.org/25310 --- doc/HACKING/CodingStandardsRust.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/HACKING/CodingStandardsRust.md b/doc/HACKING/CodingStandardsRust.md index ad8cd9d04..915d37e00 100644 --- a/doc/HACKING/CodingStandardsRust.md +++ b/doc/HACKING/CodingStandardsRust.md @@ -61,6 +61,22 @@ In general, we use modules from only the Rust standard library whenever possible. We will review including external crates on a case-by-case basis. +If a crate only contains traits meant for compatibility between Rust +crates, such as [the digest crate](https://crates.io/crates/digest) or +[the failure crate](https://crates.io/crates/failure), it is very likely +permissible to add it as a dependency. However, a brief review should +be conducted as to the usefulness of implementing external traits +(i.e. how widespread is the usage, how many other crates either +implement the traits or have trait bounds based upon them), as well as +the stability of the traits (i.e. if the trait is going to change, we'll +potentially have to re-do all our implementations of it). + +For large external libraries, especially which implement features which +would be labour-intensive to reproduce/maintain ourselves, such as +cryptographic or mathematical/statistics libraries, only crates which +have stabilised to 1.0.0 should be considered, however, again, we may +make exceptions on a case-by-case basis. + 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.

1 0

[tor/maint-0.3.3] maint: Update Rust libc dependency from 0.2.22 to 0.2.39.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit 00a473733d78f15d59c48d3244d7fc8302c8314c Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 14 21:25:52 2018 +0000 maint: Update Rust libc dependency from 0.2.22 to 0.2.39. Requires the update/libc-0.2.39 branch from https://github.com/isislovecruft/tor-rust-dependencies to be merged first. --- src/ext/rust | 2 +- src/rust/Cargo.lock | 28 ++++++++++++++-------------- src/rust/external/Cargo.toml | 2 +- src/rust/protover/Cargo.toml | 2 +- src/rust/smartlist/Cargo.toml | 2 +- src/rust/tor_allocate/Cargo.toml | 2 +- src/rust/tor_util/Cargo.toml | 2 +- 7 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/ext/rust b/src/ext/rust index 240296800..2422d7acc 160000 --- a/src/ext/rust +++ b/src/ext/rust @@ -1 +1 @@ -Subproject commit 240296800824e40b10cb8c16da0e711563353945 +Subproject commit 2422d7acccc44c633ea825b630ceee6777773cc2 diff --git a/src/rust/Cargo.lock b/src/rust/Cargo.lock index 224d2135b..4f918c022 100644 --- a/src/rust/Cargo.lock +++ b/src/rust/Cargo.lock @@ -1,21 +1,13 @@ -[root] -name = "tor_util" -version = "0.0.1" -dependencies = [ - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", - "tor_allocate 0.0.1", -] - [[package]] name = "external" version = "0.0.1" dependencies = [ - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "libc" -version = "0.2.22" +version = "0.2.39" source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] @@ -23,7 +15,7 @@ name = "protover" version = "0.0.1" dependencies = [ "external 0.0.1", - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", "smartlist 0.0.1", "tor_allocate 0.0.1", "tor_util 0.0.1", @@ -33,14 +25,14 @@ dependencies = [ name = "smartlist" version = "0.0.1" dependencies = [ - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] name = "tor_allocate" version = "0.0.1" dependencies = [ - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", ] [[package]] @@ -51,5 +43,13 @@ dependencies = [ "tor_util 0.0.1", ] +[[package]] +name = "tor_util" +version = "0.0.1" +dependencies = [ + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", + "tor_allocate 0.0.1", +] + [metadata] -"checksum libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)" = "babb8281da88cba992fa1f4ddec7d63ed96280a1a53ec9b919fd37b53d71e502" +"checksum libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)" = "f54263ad99207254cf58b5f701ecb432c717445ea2ee8af387334bdd1a03fdff" diff --git a/src/rust/external/Cargo.toml b/src/rust/external/Cargo.toml index bccd7033a..b5957b107 100644 --- a/src/rust/external/Cargo.toml +++ b/src/rust/external/Cargo.toml @@ -4,7 +4,7 @@ version = "0.0.1" name = "external" [dependencies] -libc = "0.2.22" +libc = "=0.2.39" [lib] name = "external" diff --git a/src/rust/protover/Cargo.toml b/src/rust/protover/Cargo.toml index 04d2f2ed7..86301b878 100644 --- a/src/rust/protover/Cargo.toml +++ b/src/rust/protover/Cargo.toml @@ -4,7 +4,7 @@ version = "0.0.1" name = "protover" [dependencies] -libc = "0.2.22" +libc = "=0.2.39" [dependencies.smartlist] path = "../smartlist" diff --git a/src/rust/smartlist/Cargo.toml b/src/rust/smartlist/Cargo.toml index 51f486c4d..6ddcbee8e 100644 --- a/src/rust/smartlist/Cargo.toml +++ b/src/rust/smartlist/Cargo.toml @@ -4,7 +4,7 @@ version = "0.0.1" name = "smartlist" [dependencies] -libc = "0.2.22" +libc = "0.2.39" [lib] name = "smartlist" diff --git a/src/rust/tor_allocate/Cargo.toml b/src/rust/tor_allocate/Cargo.toml index ceb08b78a..468425f11 100644 --- a/src/rust/tor_allocate/Cargo.toml +++ b/src/rust/tor_allocate/Cargo.toml @@ -4,7 +4,7 @@ version = "0.0.1" name = "tor_allocate" [dependencies] -libc = "0.2.22" +libc = "=0.2.39" [lib] name = "tor_allocate" diff --git a/src/rust/tor_util/Cargo.toml b/src/rust/tor_util/Cargo.toml index d7379a598..b540d8c84 100644 --- a/src/rust/tor_util/Cargo.toml +++ b/src/rust/tor_util/Cargo.toml @@ -12,5 +12,5 @@ crate_type = ["rlib", "staticlib"] path = "../tor_allocate" [dependencies] -libc = "0.2.22" +libc = "=0.2.39"

1 0

[tor/master] Merge branch 'bug25310_r1_033' into maint-0.3.3
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit 95b78d4178a07b9b33782a2d3193aa176a88ca80 Merge: b06997914 00a473733 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Mar 21 17:04:38 2018 -0400 Merge branch 'bug25310_r1_033' into maint-0.3.3 doc/HACKING/CodingStandardsRust.md | 36 ++++++++++++++++++++++++++ scripts/maint/updateRustDependencies.sh | 45 +++++++++++++++++++++++++++++++++ src/ext/rust | 2 +- src/rust/Cargo.lock | 28 ++++++++++---------- src/rust/external/Cargo.toml | 2 +- src/rust/protover/Cargo.toml | 2 +- src/rust/smartlist/Cargo.toml | 2 +- src/rust/tor_allocate/Cargo.toml | 2 +- src/rust/tor_util/Cargo.toml | 2 +- 9 files changed, 101 insertions(+), 20 deletions(-)

1 0

[tor/master] doc: Document our current rough-draft policy on Rust dependencies.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

1 0

[tor/master] Update src/ext/rust to latest master for libc update.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit 2b3138741002e298ee9b6a0fb8150432bfdcb0fc Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Mar 21 17:09:59 2018 -0400 Update src/ext/rust to latest master for libc update. --- src/ext/rust | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/ext/rust b/src/ext/rust index 2422d7acc..fbc0c2578 160000 --- a/src/ext/rust +++ b/src/ext/rust @@ -1 +1 @@ -Subproject commit 2422d7acccc44c633ea825b630ceee6777773cc2 +Subproject commit fbc0c25785696a25b9cbc09ed645cc8d404ee0f6

1 0

[tor/master] maint: Add script for vendoring/updating Rust dependencies.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit 97993943755fb1670fca6d216565adb69db2687b Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Mar 14 21:02:05 2018 +0000 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 --- doc/HACKING/CodingStandardsRust.md | 20 +++++++++++++++ scripts/maint/updateRustDependencies.sh | 45 +++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) diff --git a/doc/HACKING/CodingStandardsRust.md b/doc/HACKING/CodingStandardsRust.md index 915d37e00..7c6405e62 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 --------------- diff --git a/scripts/maint/updateRustDependencies.sh b/scripts/maint/updateRustDependencies.sh new file mode 100755 index 000000000..a5a92579d --- /dev/null +++ b/scripts/maint/updateRustDependencies.sh @@ -0,0 +1,45 @@ +#!/usr/bin/env bash +# +# Copyright (c) 2018 The Tor Project, Inc. +# Copyright (c) 2018 isis agora lovecruft +# See LICENSE for license information +# +# updateRustDependencies.sh +# ------------------------- +# Update our vendored Rust dependencies, either adding/removing +# dependencies and/or upgrading current dependencies to newer +# versions. +# +# To use this script, 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). +# +# Next, run this script. Then, go into src/ext/rust and commit the +# changes to the tor-rust-dependencies repo. + +set -e + +HERE=`dirname $(realpath $0)` +TOPLEVEL=`dirname $(dirname $HERE)` +TOML="$TOPLEVEL/src/rust/Cargo.toml" +VENDORED="$TOPLEVEL/src/ext/rust/crates" +CARGO=`which cargo` + +if ! test -f "$TOML" ; then + printf "Error: Couldn't find workspace Cargo.toml in expected location: %s\n" "$TOML" +fi + +if ! test -d "$VENDORED" ; then + printf "Error: Couldn't find directory for Rust dependencies! Expected location: %s\n" "$VENDORED" +fi + +if test -z "$CARGO" ; then + printf "Error: cargo must be installed and in your \$PATH\n" +fi + +if test -z `cargo --list | grep vendor` ; then + printf "Error: cargo-vendor not installed\n" +fi + +$CARGO vendor -v --locked --explicit-version --no-delete --sync $TOML $VENDORED

1 0

[tor/master] Update tor_log to libc 0.2.39 as well.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit f8e53a545a818ab8e710ca58a58d1b1f6e51b82a Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Mar 21 17:14:15 2018 -0400 Update tor_log to libc 0.2.39 as well. --- src/rust/Cargo.lock | 3 ++- src/rust/tor_log/Cargo.toml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/rust/Cargo.lock b/src/rust/Cargo.lock index 717add222..91c0502c6 100644 --- a/src/rust/Cargo.lock +++ b/src/rust/Cargo.lock @@ -40,7 +40,7 @@ dependencies = [ name = "tor_log" version = "0.1.0" dependencies = [ - "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)", + "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", "tor_allocate 0.0.1", ] @@ -58,6 +58,7 @@ version = "0.0.1" dependencies = [ "libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)", "tor_allocate 0.0.1", + "tor_log 0.1.0", ] [metadata] diff --git a/src/rust/tor_log/Cargo.toml b/src/rust/tor_log/Cargo.toml index f31d27b04..971cd658b 100644 --- a/src/rust/tor_log/Cargo.toml +++ b/src/rust/tor_log/Cargo.toml @@ -12,7 +12,7 @@ crate_type = ["rlib", "staticlib"] testing = [] [dependencies] -libc = "0.2.22" +libc = "0.2.39" [dependencies.tor_allocate] path = "../tor_allocate"

1 0

[tor/master] maint: Update Rust libc dependency from 0.2.22 to 0.2.39.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

1 0

[tor/release-0.3.3] doc: Document our current rough-draft policy on Rust dependencies.
by nickm＠torproject.org 21 Mar '18

21 Mar '18

1 0

[tor/master] Merge branch 'maint-0.3.3'
by nickm＠torproject.org 21 Mar '18

21 Mar '18

commit 4e82441e4cc54776e9210e11cdee22dc4a337003 Merge: 03e787e22 2b3138741 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Mar 21 17:10:10 2018 -0400 Merge branch 'maint-0.3.3' src/ext/rust | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits March 2018