Document how to get a clangd build with remote indexing

The clangd docs say that you need your own build for remote indexing
support, but offers no advice on how to get one (or how to check if
you have one), and the linked bug also offers no clear solution.

This patch adds advice on how to check if your build supports remote
indexing, and how to get such a build.

(see also <https://github.com/clangd/chrome-remote-index/pull/9>)

Change-Id: I45b5acb20497f51d639f609e07b9bd62ec1d2b35
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/5508557
Commit-Queue: Delan Azabani <dazabani@igalia.com>
Reviewed-by: Ivan Šandrk <isandrk@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1295385}

This commit is contained in:

Delan Azabani

2024-05-02 11:55:18 +00:00

committed by

Chromium LUCI CQ

parent 4464bb329f

commit 9e7f4ce228

1 changed files with 7 additions and 2 deletions

									
										9

docs/clangd.md
									
				@ -70,8 +70,13 @@ configuration.

				*** note

				Note: The clangd provided by Chromium does not support optional features like

				remote indexing (see https://crbug.com/1358258). If you want those features,

				you'll need to use a different build of clangd.

				remote indexing (see https://crbug.com/1358258), such that `clangd --version`

				will not mention `grpc`, and you will see “Unknown Index key External” warnings

				in the clangd log.

				If you want those features, you'll need to use a different build of clangd,

				such as the [clangd/clangd releases on

				GitHub](https://github.com/clangd/clangd/releases).

				***

				## Setting Up

Document how to get a clangd build with remote indexing

9 docs/clangd.md

9

docs/clangd.md