Skip to content

Commit c4ea4fb

Browse files
authoredSep 4, 2022
Rollup merge of #101322 - ChrisDenton:internal-doc, r=Mark-Simulacrum
Fix internal doc link The doc link from `DedupSortedIter` to `BTreeMap::bulk_build_from_sorted_iter` was broken when building internal documentation, This prevented me from building internal documentation locally: ``` R:\Rust\rust> $env:RUSTDOCFLAGS="--document-private-items" R:\Rust\rust> x doc library/std --open --stage 0 Building rustbuild Compiling bootstrap v0.0.0 (R:\Rust\rust\src\bootstrap) Finished dev [unoptimized] target(s) in 3.15s Documenting stage0 std (x86_64-pc-windows-msvc) Documenting core v0.0.0 (R:\Rust\rust\library\core) Finished release [optimized] target(s) in 36.42s Checking core v0.0.0 (R:\Rust\rust\library\core) Checking rustc-std-workspace-core v1.99.0 (R:\Rust\rust\library\rustc-std-workspace-core) Checking compiler_builtins v0.1.79 Documenting alloc v0.0.0 (R:\Rust\rust\library\alloc) error: unresolved link to `BTreeMap::bulk_build_from_sorted_iter` --> library\alloc\src\collections\btree\dedup_sorted_iter.rs:6:15 | 6 | /// Used by [`BTreeMap::bulk_build_from_sorted_iter`]. | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `BTreeMap` in scope | = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings` error: could not document `alloc` ```
2 parents a2cdcb3 + 835a461 commit c4ea4fb

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed
 

‎library/alloc/src/collections/btree/dedup_sorted_iter.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ use core::iter::Peekable;
33
/// A iterator for deduping the key of a sorted iterator.
44
/// When encountering the duplicated key, only the last key-value pair is yielded.
55
///
6-
/// Used by [`BTreeMap::bulk_build_from_sorted_iter`].
6+
/// Used by [`BTreeMap::bulk_build_from_sorted_iter`][1].
7+
///
8+
/// [1]: crate::collections::BTreeMap::bulk_build_from_sorted_iter
79
pub struct DedupSortedIter<K, V, I>
810
where
911
I: Iterator<Item = (K, V)>,

‎src/ci/docker/host-x86_64/mingw-check/Dockerfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ ENV SCRIPT python3 ../x.py --stage 2 test src/tools/expand-yaml-anchors && \
4545
python3 ../x.py test --stage 0 src/tools/compiletest && \
4646
python3 ../x.py test --stage 2 src/tools/tidy && \
4747
python3 ../x.py test --stage 0 core alloc std test proc_macro && \
48-
python3 ../x.py doc --stage 0 library/test && \
48+
# Build both public and internal documentation.
49+
RUSTDOCFLAGS="--document-private-items" python3 ../x.py doc --stage 0 library/test && \
4950
/scripts/validate-toolstate.sh && \
5051
/scripts/validate-error-codes.sh && \
5152
reuse lint && \

0 commit comments

Comments
 (0)