rustbuild: Build documentation for `proc_macro` by alexcrichton · Pull Request #40199 · rust-lang/rust

alexcrichton · 2017-03-01T23:47:19Z

This commit fixes#38749 by building documentation for the proc_macro crate by
default for configured hosts. Unfortunately did not turn out to be a trivial
fix. Currently rustbuild generates documentation into multiple locations: one
for std, one for test, and one for rustc. The initial fix for this issue simply
actually executed cargo doc -p proc_macro which was otherwise completely
elided before.

Unfortunately rustbuild was the left to merge two documentation trees together.
One for the standard library and one for the rustc tree (which only had docs for
the proc_macro crate). Rustdoc itself knows how to merge documentation files
(specifically around search indexes, etc) but rustbuild was unaware of this, so
an initial fix ended up destroying the sidebar and the search bar from the
libstd docs.

To solve this issue the method of documentation has been tweaked slightly in
rustbuild. The build system will not use symlinks (or directory junctions on
Windows) to generate all documentation into the same location initially. This'll
rely on rustdoc's logic to weave together all the output and ensure that it ends
up all consistent.

Closes#38749

rust-highfive · 2017-03-01T23:47:23Z

r? @aturon

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

brson · 2017-03-01T23:49:59Z

Please add a comment explaining what the symlinks are doing. r=me after

alexcrichton · 2017-03-01T23:50:36Z

@bors: r=brson

bors · 2017-03-01T23:50:37Z

📌 Commit 96965e6 has been approved by brson

TimNN · 2017-03-02T06:26:22Z

This has a (legitimate, as far as I can tell) travis failure (symlink already exists).

alexcrichton · 2017-03-02T17:27:57Z

@bors: r-

alexcrichton · 2017-03-02T21:08:12Z

@bors: r=brson

bors · 2017-03-02T21:08:13Z

📌 Commit 3263f26 has been approved by brson

alexcrichton · 2017-03-02T22:22:16Z

@bors: r=brson

bors · 2017-03-02T22:22:17Z

📌 Commit 3c011f3 has been approved by brson

frewsxcv · 2017-03-03T00:28:15Z

Might be relevant to this error? #40218 (comment)

bors · 2017-03-03T12:17:23Z

⌛ Testing commit 3c011f3 with merge 4ff8e43...

bors · 2017-03-03T13:12:06Z

💔 Test failed - status-travis

alexcrichton · 2017-03-03T16:39:15Z

@frewsxcv heh, yes :)

@bors: r=brson

bors · 2017-03-03T16:39:16Z

📌 Commit 6f7b9e7 has been approved by brson

bors · 2017-03-04T05:18:15Z

⌛ Testing commit 6f7b9e7 with merge 6ae1b94...

bors · 2017-03-04T05:44:09Z

💔 Test failed - status-travis

frewsxcv · 2017-03-06T01:38:46Z

@bors retry

sccache failure Spurious failures in sccache #40240

bors · 2017-03-06T02:18:14Z

🔒 Merge conflict

rustbuild: Build documentation for `proc_macro` This commit fixesrust-lang#38749 by building documentation for the `proc_macro` crate by default for configured hosts. Unfortunately did not turn out to be a trivial fix. Currently rustbuild generates documentation into multiple locations: one for std, one for test, and one for rustc. The initial fix for this issue simply actually executed `cargo doc -p proc_macro` which was otherwise completely elided before. Unfortunately rustbuild was the left to merge two documentation trees together. One for the standard library and one for the rustc tree (which only had docs for the `proc_macro` crate). Rustdoc itself knows how to merge documentation files (specifically around search indexes, etc) but rustbuild was unaware of this, so an initial fix ended up destroying the sidebar and the search bar from the libstd docs. To solve this issue the method of documentation has been tweaked slightly in rustbuild. The build system will not use symlinks (or directory junctions on Windows) to generate all documentation into the same location initially. This'll rely on rustdoc's logic to weave together all the output and ensure that it ends up all consistent. Closesrust-lang#38749

This commit fixesrust-lang#38749 by building documentation for the `proc_macro` crate by default for configured hosts. Unfortunately did not turn out to be a trivial fix. Currently rustbuild generates documentation into multiple locations: one for std, one for test, and one for rustc. The initial fix for this issue simply actually executed `cargo doc -p proc_macro` which was otherwise completely elided before. Unfortunately rustbuild was the left to merge two documentation trees together. One for the standard library and one for the rustc tree (which only had docs for the `proc_macro` crate). Rustdoc itself knows how to merge documentation files (specifically around search indexes, etc) but rustbuild was unaware of this, so an initial fix ended up destroying the sidebar and the search bar from the libstd docs. To solve this issue the method of documentation has been tweaked slightly in rustbuild. The build system will not use symlinks (or directory junctions on Windows) to generate all documentation into the same location initially. This'll rely on rustdoc's logic to weave together all the output and ensure that it ends up all consistent. Closesrust-lang#38749

alexcrichton · 2017-03-10T21:05:05Z

@bors: r=brson

bors · 2017-03-10T21:05:06Z

📌 Commit f846aaf has been approved by brson

