aa-audit
|
|
|
|
|
Online Documentation Home Page
SYNOPSIS
aa-audit
[-r relation]
[-f file_name_list]
[-l file_name]
[-select_view default | text | stdout]
[-text_file filename]
[-warn_no_flaw]
[-audit_dir directory]
[-alsys] [-alsys_suffix s] [-alsys_family f] [-alsys_library l]
[-objectada_v7]
[-decada] [-A decada_library_name]
[-gnat] [-G gnat_library_directory]
[-greenhills] [-H library_name]
[-greenhills95]
[-tartan] [-L=tartan_library_name]
[-vads] [-suffix s] [-L vads_library_name]
[-help]
DESCRIPTION
Ada-Audit is a system for computing and displaying infor-
mation about Ada code. The information is computed in the
form of relations (a.k.a. tables) that can be displayed in
an HTML browser.
As delivered, one particular relation, the style relation
is built in. The style relation contains all ERRORs, VIO-
LATIONs, and INDICATIONs that are built into Ada-ASSURED.
The style relation is easily extended.
Ada-Audit can be run either interactively or in batch
mode. In either case, an Ada-ASSURED exectuable is
required. Operation of Ada-Audit requires both a batch
and an interactive Ada-ASSURED license. Unless the
-update_only flag is specified, aa-audit will communicate
with a running Ada-ASSURED process and will start a new
editor if none is running. The Ada-ASSURED editor can be
used as the control panel for viewing the results of an
audit. Use the commands in the Ada-ASSURED Tools menu to
control Ada-Audit interactively.
In interactive mode, the relation can be computed for a
single edit buffer, or for all edit buffers of syntactic
category "compilation". In this mode, no persistant record
is kept of the computed relation unless it is explicitely
saved.
In batch mode, the relation can be computed for a list of
files or an entire library in secondary storage. For effi-
ciency, the relation for each Ada file (say foo.a) is
cached in a corresponding style file (say foo.style).
When aa-audit is run on a list of files or a library, the
cached copy of the style relation is used unless the Ada
file is newer. Such access to cached relations for files
and libraries is also available in interactive mode pro-
vided a batch license is current.
Ada-Audit is structured to support the definition and pro-
cessing of arbitrary relations, not just the built-in
style relation. When aa-audit is called in batch mode to
update a given relation (say r), it will dynamically load
the corresponding STk source code definition for that
relation, if necessary (say r.stk). It then updates the
cached .r files, as necessary, by invoking routine
r:update-file.
OPTIONS
-r relation
Perform the audit with respect to the given rela-
tion. The default relation is style, corresponding
to the Software Productivity Consortium's Ada Qual-
ity and Style Guidelines for Professional Program-
mers.
-update_only
Do not view the relation after updating it. The
default is update and then view. When this option
is used, aa-audit creates a new Ada-ASSURED process
in batch mode.
-view-only
Do not update the relation, before viewing. The
default is update and then view.
-f file_name_list
A list of Ada source files to be audited.
-l file_name
The name of a file that contains a list of files
(one per line) to audit. All other arguments are
ignored.
-select_view default|text|stdout
If text, the output is written to the file
aa_audit_out.txt, or to the file given by the
-text_file option. If stdout, the output is writ-
ten to the console.
-text_file filename
If the select_view text option is used, the output
is written to filename.
-warn_no_flaw
If a file shows no flaws, an entry for that file is
entered in the relation.
-audit_dir directory
Cache style files in directory. The default is
AA.FILES in the current directory.
-alsys Use the ALSYS Ada compiler library structure.
-alsys_suffix s
Scan source files that have the suffix s. This is
only valid in conjuction with -alsys. It is
ignored if -alsys_family or -alsys_library are
specified. The default is '{.ada,.ads,.adb}'
-alsys_family f
Scan all source files contained in all libraries in
the family. Only valid in conjuction with -alsys.
-alsys_library l
Scan all source files in library l. The current
working directory is the default. Only valid in
conjuction with -alsys.
-objectada_v7
Use the Aonix ObjectAda 7.x library structure of
the current library.
-decada
Use the DEC Ada library structure.
-A decadalib
Operate in the library named by decadalib. Valid
only in conjunction with -decada. The default is
the value of the environment variable ADALIB.
-gnat Use the GNU Ada compiler (GNAT) library structure.
-G gnat_library_name
Operate in the library named by gnat_library_name.
Valid only in conjunction with -gnat. The default
is the library named by the environment variable
ADA_INCLUDE_PATH.
-greenhills
Use the Green Hills Ada compiler library structure.
-H library_name
library_name is the path name for the Green Hills
library. Valid only in conjunction with -green-
hills. The default is './ada.lib'.
-greenhills95
Use the Green Hills Ada95 compiler library struc-
ture (version 1.8.8).
-tartan
Use the TARTAN Ada library structure.
-L=tartan_library_name
Operate in the library named by tar-
tan_library_name. Only valid in conjuction with
-tartan. The default is the library set by the
setlib command in the file .adalibrc in the current
directory. For details, see the documentation for
the Tartan command adalib1750a.
-vads Use the Vads-compiler library structure. This is
the default.
-suffix s
Scan source files that have the suffix s. This is
only valid in conjuction with -vads. The default
is '.a'
-L vads_library_name
Use vads_library_name instead of the current direc-
tory as the location of the library. This is valid
only in conjunction with -vads.
-help Print a helpful usage message.
SEE ALSO
aa(l), pprint(l),
Ada-ASSURED User Guide & Reference Manual
Part No. AA-RM-3.4, GrammaTech, Inc. 317 N. Aurora St.,
Ithaca, NY 14850.
Tel: +1 607 273 7340
Fax: +1 607 273 8752
Email: admin@grammatech.com
support@grammatech.com
COPYRIGHT
GrammaTech Inc., 317 N. Aurora St., Ithaca, NY 14850.
Ada-ASSURED Release 3.5, July 2004 AA-AUDIT(l)