[clang-tools-extra] r353423 - [clangd] Mention indexing in docs.

Kadir Cetinkaya via cfe-commits cfe-commits at lists.llvm.org
Thu Feb 7 08:10:39 PST 2019

Author: kadircet
Date: Thu Feb  7 08:10:39 2019
New Revision: 353423

URL: http://llvm.org/viewvc/llvm-project?rev=353423&view=rev
[clangd] Mention indexing in docs.

Reviewers: sammccall

Subscribers: ilya-biryukov, ioeric, MaskRay, jkorous, arphaman, cfe-commits

Differential Revision: https://reviews.llvm.org/D57392


Modified: clang-tools-extra/trunk/docs/clangd.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clangd.rst?rev=353423&r1=353422&r2=353423&view=diff
--- clang-tools-extra/trunk/docs/clangd.rst (original)
+++ clang-tools-extra/trunk/docs/clangd.rst Thu Feb  7 08:10:39 2019
@@ -143,6 +143,25 @@ Emacs Integration
 :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
+  incrementally build an index of projects that you work on and make use of that
+  in clangd automatically.
+- Generate an index file using `clangd-indexer
+  <https://github.com/llvm-mirror/clang-tools-extra/blob/master/clangd/indexer/IndexerMain.cpp>`_
+  Afterwards you can pass generated index file to clangd using
+  `-index-file=/path/to/index_file`.  *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*
 Getting Involved

More information about the cfe-commits mailing list