Reformat help text for scan-build, and remove -constraints

and -store from help text because they are no longer relevant
to users.

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

1 files changed, 84 insertions, 58 deletions

diff --git a/tools/scan-build/scan-build b/tools/scan-build/scan-build
index e2efa44bc1..c4982db20f 100755
--- a/tools/scan-build/scan-build
+++ b/tools/scan-build/scan-build
@@ -1017,74 +1017,100 @@ ENDTEXT
 print <<ENDTEXT;
 OPTIONS:
 
- -analyze-headers - Also analyze functions in #included files.
+ -analyze-headers
  
- -o             - Target directory for HTML report files.  Subdirectories
-                  will be created as needed to represent separate "runs" of
-                  the analyzer.  If this option is not specified, a directory
-                  is created in /tmp (TMPDIR on Mac OS X) to store the reports.
-                  
- -h             - Display this message.
+   Also analyze functions in #included files.  By default, such functions
+   are skipped unless they are called by functions within the main source file.
+ 
+ -o <output location>
+  
+   Specifies the output directory for analyzer reports. Subdirectories will be
+   created as needed to represent separate "runs" of the analyzer. If this
+   option is not specified, a directory is created in /tmp (TMPDIR on Mac OS X)
+   to store the reports.
+
+ -h             
  --help
 
- -k             - Add a "keep on going" option to the specified build command.
- --keep-going     This option currently supports make and xcodebuild.
-                  This is a convenience option; one can specify this
-                  behavior directly using build options.
+   Display this message.
 
- --html-title [title]       - Specify the title used on generated HTML pages.
- --html-title=[title]         If not specified, a default title will be used.
+ -k
+ --keep-going
+				  
+   Add a "keep on going" option to the specified build command. This option
+   currently supports make and xcodebuild. This is a convenience option; one
+   can specify this behavior directly using build options.
 
- -plist         - By default the output of scan-build is a set of HTML files.
-                  This option outputs the results as a set of .plist files.
- 
- -plist-html    - By default the output of scan-build is a set of HTML files.
-                  This option outputs the results as a set of HTML 
-                  and .plist files.
- 
- --status-bugs  - By default, the exit status of $Prog is the same as the
-                  executed build command.  Specifying this option causes the
-                  exit status of $Prog to be 1 if it found potential bugs
-                  and 0 otherwise.
+ --html-title [title]
+ --html-title=[title]
 
- --use-cc [compiler path]   - $Prog attempts to guess the default compiler for
- --use-cc=[compiler path]     your C and Objective-C code. Use this option
-                              to specify an alternate compiler.
+   Specify the title used on generated HTML pages. If not specified, a default
+   title will be used.
 
- --use-c++ [compiler path]  - $Prog attempts to guess the default compiler for
- --use-c++=[compiler path]    your C++ and Objective-C++ code. Use this option
-                              to specify an alternate compiler.
+ -plist
+ 
+   By default the output of scan-build is a set of HTML files. This option
+   outputs the results as a set of .plist files.
+ 
+ -plist-html
+ 
+   By default the output of scan-build is a set of HTML files. This option
+   outputs the results as a set of HTML and .plist files.
+ 
+ --status-bugs
+ 
+   By default, the exit status of scan-build is the same as the executed build
+   command. Specifying this option causes the exit status of scan-build to be 1
+   if it found potential bugs and 0 otherwise.
+
+ --use-cc [compiler path]   
+ --use-cc=[compiler path]
+  
+   scan-build analyzes a project by interposing a "fake compiler", which
+   executes a real compiler for compilation and the static analyzer for analysis.
+   Because of the current implementation of interposition, scan-build does not
+   know what compiler your project normally uses.  Instead, it simply overrides
+   the CC environment variable, and guesses your default compiler.
+   
+   In the future, this interposition mechanism to be improved, but if you need
+   scan-build to use a specific compiler for *compilation* then you can use
+   this option to specify a path to that compiler.
+
+ --use-c++ [compiler path]
+ --use-c++=[compiler path]
+ 
+   This is the same as "-use-cc" but for C++ code.
+ 
+ -v
+ 
+   Enable verbose output from scan-build. A second and third '-v' increases
+   verbosity.
 
- -v             - Verbose output from $Prog and the analyzer.
-                  A second and third '-v' increases verbosity.
+ -V
+ --view
 
- -V             - View analysis results in a web browser when the build
- --view           completes.
+   View analysis results in a web browser when the build completes.
 
 ADVANCED OPTIONS:
 
- -constraints [model] - Specify the contraint engine used by the analyzer.
-                        By default the 'range' model is used.  Specifying 
-                        'basic' uses a simpler, less powerful constraint model
-                        used by checker-0.160 and earlier.
-
- -store [model] - Specify the store model used by the analyzer. By default,
-                  the 'region' store model is used. 'region' specifies a field-
-                  sensitive store model. Users can also specify 'basic', which
-                  is far less precise but can more quickly analyze code.
-                  'basic' was the default store model for checker-0.221 and
-                  earlier.
-
- -no-failure-reports - Do not create a 'failures' subdirectory that includes
-                       analyzer crash reports and preprocessed source files.
+ -no-failure-reports
+ 
+   Do not create a 'failures' subdirectory that includes analyzer crash reports
+   and preprocessed source files.
 
- -stats - Generates visitation statistics for the project being analyzed.
+ -stats
+ 
+   Generates visitation statistics for the project being analyzed.
 
- -maxloop N - specifiy the number of times a block can be visited before giving
-              up. Default is 4. Increase for more comprehensive coverage at a
-              cost of speed.
- -internal-stats - Generate internal analyzer statistics.
+ -maxloop <loop count>
  
+   Specifiy the number of times a block can be visited before giving up.
+   Default is 4. Increase for more comprehensive coverage at a cost of speed.
+  
+ -internal-stats
+ 
+   Generate internal analyzer statistics.
+
 CONTROLLING CHECKERS:
 
  A default group of checkers are always run unless explicitly disabled.
@@ -1206,12 +1232,12 @@ BUILD OPTIONS
 
 EXAMPLE
 
- $Prog -o /tmp/myhtmldir make -j4
+ scan-build -o /tmp/myhtmldir make -j4
      
- The above example causes analysis reports to be deposited into
- a subdirectory of "/tmp/myhtmldir" and to run "make" with the "-j4" option.
- A different subdirectory is created each time $Prog analyzes a project.
- The analyzer should support most parallel builds, but not distributed builds.
+The above example causes analysis reports to be deposited into a subdirectory
+of "/tmp/myhtmldir" and to run "make" with the "-j4" option. A different
+subdirectory is created each time scan-build analyzes a project. The analyzer
+should support most parallel builds, but not distributed builds.
 
 ENDTEXT
 }