[WIP] Add cargo-deadlinks to CI #1078
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
This found a bunch more broken links, even after the changes in #1077. Broken linksThey're mostly coming from inline |
This one is weird - wasn't |
This is also weird ... it's a dependency so maybe it should be ignored? I need to look into the root cause, it might be a rustdoc bug. |
Possibly, but I wouldn't be surprised if I forgot to fix that link. |
jyn514
force-pushed
the
deadlinks
branch
2 times, most recently
from
f13e2db
to
301ef7d
Compare
|
I found the issue: there are a bunch of |
jyn514
force-pushed
the
deadlinks
branch
2 times, most recently
from
f9448c6
to
eb88759
Compare
davidbarsky
reviewed
Nov 15, 2020
tracing-serde/src/lib.rs
Outdated
| @@ -6,7 +6,7 @@ | |||
| //! [![Documentation (master)][docs-master-badge]][docs-master-url] | |||
| //! | |||
| //! [docs-badge]: https://docs.rs/tracing-serde/badge.svg | |||
| //! [docs-url]: https://docs.rs/tracing-serde | |||
| //! [docs-url]: crate | |||
There was a problem hiding this comment.
What does crate mean here? I looked over the RFC (https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md) and I don't see it defined.
There was a problem hiding this comment.
It's a normal rust path: it means 'the crate this link is defined in', since crates don't know their own names. It will go to https://docs.rs/tracing-serde on docs.rs and to the crate root when you document locally.
There was a problem hiding this comment.
It is documented on https://doc.rust-lang.org/nightly/rustdoc/linking-to-items-by-name.html if that helps.
There was a problem hiding this comment.
Oh, thanks for the details!
davidbarsky
approved these changes
Nov 15, 2020
|
@davidbarsky sorry, I haven't been keeping the status up to date - this isn't ready for review and won't be for a while because of all the broken links: I haven't looked in detail why the links are broken, if you want to fix them in parallel be my guest :P |
|
@jyn514 Gotcha, no worries. I didn't see an issue on cargo-deadlinks to print out the locations of broken links. Do you want me to open an issue there about that? |
|
There's an issue: deadlinks/cargo-deadlinks#14. The tricky thing is there's no simple way to reconstruct the original location from the generated docs, that requires knowledge of rustdoc internals: deadlinks/cargo-deadlinks#14 (comment) |
- Use --cfg docsrs - Only check dependencies - Pass --all-features
|
I won't have time to work on this in the near future. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Make sure that the generated documentation doesn't have broken links (#1077 (comment)).
Solution
Use
cargo deadlinksto check all the links automatically.This doesn't use
--check-httpsince that takes a while to run (and can lead to spurious failures), but I can add it if you're interested.