Commit 846f6f7a by Sergey Rybin Committed by Arnaud Charlet

gnat_ugn.texi: Update the gnatcheck subsection for metric rules acoording to the latest...

2008-08-22  Sergey Rybin  <rybin@adacore.com>

	* gnat_ugn.texi: Update the gnatcheck subsection for metric rules
	acoording to the latest changes in the metric rule interface

From-SVN: r139427
parent 1a456b49
...@@ -21067,18 +21067,20 @@ This rule has no parameters. ...@@ -21067,18 +21067,20 @@ This rule has no parameters.
@cindex @code{Metrics} rule (for @command{gnatcheck}) @cindex @code{Metrics} rule (for @command{gnatcheck})
@noindent @noindent
This is an umbrella rule for a set of metrics-based checks. Each metric-based There is a set of checks based on computing a metric value and comparing the
check has its own rule name that starts from the common prefix result with the specified upper (or lower, depending on a specific metric)
@code{Metrics_}. For @option{+R} option, this name ends with @code{_GT} value specified for a given metric. A construct is flagged if a given metric
(greater then) or @code{_LT} (less then). The parameter of the rule is applicable (can be computed) for it and the computed value is greater
@option{+R} option specifies bound (upper or lower, depending on the metric) then (lover then) the specified upper (lower) bound.
for the given metric. A construct is flagged if a specified metric can be
computed for it, and the resulting value is higher then the upper bound (or The name of any metric-based rule consists of the prefix @code{Metrics_}
less than the lower bound) specified. Parameters and metric names are not followed by the name of the corresponding metric (see the table below).
case-sensitive @option{-R} option does not have a parameter and it turns OFF For @option{+R} option, each metric-based rule has a numeric parameter
the check for the metric indicated by the metric rule name. specifying the bound (integer or real, depending on a metric), @option{-R}
option for metric rules does not have a parameter.
The following table shows the available metrics-based checks, including the
The following table shows the metric names for that the corresponding
metrics-based checks are supported by gnatcheck, including the
constraint that must be satisfied by the bound that is specified for the check constraint that must be satisfied by the bound that is specified for the check
and what bound - upper (U) or lower (L) - should be specified. and what bound - upper (U) or lower (L) - should be specified.
...@@ -21101,7 +21103,7 @@ the same as for the corresponding metrics in @command{gnatmetric}. ...@@ -21101,7 +21103,7 @@ the same as for the corresponding metrics in @command{gnatmetric}.
@emph{Example:} the rule @emph{Example:} the rule
@smallexample @smallexample
+RMetrics_Cyclomatic_Complexity_GT : 7 +RMetrics_Cyclomatic_Complexity : 7
@end smallexample @end smallexample
@noindent @noindent
means that all bodies with cyclomatic complexity exceeding 7 will be flagged. means that all bodies with cyclomatic complexity exceeding 7 will be flagged.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment