From 2f49025d49bab1c2a7da1097bd47a03eaa706071 Mon Sep 17 00:00:00 2001 From: Jan Polensky Date: Wed, 24 Sep 2025 18:34:48 +0200 Subject: [PATCH] cpumf/man: Unify parameter case MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Normalize parameter casing in man pages to improve consistency. Reviewed-by: Thomas Richter Reviewed-by: Jan Höppner Signed-off-by: Jan Polensky Signed-off-by: Jan Höppner --- cpumf/man/chcpumf.8 | 8 ++++---- cpumf/man/lshwc.8 | 20 ++++++++++---------- cpumf/man/lspai.8 | 2 +- cpumf/man/pai.8 | 22 +++++++++++----------- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/cpumf/man/chcpumf.8 b/cpumf/man/chcpumf.8 index f8a8a895..3c6d575d 100644 --- a/cpumf/man/chcpumf.8 +++ b/cpumf/man/chcpumf.8 @@ -17,9 +17,9 @@ chcpumf \- manage the CPU-measurement facilities support .SH SYNOPSIS .B chcpumf .RB [ \-m | \-\-min -.IR num_sdb ] +.IR NUM_SDB ] .RB [ \-x | \-\-max -.IR num_sdb ] +.IR NUM_SDB ] .RB [ \-V | \-\-verbose ] .br .B chcpumf @@ -36,14 +36,14 @@ facilities for Linux on System z. . .SH OPTIONS .TP -.BR \-m ", " \-\-min " \fInum_sdb\fP" +.BR \-m ", " \-\-min " \fINUM_SDB\fP" Specifies the minimum sampling facility buffer size in sample-data-blocks (SDB). A sample-data-block consumes about 4 kilobytes. This is the initial buffer size when you start the sampling facility. . .TP -.BR \-x ", " \-\-max " \fInum_sdb\fP" +.BR \-x ", " \-\-max " \fINUM_SDB\fP" Specifies the maximum sampling facility buffer size in sample-data-blocks (SDB). A sample-data-block consumes about 4 kilobytes. diff --git a/cpumf/man/lshwc.8 b/cpumf/man/lshwc.8 index 969db71a..6349d272 100644 --- a/cpumf/man/lshwc.8 +++ b/cpumf/man/lshwc.8 @@ -16,16 +16,16 @@ lshwc \- extract CPU Measurement Facilities counter sets \*c .RB [ \-a ][ \-d ][ \-H ][ \-s ][ \-x ][ \-X ][ \-q ] .RB [ \-l -.IR count ] +.IR COUNT ] .RB [ \-i -.IR interval ] +.IR INTERVAL ] .RB [ \-t -.IR time ] +.IR TIME ] .RB [ \-f -.IR format ] +.IR FORMAT ] .RB [ \-c -.IR list ] -\fR[\fIcpulist\fR][:\fIsets\fR]\fP +.IR LIST ] +\fR[\fICPULIST\fR][:\fISETS\fR]\fP .br \*c .BR \-h | \-\-help @@ -64,13 +64,13 @@ Without this flag the total value of each counter is displayed. See Examples. . .TP -.BR \-i ", " \-\-interval \fI\ seconds\fP +.BR \-i ", " \-\-interval \fI\ SECONDS\fP Specifies a time interval, in seconds, that the command waits between read operations. The default is 60 seconds. . .TP -.BR \-l ", " \-\-loop \fI\ count\fP +.BR \-l ", " \-\-loop \fI\ COUNT\fP Performs the specified number of read operations. . .TP @@ -136,7 +136,7 @@ Displays counter values as hexadecimal values with a leading 0x prefix. Apply quoting to every output element, regardless of content or format. . .TP -.BR \-f ", " \-\-format \fI\ format\fP +.BR \-f ", " \-\-format \fI\ FORMAT\fP Retrieve output in one of the following formats: JSON, CSV, JSON-SEQ or PAIRS. If no format is specified, the output defaults to CSV. @@ -180,7 +180,7 @@ Specify a comma-separated list of counter names to be printed. If a counter name does not match any valid counter name, it is omitted. (Implies -H) . .TP -\fR[\fIcpulist\fR][:\fIsets\fR]\fP +\fR[\fICPULIST\fR][:\fISETS\fR]\fP A comma-separated list of CPUs. Each CPU can optionally be followed by characters that specify the counter set. See below for details. diff --git a/cpumf/man/lspai.8 b/cpumf/man/lspai.8 index 79898d71..d636520a 100644 --- a/cpumf/man/lspai.8 +++ b/cpumf/man/lspai.8 @@ -18,7 +18,7 @@ .IR FORMAT ] .RB [ \-n ] .RB [ \-t -.IR "\ TYPE" ] +.IR TYPE ] .br \*c .RB [ \-\-format diff --git a/cpumf/man/pai.8 b/cpumf/man/pai.8 index 3eb20d26..db7a9c72 100644 --- a/cpumf/man/pai.8 +++ b/cpumf/man/pai.8 @@ -15,24 +15,24 @@ pai \- record and report Processor Activity Instrumentation (PAI) counters .SH SYNOPSIS \*c .RB [ \-V ][ \-m | \-\-mapsize -.IR size ] +.IR SIZE ] .RB [ \-i | \-\-interval -.IR ms ] +.IR MS ] .RB [ \-R | \-\-realtime -.IR prio ] -.BR \-c | \-\-crypto [ \fIcpulist ][: \fIdata\fR "] [" \fIloops\fP ] +.IR PRIO ] +.BR \-c | \-\-crypto [ \fICPULIST ][: \fIDATA\fR "] [" \fILOOPS\fP ] .br \*c .RB [ \-V ][ \-m | \-\-mapsize -.IR size ] +.IR SIZE ] .RB [ \-i | \-\-interval -.IR ms ] +.IR MS ] .RB [ \-R | \-\-realtime -.IR prio ] -.BR \-n | \-\-nnpa [ \fIcpulist ][: \fIdata\fR "] [" \fIloops\fP ] +.IR PRIO ] +.BR \-n | \-\-nnpa [ \fICPULIST ][: \fIDATA\fR "] [" \fILOOPS\fP ] .br \*c -.RB [ \-V ][ \-H | \-\-humantime ][ \-S | \-\-summary "] " \-r | \-\-report " [" \fIfiles\fP ] +.RB [ \-V ][ \-H | \-\-humantime ][ \-S | \-\-summary "] " \-r | \-\-report " [" \fIFILES\fP ] .br \*c .BR \-h | \-\-help @@ -73,7 +73,7 @@ Reporting evaluates files that are created by recording. .SH OPTIONS .TP -.BR \-c ", " \-\-crypto "\fR[\fIcpulist\fR][:\fIdata\fR]" +.BR \-c ", " \-\-crypto "\fR[\fICPULIST\fR][:\fIDATA\fR]" Records data for all (default) or a specified list of CPUs. The CPU list is a comma-separated list of CPU numbers and ranges. In a range, a hyphen separates the first CPU number @@ -106,7 +106,7 @@ execution. .RE . .TP -.BR \-n ", " \-\-nnpa "\fR[\fIcpulist\fR][:\fIdata\fR]" +.BR \-n ", " \-\-nnpa "\fR[\fICPULIST\fR][:\fIDATA\fR]" Records data for all (default) or a specified list of CPUs. The CPU list is a comma-separated list of CPU numbers and ranges. In a range, a hyphen separates the first CPU number