Page MenuHomePhabricator

Added more detailed documentation for clangd
ClosedPublic

Authored by gribozavr on Feb 27 2019, 3:41 AM.

Diff Detail

Repository
rL LLVM

Event Timeline

gribozavr created this revision.Feb 27 2019, 3:41 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 27 2019, 3:41 AM

Still looking at it, a few quick notes.
Also added ioeric for an extra pair of eyes (it's a large change!).

clang-tools-extra/docs/clangd/Installation.rst
360 ↗(On Diff #188513)

I'd avoid mentioning it at all, we didn't vet it for the 8 release (and I believe we landed critical fixes after the release cut).
We could add it back during 9.0 release.

clang-tools-extra/docs/clangd/index.rst
20 ↗(On Diff #188513)

The original "clangd is a language server" looked somewhat better.
Having a link to the LSP website is a good bet, though.

gribozavr marked 4 inline comments as done.Feb 27 2019, 5:54 AM
gribozavr added inline comments.
clang-tools-extra/docs/clangd/Installation.rst
360 ↗(On Diff #188513)

Removed in this patch (that I plan to cherry-pick into the 8.0 release branch). Will re-add in a separate patch, so that it goes into 9.0.

clang-tools-extra/docs/clangd/index.rst
20 ↗(On Diff #188513)

Reworded to add the phrase "language server".

gribozavr updated this revision to Diff 188521.Feb 27 2019, 5:54 AM
gribozavr marked 2 inline comments as done.

Addressed review comments

gribozavr marked an inline comment as done.Feb 27 2019, 6:35 AM
gribozavr added inline comments.
clang-tools-extra/docs/clangd/Installation.rst
360 ↗(On Diff #188513)

Reverted back after offline discussion.

gribozavr updated this revision to Diff 188531.Feb 27 2019, 7:18 AM

Added custom CSS for the details tag.

ilya-biryukov added inline comments.Feb 27 2019, 7:22 AM
clang-tools-extra/docs/clangd/Features.rst
41 ↗(On Diff #188531)

It feels wrong to have announcements of the 9.0 features in the 8.0 release.
Maybe remove these. WDYT?

ilya-biryukov added a comment.EditedFeb 27 2019, 7:25 AM

It feels we have two groups of docs here, do you think it would be useful to split them more explicitly?
Specifically, we have:

  1. User documentation
    • Getting started with clangd
    • Features
  2. Developer documentation
    • Protocol extensions
    • Compiling clangd
    • Contributing to clangd

And the split is somewhat implicit right now

gribozavr updated this revision to Diff 188534.Feb 27 2019, 7:36 AM

Separated user and developer documentation

This revision is now accepted and ready to land.Feb 27 2019, 7:43 AM
gribozavr updated this revision to Diff 188536.Feb 27 2019, 7:43 AM

Removed mentions of clangd v9.

This revision was automatically updated to reflect the committed changes.
Herald added a project: Restricted Project. · View Herald TranscriptFeb 27 2019, 7:52 AM
thakis added inline comments.
clang-tools-extra/trunk/docs/clangd/Installation.rst
325

Isn't the order of the arguments the wrong way round here?

kadircet added inline comments.Mon, Jul 15, 8:12 AM
clang-tools-extra/trunk/docs/clangd/Installation.rst
325

yeah that seems to be the case it should rather be

$ ln -s ~/myproject-build/compile_commands.json ~/myproject/

sending out a patch, thanks for bringing it up!