Update book by steveklabnik · Pull Request #47753 · rust-lang/rust

steveklabnik · 2018-01-25T20:59:16Z

This PR does two things:

update the book to include Improve redirects book#1088
update to mdbook 0.1

Both of these things are big changes, so I want to land them now, well before the next branch, so we can kick the tires.

Locally, I'm seeing some weirdness around the reference and this:

Putting this PR up so others can try and build and see if it reproduces for them.

rust-highfive · 2018-01-25T20:59:26Z

r? @alexcrichton

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

alexcrichton · 2018-01-25T21:20:35Z

in terms of r+, r=me whenever this is good to go! I imagine though @rust-lang/docs may wish to help out with the investigation

QuietMisdreavus · 2018-01-25T23:21:45Z

I can confirm the reference rendering strangely. There's an open PR on the reference that might help with this; should we merge that first and update it here?

Michael-F-Bryan · 2018-01-26T04:07:25Z

You'll probably want to make sure each document's book.toml is updated too. We changed the configuration file format around a bit, but there's a legacy shim which will try to detect when you're using the old format and use that, emitting a warning with instructions on how to update.

Let me know if there's anything we can do from mdbook's end!

steveklabnik · 2018-01-26T18:22:50Z

This will fail until rust-lang/mdBook#585 is in an mdbook release.

steveklabnik · 2018-01-27T15:37:35Z

this should be good to go now 🎊

alexcrichton · 2018-01-27T18:32:45Z

Looks like Travis may be failing?

steveklabnik · 2018-01-27T20:54:05Z

Hm. very odd.

[00:42:55] An error occured:
[00:42:55] Rendering failed

not super helpful...

Michael-F-Bryan · 2018-01-28T07:37:49Z

not super helpful...

Lol. We're using error-chain and chain_err() to give an error more context. If you print out the causes then it'll tell you what went wrong, we currently have a helper in mdbook for exactly this:

/// Prints a "backtrace" of some `Error`.pubfnlog_backtrace(e:&Error){error!("Error: {}", e);for cause in e.iter().skip(1){error!("\tCaused By: {}", cause);}}

steveklabnik · 2018-01-28T16:29:15Z

@Michael-F-Bryan yeah, sorry, I typed that in haste; this behavior is totally reasonable!

I've pushed a commit that uses this, let's see what it says (the build succeeds for me locally)

steveklabnik · 2018-01-28T17:15:59Z

i was able to reproduce locally, and this is what I have:

Error: Rendering failed
Caused By: Unable to copy across additional CSS and JS
Caused By: Unable to copy theme/reference.css to C:\Users\steve\src\rs\build\x86_64-pc-windows-msvc\doc\reference\theme/reference.css
Caused By: The system cannot find the path specified. (os error 3)

this make sense as to why it's only the reference that fails.

note that C:\Users\steve\src\rs\build\x86_64-pc-windows-msvc\doc\reference\theme/ does exist, this makes me think it's theme/reference.css that doesn't. but that does too: src\doc\reference\theme\reference.css is there.

i wonder if this is an mdbook bug, not respecting the path when passed in -d? that is, the error is just printing theme/reference.css, without the prefix and that makes me suspicious.

steveklabnik · 2018-01-28T19:09:10Z

Yes, this is the answer, I believe. The reference has theme/reference.css in its config, which is then un-modified by mdbook, leading to it not respecting -d. working on an mdbook patch now

Before, when someone like the Reference set their extra css as "theme/reference.css" in their book.toml, this path would be treated as relative to the invocation of mdbook, and not respect the input path. This PR modifies these relative paths to do so. Fixes the build of rust-lang/rust#47753 which blocks updating rustc to mdbook 0.1

steveklabnik · 2018-01-28T19:30:26Z

rust-lang/mdBook#598

steveklabnik · 2018-01-28T19:50:12Z

confirmed the fix locally, but pushed a commit up here to check on the builders too

we'll need an mdbook release in order to ship this

steveklabnik · 2018-01-28T22:24:40Z

