GNATcheck Reference Manual: General gnatcheck Switches

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [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.

``-P file'`
  Indicates the name of the project file that describes the set of sources to be processed. The exact set of argument sources depends on other options specified, see below.

``-U'`
  If a project file is specified and no argument source is explicitly specified (either directly or by means of ``-files'` option), process all the units of the closure of the argument project. Otherwise this option has no effect.

``-U main_unit'`
  If a project file is specified and no argument source is explicitly specified (either directly or by means of ``-files'` option), process the closure of units rooted at main_unit. Otherwise this option has no effect.

``-Xname=value'`
  Indicates that external variable name in the argument project has the value value. Has no effect if no project is specified as tool argument.

``--subdirs=dir'`
  Use the specified subdirectory of the project objects file (or of the project file directory if the project does not specify an object directory) for tool output files. Has no effect if no project is specified as tool argument or if ``--no_objects_dir'` is specified.

``--no_objects_dir'`
  Place all the result files into the current directory instead of project objects directory. This corresponds to the `gnatcheck` behavior when it is called with the project file from the GNAT driver. Has no effect if no project is specified.

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

``-h'`
  List all the rules checked by the given `gnatcheck` version.

``-jnnnn'`

  Use nnnn processes 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. If n is 0, then the maximum number of parallel tree creations is the number of core processors on the platform.

``-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'`. If a project file is specified as `gnatcheck` parameter then it is located in the project objects directory (or in the project file directory if no object directory is specified). Otherwise it 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.

If a project file is specified and no argument source is explicitly specified (either directly or by means of ``-files'` option), and no ``-U'` is specified, then the set of processed sources is all the immediate units of the argument project.

[ << ] | [ >> ] |  |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

This document was generated by GNAT Mailserver on April, 10 2014 using texi2html