Skip to content

docs: clarify Syncpoint changefeed configuration scope (#23363) - #23364

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23363-to-release-8.5
Jul 28, 2026
Merged

docs: clarify Syncpoint changefeed configuration scope (#23363)#23364
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23363-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Jul 28, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23363

What is changed, added or deleted? (Required)

Clarify that enable-sync-point is a changefeed configuration item rather than a TiCDC server configuration item.

Update the related Syncpoint wording in these docs so readers know the setting belongs to the changefeed configuration file:

  • ticdc/ticdc-upstream-downstream-check.md
  • dr-secondary-cluster.md

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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
    • Clarified that Syncpoint must be enabled in the changefeed configuration file.
    • Updated guidance to identify enable-sync-point as a changefeed configuration item.
    • Refined instructions for aligning consistent snapshot points between clusters.

doc-claw-bot and others added 2 commits July 28, 2026 02:37
@ti-chi-bot ti-chi-bot added area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/enhancement The issue or PR belongs to an enhancement. labels Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 18afa66c-0cb8-4ef4-b10c-38cb4c059d4a

📥 Commits

Reviewing files that changed from the base of the PR and between a0ff8ef and 6ae9a52.

📒 Files selected for processing (2)
  • dr-secondary-cluster.md
  • ticdc/ticdc-upstream-downstream-check.md

📝 Walkthrough

Walkthrough

Updated two Syncpoint documentation pages to specify that enable-sync-point must be configured in the changefeed configuration.

Changes

Syncpoint documentation

Layer / File(s) Summary
Clarify changefeed configuration
dr-secondary-cluster.md, ticdc/ticdc-upstream-downstream-check.md
Specifies that Syncpoint and enable-sync-point must be set in the changefeed configuration while preserving the existing tidb_external_ts behavior description.

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

Possibly related PRs

  • pingcap/docs#23363: Updates the same documentation files with closely related clarification of changefeed-level Syncpoint configuration.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the doc update about clarifying Syncpoint configuration scope.
Description check ✅ Passed The description covers the change, affected version, source PR, and AI involvement, meeting the required template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@qiancai

qiancai commented Jul 28, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Jul 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described 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 approved label Jul 28, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit b25be73 into pingcap:release-8.5 Jul 28, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23363-to-release-8.5 branch July 28, 2026 02:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/ticdc Indicates that the Issue or PR belongs to the area of TiCDC. contribution This PR is from a community contributor. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. type/enhancement The issue or PR belongs to an enhancement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants