From 05b77116697ac063921fd6ed99ad86338caa33b2 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Thu, 16 Apr 2020 23:24:59 +0800 Subject: [PATCH 1/3] cherry pick #2304 to release-2.1 Signed-off-by: sre-bot --- reference/tools/tidb-control.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/reference/tools/tidb-control.md b/reference/tools/tidb-control.md index 24640387bd8dc..a1a569fe6ac53 100644 --- a/reference/tools/tidb-control.md +++ b/reference/tools/tidb-control.md @@ -1,17 +1,17 @@ --- -title: TiDB Controller User Guide -summary: Use TiDB Controller to obtain TiDB status information for debugging. +title: TiDB Control User Guide +summary: Use TiDB Control to obtain TiDB status information for debugging. category: reference --- -# TiDB Controller User Guide +# TiDB Control User Guide -TiDB Controller is a command line tool of TiDB, usually used to obtain the status information of TiDB for debugging. +TiDB Control is a command line tool of TiDB, usually used to obtain the status information of TiDB for debugging. ## Compile from source code - Compilation environment requirement: [Go](https://golang.org/) Version 1.7 or later -- Compilation procedures: Go to the root directory of the [TiDB Controller project](https://github.com/pingcap/tidb-ctl), use the `make` command to compile, and generate `tidb-ctl`. +- Compilation procedures: Go to the root directory of the [TiDB Control project](https://github.com/pingcap/tidb-ctl), use the `make` command to compile, and generate `tidb-ctl`. - Compilation documentation: you can find the help files in the `doc` directory; if the help files are lost or you want to update them, use the `make doc` command to generate the help files. ## Usage introduction @@ -32,7 +32,13 @@ Usage example: `tidb-ctl schema in mysql -n db` ### Get help +<<<<<<< HEAD Use `tidb-ctl -h/--help` to get the help information. `tidb-ctl` consists of multiple layers of commands. You can use `-h/--help` to get the help information of `tidb-ctl` and all other subcommands. +======= +Use `tidb-ctl -h/--help` to get usage information. + +TiDB Control consists of multiple layers of commands. You can use `-h/--help` after each command/subcommand to get its respective usage information. +>>>>>>> 25fc1ef... reference: rename TiDB Controller to TiDB Control (#2304) ### Connect From 92063f31dd61bf350613439024dfded2713936a4 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 12 May 2020 14:06:37 +0800 Subject: [PATCH 2/3] resolve conflict --- reference/tools/tidb-control.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/reference/tools/tidb-control.md b/reference/tools/tidb-control.md index a1a569fe6ac53..e3e8d8c2fedaa 100644 --- a/reference/tools/tidb-control.md +++ b/reference/tools/tidb-control.md @@ -32,13 +32,9 @@ Usage example: `tidb-ctl schema in mysql -n db` ### Get help -<<<<<<< HEAD -Use `tidb-ctl -h/--help` to get the help information. `tidb-ctl` consists of multiple layers of commands. You can use `-h/--help` to get the help information of `tidb-ctl` and all other subcommands. -======= Use `tidb-ctl -h/--help` to get usage information. TiDB Control consists of multiple layers of commands. You can use `-h/--help` after each command/subcommand to get its respective usage information. ->>>>>>> 25fc1ef... reference: rename TiDB Controller to TiDB Control (#2304) ### Connect From 28b8c1c76f3244124d62a3cea6b7c42c4d79abe1 Mon Sep 17 00:00:00 2001 From: TomShawn <41534398+TomShawn@users.noreply.github.com> Date: Tue, 12 May 2020 18:52:33 +0800 Subject: [PATCH 3/3] Update tidb-control.md --- reference/tools/tidb-control.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/tools/tidb-control.md b/reference/tools/tidb-control.md index e3e8d8c2fedaa..0febc796ed7f1 100644 --- a/reference/tools/tidb-control.md +++ b/reference/tools/tidb-control.md @@ -44,7 +44,7 @@ tidb-ctl -H/--host {TiDB service address} -P/--port {TiDB service port} If you do not add an address or a port, the default value is used. The default address is `127.0.0.1` (service address must be the IP address); the default port is `10080`. Connection options are top-level options and apply to all of the following commands. -Currently, TiDB Controller can obtain four categories of information using the following four commands: +Currently, TiDB Control can obtain four categories of information using the following four commands: - `tidb-ctl mvcc`: MVCC information - `tidb-ctl region`: Region information