doc: provide more detailed instructions (#768)

* tests: mention version limit * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: WangXiangUSTC <[email protected]>
pingcap · Jul 2, 2020 · 41790a9 · 41790a9
1 parent de08299
commit 41790a9
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/tests/README.md b/tests/README.md
@@ -16,7 +16,7 @@
 
 2. The following programs must be installed:
 
-    * `mysql` (the CLI client)
+    * `mysql` (the CLI client, currently [not supported for mysql client 8.0](https://github.com/pingcap/tidb/issues/14021))
     * `python2.7` or `python3.x`
 
 3. The user executing the tests must have permission to create the folder `/tmp/dm_test`. All test artifacts will be written into this folder.
@@ -25,15 +25,15 @@
 
 ### Unit Test
 
-1. Setup a MySQL server with binlog enabled first, export proper environment variable `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_USER`, `MYSQL_PSWD`, default is `127.0.0.1`, `3306`, `root` and empty password.
+1. Setup a MySQL server with [binlog enabled first](https://dev.mysql.com/doc/refman/5.7/en/replication-howto-masterbaseconfig.html) and [set `GTID_MODE=ON`](https://dev.mysql.com/doc/refman/5.7/en/replication-mode-change-online-enable-gtids.html), export proper environment variable `MYSQL_HOST`, `MYSQL_PORT`, `MYSQL_USER`, `MYSQL_PSWD`, default is `127.0.0.1`, `3306`, `root` and empty password.
 
-2. Run `make test` to run unit test
+2. Run `make unit_test` to run unit test
 
 ### Integration Test
 
 1. Run `make dm_integration_test_build` to generate DM related binary for integration test
 
-2. Setup two MySQL servers with binlog enabled first and set `GTID_MODE=ON`, export proper environment variables. Variables and their default values are showed in following table.
+2. Setup two MySQL servers (5.6 ~ 5.7) with [binlog enabled first](https://dev.mysql.com/doc/refman/5.7/en/replication-howto-masterbaseconfig.html) and [set `GTID_MODE=ON`](https://dev.mysql.com/doc/refman/5.7/en/replication-mode-change-online-enable-gtids.html), export proper environment variables. Variables and their default values are showed in following table.
 
     | MySQL | Host | Port| PASSWORD |
     | :------------ | :---------- | :------ | :---- |
@@ -59,7 +59,7 @@
 
     Run `make compatibility_test` will run compatibility test.
 
-2. Setup two MySQL servers with binlog enabled first and set `GTID_MODE=ON`, export proper environment variable. Variables and their default values are showed in following table.
+2. Setup two MySQL servers with [binlog enabled first](https://dev.mysql.com/doc/refman/5.7/en/replication-howto-masterbaseconfig.html) and [set `GTID_MODE=ON`](https://dev.mysql.com/doc/refman/5.7/en/replication-mode-change-online-enable-gtids.html), export proper environment variable. Variables and their default values are showed in following table.
 
     | MySQL | Host | Port| PASSWORD |
     | :------------ | :---------- | :------ | :---- |