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

Looks like the unstable book on doc.rust-lang.org isn't being rebuilt? #47394

Closed
carols10cents opened this issue Jan 12, 2018 · 2 comments
Closed
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@carols10cents
Copy link
Member

The unstable book on master has documentation for match_default_bindings that got merged Oct 6, 2017. However, at all 3 of these URLs, the documentation for match_default_bindings is blank:

Which leads me to believe the unstable book isn't getting rebuilt/redeployed/recached at all/correctly?

cc @alexcrichton, @steveklabnik

@carols10cents carols10cents added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. labels Jan 12, 2018
@alexcrichton
Copy link
Member

Probably an artifact of https://github.com/rust-lang/rust/blob/master/src/tools/unstable-book-gen/src/main.rs, I think the filename needs dashes not underscores.

@est31
Copy link
Member

est31 commented Jan 13, 2018

Okay, so putting it all together:

Tidy has a lint that checks all source files of the unstable book whether they correspond to a valid feature. If you put hello.md there, tidy will complain. However, this check does not account for the fact that the generation tool needs dashes instead of underscores.

I think the best solution for this on the Rust side is to change the affected files from underscores to dashes and to enhance the tidy lint to treat underscores as invalid. Expect a PR any moment.

est31 added a commit to est31/rust that referenced this issue Jan 13, 2018
Also rename the existing underscore using files to use dashes.

Fixes rust-lang#47394.
kennytm added a commit to kennytm/rust that referenced this issue Jan 15, 2018
Enforce dashes in the unstable book file names

Also rename the existing underscore using files to use dashes.

Fixes rust-lang#47394.
est31 added a commit to est31/rust that referenced this issue Jan 15, 2018
Previously, any deadlinks from a book's SUMMARY.md wouldn't
cause any errors or warnings or similar but mdbook would simply
create a page with blank content.

This has kept bug rust-lang#47394 hidden. It should have been detected
back in the PR when those wrongly named files got added to the
book.

PR rust-lang#47414 was one component of the solution. This change
is a second line of defense for the unstable book and a first
line of defense for any other book.

We also update mdbook to the most recent version.
kennytm added a commit to kennytm/rust that referenced this issue Jan 23, 2018
…hton

Check for deadlinks from the summary during book generation

Previously, any deadlinks from a book's SUMMARY.md wouldn't
cause any errors or warnings or similar but mdbook would simply
create a page with blank content.

This has kept bug rust-lang#47394 hidden. It should have been detected
back in the PR when those wrongly named files got added to the
book.

PR rust-lang#47414 was one component of the solution. This change
is a second line of defense for the unstable book and a first
line of defense for any other book.

We also update mdbook to the most recent version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants