From 48c34ee280c8f53da7fcf0df83137554b3d08690 Mon Sep 17 00:00:00 2001
From: Ryan Leung <rleungx@gmail.com>
Date: Thu, 23 Apr 2020 16:54:11 +0800
Subject: [PATCH 1/7] update the pd-ctl docs

Signed-off-by: Ryan Leung <rleungx@gmail.com>
---
 pd-control.md | 249 +++++++++++++++++++++++---------------------------
 1 file changed, 116 insertions(+), 133 deletions(-)

diff --git a/pd-control.md b/pd-control.md
index 638ea2153f14..7d3a3253f902 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -11,7 +11,7 @@ PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整
 ## 源码编译
 
 1. [Go](https://golang.org/) Version 1.9 以上
-2. 在 PD 项目根目录使用 `make` 命令进行编译，生成 bin/pd-ctl
+2. 在 PD 项目根目录使用 `make` 或者 `make pd-ctl` 命令进行编译，生成 bin/pd-ctl
 
 ## 下载安装包
 
@@ -72,17 +72,17 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 - 指定 PEM 格式的 SSL 证书的文件路径
 - 默认值：""
 
-### \-\-detach,-d
+### --detach,-d
 
 + 使用单命令行模式(不进入 readline)
 + 默认值: true
 
-### \-\-help,-h
+### --help,-h
 
 + 输出帮助信息
 + 默认值：false
 
-### \-\-interact,-i
+### --interact,-i
 
 + 使用交互模式（进入 readline）
 + 默认值：false
@@ -92,7 +92,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 - 指定 PEM 格式的 SSL 证书密钥文件路径，即 `--cert` 所指定的证书的私钥
 - 默认值: ""
 
-### \-\-pd,-u
+### --pd,-u
 
 + 指定 PD 的地址
 + 默认地址：`http://127.0.0.1:2379`
@@ -124,7 +124,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 }
 ```
 
-### config [show | set \<option> \<value>]
+### config [show | set <option> <value>]
 
 用于显示或调整配置信息。示例如下。
 
@@ -138,41 +138,42 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 
 ```
 {
-  "max-snapshot-count": 3,
-  "max-pending-peer-count": 16,
-  "max-merge-region-size": 50,
-  "max-merge-region-keys": 200000,
-  "split-merge-interval": "1h",
-  "patrol-region-interval": "100ms",
-  "max-store-down-time": "1h0m0s",
-  "leader-schedule-limit": 4,
-  "region-schedule-limit": 4,
-  "replica-schedule-limit":8,
-  "merge-schedule-limit": 8,
-  "tolerant-size-ratio": 5,
-  "low-space-ratio": 0.8,
-  "high-space-ratio": 0.6,
-  "disable-raft-learner": "false",
-  "disable-remove-down-replica": "false",
-  "disable-replace-offline-replica": "false",
-  "disable-make-up-replica": "false",
-  "disable-remove-extra-replica": "false",
-  "disable-location-replacement": "false",
-  "disable-namespace-relocation": "false",
-  "schedulers-v2": [
-    {
-      "type": "balance-region",
-      "args": null
-    },
-    {
-      "type": "balance-leader",
-      "args": null
-    },
-    {
-      "type": "hot-region",
-      "args": null
-    }
-  ]
+  "replication": {
+    "enable-placement-rules": "false",
+    "location-labels": "",
+    "max-replicas": 3,
+    "strictly-match-label": "false"
+  },
+  "schedule": {
+    "enable-cross-table-merge": "false",
+    "enable-debug-metrics": "true",
+    "enable-location-replacement": "true",
+    "enable-make-up-replica": "true",
+    "enable-one-way-merge": "false",
+    "enable-remove-down-replica": "true",
+    "enable-remove-extra-replica": "true",
+    "enable-replace-offline-replica": "true",
+    "high-space-ratio": 0.6,
+    "hot-region-cache-hits-threshold": 3,
+    "hot-region-schedule-limit": 4,
+    "leader-schedule-limit": 4,
+    "leader-schedule-policy": "count",
+    "low-space-ratio": 0.8,
+    "max-merge-region-keys": 200000,
+    "max-merge-region-size": 20,
+    "max-pending-peer-count": 16,
+    "max-snapshot-count": 3,
+    "max-store-down-time": "30m0s",
+    "merge-schedule-limit": 8,
+    "patrol-region-interval": "100ms",
+    "region-schedule-limit": 2048,
+    "replica-schedule-limit": 64,
+    "scheduler-max-waiting-operator": 5,
+    "split-merge-interval": "1h0m0s",
+    "store-balance-rate": 15,
+    "store-limit-mode": "manual",
+    "tolerant-size-ratio": 0
+  }
 }
 ```
 
@@ -184,23 +185,6 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 >> config show all
 ```
 
