This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update metaconfig related information
[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 L<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 F<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, F<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" (F<os2ish.h>, F<vmsish.h>, and so on) and including
195 that in F<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 F<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>, F<regcharclass.h>,
291 F<l1_char_class_tab.h>, and F<perltoc.pod> files
292 are all automatically generated by perl scripts.  In general, don't
293 patch these directly; patch the data files instead.
294
295 F<Configure> and F<config_h.SH> are also automatically generated by
296 B<metaconfig>.  In general, you should patch the metaconfig units
297 instead of patching these files directly.  However, very minor changes
298 to F<Configure> may be made in between major sync-ups with the
299 metaconfig units, which tends to be complicated operations.  But be
300 careful, this can quickly spiral out of control.  Running metaconfig
301 is not really hard.
302
303 Also F<Makefile> is automatically produced from F<Makefile.SH>.
304 In general, look out for all F<*.SH> files.
305
306 Finally, the sample files in the F<Porting/> subdirectory are
307 generated automatically by the script F<U/mksample> included 
308 with the metaconfig units.  See L<"run metaconfig"> below for
309 information on obtaining the metaconfig units.
310
311 =head1 How to Make a Distribution
312
313 This section has now been expanded and moved into its own file,
314 F<Porting/release_managers_guide.pod>.
315
316 I've kept some of the subsections here for now, as they don't directly
317 relate to building a release any more, but still contain what might be
318 useful information - DAPM 7/2009.
319
320 =head2 run metaconfig
321
322 If you need to make changes to Configure or config_h.SH, it may be best to
323 change the appropriate metaconfig units instead, and regenerate Configure.
324
325         mconfig -m -O
326
327 will regenerate F<Configure> and F<config_h.SH>.  Much more information
328 on obtaining and running metaconfig is in the F<U/README> file
329 that comes with Perl's metaconfig units. See the head of Configure for the
330 recent information on how to obtain the units and the tools. The base boils
331 down to
332
333 `       git clone github.com:perl5-metaconfig/metaconfig metaconfig
334
335 Since metaconfig is hard to change, running correction scripts after
336 this generation is sometimes needed. Configure gained complexity over
337 time, and the order in which config_h.SH is generated can cause havoc
338 when compiling perl. Therefor, you need to run Porting/config_h.pl
339 after that generation. All that and more is described in the README
340 files that come with the metaunits.
341
342 Alternatively, do consider if the F<*ish.h> files or the hint files might
343 be a better place for your changes.
344
345 =head2 MANIFEST
346
347 If you are using metaconfig to regenerate Configure, then you should note
348 that metaconfig actually uses MANIFEST.new, so you want to be sure
349 MANIFEST.new is up-to-date too.  I haven't found the MANIFEST/MANIFEST.new
350 distinction particularly useful, but that's probably because I still haven't
351 learned how to use the full suite of tools in the dist distribution.
352
353
354 =head2 Run Configure
355
356 This will build a config.sh and config.h.  You can skip this if you haven't
357 changed Configure or config_h.SH at all.  I use the following command
358
359     sh Configure -Dprefix=/opt/perl -Doptimize=-O -Dusethreads \
360         -Dcf_by='yourname' \
361         -Dcf_email='yourname@yourhost.yourplace.com' \
362         -Dperladmin='yourname@yourhost.yourplace.com' \
363         -Dmydomain='.yourplace.com' \
364         -Dmyhostname='yourhost' \
365         -des
366
367 =head2 Update Porting/config.sh and Porting/config_H
368
369 [XXX 
370 This section needs revision.  We're currently working on easing
371 the task of keeping the vms, win32, and plan9 config.sh info
372 up-to-date.  The plan is to use keep up-to-date 'canned' config.sh
373 files in the appropriate subdirectories and then generate 'canned'
374 config.h files for vms, win32, etc. from the generic config.sh file.
375 This is to ease maintenance.  When Configure gets updated, the parts
376 sometimes get scrambled around, and the changes in config_H can
377 sometimes be very hard to follow.  config.sh, on the other hand, can
378 safely be sorted, so it's easy to track (typically very small) changes
379 to config.sh and then propagate them to a canned 'config.h' by any
380 number of means, including a perl script in win32/ or carrying 
381 F<config.sh> and F<config_h.SH> to a Unix system and running sh
382 config_h.SH.)  Vms uses F<configure.com> to generate its own F<config.sh>
383 and F<config.h>.  If you want to add a new variable to F<config.sh> check
384 with vms folk how to add it to configure.com too.
385 XXX]
386
387 The F<Porting/config.sh> and F<Porting/config_H> files are provided to
388 help those folks who can't run Configure.  It is important to keep
389 them up-to-date.  If you have changed F<config_h.SH>, those changes must
390 be reflected in config_H as well.  (The name config_H was chosen to
391 distinguish the file from config.h even on case-insensitive file systems.)
392 Simply edit the existing config_H file; keep the first few explanatory
393 lines and then copy your new config.h below.
394
395 It may also be necessary to update win32/config.?c, and
396 F<plan9/config.plan9>, though you should be quite careful in doing so if
397 you are not familiar with those systems.  You might want to issue your
398 patch with a promise to quickly issue a follow-up that handles those
399 directories.
400
401 =head2 make regen_perly
402
403 If F<perly.y> has been edited, it is necessary to run this target to rebuild
404 F<perly.h>, F<perly.act> and F<perly.tab>. In fact this target just runs the Perl
405 script F<regen_perly.pl>. Note that F<perly.c> is I<not> rebuilt; this is just a
406 plain static file now. 
407
408 This target relies on you having Bison installed on your system. Running
409 the target will tell you if you haven't got the right version, and if so,
410 where to get the right one. Or if you prefer, you could hack
411 F<regen_perly.pl> to work with your version of Bison. The important things
412 are that the regexes can still extract out the right chunks of the Bison
413 output into F<perly.act> and F<perly.tab>, and that the contents of those two
414 files, plus F<perly.h>, are functionally equivalent to those produced by the
415 supported version of Bison.
416
417 Note that in the old days, you had to do C<make run_byacc> instead.
418
419 =head2 make regen_all
420
421 This target takes care of the regen_headers target.
422 (It used to also call the regen_pods target, but that has been eliminated.)
423
424 =head2 make regen_headers
425
426 The F<embed.h>, F<keywords.h>, and F<opcode.h> files are all automatically
427 generated by perl scripts.  Since the user isn't guaranteed to have a
428 working perl, we can't require the user to generate them.  Hence you have
429 to, if you're making a distribution.
430
431 I used to include rules like the following in the makefile:
432
433     # The following three header files are generated automatically
434     # The correct versions should be already supplied with the perl kit,
435     # in case you don't have perl or 'sh' available.
436     # The - is to ignore error return codes in case you have the source
437     # installed read-only or you don't have perl yet.
438     keywords.h: keywords.pl
439             @echo "Don't worry if this fails."
440             - perl keywords.pl
441
442
443 However, I got B<lots> of mail consisting of people worrying because the
444 command failed.  I eventually decided that I would save myself time
445 and effort by manually running C<make regen_headers> myself rather
446 than answering all the questions and complaints about the failing
447 command.
448
449 =head2 globvar.sym, and perlio.sym
450
451 Make sure these files are up-to-date.  Read the comments in these
452 files and in F<perl_exp.SH> to see what to do.
453
454 =head2 Binary compatibility
455
456 If you do change F<embed.fnc> think carefully about
457 what you are doing.  To the extent reasonable, we'd like to maintain
458 source and binary compatibility with older releases of perl.  That way,
459 extensions built under one version of perl will continue to work with
460 new versions of perl.
461
462 Of course, some incompatible changes may well be necessary.  I'm just
463 suggesting that we not make any such changes without thinking carefully
464 about them first.  If possible, we should provide
465 backwards-compatibility stubs.  There's a lot of XS code out there.
466 Let's not force people to keep changing it.
467
468 =head2 PPPort
469
470 F<cpan/Devel-PPPort/PPPort.pm> needs to be synchronized to include all
471 new macros added to .h files (normally F<perl.h> and F<XSUB.h>, but others
472 as well). Since chances are that when a new macro is added the
473 committer will forget to update F<PPPort.pm>, it's the best to diff for
474 changes in .h files when making a new release and making sure that
475 F<PPPort.pm> contains them all.
476
477 The pumpking can delegate the synchronization responsibility to anybody
478 else, but the release process is the only place where we can make sure
479 that no new macros fell through the cracks.
480
481
482 =head2 Todo
483
484 The F<Porting/todo.pod> file contains a roughly-categorized unordered
485 list of aspects of Perl that could use enhancement, features that could
486 be added, areas that could be cleaned up, and so on.  During your term
487 as pumpkin-holder, you will probably address some of these issues, and
488 perhaps identify others which, while you decide not to address them this
489 time around, may be tackled in the future.  Update the file to reflect
490 the situation as it stands when you hand over the pumpkin.
491
492 You might like, early in your pumpkin-holding career, to see if you
493 can find champions for particular issues on the to-do list: an issue
494 owned is an issue more likely to be resolved.
495
496 There are also some more porting-specific L</Todo> items later in this
497 file.
498
499 =head2 OS/2-specific updates
500
501 In the os2 directory is F<diff.configure>, a set of OS/2-specific
502 diffs against B<Configure>.  If you make changes to Configure, you may
503 want to consider regenerating this diff file to save trouble for the
504 OS/2 maintainer.
505
506 You can also consider the OS/2 diffs as reminders of portability
507 things that need to be fixed in Configure.
508
509 =head2 VMS-specific updates
510
511 The Perl revision number appears as "perl5" in F<configure.com>.
512 It is courteous to update that if necessary.
513
514
515 =head2 Making a new patch
516
517 I find the F<makepatch> utility quite handy for making patches.
518 You can obtain it from any CPAN archive under
519 L<http://www.cpan.org/authors/Johan_Vromans/>.  There are a couple
520 of differences between my version and the standard one. I have mine do
521 a
522
523         # Print a reassuring "End of Patch" note so people won't
524         # wonder if their mailer truncated patches.
525         print "\n\nEnd of Patch.\n";
526
527 at the end.  That's because I used to get questions from people asking
528 if their mail was truncated.
529
530 It also writes Index: lines which include the new directory prefix
531 (change Index: print, approx line 294 or 310 depending on the version,
532 to read:  print PATCH ("Index: $newdir$new\n");).  That helps patches
533 work with more POSIX conformant patch programs.
534
535 Here's how I generate a new patch.  I'll use the hypothetical
536 5.004_07 to 5.004_08 patch as an example.
537
538         # unpack perl5.004_07/
539         gzip -d -c perl5.004_07.tar.gz | tar -xof -
540         # unpack perl5.004_08/
541         gzip -d -c perl5.004_08.tar.gz | tar -xof -
542         makepatch perl5.004_07 perl5.004_08 > perl5.004_08.pat
543
544 Makepatch will automatically generate appropriate B<rm> commands to remove
545 deleted files.  Unfortunately, it will not correctly set permissions
546 for newly created files, so you may have to do so manually.  For example,
547 patch 5.003_04 created a new test F<t/op/gv.t> which needs to be executable,
548 so at the top of the patch, I inserted the following lines:
549
550         # Make a new test
551         touch t/op/gv.t
552         chmod +x t/opt/gv.t
553
554 Now, of course, my patch is now wrong because makepatch didn't know I
555 was going to do that command, and it patched against /dev/null.
556
557 So, what I do is sort out all such shell commands that need to be in the
558 patch (including possible mv-ing of files, if needed) and put that in the
559 shell commands at the top of the patch.  Next, I delete all the patch parts
560 of perl5.004_08.pat, leaving just the shell commands.  Then, I do the
561 following:
562
563         cd perl5.004_07
564         sh ../perl5.004_08.pat
565         cd ..
566         makepatch perl5.004_07 perl5.004_08 >> perl5.004_08.pat
567
568 (Note the append to preserve my shell commands.)
569 Now, my patch will line up with what the end users are going to do.
570
571 =head2 Testing your patch
572
573 It seems obvious, but be sure to test your patch.  That is, verify that
574 it produces exactly the same thing as your full distribution.
575
576         rm -rf perl5.004_07
577         gzip -d -c perl5.004_07.tar.gz | tar -xf -
578         cd perl5.004_07
579         sh ../perl5.004_08.pat
580         patch -p1 -N < ../perl5.004_08.pat
581         cd ..
582         gdiff -r perl5.004_07 perl5.004_08
583
584 where B<gdiff> is GNU diff.  Other diff's may also do recursive checking.
585
586 =head2 More testing
587
588 Again, it's obvious, but you should test your new version as widely as you
589 can.  You can be sure you'll hear about it quickly if your version doesn't
590 work on both ANSI and pre-ANSI compilers, and on common systems such as
591 SunOS 4.1.[34], Solaris, and Linux.
592
593 If your changes include conditional code, try to test the different
594 branches as thoroughly as you can.  For example, if your system
595 supports dynamic loading, you can also test static loading with
596
597         sh Configure -Uusedl
598
599 You can also hand-tweak your config.h to try out different #ifdef
600 branches.
601
602 =head2 Other tests
603
604 =over 4
605
606 =item gcc -ansi -pedantic
607
608 Configure -Dgccansipedantic [ -Dcc=gcc ] will enable (via the cflags script,
609 not $Config{ccflags}) the gcc strict ANSI C flags -ansi and -pedantic for
610 the compilation of the core files on platforms where it knows it can
611 do so (like Linux, see cflags.SH for the full list), and on some
612 platforms only one (Solaris can do only -pedantic, not -ansi).
613 The flag -DPERL_GCC_PEDANTIC also gets added, since gcc does not add
614 any internal cpp flag to signify that -pedantic is being used, as it
615 does for -ansi (__STRICT_ANSI__).
616
617 Note that the -ansi and -pedantic are enabled only for version 3 (and
618 later) of gcc, since even gcc version 2.95.4 finds lots of seemingly
619 false "value computed not used" errors from Perl.
620
621 The -ansi and -pedantic are useful in catching at least the following
622 nonportable practices:
623
624 =over 4
625
626 =item *
627
628 gcc-specific extensions
629
630 =item *
631
632 lvalue casts
633
634 =item *
635
636 // C++ comments
637
638 =item *
639
640 enum trailing commas
641
642 =back
643
644 The -Dgccansipedantic should be used only when cleaning up the code,
645 not for production builds, since otherwise gcc cannot inline certain
646 things.
647
648 =back
649
650 =head1 Common Gotchas
651
652 =over 4
653
654 =item Probably Prefer POSIX
655
656 It's often the case that you'll need to choose whether to do
657 something the BSD-ish way or the POSIX-ish way.  It's usually not
658 a big problem when the two systems use different names for similar
659 functions, such as memcmp() and bcmp().  The perl.h header file
660 handles these by appropriate #defines, selecting the POSIX mem*()
661 functions if available, but falling back on the b*() functions, if
662 need be.
663
664 More serious is the case where some brilliant person decided to
665 use the same function name but give it a different meaning or
666 calling sequence :-).  getpgrp() and setpgrp() come to mind.
667 These are a real problem on systems that aim for conformance to
668 one standard (e.g. POSIX), but still try to support the other way
669 of doing things (e.g. BSD).  My general advice (still not really
670 implemented in the source) is to do something like the following.
671 Suppose there are two alternative versions, fooPOSIX() and
672 fooBSD().
673
674     #ifdef HAS_FOOPOSIX
675         /* use fooPOSIX(); */
676     #else
677     #  ifdef HAS_FOOBSD
678         /* try to emulate fooPOSIX() with fooBSD();
679            perhaps with the following:  */
680     #    define fooPOSIX fooBSD
681     #  else
682     #  /* Uh, oh.  We have to supply our own. */
683     #    define fooPOSIX Perl_fooPOSIX
684     #  endif
685     #endif
686
687 =item Think positively
688
689 If you need to add an #ifdef test, it is usually easier to follow if you
690 think positively, e.g.
691
692         #ifdef HAS_NEATO_FEATURE
693             /* use neato feature */
694         #else
695             /* use some fallback mechanism */
696         #endif
697
698 rather than the more impenetrable
699
700         #ifndef MISSING_NEATO_FEATURE
701             /* Not missing it, so we must have it, so use it */
702         #else
703             /* Are missing it, so fall back on something else. */
704         #endif
705
706 Of course for this toy example, there's not much difference.  But when
707 the #ifdef's start spanning a couple of screen fulls, and the #else's
708 are marked something like
709
710         #else /* !MISSING_NEATO_FEATURE */
711
712 I find it easy to get lost.
713
714 =item Providing Missing Functions -- Problem
715
716 Not all systems have all the neat functions you might want or need, so
717 you might decide to be helpful and provide an emulation.  This is
718 sound in theory and very kind of you, but please be careful about what
719 you name the function.  Let me use the C<pause()> function as an
720 illustration.
721
722 Perl5.003 has the following in F<perl.h>
723
724     #ifndef HAS_PAUSE
725     #define pause() sleep((32767<<16)+32767)
726     #endif
727
728 Configure sets HAS_PAUSE if the system has the pause() function, so
729 this #define only kicks in if the pause() function is missing.
730 Nice idea, right?
731
732 Unfortunately, some systems apparently have a prototype for pause()
733 in F<unistd.h>, but don't actually have the function in the library.
734 (Or maybe they do have it in a library we're not using.)
735
736 Thus, the compiler sees something like
737
738     extern int pause(void);
739     /* . . . */
740     #define pause() sleep((32767<<16)+32767)
741
742 and dies with an error message.  (Some compilers don't mind this;
743 others apparently do.)
744
745 To work around this, 5.003_03 and later have the following in perl.h:
746
747     /* Some unistd.h's give a prototype for pause() even though
748        HAS_PAUSE ends up undefined.  This causes the #define
749        below to be rejected by the compiler.  Sigh.
750     */
751     #ifdef HAS_PAUSE
752     #  define Pause     pause
753     #else
754     #  define Pause() sleep((32767<<16)+32767)
755     #endif
756
757 This works.
758
759 The curious reader may wonder why I didn't do the following in
760 F<util.c> instead:
761
762     #ifndef HAS_PAUSE
763     void pause()
764     {
765     sleep((32767<<16)+32767);
766     }
767     #endif
768
769 That is, since the function is missing, just provide it.
770 Then things would probably be been alright, it would seem.
771
772 Well, almost.  It could be made to work.  The problem arises from the
773 conflicting needs of dynamic loading and namespace protection.
774
775 For dynamic loading to work on AIX (and VMS) we need to provide a list
776 of symbols to be exported.  This is done by the script F<perl_exp.SH>,
777 which reads F<embed.fnc>.  Thus, the C<pause>
778 symbol would have to be added to F<embed.fnc>  So far, so good.
779
780 On the other hand, one of the goals of Perl5 is to make it easy to
781 either extend or embed perl and link it with other libraries.  This
782 means we have to be careful to keep the visible namespace "clean".
783 That is, we don't want perl's global variables to conflict with
784 those in the other application library.  Although this work is still
785 in progress, the way it is currently done is via the F<embed.h> file.
786 This file is built from the F<embed.fnc> file,
787 since those files already list the globally visible symbols.  If we
788 had added C<pause> to F<embed.fnc>, then F<embed.h> would contain the
789 line
790
791     #define pause       Perl_pause
792
793 and calls to C<pause> in the perl sources would now point to
794 C<Perl_pause>.  Now, when B<ld> is run to build the F<perl> executable,
795 it will go looking for C<perl_pause>, which probably won't exist in any
796 of the standard libraries.  Thus the build of perl will fail.
797
798 Those systems where C<HAS_PAUSE> is not defined would be ok, however,
799 since they would get a C<Perl_pause> function in util.c.  The rest of
800 the world would be in trouble.
801
802 And yes, this scenario has happened.  On SCO, the function C<chsize>
803 is available.  (I think it's in F<-lx>, the Xenix compatibility
804 library.)  Since the perl4 days (and possibly before), Perl has
805 included a C<chsize> function that gets called something akin to
806
807     #ifndef HAS_CHSIZE
808     I32 chsize(fd, length)
809     /*  . . . */
810     #endif
811
812 When 5.003 added
813
814     #define chsize      Perl_chsize
815
816 to F<embed.h>, the compile started failing on SCO systems.
817
818 The "fix" is to give the function a different name.  The one
819 implemented in 5.003_05 isn't optimal, but here's what was done:
820
821     #ifdef HAS_CHSIZE
822     # ifdef my_chsize      /* Probably #defined to Perl_my_chsize */
823     #   undef my_chsize    /* in embed.h */
824     # endif
825     # define my_chsize chsize
826     #endif
827
828 My explanatory comment in patch 5.003_05 said:
829
830     Undef and then re-define my_chsize from Perl_my_chsize to
831     just plain chsize if this system HAS_CHSIZE.  This probably only
832     applies to SCO.  This shows the perils of having internal
833     functions with the same name as external library functions :-).
834
835 Now, we can safely put C<my_chsize> in C<embed.fnc>, export it, and
836 hide it with F<embed.h>.
837
838 To be consistent with what I did for C<pause>, I probably should have
839 called the new function C<Chsize>, rather than C<my_chsize>.
840 However, the perl sources are quite inconsistent on this (Consider
841 New, Mymalloc, and Myremalloc, to name just a few.)
842
843 There is a problem with this fix, however, in that C<Perl_chsize>
844 was available as a F<libperl.a> library function in 5.003, but it
845 isn't available any more (as of 5.003_07).  This means that we've
846 broken binary compatibility.  This is not good.
847
848 =item Providing missing functions -- some ideas
849
850 We currently don't have a standard way of handling such missing
851 function names.  Right now, I'm effectively thinking aloud about a
852 solution.  Some day, I'll try to formally propose a solution.
853
854 Part of the problem is that we want to have some functions listed as
855 exported but not have their names mangled by embed.h or possibly
856 conflict with names in standard system headers.  We actually already
857 have such a list at the end of F<perl_exp.SH> (though that list is
858 out-of-date):
859
860     # extra globals not included above.
861     cat <<END >> perl.exp
862     perl_init_ext
863     perl_init_fold
864     perl_init_i18nl14n
865     perl_alloc
866     perl_construct
867     perl_destruct
868     perl_free
869     perl_parse
870     perl_run
871     perl_get_sv
872     perl_get_av
873     perl_get_hv
874     perl_get_cv
875     perl_call_argv
876     perl_call_pv
877     perl_call_method
878     perl_call_sv
879     perl_requirepv
880     safecalloc
881     safemalloc
882     saferealloc
883     safefree
884
885 This still needs much thought, but I'm inclined to think that one
886 possible solution is to prefix all such functions with C<perl_> in the
887 source and list them along with the other C<perl_*> functions in
888 F<perl_exp.SH>.
889
890 Thus, for C<chsize>, we'd do something like the following:
891
892     /* in perl.h */
893     #ifdef HAS_CHSIZE
894     #  define perl_chsize chsize
895     #endif
896
897 then in some file (e.g. F<util.c> or F<doio.c>) do
898
899     #ifndef HAS_CHSIZE
900     I32 perl_chsize(fd, length)
901     /* implement the function here . . . */
902     #endif
903
904 Alternatively, we could just always use C<chsize> everywhere and move
905 C<chsize> from F<embed.fnc> to the end of F<perl_exp.SH>.  That would
906 probably be fine as long as our C<chsize> function agreed with all the
907 C<chsize> function prototypes in the various systems we'll be using.
908 As long as the prototypes in actual use don't vary that much, this is
909 probably a good alternative.  (As a counter-example, note how Configure
910 and perl have to go through hoops to find and use get Malloc_t and
911 Free_t for C<malloc> and C<free>.)
912
913 At the moment, this latter option is what I tend to prefer.
914
915 =item All the world's a VAX
916
917 Sorry, showing my age:-).  Still, all the world is not BSD 4.[34],
918 SVR4, or POSIX.  Be aware that SVR3-derived systems are still quite
919 common (do you have any idea how many systems run SCO?)  If you don't
920 have a bunch of v7 manuals handy, the metaconfig units (by default
921 installed in F</usr/local/lib/dist/U>) are a good resource to look at
922 for portability.
923
924 =back
925
926 =head1 Miscellaneous Topics
927
928 =head2 Autoconf
929
930 Why does perl use a metaconfig-generated Configure script instead of an
931 autoconf-generated configure script?
932
933 Metaconfig and autoconf are two tools with very similar purposes.
934 Metaconfig is actually the older of the two, and was originally written
935 by Larry Wall, while autoconf is probably now used in a wider variety of
936 packages.  The autoconf info file discusses the history of autoconf and
937 how it came to be.  The curious reader is referred there for further
938 information.
939
940 Overall, both tools are quite good, I think, and the choice of which one
941 to use could be argued either way.  In March, 1994, when I was just
942 starting to work on Configure support for Perl5, I considered both
943 autoconf and metaconfig, and eventually decided to use metaconfig for the
944 following reasons:
945
946 =over 4
947
948 =item Compatibility with Perl4
949
950 Perl4 used metaconfig, so many of the #ifdef's were already set up for
951 metaconfig.  Of course metaconfig had evolved some since Perl4's days,
952 but not so much that it posed any serious problems.
953
954 =item Metaconfig worked for me
955
956 My system at the time was Interactive 2.2, an SVR3.2/386 derivative that
957 also had some POSIX support.  Metaconfig-generated Configure scripts
958 worked fine for me on that system.  On the other hand, autoconf-generated
959 scripts usually didn't.  (They did come quite close, though, in some
960 cases.)  At the time, I actually fetched a large number of GNU packages
961 and checked.  Not a single one configured and compiled correctly
962 out-of-the-box with the system's cc compiler.
963
964 =item Configure can be interactive
965
966 With both autoconf and metaconfig, if the script works, everything is
967 fine.  However, one of my main problems with autoconf-generated scripts
968 was that if it guessed wrong about something, it could be B<very> hard to
969 go back and fix it.  For example, autoconf always insisted on passing the
970 -Xp flag to cc (to turn on POSIX behavior), even when that wasn't what I
971 wanted or needed for that package.  There was no way short of editing the
972 configure script to turn this off.  You couldn't just edit the resulting
973 Makefile at the end because the -Xp flag influenced a number of other
974 configure tests.
975
976 Metaconfig's Configure scripts, on the other hand, can be interactive.
977 Thus if Configure is guessing things incorrectly, you can go back and fix
978 them.  This isn't as important now as it was when we were actively
979 developing Configure support for new features such as dynamic loading,
980 but it's still useful occasionally.
981
982 =item GPL
983
984 At the time, autoconf-generated scripts were covered under the GNU Public
985 License, and hence weren't suitable for inclusion with Perl, which has a
986 different licensing policy.  (Autoconf's licensing has since changed.)
987
988 =item Modularity
989
990 Metaconfig builds up Configure from a collection of discrete pieces
991 called "units".  You can override the standard behavior by supplying your
992 own unit.  With autoconf, you have to patch the standard files instead.
993 I find the metaconfig "unit" method easier to work with.  Others
994 may find metaconfig's units clumsy to work with.
995
996 =back
997
998 =head2 Why isn't there a directory to override Perl's library?
999
1000 Mainly because no one's gotten around to making one.  Note that
1001 "making one"  involves changing perl.c, Configure, config_h.SH (and
1002 associated files, see above), and I<documenting> it all in the
1003 INSTALL file.
1004
1005 Apparently, most folks who want to override one of the standard library
1006 files simply do it by overwriting the standard library files.
1007
1008 =head2 APPLLIB
1009
1010 In the perl.c sources, you'll find an undocumented APPLLIB_EXP
1011 variable, sort of like PRIVLIB_EXP and ARCHLIB_EXP (which are
1012 documented in config_h.SH).  Here's what APPLLIB_EXP is for, from
1013 a mail message from Larry:
1014
1015     The main intent of APPLLIB_EXP is for folks who want to send out a
1016     version of Perl embedded in their product.  They would set the
1017     symbol to be the name of the library containing the files needed
1018     to run or to support their particular application.  This works at
1019     the "override" level to make sure they get their own versions of
1020     any library code that they absolutely must have configuration
1021     control over.
1022
1023     As such, I don't see any conflict with a sysadmin using it for a
1024     override-ish sort of thing, when installing a generic Perl.  It
1025     should probably have been named something to do with overriding
1026     though.  Since it's undocumented we could still change it...  :-)
1027
1028 Given that it's already there, you can use it to override distribution modules.
1029 One way to do that is to add
1030
1031         ccflags="$ccflags -DAPPLLIB_EXP=\"/my/override\""
1032
1033 to your config.over file.  (You have to be particularly careful to get the
1034 double quotes in.  APPLLIB_EXP must be a valid C string.  It might
1035 actually be easier to just #define it yourself in perl.c.)
1036
1037 Then perl.c will put /my/override ahead of ARCHLIB and PRIVLIB.  Perl will
1038 also search architecture-specific and version-specific subdirectories of
1039 APPLLIB_EXP.
1040
1041 =head2 Shared libperl.so location
1042
1043 Why isn't the shared libperl.so installed in /usr/lib/ along
1044 with "all the other" shared libraries?  Instead, it is installed
1045 in $archlib, which is typically something like
1046
1047         /usr/local/lib/perl5/archname/5.00404
1048
1049 and is architecture- and version-specific.
1050
1051 The basic reason why a shared libperl.so gets put in $archlib is so that
1052 you can have more than one version of perl on the system at the same time,
1053 and have each refer to its own libperl.so.
1054
1055 Three examples might help.  All of these work now; none would work if you
1056 put libperl.so in /usr/lib.
1057
1058 =over
1059
1060 =item 1.
1061
1062 Suppose you want to have both threaded and non-threaded perl versions
1063 around.  Configure will name both perl libraries "libperl.so" (so that
1064 you can link to them with -lperl).  The perl binaries tell them apart
1065 by having looking in the appropriate $archlib directories.
1066
1067 =item 2.
1068
1069 Suppose you have perl5.004_04 installed and you want to try to compile
1070 it again, perhaps with different options or after applying a patch.
1071 If you already have libperl.so installed in /usr/lib/, then it may be
1072 either difficult or impossible to get ld.so to find the new libperl.so
1073 that you're trying to build.  If, instead, libperl.so is tucked away in
1074 $archlib, then you can always just change $archlib in the current perl
1075 you're trying to build so that ld.so won't find your old libperl.so.
1076 (The INSTALL file suggests you do this when building a debugging perl.)
1077
1078 =item 3.
1079
1080 The shared perl library is not a "well-behaved" shared library with
1081 proper major and minor version numbers, so you can't necessarily
1082 have perl5.004_04 and perl5.004_05 installed simultaneously.  Suppose
1083 perl5.004_04 were to install /usr/lib/libperl.so.4.4, and perl5.004_05
1084 were to install /usr/lib/libperl.so.4.5.  Now, when you try to run
1085 perl5.004_04, ld.so might try to load libperl.so.4.5, since it has
1086 the right "major version" number.  If this works at all, it almost
1087 certainly defeats the reason for keeping perl5.004_04 around.  Worse,
1088 with development subversions, you certainly can't guarantee that
1089 libperl.so.4.4 and libperl.so.4.55 will be compatible.
1090
1091 Anyway, all this leads to quite obscure failures that are sure to drive
1092 casual users crazy.  Even experienced users will get confused :-).  Upon
1093 reflection, I'd say leave libperl.so in $archlib.
1094
1095 =back
1096
1097 =head2 Indentation style
1098
1099 Over the years Perl has become a mishmash of
1100 various indentation styles, but the original "Larry style" can
1101 probably be restored with (GNU) indent somewhat like this:
1102
1103     indent -kr -nce -psl -sc
1104
1105 A more ambitious solution would also specify a list of Perl specific
1106 types with -TSV -TAV -THV .. -TMAGIC -TPerlIO ... but that list would
1107 be quite ungainly.  Also note that GNU indent also doesn't do aligning
1108 of consecutive assignments, which would truly wreck the layout in
1109 places like sv.c:Perl_sv_upgrade() or sv.c:Perl_clone_using().
1110 Similarly nicely aligned &&s, ||s and ==s would not be respected.
1111
1112 =head1 Upload Your Work to CPAN
1113
1114 You can upload your work to CPAN if you have a CPAN id.  Check out
1115 L<http://www.cpan.org/modules/04pause.html> for information on
1116 _PAUSE_, the Perl Author's Upload Server.
1117
1118 I typically upload both the patch file, e.g. F<perl5.004_08.pat.gz>
1119 and the full tar file, e.g. F<perl5.004_08.tar.gz>.
1120
1121 If you want your patch to appear in the F<src/5.0/unsupported>
1122 directory on CPAN, send e-mail to the CPAN master librarian.  (Check
1123 out L<http://www.cpan.org/CPAN.html> ).
1124
1125 =head1 Help Save the World
1126
1127 You should definitely announce your patch on the perl5-porters list.
1128
1129 =head1 Todo
1130
1131 Here, in no particular order, are some Configure and build-related
1132 items that merit consideration.  This list isn't exhaustive, it's just
1133 what I came up with off the top of my head.
1134
1135 =head2 Adding missing library functions to Perl
1136
1137 The perl Configure script automatically determines which headers and
1138 functions you have available on your system and arranges for them to be
1139 included in the compilation and linking process.  Occasionally, when porting
1140 perl to an operating system for the first time, you may find that the
1141 operating system is missing a key function.  While perl may still build
1142 without this function, no perl program will be able to reference the missing
1143 function.  You may be able to write the missing function yourself, or you
1144 may be able to find the missing function in the distribution files for
1145 another software package.  In this case, you need to instruct the perl
1146 configure-and-build process to use your function.  Perform these steps.
1147
1148 =over 3
1149
1150 =item *
1151
1152 Code and test the function you wish to add.  Test it carefully; you will
1153 have a much easier time debugging your code independently than when it is a
1154 part of perl.
1155
1156 =item *
1157
1158 Here is an implementation of the POSIX truncate function for an operating
1159 system (VOS) that does not supply one, but which does supply the ftruncate()
1160 function.
1161
1162   /* Beginning of modification history */
1163   /* Written 02-01-02 by Nick Ing-Simmons (nick@ing-simmons.net) */
1164   /* End of modification history */
1165
1166   /* VOS doesn't supply a truncate function, so we build one up
1167      from the available POSIX functions.  */
1168
1169   #include <fcntl.h>
1170   #include <sys/types.h>
1171   #include <unistd.h>
1172
1173   int
1174   truncate(const char *path, off_t len)
1175   {
1176    int fd = open(path,O_WRONLY);
1177    int code = -1;
1178    if (fd >= 0) {
1179      code = ftruncate(fd,len);
1180      close(fd);
1181    }
1182    return code;
1183   }
1184
1185 Place this file into a subdirectory that has the same name as the operating
1186 system. This file is named perl/vos/vos.c
1187
1188 =item *
1189
1190 If your operating system has a hints file (in perl/hints/XXX.sh for an
1191 operating system named XXX), then start with it.  If your operating system
1192 has no hints file, then create one.  You can use a hints file for a similar
1193 operating system, if one exists, as a template.
1194
1195 =item *
1196
1197 Add lines like the following to your hints file. The first line
1198 (d_truncate="define") instructs Configure that the truncate() function
1199 exists. The second line (archobjs="vos.o") instructs the makefiles that the
1200 perl executable depends on the existence of a file named "vos.o".  (Make
1201 will automatically look for "vos.c" and compile it with the same options as
1202 the perl source code).  The final line ("test -h...") adds a symbolic link
1203 to the top-level directory so that make can find vos.c.  Of course, you
1204 should use your own operating system name for the source file of extensions,
1205 not "vos.c".
1206
1207   # VOS does not have truncate() but we supply one in vos.c
1208   d_truncate="define"
1209   archobjs="vos.o"
1210
1211   # Help gmake find vos.c
1212   test -h vos.c || ln -s vos/vos.c vos.c
1213
1214 The hints file is a series of shell commands that are run in the top-level
1215 directory (the "perl" directory).  Thus, these commands are simply executed
1216 by Configure at an appropriate place during its execution.
1217
1218 =item *
1219
1220 At this point, you can run the Configure script and rebuild perl.  Carefully
1221 test the newly-built perl to ensure that normal paths, and error paths,
1222 behave as you expect.
1223
1224 =back
1225
1226 =head2 Good ideas waiting for round tuits
1227
1228 =over 4
1229
1230 =item Configure -Dsrc=/blah/blah
1231
1232 We should be able to emulate B<configure --srcdir>.  Tom Tromey
1233 tromey@creche.cygnus.com has submitted some patches to
1234 the dist-users mailing list along these lines.  They have been folded
1235 back into the main distribution, but various parts of the perl
1236 Configure/build/install process still assume src='.'.
1237
1238 =item Hint file fixes
1239
1240 Various hint files work around Configure problems.  We ought to fix
1241 Configure so that most of them aren't needed.
1242
1243 =item Hint file information
1244
1245 Some of the hint file information (particularly dynamic loading stuff)
1246 ought to be fed back into the main metaconfig distribution.
1247
1248 =back
1249
1250 =head2 Probably good ideas waiting for round tuits
1251
1252 =over 4
1253
1254 =item GNU configure --options
1255
1256 I've received sensible suggestions for --exec_prefix and other
1257 GNU configure --options.  It's not always obvious exactly what is
1258 intended, but this merits investigation.
1259
1260 =item Try gcc if cc fails
1261
1262 Currently, we just give up.
1263
1264 =item bypassing safe*alloc wrappers
1265
1266 On some systems, it may be safe to call the system malloc directly
1267 without going through the util.c safe* layers.  (Such systems would
1268 accept free(0), for example.)  This might be a time-saver for systems
1269 that already have a good malloc.  (Recent Linux libc's apparently have
1270 a nice malloc that is well-tuned for the system.)
1271
1272 =back
1273
1274 =head2 Vague possibilities
1275
1276 =over 4
1277
1278 =item gconvert replacement
1279
1280 Maybe include a replacement function that doesn't lose data in rare
1281 cases of coercion between string and numerical values.
1282
1283 =item Improve makedepend
1284
1285 The current makedepend process is clunky and annoyingly slow, but it
1286 works for most folks.  Alas, it assumes that there is a filename
1287 $firstmakefile that the B<make> command will try to use before it uses
1288 F<Makefile>.  Such may not be the case for all B<make> commands,
1289 particularly those on non-Unix systems.
1290
1291 Probably some variant of the BSD F<.depend> file will be useful.
1292 We ought to check how other packages do this, if they do it at all.
1293 We could probably pre-generate the dependencies (with the exception of
1294 malloc.o, which could probably be determined at F<Makefile.SH>
1295 extraction time.
1296
1297 =item GNU Makefile standard targets
1298
1299 GNU software generally has standardized Makefile targets.  Unless we
1300 have good reason to do otherwise, I see no reason not to support them.
1301
1302 =item File locking
1303
1304 Somehow, straighten out, document, and implement lockf(), flock(),
1305 and/or fcntl() file locking.  It's a mess.  See $d_fcntl_can_lock
1306 in recent config.sh files though.
1307
1308 =back
1309
1310 =head2 Copyright Issues
1311
1312 The following is based on the consensus of a couple of IPR lawyers,
1313 but it is of course not a legally binding statement, just a common
1314 sense summary.
1315
1316 =over 4
1317
1318 =item *
1319
1320 Tacking on copyright statements is unnecessary to begin with because
1321 of the Berne convention.  But assuming you want to go ahead...
1322
1323 =item *
1324
1325 The right form of a copyright statement is
1326
1327         Copyright (C) Year, Year, ... by Someone
1328
1329 The (C) is not required everywhere but it doesn't hurt and in certain
1330 jurisdictions it is required, so let's leave it in.  (Yes, it's true
1331 that in some jurisdictions the "(C)" is not legally binding, one should
1332 use the true ringed-C.  But we don't have that character available for
1333 Perl's source code.)
1334
1335 The years must be listed out separately.  Year-Year is not correct.
1336 Only the years when the piece has changed 'significantly' may be added.
1337
1338 =item *
1339
1340 One cannot give away one's copyright trivially.  One can give one's
1341 copyright away by using public domain, but even that requires a little
1342 bit more than just saying 'this is in public domain'.  (What it
1343 exactly requires depends on your jurisdiction.)  But barring public
1344 domain, one cannot "transfer" one's copyright to another person or
1345 entity.  In the context of software, it means that contributors cannot
1346 give away their copyright or "transfer" it to the "owner" of the software.
1347
1348 Also remember that in many cases if you are employed by someone,
1349 your work may be copyrighted to your employer, even when you are
1350 contributing on your own time (this all depends on too many things
1351 to list here).  But the bottom line is that you definitely can't give
1352 away a copyright you may not even have.
1353
1354 What is possible, however, is that the software can simply state
1355
1356         Copyright (C) Year, Year, ... by Someone and others
1357
1358 and then list the "others" somewhere in the distribution.
1359 And this is exactly what Perl does.  (The "somewhere" is
1360 AUTHORS and the Changes* files.)
1361
1362 =item *
1363
1364 Split files, merged files, and generated files are problematic.
1365 The rule of thumb: in split files, copy the copyright years of
1366 the original file to all the new files; in merged files make
1367 an union of the copyright years of all the old files; in generated
1368 files propagate the copyright years of the generating file(s).
1369
1370 =item *
1371
1372 The files of Perl source code distribution do carry a lot of
1373 copyrights, by various people.  (There are many copyrights embedded in
1374 perl.c, for example.)  The most straightforward thing for pumpkings to
1375 do is to simply update Larry's copyrights at the beginning of the
1376 *.[hcy], *.pl, and README files, and leave all other
1377 copyrights alone.  Doing more than that requires quite a bit of tracking. 
1378
1379 =back
1380
1381 =head1 AUTHORS
1382
1383 Original author:  Andy Dougherty doughera@lafayette.edu .
1384 Additions by Chip Salzenberg chip@perl.com, Tim Bunce and the perl5
1385 development team.
1386
1387 All opinions expressed herein are those of the authorZ<>(s).
1388
1389 =head1 LAST MODIFIED
1390
1391 2017-10-13 H.Merijn Brand