Skip to content

Commit 19363df

Browse files
committed
Adress AI review
1 parent 281e0a0 commit 19363df

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

doc/command-line-flags.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ It is not reliable to parse the `ALTER` statement to determine if it is instant
8383

8484
### check-flag
8585

86-
Checks whether one or more flags exist in the current `gh-ost` binary. This is useful for cross-version scripting. Exits with `0` when all additionally provided flags exist, non-zero otherwise. Flags that require a value must be given a dummy value.
86+
Checks whether one or more flags exist in the current `gh-ost` binary. This is useful for cross-version scripting. Exits with `0` when all flags specified alongside `--check-flag` exist, non-zero otherwise. Flags that require a value must be given a dummy value.
8787

8888
Example: `gh-ost --check-flag --cut-over-lock-timeout-seconds 1 --nice-ratio 0`
8989

@@ -136,7 +136,7 @@ This is somewhat similar to a Nagios `n`-times test, where `n` in our case is al
136136

137137
### cut-over
138138

139-
Optional. Default is `atomic`. Accepted values are `atomic`, `default`, and `two-step`. See more discussion in [`cut-over`](cut-over.md)
139+
Optional. Default is `atomic`. Accepted values are `atomic`, `default`, and `two-step`; `default` is a legacy alias for `atomic`. `atomic` performs an atomic table swap where pending connections briefly block and either all see the old table or all see the new table. `two-step` uses a non-atomic rename sequence where the original table is renamed away before the ghost table takes its place, leaving a brief interval where the table does not exist. See more discussion in [`cut-over`](cut-over.md)
140140

141141
### cut-over-exponential-backoff
142142

@@ -304,7 +304,7 @@ Typically `gh-ost` is used to migrate tables on a master. If you wish to only pe
304304

305305
### mysql-timeout
306306

307-
Connect, read, and write timeout for MySQL connections. The default `0` uses the driver's default behavior.
307+
Connect, read, and write timeout for MySQL connections, in seconds. The value is applied to the MySQL driver's `timeout`, `readTimeout`, and `writeTimeout` DSN parameters. It is configured on the initial inspector connection and is copied to related gh-ost MySQL connections, including the applier/master connection and throttle-control replica checks. The default `0` uses the driver's default behavior.
308308

309309
### nice-ratio
310310

0 commit comments

Comments
 (0)