Skip to content

docs: add memory unit example for tidb_server_memory_limit - #21893

Open
doc-claw-bot wants to merge 3 commits into
pingcap:masterfrom
doc-claw-bot:docs/memory-limit-unit-example
Open

docs: add memory unit example for tidb_server_memory_limit#21893
doc-claw-bot wants to merge 3 commits into
pingcap:masterfrom
doc-claw-bot:docs/memory-limit-unit-example

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

  • Add a 90GiB example to the tidb_server_memory_limit description in system-variables.md.
  • Clarify the documented unit-format example without changing the supported formats.

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 (in Chinese).

  • 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

  • 文档
    • 更新 tidb_server_memory_limittidb_server_memory_limit_sess_min_size 的内存大小格式说明。
    • 新增支持 KBMBGBTB 单位。
    • 补充 90GiB 配置示例。

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Aug 21, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 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 overvenus 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 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 Aug 21, 2026
@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

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: 44158789-a435-47f0-8a85-8033180f7b61

📥 Commits

Reviewing files that changed from the base of the PR and between 495c5fa and 95d484d.

📒 Files selected for processing (1)
  • system-variables.md

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


📝 Walkthrough

Walkthrough

更新两个内存相关系统变量的文档说明。新增 KB|MB|GB|TB 单位格式,并补充 90GiB 示例。

Changes

内存值格式说明

Layer / File(s) Summary
更新内存变量格式说明
system-variables.md
tidb_server_memory_limittidb_server_memory_limit_sess_min_size 增加 `KB

Estimated code review effort: 1 (简单) | ~2 分钟

Merge Risk: ⚪ Minimal · up to 95d48

This PR only clarifies the documented memory-unit example for tidb_server_memory_limit without changing product behavior or supported formats; no actionable merge-blocking risk remains.

Suggested reviewers: qiancai, lilin90

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed 标题说明了为 tidb_server_memory_limit 添加内存单位示例,与主要变更相关。标题未提及新增 KB、MB、GB、TB 单位,但不影响其通过。
Description check ✅ Passed 描述包含变更内容、适用版本、相关 PR、AI 参与情况和变更类型检查项。内容与 PR 目标基本一致,但“without changing the supported formats”与实际新增 KB、MB、GB、TB 单位的变更摘要不一致。
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.
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ 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.

@doc-claw-bot doc-claw-bot added type/bugfix This PR fixes a bug. area/general Relates to TiDB overview, architecture, and other general descriptions. and removed missing-translation-status This PR does not have translation status info. labels Aug 21, 2026
Comment thread system-variables.md Outdated
@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Aug 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/general Relates to TiDB overview, architecture, and other general descriptions. contribution This PR is from a community contributor. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants