Skip to content

Commit 0d64abd

Browse files
committed
Update README.
1 parent 827462a commit 0d64abd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,21 @@ Backticks are mandatory. There are two kinds of jobs you can invoke: **benchmark
2121
One of the most common invocations runs all benchmarks on your PR, comparing against the current Julia master branch:
2222

2323
```
24-
@nanosoldier `runbenchmarks(ALL, vs=":master")`
24+
@nanosoldier `runbenchmarks(ALL)`
2525
```
2626

2727
Similarly, you can run all package tests, e.g. if you suspect your PR might be breaking:
2828

2929
```
30-
@nanosoldier `runtests(ALL, vs = ":master")`
30+
@nanosoldier `runtests(ALL)`
3131
```
3232

3333
Both operations take a long time, so it might be wise to restrict which benchmarks you want to run, or which packages you want to test:
3434

3535
```
36-
@nanosoldier `runbenchmarks("linalg", vs = ":master")`
36+
@nanosoldier `runbenchmarks("linalg"")`
3737
38-
@nanosoldier `runtests(["JSON", "Crayons"], vs = ":master")`
38+
@nanosoldier `runtests(["JSON", "Crayons"])`
3939
```
4040

4141
When a job is completed, @nanosoldier will reply to your comment to tell you how the job went and link you to any relevant results.
@@ -64,7 +64,7 @@ A `BenchmarkJob` is triggered with the following syntax:
6464
@nanosoldier `runbenchmarks(tag_predicate, vs = "ref")`
6565
```
6666

67-
The `vs` keyword argument is optional, and is used to determine whether or not the comparison step (step 3 above) is performed.
67+
The `vs` keyword argument is optional; if invoked from a pull request, it will be derived automatically from the merge base. In other cases, the comparison step (step 3 above) will be skipped.
6868

6969
The tag predicate is used to decide which benchmarks to run, and supports the syntax defined by the [tagging system](https://github.com/JuliaCI/BenchmarkTools.jl/blob/master/doc/manual.md#indexing-into-a-benchmarkgroup-using-tagged) implemented in the [BenchmarkTools](https://github.com/JuliaCI/BenchmarkTools.jl) package. Additionally, you can run all benchmarks by using the keyword `ALL`, e.g. `runbenchmarks(ALL)`.
7070

@@ -154,7 +154,7 @@ A `PkgEvalJob` is triggered with the following syntax:
154154

155155
The package selection argument is used to decide which packages to test. It should be a list of package names, e.g. `["Example"]`, that will be looked up in the registry. Additionally, you can test all packages in the registry by using the keyword `ALL`, e.g. `runtests(ALL)`.
156156

157-
The `vs` keyword argument is optional, and is used to determine whether or not the comparison step (step 3 above) is performed. Its syntax is identical to the `BenchmarkJob` `vs` keyword argument.
157+
The `vs` keyword argument is again optional. Its syntax and behavior is identical to the `BenchmarkJob` `vs` keyword argument.
158158

159159
Both sides of the comparison can be further configured by using respectively the `configuration` and `vs_configuration` arguments. These options expect a named tuple where the elements correspond to fields of the `PkgEval.Configuration` type.
160160

0 commit comments

Comments
 (0)