Revise usage messages to better fit GNU conventions

5 years ago · ea9642561c
4 changed files with 13 additions and 5 deletions
--- a/8
+++ b/8
@ -1,3 +1,11 @@
+2021-04-01  Jacob Bachmeyer  <jcb@gnu.org>
+
+	PR47533
+
+	* dejagnu, commands/help.sh, commands/report-card.awk: Revise help
+	message to better fit GNU conventions, with thanks to Tom Tromey
+	for the reporting this issue.
+
 2021-03-30  Jacob Bachmeyer  <jcb@gnu.org>

 	* configure: Regenerate.
--- a/commands/help.sh
+++ b/commands/help.sh
@ -20,7 +20,7 @@
 # Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.

 # ##help
-# #Usage: dejagnu help [options...] <command>
+# #Usage: dejagnu help [ OPTIONS... ] COMMAND
 # #	--verbose, -v		Emit additional messages
 # #	--path, -w		Passed to man(1)
 # #	-W			Passed to man(1)
--- a/commands/report-card.awk
+++ b/commands/report-card.awk
@ -1,5 +1,5 @@
 # report-card.awk -- Test summary tool
-# Copyright (C) 2018 Free Software Foundation, Inc.
+# Copyright (C) 2018, 2021 Free Software Foundation, Inc.
 #
 # This file is part of DejaGnu.
 #
@ -20,8 +20,8 @@
 # This file was written by Jacob Bachmeyer.

 # ##help
-# #Usage: dejagnu report card [<option>|<tool>|<file>]...
-# #Usage: dejagnu report-card [<option>|<tool>|<file>]...
+# #Usage: dejagnu report card [ OPTION | TOOL | FILE ]...
+# #Usage: dejagnu report-card [ OPTION | TOOL | FILE ]...
 # #	--verbose, -v		Emit additional messages
 # ##end

--- a/2
+++ b/2
@ -45,7 +45,7 @@
 # variables.  In this script, the intended meaning is obvious in context.

 # ##help
-# #Usage: dejagnu <command> [--help|options...]
+# #Usage: dejagnu COMMAND [ --help | OPTIONS... ]
 # #Usage: dejagnu --help
 # #Usage: dejagnu --version
 # #	--help			Print help text