Skip to content

config: fix heading hierarchy for sub-section levels in tidb-configuration-file.md (#23160)#23167

Open
ti-chi-bot wants to merge 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23160-to-master
Open

config: fix heading hierarchy for sub-section levels in tidb-configuration-file.md (#23160)#23167
ti-chi-bot wants to merge 2 commits into
pingcap:masterfrom
ti-chi-bot:cherry-pick-23160-to-master

Conversation

@ti-chi-bot

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23160

What is changed, added or deleted? (Required)

Fix heading hierarchy in tidb-configuration-file.md for sub-section levels that incorrectly used ## instead of ###:

  • ## log.file### log.file (child of ## log)
  • ## opentracing.sampler### opentracing.sampler (child of ## opentracing)
  • ## opentracing.reporter### opentracing.reporter (child of ## opentracing)
  • ## tikv-client.copr-cache### tikv-client.copr-cache (child of ## tikv-client)

These dotted config key names indicate they belong to parent sections, so they should be rendered as sub-headings.

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

  • 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)?

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

yahonda added 2 commits June 29, 2026 10:55
Change sub-section headings from ## to ### to properly reflect
the config key hierarchy:

- ## log.file → ### log.file (child of ## log)
- ## opentracing.sampler → ### opentracing.sampler
- ## opentracing.reporter → ### opentracing.reporter
- ## tikv-client.copr-cache → ### tikv-client.copr-cache
@ti-chi-bot ti-chi-bot added lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR. labels Jun 29, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 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

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adjusts the markdown heading levels in tidb-configuration-file.md for several configuration sections, including log.file, opentracing.sampler, opentracing.reporter, and tikv-client.copr-cache, to establish a correct and consistent heading hierarchy. There are no review comments, and I have no additional feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. type/cherry-pick-for-master This PR is cherry-picked to master from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants