Skip to content

Rustdoc: Use the extern item-path for documentation links #30149

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

Jump to bottom
Merged
merged 2 commits into from
Dec 4, 2015
Merged

Rustdoc: Use the extern item-path for documentation links #30149

merged 2 commits into from
Dec 4, 2015

Conversation

mitaa
Copy link
Contributor

@mitaa mitaa commented Dec 1, 2015

Fixes #30109

@rust-highfive
Copy link
Contributor

r? @nikomatsakis

(rust_highfive has picked a reviewer for you, use r? to override)

@mitaa
Copy link
Contributor Author

mitaa commented Dec 1, 2015

I used a run-make test because docs for the extern crate need to be generated beforehand, otherwise the cross-crate link isn't being generated.

@alexcrichton
Copy link
Member

Could this perhaps be a src/test/rustdoc test with some modifications to the compiletest driver? Perhaps something like // run-rustdoc which indicates that the documentation of an aux-build file should be generated as well?

@mitaa
Add a build-aux-docs directive to compiletest
14f504c 
This flag causes the documentation for all `aux-build` files to
be built, which happens prior to running/building the parent test.
@mitaa mitaa force-pushed the fqn branch 2 times, most recently from bd1bedd to 5496588 Compare December 3, 2015 22:10
@mitaa
Use the extern item-path for documentation links
af1ad41 
The local item-path includes the local crates path to the extern crate
declaration which breaks cross-crate rustdoc links if the extern crate
is not linked into the crate root or renamed via `extern foo as bar`.
@mitaa
Copy link
Contributor Author

mitaa commented Dec 3, 2015

(updated)

@alexcrichton
Copy link
Member

@bors: r+ af1ad41

Thanks!

bors added a commit that referenced this pull request Dec 3, 2015
@bors
Auto merge of #30149 - mitaa:fqn, r=alexcrichton
c7d5832 
Fixes #30109
@bors
Copy link
Collaborator

bors commented Dec 3, 2015

⌛ Testing commit af1ad41 with merge c7d5832...

@bors
Copy link
Collaborator

bors commented Dec 4, 2015

☀️ Test successful - auto-linux-32-nopt-t, auto-linux-32-opt, auto-linux-64-debug-opt, auto-linux-64-nopt-t, auto-linux-64-opt, auto-linux-64-x-android-t, auto-linux-cross-opt, auto-linux-musl-64-opt, auto-mac-32-opt, auto-mac-64-nopt-t, auto-mac-64-opt, auto-win-gnu-32-nopt-t, auto-win-gnu-32-opt, auto-win-gnu-64-nopt-t, auto-win-gnu-64-opt, auto-win-msvc-32-opt, auto-win-msvc-64-opt

@bors bors merged commit af1ad41 into rust-lang:master Dec 4, 2015
@mitaa mitaa deleted the fqn branch December 4, 2015 07:04
This was referenced Dec 4, 2015
Closed
Merged
bors added a commit that referenced this pull request Dec 6, 2015
@bors
Auto merge of #30222 - mitaa:fqn#2, r=alexcrichton
3ffc6f0 
I missed this in #30149

fixes #30198

r? @alexcrichton
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@alexcrichton alexcrichton

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mitaa @rust-highfive @alexcrichton @bors @nikomatsakis