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