[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The gnatcheck
tool in GNAT can be used to
enforce coding conventions by analyzing Ada source programs with respect to
a set of rules supplied at tool invocation.
This manual describes the complete set of predefined rules that
gnatcheck
can take as input.
What This Manual Contains What You Should Know Before Reading This Manual
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This manual contains a description of gnatcheck
, an ASIS-based
utility that checks properties of Ada source files according to a given
set of semantic rules
1. Introduction, gives the general overview of the gnatcheck
tool
2. Format of the Report File, describes the structure of the report file
generated by gnatcheck
3. General gnatcheck
Switches, describes switches control the general
gnatcheck
behavior
4. gnatcheck
Rule Options, describes options used to control a set of
rules to be checked by gnatcheck
5. Adding the Results of Compiler Checks to gnatcheck
Output, explains how
the results of the check performed by the GNAT compiler can be added to the
report generated by gnatcheck
6. Rule exemption, explains how to turn off a rule check for a specified fragment of a source file
7. Predefined Rules, contains a description of each predefined
gnatcheck
rule, organized into categories.
8. Example of gnatcheck
Usage, contains a full example of
gnatcheck
usage
A. List of Rules, gives an alphabetized list of all predefined rules, for ease of reference.
The name of each rule (the "rule identifier") denotes the condition that is
detected and flagged by gnatcheck
.
The rule identifier is used as a parameter of the `+R' or `-R'
switch to gnatcheck
.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
You should be familiar with the Ada language and with the usage of GNAT in general; please refer to the GNAT User's Guide.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |