Document checkout_clangd does not support remote index

Adds a note that the version of clangd provided by "checkout_clangd"
does not support optional features like a remote index.

Bug: 1358258
Change-Id: I910683a7256a91dc696d850405dd0ab1b5b1f1c5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3866755
Reviewed-by: James Cook <jamescook@chromium.org>
Commit-Queue: K. Moon <kmoon@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1041646}

This commit is contained in:

K. Moon

2022-08-31 18:49:19 +00:00

committed by

Chromium LUCI CQ

parent bc5fa084ca

commit e7c4598da4

1 changed files with 6 additions and 0 deletions

									
										6

docs/clangd.md
									
				@ -62,6 +62,12 @@ Once you have an appropriate clangd binary, you must configure your editor to

				use it, either by placing it first on your `PATH`, or through editor-specific

				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.

				***

				## Setting Up

				1. Make sure generated ninja files are up-to-date.

Document checkout_clangd does not support remote index

6 docs/clangd.md

6

docs/clangd.md