Skip to content

Commit cc0bad2

Browse files
authored
Docs: fix --warmup option name for topic workload command (#2483)
1 parent 4a5b8fb commit cc0bad2

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

ydb/docs/en/core/reference/ydb-cli/workload-topic.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Subcommand options:
6767
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
6868
| `--quiet`, `-q` | Output only the final test result. |
6969
| `--print-timestamp` | Print the time together with the statistics of each time window. |
70-
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
70+
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
7171
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
7272
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
7373
| `--threads`, `-t` | Number of producer threads.<br>Default value: `1`. |
@@ -134,7 +134,7 @@ Subcommand options:
134134
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
135135
| `--quiet`, `-q` | Output only the final test result. |
136136
| `--print-timestamp` | Print the time together with the statistics of each time window. |
137-
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
137+
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
138138
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
139139
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
140140
| `--consumers`, `-c` | Number of consumers.<br>Default value: `1`. |
@@ -200,7 +200,7 @@ Subcommand options:
200200
| `--window`, `-w` | Statistics window in seconds.<br>Default value: `1`. |
201201
| `--quiet`, `-q` | Output only the final test result. |
202202
| `--print-timestamp` | Print the time together with the statistics of each time window. |
203-
| `--warmup-time` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
203+
| `--warmup` | Test warm-up period (in seconds).<br>Within the period, no statistics are calculated. It's needed to eliminate the effect of transition processes at startup.<br>Default value: `5`. |
204204
| `--percentile` | Percentile that is output in statistics.<br>Default value: `50`. |
205205
| `--topic` | Topic name.<br>Default value: `workload-topic`. |
206206
| `--producer-threads`, `-p` | Number of producer threads.<br>Default value: `1`. |

ydb/docs/ru/core/reference/ydb-cli/workload-topic.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
6868
`--quiet`, `-q` | Выводить только итоговый результат теста.
6969
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
70-
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
70+
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
7171
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
7272
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
7373
`--threads`, `-t` | Количество потоков писателя.<br>Значение по умолчанию: `1`.
@@ -134,7 +134,7 @@
134134
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
135135
`--quiet`, `-q` | Выводить только итоговый результат теста.
136136
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
137-
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
137+
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
138138
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
139139
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
140140
`--consumers`, `-c` | Количество читателей.<br>Значение по умолчанию: `1`.
@@ -200,7 +200,7 @@
200200
`--window`, `-w` | Длительность окна сбора статистики в секундах.<br>Значение по умолчанию: `1`.
201201
`--quiet`, `-q` | Выводить только итоговый результат теста.
202202
`--print-timestamp` | Печатать время вместе со статистикой каждого временного окна.
203-
`--warmup-time` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
203+
`--warmup` | Время прогрева теста в секундах.<br>В течение этого времени не вычисляется статистика, оно необходимо для устранения переходных процессов при старте.<br>Значение по умолчанию: `5`.
204204
`--percentile` | Процентиль в выводе статистики.<br>Значение по умолчанию: `50`.
205205
`--topic` | Имя топика.<br>Значение по умолчанию: `workload-topic`.
206206
`--producer-threads`, `-p` | Количество потоков писателя.<br>Значение по умолчанию: `1`.

0 commit comments

Comments
 (0)