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.

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

Optimize the description of disabling swap #7443

Conversation

shichun-0415
Copy link
Contributor

First-time contributors' checklist

What is changed, added or deleted? (Required)

Optimize the description of disabling swap

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 (in Chinese).

  • master (the latest development version)
  • v5.3 (TiDB 5.3 versions)
  • 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 Nov 9, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn

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.

@shichun-0415 shichun-0415 self-assigned this Nov 9, 2021
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 9, 2021
@shichun-0415 shichun-0415 added needs-cherry-pick-release-4.0 translation/doing This PR’s assignee is translating this PR. type/enhancement The issue or PR belongs to an enhancement. and removed missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 9, 2021
@shichun-0415 shichun-0415 added the ONCALL Relates to documentation oncall. label Nov 11, 2021
@ti-chi-bot
Copy link
Member

@AstroProfundis: Thanks for your review. The bot only counts approvals from reviewers and higher roles in list, but you're still welcome to leave your comments.

In response to this:

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 ti-community-infra/tichi repository.

@TomShawn TomShawn added the needs-cherry-pick-release-5.3 Should cherry pick this PR to release-5.3 branch. label Nov 19, 2021
@@ -108,9 +108,14 @@ aliases: ['/docs-cn/dev/check-before-deployment/']

## 检测及关闭系统 swap

本段介绍 swap 关闭方法。TiDB 运行需要有足够的内存,并且不建议使用 swap 作为内存不足的缓冲,这会降低性能。因此建议永久关闭系统 swap,并且不要使用 `swapoff -a` 方式关闭,否则重启机器后该操作会失效
不建议将 swap 用作内存,因为这会降低性能,建议永久关闭系统 swap。
Copy link
Contributor

Choose a reason for hiding this comment

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

感觉原来的说明很清晰,改后的描述显得很简略不清晰?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
不建议将 swap 用作内存,因为这会降低性能,建议永久关闭系统 swap。
TiDB 运行需要有足够的内存,但不建议使用 swap 作为内存不足的缓冲,因为这会降低性能,建议永久关闭系统 swap。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@TomShawn PTAL. Thanks.

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@ti-chi-bot ti-chi-bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 22, 2021
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #7648.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #7649.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #7650.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #7651.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #7652.

TomShawn added a commit that referenced this pull request Nov 24, 2021
* Optimize the description of disabling swap

* Apply suggestions from code review

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

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

* Update check-before-deployment.md

* Apply suggestions from code review

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

Co-authored-by: shichun-0415 <lishichun@pingcap.com>
Co-authored-by: shichun-0415 <89768198+shichun-0415@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@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 Nov 24, 2021
@shichun-0415 shichun-0415 deleted the Optimize-the-description-of-disabling-swap branch November 24, 2021 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-cherry-pick-release-5.3 Should cherry pick this PR to release-5.3 branch. ONCALL Relates to documentation oncall. size/XS Denotes a PR that changes 0-9 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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants