kadircet created this revision. kadircet added a reviewer: sammccall. Herald added subscribers: cfe-commits, usaxena95, arphaman. Herald added a project: clang. kadircet requested review of this revision. Herald added subscribers: MaskRay, ilya-biryukov.
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. Repository: rG LLVM Github Monorepo 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,18 @@ 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. +- Afterwards you can build clangd with `cmake --build $LLVM_ROOT/build --target + clangd`, similarly run tests by changing target to `check-clangd`.
Index: clang-tools-extra/clangd/README.md =================================================================== --- clang-tools-extra/clangd/README.md +++ clang-tools-extra/clangd/README.md @@ -17,3 +17,18 @@ 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. +- Afterwards you can build clangd with `cmake --build $LLVM_ROOT/build --target + clangd`, similarly run tests by changing target to `check-clangd`.
_______________________________________________ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
