diff options
| author | Sam McCall <sam.mccall@gmail.com> | 2019-07-25 08:00:54 +0000 |
|---|---|---|
| committer | Sam McCall <sam.mccall@gmail.com> | 2019-07-25 08:00:54 +0000 |
| commit | 85d2fe786198e66de9dd80f0db48d1942ade146f (patch) | |
| tree | dee07ebd0d78cd79d8036ab53e809eb05a6d3ac2 | |
| parent | 8faffec4e22191ad3d2a78b50f73d1010f666b60 (diff) | |
| download | llvm-85d2fe786198e66de9dd80f0db48d1942ade146f.zip llvm-85d2fe786198e66de9dd80f0db48d1942ade146f.tar.gz llvm-85d2fe786198e66de9dd80f0db48d1942ade146f.tar.bz2 | |
[clangd] Provide help text to users who run `clangd` in a terminal.
Reviewers: hokein
Subscribers: ilya-biryukov, MaskRay, jkorous, arphaman, kadircet, cfe-commits
Tags: #clang
Differential Revision: https://reviews.llvm.org/D65201
llvm-svn: 366992
| -rw-r--r-- | clang-tools-extra/clangd/tool/ClangdMain.cpp | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/clang-tools-extra/clangd/tool/ClangdMain.cpp b/clang-tools-extra/clangd/tool/ClangdMain.cpp index 74809e49..42c9601 100644 --- a/clang-tools-extra/clangd/tool/ClangdMain.cpp +++ b/clang-tools-extra/clangd/tool/ClangdMain.cpp @@ -515,6 +515,11 @@ clangd accepts flags on the commandline, and in the CLANGD_FLAGS environment var if (Tracer) TracingSession.emplace(*Tracer); + // If a user ran `clangd` in a terminal without redirecting anything, + // it's somewhat likely they're confused about how to use clangd. + // Show them the help overview, which explains. + if (llvm::outs().is_displayed() && llvm::errs().is_displayed()) + llvm::errs() << Overview << "\n"; // Use buffered stream to stderr (we still flush each log message). Unbuffered // stream can cause significant (non-deterministic) latency for the logger. llvm::errs().SetBuffered(); |