Index: docs/clangd.rst =================================================================== --- docs/clangd.rst +++ docs/clangd.rst @@ -143,6 +143,23 @@ :program:`Emacs` provides `lsp-mode `_ and `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 + `_ + 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.* + Getting Involved ==================