Commit cc63f89e authored by Zhang Rui's avatar Zhang Rui Committed by Len Brown
Browse files

tools/power turbostat: Improve --help output 



Improve the `--help` output of turbostat by standardizing the format
and enhancing readability. The following changes are made to ensure
consistency and clarity in the help message:
1. Use a consistent pattern for each parameter's help message:
   - Display the parameter and its input (if any) on the same line,
     separated by a space.
   - Provide the detailed description on a separate line.
2. Ensure that the first character of each description is in lower-case.

These changes make the help output more uniform and easier to read,
helping users quickly understand the available options and their usage.

No functional change.

Signed-off-by: default avatarZhang Rui <rui.zhang@intel.com>
Signed-off-by: default avatarLen Brown <len.brown@intel.com>
parent 48c62ba1

tools/power/x86/turbostat/turbostat.c

+26 −15
Original line number Diff line number Diff line
@@ -2145,32 +2145,41 @@ void help(void) 
		"when COMMAND completes.\n"

		"If no COMMAND is specified, turbostat wakes every 5-seconds\n"

		"to print statistics, until interrupted.\n"

		"  -a, --add	add a counter\n"

		"  -a, --add counter\n"

		"		add a counter\n"

		"		  eg. --add msr0x10,u64,cpu,delta,MY_TSC\n"

		"		  eg. --add perf/cstate_pkg/c2-residency,package,delta,percent,perfPC2\n"

		"		  eg. --add pmt,name=XTAL,type=raw,domain=package0,offset=0,lsb=0,msb=63,guid=0x1a067102\n"

		"  -c, --cpu	cpu-set	limit output to summary plus cpu-set:\n"

		"  -c, --cpu cpu-set\n"

		"		limit output to summary plus cpu-set:\n"

		"		  {core | package | j,k,l..m,n-p }\n"

		"  -d, --debug	displays usec, Time_Of_Day_Seconds and more debugging\n"

		"  -d, --debug\n"

		"		displays usec, Time_Of_Day_Seconds and more debugging\n"

		"		debug messages are printed to stderr\n"

		"  -D, --Dump	displays the raw counter values\n"

		"  -D, --Dump\n"

		"		displays the raw counter values\n"

		"  -e, --enable [all | column]\n"

		"		shows all or the specified disabled column\n"

		"  -H, --hide [column | column,column,...]\n"

		"		hide the specified column(s)\n"

		"  -i, --interval sec.subsec\n"

		"		Override default 5-second measurement interval\n"

		"  -J, --Joules	displays energy in Joules instead of Watts\n"

		"  -l, --list	list column headers only\n"

		"  -M, --no-msr Disable all uses of the MSR driver\n"

		"  -P, --no-perf Disable all uses of the perf API\n"

		"		override default 5-second measurement interval\n"

		"  -J, --Joules\n"

		"		displays energy in Joules instead of Watts\n"

		"  -l, --list\n"

		"		list column headers only\n"

		"  -M, --no-msr\n"

		"		disable all uses of the MSR driver\n"

		"  -P, --no-perf\n"

		"		disable all uses of the perf API\n"

		"  -n, --num_iterations num\n"

		"		number of the measurement iterations\n"

		"  -N, --header_iterations num\n"

		"		print header every num iterations\n"

		"  -o, --out file\n"

		"		create or truncate \"file\" for all output\n"

		"  -q, --quiet	skip decoding system configuration header\n"

		"  -q, --quiet\n"

		"		skip decoding system configuration header\n"

		"  -s, --show [column | column,column,...]\n"

		"		show only the specified column(s)\n"

		"  -S, --Summary\n"
@@ -2178,8 +2187,10 @@ void help(void) 
		"  -T, --TCC temperature\n"

		"		sets the Thermal Control Circuit temperature in\n"

		"		  degrees Celsius\n"

		"  -h, --help	print this help message\n"

		"  -v, --version	print version information\n" "\n" "For more help, run \"man turbostat\"\n");

		"  -h, --help\n"

		"		print this help message\n"

		"  -v, --version\n"

		"		print version information\n" "\n" "For more help, run \"man turbostat\"\n");

}



/*