Bug #8106 for CPAN-Nargile: [PATCH] Fix the PODs Formatting and Many Typos

This patch fixes the POD formatting (there were many initial whitespaces which caused all the markup to become a code one), and corrects many spelling errors.

diff -u -r orig/bin/nargile.pl CPAN-Nargile-0.03/bin/nargile.pl --- orig/bin/nargile.pl 2004-10-15 16:26:22.000000000 +0200 +++ CPAN-Nargile-0.03/bin/nargile.pl 2004-10-23 19:59:16.455207616 +0200 @@ -19,26 +19,44 @@ =head1 SYNOPSIS - nargile.pl [options] +B<nargile.pl> [options] - Options - --cpan URL - where is the nearest CPAN mirror or minicpan ? (required) - --perl PATH - what is the path to the perl you are using for testing ? - by default we use the same perl that was used to execute - this script but you might want to test another one without - the installation of Nargile. - --version - --help - --count NUM - the number of modules to be processed this time - (defaults to all 150 in the recentness list) - --ask - turn the script interactive, ask the user for every module to - Test/Skip/Don't do/Quit - Skip - will skip the testing for this run but might attempt for the next run if - module is still in latests list - Don't do - will skip this distribution/version pair for good +Options: +=over 4 - See also perldoc CPAN::Nargile +=item B<--cpan> I<URL> + +URL to the nearest CPAN or minicpan mirror. (required) + +=item B<--perl> I<PATH> + +The Path to the Perl Executable that is used for testing. By default we use +the same perl that was used to execute this script but you might want to test +another one without the installation of Nargile. + +=item B<--version> + +=item B<--help> + +=item B<--count> I<NUM> + +The number of modules to be processed this time (defaults to all 150 in the +recentness list) + +=item B<--ask> + +Make the script interactive, ask the user for every module to +Test/Skip/"Don't do"/Quit + +B<Skip> - will skip the testing for this run but might attempt for the next +run if module is still in the list of the latest modules. + +B<Don't do> - will skip this distribution/version pair for good + +=back + +See also "B<perldoc CPAN::Nargile>". =cut diff -u -r orig/lib/CPAN/Nargile.pm CPAN-Nargile-0.03/lib/CPAN/Nargile.pm --- orig/lib/CPAN/Nargile.pm 2004-10-15 16:26:22.000000000 +0200 +++ CPAN-Nargile-0.03/lib/CPAN/Nargile.pm 2004-10-23 19:46:41.236018384 +0200 @@ -95,123 +95,132 @@ =head1 SYNOPSIS - nargile.pl --cpan http://www.cpan.org --ask +B<nargile.pl> B<--cpan> I<http://www.cpan.org> B<--ask> - or if you want to run it on another perl installation: +Or if you want to run it on another perl installation: - nargile.pl --cpan http://www.cpan.org --perl /home/gabor/perl/585/bin/perl -ask +B<nargile.pl> B<--cpan> I<http://www.cpan.org> +B<--perl> I</home/gabor/perl/585/bin/perl> B<--ask> - See also nargile.pl --help +See also C<nargile.pl --help> =head1 DESCRIPTION - Enable the user on any platform (will someone test this on other platforms as well, please) - to run smoke tests of CPAN modules. +Enable the user on any platform (will someone test this on other platforms as +well, please) to run smoke tests of CPAN modules. - The original recommended CPAN smoking is done based on e-mails sent to the - CPAN Testsers mailing list. This has the drawback that it requres some way to - parse the incoming mails on the same box where I want to run the smoker. +The original recommended CPAN smoking is done based on e-mails sent to the +CPAN Testsers mailing list. This has the drawback that it requires some way to +parse the incoming mails on the same box where I want to run the smoker. - Nargile downloads the list of the latest modules from CPAN and works on that list so - you don't need to read mail any more. +Nargile downloads the list of the latest modules from CPAN and works on that +list so you don't need to read mail any more. - It also ensures that only modules that already reached CPAN will be tested. +It also ensures that only modules that already reached CPAN will be tested. =head2 Frequency - By default CPANPLUS is being configured to reload its index ever 86400 seconds, - that is 24 hours. If you would like to run nargile more often with fresh data - from CPAN you'll have to configure the C<update> value of CPANPLUS to a lower number. - +By default CPANPLUS is being configured to reload its index every 86400 +seconds, that is 24 hours. If you would like to run nargile more often with +fresh data from CPAN you'll have to configure the C<update> value of CPANPLUS +to a lower number. =head1 FILES - The scipt maintains a file called $ENV{HOME}/.nargile.dbm where it lists the - distributes which were already tried. +The scipt maintains a file called $ENV{HOME}/.nargile.dbm where it lists the +distributes which were already tried. =head1 BUGS - This is an experimental version that works on my computer... +This is an experimental version that works on my computer... - Sometimes I get the following error message: +Sometimes I get the following error message: - Can't call method "module" on an undefined value at /home/gabor/perl/585/lib/site_perl/5.8.5/CPANPLUS/Internals/Install.pm line 220. + Can't call method "module" on an undefined value at + /home/gabor/perl/585/lib/site_perl/5.8.5/CPANPLUS/Internals/Install.pm + line 220. + +It seems that cpansmoke, when it notices that I have already sent a report +about a distribution (in a previous life), it won't even install it. This +might be a problem but it might be that it happens only as I have installed +some modules in a previous attemt to test the Nargile script. - It seems that cpansmoke when it notices that I have already sent a report about a distribution - (in a previous life) it won't even install it. This might be a problem but it might be that it - happens only as I have installed some modules in a previous attemt to test the Nargile script. +This might be a bug in CPANPLUS 0.049 - should upgrade it before +complaining: +In the recent uploads list there was: - This might be a bug in CPANPLUS 0.049 - should upgrade it before complaining: - In the recent uploads list there was - TMTM Text-Decorator-1.5.tar.gz + TMTM Text-Decorator-1.5.tar.gz - but when I ran cpansmok Text-Decorator-1.5 - it tiread to fetch /S/SI/SIMON/Text-Decorator-1.5.tar.gz - It seem the module just changed owners as SIMON has the earlier versions of this module. +But when I ran cpansmoke Text-Decorator-1.5 it tried to fetch +/S/SI/SIMON/Text-Decorator-1.5.tar.gz. It seems the module just changed owners +as SIMON has the earlier versions of this module. =head1 TODO - Fix the bugs. +Fix the bugs. - Enable the user to give a list of modules (using regexes) to be smoked or a list of - modules (using regexes) to exclude from smoking. +Enable the user to give a list of modules (using regexes) to be smoked or a +list of modules (using regexes) to exclude from smoking. - Enable the user to decide per module if s/he wants to smoke it or not. +Enable the user to decide per module if s/he wants to smoke it or not. - Interactive mode asking the user for every module what to do before and maybe even after running it. - Test/Skip/Quit/Exclude ? +Interactive mode asking the user for every module what to do before and maybe even after running it. Test/Skip/Quit/Exclude ? - Reduce prerequisites of this module ? +Reduce prerequisites of this module ? - Enable user initiate smoking a specific distribution by giving its name. +Enable user initiate smoking a specific distribution by giving its name. - Automatically skip Bundles ? +Automatically skip Bundles ? - With the current way of testing all the files in the latest 150 it migth happen that - the user uploaded 2 or more versions in the past few days and we might test an already - outdated version (in addition to the new one). Worse than that it can easily happen - especially if using CPAN::Mini that we don't have one of the versions. I should find out - first what is really the latest version of a dist on the CPAN mirror I am using. - - Somehow catch the output of each cpansmoke run (using script on unix ?) for later reference. +With the current way of testing all the files in the latest 150 it might +happen that the user uploaded 2 or more versions in the past few days and we +might test an already outdated version (in addition to the new one). Worse +than that it can easily happen that we don't have one of the versions +(especially if using CPAN::Mini ). I should find out first what is really +the latest version of a dist on the CPAN mirror I am using. +Somehow catch the output of each cpansmoke run (using script on unix ?) for +later reference. =head1 Changes =head2 v0.03 - code moved mostly from script to module +Code moved mostly from script to module - fix bug - When user selects Skiping a module or Quiting (in case of --ask) the name of the module is already - addedd to the "smoked" list and it won't be smoked again in the next run. - split the Don't do and the Skip modes +Fix bug when user selects Skiping a module or Quiting (in case of --ask) the +name of the module is already added to the "smoked" list and it won't be +smoked again in the next run. - cpanplus option -p removed to install prerequisites too +Split the Don't do and the Skip modes. + +CPANPLUS option -p removed to install prerequisites too =head1 SEE ALSO - L<CPANPLUS::TesterGuide> - L<cpansmoke> - L<http://search.cpan.org/dist/CPANPLUS> +L<CPANPLUS::TesterGuide> + +L<cpansmoke> + +L<http://search.cpan.org/dist/CPANPLUS> - L<CPAN::Mini> +L<CPAN::Mini> =head1 Spelling - Maybe it was better if I spelled it as Nargila ? +Maybe it was better if I spelled it as Nargila ? =head1 AUTHOR - Gabor Szabo <gabor@pti.co.il> - Copyright 2004, Gabor Szabo - The code is released under the same terms as Perl itself. +Gabor Szabo <gabor@pti.co.il> +Copyright 2004, Gabor Szabo +The code is released under the same terms as Perl itself. - L<http://www.szabgab.com/> +L<http://www.szabgab.com/> =cut