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

[Kadir Cetinkaya via Phabricator via cfe-commits]

kadircet created this revision.
kadircet added a reviewer: sammccall.
Herald added subscribers: cfe-commits, arphaman, jkorous, MaskRay, ioeric, ilya-biryukov.

Repository:
  rCTE Clang Tools Extra

https://reviews.llvm.org/D57392

Files:
  docs/clangd.rst


Index: docs/clangd.rst
===================================================================
--- docs/clangd.rst
+++ docs/clangd.rst
@@ -143,6 +143,22 @@
 :program:`Emacs` provides `lsp-mode <github.com/emacs-lsp/lsp-mode>`_ and
 `Eglot <https://github.com/joaotavora/eglot>`_ plugins for LSP integration.
 
+Project-wide Index
+==================
+
+By default :program:`Clangd` only has a view on symbols coming from files you
+are currently editing. You can extend this view to whole project by providing a
+project-wide index to :program:`Clangd`.
+
+There are two ways you can generate a project-wide index for clangd:
+
+- Passing experimental `-background-index` commandline argument, which will take
+  care of everything automatically.
+- Generate an index file using `clangd_indexer
+  <https://github.com/llvm-mirror/clang-tools-extra/blob/master/clangd/indexer/IndexerMain.cpp>`_
+  Note that you need to build `clangd_indexer` from source. Afterwards you can
+  pass generated index file to clangd using `-index-file=/path/to/index_file`.
+
 Getting Involved
 ==================
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D57392.184102.patch
Type: text/x-patch
Size: 1092 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20190129/36e26b5a/attachment.bin>