From deb40840ed844b499777d5bbe58a7b9d97ffe4e7 Mon Sep 17 00:00:00 2001
From: Liuxiaozhen12 <82579298+Liuxiaozhen12@users.noreply.github.com>
Date: Wed, 22 Sep 2021 15:20:50 +0800
Subject: [PATCH 1/2] docs: update pd-configuration about upgrade
---
pd-configuration-file.md | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/pd-configuration-file.md b/pd-configuration-file.md
index 85e48778ac964..0422c98d35688 100644
--- a/pd-configuration-file.md
+++ b/pd-configuration-file.md
@@ -267,11 +267,15 @@ Configuration items related to scheduling
+ Determines whether to enable the merging of cross-table Regions
+ Default value: `true`
-### `region-score-formula-version`
+### `region-score-formula-version` New in v5.0
+ Controls the version of the Region score formula
+ Default value: `v2`
-+ Optional values: `v1` and `v2`
++ Optional values: `v1` and `v2`. Compared to v1, the changes in v2 are smoother, and the scheduling jitter caused by space recovery is improved.
+
+> **Note:**
+>
+> If you upgrade from TiDB 4.0 versions to the current versions, the new formula version is automatically disabled by default to ensure consistent PD behavior before and after upgrading. If you want to change the formula version, you need to manually switch through the `pd-ctl` setting. For details, refer to [PD Control](/pd-control.md#config-show--set-option-value--placement-rules).
### `enable-joint-consensus` New in v5.0
@@ -316,6 +320,10 @@ Configuration items related to replicas
+ Default value: 3
+ PD rounds the lowest digits of the flow number, which reduces the update of statistics caused by the changes of the Region flow information. This configuration item is used to specify the number of lowest digits to round for the Region flow information. For example, the flow `100512` will be rounded to `101000` because the default value is `3`. This configuration replaces `trace-region-flow`.
+> **Note:**
+>
+> If you upgrade from TiDB 4.0 versions to the current versions, the behavior of `flow-round-by-digit` after the upgrading and the behavior of `trace-region-flow` before upgrading are consistent by default. This means that if the value of `trace-region-flow` is false before upgrading, then the value of `flow-round-by-digit` after upgrading is 127；if the value of `trace-region-flow` is true before upgrading, then the value of `flow-round-by-digit` after upgrading is 3.
+
## `label-property`
Configuration items related to labels
From 3034aa305f17212d1f04fd6802dd1bed35c0553a Mon Sep 17 00:00:00 2001
From: TomShawn <41534398+TomShawn@users.noreply.github.com>
Date: Wed, 29 Sep 2021 14:34:18 +0800
Subject: [PATCH 2/2] Apply suggestions from code review
---
pd-configuration-file.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/pd-configuration-file.md b/pd-configuration-file.md
index 0422c98d35688..e8cb82769eb36 100644
--- a/pd-configuration-file.md
+++ b/pd-configuration-file.md
@@ -271,11 +271,11 @@ Configuration items related to scheduling
+ Controls the version of the Region score formula
+ Default value: `v2`
-+ Optional values: `v1` and `v2`. Compared to v1, the changes in v2 are smoother, and the scheduling jitter caused by space recovery is improved.
++ Optional values: `v1` and `v2`. Compared to v1, the changes in v2 are smoother, and the scheduling jitter caused by space reclaim is improved.
> **Note:**
>
-> If you upgrade from TiDB 4.0 versions to the current versions, the new formula version is automatically disabled by default to ensure consistent PD behavior before and after upgrading. If you want to change the formula version, you need to manually switch through the `pd-ctl` setting. For details, refer to [PD Control](/pd-control.md#config-show--set-option-value--placement-rules).
+> If you have upgraded your cluster from a TiDB 4.0 version to the current version, the new formula version is automatically disabled by default to ensure consistent PD behavior before and after the upgrading. If you want to change the formula version, you need to manually switch through the `pd-ctl` setting. For details, refer to [PD Control](/pd-control.md#config-show--set-option-value--placement-rules).
### `enable-joint-consensus` New in v5.0
@@ -322,7 +322,7 @@ Configuration items related to replicas
> **Note:**
>
-> If you upgrade from TiDB 4.0 versions to the current versions, the behavior of `flow-round-by-digit` after the upgrading and the behavior of `trace-region-flow` before upgrading are consistent by default. This means that if the value of `trace-region-flow` is false before upgrading, then the value of `flow-round-by-digit` after upgrading is 127；if the value of `trace-region-flow` is true before upgrading, then the value of `flow-round-by-digit` after upgrading is 3.
+> If you have upgraded your cluster from a TiDB 4.0 version to the current version, the behavior of `flow-round-by-digit` after the upgrading and the behavior of `trace-region-flow` before the upgrading are consistent by default. This means that if the value of `trace-region-flow` is false before the upgrading, the value of `flow-round-by-digit` after the upgrading is 127; if the value of `trace-region-flow` is `true` before the upgrading, the value of `flow-round-by-digit` after the upgrading is `3`.
## `label-property`