[svn:parrot] r42772 - in trunk/tools: build dev

jkeenan at svn.parrot.org jkeenan at svn.parrot.org
Sat Nov 21 20:21:38 UTC 2009 

Author: jkeenan
Date: Sat Nov 21 20:21:37 2009
New Revision: 42772
URL: https://trac.parrot.org/parrot/changeset/42772

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

Modified:
   trunk/tools/build/c2str.pl
   trunk/tools/build/headerizer.pl
   trunk/tools/dev/branch_status.pl
   trunk/tools/dev/checkdepend.pl
   trunk/tools/dev/list_unjitted.pl
   trunk/tools/dev/mk_inno.pl
   trunk/tools/dev/mk_inno_language.pl
   trunk/tools/dev/ops_not_tested.pl
   trunk/tools/dev/parrot-fuzzer
   trunk/tools/dev/pbc_to_exe.pir

Modified: trunk/tools/build/c2str.pl
==============================================================================
--- trunk/tools/build/c2str.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/build/c2str.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -5,7 +5,11 @@
 
 =head1 NAME
 
-tools/build/c2str.pl - constant string support
+tools/build/c2str.pl
+
+=head1 DESCRIPTION
+
+constant string support
 
 =cut
 

Modified: trunk/tools/build/headerizer.pl
==============================================================================
--- trunk/tools/build/headerizer.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/build/headerizer.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -14,14 +14,14 @@
 
 =head1 SYNOPSIS
 
-Update the headers in F<include/parrot> with the function declarations in
-the F<*.pmc> or F<*.c> files that correspond to the F<*.o> files passed
-on the command line.
-
     % perl tools/build/headerizer.pl OBJFILES
 
 =head1 DESCRIPTION
 
+Update the headers in F<include/parrot> with the function declarations in
+the F<*.pmc> or F<*.c> files that correspond to the F<*.o> files passed
+on the command line.
+
 =head1 TODO
 
 * Generate docs from funcs
@@ -655,6 +655,8 @@
     # In file bar.c
     /* HEADERIZER HFILE: foo.h */
 
+=back
+
 =cut
 
 # Local Variables:

Modified: trunk/tools/dev/branch_status.pl
==============================================================================
--- trunk/tools/dev/branch_status.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/branch_status.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -2,10 +2,21 @@
 # $Id$
 # Copyright (C) 2009, Parrot Foundation.
 
-=head1 branch_status
+=head1 NAME
+
+tools/dev/branch_status.pl
+
+=head1 DESCRIPTION
 
 Generate a report to help developers determine status of repository branches.
 
+This program uses modules that are not intended to be parrot requirements.
+
+Prerequisites:  Perl 5.10; XML::Twig; Perl6::Form.
+
+Assumes that you have a command line svn in your path, but doesn't have
+to be run in a working copy.
+
 =cut
 
 use v5.10.0;
@@ -100,14 +111,3 @@
 }
 
 say '+', '=' x 68, '+';
-
-__END__
-
-=head1 Notes
-
-This program uses modules that are not intended to be parrot requirements.
-
-Assumes that you have a command line svn in your path, but doesn't have
-to be run in a working copy.
-
-=cut

Modified: trunk/tools/dev/checkdepend.pl
==============================================================================
--- trunk/tools/dev/checkdepend.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/checkdepend.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -12,12 +12,16 @@
 use Test::More;
 use Test::Harness;
 
-=for comment
+=head1 NAME
 
-A braindead script to check that every .c file has makefile deps
+tools/dev/checkdepend.pl
+
+=head1 DESCRIPTION
+
+A braindead script to check that every F<.c> file has makefile deps
 on its includes.
 
-Requires: a standard (possibly non -j) make run to generate all
+Requires: a standard (possibly non C<-j>) C<make> run to generate all
 required C files first.
 
 =cut

