Skip to content

reference: rename TiDB Controller to TiDB Control (#2304) #2312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2020
Merged

reference: rename TiDB Controller to TiDB Control (#2304) #2312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions reference/tools/tidb-control.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -35,7 +35,7 @@ Usage example: `tidb-ctl schema in mysql -n db`

Use `tidb-ctl -h/--help` to get usage information.

TiDB Controller consists of multiple layers of commands. You can use `-h/--help` after each command/subcommand to get its respective 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.

### Connect

Expand Down