Skip to content

Commit b82396f

Browse files
committed
make sure the two name fields are distinct
1 parent e8e6a75 commit b82396f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ Currently supported sources:
77
- `criterion`
88

99
## Fields
10-
- `name` (required): name of the benchmark. This can optionally be specified with a given metadata format (see below)
10+
- `name` (required): name of the benchmark
1111
- `tool` (required): tool used to get benchmark output. One of `["cargo"]`
1212
- `os` (required): a string describing the os
1313
- `output-file-path` (required): a path to a file containing the output of the benchmark tool
1414
- `data-out-path` (required): the path where the output of the action should be written
1515

1616
## Metadata format
1717

18-
The `name` field can be provided as a `/`-separated string with the format `category/key size/name/platform/api`. The key size should be an integer. Some fields in this string can be left blank. Any unspecified or invalid fields will be parsed to `undefined`.
18+
The benchmark name in the `cargo` benchmarks can be provided as a `/`-separated string with the format `category/key size/name/platform/api`. The key size should be an integer. Some fields in this string can be left blank. Any unspecified or invalid fields will be parsed to `undefined`.
1919

2020
## Output data format
2121

0 commit comments

Comments
 (0)