diff --git a/README.md b/README.md index a70279f6f9f..3bca0aa6597 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,14 @@ See [Quick Start with HTAP](https://docs.pingcap.com/tidb/stable/quick-start-wit ## Build TiFlash TiFlash supports building on the following hardware architectures: -* x86-64/amd64 -* aarch64 + +- x86-64/amd64 +- aarch64 And the following operating systems: -* Linux -* MacOS + +- Linux +- MacOS ### 1. Checkout Source Code @@ -36,7 +38,7 @@ Assume `$WORKSPACE` to be the directory under which the TiFlash repo is placed. ```shell cd $WORKSPACE -git clone --recursive https://github.com/pingcap/tiflash.git +git clone https://github.com/pingcap/tiflash.git --recursive -j 20 ``` ### 2. Prepare Prerequisites @@ -57,11 +59,13 @@ The following packages are needed for all platforms: - Ninja or GNU Make The following are platform-specific prerequisites. Click to expand details: + <details> <summary><b>Linux specific prerequisites</b></summary> - TiFlash can be built using either LLVM or GCC toolchain on Linux. LLVM toolchain is our official one for releasing. - > But for GCC, only GCC 7.x is supported as far, and is not planned to be a long term support. So it may get broken some day, silently. +TiFlash can be built using either LLVM or GCC toolchain on Linux. LLVM toolchain is our official one for releasing. + +> But for GCC, only GCC 7.x is supported as far, and is not planned to be a long term support. So it may get broken some day, silently. - LLVM 13.0.0+ @@ -69,7 +73,6 @@ The following are platform-specific prerequisites. Click to expand details: Click sections below to see detailed instructions: - <details> <summary><b>Set up LLVM via package managers in Debian/Ubuntu</b></summary> @@ -225,13 +228,13 @@ To generate unit test executables with sanitizer enabled: cd $BUILD cmake $WORKSPACE/tiflash -GNinja -DENABLE_TESTS=ON -DCMAKE_BUILD_TYPE=ASan # or TSan ninja gtests_dbms -ninja gtests_libcommon ninja gtests_libdaemon +ninja gtests_libcommon ``` There are known false positives reported from leak sanitizer (which is included in address sanitizer). To suppress these errors, set the following environment variables before running the executables: -``` +```shell LSAN_OPTIONS=suppressions=$WORKSPACE/tiflash/test/sanitize/asan.suppression ```