-显示名为 ts1 的 namespace 的相关 config 信息：
-
-{{< copyable "" >}}
-
-```bash
->> config show namespace ts1
-```
-
-```
-{
-  "leader-schedule-limit": 4,
-  "region-schedule-limit": 4,
-  "replica-schedule-limit": 8,
-  "max-replicas": 3,
-}
-```
-
 显示 replication 的相关 config 信息：
 
 {{< copyable "" >}}
@@ -212,7 +196,9 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 ```
 {
   "max-replicas": 3,
-  "location-labels": ""
+  "location-labels": "",
+  "strictly-match-label": "false",
+  "enable-placement-rules": "false"
 }
 ```
 
@@ -346,23 +332,17 @@ Merge 调度的开销较大，所以这个值不宜调得过大。
 >> config set merge-schedule-limit 16
 ```
 
-以上对配置的修改是全局性的，还可以通过对不同 namespace 的配置，进行细化调整。当 namespace 未设置相应配置时，使用全局配置。注：namespace 的配置只支持对 leader-schedule-limit，region-schedule-limit，replica-schedule-limit，max-replicas 的调整，否则不生效。
+`hot-region-schedule-limit` 控制同时进行的 Hot Region 调度的任务，设置为 0 则关闭调度。这个值不宜调得过大，否则可能对系统性能造成影响。
 
-设置名为 ts1 的 namespace 最多同时进行 4 个 leader 调度：
+最多同时进行 4 个 Hot Region 调度：
 
 {{< copyable "" >}}
 
 ```bash
->> config set namespace ts1 leader-schedule-limit 4
+>> config set hot-region-schedule-limit 4
 ```
 
-设置名为 ts2 的 namespace 最多同时进行 2 个 Region 调度：
-
-{{< copyable "" >}}
-
-```bash
->> config set namespace ts2 region-schedule-limit 2
-```
+`hot-region-cache-hits-threshold` 用于设置热点 Region 的阈值，只有超过命中 cache 的次数超过这个阈值才会被当作热点。
 
 `tolerant-size-ratio` 控制 balance 缓冲区大小。
 当两个 store 的 leader 或 Region 的得分差距小于指定倍数的 Region size 时，PD 会认为此时 balance 达到均衡状态。
@@ -397,6 +377,14 @@ config set low-space-ratio 0.9
 config set high-space-ratio 0.5
 ```
 
+`leader-schedule-policy` 用于选择 leader 的调度策略，可以选择按照 `size` 或者 `count` 来进行调度。
+
+`store-balance-rate` 用于控制 store 添加/删除 peer 速度的上限。
+
+`scheduler-max-waiting-operator` 用于控制每个调度器同时存在的 operator 的个数。
+
+`store-limit-mode` 用于控制 store 限速机制的模式。主要有两种模式：`auto` 和 `manual`。`auto` 模式下会根据 load 自动进行调整。
+
 `disable-raft-learner` 用于关闭 raft learner 功能。
 默认配置下 PD 在添加副本时会使用 raft learner 来降低宕机或网络故障带来的不可用风险。
 
@@ -419,48 +407,31 @@ config set disable-raft-learner true
 config set cluster-version 1.0.8
 ```
 
-`disable-remove-down-replica` 用于关闭自动删除 DownReplica 的特性。
-当设置为 true 时，PD 不会自动清理宕机状态的副本。
+`enable-cross-table-merge` 用于开启跨表 Region 的合并。
+当设置为 false 时，PD 不会合并不同表的 Region。
 
-`disable-replace-offline-replica` 用于关闭迁移 OfflineReplica 的特性。
-当设置为 true 时，PD 不会迁移下线状态的副本。
+`enable-one-way-merge` 用于开启是否只允许和相邻的后一个 Region 进行合并。
+当设置为 false 时，PD 允许与相邻的前后 Region 进行合并。
 
-`disable-make-up-replica` 用于关闭补充副本的特性。
-当设置为 true 时，PD 不会为副本数不足的 Region 补充副本。
+`enable-remove-down-replica` 用于开启自动删除 DownReplica 的特性。
+当设置为 false 时，PD 不会自动清理宕机状态的副本。
 
-`disable-remove-extra-replica` 用于关闭删除多余副本的特性。
-当设置为 true 时，PD 不会为副本数过多的 Region 删除多余副本。
+`enable-replace-offline-replica` 用于开启迁移 OfflineReplica 的特性。
+当设置为 false 时，PD 不会迁移下线状态的副本。
 
-`disable-location-replacement` 用于关闭隔离级别检查。
-当设置为 true 时，PD 不会通过调度来提升 Region 副本的隔离级别。
+`enable-make-up-replica` 用于开启补充副本的特性。
+当设置为 false 时，PD 不会为副本数不足的 Region 补充副本。
 
-`disable-namespace-relocation` 用于关闭 Region 的 namespace 调度。当设置为 true 时，PD 不会把 Region 调度到它所属的 Store 上。
+`enable-remove-extra-replica` 用于开启删除多余副本的特性。
+当设置为 false 时，PD 不会为副本数过多的 Region 删除多余副本。
 
-### config delete namespace \<name> [\<option>]
+`enable-location-replacement` 用于开启隔离级别检查。
+当设置为 false 时，PD 不会通过调度来提升 Region 副本的隔离级别。
 
-用于删除 namespace 的配置信息。
+`enable-debug-metrics` 用于开启 debug 的 metrics。
+当设置为 true 时，PD 会开启一些 metrics，比如 `balance-tolerant-size` 等。
 
-示例：
-
-在对 namespace 相关配置进行设置后，若想让该 namespace 继续使用全局配置，可删除该 namespace 的配置信息，之后便使用全局配置。
-
-删除名为 ts1 的 namespace 的相关配置：
-
-{{< copyable "" >}}
-
-```bash
->> config delete namespace ts1
-```
-
-若只想让 namespace 中的某项配置使用全局配置而不影响其他配置，则可使用如下命令：
-
-删除名为 ts2 的 namespace 的 region-schedule-limit 配置：
-
-{{< copyable "" >}}
-
-```bash
->> config delete namespace region-schedule-limit ts2
-```
+`enable-placement-rules` 用于开启 placement rules。
 
 ### health
 
@@ -517,7 +488,7 @@ config set cluster-version 1.0.8
 >> hot store
 ```
 
-### label [store \<name> \<value>]
+### label [store <name> <value>]
 
 用于显示集群标签信息。示例如下。
 
@@ -551,6 +522,7 @@ config set cluster-version 1.0.8
 
 ```
 {
+  "header": {......},
   "members": [......],
   "leader": {......},
   "etcd_leader": {......},
@@ -591,9 +563,10 @@ Success!
 
 ```
 {
-  "name": "pd",
-  "addr": "http://192.168.199.229:2379",
-  "id": 9724873857558226554
+   "name": "pd",
+   "member_id": 13155432540099656863,
+   "peer_urls": [......],
+   "client_urls": [......]
 }
 ```
 
@@ -621,7 +594,7 @@ Success!
 ......
 ```
 
-### operator [show | add | remove]
+### operator [check | show | add | remove]
 
 用于显示和控制调度操作，或者对 Region 进行分裂或合并。
 
@@ -643,6 +616,7 @@ Success!
 >> operator add split-region 1 --policy=approximate     // 将 Region 1 对半拆分成两个 Region，基于粗略估计值
 >> operator add split-region 1 --policy=scan            // 将 Region 1 对半拆分成两个 Region，基于精确扫描值
 >> operator remove 1                                    // 把 Region 1 的调度操作删掉
+>> operator check 1                                     // 查看 Region 1 相关 operator 的状态
 ```
 
 其中，Region 的分裂都是尽可能地从靠近中间的位置开始。对这个位置的选择支持两种策略，即 scan 和 approximate。它们之间的区别是，前者通过扫描这个 Region 的方式来确定中间的 key，而后者是通过查看 SST 文件中记录的统计信息，来得到近似的位置。一般来说，前者更加精确，而后者消耗更少的 I/O，可以更快地完成。
@@ -663,7 +637,7 @@ Success!
 time: 43.12698ms
 ```
 
-### region <region_id> [--jq="\<query string>"]
+### region <region_id> [--jq="<query string>"]
 
 用于显示 Region 信息。使用 jq 格式化输出请参考 [jq-格式化-json-输出示例](#jq-格式化-json-输出示例)。示例如下。
 
@@ -702,7 +676,7 @@ time: 43.12698ms
 }
 ```
 
-### region key [--format=raw|encode] \<key>
+### region key [--format=raw|encode] <key>
 
 用于查询某个 key 在哪个 Region 上，支持 raw 和 encoding 格式。使用 encoding 格式时，key 需要使用单引号。
 
@@ -873,7 +847,7 @@ Encoding 格式示例：
 }
 ```
 
-### region check [miss-peer | extra-peer | down-peer | pending-peer | incorrect-ns]
+### region check [miss-peer | extra-peer | down-peer | pending-peer]
 
 用于查询处于异常状态的 Region，各类型的意义如下
 
@@ -881,7 +855,6 @@ Encoding 格式示例：
 - extra-peer：多副本的 Region
 - down-peer：有副本状态为 Down 的 Region
 - pending-peer：有副本状态为 Pending 的 Region
-- incorrect-ns：有副本不符合 namespace 约束的 Region
 
 示例：
 
@@ -898,7 +871,7 @@ Encoding 格式示例：
 }
 ```
 
-### scheduler [show | add | remove]
+### scheduler [show | add | remove | pause | resume | config]
 
 用于显示和控制调度策略。
 
@@ -907,15 +880,20 @@ Encoding 格式示例：
 {{< copyable "" >}}
 
 ```bash
->> scheduler show                             // 显示所有的 schedulers
->> scheduler add grant-leader-scheduler 1     // 把 store 1 上的所有 Region 的 leader 调度到 store 1
->> scheduler add evict-leader-scheduler 1     // 把 store 1 上的所有 Region 的 leader 从 store 1 调度出去
->> scheduler add shuffle-leader-scheduler     // 随机交换不同 store 上的 leader
->> scheduler add shuffle-region-scheduler     // 随机调度不同 store 上的 Region
->> scheduler remove grant-leader-scheduler-1  // 把对应的 scheduler 删掉
+>> scheduler show                                 // 显示所有的 schedulers
+>> scheduler add grant-leader-scheduler 1         // 把 store 1 上的所有 Region 的 leader 调度到 store 1
+>> scheduler add evict-leader-scheduler 1         // 把 store 1 上的所有 Region 的 leader 从 store 1 调度出去
+>> scheduler add shuffle-leader-scheduler         // 随机交换不同 store 上的 leader
+>> scheduler add shuffle-region-scheduler         // 随机调度不同 store 上的 Region
+>> scheduler remove grant-leader-scheduler-1      // 把对应的 scheduler 删掉
+>> schedule pause balance-region-scheduler 10     // 暂停运行 balance-region 调度器 10 秒
+>> schedule pause all 10                          // 暂停运行所有的调度器 10 秒
+>> schedule resume balance-region-scheduler       // 继续运行 balance-region 调度器 
+>> schedule resume all                            // 继续运行所有的调度器 
+>> scheduler config balance-hot-region-scheduler  // 显示 balance-hot-region 调度器的配置
 ```
 
-### store [delete | label | weight] <store_id>  [--jq="\<query string>"]
+### store [delete | label | weight | remove-tombstone | limit | limit-scene] <store_id> [--jq="<query string>"]
 
 用于显示 store 信息或者删除指定 store。使用 jq 格式化输出请参考 [jq-格式化-json-输出示例](#jq-格式化-json-输出示例)。示例如下。
 
@@ -974,22 +952,27 @@ Encoding 格式示例：
 >> store weight 1 5 10
 ```
 
