Skip to content

i18n(ja): unify the optimizer fix control feature name notation - #23630

Merged
qiancai merged 5 commits into
i18n-ja-release-8.5from
fix-optimizer-fix-control-term-en
Aug 28, 2026
Merged

i18n(ja): unify the optimizer fix control feature name notation#23630
qiancai merged 5 commits into
i18n-ja-release-8.5from
fix-optimizer-fix-control-term-en

Conversation

@yahonda

@yahonda yahonda commented Aug 27, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

The general feature name (Optimizer Fix Controls, オプティマイザ修正コントロール) is a normal translated title in this corpus, like its sibling TOC entries (SQLプラン管理, etc.) — this PR unifies the two competing pre-existing Japanese renderings for it (修正制御/修正コントロール) to 修正コントロール everywhere it names the feature/mechanism as a whole (page title, headings, TOC/cross-reference links, mechanism-level release-note prose).

A reference to one specific numbered fix control item (e.g. "optimizer fix control 54337", "this fix control", "Fix Control #44855") reads more like an identifier than a title, and EN itself never capitalizes these as the branded feature name — kept/restored to English at each such site, for consistency with EN and with pre-existing correctly-English sites already found in release-8.5.7.md.

The system variable identifier `tidb_opt_fix_control` (backticked, a real system variable) stays literal throughout, as it always has.

Also fixed along the way

  • optimizer-fix-controls.md: a scrambled "Possible values" line (可能\OFF`値: `ON`instead of可能な値: `ON`、`OFF``), repeated 12 times in the file.
  • releases/release-7.2.0.md: a stray dangling text fragment (オプティマ) left before a link.
  • optimizer-fix-controls.md: a missing opening backtick around `tidb_opt_fix_control` in the frontmatter summary.
  • best-practices/multi-column-index-best-practices.md: 派生範囲/派生した範囲 → 導出された範囲 and 行式 → 行の式, matching this file's own established terminology; also a missing space before a bold numbered fix-control reference.
  • releases/release-8.5.7.md: a missing space between a Japanese particle and an embedded English phrase.

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

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.5 versions)

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

  • This PR is translated from:
  • Other reference 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

Direction decided 2026-07-24/08-04: オプティマイザ (no ー) matches
the dominant corpus form and optimizer-hints.md's own H1. Fresh
recount: 592 no-vowel vs 259 with-vowel (~70/30). Mechanical
substring replace, verified 0 remaining オプティマイザー and no
double-vowel artifacts. 116 files, 259 occurrences.
Optimizer Fix Controls (and the per-item "fix control") is a specific
TiDB feature/mechanism name, not a descriptive phrase, so it should
stay literal rather than be translated as オプティマイザ修正制御/
オプティマイザ修正コントロール. Also fixes a stray dangling text
fragment in release-7.2.0.md and unifies 派生範囲/行式 in
multi-column-index-best-practices.md to match the file's own
established 導出 terminology and natural JA phrasing.
@ti-chi-bot ti-chi-bot Bot added area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. labels Aug 27, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 27, 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 breezewish 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 the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 27, 2026
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Changes

Optimizer documentation terminology

