Skip to content

tikv-configuration-file, dynamic-config: fix the tombstones key names - #23927

Open
sary8 wants to merge 1 commit into
pingcap:masterfrom
sary8:fix/tikv-auto-compaction-tombstones-key-names
Open

sary8 wants to merge 1 commit into
pingcap:masterfrom
sary8:fix/tikv-auto-compaction-tombstones-key-names

Conversation

@sary8

@sary8 sary8 commented Sep 21, 2026

Copy link
Copy Markdown

What is changed, added, or deleted? (Required)

The gc.auto-compaction options tombstone-num-threshold and tombstone-percent-threshold are documented with the wrong names. TiKV uses tombstones-num-threshold and tombstones-percent-threshold.

The documented names are rejected by --config-check and are not applied during normal startup.

This PR:

  • renames the two options in tikv-configuration-file.md and dynamic-config.md
  • updates links affected by the changed heading anchors

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

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

The same spelling is present in release-8.5 and release-7.5.

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
    • Updated TiKV configuration documentation to use the corrected plural names for automatic compaction tombstone thresholds.
    • Updated related descriptions, references, and deprecation guidance to point to the renamed configuration items.

@ti-chi-bot

ti-chi-bot Bot commented Sep 21, 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 jackysp 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 contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Sep 21, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 21, 2026

Copy link
Copy Markdown

Hi @sary8. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

📝 Walkthrough

Walkthrough

The documentation renames two gc.auto-compaction configuration items from tombstone to tombstones. Related headings, anchors, and deprecation references use the updated names.

Changes

Configuration Name Update

Layer / File(s) Summary
Rename configuration names and references
dynamic-config.md, tikv-configuration-file.md
The two configuration names, section headings, internal anchors, and deprecation references now use tombstones. Descriptions remain unchanged.

Priority: ⬇️ Low

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: ⚪ Minimal · up to 72f12

The PR is mergeable; the pre-existing v7.5 and v8.5 documentation anchors should be fixed separately.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description covers the required change, affected files, TiDB version, related implementation links, AI involvement, and applicable change classifications. It is complete and aligned with the PR ob…
Title check ✅ Passed The title clearly identifies the affected documentation files and the correction of the tombstones key names.
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…
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 a new PR

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 54ddae6b-fe0a-41ca-89d3-481a26a0d22d

📥 Commits

Reviewing files that changed from the base of the PR and between a343636 and 72f1207.

📒 Files selected for processing (2)
  • dynamic-config.md
  • tikv-configuration-file.md

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

Comment thread dynamic-config.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. missing-translation-status This PR does not have translation status info. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant