Skip to content

docs: add memory unit example for tidb_server_memory_limit (#21893) - #21901

Open
ti-chi-bot wants to merge 5 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21893-to-release-8.5
Open

docs: add memory unit example for tidb_server_memory_limit (#21893)#21901
ti-chi-bot wants to merge 5 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-21893-to-release-8.5

Conversation

@ti-chi-bot

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

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #21893

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 单位配置内存值。
    • 保留原有二进制单位格式支持。

@ti-chi-bot ti-chi-bot added area/general Relates to TiDB overview, architecture, and other general descriptions. contribution This PR is from a community contributor. lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Aug 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 28, 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 danielzhangqd 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 Aug 28, 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: 023bacbf-7e6c-4350-a6a1-76425c853dab

📥 Commits

Reviewing files that changed from the base of the PR and between 2e08649 and 224768d.

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

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


📝 Walkthrough

Walkthrough

更新 tidb_server_memory_limittidb_server_memory_limit_sess_min_size 的内存值格式说明,新增 KBMBGBTB 单位,并保留原有二进制单位格式。

Changes

系统变量内存单位格式更新

Layer / File(s) Summary
更新系统变量格式说明
system-variables.md
为两个系统变量新增 KBMBGBTB 单位说明,并保留 KiBMiBGiBTiB 格式。

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

Merge Risk: ⚪ Minimal · up to 22476

This change only clarifies the documented memory-limit unit example and does not alter product behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning 描述包含变更内容、版本选择、相关链接和 AI 参与情况,但版本选择与 PR 目标不一致。该 PR 目标是自动回移到 release-8.5 分支,而描述仅勾选了 master。相关 PR 编号也存在不一致。 勾选 v8.5,并根据实际来源补充或更正相关 PR 链接。若同时应用于 master,请一并勾选 master。
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed 标题准确概括了主要文档变更,即为 tidb_server_memory_limit 添加内存单位示例。标题简洁、明确,并与 PR 目标相关。
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.)

  • Fix all pre-merge checks with AI
✨ 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.

@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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 5ac468d1-86ed-4305-8ac3-247c2dea646b

📥 Commits

Reviewing files that changed from the base of the PR and between e7574d9 and 76ecb0b.

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

Comment thread system-variables.md Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
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. lgtm size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/bugfix This PR fixes a bug. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants