From: Mike Aizatsky <aizatsky@chromium.org>
Date: Fri, 24 Feb 2017 23:55:18 +0000 (+0000)
Subject: [sancov] extending sancov --help documentation
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=16f0a906631b891cf89eb99cbc195a30411e6380;p=llvm

[sancov] extending sancov --help documentation

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@296205 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/tools/sancov/sancov.cc b/tools/sancov/sancov.cc
index c56ea67b12c..cb097436bfe 100644
--- a/tools/sancov/sancov.cc
+++ b/tools/sancov/sancov.cc
@@ -96,7 +96,8 @@ cl::opt<ActionType> Action(
 
 static cl::list<std::string>
     ClInputFiles(cl::Positional, cl::OneOrMore,
-                 cl::desc("(<binary file>|<.sancov file>)..."));
+                 cl::desc("<action> <binary files...> <.sancov files...> "
+                          "<.symcov files...>"));
 
 static cl::opt<bool> ClDemangle("demangle", cl::init(true),
                                 cl::desc("Print demangled function name."));
@@ -1200,7 +1201,17 @@ int main(int Argc, char **Argv) {
   llvm::InitializeAllTargetMCs();
   llvm::InitializeAllDisassemblers();
 
-  cl::ParseCommandLineOptions(Argc, Argv, "Sanitizer Coverage Processing Tool");
+  cl::ParseCommandLineOptions(Argc, Argv, 
+      "Sanitizer Coverage Processing Tool (sancov)\n\n"
+      "  This tool can extract various coverage-related information from: \n"
+      "  coverage-instrumented binary files, raw .sancov files and their "
+      "symbolized .symcov version.\n"
+      "  Depending on chosen action the tool expects different input files:\n"
+      "    -print-coverage-pcs     - coverage-instrumented binary files\n"
+      "    -print-coverage         - .sancov files\n"
+      "    <other actions>         - .sancov files & corresponding binary "
+      "files, .symcov files\n"
+      );
 
   // -print doesn't need object files.
   if (Action == PrintAction) {