Skip to content

docs: unify "standardized" to "normalized" for SQL statements in sql-plan-management.md - #23581

Open
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-standardized-normalized-sql-2026-08-20
Open

docs: unify "standardized" to "normalized" for SQL statements in sql-plan-management.md#23581
yahonda wants to merge 1 commit into
pingcap:release-8.5from
yahonda:fix-standardized-normalized-sql-2026-08-20

Conversation

@yahonda

@yahonda yahonda commented Aug 20, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

sql-plan-management.md defines the term `Normalization` and uses "normalizes" / "normalized" consistently elsewhere in the same file (e.g. "The TiDB optimizer normalizes bound SQL statements", and the sql_digest table row "Digest of a normalized SQL statement"), but 3 sentences used the inconsistent synonym "standardized" for the exact same concept (a SQL statement that has gone through Normalization). This was found while investigating a related Japanese translation inconsistency that traced back to this English source ambiguity.

Unified all 3 occurrences to "normalized" to match the file's own defined terminology.

Origin of the "standardized" wording (found via git blame):

Both trace back to the same Chinese source term "标准化" (literally "standardize"), which this file's own English translation deliberately renders as "Normalization" as its formal defined term elsewhere - the "standardized" instances are just places where that established EN term wasn't applied consistently.

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)

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

@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 20, 2026
@pingcap-cla-assistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


test seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@yahonda
yahonda changed the base branch from master to release-8.5 August 20, 2026 06:48
@coderabbitai

coderabbitai Bot commented Aug 20, 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: b2078c31-fc60-469a-8fd4-ff5fde0abad9

📥 Commits

Reviewing files that changed from the base of the PR and between 8274565 and a920ee1.

📒 Files selected for processing (1)
  • sql-plan-management.md

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


📝 Walkthrough

Walkthrough

The binding documentation now uses “normalized SQL statement” terminology for binding replacement and baseline evolution.

Changes

SQL Plan Management documentation

Layer / File(s) Summary
Normalized statement terminology
sql-plan-management.md
Updated binding replacement and baseline evolution descriptions to refer to normalized SQL statements.

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

Merge Risk: ⚪ Minimal · up to a920e

This localized documentation-only terminology update is merge-ready after normal checks and review, with no actionable merge-blocking risk remaining.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
Title check ✅ Passed The title clearly and concisely describes the terminology change in the documentation.
Description check ✅ Passed The description explains the changes, affected version, references, AI involvement, and applicable change categories.
✨ 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.

@ti-chi-bot ti-chi-bot Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 20, 2026
…plan-management.md

This file defines the term `Normalization` and uses "normalizes" /
"normalized" consistently elsewhere (e.g. "The TiDB optimizer
normalizes bound SQL statements", "Digest of a normalized SQL
statement" in the sql_digest table), but 3 sentences used the
inconsistent synonym "standardized" for the same concept. Unified to
"normalized" to match the file's own defined terminology.
@yahonda
yahonda force-pushed the fix-standardized-normalized-sql-2026-08-20 branch from fdccc76 to a920ee1 Compare August 20, 2026 06:49
@ti-chi-bot ti-chi-bot Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 20, 2026
@qiancai qiancai self-assigned this Aug 21, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Aug 21, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 21, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-08-21 09:34:00.768843592 +0000 UTC m=+235075.939937708: ☑️ agreed by qiancai.

@qiancai qiancai added needs-cherry-pick-master Should cherry pick this PR to master branch. translation/no-need No need to translate this PR. and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. missing-translation-status This PR does not have translation status info. labels Aug 21, 2026
@qiancai

qiancai commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Aug 21, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 21, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 the approved label Aug 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-cherry-pick-master Should cherry pick this PR to master branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants