The code review application is started by entering a command
on the Linux or Windows command line.
When you type
the command to start the code review application, follow these guidelines:
- Enter the command as a single line.
- Use fully qualified paths for directories and files.
- Enter the parameters in any sequence.
- Put quotation marks around any parameter value that contains spaces.
- Use environment variables if necessary to shorten the length of
the command line.
For more information about the command parameters, see Parameters of the code review application command for Linux and Windows.
The command has the
following syntax:
Figure 1. Syntax for starting
the code review application eclipse_directory\eclipse | eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data workspace_directory
-rulefile rule_file
[-projects P1[, P2, P3, ...] |
-directory D1[, D2, D3, ...]]
[-includefile include_file]
[-excludefile exclude_file]
-exportdirectory export_directory
[-nosplash]
[-verbose]
[ >output_file]
- eclipse_directory\eclipse | eclipse.exe
- The fully qualified path of the Eclipse executable file. Use eclipse for Linux or eclipse.exe for Windows.
- -application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
- The name of the code analysis component.
- -data workspace_directory
- The fully qualified path of the Eclipse workspace that you are
using.
- -rulefile rule_file
- The fully qualified path of a .dat file
that contains a set of rules and severities that you exported from
the analysis configuration editor.
- -projects P1[, P2, P3, ...]
- A comma-separated list of projects in the workspace that contain
source files.
- -directory D1[, D2, D3, ...]
- A comma-separated list of directories that contain source files.
- -includefile include_file
- A file that contains a list of files to be included in the code
review.
- -excludefile exclude_file
- A file that contains a list of files to be excluded from the code
review.
- -exportdirectory export_directory
- The fully qualified path of a directory where output
data files are written.
- -nosplash
- Suppresses the display of the Eclipse splash
screen.
- -verbose
- Causes output information to be written to standard
output.
- >output_file
- A text file which captures output information that is written
to standard output.
Note: The following Eclipse parameters are not
supported:
- -reportdirectory
- -projectname
- -bindirectory
- -javacp
Sample commands
These sample commands illustrate how to start the code
review application. Enter the command as one line on the Linux or Windows command
line. For another example of the code review application command,
see Running the sample script.
- Using the -project parameter with two COBOL projects:
C:\progra~1\IBM\SDP\eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data "C:\RDz 85 workspaces\workspace_851_0914"
-rulefile "C:\RDz 8.5\CodeQuality\results\cobolRules.dat"
-projects "My COBOL project 0001","My COBOL project 0002"
-exportdirectory "C:\RDz 8.5\CodeQuality\CommandlineResults\Results851"
-nosplash
-verbose > c:\commandlineResults\out851_0916_COBOLProjects.txt
- Using the -directory parameter and the -excludefile parameter:
C:\progra~1\IBM\SDP\eclipse.exe
-application com.ibm.rsaz.analysis.commandline.AnalyzeApplication
-data "C:\RDz 85 workspaces\workspace_851_0914"
-rulefile "C:\RDz 8.5\CodeQuality\results\cobolRules.dat"
-directory "C:\CheckSourceCode\Cobol_Files_0001"
-excludefile "C:\RDz 8.5\CodeQuality\directoryExcludeFiles.txt"
-exportdirectory "C:\RDz 8.5\CodeQuality\CommandlineResults\Results851"
-nosplash
-verbose > c:\commandlineResults\out851_0916_COBOLProjects.txt