[PATCH] D66740: [clangd] Add docs for configuration knobs in clangd

[Sam McCall via Phabricator via cfe-commits]

sammccall accepted this revision.
sammccall added inline comments.
This revision is now accepted and ready to land.


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:10
+
+Clangd has a bunch of command-line options and LSP capabilities that can change
+its behaviour in certain situations. This page aims to define those
----------------
LSP capabilities generally aren't user-servicable and probably shouldn't be covered here.


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:12
+its behaviour in certain situations. This page aims to define those
+configuration knobs.
+
----------------
Maybe mention that clangd command-line options should be specified in an editor-specific way, and point back to the getting started page for details


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:23
+To get over this clangd can query your toolchain driver to extract implicit
+include paths that are unknown to clang. Since this requires executing a binary,
+we require users of this feature to whitelist their driver using the
----------------
Skip the rationale here IMO - just "Specify your driver as a full path or list of globs,..."


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:32
+`/path/to/my-custom-toolchain/arm-none-eabi-g++`; you
+can provide clangd with `--query-driver=**/my-custom-toolchain/arm-none-eabi*`
+to enable execution of any binary that has a name starting with `arm-none-eabi`
----------------
this example is insecure - include the whole prefix instead


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:36
+
+By default this flag is empty, which disallows execution of any driver.
+
----------------
(I think we can drop this sentence, it seems obvious)


================
Comment at: clang-tools-extra/docs/clangd/Configuration.rst:41
+
+You can find rest of the flags in `source code <https://github.com/llvm/llvm-project/blob/master/clang-tools-extra/clangd/tool/ClangdMain.cpp>`__.
----------------
I'd point them at clangd --help rather than the code.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D66740/new/

https://reviews.llvm.org/D66740