develooper Front page | perl.perl5.porters | Postings from November 2016

[perl #129918] central documentation of dual-lived modules hard tofind

From:
James E Keenan via RT
Date:
November 19, 2016 23:32
Subject:
[perl #129918] central documentation of dual-lived modules hard tofind
Message ID:
rt-4.0.24-26426-1479598347-801.129918-15-0@perl.org
On Wed, 19 Oct 2016 15:33:18 GMT, walde.christian@gmail.com wrote:
> 
> This is a bug report for perl from walde.christian@gmail.com,
> generated with the help of perlbug 1.39 running under perl 5.14.2.
> 
> 
> -----------------------------------------------------------------
> 
> While trying to figure out the answers to questions on a dual-lived
> module i searched the perl documentation for clues and found that
> information on their different life cycles is spread all over the core
> documentation and that their apparent official name differs from the
> common use name.
> 

Can you be more specific as to "different life cycles" and differences between the "apparent official name" and "common use name" of certain dual-life modules?  Which dual-life modules have this name clash?

> What follows is a list of sightings of information on them i made.
> 
> - http://perldoc.perl.org/perlhack.html#Patching-a-core-module
> - http://perldoc.perl.org/perlhack.html#Updating-perldelta
> - http://perldoc.perl.org/perlpolicy.html#MAINTENANCE-AND-SUPPORT
> - http://perldoc.perl.org/perlglossary.html#dual-lived

The Glossary is maintained upstream on CPAN, apparently as part of the 'perlfaq' distribution.  So that's where suggestions for revisions specific to the Glossary have to be made.

> - http://perldoc.perl.org/perlsource.html#Core-modules
> 

I ran this regex over blead:

#####
$ ack -i 'dual(\s|-)?li[vf]e' pod
#####

I then excluded all finds found in pod/perlNNNNdelta.pod files.  That left these finds for review:

#####
pod/perlpolicy.pod
318:Updates to dual-life modules should consist of minimal patches to
320:dual-life modules for which CPAN is canonical should be coordinated with
348:New versions of dual-life modules should NOT be imported into maint.
534:but, with very few exceptions, documentation isn't "dual-life" --

pod/perlsource.pod
37:which can be released on cpan are known as "dual-life" modules.
59:This directory is for dual-life modules where the blead source is
66:This directory contains dual-life modules where the CPAN module is
74:For some dual-life modules, it has not yet been determined if the CPAN
92:Tests for modules in F<ext/> and the dual-life modules are in F<t/>
189:information about a dual-life module.

pod/perlhack.pod
556:Adding, deprecating, removing, or upgrading core or dual-life modules
972:suite.  This is useful for modules that have a dual life on CPAN.
#####

I think the discussion in 'perlsource' is good -- but of course I would think that, because I'm the most recent committer to those paragraphs. ;-)  The finds in 'perlpolicy' and 'perlhack' are more tangential.  Can you provide specific suggestions for improvements?

Thank you very much.
-- 
James E Keenan (jkeenan@cpan.org)

---
via perlbug:  queue: perl5 status: new
https://rt.perl.org/Ticket/Display.html?id=129918



nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About