well, uh looks like that's another bug: https://travis-ci.org/rust-lang/rust/builds/334450214#L2554

steveklabnik · 2018-01-30T03:35:22Z

okay! I'm going to wait until the release ships, and then rebase this to be more reasonable.

steveklabnik · 2018-02-03T02:14:38Z

Why is it invalid? In that we don't accept MPL based code? I was pretty sure we had some already... and it would be kinda weird to reject Mozilla's license, heh.

kennytm · 2018-02-03T03:55:30Z

@steveklabnik it would be invalid if these packages were used by the standard library since it should be strictly MIT/Apache2. As these are only used for generating the book, you can add exceptions to tidy by editing https://github.com/rust-lang/rust/blob/master/src/tools/tidy/src/deps.rs

Rollup of 10 pull requests - Successful merges: #46156, #47829, #47842, #47898, #47914, #47916, #47919, #47942, #47951, #47973 - Failed merges: #47753

steveklabnik · 2018-02-03T16:00:55Z

new commit pushed, that look correct? :)

kennytm · 2018-02-03T16:04:47Z

@bors r=alexcrichton

bors · 2018-02-03T16:04:47Z

📌 Commit abb162c has been approved by alexcrichton

…chton Update book This PR does two things: 1. update the book to include rust-lang/book#1088 2. update to mdbook 0.1 Both of these things are big changes, so I want to land them now, well before the next branch, so we can kick the tires. ------------------------------ Locally, I'm seeing some weirdness around the reference and this: ![image](https://user-images.githubusercontent.com/27786/35411917-8dcbb31a-01e8-11e8-8c30-0bd280d93b9d.png) Putting this PR up so others can try and build and see if it reproduces for them.

Rollup of 9 pull requests - Successful merges: #47753, #47862, #47877, #47896, #47912, #47944, #47947, #47978, #47958 - Failed merges:

…chton Update book This PR does two things: 1. update the book to include rust-lang/book#1088 2. update to mdbook 0.1 Both of these things are big changes, so I want to land them now, well before the next branch, so we can kick the tires. ------------------------------ Locally, I'm seeing some weirdness around the reference and this: ![image](https://user-images.githubusercontent.com/27786/35411917-8dcbb31a-01e8-11e8-8c30-0bd280d93b9d.png) Putting this PR up so others can try and build and see if it reproduces for them.

bors · 2018-02-04T15:07:35Z

☔ The latest upstream changes (presumably #47991) made this pull request unmergeable. Please resolve the merge conflicts.

Includes rust-lang/book#1088 and rust-lang/book@62210e3

and improve printing of errors

steveklabnik · 2018-02-04T20:48:13Z

@bors r=alexcrichton

bors · 2018-02-04T20:48:13Z

📌 Commit 983cc00 has been approved by alexcrichton

…chton Update book This PR does two things: 1. update the book to include rust-lang/book#1088 2. update to mdbook 0.1 Both of these things are big changes, so I want to land them now, well before the next branch, so we can kick the tires. ------------------------------ Locally, I'm seeing some weirdness around the reference and this: ![image](https://user-images.githubusercontent.com/27786/35411917-8dcbb31a-01e8-11e8-8c30-0bd280d93b9d.png) Putting this PR up so others can try and build and see if it reproduces for them.

Rollup of 10 pull requests - Successful merges: #46030, #47496, #47543, #47704, #47753, #47807, #47948, #47959, #48003, #48007 - Failed merges:

* Handle input path with regards to custom css Before, when someone like the Reference set their extra css as "theme/reference.css" in their book.toml, this path would be treated as relative to the invocation of mdbook, and not respect the input path. This PR modifies these relative paths to do so. Fixes the build of rust-lang/rust#47753 which blocks updating rustc to mdbook 0.1 * don't use file-name the style name is theme/reference.css, this results in a Err(StripPrefixError(())), which means that we push only the file_name, losing the theme bit

rust-highfive assigned alexcrichton Jan 25, 2018

kennytm added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 25, 2018

steveklabnik force-pushed the update-book branch 2 times, most recently from a9268e3 to 33b32f0Compare January 26, 2018 17:33

steveklabnik force-pushed the update-book branch from 33b32f0 to d319ba2Compare January 27, 2018 15:13

steveklabnik added the relnotes Marks issues that should be documented in the release notes of the next release. label Jan 27, 2018

steveklabnik force-pushed the update-book branch 2 times, most recently from 7fe8313 to dd32a11Compare January 28, 2018 16:34

steveklabnik mentioned this pull request Jan 28, 2018
Handle input path with regards to custom css rust-lang/mdBook#598
Merged

kennytm added S-blocked Status: Blocked on something else such as an RFC or other implementation work. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jan 28, 2018

steveklabnik force-pushed the update-book branch from dd32a11 to 84f2111Compare January 28, 2018 19:38

kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Feb 2, 2018

bors added a commit that referenced this pull request Feb 3, 2018
Auto merge of#47962- kennytm:rollup, r=kennytm
8d04b8f
Rollup of 10 pull requests - Successful merges: #46156, #47829, #47842, #47898, #47914, #47916, #47919, #47942, #47951, #47973 - Failed merges: #47753

kennytm mentioned this pull request Feb 3, 2018
Rollup of 9 pull requests #47984
Closed

bors added a commit that referenced this pull request Feb 3, 2018
Auto merge of#47984- kennytm:rollup, r=kennytm
6f6ac5e
Rollup of 9 pull requests - Successful merges: #47753, #47862, #47877, #47896, #47912, #47944, #47947, #47978, #47958 - Failed merges:

kennytm mentioned this pull request Feb 4, 2018
Rollup of 8 pull requests #47993
Closed

steveklabnik added 4 commits February 4, 2018 15:44

update trpl
dcb3e21
Includes rust-lang/book#1088 and rust-lang/book@62210e3

update reference
b320829

update mdbook to 0.1.2
5437188
and improve printing of errors

add exceptions for new deps
983cc00

steveklabnik force-pushed the update-book branch from abb162c to 983cc00Compare February 4, 2018 20:47

kennytm mentioned this pull request Feb 5, 2018
Rollup of 10 pull requests #48017
Merged

bors added a commit that referenced this pull request Feb 6, 2018
Auto merge of#48017- kennytm:rollup, r=kennytm
b224fc8
Rollup of 10 pull requests - Successful merges: #46030, #47496, #47543, #47704, #47753, #47807, #47948, #47959, #48003, #48007 - Failed merges:

bors merged commit 983cc00 into rust-lang:masterFeb 6, 2018

steveklabnik deleted the update-book branch February 6, 2018 15:44

Uh oh!

Uh oh!

Conversation

steveklabnik commented Jan 25, 2018

Uh oh!

rust-highfive commented Jan 25, 2018

Uh oh!

alexcrichton commented Jan 25, 2018

Uh oh!

QuietMisdreavus commented Jan 25, 2018

Uh oh!

Michael-F-Bryan commented Jan 26, 2018

Uh oh!

steveklabnik commented Jan 26, 2018

Uh oh!

steveklabnik commented Jan 27, 2018

Uh oh!

alexcrichton commented Jan 27, 2018

Uh oh!

steveklabnik commented Jan 27, 2018

Uh oh!

Michael-F-Bryan commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 28, 2018• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

steveklabnik commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 28, 2018

Uh oh!

steveklabnik commented Jan 30, 2018

Uh oh!

steveklabnik commented Feb 3, 2018

Uh oh!

kennytm commented Feb 3, 2018

Uh oh!

steveklabnik commented Feb 3, 2018

Uh oh!

kennytm commented Feb 3, 2018

Uh oh!

bors commented Feb 3, 2018

Uh oh!

bors commented Feb 4, 2018

Uh oh!

steveklabnik commented Feb 4, 2018

Uh oh!

bors commented Feb 4, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

steveklabnik commented Jan 28, 2018•
edited
Loading