Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

system-variables: Add units wherever possible #6622

Merged
merged 7 commits into from
Oct 25, 2021
Merged

system-variables: Add units wherever possible #6622

merged 7 commits into from
Oct 25, 2021

Conversation

morgo
Copy link
Contributor

@morgo morgo commented Oct 15, 2021

What is changed, added or deleted? (Required)

This adds units wherever possible, and removes it from the body description if redundant.

This helps improve readability and slightly reduce risk of misconfiguration.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • 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)?

  • 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

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Oct 15, 2021 •
edited
Loading

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn
  • dveeden

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 15, 2021
@morgo
Copy link
Contributor Author

morgo commented Oct 15, 2021

Note that I used the terminology "Threads" when they are really green threads (goroutines). I considered other options like "workers", but arrived at threads because I think this is easiest for users to understand.

@shichun-0415 shichun-0415 added translation/doing This PR's assignee is translating this PR. sig/docs Indicates that the Issue or PR belongs to the docs SIG. area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. type/enhancement The issue or PR belongs to an enhancement. and removed missing-translation-status This PR does not have translation status info. labels Oct 18, 2021
@TomShawn TomShawn assigned TomShawn and shichun-0415 and unassigned TomShawn Oct 18, 2021
dveeden
dveeden requested changes Oct 18, 2021
View reviewed changes
system-variables.md Outdated Show resolved Hide resolved
system-variables.md Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md
@@ -342,6 +345,7 @@ This variable is an alias for `last_insert_id`.
- Scope: SESSION | GLOBAL
- Default value: `18446744073709551615`
- Range: `[0, 18446744073709551615]`
- Unit: Rows
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should remove the "New in v4..." labels in the master branch. But that's outside of the scope of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See #4549

I agree with you. It reduces the readability.

system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
system-variables.md
@@ -897,6 +911,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified
- Scope: GLOBAL
- Default value: `-1`
- Range: `[1, 128]`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Range: `[1, 128]`
- Range: `-1, [1, 128]`

Some other variables have the same issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will have to think about this one. The value -1 is "special" in that it is reserved for the autovalue, which is kind of like NULL or infinity: it doesn't fit neatly in a range.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Lets change this in a future PR. I would like to add some docs on what the auto value is, and then have a separate line for: Permits Auto value: Yes.

system-variables.md Outdated Show resolved Hide resolved
system-variables.md Outdated Show resolved Hide resolved
morgo and others added 6 commits October 18, 2021 08:33
@morgo @dveeden
Update system-variables.md
c9dec13 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo @dveeden
Update system-variables.md
f02607f 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo @dveeden
Update system-variables.md
45703c6 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo @dveeden
Update system-variables.md
c896349 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo @dveeden
Update system-variables.md
c6f481e 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo @dveeden
Update system-variables.md
b73640f 
Co-authored-by: Daniël van Eeden <github@myname.nl>
@morgo morgo requested a review from dveeden October 20, 2021 00:58
@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Oct 20, 2021
@morgo morgo mentioned this pull request Oct 22, 2021
Merged
12 tasks
@morgo
Copy link
Contributor Author

morgo commented Oct 22, 2021

@TomShawn If we can merge this first, I will create a followup PR to change the ranges. pingcap/tidb#28842 merged which adjusts a lot of the previous values.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Oct 25, 2021
@TomShawn
Copy link
Contributor

/verify

@TomShawn
Copy link
Contributor

@TomShawn If we can merge this first, I will create a followup PR to change the ranges. pingcap/tidb#28842 merged which adjusts a lot of the previous values.

Thanks. I have approved it. You can merge it and create the follow-up PR.

@morgo
Copy link
Contributor Author

morgo commented Oct 25, 2021

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: b73640f

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Oct 25, 2021
@morgo morgo merged commit b5f75a7 into pingcap:master Oct 25, 2021
@morgo morgo deleted the add-units branch October 25, 2021 00:42
This was referenced Nov 2, 2021
Merged
Merged
Merged
@shichun-0415 shichun-0415 mentioned this pull request Jan 28, 2023
Merged
14 tasks
@shichun-0415 shichun-0415 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 Jan 28, 2023
This was referenced Feb 3, 2023
Merged
Merged
Merged
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dveeden dveeden dveeden approved these changes

@TomShawn TomShawn TomShawn approved these changes

@tangenta tangenta Awaiting requested review from tangenta

@AilinKid AilinKid Awaiting requested review from AilinKid

Assignees

@shichun-0415 shichun-0415

Labels
area/sql-infra Indicates that the Issue or PR belongs to the area of sql-infra and sql-metadata. sig/docs Indicates that the Issue or PR belongs to the docs SIG. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@morgo @ti-chi-bot @TomShawn @dveeden @shichun-0415