Layer / File(s) Summary
Optimizer Fix Controls naming
optimizer-fix-controls.md, TOC*.md, control-execution-plan.md, system-variable-reference.md, system-variables.md, tidb-performance-tuning-config.md
Standardizes Optimizer Fix Controls labels, terminology, descriptions, and value-format text.
Optimizer terminology in technical guides
*.md, best-practices/*, develop/*, sql-statements/*, tiflash/*
Normalizes Japanese optimizer and optimizer-hint terminology across technical documentation.
Release note terminology
releases/*
Updates historical release-note terminology, Optimizer Fix Controls names, and related wording.
Cloud, benchmark, and TiFlash documentation
benchmark/*, tidb-cloud/*, tiflash/*, tiup/*
Normalizes terminology and re-indents two TiFlash performance sub-bullets.
Plan replayer description
sql-plan-replayer.md
Clarifies that PLAN REPLAYER CAPTURE captures optimizer information for SQL statements and execution plans, then exports matching information as a ZIP file.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: 🔵 Low · up to 7da9b

The PR is mergeable with explicit owner follow-up for several localized Japanese documentation issues, including an inconsistent link label, imprecise release-note wording, a Markdown delimiter defect, and unclear or inconsistent terminology. The likely impact is limited to documentation clarity and rendering.

Suggested reviewers: invalid-email-address, qiancai

🚥 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. 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.
Title check ✅ Passed The title clearly describes the primary change: unifying the Japanese notation for the Optimizer Fix Controls feature across the documentation.
Description check ✅ Passed The description includes the required change summary, affected version, AI involvement, and change-category checklist. The empty reference-link fields are non-critical because no references are requir…
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. (13 skipped: 13 unsupported.)

Full details: Description check

Explanation

The description includes the required change summary, affected version, AI involvement, and change-category checklist. The empty reference-link fields are non-critical because no references are required for this documentation-only change.

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-optimizer-fix-control-term-en

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: 4


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: a86cc6a5-012c-42f4-83ea-960939bdfcbe

📥 Commits

Reviewing files that changed from the base of the PR and between a349332 and 483b975.

📒 Files selected for processing (119)
  • TOC-tidb-cloud-essential.md
  • TOC-tidb-cloud-premium.md
  • TOC-tidb-cloud-starter.md
  • TOC-tidb-cloud.md
  • TOC.md
  • agg-distinct-optimization.md
  • analyze-slow-queries.md
  • benchmark/benchmark-tidb-using-ch.md
  • benchmark/v4.0-performance-benchmarking-with-tpch.md
  • best-practices/index-management-best-practices.md
  • best-practices/multi-column-index-best-practices.md
  • comment-syntax.md
  • control-execution-plan.md
  • ddl_embedded_analyze.md
  • derive-topn-from-window.md
  • develop/dev-guide-hybrid-oltp-and-olap-queries.md
  • develop/dev-guide-index-best-practice.md
  • develop/dev-guide-join-tables.md
  • explain-index-merge.md
  • explain-indexes.md
  • explain-joins.md
  • extended-statistics.md
  • faq/sql-faq.md
  • functions-and-operators/tidb-functions.md
  • generated-columns.md
  • information-schema/information-schema-tiflash-replica.md
  • optimizer-fix-controls.md
  • optimizer-hints.md
  • quick-start-with-htap.md
  • releases/release-1.0-ga.md
  • releases/release-1.1-alpha.md
  • releases/release-2.0-ga.md
  • releases/release-2.0-rc.1.md
  • releases/release-2.0.4.md
  • releases/release-2.1-beta.md
  • releases/release-2.1-ga.md
  • releases/release-2.1-rc.1.md
  • releases/release-2.1-rc.2.md
  • releases/release-2.1-rc.3.md
  • releases/release-2.1-rc.4.md
  • releases/release-2.1-rc.5.md
  • releases/release-2.1.1.md
  • releases/release-2.1.16.md
  • releases/release-2.1.17.md
  • releases/release-2.1.18.md
  • releases/release-2.1.19.md
  • releases/release-2.1.3.md
  • releases/release-2.1.4.md
  • releases/release-2.1.5.md
  • releases/release-2.1.6.md
  • releases/release-3.0-beta.md
  • releases/release-3.0-ga.md
  • releases/release-3.0.0-beta.1.md
  • releases/release-3.0.0-rc.1.md
  • releases/release-3.0.0-rc.2.md
  • releases/release-3.0.0-rc.3.md
  • releases/release-3.0.2.md
  • releases/release-3.0.3.md
  • releases/release-3.0.4.md
  • releases/release-3.0.5.md
  • releases/release-3.0.6.md
  • releases/release-3.0.8.md
  • releases/release-3.1.0-beta.md
  • releases/release-5.0.0-rc.md
  • releases/release-6.1.0.md
  • releases/release-6.1.1.md
  • releases/release-6.3.0.md
  • releases/release-6.4.0.md
  • releases/release-6.5.0.md
  • releases/release-6.5.10.md
  • releases/release-6.5.7.md
  • releases/release-6.6.0.md
  • releases/release-7.0.0.md
  • releases/release-7.1.0.md
  • releases/release-7.1.6.md
  • releases/release-7.2.0.md
  • releases/release-7.4.0.md
  • releases/release-7.5.3.md
  • releases/release-7.5.7.md
  • releases/release-7.6.0.md
  • releases/release-8.0.0.md
  • releases/release-8.1.0.md
  • releases/release-8.1.1.md
  • releases/release-8.4.0.md
  • releases/release-pre-ga.md
  • releases/release-rc.1.md
  • releases/release-rc.2.md
  • releases/release-rc.3.md
  • releases/release-rc.4.md
  • sql-non-prepared-plan-cache.md
  • sql-physical-optimization.md
  • sql-plan-management.md
  • sql-plan-replayer.md
  • sql-prepared-plan-cache.md
  • sql-statements/sql-statement-alter-index.md
  • sql-statements/sql-statement-select.md
  • sql-statements/sql-statement-set-variable.md
  • sql-tuning-best-practice.md
  • subquery-optimization.md
  • system-variable-reference.md
  • system-variables.md
  • tidb-cloud/releases/release-notes-2022.md
  • tidb-cloud/serverless-faqs.md
  • tidb-cloud/tidb-cloud-htap-quickstart.md
  • tidb-cloud/tidb-cloud-sql-tuning-overview.md
  • tidb-cloud/v6.5-performance-benchmarking-with-tpcc.md
  • tidb-cloud/v7.1-performance-benchmarking-with-tpcc.md
  • tidb-cloud/v7.5-performance-benchmarking-with-tpcc.md
  • tidb-cloud/v8.1-performance-benchmarking-with-tpcc.md
  • tidb-cloud/v8.5-performance-benchmarking-with-tpcc.md
  • tidb-performance-tuning-config.md
  • tiflash-performance-tuning-methods.md
  • tiflash/tiflash-late-materialization.md
  • tiflash/tiflash-overview.md
  • tiflash/tune-tiflash-performance.md
  • tiflash/use-tidb-to-read-tiflash.md
  • tiflash/use-tiflash-mpp-mode.md
  • tiup/tiup-bench.md
  • wrong-index-solution.md

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

Comment thread agg-distinct-optimization.md Outdated
Comment thread agg-distinct-optimization.md Outdated
Comment thread generated-columns.md
Comment thread releases/release-8.4.0.md Outdated
@yahonda yahonda changed the title i18n(ja): keep Optimizer Fix Control(s) feature name in English i18n(ja): unify 修正制御/修正コントロール notation to 修正コントロール Aug 27, 2026
@ti-chi-bot ti-chi-bot Bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Aug 27, 2026
@yahonda yahonda changed the title i18n(ja): unify 修正制御/修正コントロール notation to 修正コントロール i18n(ja): unify the optimizer fix control feature name notation Aug 27, 2026
@yahonda
yahonda force-pushed the fix-optimizer-fix-control-term-en branch 2 times, most recently from b94023f to a7da5a8 Compare August 27, 2026 06:07
The general feature name (Optimizer Fix Controls, オプティマイザ修正
コントロール) is a normal translated title, like its sibling TOC
entries (SQLプラン管理, etc.) — unifies the two competing pre-existing
Japanese renderings (修正制御/修正コントロール) to 修正コントロール
everywhere it names the feature/mechanism as a whole (page title,
headings, TOC/cross-reference links, mechanism-level release-note
prose).

A reference to one specific numbered fix control item (e.g. "optimizer
fix control 54337", "this fix control", "Fix Control #44855") reads
more like an identifier than a title, and EN itself never capitalizes
these as the branded feature name — kept/restored to English at each
such site for consistency with EN and with pre-existing correctly-
English sites found in release-8.5.7.md.

The system variable identifier `tidb_opt_fix_control` (backticked, a
real system variable) stays literal throughout, as it always has.

Also fixes, found along the way:
- optimizer-fix-controls.md: a scrambled "Possible values" line
  (可能`OFF`値: `ON` instead of 可能な値: `ON`、`OFF`) repeated 12 times.
- releases/release-7.2.0.md: a stray dangling text fragment before a
  link.
- optimizer-fix-controls.md: a missing opening backtick around
  `tidb_opt_fix_control` in the frontmatter summary.
- best-practices/multi-column-index-best-practices.md: 派生範囲/
  派生した範囲 → 導出された範囲 and 行式 → 行の式, matching this
  file's own established terminology; also a missing space before a
  bold numbered fix-control reference.
- releases/release-8.5.7.md: a missing space between a Japanese
  particle and an embedded English phrase.
@yahonda
yahonda force-pushed the fix-optimizer-fix-control-term-en branch from a7da5a8 to 7da9b47 Compare August 27, 2026 06:09

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


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 0cb64b6c-f82c-496b-b55c-f3421e94f8e7

📥 Commits

Reviewing files that changed from the base of the PR and between 483b975 and 7da9b47.

📒 Files selected for processing (13)
  • TOC-tidb-cloud-essential.md
  • TOC-tidb-cloud-premium.md
  • TOC-tidb-cloud-starter.md
  • TOC-tidb-cloud.md
  • TOC.md
  • control-execution-plan.md
  • optimizer-fix-controls.md
  • releases/release-7.2.0.md
  • releases/release-7.3.0.md
  • releases/release-8.5.7.md
  • system-variable-reference.md
  • system-variables.md
  • tidb-performance-tuning-config.md

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

Comment thread control-execution-plan.md
Comment thread releases/release-7.3.0.md Outdated
- agg-distinct-optimization.md: restore a missing opening backtick
  around distinct, and fix a clause-ordering mistranslation that
  misattributed "for aggregate functions" to the wrong DISTINCT form.
- releases/release-8.4.0.md: complete a dangling sentence about the
  estRows minimum-value fix control, reusing the phrasing already
  established on optimizer-fix-controls.md's own entry for the same
  fix number.
- releases/release-7.3.0.md: reword an awkward "optimize the ...
  issue" translation to the more natural "improve the overestimation".
@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Aug 28, 2026
@qiancai
qiancai merged commit 42d00a9 into i18n-ja-release-8.5 Aug 28, 2026
4 of 9 checks passed
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Aug 28, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 28, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-08-28 08:18:23.473317594 +0000 UTC m=+835338.644411724: ☑️ agreed by qiancai.

@qiancai
qiancai deleted the fix-optimizer-fix-control-term-en branch August 28, 2026 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XXL Denotes a PR that changes 1000+ 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