Modified: trunk/tools/dev/list_unjitted.pl
==============================================================================
--- trunk/tools/dev/list_unjitted.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/list_unjitted.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -59,7 +59,7 @@
 
 tools/dev/list_unjitted.pl
 
-=head1 ABSTRACT
+=head1 DESCRIPTION
 
 For a given platform, report the number of ops JITted or not JITted.
 

Modified: trunk/tools/dev/mk_inno.pl
==============================================================================
--- trunk/tools/dev/mk_inno.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/mk_inno.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -10,9 +10,10 @@
 
     % perl tools/dev/mk_inno.pl
 
-=head1 SEE ALSO
+=head1 DESCRIPTION
 
-http://www.jrsoftware.org/
+From L<http://www.jrsoftware.org/>:  Inno Setup is a free installer for
+Windows programs.
 
 =cut
 

Modified: trunk/tools/dev/mk_inno_language.pl
==============================================================================
--- trunk/tools/dev/mk_inno_language.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/mk_inno_language.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -11,9 +11,10 @@
     % cd languages/lang
     % perl ../../tools/dev/mk_inno_language.pl lang
 
-=head1 SEE ALSO
+=head1 DESCRIPTION
 
-http://www.jrsoftware.org/
+From L<http://www.jrsoftware.org/>:  Inno Setup is a free installer for
+Windows programs.
 
 =cut
 

Modified: trunk/tools/dev/ops_not_tested.pl
==============================================================================
--- trunk/tools/dev/ops_not_tested.pl	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/ops_not_tested.pl	Sat Nov 21 20:21:37 2009	(r42772)
@@ -12,7 +12,13 @@
 use Parrot::Op;
 use Parrot::OpLib::core;
 
-=head1 The problem
+=head1 NAME
+
+tools/dev/ops_not_tested.pl
+
+=head1 DESCRIPTION
+
+The problem this program addresses is described in this IRC log:
 
 10:23 <toor> # Tests - ~1/3 of opcodes are uncovered by tests <--
              were can I see which ones are not

Modified: trunk/tools/dev/parrot-fuzzer
==============================================================================
--- trunk/tools/dev/parrot-fuzzer	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/parrot-fuzzer	Sat Nov 21 20:21:37 2009	(r42772)
@@ -16,22 +16,22 @@
 
 '''
 
-=head1 Name
+=head1 NAME
 
 parrot-fuzzer
 
-=head1 Description
+=head1 DESCRIPTION
 
 This is a fuzzer for Parrot, written in Python using the fusil library.  It
 attempts to break Parrot by generating calls to random PIR opcodes.
 
-=head1 Dependencies
+=head1 DEPENDENCIES
 
 This script requires Python 2.5+ to run.  The fusil
 L<http://fusil.hachoir.org/trac> and python-ptrace
 L<http://python-ptrace.hachoir.org/trac> libraries are also required.
 
-=head1 Running
+=head1 USAGE
 
 Short version: C<sudo ./tools/dev/parrot-fuzzer>
 
@@ -49,7 +49,7 @@
 of Parrot's source code.  You can use a different dir via
 C<--parrot_root=/some/other/path>.
 
-=head1 Options
+=head1 OPTIONS
 
 =over 4
 
@@ -79,7 +79,7 @@
 
 =back
 
-=head1 License
+=head1 LICENSE
 
 This program is distributed under the same license as Parrot itself.
 

Modified: trunk/tools/dev/pbc_to_exe.pir
==============================================================================
--- trunk/tools/dev/pbc_to_exe.pir	Sat Nov 21 20:18:56 2009	(r42771)
+++ trunk/tools/dev/pbc_to_exe.pir	Sat Nov 21 20:21:37 2009	(r42772)
@@ -4,7 +4,11 @@
 
 =head1 NAME
 
-pbc_to_exe - compile bytecode to executable
+pbc_to_exe
+
+=head1 DESCRIPTION
+
+Compile bytecode to executable.
 
 =head2 SYNOPSIS

More information about the parrot-commits mailing list