Skip to content

docs: use a shorter SHOW VARIABLES example#23176

Open
doc-claw-bot wants to merge 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-show-variables-output
Open

docs: use a shorter SHOW VARIABLES example#23176
doc-claw-bot wants to merge 4 commits into
pingcap:masterfrom
doc-claw-bot:docs/fix-show-variables-output

Conversation

@doc-claw-bot

@doc-claw-bot doc-claw-bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

What is changed, added or deleted? (Required)

  • replace the outdated SHOW GLOBAL VARIABLES LIKE 'tidb%' example with a shorter verified SHOW GLOBAL VARIABLES LIKE 'tidb_stmt_summary%' example
  • avoid the disputed tidb_wait_split_region_finish row in the example output
  • keep the other SQL examples unchanged

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

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)

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

  • This PR is translated from:
  • Other reference link(s):
    • Verified against a local TiDB v8.5.6 instance for the replacement example query.

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 commented Jul 1, 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 lilin90 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. needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Jul 1, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 1, 2026

Copy link
Copy Markdown

Hi @doc-claw-bot. 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 added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 1, 2026

@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 updates the sql-statement-show-variables.md documentation by truncating the long example output of SHOW GLOBAL VARIABLES LIKE 'tidb%' to a shorter, representative list, and updating the introductory text. The reviewer suggested a minor phrasing improvement to change "part of the TiDB-specific global variables" to "some of the TiDB-specific global variables" to enhance readability and use more idiomatic technical English.

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.

## Examples

List all TiDB specific variables. For detailed description, refer to [System Variables](/system-variables.md).
The following example shows part of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md).

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.

low

To improve readability and use more idiomatic technical English, consider changing "part of the TiDB-specific global variables" to "some of the TiDB-specific global variables".

Suggested change
The following example shows part of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md).
The following example shows some of the TiDB-specific global variables. For detailed descriptions, refer to [System Variables](/system-variables.md).
References
  1. Clarity, simplicity, completeness, and readability are key aspects of documentation review. (link)

@doc-claw-bot doc-claw-bot changed the title docs: refresh SHOW VARIABLES example output docs: use a shorter SHOW VARIABLES example Jul 1, 2026
Comment thread sql-statements/sql-statement-show-variables.md Outdated
Comment thread sql-statements/sql-statement-show-variables.md Outdated
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. 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/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants