emit error when doc generation fails #55933

euclio · 2018-11-13T19:35:30Z

The diagnostic looks something like this:

error: couldn't generate documentation: No space left on device (os error 28)
  |
  = note: failed to create or modify "/path/to/crate/target/doc/src/lazycell"

rust-highfive · 2018-11-13T19:35:35Z

r? @steveklabnik

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

TimNN · 2018-11-20T20:21:31Z

Ping form triage @steveklabnik / @rust-lang/rustdoc: This PR requires your review.

steveklabnik · 2018-11-20T22:04:45Z

@QuietMisdreavus or @GuillaumeGomez should be r+'ing this, not me

GuillaumeGomez · 2018-11-21T09:15:53Z

Looks nice! Please add a rustdoc-ui test and then I r+.

euclio · 2018-11-21T16:19:38Z

I'd like to, but I'm not sure how to simulate filesystem errors in a UI test.

GuillaumeGomez · 2018-11-21T18:40:40Z

Ah that's a good point...

@rust-lang/infra Does anyone knows how to simulate a full disk?

kennytm · 2018-11-22T08:55:15Z

what about write to a location which you have no permission? this will need to be changed to a run-make test though.

GuillaumeGomez · 2018-11-22T09:36:00Z

Hard to write an all-OSes test...

QuietMisdreavus · 2018-11-30T23:07:55Z

It may be enough to make it run on just Unix, though. The trick is just to make sure it outputs the right kind of error message when it encounters a filesystem error, even if the nature of that error doesn't matter much. Plus, plenty of other run-make-fulldeps tests skip running on Windows, so at least there's precedent there. At its core, we basically need to make sure that it doesn't say "internal compiler error" (or whatever the right capitalization should be) when it hits this error, right? If you want, i could try to sketch it out.

Otherwise, i quite like this PR. (I'm also not opposed to landing it as-is, since it's effectively just changing the way rustdoc prints certain kinds of errors.)

euclio · 2018-12-03T14:53:20Z

@QuietMisdreavus pushed a run-make test that checks that it doesn't ICE.

QuietMisdreavus · 2018-12-04T17:08:01Z

src/test/run-make-fulldeps/rustdoc-io-error/Makefile

+all:
+	mkdir -p $(OUTPUT_DIR)
+	chmod u-w $(OUTPUT_DIR)
+	-$(shell $(RUSTDOC) -o $(OUTPUT_DIR) foo.rs)


Does this save the exit status into $(.SHELLSTATUS) for later? I'm not familiar with this syntax.

Yes. https://www.gnu.org/software/make/manual/html_node/Shell-Function.html#Shell-Function

Cool, thanks for the link!

src/librustdoc/lib.rs

QuietMisdreavus

Excellent, thanks so much! r=me when travis is green.

GuillaumeGomez · 2018-12-05T10:15:39Z

@bors: r=QuietMisdreavus

bors · 2018-12-05T10:15:40Z

📌 Commit e2fa3c17ebf51aac41801a040ea0e7857e9da63f has been approved by QuietMisdreavus

kennytm · 2018-12-05T14:09:34Z

@bors r-

The test did not pass on Windows. See #56531 (comment)

---- [run-make] run-make-fulldeps\rustdoc-io-error stdout ----
error: make failed
status: exit code: 2
command: "make"
stdout:
------------------------------------------
make[1]: Entering directory '/c/projects/rust/src/test/run-make-fulldeps/rustdoc-io-error'
make[1]: Leaving directory '/c/projects/rust/src/test/run-make-fulldeps/rustdoc-io-error'
------------------------------------------
stderr:
------------------------------------------
make[1]: *** No targets.  Stop.
------------------------------------------
thread '[run-make] run-make-fulldeps\rustdoc-io-error' panicked at 'explicit panic', src\tools\compiletest\src\runtest.rs:3284:9
note: Run with `RUST_BACKTRACE=1` for a backtrace.
failures:
    [run-make] run-make-fulldeps\rustdoc-io-error
test result: FAILED. 192 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out
thread 'main' panicked at 'Some tests failed', src\tools\compiletest\src\main.rs:503:22

Fixes rust-lang#41813.

