]> git.proxmox.com Git - cargo.git/commitdiff
chore(ci): Ensure intradoc links are valid
authorEd Page <eopage@gmail.com>
Tue, 6 Sep 2022 14:19:03 +0000 (09:19 -0500)
committerEd Page <eopage@gmail.com>
Tue, 6 Sep 2022 14:27:06 +0000 (09:27 -0500)
.github/workflows/main.yml
src/cargo/lib.rs
src/cargo/ops/fix.rs

index 76092793265d6b5d364ab52b1e5908a3699f78b8..21acb72ef86d9e8fb7316b365906df576ef65201 100644 (file)
@@ -150,7 +150,9 @@ jobs:
         mkdir mdbook
         curl -Lf https://github.com/rust-lang/mdBook/releases/download/v0.4.5/mdbook-v0.4.5-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
         echo `pwd`/mdbook >> $GITHUB_PATH
-    - run: cargo doc --no-deps
+    - run: cargo doc --document-private-items --no-deps
+      env:
+        RUSTDOCFLAGS: -D warnings
     - run: cd src/doc && mdbook build --dest-dir ../../target/doc
     - run: |
         cd src/doc
index e93eae04ce95de6d45443187fded470d0bc62f67..f6aadcce94d501c1237dbfcfcfaf864f2a63a953 100644 (file)
@@ -5,6 +5,7 @@
 // Due to some of the default clippy lints being somewhat subjective and not
 // necessarily an improvement, we prefer to not use them at this time.
 #![allow(clippy::all)]
+#![allow(rustdoc::private_intra_doc_links)]
 
 //! # Cargo as a library
 //!
index 5fb35b8905d28562b280b9b4e6171ece51b15246..d143beb7719e7b833399e4242960a68084f8ba6d 100644 (file)
@@ -348,7 +348,7 @@ pub fn fix_get_proxy_lock_addr() -> Option<String> {
 /// If there are warnings or errors, this does not return,
 /// and the process exits with the corresponding `rustc` exit code.
 ///
-/// See [`fix_proxy_lock_addr`]
+/// See [`fix_get_proxy_lock_addr`]
 pub fn fix_exec_rustc(config: &Config, lock_addr: &str) -> CargoResult<()> {
     let args = FixArgs::get()?;
     trace!("cargo-fix as rustc got file {:?}", args.file);