Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rustdoc integration #105

Open
4 tasks
jyn514 opened this issue Nov 19, 2020 · 7 comments
Open
4 tasks

Rustdoc integration #105

jyn514 opened this issue Nov 19, 2020 · 7 comments
Assignees
Labels
C-enhancement Category: This is a new feature C-tracking Category: This is a tracking issue
Milestone

Comments

@jyn514
Copy link
Contributor

jyn514 commented Nov 19, 2020

It would be great to add deadlinks to rustdoc itself! That would increase discoverability a ton, and I expect it would uncover a bunch more bugs in rustdoc too. It would also allow getting rid of the linkchecker in the rust repo.

As a bonus, rustdoc does know how it generates the links, so this might allow fixing #14 (comment) at the same time.

@jyn514 jyn514 added C-enhancement Category: This is a new feature C-tracking Category: This is a tracking issue labels Nov 19, 2020
@jyn514 jyn514 self-assigned this Nov 19, 2020
@jyn514 jyn514 added this to the Post-1.0 milestone Nov 19, 2020
jyn514 added a commit to jyn514/cargo-deadlinks that referenced this issue Jan 19, 2021
This will be useful for rustdoc
(deadlinks#105).
@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

Hmm, unfortunately some of the licenses in lol_html's dependencies are not MIT or Apache:

tidy error: invalid license `MPL-2.0` in `cssparser 0.25.9 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: invalid license `MPL-2.0` in `cssparser-macros 0.3.6 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: invalid license `MPL-2.0` in `dtoa-short 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: dependency `fuchsia-cprng 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)` does not define a license expression
tidy error: invalid license `BSD-3-Clause` in `lol_html 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: invalid license `ISC` in `rdrand 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: invalid license `MPL-2.0` in `selectors 0.21.0 (registry+https://github.com/rust-lang/crates.io-index)`
tidy error: invalid license `MPL-2.0` in `thin-slice 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)`

@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

Note that is blocked on rust-lang/rust#80527, but I expect figuring out the dependencies will take long enough that will be merged before I have to worry about it.

@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

I guess as a last resort I could make deadlinks generic over the parser and slot in https://github.com/rust-lang/rust/blob/94e6ea9fc97845b336067bffb3d103780474f6f5/src/tools/linkchecker/main.rs#L406 somehow, but that really seems like a hack, parsing HTML with regex is never a good idea.

@jyn514
Copy link
Contributor Author

jyn514 commented Jan 19, 2021

Oh I'm being silly - html5ever meets all the licenses. So I can make deadlinks generic over the parser and slot in HTML5ever for rust-lang/rust.

@jyn514
Copy link
Contributor Author

jyn514 commented Nov 27, 2022

Finally got a response about licensing, other tools already use the licenses so it shouldn't be a problem: https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Is.20there.20an.20approved.20HTML.20parser.3F/near/312418703

Mark did suggest that this doesn't necessarily need to be part of rustdoc, and that a cargo fix lint to migrate from manual links to intra-doc links might be more helpful. I'm going to try and make a crater run with https://github.com/rust-lang/rust/compare/master...jyn514:rust:linkcheck?expand=1 to see how useful it will be in practice, but I'm probably inclined to agree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: This is a new feature C-tracking Category: This is a tracking issue
Projects
None yet
Development

No branches or pull requests

1 participant