[PATCH] D66937: [clangd] Fix the stale documentation about background indexing.

Haojian Wu via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Tue Sep 24 04:38:42 PDT 2019


hokein added inline comments.


================
Comment at: clang-tools-extra/docs/clangd/Installation.rst:363
 
-- Pass an experimental `-background-index` command line argument.  With
-  this feature enabled, clangd incrementally builds an index of projects
-  that you work on and uses the just-built index automatically.
+- the index is saved to the ``.clangd/index`` in the project root;
+- background indexing canb be disable by the ``--background-index=false`` flag;
----------------
kadircet wrote:
> that's not necessarily true, we also save at home directory, and I don't think it is relevant for installation. maybe rather drop it?
I think it is important to mention this. For most cases, .clangd/index is in in the project root, right?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D66937





More information about the cfe-commits mailing list