improve system-variables documentation by morgo · Pull Request #4598 · pingcap/docs

morgo · 2021-01-11T19:29:48Z

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 #4532 variables did not appear in alphabetical order
default values for booleans are incorrect #4531 Default values for booleans are incorrect
Document missing system variables #3155
TiDB executor concurrency is not documented (this was introduced in master and is an important setting. If Add doc for tidb_executor_concurrency docs-cn#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)

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

TomShawn · 2021-01-12T13:01:54Z

@morgo Would you please involve technical review first?

TomShawn · 2021-01-12T13:03:25Z

pingcap/docs-cn#3975 is merged and its translation is under review: #4602. PTAL

Co-authored-by: tangenta <tangenta@126.com>

tangenta

LGTM

ti-srebot · 2021-01-15T06:21:25Z

@tangenta, PTAL.

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

TomShawn

LGTM

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot · 2021-01-18T08:20:49Z

cherry pick to release-5.0 in PR #4647

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Morgan Tocker <tocker@gmail.com>

improve system-variables documentation

230b7a7

morgo force-pushed the fix-sysvar-order branch from 6a8c03c to 46ebfba Compare January 11, 2021 19:36

fix lint issues

5a279f1

morgo force-pushed the fix-sysvar-order branch from 46ebfba to 5a279f1 Compare January 11, 2021 19:41

Merge remote-tracking branch 'upstream/master' into fix-sysvar-order

8b1b188

TomShawn added needs-cherry-pick-5.0 status/PTAL This PR is ready for reviewing. translation/doing This PR's assignee is translating this PR. labels Jan 13, 2021

TomShawn self-assigned this Jan 13, 2021

Merge remote-tracking branch 'upstream/master' into fix-sysvar-order

2bf362c

tangenta reviewed Jan 13, 2021

View reviewed changes

Comment thread system-variables.md Outdated

tangenta reviewed Jan 13, 2021

View reviewed changes

Comment thread system-variables.md Outdated

morgo and others added 2 commits January 12, 2021 23:18

Update system-variables.md

e47188e

Co-authored-by: tangenta <tangenta@126.com>

Update system-variables.md

b08a7e6

Co-authored-by: tangenta <tangenta@126.com>

tangenta reviewed Jan 13, 2021

View reviewed changes

ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Jan 13, 2021

TomShawn reviewed Jan 15, 2021

View reviewed changes

Comment thread system-variables.md

TomShawn reviewed Jan 15, 2021

View reviewed changes

Comment thread system-variables.md Outdated

Comment thread system-variables.md Outdated

Comment thread system-variables.md Outdated

Comment thread system-variables.md

Comment thread system-variables.md Outdated

morgo and others added 7 commits January 16, 2021 21:16

Update system-variables.md

7e243ae

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update system-variables.md

9ac160a

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update system-variables.md

9ac216b

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Update system-variables.md

36468c8

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Merge branch 'master' into fix-sysvar-order

daee65f

Update system-variables.md

7cdef5e

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>

Merge branch 'master' into fix-sysvar-order

9e23d0b

TomShawn approved these changes Jan 18, 2021

View reviewed changes

ti-srebot removed the status/LGT1 Indicates that a PR has LGTM 1. label Jan 18, 2021

ti-srebot approved these changes Jan 18, 2021

View reviewed changes

ti-srebot added the status/LGT2 Indicates that a PR has LGTM 2. label Jan 18, 2021

pingcap deleted a comment from morgo Jan 18, 2021

TomShawn merged commit 3339a09 into pingcap:master Jan 18, 2021

ti-srebot pushed a commit to ti-srebot/docs that referenced this pull request Jan 18, 2021

cherry pick pingcap#4598 to release-5.0

847dcc9

Signed-off-by: ti-srebot <ti-srebot@pingcap.com>

ti-srebot mentioned this pull request Jan 18, 2021

improve system-variables documentation (#4598) #4647

Merged

10 tasks

TomShawn pushed a commit that referenced this pull request Jan 18, 2021

cherry pick #4598 to release-5.0 (#4647)

d189416

Signed-off-by: ti-srebot <ti-srebot@pingcap.com> Co-authored-by: Morgan Tocker <tocker@gmail.com>

TomShawn mentioned this pull request Feb 19, 2021

Fix a wrong version mark and descrption in system-variable.md #4843

Merged

10 tasks

TomShawn added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR's assignee is translating this PR. labels Feb 19, 2021

TomShawn mentioned this pull request Feb 19, 2021

improve system-variables documentation pingcap/docs-cn#5541

Merged

10 tasks

ti-srebot mentioned this pull request Feb 23, 2021

improve system-variables documentation (#5541) pingcap/docs-cn#5586

Merged

10 tasks

shichun-0415 mentioned this pull request Feb 2, 2023

Document missing system variables #3155

Closed

22 tasks

ti-chi-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Feb 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

improve system-variables documentation#4598

improve system-variables documentation#4598
TomShawn merged 13 commits into
pingcap:masterfrom
morgo:fix-sysvar-order

morgo commented Jan 11, 2021 •

edited by shichun-0415

Loading

Uh oh!

TomShawn commented Jan 12, 2021

Uh oh!

TomShawn commented Jan 12, 2021

Uh oh!

Uh oh!

Uh oh!

tangenta left a comment

Uh oh!

ti-srebot commented Jan 15, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TomShawn left a comment

Uh oh!

ti-srebot commented Jan 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

morgo commented Jan 11, 2021 • edited by shichun-0415 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

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

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

Do your changes match any of the following descriptions?

Uh oh!

TomShawn commented Jan 12, 2021

Uh oh!

TomShawn commented Jan 12, 2021

Uh oh!

Uh oh!

Uh oh!

tangenta left a comment

Choose a reason for hiding this comment

Uh oh!

ti-srebot commented Jan 15, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TomShawn left a comment

Choose a reason for hiding this comment

Uh oh!

ti-srebot commented Jan 18, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

morgo commented Jan 11, 2021 •

edited by shichun-0415

Loading