gbranden pushed a commit to branch master
in repository groff.
commit 88300e4f5bd8e5673dc2584ac0d907baea1e2a03
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Aug 2 03:40:20 2025 -0500
[gdiffmk]: Sync Usage() description with man page.
* gdiffmk.sh (Usage): Update description, (roughly) syncing it with man
page.
Why "roughly"? We tend to use the declarative mood in the opening
sentence of our man pages' "Description" sections, and the imperative
mood in the usage messages of our commands.
---
contrib/gdiffmk/ChangeLog | 5 +++++
contrib/gdiffmk/gdiffmk.1.man | 7 +++++--
contrib/gdiffmk/gdiffmk.sh | 8 ++++----
3 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/contrib/gdiffmk/ChangeLog b/contrib/gdiffmk/ChangeLog
index 982143ac2..2bd221468 100644
--- a/contrib/gdiffmk/ChangeLog
+++ b/contrib/gdiffmk/ChangeLog
@@ -1,3 +1,8 @@
+2025-08-01 G. Branden Robinson <[email protected]>
+
+ * gdiffmk.sh (Usage): Update description, (roughly) syncing it
+ with man page.
+
2024-12-22 G. Branden Robinson <[email protected]>
Track revisions to groff Autotools usage, prompted by the fact
diff --git a/contrib/gdiffmk/gdiffmk.1.man b/contrib/gdiffmk/gdiffmk.1.man
index 6f300212b..27e28b81d 100644
--- a/contrib/gdiffmk/gdiffmk.1.man
+++ b/contrib/gdiffmk/gdiffmk.1.man
@@ -96,11 +96,14 @@ documents,
.I file1
and
.IR file2 ,
-and writes another
+and writes another,
+derived from both,
to the standard output stream
(or
.IR output-file ),
-adding margin characters to mark places in the output
+adding margin character
+.RB ( mc )
+requests at places in the output
where the input documents differ.
.
.I gdiffmk
diff --git a/contrib/gdiffmk/gdiffmk.sh b/contrib/gdiffmk/gdiffmk.sh
index e61359aaf..35f0d20a1 100644
--- a/contrib/gdiffmk/gdiffmk.sh
+++ b/contrib/gdiffmk/gdiffmk.sh
@@ -49,10 +49,10 @@ EOF
then
cat >&2 <<EOF
-Compare roff(7) documents file1 and file2, and write a roff document
-to the standard output stream (or output-file) consisting of file2 with
-added margin character ('mc') requests indicating output lines that
-differ from file1. See the gdiffmk(1) manual page.
+Compare roff(7) documents file1 and file2, and write another, derived
+from both, to the standard output stream (or output-file), adding margin
+character ('mc') requests at places in the output where the input
+documents differ.
EOF
fi
exit $status
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
