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

[Kadir Cetinkaya via Phabricator via cfe-commits]

kadircet 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;
----------------
hokein wrote:
> 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?
yes, but still if you are planning to mention this please also mention something like: `Index shards for common headers like standard library will be stored in $HOME/.clangd/index`


================
Comment at: clang-tools-extra/docs/clangd/Installation.rst:365
+- background indexing canb be disable by the ``--background-index=false`` flag;
+  if it is disabled, clangd doesn't have a global view of the whole project, it
+  only has a view on symbols coming from files you are currently editing;
----------------
kadircet wrote:
> instead of `if it's disabled...`
> 
> ```
> Note that, disabling background-index will limit clangd's knowledge about your codebase to
> files you are currently editing.
> ```
seems to be the same?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D66937