Util-Linux package development
 help / color / mirror / Atom feed
From: Benno Schulenberg <bensberg@telfort.nl>
To: util-linux@vger.kernel.org
Subject: [PATCH 12/14] man pages: use the same verb for --version as for --help, like in usages
Date: Sun,  9 Feb 2025 09:23:28 +0100	[thread overview]
Message-ID: <20250209082330.4235-12-bensberg@telfort.nl> (raw)
In-Reply-To: <20250209082330.4235-1-bensberg@telfort.nl>

Also, avoid duplication of --help/--version in the man page for `chfn`.

Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
---
 login-utils/chfn.1.adoc      |  6 +++---
 login-utils/chsh.1.adoc      | 10 +++++-----
 man-common/help-version.adoc |  2 +-
 schedutils/coresched.1.adoc  |  6 +-----
 text-utils/col.1.adoc        |  2 +-
 5 files changed, 11 insertions(+), 15 deletions(-)

diff --git a/login-utils/chfn.1.adoc b/login-utils/chfn.1.adoc
index 35a2e82cf..527c6806c 100644
--- a/login-utils/chfn.1.adoc
+++ b/login-utils/chfn.1.adoc
@@ -50,10 +50,10 @@ Specify your home phone number.
 Display help text and exit.
 
 *-V*, *--version*::
-Print version and exit. The short options *-V* have been used since version 2.39; old versions use
-deprecated *-v*.
+Display version and exit. (Short option *-V* is used since version 2.39;
+older versions used the now-deprecated *-v*).
 
-include::man-common/help-version.adoc[]
+// Do not include::man-common/help-version.adoc[]  as --help and --version are already given explicitly above.
 
 == CONFIG FILE ITEMS
 
diff --git a/login-utils/chsh.1.adoc b/login-utils/chsh.1.adoc
index 940ded5aa..e259b593f 100644
--- a/login-utils/chsh.1.adoc
+++ b/login-utils/chsh.1.adoc
@@ -37,14 +37,14 @@ Specify your login shell.
 Print the list of shells listed in _/etc/shells_ and exit.
 
 *-h*, *--help*::
-Display help text and exit. The short options *-h* have been used since version 2.30; old versions use
-deprecated *-u*.
+Display help text and exit. (Short option *-h* is used since version 2.30;
+older versions used the now-deprecated *-u*).
 
 *-V*, *--version*::
-Print version and exit. The short options *-V* have been used since version 2.39; old versions use
-deprecated *-v*.
+Display version and exit. (Short option *-V* is used since version 2.39;
+older versions used the now-deprecated *-v*).
 
-// Do not include::man-common/help-version.adoc[]  as both -h and -V were already explicitly given above in more detail. 
+// Do not include::man-common/help-version.adoc[]  as both -h and -V are already given explicitly above in more detail.
 
 == VALID SHELLS
 
diff --git a/man-common/help-version.adoc b/man-common/help-version.adoc
index 7a3c04fb9..8bce5760f 100644
--- a/man-common/help-version.adoc
+++ b/man-common/help-version.adoc
@@ -2,4 +2,4 @@
 Display help text and exit.
 
 *-V*, *--version*::
-Print version and exit.
+Display version and exit.
diff --git a/schedutils/coresched.1.adoc b/schedutils/coresched.1.adoc
index 8a9c28846..0d4c211f8 100644
--- a/schedutils/coresched.1.adoc
+++ b/schedutils/coresched.1.adoc
@@ -67,11 +67,7 @@ The type of the PID whose cookie will be modified. This can be one of three valu
 *-v*, *--verbose*::
 Show extra information when modifying cookies of tasks.
 
-*-h*, *--help*::
-Display help text and exit.
-
-*-V*, *--version*::
-Print version and exit.
+include::man-common/help-version.adoc[]
 
 == EXAMPLES
 Get the core scheduling cookie of the {command} task itself, usually inherited from its parent{colon}::
diff --git a/text-utils/col.1.adoc b/text-utils/col.1.adoc
index 46610f0c5..bc1913a91 100644
--- a/text-utils/col.1.adoc
+++ b/text-utils/col.1.adoc
@@ -81,7 +81,7 @@ Output multiple spaces instead of tabs.
 Display help text and exit.
 
 *-V*, *--version*::
-Print version and exit.
+Display version and exit.
 
 == CONFORMING TO
 
-- 
2.48.1


  parent reply	other threads:[~2025-02-09  8:26 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-09  8:23 [PATCH 01/14] setpriv: make message for failing PR_GET_PDEATHSIG the same as the other Benno Schulenberg
2025-02-09  8:23 ` [PATCH 02/14] unshare: don't use "=" before a required option argument Benno Schulenberg
2025-02-09  8:23 ` [PATCH 03/14] unshare: use single asterisks around long options, double around values Benno Schulenberg
2025-02-09  8:23 ` [PATCH 04/14] textual: remove other inconsistent uses of "=" before option argument Benno Schulenberg
2025-02-09  8:23 ` [PATCH 05/14] textual: consistently mark "=" as literal before an optional argument Benno Schulenberg
2025-02-09  8:23 ` [PATCH 06/14] mount: properly mark the arguments of the 'ro' and 'rw' extended options Benno Schulenberg
2025-02-09  8:23 ` [PATCH 07/14] unshare: don't mark "|" and ":" as part of the placeholders Benno Schulenberg
2025-02-09  8:23 ` [PATCH 08/14] textual: give seven error messages the same form as two others Benno Schulenberg
2025-02-09  8:23 ` [PATCH 09/14] blkpr: grammarize the description of the tool and its options Benno Schulenberg
2025-02-09  8:23 ` [PATCH 10/14] blkzone: correct the wording of an error message, from ioctl to function Benno Schulenberg
2025-02-10 11:28   ` Karel Zak
2025-02-09  8:23 ` [PATCH 11/14] renice: put text that belongs together into a single translatable message Benno Schulenberg
2025-02-09  8:23 ` Benno Schulenberg [this message]
2025-02-09  8:23 ` [PATCH 13/14] usage: mention also the missing KiB and MiB as permissible suffixes Benno Schulenberg
2025-02-09  8:23 ` [PATCH 14/14] zramctl: improve grammar in usage and don't gettextize list of algorithms Benno Schulenberg
2025-02-12 10:01 ` [PATCH 01/14] setpriv: make message for failing PR_GET_PDEATHSIG the same as the other Karel Zak

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250209082330.4235-12-bensberg@telfort.nl \
    --to=bensberg@telfort.nl \
    --cc=util-linux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox