From 55206eff33fd3af2b158b45dac840ba452e60dab Mon Sep 17 00:00:00 2001 From: Robert Adam Date: Thu, 4 Mar 2021 11:49:00 +0100 Subject: DOCS: Mention unity builds --- docs/dev/build-instructions/faq.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/dev/build-instructions/faq.md b/docs/dev/build-instructions/faq.md index a63b54dd2..f8d22c905 100644 --- a/docs/dev/build-instructions/faq.md +++ b/docs/dev/build-instructions/faq.md @@ -1,5 +1,13 @@ # Build FAQ +### How to speed up the compilation + +Mumble supports being compiled as a [unity build](https://en.wikipedia.org/wiki/Unity_build), if you are using cmake 3.16 or newer. To use this +feature, use `-DCMAKE_UNITY_BUILD=ON` option when invoking cmake. + +Don't use this option when also using `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON` though as the unity build will render the produced compilation database +useless. + ### How can I specify the build type In order to set the build type (Debug vs Release), you have to use the `CMAKE_BUILD_TYPE` variable when invoking cmake like so: `cmake -- cgit v1.2.3