fix: doctest respects Cargo's color options #14425
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (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 (
|
rustbot
added
Command-test
S-waiting-on-review
epage
reviewed
Aug 19, 2024
ShashiSugrim
force-pushed
the
shashi/issue14403
branch
from
6806579 to
1e026c6
Compare
rustbot
added
A-interacts-with-crates.io
Contributor
Author
|
Sorry for the problems. I am trying to fix my branch commits |
ShashiSugrim
force-pushed
the
shashi/issue14403
branch
2 times, most recently
from
616fcf9 to
4e62a57
Compare
ShashiSugrim
force-pushed
the
shashi/issue14403
branch
from
4e62a57 to
4657015
Compare
Contributor
Author
|
Hello, please review the latest changes, thank you |
weihanglo
reviewed
Aug 20, 2024
| ColorChoice::Never => "never", | ||
| ColorChoice::CargoAuto => "auto", | ||
| }; | ||
| p.arg("--color").arg(color_arg); |
Member
There was a problem hiding this comment.
Just want to call out that this may break others' builds if they already have --color in their RUSTDOCFLAGS. rustdoc doesn't allow more then one occurrence of the --color flag. While we don't consider this a breaking change, this is worth mentioning in changelog.
weihanglo
changed the title
weihanglo
approved these changes
Aug 20, 2024
Contributor
|
@bors r+ |
Contributor
bors
added
S-waiting-on-bors
Contributor
Contributor
|
☀️ Test successful - checks-actions |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Aug 22, 2024
Update cargo 12 commits in ba8b39413c74d08494f94a7542fe79aa636e1661..8f40fc59fb0c8df91c97405785197f3c630304ea 2024-08-16 22:48:57 +0000 to 2024-08-21 22:37:06 +0000 - Tests rely on absence of RUST_BACKTRACE (rust-lang/cargo#14441) - fix: -Cmetadata includes whether extra rustflags is same as host (rust-lang/cargo#14432) - [mdman] Normalize newlines when rendering options (rust-lang/cargo#14428) - fix: doctest respects Cargo's color options (rust-lang/cargo#14425) - Be more permissive while packaging unpublishable crates. (rust-lang/cargo#14408) - fix: Limiting pre-release match semantics to use only on `OptVersionReq::Req` (rust-lang/cargo#14412) - test: add a regression test for Issue 14409 (rust-lang/cargo#14430) - chore: update label trigger for Command-info (rust-lang/cargo#14422) - doc: add lockfile-path unstable doc section (rust-lang/cargo#14423) - doc: update lockfile-path tracking issue (rust-lang/cargo#14424) - fix: remove list owners feature of info subcommand (rust-lang/cargo#14418) - Lockfile path tests (follow-up) (rust-lang/cargo#14417)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR try to resolve?
Explain the motivation behind this change.
This commit fixes the issue where cargo's test command doesn't respect the color parameter when it gets passed in like this command:
cargo t --color never --doc -- --color neverFixes #14403
How should we test and review this PR?
Test on a basic rust project, with a file called lib.rs that looks like this
You can try to replicate the same commands @zacknewman used in the description of this issue.
cargo t --color never --doc -- --color neverYou will see that compared to the official build of cargo, this build will respect the --color argument