From: David Mitchell <davem@iabyn.com>
Date: Sat, 3 Jan 2009 13:38:16 +0000 (+0000)
Subject: Add some basic decriptions and/or usage info to some Porting/ scripts
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=0c429c7857dc17d863b0f599b99cd7e16e6d865f;p=p5sagit%2Fp5-mst-13.2.git

Add some basic decriptions and/or usage info to some Porting/ scripts
---

diff --git a/Porting/cmpVERSION.pl b/Porting/cmpVERSION.pl
index 2855acf..8c23649 100644
--- a/Porting/cmpVERSION.pl
+++ b/Porting/cmpVERSION.pl
@@ -14,6 +14,8 @@ use File::Compare;
 use File::Find;
 use File::Spec::Functions qw(rel2abs abs2rel catfile catdir curdir);
 
+@ARGV == 2 or die "usage: $0 source_dir1 source_dir2\n";
+
 for (@ARGV[0, 1]) {
     die "$0: '$_' does not look like Perl directory\n"
 	unless -f catfile($_, "perl.h") && -d catdir($_, "Porting");
diff --git a/Porting/makemeta b/Porting/makemeta
index 6d5b0ab..2ebaf07 100644
--- a/Porting/makemeta
+++ b/Porting/makemeta
@@ -1,5 +1,8 @@
 #!./perl -w
 # this script must be run by the current perl to get perl's version right
+#
+# Create a META.yml file in the current directory. Muyst be run from the
+# root directory of a perl source tree.
 
 use strict;
 use warnings;
diff --git a/Porting/switch_to_perforce_id.pl b/Porting/switch_to_perforce_id.pl
index cfd68e3..fb3611d 100755
--- a/Porting/switch_to_perforce_id.pl
+++ b/Porting/switch_to_perforce_id.pl
@@ -1,4 +1,8 @@
 #!perl
+#
+# given a perforce change number, checkout the equivalent git commit
+# into the git working directory
+#
 use strict;
 use warnings;
 use English;
diff --git a/Porting/testall.atom b/Porting/testall.atom
index a709cfd..8796f08 100644
--- a/Porting/testall.atom
+++ b/Porting/testall.atom
@@ -1,7 +1,7 @@
 #!/bin/sh
 
 #
-# testall.atom
+# testall.atom - test suite profiling on Tru 64
 # 
 # This script creates all.Counts file that can be fed to prof(1)
 # to produce various basic block counting profiles.
diff --git a/Porting/thirdclean b/Porting/thirdclean
index 86103f7..8f1d3f8 100644
--- a/Porting/thirdclean
+++ b/Porting/thirdclean
@@ -1,3 +1,12 @@
+#!./perl
+
+# DAPM: this description is from the original commit message:
+# this appears to be a HP leak detection thing:
+#
+#    Add a script for cleaning out the "known noise"
+#    from Third Degree reports: either noise caused
+#    by libc itself, or Perl_yyparse leaks.
+
 local $/;
 $_ = <ARGV>;