From c149a173898f62714e6afb845a9fff004e921e17 Mon Sep 17 00:00:00 2001
From: Nicholas Nethercote <njn@valgrind.org>
Date: Sun, 9 Aug 2009 23:27:00 +0000
Subject: [PATCH] Make usage messages given by -h and man pages consistent for
 the scripts.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10756
---
 cachegrind/cg_annotate.in                     | 2 +-
 cachegrind/docs/cg_annotate-manpage.xml       | 3 ++-
 callgrind/callgrind_annotate.in               | 2 +-
 callgrind/callgrind_control.in                | 2 +-
 callgrind/docs/callgrind_annotate-manpage.xml | 4 +++-
 callgrind/docs/callgrind_control-manpage.xml  | 2 +-
 massif/docs/ms_print-manpage.xml              | 3 ++-
 massif/ms_print.in                            | 2 +-
 8 files changed, 12 insertions(+), 8 deletions(-)

diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in
index 83f348310c..29d94264eb 100644
--- a/cachegrind/cg_annotate.in
+++ b/cachegrind/cg_annotate.in
@@ -142,7 +142,7 @@ my $version = "@VERSION@";
 
 # Usage message.
 my $usage = <<END
-usage: cg_annotate [options] output-file [source-files]
+usage: cg_annotate [options] cachegrind-out-file [source-files...]
 
   options for the user, with defaults in [ ], are:
     -h --help             show this message
diff --git a/cachegrind/docs/cg_annotate-manpage.xml b/cachegrind/docs/cg_annotate-manpage.xml
index a8178897c4..095207182f 100644
--- a/cachegrind/docs/cg_annotate-manpage.xml
+++ b/cachegrind/docs/cg_annotate-manpage.xml
@@ -21,7 +21,8 @@
 <cmdsynopsis>
   <command>cg_annotate</command>
   <arg><replaceable>options</replaceable></arg>
-  <arg>filename</arg>
+  <arg choice="plain"><replaceable>cachegrind-out-file</replaceable></arg>
+  <arg choice="opt" rep="repeat"><replaceable>source-files</replaceable></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
diff --git a/callgrind/callgrind_annotate.in b/callgrind/callgrind_annotate.in
index 60ecde0bab..5f7393dcd8 100644
--- a/callgrind/callgrind_annotate.in
+++ b/callgrind/callgrind_annotate.in
@@ -196,7 +196,7 @@ my $version = "@VERSION@";
 
 # Usage message.
 my $usage = <<END
-usage: callgrind_annotate [options] [data-file [source-files]]
+usage: callgrind_annotate [options] [callgrind-out-file [source-files...]]
 
   options for the user, with defaults in [ ], are:
     -h --help             show this message
diff --git a/callgrind/callgrind_control.in b/callgrind/callgrind_control.in
index 74df0317c0..7cb7b3501c 100644
--- a/callgrind/callgrind_control.in
+++ b/callgrind/callgrind_control.in
@@ -84,7 +84,7 @@ sub shortHelp {
 sub printHelp {
   printHeader;
 
-  print "Usage: callgrind_control [options] [<pid>|<name> ...]\n\n";
+  print "Usage: callgrind_control [options] [pid|program-name...]\n\n";
   print "If no pids/names are given, an action is applied to all currently\n";
   print "active Callgrind runs. Default action is printing short information.\n\n";
   print "Options:\n";
diff --git a/callgrind/docs/callgrind_annotate-manpage.xml b/callgrind/docs/callgrind_annotate-manpage.xml
index a1d8aa8dec..2d0482b1ab 100644
--- a/callgrind/docs/callgrind_annotate-manpage.xml
+++ b/callgrind/docs/callgrind_annotate-manpage.xml
@@ -21,7 +21,9 @@
   <cmdsynopsis>
     <command>callgrind_annotate</command>    
     <arg choice="opt"><replaceable>options</replaceable></arg>
-    <arg choice="opt"><replaceable>source-files</replaceable></arg>
+    <!-- note the deliberate <arg> nesting here -->
+    <arg choice="opt"><replaceable>callgrind-out-file</replaceable>
+    <arg choice="opt" rep="repeat"><replaceable>source-files</replaceable></arg></arg>
   </cmdsynopsis>
 </refsynopsisdiv>
 
diff --git a/callgrind/docs/callgrind_control-manpage.xml b/callgrind/docs/callgrind_control-manpage.xml
index dd71af0afb..952a1c0c13 100644
--- a/callgrind/docs/callgrind_control-manpage.xml
+++ b/callgrind/docs/callgrind_control-manpage.xml
@@ -20,7 +20,7 @@
   <cmdsynopsis>
     <command>callgrind_control</command>    
     <arg choice="opt"><replaceable>options</replaceable></arg>
-    <arg choice="opt" rep="repeat"><replaceable>pid/program-name</replaceable></arg>
+    <arg choice="opt" rep="repeat"><replaceable>pid|program-name</replaceable></arg>
   </cmdsynopsis>
 </refsynopsisdiv>
 
diff --git a/massif/docs/ms_print-manpage.xml b/massif/docs/ms_print-manpage.xml
index 835d49bcfb..cd1f4a061c 100644
--- a/massif/docs/ms_print-manpage.xml
+++ b/massif/docs/ms_print-manpage.xml
@@ -10,6 +10,7 @@
   <refentrytitle>ms_print</refentrytitle>
   <manvolnum>1</manvolnum>
   <refmiscinfo>Release &rel-version;</refmiscinfo>
+  <date>rel-date</date>
 </refmeta>
 
 <refnamediv>
@@ -21,7 +22,7 @@
 <cmdsynopsis>
   <command>ms_print</command>
   <arg><replaceable>options</replaceable></arg>
-  <arg>filename</arg>
+  <arg choice="plain"><replaceable>massif-out-file</replaceable></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
diff --git a/massif/ms_print.in b/massif/ms_print.in
index 2b2a412395..e6ffdbff8d 100755
--- a/massif/ms_print.in
+++ b/massif/ms_print.in
@@ -62,7 +62,7 @@ my $ms_print_args;
 
 # Usage message.
 my $usage = <<END
-usage: ms_print [options] <file>
+usage: ms_print [options] massif-out-file
 
   options for the user, with defaults in [ ], are:
     -h --help             show this message
-- 
2.47.2