From e50985181317422181bbc0d2297cf2c297982dd6 Mon Sep 17 00:00:00 2001
From: Diogo Sousa <diogogsousa@gmail.com>
Date: Sun, 10 Nov 2019 15:02:15 +0000
Subject: [PATCH] Fix unused configuration key warning for a few keys under
 `build`.

Recently cargo started to warn about configuration keys that he doesn't know
about.  However, there are a few keys under `build` that were used in a
dynamic way (`rustc`, `rustdoc`, and `rustc_wrapper`) by
`Config::maybe_get_tool()`.

Since these keys are not known to exist when `Config` is deserialized, cargo
was emitting unused warnings.

This commit makes those config keys explicit.  Note that by doing so there is a
small breaking change: before it was possible to have `build.rustc_wrapper` in
the configuration file (even though the documented key uses kebak-case), and
now that key will be ignored.  (Good thing we have warnings for unrecognized
keys!)
---
 src/cargo/ops/fix.rs         |  2 +-
 src/cargo/util/config/mod.rs | 64 +++++++++++++++---------------------
 2 files changed, 28 insertions(+), 38 deletions(-)

diff --git a/src/cargo/ops/fix.rs b/src/cargo/ops/fix.rs
index 0daaf096d34..dfad1e48123 100644
--- a/src/cargo/ops/fix.rs
+++ b/src/cargo/ops/fix.rs
@@ -15,7 +15,7 @@
 //! to print at the same time).
 //!
 //! Cargo begins a normal `cargo check` operation with itself set as a proxy
-//! for rustc by setting `rustc_wrapper` in the build config. When
+//! for rustc by setting `primary_unit_rustc` in the build config. When
 //! cargo launches rustc to check a crate, it is actually launching itself.
 //! The `FIX_ENV` environment variable is set so that cargo knows it is in
 //! fix-proxy-mode.
diff --git a/src/cargo/util/config/mod.rs b/src/cargo/util/config/mod.rs
index 0a809a5bd9b..c8de80eef7d 100644
--- a/src/cargo/util/config/mod.rs
+++ b/src/cargo/util/config/mod.rs
@@ -216,7 +216,7 @@ impl Config {
     /// Gets the path to the `rustdoc` executable.
     pub fn rustdoc(&self) -> CargoResult<&Path> {
         self.rustdoc
-            .try_borrow_with(|| self.get_tool("rustdoc"))
+            .try_borrow_with(|| Ok(self.get_tool("rustdoc", &self.build_config()?.rustdoc)))
             .map(AsRef::as_ref)
     }
 
@@ -227,9 +227,9 @@ impl Config {
                 .join(".rustc_info.json")
                 .into_path_unlocked()
         });
-        let wrapper = self.maybe_get_tool("rustc_wrapper")?;
+        let wrapper = self.maybe_get_tool("rustc_wrapper", &self.build_config()?.rustc_wrapper);
         Rustc::new(
-            self.get_tool("rustc")?,
+            self.get_tool("rustc", &self.build_config()?.rustc),
             wrapper,
             &self
                 .home()
@@ -853,47 +853,34 @@ impl Config {
         Ok(())
     }
 
-    /// Looks for a path for `tool` in an environment variable or config path, and returns `None`
-    /// if it's not present.
-    fn maybe_get_tool(&self, tool: &str) -> CargoResult<Option<PathBuf>> {
-        let var = tool
-            .chars()
-            .flat_map(|c| c.to_uppercase())
-            .collect::<String>();
-        if let Some(tool_path) = env::var_os(&var) {
-            let maybe_relative = match tool_path.to_str() {
-                Some(s) => s.contains('/') || s.contains('\\'),
-                None => false,
-            };
-            let path = if maybe_relative {
-                self.cwd.join(tool_path)
-            } else {
-                PathBuf::from(tool_path)
-            };
-            return Ok(Some(path));
-        }
-
-        // For backwards compatibility we allow both snake_case config paths as well as the
-        // idiomatic kebab-case paths.
-        let config_paths = [
-            format!("build.{}", tool),
-            format!("build.{}", tool.replace('_', "-")),
-        ];
+    /// Looks for a path for `tool` in an environment variable or the given config, and returns
+    /// `None` if it's not present.
+    fn maybe_get_tool(&self, tool: &str, from_config: &Option<PathBuf>) -> Option<PathBuf> {
+        let var = tool.to_uppercase();
 
-        for config_path in &config_paths {
-            if let Some(tool_path) = self.get_path(&config_path)? {
-                return Ok(Some(tool_path.val));
+        match env::var_os(&var) {
+            Some(tool_path) => {
+                let maybe_relative = match tool_path.to_str() {
+                    Some(s) => s.contains('/') || s.contains('\\'),
+                    None => false,
+                };
+                let path = if maybe_relative {
+                    self.cwd.join(tool_path)
+                } else {
+                    PathBuf::from(tool_path)
+                };
+                Some(path)
             }
-        }
 
-        Ok(None)
+            None => from_config.clone(),
+        }
     }
 
     /// Looks for a path for `tool` in an environment variable or config path, defaulting to `tool`
     /// as a path.
-    pub fn get_tool(&self, tool: &str) -> CargoResult<PathBuf> {
-        self.maybe_get_tool(tool)
-            .map(|t| t.unwrap_or_else(|| PathBuf::from(tool)))
+    fn get_tool(&self, tool: &str, from_config: &Option<PathBuf>) -> PathBuf {
+        self.maybe_get_tool(tool, from_config)
+            .unwrap_or_else(|| PathBuf::from(tool))
     }
 
     pub fn jobserver_from_env(&self) -> Option<&jobserver::Client> {
@@ -1473,6 +1460,9 @@ pub struct CargoBuildConfig {
     pub jobs: Option<u32>,
     pub rustflags: Option<StringList>,
     pub rustdocflags: Option<StringList>,
+    pub rustc_wrapper: Option<PathBuf>,
+    pub rustc: Option<PathBuf>,
+    pub rustdoc: Option<PathBuf>,
 }
 
 /// A type to deserialize a list of strings from a toml file.