Skip to content

migrate-with-more-columns-downstream: fix --master-addr flag dash inconsistency - #23748

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-master-addr-flag-dash-inconsistency
Open

migrate-with-more-columns-downstream: fix --master-addr flag dash inconsistency#23748
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-master-addr-flag-dash-inconsistency

Conversation

@yahonda

@yahonda yahonda commented Sep 7, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

The option-reference table in migrate-with-more-columns-downstream.md documented the dmctl flag as -master-addr (single dash), while every example command in the same file uses --master-addr (double dash).

Verified against the dmctl flag definition in pingcap/tiflow (dm/ctl/common/config.go): master-addr is registered as a pflag long-form string flag (fs.String("master-addr", ...)), whose canonical invocation is --master-addr. A single-dash -master-addr is also accepted, but only via an explicit backward-compatibility shim (argsNeedAdjust in the same file, introduced in pingcap/tiflow commit b1018964e2 "dmctl: fix dmctl command to improve its usability") that rewrites the legacy single-dash form internally — it is not the current canonical usage.

This PR updates the table to `--master-addr` to match the canonical form used throughout this file's own example commands.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Corrected the binlog-schema command parameter documentation to use the --master-addr option name.

@coderabbitai

coderabbitai Bot commented Sep 7, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 37 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d0b72804-9a74-4e1b-becc-1c8e260d5b82

📥 Commits

Reviewing files that changed from the base of the PR and between 901e176 and cff364d.

📒 Files selected for processing (1)
  • migrate-with-more-columns-downstream.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 8903a20c-affa-42a5-bcbb-0cdf4bb39d0b

📥 Commits

Reviewing files that changed from the base of the PR and between 901e176 and cff364d.

📒 Files selected for processing (1)
  • migrate-with-more-columns-downstream.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation updates the binlog-schema parameter table to use --master-addr, matching the command examples.

Changes

binlog-schema option documentation

Layer / File(s) Summary
Correct option name
migrate-with-more-columns-downstream.md
The parameter table now documents --master-addr instead of -master-addr.

Priority: ⬇️ Low — Impact reflects low issue severity.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to cff36

The binlog-schema option reference now uses the correct --master-addr form, aligning the documentation with expected command usage. The change is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation file and the primary change: correcting the --master-addr dash inconsistency.
Description check ✅ Passed The description explains the change, provides technical context and references, identifies the affected version as v8.5, and completes the applicable template sections. The minor heading variation doe…
Linked Issues check ✅ Passed The PR directly addresses issue [#23745] by changing the option-reference entry from -master-addr to the canonical --master-addr form. This matches the issue requirements and the file's examples.
Out of Scope Changes check ✅ Passed The PR contains only the documentation correction required by issue [#23745]. No unrelated code or documentation changes are indicated.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Git: CodeRabbit could not clone the repository, so clone-backed analysis was skipped and this review may be incomplete. Verify repository clone access, such as SSH credentials, before requesting another full review. If clone access is intentionally unavailable, use path_filters to narrow the review scope.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Sep 7, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 7, 2026
@yahonda

yahonda commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@yahonda

yahonda commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@yahonda

yahonda commented Sep 8, 2026

Copy link
Copy Markdown
Member Author

@coderabbitai full review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.


Your included review limit is currently reached under our Fair Usage Limits Policy. This review may still proceed through usage-based billing if eligible. Your next included review will be available in 37 minutes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant