From: Benno Schulenberg <bensberg@telfort.nl>
Date: Mon, 31 Mar 2025 09:44:35 +0000 (+0200)
Subject: uclampset: simplify the synopsis in the --help usage text
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6e94590107d67b1f01586590b49848b820c4a8c2;p=thirdparty%2Futil-linux.git

uclampset: simplify the synopsis in the --help usage text

The synopsis cannot express all possible forms of the command and still
stay readable, so do not even try.  Giving one, single synopsis is far
clearer.  Also, unabbreviate two words in the option descriptions.

Also, improve the markup and the wording in the man page.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---

diff --git a/schedutils/uclampset.1.adoc b/schedutils/uclampset.1.adoc
index 955881907..b3cdb4e7f 100644
--- a/schedutils/uclampset.1.adoc
+++ b/schedutils/uclampset.1.adoc
@@ -38,9 +38,9 @@ manipulate the utilization clamping attributes of the system or a process
 
 == SYNOPSIS
 
-*uclampset* [options] [*-m* _uclamp_min_] [*-M* _uclamp_max] _command argument_
+*uclampset* [options] [*-m* _minimum_] [*-M* _maximum_] *-p* _PID_
 
-*uclampset* [options] [*-m* _uclamp_min_] [*-M* _uclamp_max_] *-p* _PID_
+*uclampset* [options] [*-m* _minimum_] [*-M* _maximum_] _command_ [_argument_...]
 
 == DESCRIPTION
 
diff --git a/schedutils/uclampset.c b/schedutils/uclampset.c
index 4b37557a1..3aa198568 100644
--- a/schedutils/uclampset.c
+++ b/schedutils/uclampset.c
@@ -54,22 +54,22 @@ static void __attribute__((__noreturn__)) usage(void)
 
 	fputs(USAGE_HEADER, out);
 	fprintf(out,
-		_(" %1$s [options]\n"
-		  " %1$s [options] --pid <pid> | --system | <command> <arg>...\n"),
+		_(" %1$s [options] --pid <pid> | <command> [<arg>...] | --system\n"),
 		program_invocation_short_name);
 
 	fputs(USAGE_SEPARATOR, out);
 	fputs(_("Show or change the utilization clamping attributes.\n"), out);
 
 	fputs(USAGE_OPTIONS, out);
-	fputs(_(" -m <value>           util_min value to set\n"), out);
-	fputs(_(" -M <value>           util_max value to set\n"), out);
+	fputs(_(" -m <value>           minimum utilization value to set\n"), out);
+	fputs(_(" -M <value>           maximum utilization value to set\n"), out);
 	fputs(_(" -a, --all-tasks      operate on all the tasks (threads) for a given pid\n"), out);
 	fputs(_(" -p, --pid <pid>      operate on existing given pid\n"), out);
 	fputs(_(" -s, --system         operate on system\n"), out);
 	fputs(_(" -R, --reset-on-fork  set reset-on-fork flag\n"), out);
 	fputs(_(" -v, --verbose        display status information\n"), out);
 
+	fputs(USAGE_SEPARATOR, out);
 	fprintf(out, USAGE_HELP_OPTIONS(22));
 
 	fputs(USAGE_SEPARATOR, out);