[PATCH] D57392: [clangd] Mention indexing in docs.

Sam McCall via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Feb 7 07:28:01 PST 2019

sammccall accepted this revision.
sammccall added a comment.
This revision is now accepted and ready to land.
Herald added a project: clang.

Sorry about delaying this.

Comment at: docs/clangd.rst:156
+- Passing experimental `-background-index` commandline argument, which will take
+  care of everything automatically.
+- Generate an index file using `clangd_indexer
I think we should be a little more specific here: which will incrementally build an index of the projects that you work on

Comment at: docs/clangd.rst:160
+  Afterwards you can pass generated index file to clangd using
+  `-index-file=/path/to/index_file`.  *Note that you need to build
+  `clangd_indexer` from source.*
nit: clangd-indexer rather than clangd_indexer, I think.
Maybe slightly more explicit: *Note that clangd-indexer isn't included alongside clangd in the standard clang-tools package. You will likely have to build from source to use this option*

  rCTE Clang Tools Extra



More information about the cfe-commits mailing list