Next: , Previous:   [Contents][Index]

3 General gnatcheck Switches

The following switches control the general gnatcheck behavior

--version

Display Copyright and version, then exit disregarding all other options.

--help

Display usage, then exit disregarding all other options.

-a

Process all units including those with read-only ALI files such as those from the GNAT Run-Time library.

-dx

Activate internal debugging switches. x is a letter or digit, or string of letters or digits, which specifies the type of debugging outputs desired. Normally these are used only for internal development or system debugging purposes. You can find full documentation for these switches in the body of the ASIS_UL.Debug unit in the ASIS Utility Library source file asis_ul-debug.adb.

-dd

Activate a specific debug switch that does not generate any debug output but turns on a progress indicator. This switch also changes the format of the diagnostic messages sent to stderr by adding a string check: between the source location and the text of the diagnosis. This switch is mostly used when gnatcheck is called from GPS.

-h

List all the rules checked by the given gnatcheck version.

-jnnnn

Use nnnn processed to carry out the tree creations (internal representations of the argument sources). On a multiprocessor machine this speeds up processing of big sets of argument sources.

-l

Use full source locations references in the report file. For a construct from a generic instantiation a full source location is a chain from the location of this construct in the generic unit to the place where this unit is instantiated.

-log

Duplicate all the output sent to stderr into a log file. The log file is named gnatcheck.log and is located in the current directory.

-mnnnn

Maximum number of diagnostics to be sent to stdout, where nnnn is in the range 0…1000; the default value is 500. Zero means that there is no limitation on the number of diagnostic messages to be output.

-q

Quiet mode. All the diagnostics about rule violations are placed in the gnatcheck report file only, without duplication on stdout.

-s

Short format of the report file (no version information, no list of applied rules, no list of checked sources is included)

--show-rule

Add the corresponding rule name to the diagnosis generated for its violation.

--include-file=file

Append the content of the specified text file to the report file

-t

Print out execution time.

-v

Verbose mode; gnatcheck generates version information and then a trace of sources being processed.

-o report_file

Set name of report file to report_file .

--write-rules=template_file

Write to template_file the template rule file that contains all the rules currently implemented in gnatcheck turned off. A user may edit this template file manually to get his own coding standard file.


Next: , Previous:   [Contents][Index]