In perl.git, the branch blead has been updated <http://perl5.git.perl.org/perl.git/commitdiff/cb8a010e028d27ee646ddd61d74b588434691703?hp=8491f48b65f309b745e5fc6441ea3a96237d9b23>
- Log ----------------------------------------------------------------- commit cb8a010e028d27ee646ddd61d74b588434691703 Author: Jesse Vincent <[email protected]> Date: Tue Oct 13 10:36:34 2009 -0400 Move the new "perl policy" document into pod/ M MANIFEST D Porting/Contract M pod.lst M pod/perl.pod A pod/perlpolicy.pod M vms/descrip_mms.template M win32/pod.mak commit 48cb5b3a61e5b7acdd9ae8095c8d0554e9ba1a9e Author: Jesse Vincent <[email protected]> Date: Tue Oct 13 10:32:38 2009 -0400 Podify the social contract about contributed modules M Porting/Contract ----------------------------------------------------------------------- Summary of changes: MANIFEST | 2 +- pod.lst | 3 +- pod/perl.pod | 1 + Porting/Contract => pod/perlpolicy.pod | 87 ++++++++++++++++++++------------ vms/descrip_mms.template | 18 ++++--- win32/pod.mak | 4 ++ 6 files changed, 74 insertions(+), 41 deletions(-) rename Porting/Contract => pod/perlpolicy.pod (64%) diff --git a/MANIFEST b/MANIFEST index 5c69043..52c0845 100644 --- a/MANIFEST +++ b/MANIFEST @@ -3913,6 +3913,7 @@ pod/perlperf.pod Perl Performance and Optimization Techniques pod/perl.pod Perl overview (this section) pod/perlpod.pod Perl plain old documentation pod/perlpodspec.pod Perl plain old documentation format specification +pod/perlpolicy.pod Perl development policies pod/perlport.pod Perl portability guide pod/perlpragma.pod Perl modules: writing a user pragma pod/perlreapi.pod Perl regular expression plugin interface @@ -3970,7 +3971,6 @@ Porting/cmpVERSION.pl Compare whether two trees have changed modules Porting/config_H Sample config.h Porting/config_h.pl Reorder config_h.SH after metaconfig Porting/config.sh Sample config.sh -Porting/Contract Social contract for contributed modules in Perl core Porting/core-cpan-diff Compare core distros with their CPAN equivalents Porting/corecpan.pl Reports outdated dual-lived modules Porting/corelist-perldelta.pl Generates data perldelta from Module::CoreList diff --git a/pod.lst b/pod.lst index f7fb5ea..89d141b 100644 --- a/pod.lst +++ b/pod.lst @@ -122,7 +122,8 @@ g perlintern Perl internal functions (autogenerated) perlapio Perl internal IO abstraction interface perlhack Perl hackers guide - perlrepository Perl source repository + perlpolicy Perl development policies + perlrepository Perl source repository h Miscellaneous diff --git a/pod/perl.pod b/pod/perl.pod index 4d42c37..d86ecd2 100644 --- a/pod/perl.pod +++ b/pod/perl.pod @@ -136,6 +136,7 @@ For ease of access, the Perl manual has been split up into several sections. perlapio Perl internal IO abstraction interface perlhack Perl hackers guide + perlpolicy Perl development policies perlrepository Perl source repository =head2 Miscellaneous diff --git a/Porting/Contract b/pod/perlpolicy.pod similarity index 64% rename from Porting/Contract rename to pod/perlpolicy.pod index 2b619fd..fbb6bc5 100644 --- a/Porting/Contract +++ b/pod/perlpolicy.pod @@ -1,6 +1,19 @@ +=head1 NAME - Contributed Modules in Perl Core - A Social Contract about Artistic Control +perlpolicy - Various and sundry policies and commitments related to the perl core + +=head1 DESCRIPTION + +This document is the master document which records all written +policies about how the Perl 5 Porters collectively develop and maintain +the Perl core. + + + +=head1 CONTRIBUTED MODULES + + +=head2 A Social Contract about Artistic Control What follows is a statement about artistic control, defined as the ability of authors of packages to guide the future of their code and maintain @@ -35,27 +48,35 @@ involved in maintaining Perl should be aware that the module is still the property of the original author unless the original author explicitly gives up their ownership of it. In particular: - 1) The version of the module in the core should still be considered the +=over + +=item * The version of the module in the core should still be considered the work of the original author. All patches, bug reports, and so forth should be fed back to them. Their development directions should be respected whenever possible. - 2) Patches may be applied by the pumpkin holder without the explicit - cooperation of the module author if and only if they are very minor, - time-critical in some fashion (such as urgent security fixes), or if - the module author cannot be reached. Those patches must still be - given back to the author when possible, and if the author decides on - an alternate fix in their version, that fix should be strongly - preferred unless there is a serious problem with it. Any changes not - endorsed by the author should be marked as such, and the contributor - of the change acknowledged. - - 3) The version of the module distributed with Perl should, whenever - possible, be the latest version of the module as distributed by the - author (the latest non-beta version in the case of public Perl - releases), although the pumpkin holder may hold off on upgrading the - version of the module distributed with Perl to the latest version - until the latest version has had sufficient testing. +=item * + +Patches may be applied by the pumpkin holder without the explicit +cooperation of the module author if and only if they are very minor, +time-critical in some fashion (such as urgent security fixes), or if +the module author cannot be reached. Those patches must still be +given back to the author when possible, and if the author decides on +an alternate fix in their version, that fix should be strongly +preferred unless there is a serious problem with it. Any changes not +endorsed by the author should be marked as such, and the contributor +of the change acknowledged. + +=item * + +The version of the module distributed with Perl should, whenever +possible, be the latest version of the module as distributed by the +author (the latest non-beta version in the case of public Perl +releases), although the pumpkin holder may hold off on upgrading the +version of the module distributed with Perl to the latest version +until the latest version has had sufficient testing. + +=back In other words, the author of a module should be considered to have final say on modifications to their module whenever possible (bearing in mind @@ -64,17 +85,18 @@ reasonable compromises when there are disagreements). As a last resort, however: - 4) If the author's vision of the future of their module is sufficiently - different from the vision of the pumpkin holder and perl5-porters as a - whole so as to cause serious problems for Perl, the pumpkin holder may - choose to formally fork the version of the module in the core from the - one maintained by the author. This should not be done lightly and - should *always* if at all possible be done only after direct input - from Larry. If this is done, it must then be made explicit in the - module as distributed with Perl core that it is a forked version and - that while it is based on the original author's work, it is no longer - maintained by them. This must be noted in both the documentation and - in the comments in the source of the module. + +If the author's vision of the future of their module is sufficiently +different from the vision of the pumpkin holder and perl5-porters as a +whole so as to cause serious problems for Perl, the pumpkin holder may +choose to formally fork the version of the module in the core from the +one maintained by the author. This should not be done lightly and +should *always* if at all possible be done only after direct input +from Larry. If this is done, it must then be made explicit in the +module as distributed with Perl core that it is a forked version and +that while it is based on the original author's work, it is no longer +maintained by them. This must be noted in both the documentation and +in the comments in the source of the module. Again, this should be a last resort only. Ideally, this should never happen, and every possible effort at cooperation and compromise should be @@ -103,6 +125,7 @@ at a compromise. In nearly every circumstance nothing more will be necessary, and certainly no more drastic measure should be used until every avenue of communication and discussion has failed. --- -Version 1.2. By Russ Allbery ([email protected]) and the perl5-porters. +=head1 CREDITS + +Social Contract about Contributed Modules originall by Russ Allbery E<lt>[email protected]<gt> and the perl5-porters. diff --git a/vms/descrip_mms.template b/vms/descrip_mms.template index a50f1c7..43f326f 100644 --- a/vms/descrip_mms.template +++ b/vms/descrip_mms.template @@ -421,13 +421,13 @@ pod17 = [.lib.pods]perllocale.pod [.lib.pods]perllol.pod [.lib.pods]perlmacos.po pod18 = [.lib.pods]perlmodinstall.pod [.lib.pods]perlmodlib.pod [.lib.pods]perlmodstyle.pod [.lib.pods]perlmpeix.pod [.lib.pods]perlmroapi.pod pod19 = [.lib.pods]perlnetware.pod [.lib.pods]perlnewmod.pod [.lib.pods]perlnumber.pod [.lib.pods]perlobj.pod [.lib.pods]perlop.pod pod20 = [.lib.pods]perlopenbsd.pod [.lib.pods]perlopentut.pod [.lib.pods]perlos2.pod [.lib.pods]perlos390.pod [.lib.pods]perlos400.pod -pod21 = [.lib.pods]perlpacktut.pod [.lib.pods]perlperf.pod [.lib.pods]perlplan9.pod [.lib.pods]perlpod.pod [.lib.pods]perlpodspec.pod [.lib.pods]perlport.pod -pod22 = [.lib.pods]perlpragma.pod [.lib.pods]perlqnx.pod [.lib.pods]perlre.pod [.lib.pods]perlreapi.pod [.lib.pods]perlrebackslash.pod -pod23 = [.lib.pods]perlrecharclass.pod [.lib.pods]perlref.pod [.lib.pods]perlreftut.pod [.lib.pods]perlreguts.pod [.lib.pods]perlrepository.pod -pod24 = [.lib.pods]perlrequick.pod [.lib.pods]perlreref.pod [.lib.pods]perlretut.pod [.lib.pods]perlriscos.pod [.lib.pods]perlrun.pod [.lib.pods]perlsec.pod -pod25 = [.lib.pods]perlsolaris.pod [.lib.pods]perlstyle.pod [.lib.pods]perlsub.pod [.lib.pods]perlsymbian.pod [.lib.pods]perlsyn.pod -pod26 = [.lib.pods]perlthrtut.pod [.lib.pods]perltie.pod [.lib.pods]perltoc.pod [.lib.pods]perltodo.pod [.lib.pods]perltooc.pod [.lib.pods]perltoot.pod -pod27 = [.lib.pods]perltrap.pod [.lib.pods]perltru64.pod [.lib.pods]perltw.pod [.lib.pods]perlunicode.pod [.lib.pods]perlunifaq.pod +pod21 = [.lib.pods]perlpacktut.pod [.lib.pods]perlperf.pod [.lib.pods]perlplan9.pod [.lib.pods]perlpod.pod [.lib.pods]perlpodspec.pod +pod22 = [.lib.pods]perlpolicy.pod [.lib.pods]perlport.pod [.lib.pods]perlpragma.pod [.lib.pods]perlqnx.pod [.lib.pods]perlre.pod [.lib.pods]perlreapi.pod +pod23 = [.lib.pods]perlrebackslash.pod [.lib.pods]perlrecharclass.pod [.lib.pods]perlref.pod [.lib.pods]perlreftut.pod [.lib.pods]perlreguts.pod +pod24 = [.lib.pods]perlrepository.pod [.lib.pods]perlrequick.pod [.lib.pods]perlreref.pod [.lib.pods]perlretut.pod [.lib.pods]perlriscos.pod +pod25 = [.lib.pods]perlrun.pod [.lib.pods]perlsec.pod [.lib.pods]perlsolaris.pod [.lib.pods]perlstyle.pod [.lib.pods]perlsub.pod [.lib.pods]perlsymbian.pod +pod26 = [.lib.pods]perlsyn.pod [.lib.pods]perlthrtut.pod [.lib.pods]perltie.pod [.lib.pods]perltoc.pod [.lib.pods]perltodo.pod [.lib.pods]perltooc.pod +pod27 = [.lib.pods]perltoot.pod [.lib.pods]perltrap.pod [.lib.pods]perltru64.pod [.lib.pods]perltw.pod [.lib.pods]perlunicode.pod [.lib.pods]perlunifaq.pod pod28 = [.lib.pods]perluniintro.pod [.lib.pods]perlunitut.pod [.lib.pods]perlutil.pod [.lib.pods]perluts.pod [.lib.pods]perlvar.pod [.lib.pods]perlvmesa.pod pod29 = [.lib.pods]perlvms.pod [.lib.pods]perlvos.pod [.lib.pods]perlwin32.pod [.lib.pods]perlxs.pod [.lib.pods]perlxstut.pod pod = $(pod0) $(pod1) $(pod2) $(pod3) $(pod4) $(pod5) $(pod6) $(pod7) $(pod8) $(pod9) $(pod10) $(pod11) $(pod12) $(pod13) $(pod14) $(pod15) $(pod16) $(pod17) $(pod18) $(pod19) $(pod20) $(pod21) $(pod ... [66 chars truncated] @@ -1202,6 +1202,10 @@ makeppport : $(MINIPERL_EXE) $(ARCHDIR)Config.pm nonxsext @ If F$Search("[.lib]pods.dir").eqs."" Then Create/Directory [.lib.pods] Copy/NoConfirm/Log $(MMS$SOURCE) [.lib.pods] +[.lib.pods]perlpolicy.pod : [.pod]perlpolicy.pod + @ If F$Search("[.lib]pods.dir").eqs."" Then Create/Directory [.lib.pods] + Copy/NoConfirm/Log $(MMS$SOURCE) [.lib.pods] + [.lib.pods]perlport.pod : [.pod]perlport.pod @ If F$Search("[.lib]pods.dir").eqs."" Then Create/Directory [.lib.pods] Copy/NoConfirm/Log $(MMS$SOURCE) [.lib.pods] diff --git a/win32/pod.mak b/win32/pod.mak index 15131b1..c1b407c 100644 --- a/win32/pod.mak +++ b/win32/pod.mak @@ -108,6 +108,7 @@ POD = \ perlperf.pod \ perlpod.pod \ perlpodspec.pod \ + perlpolicy.pod \ perlport.pod \ perlpragma.pod \ perlre.pod \ @@ -235,6 +236,7 @@ MAN = \ perlperf.man \ perlpod.man \ perlpodspec.man \ + perlpolicy.man \ perlport.man \ perlpragma.man \ perlre.man \ @@ -362,6 +364,7 @@ HTML = \ perlperf.html \ perlpod.html \ perlpodspec.html \ + perlpolicy.html \ perlport.html \ perlpragma.html \ perlre.html \ @@ -489,6 +492,7 @@ TEX = \ perlperf.tex \ perlpod.tex \ perlpodspec.tex \ + perlpolicy.tex \ perlport.tex \ perlpragma.tex \ perlre.tex \ -- Perl5 Master Repository
