Skip to content

dm: fix operate-source create description to match its actual behavior - #23837

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-operate-source-wording
Open

dm: fix operate-source create description to match its actual behavior#23837
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-en-operate-source-wording

Conversation

@yahonda

@yahonda yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

The usage example said "Use the following `operate-source` command to create a source configuration file", which describes the command backwards. The same document's own "Flags description" section (directly above) already states that `create` "Creates one or more upstream database sources" and that `config-file` "Specifies the file path of `source.yaml`" (an existing, pre-created input file) — i.e. the command registers an existing source file's contents into the DM cluster; it does not create the file.

Playground verification: deployed a live DM cluster (dm-master + dm-worker + dmctl v8.5.3) in a local Docker container and ran `operate-source create ./source.yaml`. No new file was written to disk, and `operate-source show` continued to report the source as registered even after `source.yaml` was deleted — confirming the command registers the source into cluster state rather than creating a file.

Source-code verification: `dm/ctl/master/operate_source.go` (`operateSourceFunc`) calls `common.GetFileContent(arg)` to read the existing `source.yaml`'s bytes, parses it with `config.SourceCfgFromYaml`, and sends the content over gRPC as `OperateSourceRequest{Config: contents, ...}`. The CLI never writes a file — it only reads one and transmits its content to dm-master.

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)?

  • This PR is translated from:
  • Other reference 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

The command registers an existing data source (source.yaml) into the
DM cluster; it does not create the configuration file. The
surrounding "Flags description" section already documents create as
creating upstream database sources, and config-file as pointing to a
pre-existing source.yaml path.
@ti-chi-bot

ti-chi-bot Bot commented Sep 11, 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 lilin90 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

@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 4 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: 0376ffc0-0b71-4ca9-9b16-e4ba5b00a9e0

📥 Commits

Reviewing files that changed from the base of the PR and between 8d85871 and 7db470c.

📒 Files selected for processing (1)
  • dm/dm-manage-source.md

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 missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 11, 2026
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