--include-info-json --write-info-json take path directly to crate-info.json

Author: EtomicBomb

src/librustdoc/config.rs

@@ -298,7 +298,7 @@ pub(crate) struct RenderOptions {
     pub(crate) write_rendered_cci: bool,
     /// The location of the doc directory for externally located crates.
     /// Absolute path ending in doc/.
-    pub(crate) parts_paths: FxHashMap<String, PathToParts>,
+    pub(crate) parts_paths: Vec<PathToParts>,
     /// Where to write the cross-crate information parts
     pub(crate) parts_out_dir: Option<PathToParts>,
 }
@@ -505,10 +505,9 @@ impl Options {
             Err(err) => dcx.fatal(err),
         };
 
-        let parts_paths = match parse_include_info_json(matches) {
-            Ok(ex) => ex,
-            Err(err) => dcx.fatal(err),
-        };
+        let parts_paths = matches.opt_strs("include-info-json").iter()
+            .map(|path| PathToParts::from_path_to_crate_info(PathBuf::from(path)))
+            .collect();
 
         let default_settings: Vec<Vec<(String, String)>> = vec![
             matches
@@ -754,7 +753,7 @@ impl Options {
             Ok(result) => result,
             Err(e) => dcx.fatal(format!("could not parse --merge: {e}")),
         };
-        let parts_out_dir = matches.opt_str("write-info-json").map(|p| PathToParts::from_doc_root(PathBuf::from(p)));
+        let parts_out_dir = matches.opt_str("write-info-json").map(|p| PathToParts::from_path_to_crate_info(PathBuf::from(p)));
 
         if generate_link_to_definition && (show_coverage || output_format != OutputFormat::Html) {
             dcx.fatal(
@@ -924,35 +923,20 @@ fn parse_extern_html_roots(
 
 /// Absolute path to cci root, including doc.parts, but not the crate name
 ///
-/// For example, `/home/user/project/target/doc.parts/`.
+/// For example, `/home/user/project/target/doc.parts/<crate>/crate-info.json`.
 #[derive(Clone, Debug)]
 pub(crate) struct PathToParts(PathBuf);
 
 impl PathToParts {
     /// Absolute path to cci root, including doc.parts, but not the crate name
-    fn from_doc_root(doc_root: PathBuf) -> Self {
+    fn from_path_to_crate_info(doc_root: PathBuf) -> Self {
         PathToParts(doc_root)
     }
 
     /// Gets the final path at which to place the cci part
-    pub(crate) fn crate_info_path(&self, crate_name: &str) -> PathBuf {
-        PathBuf::from_iter([&self.0, Path::new(crate_name), Path::new("crate-info.json")])
-    }
-}
-
-/// Extracts `--include-info-json` arguments from `matches` and returns a map of crate names to
-/// the given locations. If an `--include-info-json` argument was ill-formed, returns an error
-/// describing the issue.
-fn parse_include_info_json(
-    matches: &getopts::Matches,
-) -> Result<FxHashMap<String, PathToParts>, &'static str> {
-    let mut externs = FxHashMap::default();
-    for arg in &matches.opt_strs("include-info-json") {
-        let (name, path) =
-            arg.split_once('=').ok_or("--include-info-json must be of the form NAME=PATH")?;
-        externs.insert(name.to_string(), PathToParts::from_doc_root(PathBuf::from(path)));
+    pub(crate) fn path(&self) -> &Path {
+        &self.0
     }
-    Ok(externs)
 }
 
 struct MergeResult {

src/librustdoc/html/render/offset_template.rs

@@ -142,6 +142,7 @@ mod tests {
         s.starts_with("//")
     }
 
+    /// not correct, but good enough for these tests
     fn is_comment_html(s: &str) -> bool {
         s.starts_with("<!--") && s.ends_with("-->")
     }

src/librustdoc/html/render/write_shared.rs

@@ -75,6 +75,7 @@ struct CrateInfo {
 }
 
 impl CrateInfo {
+    /// Gets a reference to the cross-crate information parts for `T`
     fn get<T: 'static>(&self) -> Option<&PartsAndLocations<T>> {
         (&self.src_files_js as &dyn Any).downcast_ref()
             .or_else(|| (&self.search_index_js as &dyn Any).downcast_ref())
@@ -84,17 +85,17 @@ impl CrateInfo {
             .or_else(|| (&self.type_impl as &dyn Any).downcast_ref())
     }
 
-    fn read(parts_paths: &FxHashMap<String, PathToParts>) -> Result<Vec<Self>, Error> {
+    /// read all of the crate info from its location on the filesystem
+    fn read(parts_paths: &[PathToParts]) -> Result<Vec<Self>, Error> {
         parts_paths.iter()
-            .map(|(crate_name, parts_path)| {
-                let path = parts_path.crate_info_path(crate_name);
+            .map(|parts_path| {
+                let path = parts_path.path();
                 let parts = try_err!(fs::read(&path), &path);
                 let parts: CrateInfo = try_err!(serde_json::from_slice(&parts), &path);
                 Ok::<_, Error>(parts)
             })
             .collect::<Result<Vec<CrateInfo>, Error>>()
     }
-
 }
 
 
@@ -125,8 +126,8 @@ pub(crate) fn write_shared(
     };
 
     if let Some(parts_out_dir) = &opt.parts_out_dir {
-        let path = parts_out_dir.crate_info_path(&crate_name);
-        write_create_parents(cx, path, serde_json::to_string(&info).unwrap())?;
+        let path = parts_out_dir.path().to_owned();
+        write_create_parents(cx, dbg!(path), serde_json::to_string(&info).unwrap())?;
     }
 
     let mut crates_info = CrateInfo::read(&opt.parts_paths)?;