Skip to content

improve system-variables documentation#5541

Merged
TomShawn merged 4 commits into
pingcap:masterfrom
TomShawn:sysvar-revfinew
Feb 23, 2021
Merged

improve system-variables documentation#5541
TomShawn merged 4 commits into
pingcap:masterfrom
TomShawn:sysvar-revfinew

Conversation

@TomShawn
Copy link
Copy Markdown
Contributor

@TomShawn TomShawn commented Feb 19, 2021 •
edited
Loading

What is changed, added or deleted? (Required)

The system variables documentation is incomplete and out of date. This helps improve it, but there are still many issues.

The following issues were fixed:

  • new system variables are not documented in alphabetical order docs#4532 variables did not appear in alphabetical order
  • default values for booleans are incorrect docs#4531 Default values for booleans are incorrect
  • TiDB executor concurrency is not documented (this was introduced in master and is an important setting. If Add doc for tidb_executor_concurrency #3975 merges, the translation can be overwritten here.)
  • The defaults for other executor concurrency options were incorrect. They also did not document if they were deprecated by executor concurrency.
  • The new options added have backticks in the heading. I've removed them for consistency.
  • The options auto_increment_increment, auto_increment_offset, port, socket, system_time_zone are now documented.
  • The description of tidb_check_mb4_value_in_utf8 was vague/incorrect. It checks for data outside of the BMP (i.e. "mysql utf8" not UTF-8).

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

  • master (the latest development version)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

What is the related PR or file 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

@TomShawn TomShawn added translation/from-docs This PR is translated from a PR in pingcap/docs. size/large Changes of a large size. status/PTAL This PR is ready for reviewing. needs-cherry-pick-5.0 labels Feb 19, 2021
ran-huang
ran-huang reviewed Feb 19, 2021
View reviewed changes
Comment thread system-variables.md
Comment thread system-variables.md Outdated
Comment thread system-variables.md
- 这个变量用于控制是否同时将各个执行算子的执行信息记录入 slow query log 中。

### `tidb_enable_fast_analyze`

Copy link
Copy Markdown
Contributor

@ran-huang ran-huang Feb 19, 2021

Choose a reason for hiding this comment

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

L431 should be OFF.

Copy link
Copy Markdown
Contributor Author

@TomShawn TomShawn Feb 19, 2021

Choose a reason for hiding this comment

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

Changed in bea8f63.

Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
Comment thread system-variables.md Outdated
TomShawn and others added 2 commits February 19, 2021 20:21
@TomShawn @ran-huang
Apply suggestions from code review
5dd2b20 
Co-authored-by: Ran <huangran@pingcap.com>
@TomShawn
update L431
bea8f63
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Feb 21, 2021

@ran-huang, @tangenta, PTAL.

ran-huang
ran-huang reviewed Feb 22, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@ran-huang ran-huang left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Feb 22, 2021
tangenta
tangenta reviewed Feb 23, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@tangenta tangenta left a comment

Choose a reason for hiding this comment

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

LGTM

@ti-srebot ti-srebot removed the status/LGT1 Indicates that a PR has LGTM 1. label Feb 23, 2021
@ti-srebot ti-srebot added the status/LGT2 Indicates that a PR has LGTM 2. label Feb 23, 2021
@TomShawn TomShawn merged commit 9b67d36 into pingcap:master Feb 23, 2021
@TomShawn TomShawn deleted the sysvar-revfinew branch February 23, 2021 11:36
ti-srebot pushed a commit to ti-srebot/docs-cn that referenced this pull request Feb 23, 2021
@TomShawn @ti-srebot
cherry pick pingcap#5541 to release-5.0
8049cfd 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>
@ti-srebot ti-srebot mentioned this pull request Feb 23, 2021
Merged
10 tasks
@ti-srebot
Copy link
Copy Markdown
Contributor

ti-srebot commented Feb 23, 2021

cherry pick to release-5.0 in PR #5586

TomShawn added a commit that referenced this pull request Feb 23, 2021
@ti-srebot @TomShawn
cherry pick #5541 to release-5.0 (#5586)
f9126db 
Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tangenta tangenta tangenta left review comments

@ti-srebot ti-srebot ti-srebot approved these changes

+1 more reviewer

@ran-huang ran-huang ran-huang left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

size/large Changes of a large size. status/LGT2 Indicates that a PR has LGTM 2. status/PTAL This PR is ready for reviewing. translation/from-docs This PR is translated from a PR in pingcap/docs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@TomShawn @ti-srebot @tangenta @ran-huang