Skip to content

Commit 602d1a8

Browse files
MyonKemintazhangjinpeng87
authored andcommitted
Update TiKV build guide (pingcap#349)
1 parent 8b6f06a commit 602d1a8

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

dev-guide/development.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@ Before you begin, check the [supported platforms](./requirements.md#supported-pl
88

99
## Build TiKV
1010

11-
After you install the RocksDB shared library, you can build TiKV directly without `ROCKSDB_SYS_STATIC`.
12-
13-
+ Get the TiKV source code.
11+
+ Get TiKV source code from GitHub
1412

1513
```bash
1614
git clone https://github.com/pingcap/tikv.git
15+
cd tikv
1716
```
18-
+ Enter the source directory to build and install the binary in the `bin` directory.
17+
18+
+ Run all unit tests:
1919

2020
```bash
21-
make
21+
make test
2222
```
23-
24-
+ Run unit test.
25-
23+
24+
+ Build in release mode:
25+
2626
```bash
27-
make test
27+
make release
2828
```
2929

3030
## Build TiDB

dev-guide/requirements.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,18 @@ The following table lists TiDB support for common architectures and operating sy
1212

1313
## Prerequisites
1414

15-
+ Go [1.8+](https://golang.org/doc/install)
15+
+ Go [1.9+](https://golang.org/doc/install)
1616
+ Rust [nightly version](https://www.rust-lang.org/downloads.html)
1717
+ GCC 4.8+ with static library
18+
+ CMake 3.1+
1819

1920
The [check requirement script](../scripts/check_requirement.sh) can help you check prerequisites and
2021
install the missing ones automatically.
2122

23+
24+
TiKV is well tested in a certain Rust version by us, and the exact version can be found in the `RUST_VERSION` file in TiKV's root directory. We recommend you to use the same version as we do. To set Rust version, execute following command in your TiKV project directory:
25+
26+
```bash
27+
rustup override set nightly-2018-01-12 # For example if our current version is `nightly-2018-01-12`
28+
cargo +nightly-2018-01-12 install rustfmt-nightly --version 0.3.4
29+
```

0 commit comments

Comments
 (0)