-### table_ns [create | add | remove | set_store | rm_store | set_meta | rm_meta]
-
-用于显示 table 的 namespace 的相关信息
-
-示例：
-
 {{< copyable "" >}}
 
 ```bash
->> table_ns add ts1 1            // 将 table id 为 1 的 table 添加到名为 ts1 的 namespace
->> table_ns create ts1           // 添加名为 ts1 的 namespace
->> table_ns remove ts1 1         // 将 table id 为 1 的 table 从名为 ts1 的 namespace 中移除
->> table_ns rm_meta ts1          // 将 meta 信息从名为 ts1 的 namespace 中移除
->> table_ns rm_store 1 ts1       // 将 store id 为 1 的 table 从名为 ts1 的 namespace 中移除
->> table_ns set_meta ts1         // 将 meta 信息添加到名为 ts1 的 namespace
->> table_ns set_store 1 ts1      // 将 store id 为 1 的 table 添加到名为 ts1 的 namespace
+>> store remove-tombstone              // 删除所有 tombstone 状态的 store 记录
+>> store limit                         // 显示所有 store 添加 peer 的速度上限
+>> store limit region-add              // 显示所有 store 添加 peer 的速度上限
+>> store limit region-remove           // 显示所有 store 删除 peer 的速度上限
+>> store limit all 5                   // 设置所有 store 添加 peer 的速度上限为每分钟 5 个
+>> store limit 1 5                     // 设置 store 1 添加 peer 的速度上限为每分钟 5 个
+>> store limit all 5 region-add        // 设置所有 store 添加 peer 的速度上限为每分钟 5 个
+>> store limit 1 5 region-add          // 设置 store 1 添加 peer 的速度上限为每分钟 5 个
+>> store limit 1 5 region-remove       // 设置 store 1 删除 peer 的速度上限为每分钟 5 个
+>> store limit all 5 region-remove     // 设置所有 store 删除 peer 的速度上限为每分钟 5 个
+>> store limit-scene                   // 显示不同 load 场景下，添加/删除 peer 的速度上限，仅在 `store-limit-mode` 为 `auto` 时有效
+{
+  "Idle": 100,
+  "Low": 50,
+  "Normal": 32,
+  "High": 12
+}
+>> store limit-scene idle 100          // 设置 load 为 idle 场景下，添加/删除 peer 的速度上限为每分钟 100 个
 ```
 
 ### tso

From adde74e7f6464433163353e7b3500c0ad7d68bc6 Mon Sep 17 00:00:00 2001
From: Ryan Leung <rleungx@gmail.com>
Date: Wed, 13 May 2020 15:16:12 +0800
Subject: [PATCH 2/7] add backslash back

Signed-off-by: Ryan Leung <rleungx@gmail.com>
---
 pd-control.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/pd-control.md b/pd-control.md
index 7d3a3253f902..490ccb1f1eec 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -124,7 +124,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 }
 ```
 
-### config [show | set <option> <value>]
+### config [show | set \<option> \<value>]
 
 用于显示或调整配置信息。示例如下。
 
@@ -488,7 +488,7 @@ config set cluster-version 1.0.8
 >> hot store
 ```
 
-### label [store <name> <value>]
+### label [store \<name> \<value>]
 
 用于显示集群标签信息。示例如下。
 
@@ -637,7 +637,7 @@ Success!
 time: 43.12698ms
 ```
 
-### region <region_id> [--jq="<query string>"]
+### region <region_id> [--jq="\<query string>"]
 
 用于显示 Region 信息。使用 jq 格式化输出请参考 [jq-格式化-json-输出示例](#jq-格式化-json-输出示例)。示例如下。
 
@@ -676,7 +676,7 @@ time: 43.12698ms
 }
 ```
 
-### region key [--format=raw|encode] <key>
+### region key [--format=raw|encode] \<key>
 
 用于查询某个 key 在哪个 Region 上，支持 raw 和 encoding 格式。使用 encoding 格式时，key 需要使用单引号。
 
@@ -893,7 +893,7 @@ Encoding 格式示例：
 >> scheduler config balance-hot-region-scheduler  // 显示 balance-hot-region 调度器的配置
 ```
 
-### store [delete | label | weight | remove-tombstone | limit | limit-scene] <store_id> [--jq="<query string>"]
+### store [delete | label | weight | remove-tombstone | limit | limit-scene] <store_id> [--jq="\<query string>"]
 
 用于显示 store 信息或者删除指定 store。使用 jq 格式化输出请参考 [jq-格式化-json-输出示例](#jq-格式化-json-输出示例)。示例如下。
 

From 58b26ca6ddc520977034dbe2d273d73a67f54fe7 Mon Sep 17 00:00:00 2001
From: Ran <huangran@pingcap.com>
Date: Wed, 13 May 2020 17:54:14 +0800
Subject: [PATCH 3/7] Update reference/tools/pd-control.md

---
 pd-control.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pd-control.md b/pd-control.md
index 490ccb1f1eec..5b16b99187fc 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -377,7 +377,7 @@ config set low-space-ratio 0.9
 config set high-space-ratio 0.5
 ```
 
