Skip to content

docs: fix tidb_server_memory_limit unit description (release-8.5) - #23660

Open
vjymisal0 wants to merge 1 commit into
pingcap:release-8.5from
vjymisal0:docs/fix-tidb-server-memory-limit-unit-8.5
Open

docs: fix tidb_server_memory_limit unit description (release-8.5)#23660
vjymisal0 wants to merge 1 commit into
pingcap:release-8.5from
vjymisal0:docs/fix-tidb-server-memory-limit-unit-8.5

Conversation

@vjymisal0

@vjymisal0 vjymisal0 commented Aug 29, 2026

Copy link
Copy Markdown

What is changed, added or deleted? (Required)

This gap exists on release-7.6 through release-8.4 as well; happy to open matching PRs for those branches if useful, or this could go through the needs-cherry-pick-release-* bot flow instead.

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

  • release-8.5

Summary by CodeRabbit

  • Documentation
    • Updated memory limit variable documentation to support both binary and decimal size units.
    • Added an example clarifying that no space is allowed between the numeric value and unit.

@ti-chi-bot

ti-chi-bot Bot commented Aug 29, 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 csuzhangxc 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 Aug 29, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 29, 2026

Copy link
Copy Markdown

Hi @vjymisal0. 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 commented Aug 29, 2026

Copy link
Copy Markdown

Welcome @vjymisal0!

It looks like this is your first PR to pingcap/docs 🎉.

I'm the bot to help you request reviewers, add labels and more, See available commands.

We want to make sure your contribution gets all the attention it needs!



Thank you, and welcome to pingcap/docs. 😃

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Aug 29, 2026
@pingcap-cla-assistant

pingcap-cla-assistant Bot commented Aug 29, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@ti-chi-bot ti-chi-bot Bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Aug 29, 2026
@coderabbitai

coderabbitai Bot commented Aug 29, 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: f2415a9b-fc67-4d4a-ae42-1f46847cd314

📥 Commits

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

📒 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 updates two TiDB system variable descriptions. Both descriptions list binary and decimal memory units and add a 90GiB example that shows no space is allowed between the number and unit.

Changes

Memory unit documentation

Layer / File(s) Summary
Update memory variable descriptions
system-variables.md
The tidb_server_memory_limit and tidb_server_memory_limit_sess_min_size descriptions now list KiB|MiB|GiB|TiB and KB|MB|GB|TB formats. Each description includes the 90GiB no-space example.

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

Merge Risk: ⚪ Minimal · up to a6bbd

This localized documentation update clarifies supported memory-limit units and adds an example; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: ti-chi-bot, qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation fix and the affected release branch.
Description check ✅ Passed The description explains the documentation change, its purpose, affected version, and related backport context. The required sections are sufficiently complete; optional checklist sections are omitted…
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 explains the documentation change, its purpose, affected version, and related backport context. The required sections are sufficiently complete; optional checklist sections are omitted.

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.

Backport of the master fix (pingcap#23587) to release-8.5: clarify that both
'KiB|MiB|GiB|TiB' and 'KB|MB|GB|TB' unit formats are supported, and add
a 90GiB example.
@vjymisal0
vjymisal0 force-pushed the docs/fix-tidb-server-memory-limit-unit-8.5 branch 2 times, most recently from b0c8c16 to 22aa963 Compare August 29, 2026 07:57
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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant