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