Skip to content

Commit

Permalink
Merge #18: Add -j1 to docs build invocation
Browse files Browse the repository at this point in the history
9766b0d Add -j1 to docs build invocation (Tobin C. Harding)

Pull request description:

  After upgrade of `hashes` but before we upgrade it in `secp` we get multiple versions in the dep tree. This makes the docs build choke because output directory uses the name of the crate (without the version) which then conflicts and causes the build to fail.

  Adding `-j1` so that only a single job is run when building the docs resolves the issue.

ACKs for top commit:
  apoelstra:
    utACK 9766b0d

Tree-SHA512: 8851f9d1ae7402577a1fa3b773c2caa8800adf214b94fd7140ec4599685377b7a5b1a222c34bdefbd812020c4896fafaa348b4fd20594c12ddc0191a14e588e3
  • Loading branch information
apoelstra committed Nov 4, 2024
2 parents 906ffd4 + 9766b0d commit 4f17a05
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions ci/run_task.sh
Original file line number Diff line number Diff line change
Expand Up @@ -273,14 +273,15 @@ do_dup_deps() {
# below this checks that we feature guarded docs imports correctly.
build_docs_with_nightly_toolchain() {
need_nightly
RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" $cargo doc --all-features
# -j1 is because docs build fails if multiple versions of `bitcoin_hashes` are present in dep tree.
RUSTDOCFLAGS="--cfg docsrs -D warnings -D rustdoc::broken-intra-doc-links" $cargo doc --all-features -j1
}

# Build the docs with a stable toolchain, in unison with the function
# above this checks that we feature guarded docs imports correctly.
build_docs_with_stable_toolchain() {
local cargo="cargo +stable --locked" # Can't use global because of `+stable`.
RUSTDOCFLAGS="-D warnings" $cargo doc --all-features
RUSTDOCFLAGS="-D warnings" $cargo doc --all-features -j1
}

# Bench only works with a non-stable toolchain (nightly, beta).
Expand Down

0 comments on commit 4f17a05

Please sign in to comment.