This is an archive of the discontinued LLVM Phabricator instance.

Differential D57392

[clangd] Mention indexing in docs.
ClosedPublic

Authored by kadircet on Jan 29 2019, 9:18 AM.

Details

Reviewers
sammccall
Commits
rGb88144e4babd: [clangd] Mention indexing in docs.
rL353423: [clangd] Mention indexing in docs.
rCTE353423: [clangd] Mention indexing in docs.

Diff Detail

Event Timeline

kadircet created this revision.Jan 29 2019, 9:18 AM
Herald added subscribers: cfe-commits, arphaman, jkorous and 3 others. · View Herald TranscriptJan 29 2019, 9:18 AM
Harbormaster completed remote builds in B27445: Diff 184102.Jan 29 2019, 9:20 AM
kadircet updated this revision to Diff 184104.Jan 29 2019, 9:24 AM
  • Change ordering of sentences
Harbormaster completed remote builds in B27447: Diff 184104.Jan 29 2019, 9:25 AM
sammccall accepted this revision.Feb 7 2019, 7:26 AM

Sorry about delaying this.

docs/clangd.rst
156

I think we should be a little more specific here: which will incrementally build an index of the projects that you work on

160

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*

This revision is now accepted and ready to land.Feb 7 2019, 7:26 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 7 2019, 7:26 AM
kadircet updated this revision to Diff 185777.Feb 7 2019, 8:07 AM
kadircet marked 2 inline comments as done.

Address comments

Harbormaster completed remote builds in B27885: Diff 185777.Feb 7 2019, 8:09 AM
Closed by commit rCTE353423: [clangd] Mention indexing in docs. (authored by kadircet). · Explain WhyFeb 7 2019, 8:10 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
docs/
16 lines

Diff 184102

docs/clangd.rst

Show First 20 Lines • Show All 137 Lines • ▼ Show 20 Lines
from :program:`VSCode`. from :program:`VSCode`.
Emacs Integration Emacs Integration
----------------- -----------------
:program:`Emacs` provides `lsp-mode <github.com/emacs-lsp/lsp-mode>`_ and :program:`Emacs` provides `lsp-mode <github.com/emacs-lsp/lsp-mode>`_ and
`Eglot <https://github.com/joaotavora/eglot>`_ plugins for LSP integration. `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.
sammccallUnsubmitted
Done
ReplyInline Actions

I think we should be a little more specific here: which will incrementally build an index of the projects that you work on

sammccall: I think we should be a little more specific here: which will incrementally build an index of…
- 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`.
sammccallUnsubmitted
Done
ReplyInline Actions

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*

sammccall: nit: clangd-indexer rather than clangd_indexer, I think. Maybe slightly more explicit: *Note…
Getting Involved Getting Involved
================== ==================
A good place for interested contributors is the `Clangd developer mailing list A good place for interested contributors is the `Clangd developer mailing list
<https://lists.llvm.org/mailman/listinfo/clangd-dev>`_. For discussions with the <https://lists.llvm.org/mailman/listinfo/clangd-dev>`_. For discussions with the
broader community on topics not only related to Clangd, use broader community on topics not only related to Clangd, use
`Clang developer mailing list `Clang developer mailing list
<https://lists.llvm.org/mailman/listinfo/cfe-dev>`_. <https://lists.llvm.org/mailman/listinfo/cfe-dev>`_.
If you're also interested in contributing patches to :program:`Clangd`, take a If you're also interested in contributing patches to :program:`Clangd`, take a
look at the `LLVM Developer Policy look at the `LLVM Developer Policy
<https://llvm.org/docs/DeveloperPolicy.html>`_ and `Code Reviews <https://llvm.org/docs/DeveloperPolicy.html>`_ and `Code Reviews
<https://llvm.org/docs/Phabricator.html>`_ page. Contributions of new features <https://llvm.org/docs/Phabricator.html>`_ page. Contributions of new features
to the `Language Server Protocol to the `Language Server Protocol
<https://github.com/Microsoft/language-server-protocol>`_ itself would also be <https://github.com/Microsoft/language-server-protocol>`_ itself would also be
very useful, so that :program:`Clangd` can eventually implement them in a very useful, so that :program:`Clangd` can eventually implement them in a
conforming way. conforming way.