This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Metaconfig and Porting patches from Andy; start using the new
[perl5.git] / Porting / pumpkin.pod
1 =head1 NAME
2
3 Pumpkin - Notes on handling the Perl Patch Pumpkin
4
5 =head1 SYNOPSIS
6
7 There is no simple synopsis, yet.
8
9 =head1 DESCRIPTION
10
11 This document attempts to begin to describe some of the considerations
12 involved in patching, porting, and maintaining perl.
13
14 This document is still under construction, and still subject to
15 significant changes.  Still, I hope parts of it will be useful,
16 so I'm releasing it even though it's not done.
17
18 For the most part, it's a collection of anecdotal information that
19 already assumes some familiarity with the Perl sources.  I really need
20 an introductory section that describes the organization of the sources
21 and all the various auxiliary files that are part of the distribution.
22
23 =head1 Where Do I Get Perl Sources and Related Material?
24
25 The Comprehensive Perl Archive Network (or CPAN) is the place to go.
26 There are many mirrors, but the easiest thing to use is probably
27 http://www.perl.com/CPAN/README.html , which automatically points you to a
28 mirror site "close" to you.
29
30 =head2 Perl5-porters mailing list
31
32 The mailing list perl5-porters@perl.org
33 is the main group working with the development of perl.  If you're
34 interested in all the latest developments, you should definitely
35 subscribe.  The list is high volume, but generally has a
36 fairly low noise level.
37
38 Subscribe by sending the message (in the body of your letter)
39
40         subscribe perl5-porters
41
42 to perl5-porters-request@perl.org .
43
44 Archives of the list are held at:
45
46     http://www.rosat.mpe-garching.mpg.de/mailing-lists/perl-porters/
47
48 =head1 How are Perl Releases Numbered?
49
50 Perl version numbers are floating point numbers, such as 5.004.
51 (Observations about the imprecision of floating point numbers for
52 representing reality probably have more relevance than you might
53 imagine :-) The major version number is 5 and the '004' is the
54 patchlevel.  (Questions such as whether or not '004' is really a minor
55 version number can safely be ignored.:)
56
57 The version number is available as the magic variable $],
58 and can be used in comparisons, e.g.
59
60         print "You've got an old perl\n" if $] < 5.002;
61
62 You can also require particular version (or later) with
63
64         use 5.002;
65
66 At some point in the future, we may need to decide what to call the
67 next big revision.  In the .package file used by metaconfig to
68 generate Configure, there are two variables that might be relevant:
69 $baserev=5.0 and $package=perl5.   At various times, I have suggested
70 we might change them to $baserev=5.1 and $package=perl5.1 if want
71 to signify a fairly major update.  Or, we might want to jump to perl6.
72 Let's worry about that problem when we get there.
73
74 =head2 Subversions
75
76 In addition, there usually are sub-versions available. Sub-versions
77 are numbered with sub-version numbers. For example, version 5.003_04
78 is the 4'th developer version built on top of 5.003. It might include
79 the _01, _02, and _03 changes, but it also might not. Sub-versions are
80 allowed to be subversive. (But see the next section for recent
81 changes.)
82
83 These sub-versions can also be used as floating point numbers, so
84 you can do things such as
85
86         print "You've got an unstable perl\n" if $] == 5.00303;
87
88 You can also require particular version (or later) with
89
90         use 5.003_03;    # the "_" is optional
91
92 Sub-versions produced by the members of perl5-porters are usually
93 available on CPAN in the F<src/5.0/maint> and F<src/5.0/devel>
94 directories.
95
96 =head2 Maintenance and Development Subversions
97
98 Starting with version 5.004, subversions _01 through _49 are reserved
99 for bug-fix maintenance releases, and subversions _50 through _99 for
100 unstable development versions.
101
102 The separate bug-fix track is being established to allow us an easy
103 way to distribute important bug fixes without waiting for the
104 developers to untangle all the other problems in the current
105 developer's release. The first rule of maintenance work is "First, do
106 no harm."
107
108 Trial releases of bug-fix maintenance releases are announced on
109 perl5-porters. Trial releases use the new subversion number (to avoid
110 testers installing it over the previous release) and include a 'local
111 patch' entry in patchlevel.h. The distribution file contains the
112 string C<MAINT_TRIAL> to make clear that the file is not meant for
113 public consumption.
114
115 In general, the names of official distribution files for the public
116 always match the regular expression
117
118     ^perl5\.\d{3}(_[0-4]\d)?\.tar\.gz$
119
120 Developer releases always match
121
122     ^perl5\.\d{3}(_[5-9]\d)?\.tar\.gz$
123
124 And the trial versions for a new maintainance release match
125
126     ^perl5\.\d{3}(_[0-4]\d)-MAINT_TRIAL_\d+\.tar\.gz$
127
128 In the past it has been observed that pumkings tend to invent new
129 naming conventions on the fly. If you are a pumpking, before you
130 invent a new name for any of the three types of perl distributions,
131 please inform the guys from the CPAN who are doing indexing and
132 provide the trees of symlinks and the like. They will have to know
133 I<in advance> what you decide.
134
135 =head2 Why such a complicated scheme?
136
137 Two reasons, really.  At least.
138
139 First, we need some way to identify and release collections of patches
140 that are known to have new features that need testing and exploration.  The
141 subversion scheme does that nicely while fitting into the
142 C<use 5.004;> mold.
143
144 Second, since most of the folks who help maintain perl do so on a
145 free-time voluntary basis, perl development does not proceed at a
146 precise pace, though it always seems to be moving ahead quickly.
147 We needed some way to pass around the "patch pumpkin" to allow
148 different people chances to work on different aspects of the
149 distribution without getting in each other's way.  It wouldn't be
150 constructive to have multiple people working on incompatible
151 implementations of the same idea.  Instead what was needed was
152 some kind of "baton" or "token" to pass around so everyone knew
153 whose turn was next.
154
155 =head2 Why is it called the patch pumpkin?
156
157 Chip Salzenberg gets credit for that, with a nod to his cow orker,
158 David Croy.  We had passed around various names (baton, token, hot
159 potato) but none caught on.  Then, Chip asked:
160
161 [begin quote]
162
163    Who has the patch pumpkin?
164
165 To explain:  David Croy once told me once that at a previous job,
166 there was one tape drive and multiple systems that used it for backups.
167 But instead of some high-tech exclusion software, they used a low-tech
168 method to prevent multiple simultaneous backups: a stuffed pumpkin.
169 No one was allowed to make backups unless they had the "backup pumpkin".
170
171 [end quote]
172
173 The name has stuck.
174
175 =head1 Philosophical Issues in Patching and Porting Perl
176
177 There are no absolute rules, but there are some general guidelines I
178 have tried to follow as I apply patches to the perl sources.
179 (This section is still under construction.)
180
181 =head2 Solve problems as generally as possible
182
183 Never implement a specific restricted solution to a problem when you
184 can solve the same problem in a more general, flexible way.
185
186 For example, for dynamic loading to work on some SVR4 systems, we had
187 to build a shared libperl.so library.  In order to build "FAT" binaries
188 on NeXT 4.0 systems, we had to build a special libperl library.  Rather
189 than continuing to build a contorted nest of special cases, I
190 generalized the process of building libperl so that NeXT and SVR4 users
191 could still get their work done, but others could build a shared
192 libperl if they wanted to as well.
193
194 Contain your changes carefully.  Assume nothing about other operating
195 systems, not even closely related ones.  Your changes must not affect
196 other platforms.
197
198 Spy shamelessly on how similar patching or porting issues have been
199 settled elsewhere.
200
201 If feasible, try to keep filenames 8.3-compliant to humor those poor
202 souls that get joy from running Perl under such dire limitations.
203
204 =head2 Seek consensus on major changes
205
206 If you are making big changes, don't do it in secret.  Discuss the
207 ideas in advance on perl5-porters.
208
209 =head2 Keep the documentation up-to-date
210
211 If your changes may affect how users use perl, then check to be sure
212 that the documentation is in sync with your changes.  Be sure to
213 check all the files F<pod/*.pod> and also the F<INSTALL> document.
214
215 Consider writing the appropriate documentation first and then
216 implementing your change to correspond to the documentation.
217
218 =head2 Avoid machine-specific #ifdef's
219
220 To the extent reasonable, try to avoid machine-specific #ifdef's in
221 the sources.  Instead, use feature-specific #ifdef's.  The reason is
222 that the machine-specific #ifdef's may not be valid across major
223 releases of the operating system.  Further, the feature-specific tests
224 may help out folks on another platform who have the same problem.
225
226 =head2 Machine-specific files
227
228 =over 4
229
230 =item source code
231
232 If you have many machine-specific #defines or #includes, consider
233 creating an "osish.h" (os2ish.h, vmsish.h, and so on) and including
234 that in perl.h.  If you have several machine-specific files (function
235 emulations, function stubs, build utility wrappers) you may create a
236 separate subdirectory (djgpp, win32) and put the files in there.
237 Remember to update C<MANIFEST> when you add files.
238
239 If your system supports dynamic loading but none of the existing
240 methods at F<ext/DynaLoader/dl_*.xs> work for you, you must write
241 a new one.  Study the existing ones to see what kind of interface
242 you must supply.
243
244 =item build hints
245
246 There are two kinds of hints: hints for building Perl and hints for
247 extensions.   The former live in the C<hints> subdirectory, the latter
248 in C<ext/*/hints> subdirectories.
249
250 The top level hints are Bourne-shell scripts that set, modify and
251 unset appropriate Configure variables, based on the Configure command
252 line options and possibly existing config.sh and Policy.sh files from
253 previous Configure runs.
254
255 The extension hints are written Perl (by the time they are used
256 miniperl has been built) and control the building of their respective
257 extensions.  They can be used to for example manipulate compilation
258 and linking flags.
259
260 =item build and installation Makefiles, scripts, and so forth
261
262 Sometimes you will also need to tweak the Perl build and installation
263 procedure itself, like for example F<Makefile.SH> and F<installperl>.
264 Tread very carefully, even more than usual.  Contain your changes
265 with utmost care.
266
267 =item test suite
268
269 Many of the tests in C<t> subdirectory assume machine-specific things
270 like existence of certain functions, something about filesystem
271 semantics, certain external utilities and their error messages.  Use
272 the C<$^O> and the C<Config> module (which contains the results of the
273 Configure run, in effect the C<config.sh> converted to Perl) to either
274 skip (preferably not) or customize (preferable) the tests for your
275 platform.
276
277 =item modules
278
279 Certain standard modules may need updating if your operating system
280 sports for example a native filesystem naming.  You may want to update
281 some or all of the modules File::Basename, File::Spec, File::Path, and
282 File::Copy to become aware of your native filesystem syntax and
283 peculiarities.
284
285 =item documentation
286
287 If your operating system comes from outside UNIX you almost certainly
288 will have differences in the available operating system functionality
289 (missing system calls, different semantics, whatever).  Please
290 document these at F<pod/perlport.pod>.  If your operating system is
291 the first B<not> to have a system call also update the list of
292 "portability-bewares" at the beginning of F<pod/perlfunc.pod>.
293
294 A file called F<README.youros> at the top level that explains things
295 like how to install perl at this platform, where to get any possibly
296 required additional software, and for example what test suite errors
297 to expect, is nice too.
298
299 You may also want to write a separate F<.pod> file for your operating
300 system to tell about existing mailing lists, os-specific modules,
301 documentation, whatever.  Please name these along the lines of
302 F<perl>I<youros>.pod.  [unfinished: where to put this file (the pod/
303 subdirectory, of course: but more importantly, which/what index files
304 should be updated?)]
305
306 =back
307
308 =head2 Allow for lots of testing
309
310 We should never release a main version without testing it as a
311 subversion first.
312
313 =head2 Test popular applications and modules.
314
315 We should never release a main version without testing whether or not
316 it breaks various popular modules and applications.  A partial list of
317 such things would include majordomo, metaconfig, apache, Tk, CGI,
318 libnet, and libwww, to name just a few.  Of course it's quite possible
319 that some of those things will be just plain broken and need to be fixed,
320 but, in general, we ought to try to avoid breaking widely-installed
321 things.
322
323 =head2 Automated generation of derivative files
324
325 The F<embed.h>, F<keywords.h>, F<opcode.h>, and F<perltoc.pod> files
326 are all automatically generated by perl scripts.  In general, don't
327 patch these directly; patch the data files instead.
328
329 F<Configure> and F<config_h.SH> are also automatically generated by
330 B<metaconfig>.  In general, you should patch the metaconfig units
331 instead of patching these files directly.  However, very minor changes
332 to F<Configure> may be made in between major sync-ups with the
333 metaconfig units, which tends to be complicated operations.  But be
334 careful, this can quickly spiral out of control.  Running metaconfig
335 is not really hard.
336
337 Also F<Makefile> is automatically produced from F<Makefile.SH>.
338 In general, look out for all F<*.SH> files.
339
340 Finally, the sample files in the F<Porting/> subdirectory are
341 generated automatically by the script F<U/mksample> included 
342 with the metaconfig units.  See L<"run metaconfig"> below for
343 information on obtaining the metaconfig units.
344
345 =head1 How to Make a Distribution
346
347 There really ought to be a 'make dist' target, but there isn't.
348 The 'dist' suite of tools also contains a number of tools that I haven't
349 learned how to use yet.  Some of them may make this all a bit easier.
350
351 Here are the steps I go through to prepare a patch & distribution.
352
353 Lots of it could doubtless be automated but isn't.  The Porting/makerel
354 (make release) perl script does now help automate some parts of it.
355
356 =head2 Announce your intentions
357
358 First, you should volunteer out loud to take the patch pumpkin.  It's
359 generally counter-productive to have multiple people working in secret
360 on the same thing.
361
362 At the same time, announce what you plan to do with the patch pumpkin,
363 to allow folks a chance to object or suggest alternatives, or do it for
364 you.  Naturally, the patch pumpkin holder ought to incorporate various
365 bug fixes and documentation improvements that are posted while he or
366 she has the pumpkin, but there might also be larger issues at stake.
367
368 One of the precepts of the subversion idea is that we shouldn't give
369 the patch pumpkin to anyone unless we have some idea what he or she
370 is going to do with it.
371
372 =head2 refresh pod/perltoc.pod
373
374 Presumably, you have done a full C<make> in your working source
375 directory.  Before you C<make spotless> (if you do), and if you have
376 changed any documentation in any module or pod file, change to the
377 F<pod> directory and run C<make toc>.
378
379 =head2 run installhtml to check the validity of the pod files
380
381 =head2 update patchlevel.h
382
383 Don't be shy about using the subversion number, even for a relatively
384 modest patch.  We've never even come close to using all 99 subversions,
385 and it's better to have a distinctive number for your patch.  If you
386 need feedback on your patch, go ahead and issue it and promise to
387 incorporate that feedback quickly (e.g. within 1 week) and send out a
388 second patch.
389
390 =head2 run metaconfig
391
392 If you need to make changes to Configure or config_h.SH, it may be best to
393 change the appropriate metaconfig units instead, and regenerate Configure.
394
395         metaconfig -m
396
397 will regenerate Configure and config_h.SH.  Much more information
398 on obtaining and running metaconfig is in the F<U/README> file
399 that comes with Perl's metaconfig units.  Perl's metaconfig units
400 should be available on CPAN.  A set of units that will work with
401 perl5.005 is in the file F<mc_units-5.005_00-01.tar.gz> under
402 http://www.perl.com/CPAN/authors/id/ANDYD/ .  The mc_units tar file
403 should be unpacked in your main perl source directory.  Note: those
404 units were for use with 5.005.  There may have been changes since then.
405 Check for later versions or contact perl5-porters@perl.org to obtain a
406 pointer to the current version.
407
408 Alternatively, do consider if the F<*ish.h> files might be a better
409 place for your changes.
410
411 =head2 MANIFEST
412
413 Make sure the MANIFEST is up-to-date.  You can use dist's B<manicheck>
414 program for this.  You can also use
415
416     perl -w -MExtUtils::Manifest=fullcheck -e fullcheck
417
418 Both commands will also list extra files in the directory that are not
419 listed in MANIFEST.
420
421 The MANIFEST is normally sorted.
422
423 If you are using metaconfig to regenerate Configure, then you should note
424 that metaconfig actually uses MANIFEST.new, so you want to be sure
425 MANIFEST.new is up-to-date too.  I haven't found the MANIFEST/MANIFEST.new
426 distinction particularly useful, but that's probably because I still haven't
427 learned how to use the full suite of tools in the dist distribution.
428
429 =head2 Check permissions
430
431 All the tests in the t/ directory ought to be executable.  The
432 main makefile used to do a 'chmod t/*/*.t', but that resulted in
433 a self-modifying distribution--something some users would strongly
434 prefer to avoid.  The F<t/TEST> script will check for this
435 and do the chmod if needed, but the tests still ought to be
436 executable.
437
438 In all, the following files should probably be executable:
439
440     Configure
441     configpm
442     configure.gnu
443     embed.pl
444     installperl
445     installman
446     keywords.pl
447     myconfig
448     opcode.pl
449     perly.fixer
450     t/TEST
451     t/*/*.t
452     *.SH
453     vms/ext/Stdio/test.pl
454     vms/ext/filespec.t
455     x2p/*.SH
456
457 Other things ought to be readable, at least :-).
458
459 Probably, the permissions for the files could be encoded in MANIFEST
460 somehow, but I'm reluctant to change MANIFEST itself because that
461 could break old scripts that use MANIFEST.
462
463 I seem to recall that some SVR3 systems kept some sort of file that listed
464 permissions for system files; something like that might be appropriate.
465
466 =head2 Run Configure
467
468 This will build a config.sh and config.h.  You can skip this if you haven't
469 changed Configure or config_h.SH at all.  I use the following command
470
471     sh Configure -Dprefix=/opt/perl -Doptimize=-O -Dusethreads \
472         -Dcf_by='yourname' \
473         -Dcf_email='yourname@yourhost.yourplace.com' \
474         -Dperladmin='yourname@yourhost.yourplace.com' \
475         -Dmydomain='.yourplace.com' \
476         -Dmyhostname='yourhost' \
477         -des
478
479 =head2 Update Porting/config.sh and Porting/config_H
480
481 [XXX 
482 This section needs revision.  We're currently working on easing
483 the task of keeping the vms, win32, and plan9 config.sh info
484 up-to-date.  The plan is to use keep up-to-date 'canned' config.sh
485 files in the appropriate subdirectories and then generate 'canned'
486 config.h files for vms, win32, etc. from the generic config.sh file.
487 This is to ease maintenance.  When Configure gets updated, the parts
488 sometimes get scrambled around, and the changes in config_H can
489 sometimes be very hard to follow.  config.sh, on the other hand, can
490 safely be sorted, so it's easy to track (typically very small) changes
491 to config.sh and then propoagate them to a canned 'config.h' by any
492 number of means, including a perl script in win32/ or carrying 
493 config.sh and config_h.SH to a Unix system and running sh
494 config_h.SH.)
495 XXX]
496
497 The Porting/config.sh and Porting/config_H files are provided to
498 help those folks who can't run Configure.  It is important to keep
499 them up-to-date.  If you have changed config_h.SH, those changes must
500 be reflected in config_H as well.  (The name config_H was chosen to
501 distinguish the file from config.h even on case-insensitive file systems.)
502 Simply edit the existing config_H file; keep the first few explanatory
503 lines and then copy your new config.h below.
504
505 It may also be necessary to update win32/config.?c, vms/config.vms and
506 plan9/config.plan9, though you should be quite careful in doing so if
507 you are not familiar with those systems.  You might want to issue your
508 patch with a promise to quickly issue a follow-up that handles those
509 directories.
510
511 =head2 make run_byacc
512
513 If you have byacc-1.8.2 (available from CPAN), and if there have been
514 changes to F<perly.y>, you can regenerate the F<perly.c> file.  The
515 run_byacc makefile target does this by running byacc and then applying
516 some patches so that byacc dynamically allocates space, rather than
517 having fixed limits.  This patch is handled by the F<perly.fixer>
518 script.  Depending on the nature of the changes to F<perly.y>, you may
519 or may not have to hand-edit the patch to apply correctly.  If you do,
520 you should include the edited patch in the new distribution.  If you
521 have byacc-1.9, the patch won't apply cleanly.  Changes to the printf
522 output statements mean the patch won't apply cleanly.  Long ago I
523 started to fix F<perly.fixer> to detect this, but I never completed the
524 task.
525
526 If C<perly.c> changes, make sure you run C<perl vms/vms_yfix.pl> to
527 update the corresponding VMS files.  See L<VMS-specific updates>.
528
529 Some additional notes from Larry on this:
530
531 Don't forget to regenerate perly_c.diff.
532
533     byacc -d perly.y
534     mv y.tab.c perly.c
535     patch perly.c <perly_c.diff
536     # manually apply any failed hunks
537     diff -c2 perly.c.orig perly.c >perly_c.diff
538
539 One chunk of lines that often fails begins with
540
541     #line 29 "perly.y"
542
543 and ends one line before
544
545     #define YYERRCODE 256
546
547 This only happens when you add or remove a token type.  I suppose this
548 could be automated, but it doesn't happen very often nowadays.
549
550 Larry
551
552 =head2 make regen_headers
553
554 The F<embed.h>, F<keywords.h>, and F<opcode.h> files are all automatically
555 generated by perl scripts.  Since the user isn't guaranteed to have a
556 working perl, we can't require the user to generate them.  Hence you have
557 to, if you're making a distribution.
558
559 I used to include rules like the following in the makefile:
560
561     # The following three header files are generated automatically
562     # The correct versions should be already supplied with the perl kit,
563     # in case you don't have perl or 'sh' available.
564     # The - is to ignore error return codes in case you have the source
565     # installed read-only or you don't have perl yet.
566     keywords.h: keywords.pl
567             @echo "Don't worry if this fails."
568             - perl keywords.pl
569
570
571 However, I got B<lots> of mail consisting of people worrying because the
572 command failed.  I eventually decided that I would save myself time
573 and effort by manually running C<make regen_headers> myself rather
574 than answering all the questions and complaints about the failing
575 command.
576
577 =head2 global.sym, interp.sym and perlio.sym
578
579 Make sure these files are up-to-date.  Read the comments in these
580 files and in perl_exp.SH to see what to do.
581
582 =head2 Binary compatibility
583
584 If you do change F<global.sym> or F<interp.sym>, think carefully about
585 what you are doing.  To the extent reasonable, we'd like to maintain
586 souce and binary compatibility with older releases of perl.  That way,
587 extensions built under one version of perl will continue to work with
588 new versions of perl.
589
590 Of course, some incompatible changes may well be necessary.  I'm just
591 suggesting that we not make any such changes without thinking carefully
592 about them first.  If possible, we should provide
593 backwards-compatibility stubs.  There's a lot of XS code out there.
594 Let's not force people to keep changing it.
595
596 =head2 Changes
597
598 Be sure to update the F<Changes> file.  Try to include both an overall
599 summary as well as detailed descriptions of the changes.  Your
600 audience will include other developers and users, so describe
601 user-visible changes (if any) in terms they will understand, not in
602 code like "initialize foo variable in bar function".
603
604 There are differing opinions on whether the detailed descriptions
605 ought to go in the Changes file or whether they ought to be available
606 separately in the patch file (or both).  There is no disagreement that
607 detailed descriptions ought to be easily available somewhere.
608
609 =head2 Todo
610
611 The F<Todo> file contains a roughly-catgorized unordered list of
612 aspects of Perl that could use enhancement, features that could be
613 added, areas that could be cleaned up, and so on.  During your term as
614 pumpkin-holder, you will probably address some of these issues, and
615 perhaps identify others which, while you decide not to address them
616 this time around, may be tackled in the future.  Update the file
617 reflect the situation as it stands when you hand over the pumpkin.
618
619 You might like, early in your pumpkin-holding career, to see if you
620 can find champions for partiticular issues on the to-do list: an issue
621 owned is an issue more likely to be resolved.
622
623 There are also some more porting-specific L<Todo> items later in this
624 file.
625
626 =head2 OS/2-specific updates
627
628 In the os2 directory is F<diff.configure>, a set of OS/2-specific
629 diffs against B<Configure>.  If you make changes to Configure, you may
630 want to consider regenerating this diff file to save trouble for the
631 OS/2 maintainer.
632
633 You can also consider the OS/2 diffs as reminders of portability
634 things that need to be fixed in Configure.
635
636 =head2 VMS-specific updates
637
638 If you have changed F<perly.y> or F<perly.c>, then you most probably want
639 to update F<vms/perly_{h,c}.vms> by running C<perl vms/vms_yfix.pl>.
640
641 The Perl version number appears in several places under F<vms>.
642 It is courteous to update these versions.  For example, if you are
643 making 5.004_42, replace "5.00441" with "5.00442".
644
645 =head2 Making the new distribution
646
647 Suppose, for example, that you want to make version 5.004_08.  Then you can
648 do something like the following
649
650         mkdir ../perl5.004_08
651         awk '{print $1}' MANIFEST | cpio -pdm ../perl5.004_08
652         cd ../
653         tar cf perl5.004_08.tar perl5.004_08
654         gzip --best perl5.004_08.tar
655
656 These steps, with extra checks, are automated by the Porting/makerel
657 script.
658
659 =head2 Making a new patch
660
661 I find the F<makepatch> utility quite handy for making patches.
662 You can obtain it from any CPAN archive under
663 http://www.perl.com/CPAN/authors/Johan_Vromans/ .  There are a couple
664 of differences between my version and the standard one. I have mine do
665 a
666
667         # Print a reassuring "End of Patch" note so people won't
668         # wonder if their mailer truncated patches.
669         print "\n\nEnd of Patch.\n";
670
671 at the end.  That's because I used to get questions from people asking
672 if their mail was truncated.
673
674 It also writes Index: lines which include the new directory prefix
675 (change Index: print, approx line 294 or 310 depending on the version,
676 to read:  print PATCH ("Index: $newdir$new\n");).  That helps patches
677 work with more POSIX conformant patch programs.
678
679 Here's how I generate a new patch.  I'll use the hypothetical
680 5.004_07 to 5.004_08 patch as an example.
681
682         # unpack perl5.004_07/
683         gzip -d -c perl5.004_07.tar.gz | tar -xof -
684         # unpack perl5.004_08/
685         gzip -d -c perl5.004_08.tar.gz | tar -xof -
686         makepatch perl5.004_07 perl5.004_08 > perl5.004_08.pat
687
688 Makepatch will automatically generate appropriate B<rm> commands to remove
689 deleted files.  Unfortunately, it will not correctly set permissions
690 for newly created files, so you may have to do so manually.  For example,
691 patch 5.003_04 created a new test F<t/op/gv.t> which needs to be executable,
692 so at the top of the patch, I inserted the following lines:
693
694         # Make a new test
695         touch t/op/gv.t
696         chmod +x t/opt/gv.t
697
698 Now, of course, my patch is now wrong because makepatch didn't know I
699 was going to do that command, and it patched against /dev/null.
700
701 So, what I do is sort out all such shell commands that need to be in the
702 patch (including possible mv-ing of files, if needed) and put that in the
703 shell commands at the top of the patch.  Next, I delete all the patch parts
704 of perl5.004_08.pat, leaving just the shell commands.  Then, I do the
705 following:
706
707         cd perl5.004_07
708         sh ../perl5.004_08.pat
709         cd ..
710         makepatch perl5.004_07 perl5.004_08 >> perl5.004_08.pat
711
712 (Note the append to preserve my shell commands.)
713 Now, my patch will line up with what the end users are going to do.
714
715 =head2 Testing your patch
716
717 It seems obvious, but be sure to test your patch.  That is, verify that
718 it produces exactly the same thing as your full distribution.
719
720         rm -rf perl5.004_07
721         gzip -d -c perl5.004_07.tar.gz | tar -xf -
722         cd perl5.004_07
723         sh ../perl5.004_08.pat
724         patch -p1 -N < ../perl5.004_08.pat
725         cd ..
726         gdiff -r perl5.004_07 perl5.004_08
727
728 where B<gdiff> is GNU diff.  Other diff's may also do recursive checking.
729
730 =head2 More testing
731
732 Again, it's obvious, but you should test your new version as widely as you
733 can.  You can be sure you'll hear about it quickly if your version doesn't
734 work on both ANSI and pre-ANSI compilers, and on common systems such as
735 SunOS 4.1.[34], Solaris, and Linux.
736
737 If your changes include conditional code, try to test the different
738 branches as thoroughly as you can.  For example, if your system
739 supports dynamic loading, you can also test static loading with
740
741         sh Configure -Uusedl
742
743 You can also hand-tweak your config.h to try out different #ifdef
744 branches.
745
746 =head1 Common Gotcha's
747
748 =over 4
749
750 =item #elif
751
752 The '#elif' preprocessor directive is not understood on all systems.
753 Specifically, I know that Pyramids don't understand it.  Thus instead of the
754 simple
755
756         #if defined(I_FOO)
757         #  include <foo.h>
758         #elif defined(I_BAR)
759         #  include <bar.h>
760         #else
761         #  include <fubar.h>
762         #endif
763
764 You have to do the more Byzantine
765
766         #if defined(I_FOO)
767         #  include <foo.h>
768         #else
769         #  if defined(I_BAR)
770         #    include <bar.h>
771         #  else
772         #    include <fubar.h>
773         #  endif
774         #endif
775
776 Incidentally, whitespace between the leading '#' and the preprocessor
777 command is not guaranteed, but is very portable and you may use it freely.
778 I think it makes things a bit more readable, especially once things get
779 rather deeply nested.  I also think that things should almost never get
780 too deeply nested,  so it ought to be a moot point :-)
781
782 =item Probably Prefer POSIX
783
784 It's often the case that you'll need to choose whether to do
785 something the BSD-ish way or the POSIX-ish way.  It's usually not
786 a big problem when the two systems use different names for similar
787 functions, such as memcmp() and bcmp().  The perl.h header file
788 handles these by appropriate #defines, selecting the POSIX mem*()
789 functions if available, but falling back on the b*() functions, if
790 need be.
791
792 More serious is the case where some brilliant person decided to
793 use the same function name but give it a different meaning or
794 calling sequence :-).  getpgrp() and setpgrp() come to mind.
795 These are a real problem on systems that aim for conformance to
796 one standard (e.g. POSIX), but still try to support the other way
797 of doing things (e.g. BSD).  My general advice (still not really
798 implemented in the source) is to do something like the following.
799 Suppose there are two alternative versions, fooPOSIX() and
800 fooBSD().
801
802     #ifdef HAS_FOOPOSIX
803         /* use fooPOSIX(); */
804     #else
805     #  ifdef HAS_FOOBSD
806         /* try to emulate fooPOSIX() with fooBSD();
807            perhaps with the following:  */
808     #    define fooPOSIX fooBSD
809     #  else
810     #  /* Uh, oh.  We have to supply our own. */
811     #    define fooPOSIX Perl_fooPOSIX
812     #  endif
813     #endif
814
815 =item Think positively
816
817 If you need to add an #ifdef test, it is usually easier to follow if you
818 think positively, e.g.
819
820         #ifdef HAS_NEATO_FEATURE
821             /* use neato feature */
822         #else
823             /* use some fallback mechanism */
824         #endif
825
826 rather than the more impenetrable
827
828         #ifndef MISSING_NEATO_FEATURE
829             /* Not missing it, so we must have it, so use it */
830         #else
831             /* Are missing it, so fall back on something else. */
832         #endif
833
834 Of course for this toy example, there's not much difference.  But when
835 the #ifdef's start spanning a couple of screen fulls, and the #else's
836 are marked something like
837
838         #else /* !MISSING_NEATO_FEATURE */
839
840 I find it easy to get lost.
841
842 =item Providing Missing Functions -- Problem
843
844 Not all systems have all the neat functions you might want or need, so
845 you might decide to be helpful and provide an emulation.  This is
846 sound in theory and very kind of you, but please be careful about what
847 you name the function.  Let me use the C<pause()> function as an
848 illustration.
849
850 Perl5.003 has the following in F<perl.h>
851
852     #ifndef HAS_PAUSE
853     #define pause() sleep((32767<<16)+32767)
854     #endif
855
856 Configure sets HAS_PAUSE if the system has the pause() function, so
857 this #define only kicks in if the pause() function is missing.
858 Nice idea, right?
859
860 Unfortunately, some systems apparently have a prototype for pause()
861 in F<unistd.h>, but don't actually have the function in the library.
862 (Or maybe they do have it in a library we're not using.)
863
864 Thus, the compiler sees something like
865
866     extern int pause(void);
867     /* . . . */
868     #define pause() sleep((32767<<16)+32767)
869
870 and dies with an error message.  (Some compilers don't mind this;
871 others apparently do.)
872
873 To work around this, 5.003_03 and later have the following in perl.h:
874
875     /* Some unistd.h's give a prototype for pause() even though
876        HAS_PAUSE ends up undefined.  This causes the #define
877        below to be rejected by the compiler.  Sigh.
878     */
879     #ifdef HAS_PAUSE
880     #  define Pause     pause
881     #else
882     #  define Pause() sleep((32767<<16)+32767)
883     #endif
884
885 This works.
886
887 The curious reader may wonder why I didn't do the following in
888 F<util.c> instead:
889
890     #ifndef HAS_PAUSE
891     void pause()
892     {
893     sleep((32767<<16)+32767);
894     }
895     #endif
896
897 That is, since the function is missing, just provide it.
898 Then things would probably be been alright, it would seem.
899
900 Well, almost.  It could be made to work.  The problem arises from the
901 conflicting needs of dynamic loading and namespace protection.
902
903 For dynamic loading to work on AIX (and VMS) we need to provide a list
904 of symbols to be exported.  This is done by the script F<perl_exp.SH>,
905 which reads F<global.sym> and F<interp.sym>.  Thus, the C<pause>
906 symbol would have to be added to F<global.sym>  So far, so good.
907
908 On the other hand, one of the goals of Perl5 is to make it easy to
909 either extend or embed perl and link it with other libraries.  This
910 means we have to be careful to keep the visible namespace "clean".
911 That is, we don't want perl's global variables to conflict with
912 those in the other application library.  Although this work is still
913 in progress, the way it is currently done is via the F<embed.h> file.
914 This file is built from the F<global.sym> and F<interp.sym> files,
915 since those files already list the globally visible symbols.  If we
916 had added C<pause> to global.sym, then F<embed.h> would contain the
917 line
918
919     #define pause       Perl_pause
920
921 and calls to C<pause> in the perl sources would now point to
922 C<Perl_pause>.  Now, when B<ld> is run to build the F<perl> executable,
923 it will go looking for C<perl_pause>, which probably won't exist in any
924 of the standard libraries.  Thus the build of perl will fail.
925
926 Those systems where C<HAS_PAUSE> is not defined would be ok, however,
927 since they would get a C<Perl_pause> function in util.c.  The rest of
928 the world would be in trouble.
929
930 And yes, this scenario has happened.  On SCO, the function C<chsize>
931 is available.  (I think it's in F<-lx>, the Xenix compatibility
932 library.)  Since the perl4 days (and possibly before), Perl has
933 included a C<chsize> function that gets called something akin to
934
935     #ifndef HAS_CHSIZE
936     I32 chsize(fd, length)
937     /*  . . . */
938     #endif
939
940 When 5.003 added
941
942     #define chsize      Perl_chsize
943
944 to F<embed.h>, the compile started failing on SCO systems.
945
946 The "fix" is to give the function a different name.  The one
947 implemented in 5.003_05 isn't optimal, but here's what was done:
948
949     #ifdef HAS_CHSIZE
950     # ifdef my_chsize  /* Probably #defined to Perl_my_chsize in embed.h */
951     #   undef my_chsize
952     # endif
953     # define my_chsize chsize
954     #endif
955
956 My explanatory comment in patch 5.003_05 said:
957
958      Undef and then re-define my_chsize from Perl_my_chsize to
959      just plain chsize if this system HAS_CHSIZE.  This probably only
960      applies to SCO.  This shows the perils of having internal
961      functions with the same name as external library functions :-).
962
963 Now, we can safely put C<my_chsize> in F<global.sym>, export it, and
964 hide it with F<embed.h>.
965
966 To be consistent with what I did for C<pause>, I probably should have
967 called the new function C<Chsize>, rather than C<my_chsize>.
968 However, the perl sources are quite inconsistent on this (Consider
969 New, Mymalloc, and Myremalloc, to name just a few.)
970
971 There is a problem with this fix, however, in that C<Perl_chsize>
972 was available as a F<libperl.a> library function in 5.003, but it
973 isn't available any more (as of 5.003_07).  This means that we've
974 broken binary compatibility.  This is not good.
975
976 =item Providing missing functions -- some ideas
977
978 We currently don't have a standard way of handling such missing
979 function names.  Right now, I'm effectively thinking aloud about a
980 solution.  Some day, I'll try to formally propose a solution.
981
982 Part of the problem is that we want to have some functions listed as
983 exported but not have their names mangled by embed.h or possibly
984 conflict with names in standard system headers.  We actually already
985 have such a list at the end of F<perl_exp.SH> (though that list is
986 out-of-date):
987
988     # extra globals not included above.
989     cat <<END >> perl.exp
990     perl_init_ext
991     perl_init_fold
992     perl_init_i18nl14n
993     perl_alloc
994     perl_construct
995     perl_destruct
996     perl_free
997     perl_parse
998     perl_run
999     perl_get_sv
1000     perl_get_av
1001     perl_get_hv
1002     perl_get_cv
1003     perl_call_argv
1004     perl_call_pv
1005     perl_call_method
1006     perl_call_sv
1007     perl_requirepv
1008     safecalloc
1009     safemalloc
1010     saferealloc
1011     safefree
1012
1013 This still needs much thought, but I'm inclined to think that one
1014 possible solution is to prefix all such functions with C<perl_> in the
1015 source and list them along with the other C<perl_*> functions in
1016 F<perl_exp.SH>.
1017
1018 Thus, for C<chsize>, we'd do something like the following:
1019
1020     /* in perl.h */
1021     #ifdef HAS_CHSIZE
1022     #  define perl_chsize chsize
1023     #endif
1024
1025 then in some file (e.g. F<util.c> or F<doio.c>) do
1026
1027     #ifndef HAS_CHSIZE
1028     I32 perl_chsize(fd, length)
1029     /* implement the function here . . . */
1030     #endif
1031
1032 Alternatively, we could just always use C<chsize> everywhere and move
1033 C<chsize> from F<global.sym> to the end of F<perl_exp.SH>.  That would
1034 probably be fine as long as our C<chsize> function agreed with all the
1035 C<chsize> function prototypes in the various systems we'll be using.
1036 As long as the prototypes in actual use don't vary that much, this is
1037 probably a good alternative.  (As a counter-example, note how Configure
1038 and perl have to go through hoops to find and use get Malloc_t and
1039 Free_t for C<malloc> and C<free>.)
1040
1041 At the moment, this latter option is what I tend to prefer.
1042
1043 =item All the world's a VAX
1044
1045 Sorry, showing my age:-).  Still, all the world is not BSD 4.[34],
1046 SVR4, or POSIX.  Be aware that SVR3-derived systems are still quite
1047 common (do you have any idea how many systems run SCO?)  If you don't
1048 have a bunch of v7 manuals handy, the metaconfig units (by default
1049 installed in F</usr/local/lib/dist/U>) are a good resource to look at
1050 for portability.
1051
1052 =back
1053
1054 =head1 Miscellaneous Topics
1055
1056 =head2 Autoconf
1057
1058 Why does perl use a metaconfig-generated Configure script instead of an
1059 autoconf-generated configure script?
1060
1061 Metaconfig and autoconf are two tools with very similar purposes.
1062 Metaconfig is actually the older of the two, and was originally written
1063 by Larry Wall, while autoconf is probably now used in a wider variety of
1064 packages.  The autoconf info file discusses the history of autoconf and
1065 how it came to be.  The curious reader is referred there for further
1066 information.
1067
1068 Overall, both tools are quite good, I think, and the choice of which one
1069 to use could be argued either way.  In March, 1994, when I was just
1070 starting to work on Configure support for Perl5, I considered both
1071 autoconf and metaconfig, and eventually decided to use metaconfig for the
1072 following reasons:
1073
1074 =over 4
1075
1076 =item Compatibility with Perl4
1077
1078 Perl4 used metaconfig, so many of the #ifdef's were already set up for
1079 metaconfig.  Of course metaconfig had evolved some since Perl4's days,
1080 but not so much that it posed any serious problems.
1081
1082 =item Metaconfig worked for me
1083
1084 My system at the time was Interactive 2.2, a SVR3.2/386 derivative that
1085 also had some POSIX support.  Metaconfig-generated Configure scripts
1086 worked fine for me on that system.  On the other hand, autoconf-generated
1087 scripts usually didn't.  (They did come quite close, though, in some
1088 cases.)  At the time, I actually fetched a large number of GNU packages
1089 and checked.  Not a single one configured and compiled correctly
1090 out-of-the-box with the system's cc compiler.
1091
1092 =item Configure can be interactive
1093
1094 With both autoconf and metaconfig, if the script works, everything is
1095 fine.  However, one of my main problems with autoconf-generated scripts
1096 was that if it guessed wrong about something, it could be B<very> hard to
1097 go back and fix it.  For example, autoconf always insisted on passing the
1098 -Xp flag to cc (to turn on POSIX behavior), even when that wasn't what I
1099 wanted or needed for that package.  There was no way short of editing the
1100 configure script to turn this off.  You couldn't just edit the resulting
1101 Makefile at the end because the -Xp flag influenced a number of other
1102 configure tests.
1103
1104 Metaconfig's Configure scripts, on the other hand, can be interactive.
1105 Thus if Configure is guessing things incorrectly, you can go back and fix
1106 them.  This isn't as important now as it was when we were actively
1107 developing Configure support for new features such as dynamic loading,
1108 but it's still useful occasionally.
1109
1110 =item GPL
1111
1112 At the time, autoconf-generated scripts were covered under the GNU Public
1113 License, and hence weren't suitable for inclusion with Perl, which has a
1114 different licensing policy.  (Autoconf's licensing has since changed.)
1115
1116 =item Modularity
1117
1118 Metaconfig builds up Configure from a collection of discrete pieces
1119 called "units".  You can override the standard behavior by supplying your
1120 own unit.  With autoconf, you have to patch the standard files instead.
1121 I find the metaconfig "unit" method easier to work with.  Others
1122 may find metaconfig's units clumsy to work with.
1123
1124 =back
1125
1126 =head2 Why isn't there a directory to override Perl's library?
1127
1128 Mainly because no one's gotten around to making one.  Note that
1129 "making one"  involves changing perl.c, Configure, config_h.SH (and
1130 associated files, see above), and I<documenting> it all in the
1131 INSTALL file.
1132
1133 Apparently, most folks who want to override one of the standard library
1134 files simply do it by overwriting the standard library files.
1135
1136 =head2 APPLLIB
1137
1138 In the perl.c sources, you'll find an undocumented APPLLIB_EXP
1139 variable, sort of like PRIVLIB_EXP and ARCHLIB_EXP (which are
1140 documented in config_h.SH).  Here's what APPLLIB_EXP is for, from
1141 a mail message from Larry:
1142
1143     The main intent of APPLLIB_EXP is for folks who want to send out a
1144     version of Perl embedded in their product.  They would set the symbol
1145     to be the name of the library containing the files needed to run or to
1146     support their particular application.  This works at the "override"
1147     level to make sure they get their own versions of any library code that
1148     they absolutely must have configuration control over.
1149
1150     As such, I don't see any conflict with a sysadmin using it for a
1151     override-ish sort of thing, when installing a generic Perl.  It should
1152     probably have been named something to do with overriding though.  Since
1153     it's undocumented we could still change it...  :-)
1154
1155 Given that it's already there, you can use it to override
1156 distribution modules.  If you do
1157
1158         sh Configure -Dccflags='-DAPPLLIB_EXP=/my/override'
1159
1160 then perl.c will put /my/override ahead of ARCHLIB and PRIVLIB.
1161
1162 =head2 Shared libperl.so location
1163
1164 Why isn't the shared libperl.so installed in /usr/lib/ along
1165 with "all the other" shared libraries?  Instead, it is installed
1166 in $archlib, which is typically something like
1167
1168         /usr/local/lib/perl5/archname/5.00404
1169
1170 and is architecture- and version-specific.
1171
1172 The basic reason why a shared libperl.so gets put in $archlib is so that
1173 you can have more than one version of perl on the system at the same time,
1174 and have each refer to its own libperl.so.
1175
1176 Three examples might help.  All of these work now; none would work if you
1177 put libperl.so in /usr/lib.
1178
1179 =over
1180
1181 =item 1.
1182
1183 Suppose you want to have both threaded and non-threaded perl versions
1184 around.  Configure will name both perl libraries "libperl.so" (so that
1185 you can link to them with -lperl).  The perl binaries tell them apart
1186 by having looking in the appropriate $archlib directories.
1187
1188 =item 2.
1189
1190 Suppose you have perl5.004_04 installed and you want to try to compile
1191 it again, perhaps with different options or after applying a patch.
1192 If you already have libperl.so installed in /usr/lib/, then it may be
1193 either difficult or impossible to get ld.so to find the new libperl.so
1194 that you're trying to build.  If, instead, libperl.so is tucked away in
1195 $archlib, then you can always just change $archlib in the current perl
1196 you're trying to build so that ld.so won't find your old libperl.so.
1197 (The INSTALL file suggests you do this when building a debugging perl.)
1198
1199 =item 3.
1200
1201 The shared perl library is not a "well-behaved" shared library with
1202 proper major and minor version numbers, so you can't necessarily
1203 have perl5.004_04 and perl5.004_05 installed simultaneously.  Suppose
1204 perl5.004_04 were to install /usr/lib/libperl.so.4.4, and perl5.004_05
1205 were to install /usr/lib/libperl.so.4.5.  Now, when you try to run
1206 perl5.004_04, ld.so might try to load libperl.so.4.5, since it has
1207 the right "major version" number.  If this works at all, it almost
1208 certainly defeats the reason for keeping perl5.004_04 around.  Worse,
1209 with development subversions, you certaily can't guarantee that
1210 libperl.so.4.4 and libperl.so.4.55 will be compatible.
1211
1212 Anyway, all this leads to quite obscure failures that are sure to drive
1213 casual users crazy.  Even experienced users will get confused :-).  Upon
1214 reflection, I'd say leave libperl.so in $archlib.
1215
1216 =back
1217
1218 =head1 Upload Your Work to CPAN
1219
1220 You can upload your work to CPAN if you have a CPAN id.  Check out
1221 http://www.perl.com/CPAN/modules/04pause.html for information on
1222 _PAUSE_, the Perl Author's Upload Server.
1223
1224 I typically upload both the patch file, e.g. F<perl5.004_08.pat.gz>
1225 and the full tar file, e.g. F<perl5.004_08.tar.gz>.
1226
1227 If you want your patch to appear in the F<src/5.0/unsupported>
1228 directory on CPAN, send e-mail to the CPAN master librarian.  (Check
1229 out http://www.perl.com/CPAN/CPAN.html ).
1230
1231 =head1 Help Save the World
1232
1233 You should definitely announce your patch on the perl5-porters list.
1234 You should also consider announcing your patch on
1235 comp.lang.perl.announce, though you should make it quite clear that a
1236 subversion is not a production release, and be prepared to deal with
1237 people who will not read your disclaimer.
1238
1239 =head1 Todo
1240
1241 Here, in no particular order, are some Configure and build-related
1242 items that merit consideration.  This list isn't exhaustive, it's just
1243 what I came up with off the top of my head.
1244
1245 =head2 Good ideas waiting for round tuits
1246
1247 =over 4
1248
1249 =item Configure -Dsrc=/blah/blah
1250
1251 We should be able to emulate B<configure --srcdir>.  Tom Tromey
1252 tromey@creche.cygnus.com has submitted some patches to
1253 the dist-users mailing list along these lines.  They have been folded
1254 back into the main distribution, but various parts of the perl
1255 Configure/build/install process still assume src='.'.
1256
1257 =item Hint file fixes
1258
1259 Various hint files work around Configure problems.  We ought to fix
1260 Configure so that most of them aren't needed.
1261
1262 =item Hint file information
1263
1264 Some of the hint file information (particularly dynamic loading stuff)
1265 ought to be fed back into the main metaconfig distribution.
1266
1267 =back
1268
1269 =head2 Probably good ideas waiting for round tuits
1270
1271 =over 4
1272
1273 =item GNU configure --options
1274
1275 I've received sensible suggestions for --exec_prefix and other
1276 GNU configure --options.  It's not always obvious exactly what is
1277 intended, but this merits investigation.
1278
1279 =item make clean
1280
1281 Currently, B<make clean> isn't all that useful, though
1282 B<make realclean> and B<make distclean> are.  This needs a bit of
1283 thought and documentation before it gets cleaned up.
1284
1285 =item Try gcc if cc fails
1286
1287 Currently, we just give up.
1288
1289 =item bypassing safe*alloc wrappers
1290
1291 On some systems, it may be safe to call the system malloc directly
1292 without going through the util.c safe* layers.  (Such systems would
1293 accept free(0), for example.)  This might be a time-saver for systems
1294 that already have a good malloc.  (Recent Linux libc's apparently have
1295 a nice malloc that is well-tuned for the system.)
1296
1297 =back
1298
1299 =head2 Vague possibilities
1300
1301 =over 4
1302
1303 =item MacPerl
1304
1305 Get some of the Macintosh stuff folded back into the main distribution.
1306
1307 =item gconvert replacement
1308
1309 Maybe include a replacement function that doesn't lose data in rare
1310 cases of coercion between string and numerical values.
1311
1312 =item Improve makedepend
1313
1314 The current makedepend process is clunky and annoyingly slow, but it
1315 works for most folks.  Alas, it assumes that there is a filename
1316 $firstmakefile that the B<make> command will try to use before it uses
1317 F<Makefile>.  Such may not be the case for all B<make> commands,
1318 particularly those on non-Unix systems.
1319
1320 Probably some variant of the BSD F<.depend> file will be useful.
1321 We ought to check how other packages do this, if they do it at all.
1322 We could probably pre-generate the dependencies (with the exception of
1323 malloc.o, which could probably be determined at F<Makefile.SH>
1324 extraction time.
1325
1326 =item GNU Makefile standard targets
1327
1328 GNU software generally has standardized Makefile targets.  Unless we
1329 have good reason to do otherwise, I see no reason not to support them.
1330
1331 =item File locking
1332
1333 Somehow, straighten out, document, and implement lockf(), flock(),
1334 and/or fcntl() file locking.  It's a mess.
1335
1336 =back
1337
1338 =head1 AUTHORS
1339
1340 Original author:  Andy Dougherty doughera@lafcol.lafayette.edu .
1341 Additions by Chip Salzenberg chip@perl.com and 
1342 Tim Bunce Tim.Bunce@ig.co.uk .
1343
1344 All opinions expressed herein are those of the authorZ<>(s).
1345
1346 =head1 LAST MODIFIED
1347
1348 $Id: pumpkin.pod,v 1.23 2000/01/13 19:45:13 doughera Released $