Skip to content

Commit fc946ac

Browse files
author
Abduqodiri Qurbonzoda
committed
Use consistent format for citing string values
1 parent cb40ddb commit fc946ac

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

‎docs/configuration-options.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ Configuration profiles dictate the execution pattern of benchmarks:
2929

3030
Note that values defined in the build script take precedence over those specified by annotations in the code.
3131

32-
| Option | Description | Possible Values | Corresponding Annotation |
33-
| ----------------------------------- |---------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|-----------------------------------------------------|
34-
| `iterations` | Sets the number of iterations for measurements. | Positive Integer | @Measurement(iterations: Int, ...) |
35-
| `warmups` | Sets the number of iterations for system warming, ensuring accurate measurements. | Non-negative Integer | @Warmup(iterations: Int) |
36-
| `iterationTime` | Sets the duration for each iteration, both measurement and warm-up. | Positive Integer | @Measurement(..., time: Int, ...) |
37-
| `iterationTimeUnit` | Defines the unit for `iterationTime`. | Time unit, see below | @Measurement(..., timeUnit: BenchmarkTimeUnit, ...) |
38-
| `outputTimeUnit` | Sets the unit for the results display. | Time unit, see below | @OutputTimeUnit(value: BenchmarkTimeUnit) |
39-
| `mode` | Selects "thrpt" (Throughput) for measuring the number of function calls per unit time or "avgt" (AverageTime) for measuring the time per function call. | `thrpt`, `Throughput`, `avgt`, `AverageTime` | @BenchmarkMode(value: Mode) |
40-
| `include("…")` | Applies a regular expression to include benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
41-
| `exclude("…")` | Applies a regular expression to exclude benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
42-
| `param("name", "value1", "value2")` | Assigns values to a public mutable property with the specified name, annotated with `@Param`. | String values that represent valid values for the property | @Param |
43-
| `reportFormat` | Defines the benchmark report's format options. | `json`(default), `csv`, `scsv`, `text` | - |
32+
| Option | Description | Possible Values | Corresponding Annotation |
33+
|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|-------------------------------------------------------|
34+
| `iterations` | Sets the number of iterations for measurements. | Positive Integer | `@Measurement(iterations: Int, ...)` |
35+
| `warmups` | Sets the number of iterations for system warming, ensuring accurate measurements. | Non-negative Integer | `@Warmup(iterations: Int)` |
36+
| `iterationTime` | Sets the duration for each iteration, both measurement and warm-up. | Positive Integer | `@Measurement(..., time: Int, ...)` |
37+
| `iterationTimeUnit` | Defines the unit for `iterationTime`. | Time unit, see below | `@Measurement(..., timeUnit: BenchmarkTimeUnit, ...)` |
38+
| `outputTimeUnit` | Sets the unit for the results display. | Time unit, see below | `@OutputTimeUnit(value: BenchmarkTimeUnit)` |
39+
| `mode` | Selects "thrpt" (Throughput) for measuring the number of function calls per unit time or "avgt" (AverageTime) for measuring the time per function call. | `"thrpt"`, `"Throughput"`, `"avgt"`, `"AverageTime"` | `@BenchmarkMode(value: Mode)` |
40+
| `include("…")` | Applies a regular expression to include benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
41+
| `exclude("…")` | Applies a regular expression to exclude benchmarks that match the substring in their fully qualified names. | Regex pattern | - |
42+
| `param("name", "value1", "value2")` | Assigns values to a public mutable property with the specified name, annotated with `@Param`. | String values that represent valid values for the property | `@Param` |
43+
| `reportFormat` | Defines the benchmark report's format options. | `"json"`(default), `"csv"`, `"scsv"`, `"text"` | - |
4444

4545
The following values can be used for specifying time unit:
4646
- "NANOSECONDS", "ns", "nanos"
@@ -54,15 +54,15 @@ The following values can be used for specifying time unit:
5454
The options listed in the following sections allow you to tailor the benchmark execution behavior for specific platforms:
5555

5656
### Kotlin/Native
57-
| Option | Description | Possible Values | Default Value |
58-
|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------|--------------------------------|----------------|
59-
| `advanced("nativeFork", "value")` | Executes iterations within the same process ("perBenchmark") or each iteration in a separate process ("perIteration"). | `perBenchmark`, `perIteration` | "perBenchmark" |
60-
| `advanced("nativeGCAfterIteration", value)` | Whether to trigger garbage collection after each iteration. | `true`, `false` | `false` |
57+
| Option | Description | Possible Values | Default Value |
58+
|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------------------------|------------------|
59+
| `advanced("nativeFork", "value")` | Executes iterations within the same process ("perBenchmark") or each iteration in a separate process ("perIteration"). | `"perBenchmark"`, `"perIteration"` | `"perBenchmark"` |
60+
| `advanced("nativeGCAfterIteration", value)` | Whether to trigger garbage collection after each iteration. | `true`, `false` | `false` |
6161

6262
### Kotlin/JVM
63-
| Option | Description | Possible Values | Default Value |
64-
|---------------------------------------------|------------------------------------------------------------|--------------------------------|----------------|
65-
| `advanced("jvmForks", value)` | Specifies the number of times the harness should fork. | Integer, "definedByJmh" | `1` |
63+
| Option | Description | Possible Values | Default Value |
64+
|---------------------------------------------|------------------------------------------------------------|----------------------------------------|----------------|
65+
| `advanced("jvmForks", value)` | Specifies the number of times the harness should fork. | Non-negative Integer, `"definedByJmh"` | `1` |
6666

6767
**Notes on "jvmForks":**
6868
- **0** - "no fork", i.e., no subprocesses are forked to run benchmarks.

0 commit comments

Comments
 (0)