Skip Menu |

This queue is for tickets about the CPANPLUS CPAN distribution.

Report information
The Basics
Id: 9131
Status: resolved
Priority: 0/
Queue: CPANPLUS

People
Owner: Nobody in particular
Requestors: SAPER [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: 0.050_01
Fixed in: (no value)



Subject: Small mistakes in the documentation
Hello Jos, I found a few minor mistakes in the documentation. - CPANPLUS::Module::Author has =head1 NAME CPANPLUS::Module, which masks the documentation of CPANPLUS::Module when looking the documentation throught Search CPAN. - CPANPLUS::Shell::Default has =head1 NAME CPANPLUS::Shell::Default; (note the ";"), thus not linking the documentation to the module in Search CPAN. - at the end of the documentation of CPANPLUS::Configure, in "See Also", there is a link towards "CPANPLUS::Conf", which does not exist. Also, one can see comments used to configure your editor :-) - CPANPLUS::Module::Checksums is missing the traditionnal NAME, SYNOPSIS, DESCRIPTION, METHODS sections - some Pod formatting errors in CPANPLUS::Hacking I'll try to send you a patch which correct some of these later. Regards, Sébastien Aperghis-Tramoni
RT-Send-CC: kane [...] cpan.org
Here is the patch. Happy Christmas :)
diff -ru devel/lib/CPANPLUS/Configure.pm devel+01/lib/CPANPLUS/Configure.pm --- devel/lib/CPANPLUS/Configure.pm 2004-12-17 15:54:59.000000000 +0100 +++ devel+01/lib/CPANPLUS/Configure.pm 2004-12-24 20:13:50.000000000 +0100 @@ -564,8 +564,9 @@ =head1 SEE ALSO -L<CPANPLUS::Backend>, L<CPANPLUS::Conf> +L<CPANPLUS::Backend>, L<CPANPLUS::Configure::Setup> +=cut # Local variables: # c-indentation-style: bsd diff -ru devel/lib/CPANPLUS/Hacking.pod devel+01/lib/CPANPLUS/Hacking.pod --- devel/lib/CPANPLUS/Hacking.pod 2004-12-16 18:06:19.000000000 +0100 +++ devel+01/lib/CPANPLUS/Hacking.pod 2004-12-24 20:29:22.000000000 +0100 @@ -19,25 +19,26 @@ automatically updated. You can find the stable branch here (which should be equal to the -CPAN release): - http://p4.elixus.org/snap/cpanplus-dist.tar.gz +CPAN release): L<http://p4.elixus.org/snap/cpanplus-dist.tar.gz> And the development branch here: - http://p4.elixus.org/snap/cpanplus-devel.tar.gz +L<http://p4.elixus.org/snap/cpanplus-devel.tar.gz> =head1 INSTALLING CPANPLUS CPANPLUS follows the standard perl module installation process: + perl Makefile.PL make make test - mkae install + make install =head1 CONFIGURING CPANPLUS When running C<perl Makefile.PL> you will be prompted to configure. If you have already done so, and merely wish to update the C<Makefile>, simply run: + perl Makefile.PL JFDI=1 This will keep your configuration intact. Note however, if there are @@ -56,6 +57,7 @@ Tests are what tells us if CPANPLUS is working. If a test is not working, try to run it explicilty like this: + perl -I/path/to/cpanplus/lib t/XX_name_of_test.t 1 The extra '1' makes sure that all the messages and errors (they might @@ -71,7 +73,7 @@ Sometimes you might find bugs in CPANPLUS' behaviour. If you encounter these in a development snapshot, we'd appreciate a complete patch (as -described below in the C<SENDING PATCHES> section. +described below in the L<SENDING PATCHES> section. If it's way over your head, then of course reporting the bug is always better than not reporting it at all. Before you do so though, make @@ -96,7 +98,7 @@ =item [OPTIONAL] A patch to the test suite to test for the bug Amend our test suite by making sure this bug will be found in this, and -future versions of CPANPLUS (see C<SUPPLYING PATCHES>) +future versions of CPANPLUS (see L<SUPPLYING PATCHES>) =item [OPTIONAL] A patch to the code + tests + documentation diff -ru devel/lib/CPANPLUS/Module/Author.pm devel+01/lib/CPANPLUS/Module/Author.pm --- devel/lib/CPANPLUS/Module/Author.pm 2004-12-16 18:06:23.000000000 +0100 +++ devel+01/lib/CPANPLUS/Module/Author.pm 2004-12-24 20:12:16.000000000 +0100 @@ -12,7 +12,7 @@ =head1 NAME -CPANPLUS::Module +CPANPLUS::Module::Author =head1 SYNOPSIS diff -ru devel/lib/CPANPLUS/Module/Checksums.pm devel+01/lib/CPANPLUS/Module/Checksums.pm --- devel/lib/CPANPLUS/Module/Checksums.pm 2004-12-16 18:06:23.000000000 +0100 +++ devel+01/lib/CPANPLUS/Module/Checksums.pm 2004-12-24 20:25:09.000000000 +0100 @@ -17,6 +17,22 @@ @ISA = qw[ CPANPLUS::Module::Signature ]; +=head1 NAME + +CPANPLUS::Module::Checksums + +=head1 SYNOPSIS + + use CPANPLUS::Module::Checksums; + push @ISA, 'CPANPLUS::Module::Checksums'; + +=head1 DESCRIPTION + +This is a class that provides functions for checking the checksum +of a distribution. + +=head1 METHODS + =head2 $mod->checksums Fetches the checksums file for this module object. @@ -26,6 +42,7 @@ on error. The location of the checksums file is also stored as + $mod->status->checksums =cut diff -ru devel/lib/CPANPLUS/Shell/Default.pm devel+01/lib/CPANPLUS/Shell/Default.pm --- devel/lib/CPANPLUS/Shell/Default.pm 2004-12-16 18:06:25.000000000 +0100 +++ devel+01/lib/CPANPLUS/Shell/Default.pm 2004-12-24 20:12:41.000000000 +0100 @@ -70,7 +70,7 @@ =head1 NAME -CPANPLUS::Shell::Default; +CPANPLUS::Shell::Default =head1 SYNOPSIS
[SAPER - Fri Dec 24 14:33:56 2004]: Show quoted text
> Here is the patch. > > Happy Christmas :)
Thanks, and thanks applied @ 11755