euclio · 2018-12-05T15:11:25Z

The test was missing an else branch that runs an empty target. Fixed.

QuietMisdreavus · 2018-12-05T15:23:34Z

r=me pending travis

QuietMisdreavus · 2018-12-05T18:51:30Z

@bors r+

bors · 2018-12-05T18:51:32Z

📌 Commit c359f98 has been approved by QuietMisdreavus

bors · 2018-12-05T20:27:23Z

⌛ Testing commit c359f98 with merge 14997d5...

emit error when doc generation fails Fixes #41813. The diagnostic looks something like this: ``` error: couldn't generate documentation: No space left on device (os error 28) | = note: failed to create or modify "/path/to/crate/target/doc/src/lazycell" ```

bors · 2018-12-05T23:00:30Z

☀️ Test successful - status-appveyor, status-travis
Approved by: QuietMisdreavus
Pushing 14997d5 to master...

michaelwoerister · 2018-12-06T15:47:14Z

I'm wondering why this caused a visible performance regression:
https://perf.rust-lang.org/compare.html?start=b866f7d258a2428e004039eb0f3fabd73cc9d6ae&end=14997d56a550f4aa99fe737593cd2758227afc56&stat=instructions:u

cc @rust-lang/wg-compiler-performance

eddyb · 2018-12-07T10:30:17Z

@michaelwoerister That makes no sense, I'd suspect an issue with the perf setup.

rust-highfive assigned steveklabnik Nov 13, 2018

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 13, 2018

QuietMisdreavus reviewed Dec 4, 2018

View reviewed changes

src/librustdoc/lib.rs Outdated Show resolved Hide resolved

euclio force-pushed the doc-panic branch 2 times, most recently from d4325f0 to e2fa3c1 Compare December 4, 2018 22:28

QuietMisdreavus approved these changes Dec 4, 2018

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 5, 2018

GuillaumeGomez mentioned this pull request Dec 5, 2018

Rollup of 19 pull requests #56531

Closed

bors 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 Dec 5, 2018

emit error when doc generation fails

c359f98

Fixes rust-lang#41813.

euclio force-pushed the doc-panic branch from e2fa3c1 to c359f98 Compare December 5, 2018 15:10

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

bors merged commit c359f98 into rust-lang:master Dec 5, 2018

euclio deleted the doc-panic branch December 7, 2018 13:47

ollie27 mentioned this pull request Apr 9, 2019

Unexpected panic while using cargo doc command with nom 4.2.2. #59703

Closed

emit error when doc generation fails #55933

emit error when doc generation fails #55933

Uh oh!

Conversation

euclio commented Nov 13, 2018

Uh oh!

rust-highfive commented Nov 13, 2018

Uh oh!

TimNN commented Nov 20, 2018

Uh oh!

steveklabnik commented Nov 20, 2018

Uh oh!

GuillaumeGomez commented Nov 21, 2018

Uh oh!

euclio commented Nov 21, 2018

Uh oh!

GuillaumeGomez commented Nov 21, 2018

Uh oh!

kennytm commented Nov 22, 2018

Uh oh!

GuillaumeGomez commented Nov 22, 2018

Uh oh!

QuietMisdreavus commented Nov 30, 2018

Uh oh!

euclio commented Dec 3, 2018

Uh oh!

QuietMisdreavus Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

euclio Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

QuietMisdreavus Dec 4, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

QuietMisdreavus left a comment

Choose a reason for hiding this comment

Uh oh!

GuillaumeGomez commented Dec 5, 2018

Uh oh!

bors commented Dec 5, 2018

Uh oh!

kennytm commented Dec 5, 2018

Uh oh!

euclio commented Dec 5, 2018

Uh oh!

QuietMisdreavus commented Dec 5, 2018

Uh oh!

QuietMisdreavus commented Dec 5, 2018

Uh oh!

bors commented Dec 5, 2018

Uh oh!

bors commented Dec 5, 2018

Uh oh!

bors commented Dec 5, 2018

Uh oh!

michaelwoerister commented Dec 6, 2018

Uh oh!

eddyb commented Dec 7, 2018

Uh oh!

Uh oh!