Skip to content

docs: add memory unit example for tidb_server_memory_limit (#23587) - #23657

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

docs: add memory unit example for tidb_server_memory_limit (#23587)#23657
ti-chi-bot wants to merge 4 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23587-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 #23587

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.

  • 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

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 memory-size configuration guidance to support decimal units (KB, MB, GB, TB) alongside binary units.
    • Added a 90GiB usage example.

@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 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

@coderabbitai

coderabbitai Bot commented Aug 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: f12acf43-4b90-49ce-9a26-014b58476cce

📥 Commits

Reviewing files that changed from the base of the PR and between 965cdb9 and 0769740.

📒 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

The documentation for two TiDB system variables now includes decimal memory units (KB|MB|GB|TB) alongside binary units and adds a 90GiB example.

Changes

Memory-size documentation

Layer / File(s) Summary
Document supported memory-size formats
system-variables.md
The descriptions for tidb_server_memory_limit and tidb_server_memory_limit_sess_min_size now list decimal units and include a 90GiB example.

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

Merge Risk: ⚪ Minimal · up to 07697

This change only clarifies the documented memory-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 The description includes the required change summary, version section, reference link, and change-type checklist. However, it selects master while the PR objective identifies this as an automated cher… Confirm the target version. Select v8.5 instead of master if this PR targets the release-8.5 branch, or update the objective to explain why master is correct.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change and the specific memory-unit example added.
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: Description check

Explanation

The description includes the required change summary, version section, reference link, and change-type checklist. However, it selects master while the PR objective identifies this as an automated cherry-pick for the release-8.5 branch.

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.

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