X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=Porting%2Fpumpkin.pod;h=f0f58000b3c07350a56c25efe1c4d3a72320586e;hb=2a0de2c52ab4e8b4f51332a0e1eaae4b8cff3f48;hp=aa52845be4e9923837a2264ab4af3df79b4daaff;hpb=0de566d74fdaf0a49123989fe8d4ad06603c6608;p=p5sagit%2Fp5-mst-13.2.git diff --git a/Porting/pumpkin.pod b/Porting/pumpkin.pod index aa52845..f0f5800 100644 --- a/Porting/pumpkin.pod +++ b/Porting/pumpkin.pod @@ -364,17 +364,25 @@ change the appropriate metaconfig units instead, and regenerate Configure. will regenerate Configure and config_h.SH. Much more information on obtaining and running metaconfig is in the F file -that comes with Perl's metaconfig units. Perl's metaconfig units -should be available on CPAN. A set of units that will work with -perl5.005 is in the file F under -http://www.cpan.org/authors/id/ANDYD/ . The mc_units tar file -should be unpacked in your main perl source directory. Note: those -units were for use with 5.005. There may have been changes since then. -Check for later versions or contact perl5-porters@perl.org to obtain a +that comes with Perl's metaconfig units. + +Since metaconfig is hard to change, running correction scripts after +this generation is sometimes needed. Configure gained complexity over +time, and the order in which config_h.SH is generated can cause havoc +when compiling perl. Therefor, you need to run Porting/config_h.pl +after that generation. All that and more is described in the README +files that come with the metaunits. + +Perl's metaconfig units should be available on CPAN. A set of units +that will work with perl5.9.x is in a file with a name similar to +F under http://www.cpan.org/authors/id/H/HM/HMBRAND/ . +The mc_units tar file should be unpacked in your main perl source directory. +Note: those units were for use with 5.9.x. There may have been changes since +then. Check for later versions or contact perl5-porters@perl.org to obtain a pointer to the current version. -Alternatively, do consider if the F<*ish.h> files might be a better -place for your changes. +Alternatively, do consider if the F<*ish.h> files or the hint files might be +a better place for your changes. =head2 MANIFEST @@ -455,7 +463,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 @@ -479,9 +487,9 @@ directories. =head2 make regen_perly -If perly.y has been edited, it is nessary to run this target to rebuild -perly.h, perl.act and perl.tab. In fact this target just runs the Perl -script regen_perly.pl. Note that perl.c is I rebuilt; this is just a +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. This target relies on you having Bison installed on your system. Running @@ -489,7 +497,7 @@ 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 perl.tab, and that the contents of those two +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. @@ -576,6 +584,15 @@ detailed descriptions ought to be easily available somewhere. If you update the subversion number in F, you may need to change the version number near the top of the F file. +=head2 Bumping perl's version + +If you bump perl's version, you will need to update a few things: +the L manpage for the date of release, the version number and +perldelta reference in the top level F (and maybe the copyright +year too), the F file (generated via F, be +sure to run it with the current bleadperl), and the meta-info about +dual-lived modules in Module::Corelist (F does that). + =head2 Todo The F file contains a roughly-categorized unordered @@ -587,7 +604,7 @@ 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 @@ -713,48 +730,6 @@ branches. =over 4 -=item CHECK_FORMAT - -If you have gcc, you can test the correct use of printf-style -arguments. Run C with S<-Dccflags='-DCHECK_FORMAT --Wformat'> (and S<-Dcc=gcc>, if you are not on a system where C -is C) and run C. The compiler will produce warnings 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, @@ -835,42 +810,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 @@ -1621,4 +1564,5 @@ All opinions expressed herein are those of the authorZ<>(s). =head1 LAST MODIFIED +27-04-2007 H.Merijn Brand $Id: pumpkin.pod,v 1.23 2000/01/13 19:45:13 doughera Released $