You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,15 +7,15 @@ Currently supported sources:
7
7
-`criterion`
8
8
9
9
## 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
11
11
-`tool` (required): tool used to get benchmark output. One of `["cargo"]`
12
12
-`os` (required): a string describing the os
13
13
-`output-file-path` (required): a path to a file containing the output of the benchmark tool
14
14
-`data-out-path` (required): the path where the output of the action should be written
15
15
16
16
## Metadata format
17
17
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`.
0 commit comments