Introduction |
The primary tool for creating and building Understand for Ada reports is repada. It is a command line program that uses the database created by undada to build reports about the analyzed software.
The command line syntax for repada is:
repada -db database_name [options]
-db <database_name>
Specify the Understand for Ada database to be used to create reports. This is the database created by analyze_ada.
-test output_file
Specify the output file name. Use this option to create an ASCII output file containing all reports. Cannot be used in conjunction with -prefix or -html options.
-separate prefix_filename
Used to break each report into a separate ASCII file. The prefix_filename is pre-pended to each generated file. See Extensions used by the -separate option. This option may not be used if -html or -o options are used.
-html html_directory
Use this option to generate HTML versions of the reports. If the directory specified by html_directory exists, it is used, if not it is created. The "home" file of the directory is index.html.
Also specify one of the options -htmlall, -htmlalpha, or -htmlsplit to specify if and how the html files are to be split up. The -html option may not be used if -text or -prefix is used.
-htmlall
Use this option to specify that each html report is to be kept in one html file. Using this option on large projects may cause html browser problems when loading large files.
-htmlalpha
Generate multiple files for each html report, splitting up the files alphabetically by the first character of each entity name. The "home" file of the directory is index.html. This is the default.
-htmlsplit n
Generate multilple files for each html report, splitting up the files into "n" entities per file. By default, the report is split into 500 entities per file. The "home" file of the directory is index.html.
-l library_name...
Use this option to specify which library or set of libraries within the database are to be reported. Multiple libraries may be specified, separated by a space. No reports are generated if a library name is invalid. If this option is not specified then "Application" is assumed. See Example: Using Libraries to Partition Analysis for information about libraries.
-metrics filename
Export metrics information to a comma delimited file of name "filename"
-help [reports] [format]
Provides on-line guidance for command line syntax. Used as just -help only provides non-report selection guidance. If used as "-help reports" then a list of report generation options is provided. When used as "-help format" provides a list of report format options.
-quiet
Run quietly (don't output message about what report is being generated and so on). This option is useful when using repada in cron jobs or other batch creation situations.
[report options]
repada offers a variety of reports, these options are used to turn reports on or off. See Choosing Reports for details.
By default, all reports are turned on. However, you control what reports are generated either by turning them off individually, or by turning them all off and then on individually. For instance, this line would turn off just the complexity report:
repada -db myproject -html html -rep_complexity offAlternately, if you wished to just see the complexity report you could turn off all others and then choose just the complexity report:
repada -db myproject -html html -rep_complexity onThe usage extensions for choosing reports to repada are shown in the table below.
The following report formatting options are available.
The -separate option (described above) is used to break ASCII output reports into multiple reports. On larger projects this can make for more managable output file sizes. A .pcn file is also created as in index to every program unit, listing it's parameters and file/line declaration.
For instance, if this command is used,
repada -db myproject -separate testthen a variety of files beginning with test and using these extensions would be created:
.cmx - Program Unit Complexity ReportThe following command will generate all reports, create a directory called html and fill it with the HTML versions of each report:
repada -db my_project -html htmlThe resulting file index.html is the home page of the report directory.
This command will generate all reports except for the Program Unit Renames and the Interrupt Cross Reference Report:
repada -db my_project -html html -rep_renames off -rep_interrupt offScientific Toolworks, Inc. http://www.scitools.com Voice: (802) 763-2995 Fax: (802) 763-3066 support@scitools.com sales@scitools.com |