[PATCH] D91186: [clangd] Add documentation for building and testing clangd

[Kadir Cetinkaya via Phabricator via cfe-commits]

kadircet updated this revision to Diff 306633.
kadircet marked 2 inline comments as done.
kadircet added a comment.

- Mention assertions and ninja


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D91186/new/

https://reviews.llvm.org/D91186

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


Index: clang-tools-extra/clangd/README.md
===================================================================
--- clang-tools-extra/clangd/README.md
+++ clang-tools-extra/clangd/README.md
@@ -17,3 +17,22 @@
   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`.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D91186.306633.patch
Type: text/x-patch
Size: 1364 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20201120/cf9af60a/attachment.bin>