ClickHouse/docs/_includes/cmake_in_clickhouse_header.md

# CMake in ClickHouse

## TL; DR How to make ClickHouse compile and link faster?

Developer only! This command will likely fulfill most of your needs. Run before calling `ninja`.

```cmake
cmake .. \
    -DCMAKE_C_COMPILER=/bin/clang-10 \
    -DCMAKE_CXX_COMPILER=/bin/clang++-10 \
    -DCMAKE_BUILD_TYPE=Debug \
    -DENABLE_CLICKHOUSE_ALL=OFF \
    -DENABLE_CLICKHOUSE_SERVER=ON \
    -DENABLE_CLICKHOUSE_CLIENT=ON \
    -DUSE_STATIC_LIBRARIES=OFF \
    -DSPLIT_SHARED_LIBRARIES=ON \
    -DENABLE_LIBRARIES=OFF \
    -DUSE_UNWIND=ON \
    -DENABLE_UTILS=OFF \
    -DENABLE_TESTS=OFF
```

## CMake files types

1. ClickHouse's source CMake files (located in the root directory and in `/src`).
2. Arch-dependent CMake files (located in `/cmake/*os_name*`).
3. Libraries finders (search for contrib libraries, located in `/cmake/find`).
3. Contrib build CMake files (used instead of libraries' own CMake files, located in `/cmake/modules`)

## List of CMake flags

* This list is auto-generated by [this Python script](https://github.com/clickhouse/clickhouse/blob/master/docs/tools/cmake_in_clickhouse_generator.py).
* The flag name is a link to its position in the code.
* If an option's default value is itself an option, it's also a link to its position in this list.
slighly updated CMake files 2020-09-17 15:09:59 +00:00			`# CMake in ClickHouse`
initial docs header 2020-09-10 15:57:18 +00:00
slighly updated CMake files 2020-09-17 15:09:59 +00:00			`## TL; DR How to make ClickHouse compile and link faster?`
initial docs header 2020-09-10 15:57:18 +00:00
added sub-tables in report, replaced some USE_ -> ENABLE_ for consistency 2020-09-18 13:09:22 +00:00			Developer only! This command will likely fulfill most of your needs. Run before calling `ninja`.
slighly updated CMake files 2020-09-17 15:09:59 +00:00
removed extra dots in generated list 2020-09-17 15:46:55 +00:00			```cmake
updated multi-line command 2020-09-17 16:27:51 +00:00			`cmake .. \`
			`-DCMAKE_C_COMPILER=/bin/clang-10 \`
			`-DCMAKE_CXX_COMPILER=/bin/clang++-10 \`
			`-DCMAKE_BUILD_TYPE=Debug \`
			`-DENABLE_CLICKHOUSE_ALL=OFF \`
			`-DENABLE_CLICKHOUSE_SERVER=ON \`
			`-DENABLE_CLICKHOUSE_CLIENT=ON \`
			`-DUSE_STATIC_LIBRARIES=OFF \`
			`-DSPLIT_SHARED_LIBRARIES=ON \`
			`-DENABLE_LIBRARIES=OFF \`
updated docs -- removed the unbundled option for... Default values in Cmake in ClickHouse, as there could be some caveats (e.g. tester not working) 2020-10-12 14:42:19 +00:00			`-DUSE_UNWIND=ON \`
updated multi-line command 2020-09-17 16:27:51 +00:00			`-DENABLE_UTILS=OFF \`
slighly updated CMake files 2020-09-17 15:09:59 +00:00			`-DENABLE_TESTS=OFF`
			```

			`## CMake files types`

			1. ClickHouse's source CMake files (located in the root directory and in `/src`).
			2. Arch-dependent CMake files (located in `/cmake/os_name`).
			3. Libraries finders (search for contrib libraries, located in `/cmake/find`).
			3. Contrib build CMake files (used instead of libraries' own CMake files, located in `/cmake/modules`)
initial docs header 2020-09-10 15:57:18 +00:00
			`## List of CMake flags`

finishing the PR 2020-09-19 17:31:41 +00:00			`* This list is auto-generated by [this Python script](https://github.com/clickhouse/clickhouse/blob/master/docs/tools/cmake_in_clickhouse_generator.py).`
initial docs header 2020-09-10 15:57:18 +00:00			`* The flag name is a link to its position in the code.`
added sub-tables in report, replaced some USE_ -> ENABLE_ for consistency 2020-09-18 13:09:22 +00:00			`* If an option's default value is itself an option, it's also a link to its position in this list.`