Clean up documentation and naming of variables.

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

1 files changed, 15 insertions, 12 deletions

diff --git a/tools/llvm-abcd/llvm-abcd.cpp b/tools/llvm-abcd/llvm-abcd.cpp
index b0ce2bf..b879cf8 100644
--- a/tools/llvm-abcd/llvm-abcd.cpp
+++ b/tools/llvm-abcd/llvm-abcd.cpp
@@ -2,7 +2,7 @@
 // 
 //                     The LLVM Compiler Infrastructure
 //
-// This file was developed by Reid Spencerearch and is distributed under the 
+// This file was developed by Reid Spencer and is distributed under the 
 // University of Illinois Open Source License. See LICENSE.TXT for details.
 // 
 //===----------------------------------------------------------------------===//
@@ -12,18 +12,21 @@
 //  llvm-abcd [options] x.bc - Read LLVM bytecode from the x.bc file
 //
 //  Options:
-//      --help    - Output information about command line switches
-//      --details - Provide detailed analysis of individual functions
-//      --dump    - Dump bytecode in readable format
+//      --help      - Output information about command line switches
+//      --nodetails - Don't print out detailed informaton about individual 
+//                    blocks and functions
+//      --dump      - Dump low-level bytecode structure in readable format
 //
 // This tool provides analytical information about a bytecode file. It is
 // intended as an aid to developers of bytecode reading and writing software. It
 // produces on std::out a summary of the bytecode file that shows various 
-// statistics about the contents of the file. If the -details option is given
-// then the output includes detailed information about each function in the 
-// bytecode file.  The tool is also able to print a bytecode file in a straight 
-// forward text format // that shows the containment and relationships of the 
-// information in the bytecode file (-dump option). 
+// statistics about the contents of the file. By default this information is
+// detailed and contains information about individual bytecode blocks and the
+// functions in the module. To avoid this more detailed output, use the 
+// -nodetails option to limit the output to just module level information.
+// The tool is also able to print a bytecode file in a straight forward text 
+// format that shows the containment and relationships of the information in 
+// the bytecode file (-dump option). 
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Bytecode/Analyzer.h"
@@ -37,8 +40,8 @@ using namespace llvm;
 static cl::opt<std::string>
   InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
 
-static cl::opt<bool> Detailed ("nodetails", cl::desc("Skip detailed output"));
-static cl::opt<bool> Dump     ("dump", cl::desc("Detailed output"));
+static cl::opt<bool> NoDetails ("nodetails", cl::desc("Skip detailed output"));
+static cl::opt<bool> Dump      ("dump", cl::desc("Detailed output"));
 
 int 
 main(int argc, char **argv) 
@@ -55,7 +58,7 @@ main(int argc, char **argv)
 
   /// Determine what to generate
   bca.dumpBytecode = Dump;
-  bca.detailedResults = !Detailed;
+  bca.detailedResults = !NoDetails;
 
   /// Analyze the bytecode file
   AnalyzeBytecodeFile(InputFilename, bca, &ErrorMessage);