[Doc/Samples] Rename variables in microbenchmarks YAML samples to avoid conflict #330
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.
Hi,
I stumbled upon an issue while reading and testing the "Running micro-benchmarks" section of the documentation.
In the example below (from the
micro.benchmarks.yml
sample), thejob
variable does not expand as expected (we expectshort
) at runtime, and thus results in a error from BenchmarkDotNet (it fails parsing its arguments).Here is the output from
crank-agent
(shrinked) :It seems (according to the
benchmarks.schema.json
file) thatjob
is already used as a global variable bycrank
to define the job to be executed. That explains why thejob
variable expands to a big JSON block in the output above.In this PR, I suggest renaming these variables in the
micro.benchmarks.yml
anddotnet.benchmarks.yml
tofilterArg
andjobArg
in order to correct this issue and avoid any conflict.Eventually, I replaced the reference to
master
bymain
indotnet.benchmarks.yml
for thedotnet/performance
repo.Regards,