[PATCH] D49785: [clangd] Give an example for global-symbol-builder usage

[Eric Liu via Phabricator via cfe-commits]

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


================
Comment at: clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp:153
 
-  const char* Overview =
-      "This is an **experimental** tool to generate YAML-format "
-      "project-wide symbols for clangd (global code completion). It would be "
-      "changed and deprecated eventually. Don't use it in production code!";
+  const auto Overview = R"(
+  This is an **experimental** tool to generate YAML-format project-wide symbols
----------------
why replace `char *` with `auto`? I'd keep char * as it's clearer and short enough.


================
Comment at: clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp:158
+
+  Example usage for building index for the whole project:
+
----------------
Maybe also give an example for running on one file?


https://reviews.llvm.org/D49785