Front page | perl.perl5.changes |
Postings from March 2003
Change 18842: Re: [PATCH] let perlmodstyle mention Module::Build and Test::More
From:
Rafael Garcia-Suarez
Date:
March 6, 2003 16:37
Subject:
Change 18842: Re: [PATCH] let perlmodstyle mention Module::Build and Test::More
Message ID:
200303062245.h26Mj5B17841@smtp3.ActiveState.com
Change 18842 by rgs@rgs-home on 2003/03/06 21:27:15
Subject: Re: [PATCH] let perlmodstyle mention Module::Build and Test::More
From: "Jos I. Boumans" <kane@dwim.org>
Date: Fri, 21 Feb 2003 20:33:53 +0100
Message-ID: <3E567F21.6020006@dwim.org>
(with some minor tweaks)
Affected files ...
... //depot/perl/pod/perlmodstyle.pod#5 edit
Differences ...
==== //depot/perl/pod/perlmodstyle.pod#5 (text) ====
Index: perl/pod/perlmodstyle.pod
--- perl/pod/perlmodstyle.pod#4~17418~ Mon Jul 8 05:11:31 2002
+++ perl/pod/perlmodstyle.pod Thu Mar 6 13:27:15 2003
@@ -137,7 +137,7 @@
=item *
-Specify pre-requisites in Makefile.PL
+Specify pre-requisites in Makefile.PL or Build.PL
=item *
@@ -563,7 +563,33 @@
giving pointers to further information (website, author email).
An INSTALL file should be included, and should contain simple installation
-instructions (usually "perl Makefile.PL; make; make install").
+instructions. When using ExtUtils::MakeMaker this will usually be:
+
+=over 4
+
+=item perl Makefile.PL
+
+=item make
+
+=item make test
+
+=item make install
+
+=back
+
+When using Module::Build, this will usually be:
+
+=over 4
+
+=item perl Build.PL
+
+=item perl Build
+
+=item perl Build test
+
+=item perl Build install
+
+=back
Release notes or changelogs should be produced for each release of your
software describing user-visible changes to your module, in terms
@@ -639,16 +665,18 @@
=back
Specify version requirements for other Perl modules in the
-pre-requisites in your Makefile.PL.
+pre-requisites in your Makefile.PL or Build.PL.
-Be sure to specify Perl version requirements both in Makefile.PL and
-with C<require 5.6.1> or similar.
+Be sure to specify Perl version requirements both in Makefile.PL or
+Build.PL and with C<require 5.6.1> or similar. See the section on
+C<use VERSION> of L<perlfunc/require> for details.
=head2 Testing
-All modules should be tested before distribution (using "make disttest",
+All modules should be tested before distribution (using "make disttest"),
and the tests should also be available to people installing the modules
(using "make test").
+For Module::Build you would use the C<make test> equivalent C<perl Build test>.
The importance of these tests is proportional to the alleged stability of a
module -- a module which purports to be stable or which hopes to achieve wide
@@ -657,15 +685,17 @@
Useful modules to help you write tests (with minimum impact on your
development process or your time) include Test::Simple, Carp::Assert
and Test::Inline.
+For more sophisticated test suites there are Test::More and Test::MockObject.
=head2 Packaging
-Modules should be packaged using the standard MakeMaker tools, allowing
-them to be installed in a consistent manner. Use "make dist" to create
-your package.
-
-Tools exist to help you build your module in a MakeMaker-friendly style.
-These include ExtUtils::ModuleMaker and h2xs. See also L<perlnewmod>.
+Modules should be packaged using one of the standard packaging tools.
+Currently you have the choice between ExtUtils::MakeMaker and the
+more platform independent Module::Build, allowing modules to be installed in a
+consistent manner.
+When using ExtUtils::MakeMaker, you can use "make dist" to create your
+package. Tools exist to help you to build your module in a MakeMaker-friendly
+style. These include ExtUtils::ModuleMaker and h2xs. See also L<perlnewmod>.
=head2 Licensing
@@ -726,9 +756,13 @@
Verifies your POD's correctness
+=item Packaging Tools
+
+L<ExtUtils::MakeMaker>, L<Module::Build>
+
=item Testing tools
-L<Test::Simple>, L<Test::Inline>, L<Carp::Assert>
+L<Test::Simple>, L<Test::Inline>, L<Carp::Assert>, L<Test::More>, L<Test::MockObject>
=item http://pause.perl.org/
End of Patch.
-
Change 18842: Re: [PATCH] let perlmodstyle mention Module::Build and Test::More
by Rafael Garcia-Suarez