nested aux-build in tests/rustdoc/ tests #128161

EtomicBomb · 2024-07-24T21:30:58Z

Fixes bug that prevented using nested aux-build in tests/rustdoc/ tests. Before, fn document and the auxiliary builder disagreed about where to find the nested aux-build source file (auxiliary/auxiliary/aux.rs vs auxiliary/aux.rs), preventing them from building. Picked the latter in line with other builders in compiletest.
Adds //@ doc-flags header, which forwards flags to rustdoc and not rustc.
Adds //@ unique-doc-out-dir header, which sets the --out-dir for the rustdoc invocation to a unique directory: <root out dir>/docs/<test name>/doc
Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs
Adds tests that use nested aux builds and new headers

These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the mergable-rustdoc-cross-crate-info RFC.

try-job: x86_64-msvc

rustbot · 2024-07-24T21:31:06Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @compiler-errors (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

@rustbot author: the review is finished, PR author should check the comments and take action accordingly
@rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

rustbot · 2024-07-24T21:31:08Z

Some changes occurred in src/tools/compiletest

cc @jieyouxu

compiler-errors · 2024-07-24T22:07:06Z

This PR's history should be cleaned quite a lot, at least rebasing out all of the merge commits but also probably the useless commits that represent intermediate work states like "code from this morning".

r? rustdoc

EtomicBomb · 2024-07-24T23:51:09Z

Rebased the history! This is my first PR, so I'm just learning the ropes!

notriddle

AFAICT, this seems fine. In particular, I love these test cases!

I'm not as familiar with the deep guts of compiletest, though.

CC @jieyouxu

src/tools/compiletest/src/runtest.rs

notriddle · 2024-07-25T16:17:59Z

tests/rustdoc/cross-crate-info/write-docs-somewhere-else/e.rs

Thank you for including a negative test here! 👍

Those things aren't common enough, and they should be.

jieyouxu · 2024-07-25T16:44:16Z

I'm not as familiar with the deep guts of compiletest, though.

CC @jieyouxu

I'll try to take a look tomorrow for the compiletest changes.

bors · 2024-07-29T06:03:36Z

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

jieyouxu

Sorry for the wait, I just got to this PR today. The compiletest changes LGTM for the most part, just a question about potential test revision interactions.

src/tools/compiletest/src/runtest.rs

tmandry · 2024-08-01T18:26:19Z

@bors r=notriddle

bors · 2024-08-01T18:26:21Z

📌 Commit bd23e0e has been approved by notriddle

It is now in the queue for this repository.

…riddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

Rollup of 7 pull requests Successful merges: - rust-lang#122049 (Promote riscv64gc-unknown-linux-musl to tier 2) - rust-lang#128147 (migrate fmt-write-bloat to rmake) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128404 (Revert recent changes to dead code analysis) - rust-lang#128466 (Update the stdarch submodule) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128494 (MIR required_consts, mentioned_items: ensure we do not forget to fill these lists) r? `@ghost` `@rustbot` modify labels: rollup

…riddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#122049 (Promote riscv64gc-unknown-linux-musl to tier 2) - rust-lang#125558 (Tweak type inference for `const` operands in inline asm) - rust-lang#126704 (Added SHA512, SM3, SM4 target-features and `sha512_sm_x86` feature gate) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128528 (Finish removing `has_cpuid`) r? `@ghost` `@rustbot` modify labels: rollup

…riddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

…iaskrgr Rollup of 5 pull requests Successful merges: - rust-lang#122049 (Promote riscv64gc-unknown-linux-musl to tier 2) - rust-lang#126704 (Added SHA512, SM3, SM4 target-features and `sha512_sm_x86` feature gate) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128528 (Finish removing `has_cpuid`) r? `@ghost` `@rustbot` modify labels: rollup

…riddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

Rollup of 9 pull requests Successful merges: - rust-lang#126704 (Added SHA512, SM3, SM4 target-features and `sha512_sm_x86` feature gate) - rust-lang#127095 (Migrate `reproducible-build-2` and `stable-symbol-names` `run-make` tests to rmake) - rust-lang#128107 (Migrate `raw-dylib-alt-calling-convention`, `raw-dylib-c` and `redundant-libs` `run-make` tests to rmake) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128356 (Migrate `cross-lang-lto-clang` and `cross-lang-lto-pgo-smoketest` `run-make` tests to rmake) - rust-lang#128404 (Revert recent changes to dead code analysis) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128528 (Finish removing `has_cpuid`) - rust-lang#128557 (chore: use shorthand initializer) r? `@ghost` `@rustbot` modify labels: rollup

…riddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

Rollup of 10 pull requests Successful merges: - rust-lang#126704 (Added SHA512, SM3, SM4 target-features and `sha512_sm_x86` feature gate) - rust-lang#127095 (Migrate `reproducible-build-2` and `stable-symbol-names` `run-make` tests to rmake) - rust-lang#127586 (Add `#[must_use]` to some `into_raw*` functions.) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128303 (Enable `std::io::copy` specialisation for `std::pipe::{PipeReader, PipeWriter}`) - rust-lang#128356 (Migrate `cross-lang-lto-clang` and `cross-lang-lto-pgo-smoketest` `run-make` tests to rmake) - rust-lang#128368 (Formatting tweaks) - rust-lang#128404 (Revert recent changes to dead code analysis) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128557 (chore: use shorthand initializer) r? `@ghost` `@rustbot` modify labels: rollup

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#126704 (Added SHA512, SM3, SM4 target-features and `sha512_sm_x86` feature gate) - rust-lang#127586 (Add `#[must_use]` to some `into_raw*` functions.) - rust-lang#128161 (nested aux-build in tests/rustdoc/ tests) - rust-lang#128303 (Enable `std::io::copy` specialisation for `std::pipe::{PipeReader, PipeWriter}`) - rust-lang#128368 (Formatting tweaks) - rust-lang#128483 (Still more `cfg` cleanups) - rust-lang#128557 (chore: use shorthand initializer) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#128161 - EtomicBomb:just-compiletest, r=notriddle nested aux-build in tests/rustdoc/ tests * Fixes bug that prevented using nested aux-build in `tests/rustdoc/` tests. Before, `fn document` and the auxiliary builder disagreed about where to find the nested aux-build source file (`auxiliary/auxiliary/aux.rs` vs `auxiliary/aux.rs`), preventing them from building. Picked the latter in line with other builders in compiletest. * Adds `//@ doc-flags` header, which forwards flags to rustdoc and not rustc. * Adds `//@ unique-doc-out-dir` header, which sets the --out-dir for the rustdoc invocation to a unique directory: `<root out dir>/docs/<test name>/doc` * Changes working directory of the rustdoc invocation to the root out directory (common among all aux-builds). Prior art: exec_compiled_test in runtest.rs * Adds tests that use nested aux builds and new headers These changes provide useful capabilities for writing rustdoc tests on their own. They are also needed to test the implementation for the [mergable-rustdoc-cross-crate-info](rust-lang/rfcs#3662) RFC. try-job: x86_64-msvc

rustbot assigned compiler-errors Jul 24, 2024

rustbot added has-merge-commits PR has merge commits, merge with caution. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jul 24, 2024

This comment was marked as resolved.

Sign in to view

This comment has been minimized.

Sign in to view

rustbot assigned notriddle and unassigned compiler-errors Jul 24, 2024

EtomicBomb force-pushed the just-compiletest branch from 44f18f6 to dc024fe Compare July 24, 2024 22:16

This comment has been minimized.

Sign in to view

notriddle removed the has-merge-commits PR has merge commits, merge with caution. label Jul 25, 2024

notriddle reviewed Jul 25, 2024

View reviewed changes

jieyouxu self-assigned this Jul 25, 2024

jieyouxu approved these changes Jul 29, 2024

View reviewed changes

src/tools/compiletest/src/runtest.rs Show resolved Hide resolved

jieyouxu removed the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 29, 2024

EtomicBomb added 5 commits July 29, 2024 14:33

initial implementation of rustdoc nested aux-build

794434e

ordering and wrapping cross-crate-info tests

d8211de

reformatted rustdoc/cross-crate-info, fixing trailing newline issue

f6f0ef4

file_stem and comment per notriddle

12d87ee

merge conflicts; fix rebase duplicating imports

f91da72

EtomicBomb force-pushed the just-compiletest branch from 6516b64 to f91da72 Compare July 29, 2024 14:42

tgross35 mentioned this pull request Aug 1, 2024

Rollup of 4 pull requests #128513

Closed

tgross35 mentioned this pull request Aug 1, 2024

Rollup of 5 pull requests #128514

Closed

tgross35 mentioned this pull request Aug 1, 2024

Rollup of 7 pull requests #128518

Closed

matthiaskrgr mentioned this pull request Aug 2, 2024

Rollup of 6 pull requests #128556

Closed

matthiaskrgr mentioned this pull request Aug 2, 2024

Rollup of 5 pull requests #128566

Closed

jieyouxu mentioned this pull request Aug 2, 2024

Rollup of 10 pull requests #128574

Closed

jieyouxu mentioned this pull request Aug 2, 2024

Rollup of 9 pull requests #128575

Closed

jieyouxu mentioned this pull request Aug 3, 2024

Rollup of 10 pull requests #128577

Closed

matthiaskrgr mentioned this pull request Aug 3, 2024

Rollup of 7 pull requests #128595

Merged

bors merged commit 47a795b into rust-lang:master Aug 3, 2024
7 checks passed

rustbot added this to the 1.82.0 milestone Aug 3, 2024

camelid mentioned this pull request Sep 21, 2024

Tracking Issue for mergeable rustdoc cross-crate info #130676

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nested aux-build in tests/rustdoc/ tests #128161

nested aux-build in tests/rustdoc/ tests #128161

EtomicBomb commented Jul 24, 2024 •

edited

Loading

rustbot commented Jul 24, 2024

rustbot commented Jul 24, 2024

This comment was marked as resolved.

This comment has been minimized.

compiler-errors commented Jul 24, 2024

This comment has been minimized.

EtomicBomb commented Jul 24, 2024

notriddle left a comment •

edited

Loading

notriddle Jul 25, 2024

jieyouxu commented Jul 25, 2024

bors commented Jul 29, 2024

jieyouxu left a comment

tmandry commented Aug 1, 2024

bors commented Aug 1, 2024

nested aux-build in tests/rustdoc/ tests #128161

nested aux-build in tests/rustdoc/ tests #128161

Conversation

EtomicBomb commented Jul 24, 2024 • edited Loading

rustbot commented Jul 24, 2024

rustbot commented Jul 24, 2024

This comment was marked as resolved.

This comment has been minimized.

compiler-errors commented Jul 24, 2024

This comment has been minimized.

EtomicBomb commented Jul 24, 2024

notriddle left a comment • edited Loading

Choose a reason for hiding this comment

notriddle Jul 25, 2024

Choose a reason for hiding this comment

jieyouxu commented Jul 25, 2024

bors commented Jul 29, 2024

jieyouxu left a comment

Choose a reason for hiding this comment

tmandry commented Aug 1, 2024

bors commented Aug 1, 2024

EtomicBomb commented Jul 24, 2024 •

edited

Loading

notriddle left a comment •

edited

Loading