Fix typos in TiUP docs (#6192)

* Fix typos in TiUP docs * fix wrong description
pingcap · May 11, 2021 · b503c23 · b503c23
1 parent 521f861
commit b503c23
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 10 deletions.
diff --git a/tiup/tiup-component-cluster-check.md b/tiup/tiup-component-cluster-check.md
@@ -149,6 +149,8 @@ tiup cluster check <topology.yml | cluster-name> [flags]
 
 若选择的格式为 `tiup cluster check <cluster-name>` 则必须加上该选项：`tiup cluster check <cluster-name> --cluster`。
 
+该选项的数据类型为 `BOOLEAN`。该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
+
 ### -N, --node
 
 - 指定要检查的节点。该选项的值为以逗号分割的节点 ID 列表，节点 ID 为 [`tiup-component-cluster-display`](/tiup/tiup-component-cluster-display.md) 命令返回的集群状态表格的第一列。

diff --git a/tiup/tiup-component-cluster-display.md b/tiup/tiup-component-cluster-display.md
@@ -24,15 +24,15 @@ tiup cluster display <cluster-name> [flags]
 
 ### -N, --node（strings，默认为 []，表示所有节点）
 
-指定要查询的节点，不指定则表示所有节点。该选项的值为以逗号分割的节点 ID 列表，节点 ID 为[集群状态](/tiup/tiup-component-cluster-display.md)表格的第一列。
+指定要查询的节点，不指定则表示所有节点。该选项的值为以逗号分割的节点 ID 列表，如果不确定要查询节点的 ID，不指定此选项，输出会显示所有节点的 ID 和状态信息。
 
 > **注意：**
 >
 > 若同时指定了 `-R, --role`，那么将查询它们的交集中的服务状态。
 
 ### -R, --role（strings，默认为 []，表示所有角色）
 
-指定要查询的角色，不指定则表示所有角色。该选项的值为以逗号分割的节点角色列表，角色为[集群状态](/tiup/tiup-component-cluster-display.md)表格的第二列。
+指定要查询的角色，不指定则表示所有角色。该选项的值为以逗号分割的节点角色列表，如果不确定要查询节点的角色，不指定此选项，输出会显示所有节点的角色和状态信息。
 
 > **注意：**
 >

diff --git a/tiup/tiup-component-cluster-patch.md b/tiup/tiup-component-cluster-patch.md
@@ -61,7 +61,7 @@ tiup cluster patch <cluster-name> <package-path> [flags]
 >
 > 若同时指定了 `-N, --node`，那么将替换它们的交集中的服务。
 
-## --offline
+### --offline
 
 - 声明当前集群处于停止状态。指定该选项时，TiUP Cluster 仅原地替换集群组件的二进制文件，不执行迁移 Leader 以及重启服务等操作。
 - 数据类型：`BOOLEAN`

diff --git a/tiup/tiup-component-cluster-upgrade.md b/tiup/tiup-component-cluster-upgrade.md
@@ -32,7 +32,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
 在升级 PD 或 TiKV 时，会先将被升级节点的 leader 迁移到其他节点，迁移过程会需要一定时间，可以通过设置 `--transfer-timeout` 设置最长等待时间（单位为秒），超时之后会跳过等待直接升级服务。
 
 > **注意：**
-> 
+>
 > 若出现跳过等待直接升级的情况，服务性能可能会出现抖动。
 
 ### --ignore-config-check
@@ -41,7 +41,7 @@ tiup cluster upgrade <cluster-name> <version> [flags]
 - 数据类型：`BOOLEAN`
 - 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
-## --offline
+### --offline
 
 - 声明当前集群处于停止状态。指定该选项时，TiUP Cluster 仅原地替换集群组件的二进制文件，不执行迁移 Leader 以及重启服务等操作。
 - 数据类型：`BOOLEAN`

diff --git a/tiup/tiup-component-dm-display.md b/tiup/tiup-component-dm-display.md
@@ -21,15 +21,15 @@ tiup dm display <cluster-name> [flags]
 指定要查询的节点，不指定则表示所有节点。该选项的值为以逗号分割的节点 ID 列表，如果不确定要查询节点的 ID，不指定此选项，输出会显示所有节点的 ID 和状态信息。
 
 > **注意：**
-> 
+>
 > 若同时指定了 `-R, --role`，那么将查询它们的交集中的服务状态。
 
 ### -R, --role（strings，默认为 []，表示所有角色）
 
 指定要查询的角色，不指定则表示所有角色。该选项的值为以逗号分割的节点角色列表，如果不确定要查询节点的角色，不指定此选项，输出会显示所有节点的角色和状态信息。
 
 > **注意：**
-> 
+>
 > 若同时指定了 `-N, --node`，那么将查询它们的交集中的服务状态。
 
 ### -h, --help

diff --git a/tiup/tiup-component-dm-enable.md b/tiup/tiup-component-dm-enable.md
@@ -20,7 +20,7 @@ tiup dm enable <cluster-name> [flags]
 
 - 指定要开启自启的节点，该选项的值为以逗号分割的节点 ID 列表，节点 ID 为[集群状态](/tiup/tiup-component-dm-display.md)表格的第一列。
 - 数据类型：`STRINGS`
-- 如果不指定该选项，默认关闭所有节点的自启。
+- 如果不指定该选项，默认开启所有节点的自启。
 
 > **注意：**
 >

diff --git a/tiup/tiup-component-dm-patch.md b/tiup/tiup-component-dm-patch.md
@@ -59,7 +59,7 @@ tiup dm patch <cluster-name> <package-path> [flags]
 >
 > 若同时指定了 `-N, --node`，那么将替换它们的交集中的服务。
 
-## --offline
+### --offline
 
 声明当前集群处于离线状态。指定该选项时，TiUP DM 仅原地替换集群组件的二进制文件，不重启服务。
 

diff --git a/tiup/tiup-component-dm-upgrade.md b/tiup/tiup-component-dm-upgrade.md
@@ -17,7 +17,7 @@ tiup dm upgrade <cluster-name> <version> [flags]
 
 ## 选项
 
-## --offline
+### --offline
 
 声明当前集群处于离线状态。指定该选项时，TiUP DM 仅原地替换集群组件的二进制文件，不重启服务。