-`leader-schedule-policy` 用于选择 leader 的调度策略，可以选择按照 `size` 或者 `count` 来进行调度。
+`leader-schedule-policy` 用于选择 Leader 的调度策略，可以选择按照 `size` 或者 `count` 来进行调度。
 
 `store-balance-rate` 用于控制 store 添加/删除 peer 速度的上限。
 

From 02b74a5aa001e166eb6e21ec90b09b30afaa282f Mon Sep 17 00:00:00 2001
From: Keke Yi <40977455+yikeke@users.noreply.github.com>
Date: Wed, 13 May 2020 23:16:04 +0800
Subject: [PATCH 4/7] *: simplify all file directories for master (#3092)

* *: simplify all file directories

* update deadlink

* fix 2 dead links caused by two deleted files

Co-authored-by: Qiang Zhou <zhouqiang.cl@gmail.com>
---
 tidb-binlog/troubleshoot-tidb-binlog.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tidb-binlog/troubleshoot-tidb-binlog.md b/tidb-binlog/troubleshoot-tidb-binlog.md
index 8b2a736785cb..23534e32a92f 100644
--- a/tidb-binlog/troubleshoot-tidb-binlog.md
+++ b/tidb-binlog/troubleshoot-tidb-binlog.md
@@ -1,7 +1,7 @@
 ---
 title: TiDB Binlog 故障诊断
 category: reference
-aliases: ['/docs-cn/dev/reference/tidb-binlog/troubleshoot/binlog/','/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
+aliases: ['/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
 ---
 
 # TiDB Binlog 故障诊断

From 87960adf262334171008cd79a63a854ab74bff81 Mon Sep 17 00:00:00 2001
From: Ryan Leung <rleungx@gmail.com>
Date: Fri, 22 May 2020 11:55:27 +0800
Subject: [PATCH 5/7] update more commands

Signed-off-by: Ryan Leung <rleungx@gmail.com>
---
 pd-control.md                           | 92 +++++++++++++++++++++----
 tidb-binlog/troubleshoot-tidb-binlog.md |  2 +-
 2 files changed, 81 insertions(+), 13 deletions(-)

diff --git a/pd-control.md b/pd-control.md
index 5b16b99187fc..b32b2adc79b7 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -10,7 +10,7 @@ PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整
 
 ## 源码编译
 
-1. [Go](https://golang.org/) Version 1.9 以上
+1. [Go](https://golang.org/) Version 1.13 以上
 2. 在 PD 项目根目录使用 `make` 或者 `make pd-ctl` 命令进行编译，生成 bin/pd-ctl
 
 ## 下载安装包
@@ -23,7 +23,7 @@ PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整
 
 > **注意：**
 >
-> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v3.0.5` 版本的下载链接为 `https://download.pingcap.org/tidb-v3.0.5-linux-amd64.tar.gz`。也可以使用 `latest` 替代 `{version}` 来下载最新的未发布版本。
+> 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v4.0.0-rc.2` 版本的下载链接为 `https://download.pingcap.org/tidb-v4.0.0-rc.2-linux-amd64.tar.gz`。也可以使用 `latest` 替代 `{version}` 来下载最新的未发布版本。
 
 ## 简单例子
 
@@ -124,7 +124,7 @@ export PD_ADDR=http://127.0.0.1:2379 &&
 }
 ```
 
-### config [show | set \<option> \<value>]
+### config [show | set \<option> \<value> | placement-rules]
 
 用于显示或调整配置信息。示例如下。
 
@@ -433,6 +433,10 @@ config set cluster-version 1.0.8
 
 `enable-placement-rules` 用于开启 placement rules。
 
+### config placement-rules [disable | enable | load | save | show]
+
+用于配置 Placement Rules。 具体使用说明可参考[Placement Rules 使用文档](/configure-placement-rules.md)。
+
 ### health
 
 用于显示集群健康信息。示例如下。
@@ -666,13 +670,29 @@ time: 43.12698ms
 
 ```
 {
-  "region": {
-      "id": 2,
-      ......
-  }
+  "id": 2,
+  "start_key": "7480000000000000FF1D00000000000000F8",
+  "end_key": "7480000000000000FF1F00000000000000F8",
+  "epoch": {
+    "conf_ver": 1,
+    "version": 15
+  },
+  "peers": [
+    {
+      "id": 40,
+      "store_id": 3
+    }
+  ],
   "leader": {
-      ......
-  }
+    "id": 40,
+    "store_id": 3
+  },
+  "written_bytes": 0,
+  "read_bytes": 0,
+  "written_keys": 0,
+  "read_keys": 0,
+  "approximate_size": 1,
+  "approximate_keys": 0
 }
 ```
 
@@ -685,7 +705,7 @@ Raw 格式（默认）示例：
 {{< copyable "" >}}
 
 ```bash
->> region key abc
+>> region key --format=raw abc
 ```
 
 ```
@@ -714,6 +734,25 @@ Encoding 格式示例：
 }
 ```
 
+### region scan
+
+用于获取所有 Region。
+
+示例：
+
+{{< copyable "" >}}
+
+```bash
+>> region scan
+```
+
+```
+{
+  "count": 20,
+  "regions": [......],
+}
+```
+
 ### region sibling <region_id>
 
 用于查询某个 Region 相邻的 Region。
@@ -733,6 +772,25 @@ Encoding 格式示例：
 }
 ```
 
+### region startkey [--format=raw|encode|hex] <key> <limit>
+
+用于查询从某个 key 开始的所有 Region。
+
+示例：
+
+{{< copyable "" >}}
+
+```bash
+>> region startkey --format=raw abc
+```
+
+```
+{
+  "count": 16,
+  "regions": [......],
+}
+```
+
 ### `region store <store_id>`
 
 用于查询某个 store 上面所有的 Region。
@@ -842,8 +900,8 @@ Encoding 格式示例：
 
 ```
 {
-    "count": 16,
-    "regions": [......],
+  "count": 16,
+  "regions": [......],
 }
 ```
 
@@ -975,6 +1033,16 @@ Encoding 格式示例：
 >> store limit-scene idle 100          // 设置 load 为 idle 场景下，添加/删除 peer 的速度上限为每分钟 100 个
 ```
 
+### log [fatal | error | warn | info | debug]
+
+用于设置 PD leader 的日志级别。
+
+{{< copyable "" >}}
+
+```bash
+>> log warn
+```
+
 ### tso
 
 用于解析 TSO 到物理时间和逻辑时间。示例如下。
diff --git a/tidb-binlog/troubleshoot-tidb-binlog.md b/tidb-binlog/troubleshoot-tidb-binlog.md
index 23534e32a92f..8b2a736785cb 100644
--- a/tidb-binlog/troubleshoot-tidb-binlog.md
+++ b/tidb-binlog/troubleshoot-tidb-binlog.md
@@ -1,7 +1,7 @@
 ---
 title: TiDB Binlog 故障诊断
 category: reference
-aliases: ['/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
+aliases: ['/docs-cn/dev/reference/tidb-binlog/troubleshoot/binlog/','/docs-cn/dev/how-to/troubleshoot/tidb-binlog/']
 ---
 
 # TiDB Binlog 故障诊断

From dea17655f3be88ceb0445bb19c9c4ff2a35b10c6 Mon Sep 17 00:00:00 2001
From: Ryan Leung <rleungx@gmail.com>
Date: Fri, 22 May 2020 13:49:33 +0800
Subject: [PATCH 6/7] address the comment

Signed-off-by: Ryan Leung <rleungx@gmail.com>
---
 pd-control.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pd-control.md b/pd-control.md
index b32b2adc79b7..078accb04fab 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -342,7 +342,7 @@ Merge 调度的开销较大，所以这个值不宜调得过大。
 >> config set hot-region-schedule-limit 4
 ```
 
-`hot-region-cache-hits-threshold` 用于设置热点 Region 的阈值，只有超过命中 cache 的次数超过这个阈值才会被当作热点。
+`hot-region-cache-hits-threshold` 用于设置热点 Region 的阈值，只有命中 cache 的次数超过这个阈值才会被当作热点。
 
 `tolerant-size-ratio` 控制 balance 缓冲区大小。
 当两个 store 的 leader 或 Region 的得分差距小于指定倍数的 Region size 时，PD 会认为此时 balance 达到均衡状态。

From cf701c4130c01ad94762391afb9c3170c6ff1611 Mon Sep 17 00:00:00 2001
From: Ryan Leung <rleungx@gmail.com>
Date: Mon, 25 May 2020 12:07:19 +0800
Subject: [PATCH 7/7] address comments

Signed-off-by: Ryan Leung <rleungx@gmail.com>
---
 pd-control.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/pd-control.md b/pd-control.md
index 078accb04fab..14c60cce8a25 100644
--- a/pd-control.md
+++ b/pd-control.md
@@ -8,10 +8,9 @@ aliases: ['/docs-cn/dev/reference/tools/pd-control/']
 
 PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整集群。
 
-## 源码编译
+## 使用 TiUP
 
-1. [Go](https://golang.org/) Version 1.13 以上
-2. 在 PD 项目根目录使用 `make` 或者 `make pd-ctl` 命令进行编译，生成 bin/pd-ctl
+可直接通过 `tiup ctl pd -- -u http://<pd_ip>:<pd_port> [-i]` 使用。
 
 ## 下载安装包
 
@@ -25,6 +24,11 @@ PD Control 是 PD 的命令行工具，用于获取集群状态信息和调整
 >
 > 下载链接中的 `{version}` 为 TiDB 的版本号。例如 `v4.0.0-rc.2` 版本的下载链接为 `https://download.pingcap.org/tidb-v4.0.0-rc.2-linux-amd64.tar.gz`。也可以使用 `latest` 替代 `{version}` 来下载最新的未发布版本。
 
+## 源码编译
+
+1. [Go](https://golang.org/) Version 1.13 以上
+2. 在 PD 项目根目录使用 `make` 或者 `make pd-ctl` 命令进行编译，生成 bin/pd-ctl
+
 ## 简单例子
 
 单命令模式：
@@ -1017,8 +1021,8 @@ Encoding 格式示例：
 >> store limit                         // 显示所有 store 添加 peer 的速度上限
 >> store limit region-add              // 显示所有 store 添加 peer 的速度上限
 >> store limit region-remove           // 显示所有 store 删除 peer 的速度上限
->> store limit all 5                   // 设置所有 store 添加 peer 的速度上限为每分钟 5 个
->> store limit 1 5                     // 设置 store 1 添加 peer 的速度上限为每分钟 5 个
+>> store limit all 5                   // 设置所有 store 添加 peer 的速度上限为每分钟 5 个（如不设置具体类型，则默认设置的是添加 peer 的速度） 
+>> store limit 1 5                     // 设置 store 1 添加 peer 的速度上限为每分钟 5 个（如不设置具体类型，则默认设置的是添加 peer 的速度） 
 >> store limit all 5 region-add        // 设置所有 store 添加 peer 的速度上限为每分钟 5 个
 >> store limit 1 5 region-add          // 设置 store 1 添加 peer 的速度上限为每分钟 5 个
 >> store limit 1 5 region-remove       // 设置 store 1 删除 peer 的速度上限为每分钟 5 个
@@ -1033,6 +1037,10 @@ Encoding 格式示例：
 >> store limit-scene idle 100          // 设置 load 为 idle 场景下，添加/删除 peer 的速度上限为每分钟 100 个
 ```
 
+> **注意：**
+>
+> store limit 的生效情况和执行命令的先后顺序有关。如先执行 `store limit 1 5 region-add` 会将 store 1 添加 peer 的速度上限设置为每分钟 5 个，然后执行 `store limit 1 10 region-add`。此时 store 1 添加 peer 的速度上限会被修改为每分钟 10 个；反之，如先执行 `store limit 1 10 region-add`，会将全部 store 添加 peer 的速度上限设置为为每分钟 10 个，然后执行 `store limit 1 5 region-add`。此时只有 store 1 添加 peer 的速度上限被修改为每分钟 5 个。
+
 ### log [fatal | error | warn | info | debug]
 
 用于设置 PD leader 的日志级别。