X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=Porting%2Fpumpkin.pod;h=fb5c2d7a8e9787b446f0064badb826ee80c5da68;hb=e40b81a3dd247b1a29fc78399677b77b78b5f183;hp=a000108257cbb277ebdc45a89492baa1fc844df7;hpb=a042607511961b7f7852d92748b40c4e94e5cc75;p=p5sagit%2Fp5-mst-13.2.git diff --git a/Porting/pumpkin.pod b/Porting/pumpkin.pod index a000108..fb5c2d7 100644 --- a/Porting/pumpkin.pod +++ b/Porting/pumpkin.pod @@ -43,7 +43,7 @@ to perl5-porters-request@perl.org . Archives of the list are held at: - http://www.rosat.mpe-garching.mpg.de/mailing-lists/perl-porters/ + http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/ =head1 How are Perl Releases Numbered? @@ -103,7 +103,7 @@ always match the regular expression: C<$1> in the pattern is always an even number for maintenance versions, and odd for developer releases. -In the past it has been observed that pumkings tend to invent new +In the past it has been observed that pumpkings tend to invent new naming conventions on the fly. If you are a pumpking, before you invent a new name for any of the three types of perl distributions, please inform the guys from the CPAN who are doing indexing and @@ -159,6 +159,8 @@ settled elsewhere. If feasible, try to keep filenames 8.3-compliant to humor those poor souls that get joy from running Perl under such dire limitations. There's a script, check83.pl, for keeping your nose 8.3-clean. +In a similar vein, do not create files or directories which differ only +in case (upper versus lower). =head2 Seek consensus on major changes @@ -412,7 +414,6 @@ In all, the following files should probably be executable: keywords.pl myconfig opcode.pl - perly.fixer t/TEST t/*/*.t *.SH @@ -454,7 +455,7 @@ This is to ease maintenance. When Configure gets updated, the parts sometimes get scrambled around, and the changes in config_H can sometimes be very hard to follow. config.sh, on the other hand, can safely be sorted, so it's easy to track (typically very small) changes -to config.sh and then propoagate them to a canned 'config.h' by any +to config.sh and then propagate them to a canned 'config.h' by any number of means, including a perl script in win32/ or carrying config.sh and config_h.SH to a Unix system and running sh config_h.SH.) Vms uses configure.com to generate its own config.sh @@ -476,53 +477,27 @@ you are not familiar with those systems. You might want to issue your patch with a promise to quickly issue a follow-up that handles those directories. -=head2 make run_byacc +=head2 make regen_perly -If you have byacc-1.8.2 (available from CPAN), and if there have been -changes to F, you can regenerate the F file. The -run_byacc makefile target does this by running byacc and then applying -some patches so that byacc dynamically allocates space, rather than -having fixed limits. This patch is handled by the F -script. Depending on the nature of the changes to F, you may -or may not have to hand-edit the patch to apply correctly. If you do, -you should include the edited patch in the new distribution. If you -have byacc-1.9, the patch won't apply cleanly. Changes to the printf -output statements mean the patch won't apply cleanly. Long ago I -started to fix F to detect this, but I never completed the -task. +If perly.y has been edited, it is necessary to run this target to rebuild +perly.h, perly.act and perly.tab. In fact this target just runs the Perl +script regen_perly.pl. Note that perly.c is I rebuilt; this is just a +plain static file now. -If C or C changes, make sure you run C -to update the corresponding VMS files. This could be taken care of by -the regen_all target in the Unix Makefile. See also -L. +This target relies on you having Bison installed on your system. Running +the target will tell you if you haven't got the right version, and if so, +where to get the right one. Or if you prefer, you could hack +regen_perly.pl to work with your version of Bison. The important things +are that the regexes can still extract out the right chunks of the Bison +output into perly.act and perly.tab, and that the contents of those two +files, plus perly.h, are functionally equivalent to those produced by the +supported version of Bison. -Some additional notes from Larry on this: - -Don't forget to regenerate perly_c.diff. - - byacc -d perly.y - mv y.tab.c perly.c - patch perly.c perly_c.diff - -One chunk of lines that often fails begins with - - #line 29 "perly.y" - -and ends one line before - - #define YYERRCODE 256 - -This only happens when you add or remove a token type. I suppose this -could be automated, but it doesn't happen very often nowadays. - -Larry +Note that in the old days, you had to do C instead. =head2 make regen_all -This target takes care of the PERLYVMS, regen_headers, and regen_pods -targets. +This target takes care of the regen_headers, and regen_pods targets. =head2 make regen_headers @@ -572,6 +547,19 @@ about them first. If possible, we should provide backwards-compatibility stubs. There's a lot of XS code out there. Let's not force people to keep changing it. +=head2 PPPort + +F needs to be synchronized to include all +new macros added to .h files (normally perl.h and XSUB.h, but others +as well). Since chances are that when a new macro is added the +committer will forget to update F, it's the best to diff for +changes in .h files when making a new release and making sure that +F contains them all. + +The pumpking can delegate the synchronization responsibility to anybody +else, but the release process is the only place where we can make sure +that no new macros fell through the cracks. + =head2 Changes Be sure to update the F file. Try to include both an overall @@ -590,19 +578,19 @@ to change the version number near the top of the F file. =head2 Todo -The F file contains a roughly-catgorized unordered list of -aspects of Perl that could use enhancement, features that could be -added, areas that could be cleaned up, and so on. During your term as -pumpkin-holder, you will probably address some of these issues, and -perhaps identify others which, while you decide not to address them -this time around, may be tackled in the future. Update the file -reflect the situation as it stands when you hand over the pumpkin. +The F file contains a roughly-categorized unordered +list of aspects of Perl that could use enhancement, features that could +be added, areas that could be cleaned up, and so on. During your term +as pumpkin-holder, you will probably address some of these issues, and +perhaps identify others which, while you decide not to address them this +time around, may be tackled in the future. Update the file to reflect +the situation as it stands when you hand over the pumpkin. You might like, early in your pumpkin-holding career, to see if you -can find champions for partiticular issues on the to-do list: an issue +can find champions for particular issues on the to-do list: an issue owned is an issue more likely to be resolved. -There are also some more porting-specific L items later in this +There are also some more porting-specific L items later in this file. =head2 OS/2-specific updates @@ -617,10 +605,6 @@ things that need to be fixed in Configure. =head2 VMS-specific updates -If you have changed F or F, then you most probably want -to update F by running C, or -by running `make regen_all` which will run that script for you. - The Perl revision number appears as "perl5" in configure.com. It is courteous to update that if necessary. @@ -729,46 +713,6 @@ branches. =over 4 -=item CHECK_FORMAT - -To test the correct use of printf-style arguments, C with -S<-Dccflags='-DCHECK_FORMAT -Wformat'> and run C. The compiler -will produce warning of incorrect use of format arguments. CHECK_FORMAT -changes perl-defined formats to common formats, so DO NOT USE the executable -produced by this process. - -A more accurate approach is the following commands: - -=over 4 - -=item * - -build miniperl with -DCHECK_FORMAT - - make clean - make miniperl OPTIMIZE=-DCHECK_FORMAT >& mini.log - -=item * - -build a clean miniperl, -and build everything else from that with -DCHECK_FORMAT - - make clean - make miniperl - make all OPTIMIZE='-DCHECK_FORMAT -Wformat' >& make.log - -=item * - -clean up, and print warnings from the log files - - make clean - perl -nwe 'print if /^\S+:/ and not /^make\b/' \ - mini.log make.log - -=back - -(-Wformat support by Robin Barker.) - =item gcc -ansi -pedantic Configure -Dgccansipedantic [ -Dcc=gcc ] will enable (via the cflags script, @@ -849,42 +793,10 @@ The only currently known leaks happen when there are compile-time errors within eval or require. (Fixing these is non-trivial, unfortunately, but they must be fixed eventually.) -=head1 Common Gotcha's +=head1 Common Gotchas =over 4 -=item #elif - -The '#elif' preprocessor directive is not understood on all systems. -Specifically, I know that Pyramids don't understand it. Thus instead of the -simple - - #if defined(I_FOO) - # include - #elif defined(I_BAR) - # include - #else - # include - #endif - -You have to do the more Byzantine - - #if defined(I_FOO) - # include - #else - # if defined(I_BAR) - # include - # else - # include - # endif - #endif - -Incidentally, whitespace between the leading '#' and the preprocessor -command is not guaranteed, but is very portable and you may use it freely. -I think it makes things a bit more readable, especially once things get -rather deeply nested. I also think that things should almost never get -too deeply nested, so it ought to be a moot point :-) - =item Probably Prefer POSIX It's often the case that you'll need to choose whether to do @@ -1258,12 +1170,18 @@ a mail message from Larry: probably have been named something to do with overriding though. Since it's undocumented we could still change it... :-) -Given that it's already there, you can use it to override -distribution modules. If you do +Given that it's already there, you can use it to override distribution modules. +One way to do that is to add - sh Configure -Dccflags='-DAPPLLIB_EXP=/my/override' + ccflags="$ccflags -DAPPLLIB_EXP=\"/my/override\"" + +to your config.over file. (You have to be particularly careful to get the +double quotes in. APPLLIB_EXP must be a valid C string. It might +actually be easier to just #define it yourself in perl.c.) -then perl.c will put /my/override ahead of ARCHLIB and PRIVLIB. +Then perl.c will put /my/override ahead of ARCHLIB and PRIVLIB. Perl will +also search architecture-specific and version-specific subdirectories of +APPLLIB_EXP. =head2 Shared libperl.so location @@ -1319,9 +1237,11 @@ Anyway, all this leads to quite obscure failures that are sure to drive casual users crazy. Even experienced users will get confused :-). Upon reflection, I'd say leave libperl.so in $archlib. -=item 4. +=back -Indentation style: over the years Perl has become a mishmash of +=head2 Indentation style + +Over the years Perl has become a mishmash of various indentation styles, but the original "Larry style" can probably be restored with (GNU) indent somewhat like this: @@ -1334,8 +1254,6 @@ of consecutive assignments, which would truly wreck the layout in places like sv.c:Perl_sv_upgrade() or sv.c:Perl_clone_using(). Similarly nicely aligned &&s, ||s and ==s would not be respected. -=back - =head1 Upload Your Work to CPAN You can upload your work to CPAN if you have a CPAN id. Check out @@ -1548,9 +1466,80 @@ in recent config.sh files though. =back +=head2 Copyright Issues + +The following is based on the consensus of a couple of IPR lawyers, +but it is of course not a legally binding statement, just a common +sense summary. + +=over 4 + +=item * + +Tacking on copyright statements is unnecessary to begin with because +of the Berne convention. But assuming you want to go ahead... + +=item * + +The right form of a copyright statement is + + Copyright (C) Year, Year, ... by Someone + +The (C) is not required everywhere but it doesn't hurt and in certain +jurisdictions it is required, so let's leave it in. (Yes, it's true +that in some jurisdictions the "(C)" is not legally binding, one should +use the true ringed-C. But we don't have that character available for +Perl's source code.) + +The years must be listed out separately. Year-Year is not correct. +Only the years when the piece has changed 'significantly' may be added. + +=item * + +One cannot give away one's copyright trivially. One can give one's +copyright away by using public domain, but even that requires a little +bit more than just saying 'this is in public domain'. (What it +exactly requires depends on your jurisdiction.) But barring public +domain, one cannot "transfer" one's copyright to another person or +entity. In the context of software, it means that contributors cannot +give away their copyright or "transfer" it to the "owner" of the software. + +Also remember that in many cases if you are employed by someone, +your work may be copyrighted to your employer, even when you are +contributing on your own time (this all depends on too many things +to list here). But the bottom line is that you definitely can't give +away a copyright you may not even have. + +What is possible, however, is that the software can simply state + + Copyright (C) Year, Year, ... by Someone and others + +and then list the "others" somewhere in the distribution. +And this is exactly what Perl does. (The "somewhere" is +AUTHORS and the Changes* files.) + +=item * + +Split files, merged files, and generated files are problematic. +The rule of thumb: in split files, copy the copyright years of +the original file to all the new files; in merged files make +an union of the copyright years of all the old files; in generated +files propagate the copyright years of the generating file(s). + +=item * + +The files of Perl source code distribution do carry a lot of +copyrights, by various people. (There are many copyrights embedded in +perl.c, for example.) The most straightforward thing for pumpkings to +do is to simply update Larry's copyrights at the beginning of the +*.[hcy], x2p/*.[hcy], *.pl, and README files, and leave all other +copyrights alone. Doing more than that requires quite a bit of tracking. + +=back + =head1 AUTHORS -Original author: Andy Dougherty doughera@lafcol.lafayette.edu . +Original author: Andy Dougherty doughera@lafayette.edu . Additions by Chip Salzenberg chip@perl.com and Tim Bunce Tim.Bunce@ig.co.uk .