Skip to content

Document missing command-line flags#1706

Open
grodowski wants to merge 2 commits into
github:masterfrom
Shopify:grodowski/update-command-line-flags-doc
Open

Document missing command-line flags#1706
grodowski wants to merge 2 commits into
github:masterfrom
Shopify:grodowski/update-command-line-flags-doc

Conversation

@grodowski

Copy link
Copy Markdown
Contributor

Add sections for command-line flags that were registered in the CLI but missing from command-line-flags.md, including logging, throttling, hooks, StatsD, trigger, revert, and basic connection flags.

Update the documented cut-over default from the stale "safe" value to the current "atomic" default.

Add sections for command-line flags that were registered in the CLI but missing from command-line-flags.md, including logging, throttling, hooks, StatsD, trigger, revert, and basic connection flags.

Update the documented cut-over default from the stale "safe" value to the current "atomic" default.
Copilot AI review requested due to automatic review settings June 11, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates gh-ost documentation to cover additional command-line flags and refine existing flag descriptions.

Changes:

  • Added documentation entries for many previously undocumented flags (e.g., alter, ask-pass, check-flag, chunk-size, statsd-*, etc.).
  • Updated the cut-over flag description, including default and accepted values.
  • Added/clarified descriptions for connection/auth/logging/throttling-related flags.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread doc/command-line-flags.md Outdated
Comment thread doc/command-line-flags.md Outdated
Comment thread doc/command-line-flags.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants