[svn:parrot] r42770 - in trunk/tools: dev util

[jkeenan at svn.parrot.org]

Author: jkeenan
Date: Sat Nov 21 20:00:08 2009
New Revision: 42770
URL: https://trac.parrot.org/parrot/changeset/42770

Log:
Add DESCRIPTION section to Pod (or correct things keeping file from passing codingstd test).

Modified:
   trunk/tools/dev/pprof2cg.pl
   trunk/tools/dev/search-ops.pl
   trunk/tools/util/ncidef2pasm.pl
   trunk/tools/util/update_copyright.pl

Modified: trunk/tools/dev/pprof2cg.pl
==============================================================================
--- trunk/tools/dev/pprof2cg.pl	Sat Nov 21 19:53:17 2009	(r42769)
+++ trunk/tools/dev/pprof2cg.pl	Sat Nov 21 20:00:08 2009	(r42770)
@@ -6,22 +6,20 @@
 use strict;
 use warnings;
 
-# use Data::Dumper;
-
-=head1 Name
+=head1 NAME
 
 tools/dev/pprof2cg.pl
 
-=head1 Description
+=head1 DESCRIPTION
 
 Convert the output of Parrot's profiling runcore to a Callgrind-compatible
 format.
 
-=head1 Synopsis
+=head1 SYNOPSIS
 
 perl tools/dev/pprof2cg.pl parrot.pprof.1234
 
-=head1 Usage
+=head1 USAGE
 
 Generate a profile by passing C<-Rprofiling> to parrot, for example C<./parrot
 -Rprofiling perl6.pbc hello.p6>.  Once execution completes, C<parrot> will
@@ -34,7 +32,7 @@
 filename as the first argument.  The output file usable by kcachegrind will be
 in parrot.out.XXXX, where XXXX again is the PID of the original parrot process.
 
-=head1 Environment Variables
+=head1 ENVIRONMENT VARIABLES
 
 =head2 PARROT_PROFILING_OUTPUT
 
@@ -47,7 +45,7 @@
 
 main(\@ARGV);
 
-=head1 Internal Data Structures
+=head1 INTERNAL DATA STRUCTURES
 
 =over 4
 
@@ -106,7 +104,7 @@
 
 =back
 
-=head1 Functions
+=head1 FUNCTIONS
 
 =over 4
 

Modified: trunk/tools/dev/search-ops.pl
==============================================================================
--- trunk/tools/dev/search-ops.pl	Sat Nov 21 19:53:17 2009	(r42769)
+++ trunk/tools/dev/search-ops.pl	Sat Nov 21 20:00:08 2009	(r42770)
@@ -43,7 +43,11 @@
 
 =head1 NAME
 
-tools/dev/search-ops.pl - Get descriptions of ops codes
+tools/dev/search-ops.pl
+
+=head1 DESCRIPTION
+
+Command-line tool to get descriptions of ops codes.
 
 =head1 USAGE
 

Modified: trunk/tools/util/ncidef2pasm.pl
==============================================================================
--- trunk/tools/util/ncidef2pasm.pl	Sat Nov 21 19:53:17 2009	(r42769)
+++ trunk/tools/util/ncidef2pasm.pl	Sat Nov 21 20:00:08 2009	(r42770)
@@ -3,11 +3,13 @@
 # Copyright (C) 2003-2007, Parrot Foundation.
 # $Id$
 
-=head1 ncidef2asm.pl
+=head1 NAME
 
-Take an NCI library definition file and turn it into a
+F<tools/util/ncidef2asm.pl>
 
-=head1 Sections
+=head1 DESCRIPTION
+
+Take an NCI library definition file and turn it into PASM.
 
 An NCI library definition file provides the information needed to
 generate a parrot wrapper for the named library (or libraries). Its

Modified: trunk/tools/util/update_copyright.pl
==============================================================================
--- trunk/tools/util/update_copyright.pl	Sat Nov 21 19:53:17 2009	(r42769)
+++ trunk/tools/util/update_copyright.pl	Sat Nov 21 20:00:08 2009	(r42770)
@@ -7,7 +7,11 @@
 use warnings;
 use Fatal qw( open close );
 
-=head1 PURPOSE
+=head1 NAME
+
+F<tools/util/update_copyright.pl>
+
+=head1 DESCRIPTION
 
 Given a list of files as command line arguments, update the copyright
 notice to go from the earliest year noted to the current year.