From f244db54bfc37f5cc1d831f54c74e818e69bd28c Mon Sep 17 00:00:00 2001
From: Cristian Cadar <c.cadar@imperial.ac.uk>
Date: Tue, 1 Mar 2016 14:36:13 +0000
Subject: Documented default values for various options and improved the
 description of some.

---
 lib/Core/StatsTracker.cpp | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

(limited to 'lib/Core/StatsTracker.cpp')

diff --git a/lib/Core/StatsTracker.cpp b/lib/Core/StatsTracker.cpp
index 9995b7e2..5e77172e 100644
--- a/lib/Core/StatsTracker.cpp
+++ b/lib/Core/StatsTracker.cpp
@@ -68,45 +68,46 @@ using namespace llvm;
 namespace {  
   cl::opt<bool>
   TrackInstructionTime("track-instruction-time",
-                       cl::desc("Enable tracking of time for individual instructions"),
-                       cl::init(false));
+                       cl::init(false),
+		       cl::desc("Enable tracking of time for individual instructions (default=off)"));
 
   cl::opt<bool>
   OutputStats("output-stats",
-              cl::desc("Write running stats trace file"),
-              cl::init(true));
+              cl::init(true),
+	      cl::desc("Write running stats trace file (default=on)"));
 
   cl::opt<bool>
   OutputIStats("output-istats",
-               cl::desc("Write instruction level statistics (in callgrind format)"),
-               cl::init(true));
+	       cl::init(true),
+               cl::desc("Write instruction level statistics in callgrind format (default=on)"));
 
   cl::opt<double>
   StatsWriteInterval("stats-write-interval",
-                     cl::desc("Approximate number of seconds between stats writes (default: 1.0)"),
-                     cl::init(1.));
+                     cl::init(1.),
+		     cl::desc("Approximate number of seconds between stats writes (default=1.0s)"));
 
   cl::opt<double>
   IStatsWriteInterval("istats-write-interval",
-                      cl::desc("Approximate number of seconds between istats writes (default: 10.0)"),
-                      cl::init(10.));
+		      cl::init(10.),
+                      cl::desc("Approximate number of seconds between istats writes (default: 10.0s)"));
 
   /*
   cl::opt<double>
   BranchCovCountsWriteInterval("branch-cov-counts-write-interval",
-                     cl::desc("Approximate number of seconds between run.branches writes (default: 5.0)"),
+                     cl::desc("Approximate number of seconds between run.branches writes (default: 5.0s)"),
                      cl::init(5.));
   */
 
   // XXX I really would like to have dynamic rate control for something like this.
   cl::opt<double>
   UncoveredUpdateInterval("uncovered-update-interval",
-                          cl::init(30.));
+                          cl::init(30.),
+			  cl::desc("(default=30.0s)"));
   
   cl::opt<bool>
   UseCallPaths("use-call-paths",
-               cl::desc("Enable calltree tracking for instruction level statistics"),
-               cl::init(true));
+	       cl::init(true),
+               cl::desc("Enable calltree tracking for instruction level statistics (default=on)"));
   
 }
 
-- 
cgit v1.2.3