Re: [rt-tests v2 05/18] deadline_test: Streamline usage output and man page

[John Kacur <jkacur@redhat.com>]

On Wed, 7 Oct 2020, Daniel Wagner wrote:

> Signed-off-by: Daniel Wagner <dwagner@suse.de>
> ---
>  src/sched_deadline/deadline_test.8 | 37 ++++++++++++-----------
>  src/sched_deadline/deadline_test.c | 47 +++++++++++++++---------------
>  2 files changed, 41 insertions(+), 43 deletions(-)
> 
> diff --git a/src/sched_deadline/deadline_test.8 b/src/sched_deadline/deadline_test.8
> index 5dc99c0bfc63..8f32c5b6feb6 100644
> --- a/src/sched_deadline/deadline_test.8
> +++ b/src/sched_deadline/deadline_test.8
> @@ -19,45 +19,44 @@ deadline_test \- High resolution test program
>  This program is used to test the deadline scheduler (SCHED_DEADLINE tasks)
>  .SH SYNOPSIS
>  .B deadline_test
> -.RI "[ \-hb ] [ \-r prio ] [ \-c cpulist ] [ \-i interval ] [ \-p percent ] [ \-P percent ] [ \-t threads ] [ \-s step[us) ]"
> -
> +.RI "[ \-hb ] [ \-c CPUSET ] [ \-i INTV ] [ \-p PERCENT ] [ \-P PERCENT ] \
> +[ \-r PRIO ]  [ \-s STEP ] [ \-t NUM ]"
>  .SH OPTIONS
>  .TP
> -.B \-h
> -Show this help menu
> -.br
> -.TP
>  .B \-b
>  Bind on the last cpu. (shortcut for -c <lastcpu>)
>  .br
>  .TP
> -.B \-r prio
> -Add an RT task with given prio to stress system
> +.B \-c CPUSET
> +Comma/hyphen separated list of CPUs to run deadline tasks on
>  .br
>  .TP
> -.B \-c cpulist
> -Comma/hyphen separated list of CPUs to run deadline tasks on
> +.B \-h
> +Show this help menu
>  .br
>  .TP
> -.B \-i interval
> +.B \-i INTV
>  The shortest deadline for the tasks
>  .br
>  .TP
> -.B \-p percent
> +.B \-p PERCENT
>  The percent of bandwidth to use (1-90%)
>  .br
>  .TP
> -.B \-P percent
> -The percent of runtime for execution completion
> -              (Default 100%)
> +.B \-P PERCENT
> +The percent of runtime for execution completion (default 100%)
>  .br
>  .TP
> -.B \-t threads
> -The number of threads to run as deadline (default 1)
> +.B \-r PRIO
> +Add an RT task with given prio to stress system
>  .br
>  .TP
> -.B \-s step(us)
> -The amount to increase the deadline for each task (default 500us)
> +.B \-s STEP
> +The amount to increase the deadline for each task in us (default 500us)
> +.br
> +.TP
> +.B \-t NUM
> +The number of threads to run as deadline (default 1)
>  .br
>  .SH AUTHOR
>  Deadline test was written by Steven Rostedt <rostedt@goodmis.org>
> diff --git a/src/sched_deadline/deadline_test.c b/src/sched_deadline/deadline_test.c
> index 4cef2609912e..060ac896aef2 100644
> --- a/src/sched_deadline/deadline_test.c
> +++ b/src/sched_deadline/deadline_test.c
> @@ -46,33 +46,30 @@
>  
>  /**
>   * usage - show the usage of the program and exit.
> - * @argv: The program passed in args
> + * @error: Exit error code to be used
>   *
> - * This is defined here to show people looking at this code how
> + * This is defined here to show peoplde looking at this code how
>   * to use this program as well. 
>   */
> -static void usage(char **argv)
> +static void usage(int error)
>  {
> -	char *arg = argv[0];
> -	char *p = arg+strlen(arg);
> -
> -	while (p >= arg && *p != '/')
> -		p--;
> -	p++;
> -
> -	printf("usage: %s [options]\n"
> -	       " -h - Show this help menu\n"
> -	       " -b - Bind on the last cpu. (shortcut for -c <lastcpu>)\n"
> -	       " -r prio - Add an RT task with given prio to stress system\n"
> -	       " -c cpulist - Comma/hyphen separated list of CPUs to run deadline tasks on\n"
> -	       " -i interval - The shortest deadline for the tasks\n"
> -	       " -p percent - The percent of bandwidth to use (1-90%%)\n"
> -	       " -P percent - The percent of runtime for execution completion\n"
> -	       "              (Default 100%%)\n"
> -	       " -t threads - The number of threads to run as deadline (default 1)\n"
> -	       " -s step(us) - The amount to increase the deadline for each task (default 500us)\n"
> -	       "\n", p);
> -	exit(-1);
> +	printf("deadline_test V %1.2f\n", VERSION);
> +	printf("Usage:\n"
> +	       "deadline_test <options>\n"
> +	       "-b                         Bind on the last cpu. (shortcut for -c <lastcpu>)\n"
> +	       "-c CPUSET                  Comma/hyphen separated list of CPUs to run deadline\n"
> +	       "                           tasks on\n"
> +	       "-h                         Show this help menu\n"
> +	       "-i INTV                    The shortest deadline for the tasks\n"
> +	       "-p PERCENT                 The percent of bandwidth to use (1-90%%)\n"
> +	       "-P PERCENT                 The percent of runtime for execution completion\n"
> +	       "                           (default 100%%)\n"
> +	       "-r PRIO                    Add an RT task with given prio to stress system\n"
> +	       "-s STEP                    The amount to increase the deadline for each task in us\n"
> +	       "                           (default 500us)\n"
> +	       "-t NUM                     The number of threads to run as deadline (default 1)\n"
> +	       );
> +	exit(error);
>  }
>  
>  #define _STR(x) #x
> @@ -1753,8 +1750,10 @@ int main (int argc, char **argv)
>  			rt_task = atoi(optarg);
>  			break;
>  		case 'h':
> +			usage(0);
> +			break;
>  		default:
> -			usage(argv);
> +			usage(1);
>  		}
>  	}
>  
> -- 
> 2.28.0
> 
> 
Signed-off-by: John Kacur <jkacur@redhat.com

Thanks!