[clang-tools-extra] 085f900 - [clangd] Update remote index documentation
Kirill Bobyrev via cfe-commits
cfe-commits at lists.llvm.org
Tue Nov 10 01:18:48 PST 2020
Author: Kirill Bobyrev
Date: 2020-11-10T10:18:38+01:00
New Revision: 085f900830e6687de54d3d6115c9517a55cc860a
URL: https://github.com/llvm/llvm-project/commit/085f900830e6687de54d3d6115c9517a55cc860a
DIFF: https://github.com/llvm/llvm-project/commit/085f900830e6687de54d3d6115c9517a55cc860a.diff
LOG: [clangd] Update remote index documentation
* Even though remote index is still somewhat experimental, it can now be
used withing clangd itself: this should be the primary way of trying
it out
* Remove `protobuf-compiler` from list of needed Debian packages as it
`protobuf-compiler-grpc` already depends on it
* Bump recommended gRPC version to 1.32.3
Added:
Modified:
clang-tools-extra/clangd/index/remote/README.md
Removed:
################################################################################
diff --git a/clang-tools-extra/clangd/index/remote/README.md b/clang-tools-extra/clangd/index/remote/README.md
index b56b2fc1011e..235e967ff878 100644
--- a/clang-tools-extra/clangd/index/remote/README.md
+++ b/clang-tools-extra/clangd/index/remote/README.md
@@ -22,19 +22,20 @@ tools you will need to set this CMake flag — `-DCLANGD_ENABLE_REMOTE=On`.
On Debian-like systems gRPC and Protobuf can be installed from apt:
```bash
-apt install libgrpc++-dev libprotobuf-dev protobuf-compiler protobuf-compiler-grpc
+apt install libgrpc++-dev libprotobuf-dev protobuf-compiler-grpc
```
### Building from sources
Another way of installing gRPC and Protobuf is building from sources using
-CMake. The easiest way of doing that would be to choose a directory where you
-want to install so that the installation files are not copied to system root and
-you can uninstall gRPC or use
diff erent versions of the library.
+CMake (we need CMake config files to find necessary libraries in LLVM). The
+easiest way of doing that would be to choose a directory where you want to
+install so that the installation files are not copied to system root and you
+can easily uninstall gRPC or use
diff erent versions.
```bash
# Get source code.
-$ git clone -b v1.28.1 https://github.com/grpc/grpc
+$ git clone -b v1.32.2 https://github.com/grpc/grpc
$ cd grpc
$ git submodule update --init
# Choose directory where you want gRPC installation to live.
@@ -55,5 +56,5 @@ flag will inform build system that you chose this option —
## Running
-The remote index isn't usable with Clangd yet, but you can try the
-proof-of-concept tools in `client/` and `server/` subdirectories.
+You can run `clangd-index-server` and connect `clangd` instance to it using
+`--remote-index-address` and `--project-root` flags.
More information about the cfe-commits
mailing list