rustbuild: Build documentation for `proc_macro` This commit fixesrust-lang#38749 by building documentation for the `proc_macro` crate by default for configured hosts. Unfortunately did not turn out to be a trivial fix. Currently rustbuild generates documentation into multiple locations: one for std, one for test, and one for rustc. The initial fix for this issue simply actually executed `cargo doc -p proc_macro` which was otherwise completely elided before. Unfortunately rustbuild was the left to merge two documentation trees together. One for the standard library and one for the rustc tree (which only had docs for the `proc_macro` crate). Rustdoc itself knows how to merge documentation files (specifically around search indexes, etc) but rustbuild was unaware of this, so an initial fix ended up destroying the sidebar and the search bar from the libstd docs. To solve this issue the method of documentation has been tweaked slightly in rustbuild. The build system will not use symlinks (or directory junctions on Windows) to generate all documentation into the same location initially. This'll rely on rustdoc's logic to weave together all the output and ensure that it ends up all consistent. Closesrust-lang#38749

Rollup of 38 pull requests - Successful merges: #39202, #39820, #39918, #39921, #40092, #40146, #40199, #40225, #40239, #40257, #40259, #40261, #40277, #40278, #40287, #40297, #40311, #40315, #40319, #40324, #40336, #40340, #40344, #40345, #40367, #40369, #40372, #40373, #40379, #40385, #40386, #40389, #40400, #40404, #40410, #40422, #40423, #40424 - Failed merges: #40220, #40329, #40426

bors · 2017-03-11T11:42:13Z

⌛ Testing commit f846aaf with merge 5d0be0d...

rustbuild: Build documentation for `proc_macro` This commit fixes#38749 by building documentation for the `proc_macro` crate by default for configured hosts. Unfortunately did not turn out to be a trivial fix. Currently rustbuild generates documentation into multiple locations: one for std, one for test, and one for rustc. The initial fix for this issue simply actually executed `cargo doc -p proc_macro` which was otherwise completely elided before. Unfortunately rustbuild was the left to merge two documentation trees together. One for the standard library and one for the rustc tree (which only had docs for the `proc_macro` crate). Rustdoc itself knows how to merge documentation files (specifically around search indexes, etc) but rustbuild was unaware of this, so an initial fix ended up destroying the sidebar and the search bar from the libstd docs. To solve this issue the method of documentation has been tweaked slightly in rustbuild. The build system will not use symlinks (or directory junctions on Windows) to generate all documentation into the same location initially. This'll rely on rustdoc's logic to weave together all the output and ensure that it ends up all consistent. Closes#38749

bors · 2017-03-11T13:55:04Z

☀️ Test successful - status-appveyor, status-travis
Approved by: brson
Pushing 5d0be0d to master...

rust-highfive assigned aturon Mar 1, 2017

alexcrichton force-pushed the doc-proc-macro branch from 5d466d2 to 96965e6Compare March 1, 2017 23:49

alexcrichton force-pushed the doc-proc-macro branch from 96965e6 to 3263f26Compare March 2, 2017 21:08

alexcrichton force-pushed the doc-proc-macro branch from 3263f26 to 3c011f3Compare March 2, 2017 22:22

frewsxcv mentioned this pull request Mar 2, 2017
Rollup of 6 pull requests #40218
Closed

alexcrichton force-pushed the doc-proc-macro branch from 3c011f3 to 6f7b9e7Compare March 3, 2017 16:38

alexcrichton force-pushed the doc-proc-macro branch from 6f7b9e7 to eeb7af6Compare March 6, 2017 16:47

alexcrichton mentioned this pull request Mar 10, 2017
Rollup of 35 pull requests #40420
Closed

arielb1 mentioned this pull request Mar 10, 2017
Rollup of 24 pull requests #40427
Closed

alexcrichton force-pushed the doc-proc-macro branch from 2b5f1b2 to f846aafCompare March 10, 2017 21:04

arielb1 mentioned this pull request Mar 10, 2017
Rollup of 26 pull requests #40428
Closed

arielb1 mentioned this pull request Mar 10, 2017
Rollup of 29 pull requests #40429
Closed

alexcrichton mentioned this pull request Mar 10, 2017
Rollup of 38 pull requests #40432
Merged

bors merged commit f846aaf into rust-lang:masterMar 11, 2017

alexcrichton deleted the doc-proc-macro branch March 11, 2017 16:29

ollie27 mentioned this pull request Mar 12, 2017
rustbuild: doc-rustc overwrites search index #34800
Closed

Uh oh!

Uh oh!

Conversation

alexcrichton commented Mar 1, 2017

Uh oh!

rust-highfive commented Mar 1, 2017

Uh oh!

brson commented Mar 1, 2017

Uh oh!

alexcrichton commented Mar 1, 2017

Uh oh!

bors commented Mar 1, 2017

Uh oh!

TimNN commented Mar 2, 2017

Uh oh!

alexcrichton commented Mar 2, 2017

Uh oh!

alexcrichton commented Mar 2, 2017

Uh oh!

bors commented Mar 2, 2017

Uh oh!

alexcrichton commented Mar 2, 2017

Uh oh!

bors commented Mar 2, 2017

Uh oh!

frewsxcv commented Mar 3, 2017

Uh oh!

bors commented Mar 3, 2017

Uh oh!

bors commented Mar 3, 2017

Uh oh!

alexcrichton commented Mar 3, 2017

Uh oh!

bors commented Mar 3, 2017

Uh oh!

bors commented Mar 4, 2017

Uh oh!

bors commented Mar 4, 2017

Uh oh!

frewsxcv commented Mar 6, 2017• edited by alexcrichton Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bors commented Mar 6, 2017

Uh oh!

alexcrichton commented Mar 10, 2017

Uh oh!

bors commented Mar 10, 2017

Uh oh!

bors commented Mar 11, 2017

Uh oh!

bors commented Mar 11, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

frewsxcv commented Mar 6, 2017•
edited by alexcrichton
Loading