diff --git a/docs/microbenchmarks.md b/docs/microbenchmarks.md index dc0b8c924..7a117bb57 100644 --- a/docs/microbenchmarks.md +++ b/docs/microbenchmarks.md @@ -54,9 +54,9 @@ The following example is available at https://github.com/dotnet/crank/blob/main/ localFolder: . project: micro.csproj variables: - filter: "*" - job: short - arguments: --job {{job}} --filter {{filter}} --memory + filterArg: "*" + jobArg: short + arguments: --job {{jobArg}} --filter {{filterArg}} --memory options: benchmarkDotNet: true ``` @@ -80,13 +80,13 @@ Custom arguments can be defined at the job level, or at the scenario level. For ```yml variables: - filter: "*" - job: short -arguments: --job {{job}} --filter {{filter}} --memory + filterArg: "*" + jobArg: short +arguments: --job {{jobArg}} --filter {{filterArg}} --memory ``` By doing this, each scenario can change the value of these variables. -More information about the available command line arguments can be found [on the BenchmarDotNet website](https://benchmarkdotnet.org/articles/guides/console-args.html) +More information about the available command line arguments can be found [on the BenchmarkDotNet website](https://benchmarkdotnet.org/articles/guides/console-args.html) ## Storing results locally @@ -104,7 +104,7 @@ For instance to run the sockets micro-benchmarks, use this command: > crank --config /crank/samples/micro/dotnet.benchmarks.yml --scenario Sockets --profile local ``` -The file points directly to the GitHub repository, and defines a `filter` argument that will only use the expected classes. You can follow this example to target other benchmarks from this repository. +The file points directly to the GitHub repository, and defines a `filterArg` argument that will only use the expected classes. You can follow this example to target other benchmarks from this repository. ## Conclusion diff --git a/samples/micro/dotnet.benchmarks.yml b/samples/micro/dotnet.benchmarks.yml index a3f7daeeb..fb2f8047b 100644 --- a/samples/micro/dotnet.benchmarks.yml +++ b/samples/micro/dotnet.benchmarks.yml @@ -2,12 +2,12 @@ jobs: dotnet: source: repository: https://github.com/dotnet/performance - branchOrCommit: master + branchOrCommit: main project: src/benchmarks/micro/MicroBenchmarks.csproj variables: - filter: "*" - job: short - arguments: --job {{job}} --filter {{filter}} --memory + filterArg: "*" + jobArg: short + arguments: --job {{jobArg}} --filter {{filterArg}} --memory framework: netcoreapp3.1 options: benchmarkDotNet: true @@ -18,13 +18,13 @@ scenarios: application: job: dotnet variables: - filter: "*LinqBenchmarks*" + filterArg: "*LinqBenchmarks*" Sockets: application: job: dotnet variables: - filter: "*SocketSendReceivePerfTest*" + filterArg: "*SocketSendReceivePerfTest*" profiles: local: diff --git a/samples/micro/micro.benchmarks.yml b/samples/micro/micro.benchmarks.yml index 3c7427cb4..adec64334 100644 --- a/samples/micro/micro.benchmarks.yml +++ b/samples/micro/micro.benchmarks.yml @@ -4,9 +4,9 @@ jobs: localFolder: . project: micro.csproj variables: - filter: "*" - job: short - arguments: --job {{job}} --filter {{filter}} --memory + filterArg: "*" + jobArg: short + arguments: --job {{jobArg}} --filter {{filterArg}} --memory options: benchmarkDotNet: true