[Module-build-general] [PATCH] docs, and remove unused code from PPMMaker

[Dave R. <au...@ur...>]

The patch, after my sig, includes the following:

- Update list of actions in POD, and include some docs for ppd and
distmeta actions.

- Document dist_author, dist_abstract, and codebase arguments to new().

- Remove an unused method from PPMMaker.

Patch after sig.


-dave

/*=======================
House Absolute Consulting
www.houseabsolute.com
=======================*/


? mb-patch
? t/Sample/SIGNATURE
? t/Sample/Sample-0.01.tar.gz
Index: lib/Module/Build.pm
===================================================================
RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build.pm,v
retrieving revision 1.89
diff -u -r1.89 Build.pm
--- lib/Module/Build.pm	24 Jul 2003 19:22:36 -0000	1.89
+++ lib/Module/Build.pm	25 Jul 2003 04:05:11 -0000
@@ -133,16 +133,17 @@
 'actions'.  In this case the actions run are 'build' (the default
 action), 'test', and 'install'.  Actions defined so far include:

-  build                          help
-  clean                          install
-  diff                           manifest
-  dist                           manifypods
-  distcheck                      realclean
-  distclean                      skipcheck
-  distdir                        test
-  distsign                       testdb
-  disttest                       versioninstall
-  fakeinstall
+  build                          fakeinstall
+  builddocs                      help
+  clean                          install
+  diff                           manifest
+  dist                           ppd
+  distcheck                      realclean
+  distclean                      skipcheck
+  distdir                        test
+  distmeta                       testdb
+  distsign                       versioninstall
+  disttest

 You can run the 'help' action for a complete list of actions.

@@ -542,6 +543,29 @@
      extra_linker_flags   => `glib-config --libs`,
  );

+=head dist_author
+
+This should be something like "John Doe <jd...@ex...>".  This is
+used when creating PPD files.  If this is not specified, then
+C<Module::Build> looks at the module from which it gets the
+distribution's version.  If it finds a POD section marked "=head1
+AUTHOR", then it uses the contents of this section.
+
+=head dist_abstract
+
+This should be a short description of the distribution.  This is used
+when creating PPD files.  If it is not given then C<Module::Build>
+looks in the POD of the module from which it gets the distribution's
+version.  It looks for the first line matching C<$package\s-\s(.+)>,
+and uses the captured text as the abstract.
+
+=head codebase
+
+This can be either a single scalar string, or an array reference of
+strings.  It is required when creating PPD files.  It should be a URL,
+or URLs, to be used as the value for the C<< <CODEBASE> >> tag in the
+generated PPD.
+
 =back

 =item create_build_script()
@@ -994,6 +1018,10 @@
 Uses C<Module::Signature> to create a SIGNATURE file for your
 distribution.

+=item distmeta
+
+Creates the F<META.yml> file for your distribution.
+
 =item distcheck

 Reports which files are in the build directory but not in the
@@ -1029,6 +1057,10 @@
 Performs the 'distdir' action, then switches into that directory and
 runs a C<perl Build.PL>, followed by the 'build' and 'test' actions in
 that directory.
+
+=item ppd
+
+Build a PPD file for your distribution.

 =back

Index: lib/Module/Build/PPMMaker.pm
===================================================================
RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build/PPMMaker.pm,v
retrieving revision 1.1
diff -u -r1.1 PPMMaker.pm
--- lib/Module/Build/PPMMaker.pm	10 May 2003 17:40:13 -0000	1.1
+++ lib/Module/Build/PPMMaker.pm	25 Jul 2003 04:05:12 -0000
@@ -104,18 +104,6 @@
   return $ppd_file;
 }

-sub _parse_abstract {
-    my($self, $file) = @_;
-
-    my $result;
-    local $/ = "\n";
-
-    my $fh = IO::File->new("<$file")
-      or die "Could not open $file: $!";
-
-    return $result;
-}
-
 sub _ppd_version {
   my ($self, $version) = @_;