]> git.proxmox.com Git - cargo.git/commitdiff
Fix documenting with undocumented dependencies.
authorEric Huss <eric@huss.org>
Tue, 25 Jan 2022 01:10:05 +0000 (17:10 -0800)
committerEric Huss <eric@huss.org>
Tue, 25 Jan 2022 01:10:05 +0000 (17:10 -0800)
src/cargo/core/compiler/unit_dependencies.rs
tests/testsuite/doc.rs

index a3bcecc178244da8e5629d4980394bdfa8769c8f..c2575fd77f181cded9abdbb34f2e54d7134ccfbb 100644 (file)
@@ -431,7 +431,7 @@ fn compute_deps_doc(
     let mut ret = Vec::new();
     for (id, _deps) in deps {
         let dep = state.get(id);
-        let lib = match dep.targets().iter().find(|t| t.is_lib() && t.documented()) {
+        let lib = match dep.targets().iter().find(|t| t.is_lib()) {
             Some(lib) => lib,
             None => continue,
         };
@@ -449,18 +449,20 @@ fn compute_deps_doc(
             mode,
         )?;
         ret.push(lib_unit_dep);
-        if let CompileMode::Doc { deps: true } = unit.mode {
-            // Document this lib as well.
-            let doc_unit_dep = new_unit_dep(
-                state,
-                unit,
-                dep,
-                lib,
-                dep_unit_for,
-                unit.kind.for_target(lib),
-                unit.mode,
-            )?;
-            ret.push(doc_unit_dep);
+        if lib.documented() {
+            if let CompileMode::Doc { deps: true } = unit.mode {
+                // Document this lib as well.
+                let doc_unit_dep = new_unit_dep(
+                    state,
+                    unit,
+                    dep,
+                    lib,
+                    dep_unit_for,
+                    unit.kind.for_target(lib),
+                    unit.mode,
+                )?;
+                ret.push(doc_unit_dep);
+            }
         }
     }
 
index 869e4f3342faadbcaffb25c39d8bbd4664f89edd..da500d4a1d4785a3745b1c0e9f59434ec12fc7ab 100644 (file)
@@ -2557,7 +2557,7 @@ fn doc_lib_false() {
                 bar = {path = "bar"}
             "#,
         )
-        .file("src/lib.rs", "")
+        .file("src/lib.rs", "extern crate bar;")
         .file("src/bin/some-bin.rs", "fn main() {}")
         .file(
             "bar/Cargo.toml",
@@ -2588,3 +2588,48 @@ fn doc_lib_false() {
     assert!(!p.build_dir().join("doc/bar").exists());
     assert!(p.build_dir().join("doc/some_bin").exists());
 }
+
+#[cargo_test]
+fn doc_lib_false_dep() {
+    // doc = false for a dependency
+    // Ensures that the rmeta gets produced
+    let p = project()
+        .file(
+            "Cargo.toml",
+            r#"
+                [package]
+                name = "foo"
+                version = "0.1.0"
+
+                [dependencies]
+                bar = { path = "bar" }
+            "#,
+        )
+        .file("src/lib.rs", "extern crate bar;")
+        .file(
+            "bar/Cargo.toml",
+            r#"
+                [package]
+                name = "bar"
+                version = "0.1.0"
+
+                [lib]
+                doc = false
+            "#,
+        )
+        .file("bar/src/lib.rs", "")
+        .build();
+
+    p.cargo("doc")
+        .with_stderr(
+            "\
+[CHECKING] bar v0.1.0 [..]
+[DOCUMENTING] foo v0.1.0 [..]
+[FINISHED] [..]
+",
+        )
+        .run();
+
+    assert!(p.build_dir().join("doc/foo").exists());
+    assert!(!p.build_dir().join("doc/bar").exists());
+}