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

[Kirill Bobyrev via Phabricator via cfe-commits]

kbobyrev created this revision.
kbobyrev added reviewers: ioeric, ilya-biryukov.
kbobyrev added a project: clang-tools-extra.
Herald added subscribers: arphaman, jkorous, MaskRay.

`global-symbol-builder` help message mentions `-executor=<string>` option, but doesn't give any example of what the value could be

Assuming the most popular use case to be building the whole project index, help message should probably give an example of such usage.


https://reviews.llvm.org/D49785

Files:
  clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp


Index: clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp
===================================================================
--- clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp
+++ clang-tools-extra/clangd/global-symbol-builder/GlobalSymbolBuilderMain.cpp
@@ -150,10 +150,16 @@
 int main(int argc, const char **argv) {
   llvm::sys::PrintStackTraceOnErrorSignal(argv[0]);
 
-  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
+  for clangd (global code completion). It would be changed and deprecated
+  eventually. Don't use it in production code!
+
+  Example usage for building index for the whole project:
+
+  $ global-symbol-builder --executor=all-TUs compile_commands.json > index.yaml
+  )";
+
   auto Executor = clang::tooling::createExecutorFromCommandLineArgs(
       argc, argv, cl::GeneralCategory, Overview);
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D49785.157227.patch
Type: text/x-patch
Size: 1186 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20180725/1b9a0949/attachment.bin>