From 4e492b18d785f7eaf0bb4e53699f6935195c273e Mon Sep 17 00:00:00 2001 From: Matt Briggs Date: Thu, 6 May 2021 13:53:33 -0700 Subject: [PATCH] webpki-roots-shim: document version We need to be careful with the version number in webpki-roots-shim's Cargo.toml file. This commit attempts to explain why in comments. --- sources/Cargo.toml | 3 ++- sources/webpki-roots-shim/Cargo.toml | 9 +++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/sources/Cargo.toml b/sources/Cargo.toml index 21442c155b9..ffd720af177 100644 --- a/sources/Cargo.toml +++ b/sources/Cargo.toml @@ -57,6 +57,7 @@ members = [ [profile.release] debug = true -# This replaces webpki-roots with a shim that reads from the ca-certificates package +# This replaces webpki-roots with a shim that reads from the ca-certificates package. See +# webpki-roots-shim/Cargo.toml for more information about using the right version number. [patch.crates-io.webpki-roots] path = "webpki-roots-shim" diff --git a/sources/webpki-roots-shim/Cargo.toml b/sources/webpki-roots-shim/Cargo.toml index cf11f21e06b..dd1477c722a 100644 --- a/sources/webpki-roots-shim/Cargo.toml +++ b/sources/webpki-roots-shim/Cargo.toml @@ -1,5 +1,14 @@ [package] name = "webpki-roots" +# This version number is important because it determines whether or not our shim gets used by the +# patch statement in the sources workspace's Cargo.toml. +# +# At the time of this writing, reqwest is the only crate in sources/Cargo.lock that depends on +# webpki-roots. When reqwest is updated, the version here should be updated to exactly match the one +# that reqwest is using. +# +# You should also double-check sources/Cargo.lock to make sure there aren't two versions of +# webpki-roots being used (which would mean that one of them came from crates.io instead of here). version = "0.21.1" authors = ["iliana destroyer of worlds "] license = "Apache-2.0 OR MIT"