llvm-cov: Improve help message text
authorJustin Bogner <mail@justinbogner.com>
Wed, 29 Jan 2014 21:31:45 +0000 (21:31 +0000)
committerJustin Bogner <mail@justinbogner.com>
Wed, 29 Jan 2014 21:31:45 +0000 (21:31 +0000)
This Properly capitalizes and clarifies the help output from
llvm-cov. It also puts the llvm-only / non-gcov-compatible options in
their own category.

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

tools/llvm-cov/llvm-cov.cpp

index 177c99d8968084ff94115e199e0815f4ae70a95f..3f52f94010cbb2cb5adedb670d5fa8a84b01da8e 100644 (file)
@@ -24,31 +24,30 @@ using namespace llvm;
 static cl::opt<std::string> SourceFile(cl::Positional, cl::Required,
                                        cl::desc("SOURCEFILE"));
 
-static cl::opt<bool>
-DumpGCOV("dump", cl::init(false), cl::desc("dump gcov file"));
+static cl::opt<bool> AllBlocks("a", cl::init(false),
+                               cl::desc("Display all basic blocks"));
 
-static cl::opt<std::string>
-InputGCNO("gcno", cl::desc("<input gcno file>"), cl::init(""));
+static cl::opt<bool> BranchProb("b", cl::init(false),
+                                cl::desc("Display branch probabilities"));
 
-static cl::opt<std::string>
-InputGCDA("gcda", cl::desc("<input gcda file>"), cl::init(""));
+static cl::opt<bool> BranchCount("c", cl::init(false),
+                                 cl::desc("Display branch counts instead "
+                                           "of percentages (requires -b)"));
 
-static cl::opt<bool>
-AllBlocks("a", cl::init(false), cl::desc("display all block info"));
+static cl::opt<bool> FuncSummary("f", cl::init(false),
+                                 cl::desc("Show coverage for each function"));
 
-static cl::opt<bool>
-BranchInfo("b", cl::init(false), cl::desc("display branch info"));
+static cl::opt<bool> UncondBranch("u", cl::init(false),
+                                  cl::desc("Display unconditional branch info "
+                                           "(requires -b)"));
 
-static cl::opt<bool>
-BranchCount("c", cl::init(false), cl::desc("display branch counts instead of \
-                                            probabilities (requires -b)"));
-
-static cl::opt<bool>
-FuncCoverage("f", cl::init(false), cl::desc("output function coverage"));
-
-static cl::opt<bool>
-UncondBranch("u", cl::init(false), cl::desc("display unconditional branch info \
-                                             (requires -b)"));
+static cl::OptionCategory DebugCat("Internal and debugging options");
+static cl::opt<bool> DumpGCOV("dump", cl::init(false), cl::cat(DebugCat),
+                              cl::desc("Dump the gcov file to stderr"));
+static cl::opt<std::string> InputGCNO("gcno", cl::cat(DebugCat), cl::init(""),
+                                      cl::desc("Override inferred gcno file"));
+static cl::opt<std::string> InputGCDA("gcda", cl::cat(DebugCat), cl::init(""),
+                                      cl::desc("Override inferred gcda file"));
 
 //===----------------------------------------------------------------------===//
 int main(int argc, char **argv) {
@@ -57,7 +56,7 @@ int main(int argc, char **argv) {
   PrettyStackTraceProgram X(argc, argv);
   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 
-  cl::ParseCommandLineOptions(argc, argv, "llvm coverage tool\n");
+  cl::ParseCommandLineOptions(argc, argv, "LLVM code coverage tool\n");
 
   if (InputGCNO.empty())
     InputGCNO = SourceFile.substr(0, SourceFile.rfind(".")) + ".gcno";
@@ -91,7 +90,7 @@ int main(int argc, char **argv) {
   if (DumpGCOV)
     GF.dump();
 
-  GCOVOptions Options(AllBlocks, BranchInfo, BranchCount, FuncCoverage,
+  GCOVOptions Options(AllBlocks, BranchProb, BranchCount, FuncSummary,
                       UncondBranch);
   FileInfo FI(Options);
   GF.collectLineCounts(FI);