Command Line Processing

prevnext

Generating Reports with repada


The "repada" Program

Using the command line program "repada", text and/or html reports can be generated from a previously created Understand for Ada project and database. The database (.uda file) may be created by using either Understand for Ada or the "undada" command line program.

The command line syntax for repada is:

repada -db database [options] [report_options] [format_options]

Details for the available options are in the following sections.

General repada Options

The general options specify what type of reports to generate (text or html) and where they should be created. Details of each general option follows:

Option Explanation
-db database Specify the Understand for Ada database to be used to create reports. This is the .uda file created by undada or Understand for Ada.
-help Provides on-line guidance for command line syntax.
-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"
-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.
-separate prefix_filename Used to break each report into a separate ASCII file. The prefix_filename is pre-pended to each generated file. See Report File Naming Conventions. This option may not be used if -html or -o options are used.
-text 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 -separate or -html options.

Report Options

repada offers a variety of reports. These report options are used to turn the generation of specific reports on or off. These options are not applicable when using the single -text report.

If not report options are specified, all reports are turned on and will be generated.. Specifying one or more reports to be "on" will turn off all reports except those explicitly specified to be on. Specifying one or more reports to be "off" will turn on all reports except those explicitly turned off. Each report option is listed below:
Report Option Description
-rep_complexity on|off Turn the Program Unit Complexity report on or off
-rep_dec_not_used on|off
Turn the Unused Objects, Program Units, and Types reports on or off
-rep_dectree on|off
Turn the Declaration Trees report on or off
-rep_dict on|off
Turn the Data Dictionary report on or off
-rep_exception on|off Turn the Exception Cross Refernce report on or off
-rep_generic on|off Turn the Generic Instantiation report on or off
-rep_invtree on|off Turn the Invocation report on or off
-rep_metrics_file on|off Turn the File Metrics report on or off
-rep_metrics_project on|off Turn the Project Metrics report on or off
-rep_metrics_pu on|off Turn the Program Unit Metrics report on or off
-rep_metrics_pu_inclusive on|off Turn the Program Unit Inclusive Metrics report on or off
-rep_object on|off Turn the Object Cross Reference report on or off
-rep_program_unit on|off Turn theProgram Unit Cross Reference report on or off
-rep_renames on|off Turn the Renames report on or off
-rep_simple_invtree on|off Turn the Simple Invocation Tree report on or off
-rep_simple_withtree on|off Turn the Simple With Tree report on or off
-rep_type on|off Turn the Type Cross Reference report on or off
-rep_withtree on|off Turn the With Tree report on or off
-rep_withs_not_needed on|off Turn the Withs Not Needed report on or off

Refer to Text and HTML Reports for more information on the different reports generated.

Report Format Options

The following report formatting options are available.
Format Option explanation
-fmt_fullname Specify use of full entity names in the invocation tree and metrics reports. The default is to use shortnames.
-fmt_profiles Reports fullnames with a "parameter profile" for entities in the invocation tree and metrics reports. The default is "parameter profiles" are not included.
-fmt_xref_detailed Includes additional details in cross reference reports. This additional information includes object types in the objects report and referencing program unit fullnames in all cross reference reports. The default is that this additional information is not provided.

Extensions used by the -separate option

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 test

then a variety of files beginning with test and ending in different extensions would be created. Refer to Report File Naming Conventions for a complete list of all file extensions used.

Example - Creating All Reports in an HTML directory

The 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 html

The resulting file index.html is the home page of the report directory.

Example - Turning Off A Couple Reports

This command will generate all reports except for the Program Unit Renames and the Exception Cross Reference Report:

repada -db my_project -html html -rep_renames off -rep_exception off

This command will generate only the textual Invocation Tree and With Tree reports:

repada -db my_project -separate my_project -rep_invtree on -rep_withtree on

Generating All Text Reports

Generate one text file of the specified name with the option -text. Generate multiple text files with the -prefix option and specify a directory path and a common filename prefix. The file extensions of each text file will denote the separate reports. Refer to Report File Naming Conventions for details on the file extensions used for each report.

All available text reports are always generated when this option is specified.

repada -db sample.uda -reports_text textreports.txt

Example to generate multiple text files in subdirectory text_reports:

repada -db sample.uda -reports_separate text_reports

Generating All HTML Reports

Generate html files with the -reports_html option and specify the directory to place the files. Refer to Report File Naming Conventions for more details on the files generated.

HTML reports may be split into multiple files either alphabetically or by number of entities. Specify "size" to split each report into multiple html files (one file per alpha character) or use -htmlsplit and specify the number of entities desired per html file. Or, use -htmlall to create only one html file per report generated.

All available html reports are always generated when this option is specified.

Examples:

To create one html file per report:

repada -db sample.uda -html_reports size 0 html

To create multiple html files per report, split alphabetically:

repada -db sample.uda -reports_html html

To create multiple html files per report, up to 250 entities per file:

repada -db sample.uda -reports_html 250 html

Generating Metrics Reports

Use the -metric option to create a comma delimited project metrics file which can be used in spreadsheet programs. Refer to Exporting Project Metrics Info for a sample file.

Example:

repada -db sample.uda -metrisc sample-metrics.txt

prevnext


Scientific Toolworks, Inc.
http://www.scitools.com
Voice: (802) 763-2995
Fax: (802) 763-3066
support@scitools.com
sales@scitools.com