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

Stabilize flags for doctest cross compilation #137096

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ehuss
Copy link
Contributor

@ehuss ehuss commented Feb 15, 2025

This makes the following changes in preparation for supporting doctest cross-compiling in cargo:

  • Renames --runtool and --runtool-arg to --test-runtool and --test-runtool-arg to maintain consistency with other --test-* arguments.
  • Stabilizes the --test-runtool and --test-runtool-arg. These are needed in order to support cargo's target.runner option which specifies a runner to execute a cross-compiled doctest (for example, qemu).
  • Stabilizes the --enable-per-target-ignores flag by removing it and making it unconditionally enabled. This makes it possible to disable a doctest on a per-target basis, which I think will be helpful for rolling out this feature.

These changes were suggested in https://rust-lang.zulipchat.com/#narrow/channel/266220-t-rustdoc/topic/stabilizing.20doctest.20xcompile/near/409281127

The intent is to stabilize the doctest-xcompile feature in cargo. This will help ensure that for projects that do cross-compile testing that their doctests are also covered. Currently there is a somewhat surprising behavior that they are ignored.

Closes #64245

@rustbot
Copy link
Collaborator

rustbot commented Feb 15, 2025

r? @fmease

rustbot has assigned @fmease.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output. labels Feb 15, 2025
@fmease fmease added the needs-fcp This change is insta-stable, so needs a completed FCP to proceed. label Feb 15, 2025
@rust-log-analyzer

This comment has been minimized.

@ehuss ehuss force-pushed the stabilize-doctest-xcompile branch from ab9d4c8 to a676b04 Compare February 15, 2025 20:58
@rustbot rustbot added the A-run-make Area: port run-make Makefiles to rmake.rs label Feb 15, 2025
@rustbot
Copy link
Collaborator

rustbot commented Feb 15, 2025

This PR modifies tests/run-make/. If this PR is trying to port a Makefile
run-make test to use rmake.rs, please update the
run-make port tracking issue
so we can track our progress. You can either modify the tracking issue
directly, or you can comment on the tracking issue and link this PR.

cc @jieyouxu

The Miri subtree was changed

cc @rust-lang/miri

@rust-log-analyzer

This comment has been minimized.

This renames `--runtool` and `--runtool-arg` to `--test-runtool` and
`--test-runtool-arg` to maintain consistency with other `--test-*`
arguments.
This removes the `--enable-per-target-ignores` and enables it
unconditionally.
@ehuss ehuss force-pushed the stabilize-doctest-xcompile branch from a676b04 to 8aaa90b Compare February 15, 2025 22:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-run-make Area: port run-make Makefiles to rmake.rs needs-fcp This change is insta-stable, so needs a completed FCP to proceed. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-rustdoc-frontend Relevant to the rustdoc-frontend team, which will review and decide on the web UI/UX output.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tracking Issue for Cross Compiling Doctests
4 participants