-
Notifications
You must be signed in to change notification settings - Fork 29.1k
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
doc: Change test option at STEP 5: Test in CONTRIBUTING.md #12830
Closed
Closed
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ce884c0
doc: Change test option at STEP 5: Test in CONTRIBUTING.md
kysnm 7832bb6
Remove unnecessary sentence
kysnm def6cf0
Follow the doc linting
kysnm c05c325
Fix to words more better
kysnm fd8324e
Fix to plural
kysnm 2d52243
Change the word more naturally
kysnm f7a15d7
Add option `-J`
kysnm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -185,7 +185,19 @@ If you are updating tests and just want to run a single test to check it, you | |
can use this syntax to run it exactly as the test harness would: | ||
|
||
```text | ||
$ python tools/test.py -v --mode=release parallel/test-stream2-transform | ||
$ python tools/test.py --mode=release parallel/test-stream2-transform | ||
``` | ||
|
||
You can run tests in parallel with option `-J` | ||
|
||
```text | ||
$ python tools/test.py -J --mode=release parallel | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thank you for reviewing. |
||
``` | ||
|
||
If you want to check the other option, please refer the help with option `--help` | ||
|
||
```text | ||
$ python tools/test.py --help | ||
``` | ||
|
||
You can run tests directly with node: | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a
-J
? Given that it says "exactly as the test harness would" we should probably be exact:LGTM otherwise.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be run "exactly as the test harness would" either way given that
tools/test.py
is the test harness, regardless of the options.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that users would understand by looking at help.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume the test harness means
make test
, otherwise that part of the sentence is kinda meaningless. The reason I think this is necessary is that using-J
can cause subtle bugs (when tests interact with each other), and that is impossible to debug if you don't use the flag by default.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I agree with that if we are talking about running multiple tests. But that sentence is about running a single test, isn't it? Do I miss the point?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maaaybe, I think I'd be +1 on that, but I suspect it might be contentious...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other option, a wrapper script
test-ci
(.sh & .cmd).This one I'm doing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't that duplicate the
Makefile
andvcbuild.bat
test-ci
target? What's the gain?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'll take $*, so it's useful for single files, or single suits.
I don't know about
make test-ci
butvcbuild test-ci
builds first (with Feet of clay), very demotivating.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL #12874