From fe0509bc21985e0ccf99f65c727a7665739bdef4 Mon Sep 17 00:00:00 2001 From: jonasbn Date: Fri, 6 Oct 2017 22:29:30 +0200 Subject: [PATCH 1/2] This documentation was lifted from Module::Install::Makefile, it seems to have been placed in the wrong component --- lib/Module/Install/MakeMaker.pm | 129 ++++++++++++++++++++++++++++++++ 1 file changed, 129 insertions(+) diff --git a/lib/Module/Install/MakeMaker.pm b/lib/Module/Install/MakeMaker.pm index 62d1332..db80446 100644 --- a/lib/Module/Install/MakeMaker.pm +++ b/lib/Module/Install/MakeMaker.pm @@ -53,3 +53,132 @@ END { } 1; + +=pod + +=head1 NAME + +Module::Install::MakeMaker - Extension Rules for ExtUtils::MakeMaker + +=head1 SYNOPSIS + +In your F: + + use inc::Module::Install; + WriteMakefile(); + +=head1 DESCRIPTION + +This module is a wrapper around B. It exports +two functions: C (an alias for C) +and C. + +The C function will pass on keyword/value pair functions +to C. The required parameters +C and C (or C) are not necessary if +it can find them unambiguously in your code. + +=head1 CONFIGURATION OPTIONS + +This module also adds some Configuration parameters of its own: + +=head2 NAME + +The NAME parameter is required by B. If you have a +single module in your distribution, or if the module name indicated by +the current directory exists under F, this module will use the +guessed package name as the default. + +If this module can't find a default for C it will ask you to specify +it manually. + +=head2 VERSION + +B requires either the C or C +parameter. If this module can guess the package's C, it will attempt +to parse the C from it. + +If this module can't find a default for C it will ask you to +specify it manually. + +=head1 MAKE TARGETS + +B provides you with many useful C targets. A +C B is the word you specify after C, like C +for C. Some of the more useful targets are: + +=over 4 + +=item * all + +This is the default target. When you type C it is the same as +entering C. This target builds all of your code and stages it +in the C directory. + +=item * test + +Run your distribution's test suite. + +=item * install + +Copy the contents of the C directory into the appropriate +directories in your Perl installation. + +=item * dist + +Create a distribution tarball, ready for uploading to CPAN or sharing +with a friend. + +=item * clean distclean purge + +Remove the files created by C and C. + +=item * help + +Same as typing C. + +=back + +This module modifies the behaviour of some of these targets, depending +on your requirements, and also adds the following targets to your Makefile: + +=over 4 + +=item * cpurge + +Just like purge, except that it also deletes the files originally added +by this module itself. + +=item * chelp + +Short cut for typing C. + +=item * distsign + +Short cut for typing C, for B users to +sign the distribution before release. + +=back + +=head1 SEE ALSO + +L, L, L + +=head1 AUTHORS + +Adam Kennedy Eadamk@cpan.orgE + +Audrey Tang Eautrijus@autrijus.orgE + +Brian Ingerson EINGY@cpan.orgE + +=head1 COPYRIGHT + +Some parts copyright 2008 - 2012 Adam Kennedy. + +Copyright 2002, 2003, 2004 Audrey Tang and Brian Ingerson. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +=cut From 2df5e33a0d55ebea173418f499ffc8880018e8fc Mon Sep 17 00:00:00 2001 From: jonasbn Date: Fri, 6 Oct 2017 22:43:20 +0200 Subject: [PATCH 2/2] Cleaned the documentation, which seemed to belong in Module::Install::MakeMaker instead of Module::Install::Makefile. next up must be a rewrite of the documentation in Module::Install::Makefile. --- lib/Module/Install/Makefile.pm | 95 +--------------------------------- 1 file changed, 1 insertion(+), 94 deletions(-) diff --git a/lib/Module/Install/Makefile.pm b/lib/Module/Install/Makefile.pm index c8e31e8..5b0fa51 100644 --- a/lib/Module/Install/Makefile.pm +++ b/lib/Module/Install/Makefile.pm @@ -418,7 +418,7 @@ __END__ =head1 NAME -Module::Install::MakeMaker - Extension Rules for ExtUtils::MakeMaker +Module::Install::Makefile - Extension Rules for Makefile =head1 SYNOPSIS @@ -429,101 +429,8 @@ In your F: =head1 DESCRIPTION -This module is a wrapper around B. It exports -two functions: C (an alias for C) -and C. - -The C function will pass on keyword/value pair functions -to C. The required parameters -C and C (or C) are not necessary if -it can find them unambiguously in your code. - =head1 CONFIGURATION OPTIONS -This module also adds some Configuration parameters of its own: - -=head2 NAME - -The NAME parameter is required by B. If you have a -single module in your distribution, or if the module name indicated by -the current directory exists under F, this module will use the -guessed package name as the default. - -If this module can't find a default for C it will ask you to specify -it manually. - -=head2 VERSION - -B requires either the C or C -parameter. If this module can guess the package's C, it will attempt -to parse the C from it. - -If this module can't find a default for C it will ask you to -specify it manually. - -=head1 MAKE TARGETS - -B provides you with many useful C targets. A -C B is the word you specify after C, like C -for C. Some of the more useful targets are: - -=over 4 - -=item * all - -This is the default target. When you type C it is the same as -entering C. This target builds all of your code and stages it -in the C directory. - -=item * test - -Run your distribution's test suite. - -=item * install - -Copy the contents of the C directory into the appropriate -directories in your Perl installation. - -=item * dist - -Create a distribution tarball, ready for uploading to CPAN or sharing -with a friend. - -=item * clean distclean purge - -Remove the files created by C and C. - -=item * help - -Same as typing C. - -=back - -This module modifies the behaviour of some of these targets, depending -on your requirements, and also adds the following targets to your Makefile: - -=over 4 - -=item * cpurge - -Just like purge, except that it also deletes the files originally added -by this module itself. - -=item * chelp - -Short cut for typing C. - -=item * distsign - -Short cut for typing C, for B users to -sign the distribution before release. - -=back - -=head1 SEE ALSO - -L, L, L - =head1 AUTHORS Adam Kennedy Eadamk@cpan.orgE