[clangd] Clarify and hide -index flag.
authorEric Liu <ioeric@google.com>
Thu, 13 Sep 2018 12:53:23 +0000 (12:53 +0000)
committerEric Liu <ioeric@google.com>
Thu, 13 Sep 2018 12:53:23 +0000 (12:53 +0000)
Summary:
The wording implies global index support, which is confusing.
As most users shouldn't care about this flag, also make it hidden to avoid
further confusion.

Reviewers: sammccall, ilya-biryukov

Subscribers: MaskRay, jkorous, arphaman, kadircet, cfe-commits

Differential Revision: https://reviews.llvm.org/D51977

llvm-svn: 342134

clang-tools-extra/clangd/tool/ClangdMain.cpp

index c7d99d2..b3b34de 100644 (file)
@@ -130,10 +130,11 @@ static llvm::cl::opt<Path> InputMirrorFile(
 
 static llvm::cl::opt<bool> EnableIndex(
     "index",
-    llvm::cl::desc("Enable index-based features such as global code completion "
-                   "and searching for symbols. "
-                   "Clang uses an index built from symbols in opened files"),
-    llvm::cl::init(true));
+    llvm::cl::desc(
+        "Enable index-based features. By default, clangd maintains an index "
+        "built from symbols in opened files. Global index support needs to "
+        "enabled separatedly."),
+    llvm::cl::init(true), llvm::cl::Hidden);
 
 static llvm::cl::opt<bool>
     ShowOrigins("debug-origin",