refactor(gctx): make paths overrides getter explicit

Author: weihanglo

src/cargo/ops/resolve.rs

@@ -527,7 +527,7 @@ pub fn add_overrides<'a>(
     ws: &Workspace<'a>,
 ) -> CargoResult<()> {
     let gctx = ws.gctx();
-    let Some(paths) = gctx.get_list("paths")? else {
+    let Some(paths) = gctx.paths_overrides()? else {
         return Ok(());
     };
 

src/cargo/util/context/mod.rs

@@ -986,15 +986,10 @@ impl GlobalContext {
         }
     }
 
-    /// Get a list of strings.
-    ///
-    /// DO NOT USE outside of the config module. `pub` will be removed in the
-    /// future.
-    ///
-    /// NOTE: this does **not** support environment variables. Use `get` instead
-    /// if you want that.
-    pub fn get_list(&self, key: &str) -> CargoResult<OptValue<Vec<(String, Definition)>>> {
-        let key = ConfigKey::from_str(key);
+    /// Get the `paths` overrides config value.
+    pub fn paths_overrides(&self) -> CargoResult<OptValue<Vec<(String, Definition)>>> {
+        let key = ConfigKey::from_str("paths");
+        // paths overrides cannot be set via env config, so use get_cv here.
         match self.get_cv(&key)? {
             Some(CV::List(val, definition)) => Ok(Some(Value { val, definition })),
             Some(val) => self.expected("list", &key, &val),

tests/testsuite/config_cli.rs

@@ -281,7 +281,7 @@ fn merge_array_mixed_def_paths() {
         // env is currently ignored for get_list()
         .env("CARGO_PATHS", "env")
         .build();
-    let paths = gctx.get_list("paths").unwrap().unwrap();
+    let paths = gctx.paths_overrides().unwrap().unwrap();
     // The definition for the root value is somewhat arbitrary, but currently starts with the file because that is what is loaded first.
     assert_eq!(paths.definition, Definition::Path(paths::root()));
     assert_eq!(paths.val.len(), 2);