Skip to content

Commit

Permalink
Remove "cargo deadlinks" check (#403)
Browse files Browse the repository at this point in the history
I have found this tool not *that* useful in preventing mistakes in API
documentation, but it adds quite a considerable chunk to the build time
of a development environment. I don't really want developers to wait
5-15 minutes to download and build all the dependencies just to have
a check which passes 99% of time.

We may reconsider this decision later if we actually run into issues
with dead links in API docs.
  • Loading branch information
ilammy authored and shadinua committed Mar 1, 2019
1 parent e86a872 commit bf46abe
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 2 deletions.
1 change: 0 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ jobs:
- run: curl https://sh.rustup.rs -sSf | sh -s -- -y && cat ~/.cargo/env >> $BASH_ENV && source ~/.cargo/env && cargo --version && rustc --version
- run: rustup component add clippy
- run: rustup component add rustfmt
- run: cargo deadlinks --version || cargo install cargo-deadlinks

# download last valgrind because current version of valgrind on ubuntu (3.11.0) gives false positive errors
# link from http://valgrind.org/downloads/current.html
Expand Down
1 change: 0 additions & 1 deletion tests/rust/run_tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ echo "Checking documentation..."
echo
cargo clean --doc && cargo doc --no-deps
cargo clean --doc && cargo doc --no-deps --features "vendored"
cargo deadlinks

echo
echo "Rust tests OK!"
Expand Down

0 comments on commit bf46abe

Please sign in to comment.