book.tom.l must configure path to Cargo.toml, not just root folder of project: changed config rust.package-dir to rust.manifest

Author: bobhy

guide/book.toml

@@ -6,7 +6,7 @@ language = "en"
 
 [rust]
 ## not needed, and will cause an error, if using Cargo.toml: edition = "2021"
-package-dir = "."
+manifest = "Cargo.toml"
 
 [output.html]
 smart-punctuation = true

src/book/mod.rs

@@ -309,8 +309,8 @@ impl MDBook {
         // get extra args we'll need for rustdoc, if config points to a cargo project.
 
         let mut extern_args = ExternArgs::new();
-        if let Some(package_dir) = &self.config.rust.package_dir {
-            extern_args.load(&package_dir)?;
+        if let Some(manifest) = &self.config.rust.manifest {
+            extern_args.load(&manifest)?;
         }
 
         let mut failed = false;

src/cmd/test.rs

@@ -28,7 +28,7 @@ pub fn make_subcommand() -> Command {
                 .value_parser(NonEmptyStringValueParser::new())
                 .action(ArgAction::Append)
                 .help(
-                    "A comma-separated list of directories to add to the crate \
+                    "[deprecated] A comma-separated list of directories to add to the crate \
                     search path when building tests",
                 ),
         )

src/config.rs

@@ -497,8 +497,8 @@ impl Default for BuildConfig {
 #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(default, rename_all = "kebab-case")]
 pub struct RustConfig {
-    /// Path to a Cargo package
-    pub package_dir: Option<PathBuf>,
+    /// Path to a Cargo.toml
+    pub manifest: Option<PathBuf>,
     /// Rust edition used in playground
     pub edition: Option<RustEdition>,
 }
@@ -801,7 +801,7 @@ mod tests {
         use-default-preprocessors = true
 
         [rust]
-        package-dir = "."
+        manifest = "./Cargo.toml"
 
         [output.html]
         theme = "./themedir"
@@ -845,7 +845,7 @@ mod tests {
             extra_watch_dirs: Vec::new(),
         };
         let rust_should_be = RustConfig {
-            package_dir: Some(PathBuf::from(".")),
+            manifest: Some(PathBuf::from("./Cargo.toml")),
             edition: None,
         };
         let playground_should_be = Playground {
@@ -926,7 +926,7 @@ mod tests {
         assert_eq!(got.book, book_should_be);
 
         let rust_should_be = RustConfig {
-            package_dir: None,
+            manifest: None,
             edition: Some(RustEdition::E2015),
         };
         let got = Config::from_str(src).unwrap();
@@ -946,7 +946,7 @@ mod tests {
         "#;
 
         let rust_should_be = RustConfig {
-            package_dir: None,
+            manifest: None,
             edition: Some(RustEdition::E2018),
         };
 
@@ -967,7 +967,7 @@ mod tests {
         "#;
 
         let rust_should_be = RustConfig {
-            package_dir: None,
+            manifest: None,
             edition: Some(RustEdition::E2021),
         };
 

src/utils/extern_args.rs

@@ -1,6 +1,7 @@
 //! Get "compiler" args from cargo
 
 use crate::errors::*;
+use anyhow::anyhow;
 use cargo_manifest::{Edition, Manifest, MaybeInherited::Local};
 use log::{debug, info};
 use std::fs;
@@ -27,9 +28,9 @@ use std::process::Command;
 ///
 /// # fn main() -> Result<()> {
 /// // Get cargo to say what the compiler args need to be...
-/// let proj_root = std::env::current_dir()?;    // or other path to `Cargo.toml`
+/// let manifest_file = std::env::current_dir()?.join("Cargo.toml");    // or other path to `Cargo.toml`
 /// let mut extern_args = ExternArgs::new();
-/// extern_args.load(&proj_root)?;
+/// extern_args.load(&manifest_file)?;
 ///
 /// // then, when actually invoking rustdoc or some other compiler-like tool...
 ///
@@ -61,11 +62,14 @@ impl ExternArgs {
     /// Run a `cargo build` to see what args Cargo is using for library paths and extern crates.
     /// Touch a source file in the crate to ensure something is compiled and the args will be visible.
 
-    pub fn load(&mut self, proj_root: &Path) -> Result<&Self> {
+    pub fn load(&mut self, cargo_path: &Path) -> Result<&Self> {
         // find Cargo.toml and determine the package name and lib or bin source file.
-        let cargo_path = proj_root.join("Cargo.toml");
+        let proj_root = cargo_path
+            .canonicalize()?
+            .parent()
+            .ok_or(anyhow!("can't find parent of {:?}", cargo_path))?.to_owned();
         let mut manifest = Manifest::from_path(&cargo_path)?;
-        manifest.complete_from_path(proj_root)?; // try real hard to determine bin or lib
+        manifest.complete_from_path(&proj_root)?; // try real hard to determine bin or lib
         let package = manifest
             .package
             .expect("doctest Cargo.toml must include a [package] section");
@@ -75,7 +79,7 @@ impl ExternArgs {
         self.edition = if let Some(Local(edition)) = package.edition {
             my_display_edition(edition)
         } else {
-            "".to_owned()   // 
+            "".to_owned() //
         };
 
         debug!(
@@ -91,7 +95,7 @@ impl ExternArgs {
             let try_path: PathBuf = proj_root.join("src").join(fname);
             if try_path.exists() {
                 touch(&try_path)?;
-                self.run_cargo(proj_root, &cargo_path)?;
+                self.run_cargo(&proj_root, &cargo_path)?;
                 return Ok(self);
                 // file should be closed when f goes out of scope at bottom of this loop
             }