Update production-deployment-using-tiup.md (pingcap#3417)

jacktd9 · Jun 1, 2020 · 721138e · 721138e
1 parent 764d50f
commit 721138e
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 14 deletions.
diff --git a/production-deployment-using-tiup.md b/production-deployment-using-tiup.md
@@ -120,7 +120,7 @@ tiup cluster deploy tidb-test v4.0.0 ./topology.yaml --user root [-p] [-i /home/
 以上部署命令中：
 
 - 通过 TiUP cluster 部署的集群名称为 `tidb-test`
-- 部署版本为 `v4.0.0`，最新版本可以通过执行 `tiup list tidb --refresh` 来查看 TiUP 支持的版本
+- 部署版本为 `v4.0.0`，最新版本可以通过执行 `tiup list tidb` 来查看 TiUP 支持的版本
 - 初始化配置文件为 `topology.yaml`
 - --user root：通过 root 用户登录到目标主机完成集群部署，该用户需要有 ssh 到目标机器的权限，并且在目标机器有 sudo 权限。也可以用其他有 ssh 和 sudo 权限的用户完成部署。
 - [-i] 及 [-p]：非必选项，如果已经配置免密登陆目标机，则不需填写。否则选择其一即可，[-i] 为可登录到部署机的 root 用户（或 --user 指定的其他用户）的私钥，也可使用 [-p] 交互式输入该用户的密码

diff --git a/production-offline-deployment-using-tiup.md b/production-offline-deployment-using-tiup.md
@@ -237,7 +237,7 @@ tiup cluster start tidb-test
 > **参数说明：**
 >
 > - 通过 TiUP cluster 部署的集群名称为 `tidb-test`
-> - 部署版本为 `v4.0.0`，其他版本可以执行 `tiup list tidb --refresh` 获取
+> - 部署版本为 `v4.0.0`，其他版本可以执行 `tiup list tidb` 获取
 > - 初始化配置文件为 `topology.yaml`
 > - --user tidb：通过 tidb 用户登录到目标主机完成集群部署，该用户需要有 ssh 到目标机器的权限，并且在目标机器有 sudo 权限。也可以用其他有 ssh 和 sudo 权限的用户完成部署。
 > - [-i] 及 [-p]：非必选项，如果已经配置免密登陆目标机，则不需填写。否则选择其一即可，[-i] 为可登录到部署机 root 用户（或 --user 指定的其他用户）的私钥，也可使用 [-p] 交互式输入该用户的密码

diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md
@@ -248,7 +248,7 @@ TiDB-Wasm 是运行在浏览器中的 TiDB 数据库，打开网页即可使用
     ```
 
     - 参数 `<cluster-name>` 表示设置集群名称
-    - 参数 `<tidb-version>` 表示设置集群版本，可以通过 `tiup list tidb --refresh` 命令来查看当前支持部署的 TiDB 版本
+    - 参数 `<tidb-version>` 表示设置集群版本，可以通过 `tiup list tidb` 命令来查看当前支持部署的 TiDB 版本
 
     按照引导，输入”y”及 root 密码，来完成部署：
 

diff --git a/tiup/tiup-component-management.md b/tiup/tiup-component-management.md
@@ -25,10 +25,11 @@ TiUP 主要通过以下一些命令来管理组件：
 - `tiup list`：查看当前有哪些组件可以安装
 - `tiup list ${component}`：查看某个组件有哪些版本可以安装
 
-你也可以在命令中组合使用以下两个参数 (flag)：
+你也可以在命令中组合使用以下参数 (flag)：
 
 - `--installed`：查看本地已经安装了哪些组件，或者已经安装了某个组件的哪些版本
-- `--refresh`：获取服务器上最新的组件列表，以及它们的版本列表
+- `--all`：显式隐藏的组件
+- `--verbose`：显式所有列（安装的版本、支持的平台）
 
 示例一：查看当前已经安装的所有组件
 
@@ -43,7 +44,7 @@ tiup list --installed
 {{< copyable "shell-regular" >}}
 
 ```shell
-tiup list tikv --refresh
+tiup list tikv
 ```
 
 ## 安装组件

diff --git a/tiup/tiup-overview.md b/tiup/tiup-overview.md
@@ -94,7 +94,7 @@ Examples:
   $ tiup update --all                  # Update all installed components to the latest version
   $ tiup update --nightly              # Update all installed components to the nightly version
   $ tiup update --self                 # Update the "tiup" to the latest version
-  $ tiup list --refresh                # Fetch the latest supported components list
+  $ tiup list                          # Fetch the latest supported components list
   $ tiup status                        # Display all running/terminated instances
   $ tiup clean <name>                  # Clean the data of running/terminated instance (Kill process if it's running)
   $ tiup clean --all                   # Clean the data of all running/terminated instances
@@ -123,7 +123,7 @@ Use "tiup [command] --help" for more information about a command.
 
 > **注意：**
 >
-> - 可用的组件会持续增加，以 `tiup list --refresh` 输出结果为准。
-> - 组件的可用版本列表也会持续增加，以 `tiup list <component> --refresh` 输出结果为准。
+> - 可用的组件会持续增加，以 `tiup list` 输出结果为准。
+> - 组件的可用版本列表也会持续增加，以 `tiup list <component>` 输出结果为准。
 
 命令和组件的区别在于，命令是 TiUP 自带的，用于进行包管理的操作。而组件是 TiUP 通过包管理操作安装的独立组件包。比如执行 `tiup list` 命令，TiUP 会直接运行自己内部的代码，而执行 `tiup playground` 命令则会先检查本地有没有叫做 playground 的组件包，若没有则先从镜像上下载过来，然后运行这个组件包。
diff --git a/tiup/tiup-package.md b/tiup/tiup-package.md
@@ -95,7 +95,7 @@ Flags:
     {{< copyable "shell-root" >}}
 
     ```bash
-    tiup list hello --refresh
+    tiup list hello
     ```
 
     ```

diff --git a/tiup/tiup-terminology-and-concepts.md b/tiup/tiup-terminology-and-concepts.md
@@ -27,5 +27,5 @@ TiUP 的所有组件都从镜像仓库 (mirrors) 下载，镜像仓库包含各
 
 镜像仓库可以是本地文件目录或在线 HTTP 服务器：
 
-1. `TIUP_MIRRORS=/path/to/local tiup list --refresh`
-2. `TIUP_MIRRORS=https://private-mirrors.example.com tiup list --refresh`
+1. `TIUP_MIRRORS=/path/to/local tiup list`
+2. `TIUP_MIRRORS=https://private-mirrors.example.com tiup list`
diff --git a/tiup/tiup-troubleshooting-guide.md b/tiup/tiup-troubleshooting-guide.md
@@ -14,11 +14,11 @@ category: tools
 
 ### 1.1 使用 `tiup list` 看不到最新的组件列表
 
-TiUP 并不会每次都从镜像服务器更新最新的组件列表，可以通过 `tiup list --refresh` 来强制刷新组件列表。
+TiUP 并不会每次都从镜像服务器更新最新的组件列表，可以通过 `tiup list` 来强制刷新组件列表。
 
 ### 1.2 使用 `tiup list <component>` 看不到一个组件的最新版本信息
 
-同 1.1 一样，组件的版本信息只会在本地无缓存的情况下从镜像服务器获取，可以通过 `tiup list <component> --refresh` 刷新组件列表。
+同 1.1 一样，组件的版本信息只会在本地无缓存的情况下从镜像服务器获取，可以通过 `tiup list <component>` 刷新组件列表。
 
 ### 1.3 下载组件的过程中中断
-Original file line number
+Diff line change
@@ Expand Up / @@ -95,7 +95,7 @@ Flags: @@
         {{< copyable "shell-root" >}}
         ```bash
-        tiup list hello --refresh
+        tiup list hello
         ```
         ```
@@ Expand Down @@