documentation shouldn't recommend usenet #15320
Created by @mauke
Several files in the perl distribution reference usenet (comp.lang.perl.misc
| How to release and distribute a module.
This seems very outdated.
| =item Discuss the need
I'm not sure what to recommend instead here.
| =item Announce to clpa
This section can probably be removed.
| If you have any suggested changes for this page, let me know. Please
| There are also plenty of Perl related newsgroups located under
| Wherever possible please use the perlbug tool supplied with this Perl
| You should definitely announce your patch on the perl5-porters list.
On Tue, 24 May 2016 16:14:05 -0700
I agree as well. No objections here.
We have much consensus but no patches or commits yet. I have attached two in the hopes of closing this.
The first one is easy - my only question here is that I thought all the .SH files like myconfig.SH were automatically generated, but I can't figure out where from. So please just sanity check that that is a file that I can modify.
The second one patches a comment in DynaLoader/dl_dlopen.xs, not sure if that's appropriate.
Any other suggestions for replacement language, especially places for people to go to for help before filing a perlbug?
From a3137240515e1b8714ce5585b3ddd9cfb667c7d9 Mon Sep 17 00:00:00 2001 From: Dan Collins <firstname.lastname@example.org> Date: Wed, 8 Jun 2016 15:41:34 -0400 Subject: [PATCH 1/2] [perl #128200] Remove most references to USENET from docs --- INSTALL | 7 +++---- Porting/perldelta_template.pod | 5 ++--- Porting/pumpkin.pod | 4 ---- README.tw | 4 ---- myconfig.SH | 2 +- pod/perlcommunity.pod | 3 --- pod/perldelta.pod | 5 ++--- pod/perlmodinstall.pod | 4 ++-- pod/perlmodlib.PL | 31 +++++-------------------------- pod/perlnewmod.pod | 12 +----------- vms/myconfig.com | 2 +- 11 files changed, 17 insertions(+), 62 deletions(-) diff --git a/INSTALL b/INSTALL index 0ad1097..599414b 100644 --- a/INSTALL +++ b/INSTALL @@ -2389,10 +2389,9 @@ to report problems, as it automatically includes summary configuration information about your perl, which may help us track down problems far more quickly. But first you should read the advice in this file, carefully re-read the error message and check the relevant manual pages -on your system, as these may help you find an immediate solution. If -you are not sure whether what you are seeing is a bug, you can send a -message describing the problem to the comp.lang.perl.misc newsgroup to -get advice. +on your system, as these may help you find an immediate solution. +get advice. Once you've exhausted the documentation, please report +bugs to us using the 'perlbug' tool. The perlbug tool is installed along with perl, so after you have completed C<make install> it should be possible to run it with plain diff --git a/Porting/perldelta_template.pod b/Porting/perldelta_template.pod index e2535db..fd4825b 100644 --- a/Porting/perldelta_template.pod +++ b/Porting/perldelta_template.pod @@ -382,9 +382,8 @@ XXX Generate this with: =head1 Reporting Bugs -If you find what you think is a bug, you might check the articles recently -posted to the comp.lang.perl.misc newsgroup and the perl bug database at -L<https://rt.perl.org/> . There may also be information at +If you find what you think is a bug, you might check the perl bug database +at L<https://rt.perl.org/> . There may also be information at L<http://www.perl.org/> , the Perl Home Page. If you believe you have an unreported bug, please run the L<perlbug> program diff --git a/Porting/pumpkin.pod b/Porting/pumpkin.pod index 3618eec..69da88b 100644 --- a/Porting/pumpkin.pod +++ b/Porting/pumpkin.pod @@ -1129,10 +1129,6 @@ out http://www.cpan.org/CPAN.html ). =head1 Help Save the World You should definitely announce your patch on the perl5-porters list. -You should also consider announcing your patch on -comp.lang.perl.announce, though you should make it quite clear that a -subversion is not a production release, and be prepared to deal with -people who will not read your disclaimer. =head1 Todo diff --git a/README.tw b/README.tw index 5944bd8..f5588a8 100644 --- a/README.tw +++ b/README.tw @@ -101,10 +101,6 @@ Perl 郵遞論壇一覽 正體中文版的歐萊禮 Perl 書藉 -=item L<http://groups.google.com/groups?q=tw.bbs.comp.lang.perl> - -臺灣 Perl 連線討論區 (也就是各大 BBS 的 Perl 連線版) - =back =head2 Perl 使用者集會 diff --git a/myconfig.SH b/myconfig.SH index c5a9537..2b0ec78 100755 --- a/myconfig.SH +++ b/myconfig.SH @@ -25,7 +25,7 @@ $startsh # This script is designed to provide a handy summary of the configuration # information being used to build perl. This is especially useful if you -# are requesting help from comp.lang.perl.misc on usenet or via mail. +# are requesting help online or via email. # Note that the text lines /^Summary of/ .. /^\s*$/ are copied into Config.pm. cat <<'!NO!SUBS!' diff --git a/pod/perlcommunity.pod b/pod/perlcommunity.pod index 4b86740..bb55b67 100644 --- a/pod/perlcommunity.pod +++ b/pod/perlcommunity.pod @@ -32,9 +32,6 @@ contributors. If you don't see a certain project listed at L<http://lists.perl.org>, check the particular website for that project. Most mailing lists are archived at L<http://nntp.perl.org/>. -There are also plenty of Perl related newsgroups located under -C<comp.lang.perl.*>. - =head2 IRC The Perl community has a rather large IRC presence. For starters, it has its diff --git a/pod/perldelta.pod b/pod/perldelta.pod index ee4944c..5ebecce 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -429,9 +429,8 @@ XXX Generate this with: =head1 Reporting Bugs -If you find what you think is a bug, you might check the articles recently -posted to the comp.lang.perl.misc newsgroup and the perl bug database at -L<https://rt.perl.org/> . There may also be information at +If you find what you think is a bug, you might check the perl bug database +at L<https://rt.perl.org/> . There may also be information at L<http://www.perl.org/> , the Perl Home Page. If you believe you have an unreported bug, please run the L<perlbug> program diff --git a/pod/perlmodinstall.pod b/pod/perlmodinstall.pod index f92620c..79e350f 100644 --- a/pod/perlmodinstall.pod +++ b/pod/perlmodinstall.pod @@ -415,8 +415,8 @@ If you have any suggested changes for this page, let me know. Please don't send me mail asking for help on how to install your modules. There are too many modules, and too few Orwants, for me to be able to answer or even acknowledge all your questions. Contact the module -author instead, or post to comp.lang.perl.modules, or ask someone -familiar with Perl on your operating system. +author instead, ask someone familiar with Perl on your operating +system, or if all else fails, file a ticket at http://rt.cpan.org/. =head1 AUTHOR diff --git a/pod/perlmodlib.PL b/pod/perlmodlib.PL index aa6b18c..12767f1 100644 --- a/pod/perlmodlib.PL +++ b/pod/perlmodlib.PL @@ -1362,43 +1362,22 @@ See perldoc ExtUtils::MakeMaker.pm for details. How to release and distribute a module. -It's good idea to post an announcement of the availability of your -module (or the module itself if small) to the comp.lang.perl.announce -Usenet newsgroup. This will at least ensure very wide once-off -distribution. +If possible, register the module with CPAN. Follow the instructions +and links on: -If possible, register the module with CPAN. You should -include details of its location in your announcement. - -Some notes about ftp archives: Please use a long descriptive file -name that includes the version number. Most incoming directories -will not be readable/listable, i.e., you won't be able to see your -file after uploading it. Remember to send your email notification -message as soon as possible after uploading else your file may get -deleted automatically. Allow time for the file to be processed -and/or check the file has been processed before announcing its -location. - -FTP Archives for Perl Modules: - -Follow the instructions and links on: - - http://www.cpan.org/modules/00modlist.long.html http://www.cpan.org/modules/04pause.html -or upload to one of these sites: +and upload to: - https://pause.kbx.de/pause/ http://pause.perl.org/ -and notify <email@example.com>. +and notify <firstname.lastname@example.org>. This will allow anyone to install +your module using the C<cpan> tool distributed with Perl. By using the WWW interface you can ask the Upload Server to mirror your modules from your ftp or WWW site into your own directory on CPAN! -Please remember to send me an updated entry for the Module list! - =item * Take care when changing a released module. diff --git a/pod/perlnewmod.pod b/pod/perlnewmod.pod index eae2997..1426f8b 100644 --- a/pod/perlnewmod.pod +++ b/pod/perlnewmod.pod @@ -94,12 +94,7 @@ reinventing the wheel! =item Discuss the need You might love it. You might feel that everyone else needs it. But there -might not actually be any real demand for it out there. If you're unsure -about the demand your module will have, consider sending out feelers -on the C<comp.lang.perl.modules> newsgroup, or as a last resort, ask the -modules list at C<email@example.com>. Remember that this is a closed list -with a very long turn-around time - be prepared to wait a good while for -a response from them. +might not actually be any real demand for it out there. =item Choose a name @@ -255,11 +250,6 @@ it connected to the rest of the CPAN, you'll need to go to "Register Namespace" on PAUSE. Once registered, your module will appear in the by-module and by-category listings on CPAN. -=item Announce to clpa - -If you have a burning desire to tell the world about your release, post -an announcement to the moderated C<comp.lang.perl.announce> newsgroup. - =item Fix bugs! Once you start accumulating users, they'll send you bug reports. If diff --git a/vms/myconfig.com b/vms/myconfig.com index f3c69b9..5f80d25 100644 --- a/vms/myconfig.com +++ b/vms/myconfig.com @@ -2,7 +2,7 @@ $! #!/bin/sh ---> MYCONFIG.COM $! # This script is designed to provide a handy summary of the configuration $! # information being used to build perl. This is especially useful if you -$! # are requesting help from comp.lang.perl.misc on usenet or via mail. +$! # are requesting help online or via email. $! DCL-ified by Peter Prymmer <firstname.lastname@example.org> 22-DEC-1995 $! DCL usage (choose one): -- 2.8.1
From 339f66f4bea462f4cf39c849ac547d8b1af5c5ac Mon Sep 17 00:00:00 2001 From: Dan Collins <email@example.com> Date: Wed, 8 Jun 2016 15:42:11 -0400 Subject: [PATCH 2/2] [perl #128200] Remove references to USENET from ext/ --- ext/DynaLoader/dl_dlopen.xs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/ext/DynaLoader/dl_dlopen.xs b/ext/DynaLoader/dl_dlopen.xs index 172da13..c166882 100644 --- a/ext/DynaLoader/dl_dlopen.xs +++ b/ext/DynaLoader/dl_dlopen.xs @@ -88,8 +88,7 @@ Dean Roerich's Perl 5 API document. Also, have a look in the typemap file (in the ext directory) for a fairly comprehensive list of types that are already supported. If you are completely stuck, I suggest you - post a message to perl5-porters, comp.lang.perl.misc or if you are really - desperate to me. + post a message to perl5-porters. Remember when you are making any changes that the return value from dl_load_file is used as a parameter in the dl_find_symbol -- 2.8.1
On Wed Jun 08 19:29:48 2016, firstname.lastname@example.org wrote:
My understanding is that foo.SH files are templates for generating foo. So patching myconfig.SH should be OK.
Looks OK to me.
But about your first patch:
Your change to INSTALL results in:
| more quickly. But first you should read the advice in this file,
That "get advice." in there looks wrong. Did you mean to delete it instead?
| =item Discuss the need
Well, there's not much discussion left in that paragraph. :-)
If we don't have any place to recommend for discussion, we should just remove the whole section.
On Sun Jun 12 06:14:13 2016, mauke- wrote:
What about the module-authors mailing list?
On Wed Jun 08 19:29:48 2016, email@example.com wrote:
- I've removed the sentence fragment in INSTALL
Thank you for filing this report. You have helped make Perl better.
With the release today of Perl 5.26.0, this and 210 other issues have been
Perl 5.26.0 may be downloaded via:
If you find that the problem persists, feel free to reopen this ticket.