]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
irqtop: improve several more option descriptions, and align them all
authorBenno Schulenberg <bensberg@telfort.nl>
Mon, 31 Mar 2025 09:44:38 +0000 (11:44 +0200)
committerKarel Zak <kzak@redhat.com>
Wed, 2 Apr 2025 11:04:50 +0000 (13:04 +0200)
Keep at least two spaces between option+argument and its description,
while making sure not to go above 80 columns per line.

Also, improve the docstring (there is no need to mention that irqtop
is a utility) and remove the ugly Q from the list of interactive keys.

CC: Joe Jin <joe.jin@oracle.com>
CC: Zhenwei Pi <pizhenwei@bytedance.com>
Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
sys-utils/irqtop.1.adoc
sys-utils/irqtop.c

index 04158a0ef92b333cc60e0c6b3e06da76d2c1b595..cf258d08532daba3601d4e719e20aa0b6686a610 100644 (file)
@@ -8,7 +8,7 @@
 
 == NAME
 
-irqtop - utility to display kernel interrupt information
+irqtop - display kernel interrupt information
 
 == SYNOPSIS
 
@@ -16,7 +16,7 @@ irqtop - utility to display kernel interrupt information
 
 == DESCRIPTION
 
-Display kernel interrupt counter information in *top*(1) style view.
+Display interrupt-counter information from the kernel in the style of *top*(1).
 
 The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using *--output*.
 
index e0abddd821e9399e4d972d7f369ec43e68035568..3dbd030e0b1ebac4ecc8c84a58300d8a3b2ab1de 100644 (file)
@@ -303,28 +303,28 @@ static void __attribute__((__noreturn__)) usage(void)
        printf(_(" %s [options]\n"), program_invocation_short_name);
        fputs(USAGE_SEPARATOR, stdout);
 
-       puts(_("Interactive utility to display kernel interrupt information."));
+       puts(_("Display kernel interrupt information."));
 
        fputs(USAGE_OPTIONS, stdout);
-       fputs(_(" -b, --batch           send tables to stdout, not to a static screen\n"), stdout);
-       fputs(_(" -c, --cpu-stat <mode> show per-cpu stat (auto, enable, disable)\n"), stdout);
-       fputs(_(" -C, --cpu-list <list> specify cpus in list format\n"), stdout);
-       fputs(_(" -d, --delay <secs>    wait this number of seconds between updates\n"), stdout);
-       fputs(_(" -J, --json            use JSON output format (implies --batch)\n"), stdout);
-       fputs(_(" -n, --iter <number>  the maximum number of iterations\n"), stdout);
-       fputs(_(" -o, --output <list>  define which output columns to use\n"), stdout);
-       fputs(_(" -s, --sort <column>  specify sort column\n"), stdout);
-       fputs(_(" -S, --softirq        show softirqs instead of interrupts\n"), stdout);
-       fputs(_(" -t, --threshold <N>  only IRQs with counters above <N>\n"), stdout);
+       fputs(_(" -b, --batch            send tables to stdout, not to a static screen\n"), stdout);
+       fputs(_(" -c, --cpu-stat <mode>  whether to show the per-cpu stats (auto|enable|disable)\n"), stdout);
+       fputs(_(" -C, --cpu-list <list>  show IRQs only for the specified cpus\n"), stdout);
+       fputs(_(" -d, --delay <secs>     wait this number of seconds between updates\n"), stdout);
+       fputs(_(" -J, --json             use JSON output format (implies --batch)\n"), stdout);
+       fputs(_(" -n, --iter <number>    the maximum number of iterations\n"), stdout);
+       fputs(_(" -o, --output <list>    which columns to show, and in which order\n"), stdout);
+       fputs(_(" -s, --sort <column>    sort the table on this column\n"), stdout);
+       fputs(_(" -S, --softirq          show softirqs instead of interrupts\n"), stdout);
+       fputs(_(" -t, --threshold <num>  show only IRQs with counters above this number\n"), stdout);
        fputs(USAGE_SEPARATOR, stdout);
-       fprintf(stdout, USAGE_HELP_OPTIONS(22));
+       fprintf(stdout, USAGE_HELP_OPTIONS(24));
 
        fputs(_("\nThe following interactive key commands are valid:\n"), stdout);
        fputs(_("  i      sort by IRQ\n"), stdout);
        fputs(_("  t      sort by TOTAL\n"), stdout);
        fputs(_("  d      sort by DELTA\n"), stdout);
        fputs(_("  n      sort by NAME\n"), stdout);
-       fputs(_("  q Q    quit program\n"), stdout);
+       fputs(_("  q      quit program\n"), stdout);
 
        fputs(USAGE_COLUMNS, stdout);
        irq_print_columns(stdout, 0);