Re: [PATCH 04/10] irqtop: improve the description of --batch, and align it with others

[Joe Jin <joe.jin@oracle.com>]

Change looks good to me.
Reviewed-by: Joe Jin <joe.jin@oracle.com>

Thanks,
Joe

On 3/31/25 02:44, Benno Schulenberg wrote:
> Also improve the description of --delay and tweak the one of --json,
> and align both descriptions with the preceding ones.
>
> CC: Joe Jin <joe.jin@oracle.com>
> Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
> ---
>  sys-utils/irqtop.1.adoc | 7 ++++---
>  sys-utils/irqtop.c      | 6 +++---
>  2 files changed, 7 insertions(+), 6 deletions(-)
>
> diff --git a/sys-utils/irqtop.1.adoc b/sys-utils/irqtop.1.adoc
> index 880ee1906..04158a0ef 100644
> --- a/sys-utils/irqtop.1.adoc
> +++ b/sys-utils/irqtop.1.adoc
> @@ -26,7 +26,8 @@ The default output is subject to change. So whenever possible, you should avoid
>  Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
>  
>  *-b*, *--batch*::
> -Starts irqtop in batch mode, which could be useful for sending output to other programs or to a file.
> +Send the produced tables to stdout instead of to a static screen.
> +This can be used for sending the output to other programs or to a file.
>  
>  *-c*, *--cpu-stat* _mode_::
>  Show per-cpu statistics by specified mode. Available modes are: *auto*, *enable*, *disable*. The default option *auto* detects the width of window, then shows the per-cpu statistics if the width of window is large enough to show a full line of statistics.
> @@ -35,10 +36,10 @@ Show per-cpu statistics by specified mode. Available modes are: *auto*, *enable*
>  Specify cpus in list format to show.
>  
>  *-d*, *--delay* _seconds_::
> -Update interrupt output every _seconds_ intervals.
> +Update the tables every this number of seconds.
>  
>  *-J*, *--json*::
> -Use JSON output format. irqtop will run in batch mode.
> +Use JSON output format. Implies *--batch*.
>  
>  *-n*, *--iter* _number_::
>  Specifies the maximum iterations before quitting.
> diff --git a/sys-utils/irqtop.c b/sys-utils/irqtop.c
> index 751e9e19b..e0abddd82 100644
> --- a/sys-utils/irqtop.c
> +++ b/sys-utils/irqtop.c
> @@ -306,11 +306,11 @@ static void __attribute__((__noreturn__)) usage(void)
>  	puts(_("Interactive utility to display kernel interrupt information."));
>  
>  	fputs(USAGE_OPTIONS, stdout);
> -	fputs(_(" -b, --batch batch mode\n"), 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>   delay updates\n"), stdout);
> -	fputs(_(" -J, --json  use JSON output format (will run in batch mode)\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);