docs: sync --test_summary description with current behavior#29550
Open
shrey4796 wants to merge 1 commit into
Open
docs: sync --test_summary description with current behavior#29550shrey4796 wants to merge 1 commit into
shrey4796 wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
The user-manual.md description of --test_summary became stale after two upstream changes that updated the @option help= string in ExecutionOptions.java but not this page: * c75fda9 / bazelbuild#19099 (cherry-picked to 6.4 as bazelbuild#19505): made --test_summary=detailed print passed and skipped test cases in addition to failed ones. * 42196f5 / bazelbuild#28341 (in 8.6 and 9.1): added the short_uncached and detailed_uncached values. The 'testcase' value has also been a public TestSummaryFormat enum constant for years without ever being documented here. Resync the prose with the help= string and the TestSummaryFormat javadoc so the documented behavior matches what bazel actually does.
54ba8e0 to
ba5e8d5
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Description
sync --test_summary description with current behavior
Motivation
The user-manual.md description of --test_summary became stale after two upstream changes that updated the @option help= string in ExecutionOptions.java but not this page:
short_uncachedanddetailed_uncachedoptions to--test_summary#28341 (in 8.6 and 9.1): added the short_uncached and detailed_uncached values.The 'testcase' value has also been a public TestSummaryFormat enum constant for years without ever being documented here.
Resync the prose with the help= string and the TestSummaryFormat javadoc so the documented behavior matches what bazel actually does.
Build API Changes
No
Checklist
Release Notes
RELNOTES: None