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.

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

When rustdoc tests crash, it is very difficult to investigate the failure #95601

Open
nagisa opened this issue Apr 2, 2022 · 1 comment
Open

When rustdoc tests crash, it is very difficult to investigate the failure #95601

nagisa opened this issue Apr 2, 2022 · 1 comment
Labels
A-doctests Area: Documentation tests, run by rustdoc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@nagisa
Copy link
Member

nagisa commented Apr 2, 2022

One of the rustdoc tests is crashing and the output is:

---- src/lib.rs - span (line 28) stdout ----
Test executable failed (terminated by signal).

It is extremely difficult to actually debug this – I know rustdoc compiles a test binary and runs it, but there is no intuition whatsoever as to where to look for the executable in question!

On failures like these, I feel like we should print a path to the executable (much like cargo does).
@nagisa nagisa added the A-doctests Area: Documentation tests, run by rustdoc label Apr 2, 2022
@nagisa
Copy link
Member Author

nagisa commented Apr 2, 2022 •
edited
Loading

Seems like a part of the reason it is so difficult is that rustdoc places the executables into a temporary directory and this directory is removed on exit. There is a --persist-doctests option, but it is extremely undiscoverable.

@notriddle notriddle mentioned this issue Apr 7, 2022
Merged
notriddle added a commit to notriddle/rust that referenced this issue Apr 7, 2022
@notriddle
rustdoc doctest: include signal number in exit status
813b93e 
Related to rust-lang#95601
@notriddle notriddle mentioned this issue Apr 9, 2022
Merged
m-ou-se added a commit to m-ou-se/rust that referenced this issue Apr 12, 2022
@m-ou-se
Rollup merge of rust-lang#95783 - notriddle:notriddle/doctest-signal,…
7644de5 
… r=GuillaumeGomez

rustdoc doctest: include signal number in exit status

Related to rust-lang#95601
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Jun 2, 2022
@matthiaskrgr
Rollup merge of rust-lang#95833 - notriddle:notriddle/human-readable-…
daa6b17 
…signals, r=yaahc

std: `<ExitStatus as Display>::fmt` name the signal it died from

Related to rust-lang#95601
bors added a commit to rust-lang-ci/rust that referenced this issue Jun 3, 2022
@bors
Auto merge of rust-lang#95833 - notriddle:notriddle/human-readable-si…
a6b8c69 
…gnals, r=yaahc

std: `<ExitStatus as Display>::fmt` name the signal it died from

Related to rust-lang#95601
@Enselic Enselic added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-doctests Area: Documentation tests, run by rustdoc T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
testing-devex backlog
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Enselic @nagisa