[llvm-branch-commits] [clang-tools-extra] 4cca222 - [clangd] Add documentation for building and testing clangd

[Kadir Cetinkaya via llvm-branch-commits]

Author: Kadir Cetinkaya
Date: 2021-01-22T11:53:31+01:00
New Revision: 4cca222279396c4e4d484ba79e74c5dc45fe63e4

URL: https://github.com/llvm/llvm-project/commit/4cca222279396c4e4d484ba79e74c5dc45fe63e4
DIFF: https://github.com/llvm/llvm-project/commit/4cca222279396c4e4d484ba79e74c5dc45fe63e4.diff

LOG: [clangd] Add documentation for building and testing clangd

Adds minimal cmake configuration required to build and test clangd,
while telling target names. Should be helpful for people unfamiliar with the
LLVM repo.

See https://github.com/clangd/clangd/issues/579 for a request.

Differential Revision: https://reviews.llvm.org/D91186

Added: 
    

Modified: 
    clang-tools-extra/clangd/README.md

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/clangd/README.md b/clang-tools-extra/clangd/README.md
index c9a75895acab..3ef9174c9529 100644
--- a/clang-tools-extra/clangd/README.md
+++ b/clang-tools-extra/clangd/README.md
@@ -17,3 +17,22 @@ through one of these channels:
   channel](https://discord.gg/xS7Z362).
 - user questions and feature requests can be asked in the clangd topic on [LLVM
   Discussion Forums](https://llvm.discourse.group/c/llvm-project/clangd/34)
+
+### Building and testing clangd
+
+For a minimal setup on building clangd:
+- Clone the LLVM repo to `$LLVM_ROOT`.
+- Create a build directory, for example at `$LLVM_ROOT/build`.
+- Inside the build directory run: `cmake $LLVM_ROOT/llvm/
+  -DCMAKE_BUILD_TYPE=Release -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra"`.
+
+  - We suggest building in `Release` mode as building DEBUG binaries requires
+    considerably more resources. You can check
+    [Building LLVM with CMake documentation](https://llvm.org/docs/CMake.html)
+    for more details about cmake flags.
+  - In addition to that using `Ninja` as a generator rather than default `make`
+    is preferred. To do that consider passing `-G Ninja` to cmake invocation.
+  - Finally, you can turn on assertions via `-DLLVM_ENABLE_ASSERTS=On`.
+
+- Afterwards you can build clangd with `cmake --build $LLVM_ROOT/build --target
+  clangd`, similarly run tests by changing target to `check-clangd`.