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