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

Improve rustdoc gui tester #85191

Merged
merged 3 commits into from
May 12, 2021

Conversation

GuillaumeGomez
Copy link
Member

I cherry-picked the commit from #84834 (and modified it a bit). I also used this opportunity to update it to last version (forgot to update GUI test in #85074, really can't wait to make #84586 finally work).

cc @Mark-Simulacrum for the changes in bootstrap.

r? @jsha

@GuillaumeGomez GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-doctests Area: Documentation tests, run by rustdoc labels May 11, 2021
@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 11, 2021
@GuillaumeGomez
Copy link
Member Author

Actually, considering it's a simple enough PR, might be interesting to put @CraftSpider on it. :)

r? @CraftSpider

@rust-highfive rust-highfive assigned CraftSpider and unassigned jsha May 11, 2021
let _ = fs::remove_dir_all(&out_dir);

// We generate docs for the libraries present in the rustdoc-gui's src folder.
let libs_dir = Path::new("src/test/rustdoc-gui/src");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be joined onto builder.config.src, otherwise this won't work when invoked from a different working directory.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right, I did it in #84586 but that's definitely a good idea to have it ahead!

}
}

// We now run GUI tests.
let mut command = Command::new(&nodejs);
command
.arg("src/tools/rustdoc-gui/tester.js")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: this probably also needs to be builder.config.src.join, as well as the test-folder here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely, all the "src" paths need it. Like I said, I did it in #84586 but didn't think about doing it here. Thanks for the reminder!

@Mark-Simulacrum
Copy link
Member

Mark-Simulacrum commented May 11, 2021

Modulo changed working directory support, this seems fine to me. I didn't review anything beyond bootstrap.

@GuillaumeGomez
Copy link
Member Author

@Mark-Simulacrum Updated. The other changes are simply taking into account the fact that the doc directory changed and update one test to last master version.

@Mark-Simulacrum
Copy link
Member

@bors r+ rollup

@bors
Copy link
Contributor

bors commented May 11, 2021

📌 Commit 6b94990 has been approved by Mark-Simulacrum

@bors 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 May 11, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request May 11, 2021
Rollup of 8 pull requests

Successful merges:

 - rust-lang#83501 (rustdoc: Add unstable CLI option to show basic type layout information)
 - rust-lang#85018 (shrinking the deprecated method span)
 - rust-lang#85124 (rustdoc: remove explicit boolean comparisons.)
 - rust-lang#85136 (Change param name (k to key and v to value) in std::env module)
 - rust-lang#85162 (Fix typo in variable name)
 - rust-lang#85187 (Use .name_str() to format primitive types in error messages)
 - rust-lang#85191 (Improve rustdoc gui tester)
 - rust-lang#85196 (Revert "Auto merge of rust-lang#84797 - richkadel:cover-unreachable-statements…)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 8f3c2cc into rust-lang:master May 12, 2021
@rustbot rustbot added this to the 1.54.0 milestone May 12, 2021
@GuillaumeGomez GuillaumeGomez deleted the improve-rustdoc-gui-tester branch May 12, 2021 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-doctests Area: Documentation tests, run by rustdoc S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants