Re: [PATCH v1 1/4] perf tools record: Modernize -W man page
| Newsgroups | org.kernel.vger.linux-perf-users |
|---|---|
| Message-ID | <[email protected]> |
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] The patch introduces a double space in the updated text for the `--weight` option ('weight3 and local_weight'). Additionally, it propagates the pre-existing typo 'weightened' (which should likely be 'weighted') in the same modified block.
--
--- Patch [1]: [PATCH v1 1/4] perf tools record: Modernize -W man page ---
commit 3b23df9a5d2c30f9e6db8d77004cb5c3a03f441d
Author: Andi Kleen <[email protected]>
perf tools record: Modernize -W man page
This commit updates the -W / --weight description in the perf-record man page
to cover newly supported cases and configurations.
> diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
> --- a/tools/perf/Documentation/perf-record.txt
> +++ b/tools/perf/Documentation/perf-record.txt
> @@ -480,9 +480,11 @@ Note that this feature may not be available on all processors.
>
> -W::
> --weight::
> -Enable weightened sampling. An additional weight is recorded per sample and can be
> -displayed with the weight and local_weight sort keys. This currently works for TSX
> -abort events and some memory events in precise mode on modern Intel CPUs.
> +Enable weightened sampling. One or more additional weights can be recorded per sample
> +and can be displayed with the weight, weight2, weight3 and local_weight sort keys.
[Severity: Low]
This isn't a bug, but it looks like a double space was introduced between
weight3 and the word and.
Additionally, this is a pre-existing issue, but the phrase Enable weightened
sampling should likely be Enable weighted sampling. Since this block of text
is being modified, would it make sense to correct the typo here?
> +Possible uses for weights are memory or instruction retirement latencies.
> +Support depends on the PMU and the event, as well as its configuration. Typically
> +it requires use of 'p'.
--
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1