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.

Sign up for GitHub

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

Fix links pointing to std_detect #96519

Closed
wants to merge 1 commit into from
Closed

Fix links pointing to std_detect #96519

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/bootstrap/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,10 @@ impl Step for Std {
.arg("--resource-suffix")
.arg(&builder.version)
.arg("--index-page")
.arg(&builder.src.join("src/doc/index.md"));
.arg(&builder.src.join("src/doc/index.md"))
.arg("--extern-html-root-url")
.arg("std_detect=https://docs.rs/std_detect/0.1.5/")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version will eventually be changed, and this can lead to some hard to detect errors.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is exactly why I specify a version: otherwise older std docs version will always point to the latest std_detect version and that will very likely be completely wrong.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we can check version of crate via metadata and fail if it not equal hardcoded one.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can extract the version from the libstd Cargo.toml file I guess...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cargo_metadata crate should work, i guess.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is std_detect not added to the list of crates we document?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea. Should it be part of the crates documented?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe - it seems like a likely easy and correct way to expose it's documentation/source. There's a policy question of whether we should do that - it would probably be a reasonable stance that it's not part of the stable surface area so showing search results (for example) from it isn't appropriate. Perhaps rustdoc shouldn't render the src link in this case.

But I think this PR is almost certainly the wrong approach - if we want to not include it in search results but include links to it, there's probably a way to order the builds and later combine them or something like that to accomplish that.

.arg("--extern-html-root-takes-precedence");

if !builder.config.docs_minification {
cargo.arg("--disable-minification");
Expand Down