Re: [PATCH v1 2/2] perf stat: Document --metric-no-threshold and threshold colors

[Liang, Kan]

On 2023-05-04 3:58 p.m., Ian Rogers wrote:
> Document the threshold behavior for -M/--metrics.
> 
> Signed-off-by: Ian Rogers <irogers@xxxxxxxxxx>
> ---
>  tools/perf/Documentation/perf-stat.txt | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
> index 29bdcfa93f04..ff71399db738 100644
> --- a/tools/perf/Documentation/perf-stat.txt
> +++ b/tools/perf/Documentation/perf-stat.txt
> @@ -353,6 +353,15 @@ small group that need not have multiplexing is lowered. This option
>  forbids the event merging logic from sharing events between groups and
>  may be used to increase accuracy in this case.
>  
> +--metric-no-threshold::
> +Metric thresholds may increase the number of events necessary to
> +compute whether a metric has exceeded its threshold expression. This
> +may not be desirable, for example, as the events can introduce
> +multiplexing. This option disables the adding of threshold expression
> +events for a metric. However, if there are sufficient events to
> +compute the threshold then the threshold is still computed and used to
> +color the metric's computed value.
> +
>  --quiet::
>  Don't print output, warnings or messages. This is useful with perf stat
>  record below to only write data to the perf.data file.
> @@ -389,6 +398,12 @@ For a group all metrics from the group are added.
>  The events from the metrics are automatically measured.
>  See perf list output for the possible metrics and metricgroups.
>  
> +	When threshold information is available for a metric, the
> +	color red is used to signify a metric has exceeded a threshold
> +	while green shows it is hasn't. The default color means that

A typo. "it is hasn't" -> "it hasn't"

Rest looks good to me.

Reviewed-by: Kan Liang <kan.liang@xxxxxxxxxxxxxxx>

Thanks,
Kan

> +	no threshold information was available or the threshold
> +	couldn't be computed.
> +
>  -A::
>  --no-aggr::
>  Do not aggregate counts across all monitored CPUs.