This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlhack.pod: invoke git-format-patch with --attach
[perl5.git] / pod / perlhack.pod
1 =encoding utf8
2
3 =for comment
4 Consistent formatting of this file is achieved with:
5   perl ./Porting/podtidy pod/perlhack.pod
6
7 =head1 NAME
8
9 perlhack - How to hack on Perl
10
11 =head1 DESCRIPTION
12
13 This document explains how Perl development works. It includes details
14 about the Perl 5 Porters email list, the Perl repository, the Perlbug
15 bug tracker, patch guidelines, and commentary on Perl development
16 philosophy.
17
18 =head1 SUPER QUICK PATCH GUIDE
19
20 If you just want to submit a single small patch like a pod fix, a test
21 for a bug, comment fixes, etc., it's easy! Here's how:
22
23 =over 4
24
25 =item * Check out the source repository
26
27 The perl source is in a git repository. You can clone the repository
28 with the following command:
29
30   % git clone git://perl5.git.perl.org/perl.git perl
31
32 =item * Make your change
33
34 Hack, hack, hack.
35
36 =item * Test your change
37
38 You can run all the tests with the following commands:
39
40   % ./Configure -des -Dusedevel
41   % make test
42
43 Keep hacking until the tests pass.
44
45 =item * Commit your change
46
47 Committing your work will save the change I<on your local system>:
48
49   % git commit -a -m 'Commit message goes here'
50
51 Make sure the commit message describes your change in a single
52 sentence. For example, "Fixed spelling errors in perlhack.pod".
53
54 =item * Send your change to perlbug
55
56 The next step is to submit your patch to the Perl core ticket system
57 via email.
58
59 Assuming your patch consists of a single git commit, the following
60 writes the file as a MIME attachment, and sends it with a meaningful
61 subject:
62
63   % git format-patch -1 --attach
64   % perlbug -s "[PATCH] $(git log -1 --oneline HEAD)" -f 0001-*.patch
65
66 The perlbug program will ask you a few questions about your email
67 address and the patch you're submitting. Once you've answered them you
68 can submit your patch.
69
70 =item * Thank you
71
72 The porters appreciate the time you spent helping to make Perl better.
73 Thank you!
74
75 =back
76
77 =head1 BUG REPORTING
78
79 If you want to report a bug in Perl, you must use the F<perlbug> command
80 line tool. This tool will ensure that your bug report includes all the
81 relevant system and configuration information.
82
83 To browse existing Perl bugs and patches, you can use the web interface
84 at L<http://rt.perl.org/>.
85
86 Please check the archive of the perl5-porters list (see below) and/or
87 the bug tracking system before submitting a bug report. Often, you'll
88 find that the bug has been reported already.
89
90 You can log in to the bug tracking system and comment on existing bug
91 reports. If you have additional information regarding an existing bug,
92 please add it. This will help the porters fix the bug.
93
94 =head1 PERL 5 PORTERS
95
96 The perl5-porters (p5p) mailing list is where the Perl standard
97 distribution is maintained and developed. The people who maintain Perl
98 are also referred to as the "Perl 5 Porters", or just the "porters".
99
100 A searchable archive of the list is available at
101 L<http://www.xray.mpe.mpg.de/mailing-lists/perl5-porters/>. There is
102 also another archive at
103 L<http://archive.develooper.com/perl5-porters@perl.org/>.
104
105 =head2 perl-changes mailing list
106
107 The perl5-changes mailing list receives a copy of each patch that gets
108 submitted to the maintenance and development branches of the perl
109 repository. See L<http://lists.perl.org/list/perl5-changes.html> for
110 subscription and archive information.
111
112 =head1 GETTING THE PERL SOURCE
113
114 All of Perl's source code is kept centrally in a Git repository at
115 I<perl5.git.perl.org>. The repository contains many Perl revisions from
116 Perl 1 onwards and all the revisions from Perforce, the previous
117 version control system.
118
119 For much more detail on using git with the Perl repository, please see
120 L<perlgit>.
121
122 =head2 Read access via Git
123
124 You will need a copy of Git for your computer. You can fetch a copy of
125 the repository using the git protocol:
126
127   % git clone git://perl5.git.perl.org/perl.git perl
128
129 This clones the repository and makes a local copy in the F<perl>
130 directory.
131
132 If you cannot use the git protocol for firewall reasons, you can also
133 clone via http, though this is much slower:
134
135   % git clone http://perl5.git.perl.org/perl.git perl
136
137 =head2 Read access via the web
138
139 You may access the repository over the web. This allows you to browse
140 the tree, see recent commits, subscribe to RSS feeds for the changes,
141 search for particular commits and more. You may access it at
142 L<http://perl5.git.perl.org/perl.git>. A mirror of the repository is
143 found at L<http://github.com/mirrors/perl>.
144
145 =head2 Read access via rsync
146
147 You can also choose to use rsync to get a copy of the current source
148 tree for the bleadperl branch and all maintenance branches:
149
150     % rsync -avz rsync://perl5.git.perl.org/perl-current .
151     % rsync -avz rsync://perl5.git.perl.org/perl-5.12.x .
152     % rsync -avz rsync://perl5.git.perl.org/perl-5.10.x .
153     % rsync -avz rsync://perl5.git.perl.org/perl-5.8.x .
154     % rsync -avz rsync://perl5.git.perl.org/perl-5.6.x .
155     % rsync -avz rsync://perl5.git.perl.org/perl-5.005xx .
156
157 (Add the C<--delete> option to remove leftover files.)
158
159 To get a full list of the available sync points:
160
161     % rsync perl5.git.perl.org::
162
163 =head2 Write access via git
164
165 If you have a commit bit, please see L<perlgit> for more details on
166 using git.
167
168 =head1 PATCHING PERL
169
170 If you're planning to do more extensive work than a single small fix,
171 we encourage you to read the documentation below. This will help you
172 focus your work and make your patches easier to incorporate into the
173 Perl source.
174
175 =head2 Submitting patches
176
177 If you have a small patch to submit, please submit it via perlbug. You
178 can also send email directly to perlbug@perl.org. Please note that
179 messages sent to perlbug may be held in a moderation queue, so you
180 won't receive a response immediately.
181
182 You'll know your submission has been processed when you receive an
183 email from our ticket tracking system. This email will give you a
184 ticket number. Once your patch has made it to the ticket tracking
185 system, it will also be sent to the perl5-porters@perl.org list.
186
187 Patches are reviewed and discussed on the p5p list. Simple,
188 uncontroversial patches will usually be applied without any discussion.
189 When the patch is applied, the ticket will be updated and you will
190 receive email. In addition, an email will be sent to the p5p list.
191
192 In other cases, the patch will need more work or discussion. That will
193 happen on the p5p list.
194
195 You are encouraged to participate in the discussion and advocate for
196 your patch. Sometimes your patch may get lost in the shuffle. It's
197 appropriate to send a reminder email to p5p if no action has been taken
198 in a month. Please remember that the Perl 5 developers are all
199 volunteers, and be polite.
200
201 Changes are always applied directly to the main development branch,
202 called "blead". Some patches may be backported to a maintenance branch.
203 If you think your patch is appropriate for the maintenance branch,
204 please explain why when you submit it.
205
206 =head2 Getting your patch accepted
207
208 If you are submitting a code patch there are several things that you
209 can do to help the Perl 5 Porters accept your patch.
210
211 =head3 Patch style
212
213 If you used git to check out the Perl source, then using C<git
214 format-patch> will produce a patch in a style suitable for Perl. The
215 C<format-patch> command produces one patch file for each commit you
216 made. If you prefer to send a single patch for all commits, you can use
217 C<git diff>.
218
219   % git co blead
220   % git pull
221   % git diff blead my-branch-name
222
223 This produces a patch based on the difference between blead and your
224 current branch. It's important to make sure that blead is up to date
225 before producing the diff, that's why we call C<git pull> first.
226
227 We strongly recommend that you use git if possible. It will make your
228 life easier, and ours as well.
229
230 However, if you're not using git, you can still produce a suitable
231 patch. You'll need a pristine copy of the Perl source to diff against.
232 The porters prefer unified diffs. Using GNU C<diff>, you can produce a
233 diff like this:
234
235   % diff -Npurd perl.pristine perl.mine
236
237 Make sure that you C<make realclean> in your copy of Perl to remove any
238 build artifacts, or you may get a confusing result.
239
240 =head3 Commit message
241
242 As you craft each patch you intend to submit to the Perl core, it's
243 important to write a good commit message. This is especially important
244 if your submission will consist of a series of commits.
245
246 The first line of the commit message should be a short description
247 without a period. It should be no longer than the subject line of an
248 email, 50 characters being a good rule of thumb.
249
250 A lot of Git tools (Gitweb, GitHub, git log --pretty=oneline, ...) will
251 only display the first line (cut off at 50 characters) when presenting
252 commit summaries.
253
254 The commit message should include a description of the problem that the
255 patch corrects or new functionality that the patch adds.
256
257 As a general rule of thumb, your commit message should help a
258 programmer who knows the Perl core quickly understand what you were
259 trying to do, how you were trying to do it, and why the change matters
260 to Perl.
261
262 =over 4
263
264 =item * Why
265
266 Your commit message should describe why the change you are making is
267 important. When someone looks at your change in six months or six
268 years, your intent should be clear.
269
270 If you're deprecating a feature with the intent of later simplifying
271 another bit of code, say so. If you're fixing a performance problem or
272 adding a new feature to support some other bit of the core, mention
273 that.
274
275 =item * What
276
277 Your commit message should describe what part of the Perl core you're
278 changing and what you expect your patch to do.
279
280 =item * How
281
282 While it's not necessary for documentation changes, new tests or
283 trivial patches, it's often worth explaining how your change works.
284 Even if it's clear to you today, it may not be clear to a porter next
285 month or next year.
286
287 =back
288
289 A commit message isn't intended to take the place of comments in your
290 code. Commit messages should describe the change you made, while code
291 comments should describe the current state of the code.
292
293 If you've just implemented a new feature, complete with doc, tests and
294 well-commented code, a brief commit message will often suffice. If,
295 however, you've just changed a single character deep in the parser or
296 lexer, you might need to write a small novel to ensure that future
297 readers understand what you did and why you did it.
298
299 =head3 Comments, Comments, Comments
300
301 Be sure to adequately comment your code. While commenting every line is
302 unnecessary, anything that takes advantage of side effects of
303 operators, that creates changes that will be felt outside of the
304 function being patched, or that others may find confusing should be
305 documented. If you are going to err, it is better to err on the side of
306 adding too many comments than too few.
307
308 The best comments explain I<why> the code does what it does, not I<what
309 it does>.
310
311 =head3 Style
312
313 In general, please follow the particular style of the code you are
314 patching.
315
316 In particular, follow these general guidelines for patching Perl
317 sources:
318
319 =over 4
320
321 =item *
322
323 8-wide tabs (no exceptions!)
324
325 =item *
326
327 4-wide indents for code, 2-wide indents for nested CPP #defines
328
329 =item *
330
331 Try hard not to exceed 79-columns
332
333 =item *
334
335 ANSI C prototypes
336
337 =item *
338
339 Uncuddled elses and "K&R" style for indenting control constructs
340
341 =item *
342
343 No C++ style (//) comments
344
345 =item *
346
347 Mark places that need to be revisited with XXX (and revisit often!)
348
349 =item *
350
351 Opening brace lines up with "if" when conditional spans multiple lines;
352 should be at end-of-line otherwise
353
354 =item *
355
356 In function definitions, name starts in column 0 (return value is on
357 previous line)
358
359 =item *
360
361 Single space after keywords that are followed by parens, no space
362 between function name and following paren
363
364 =item *
365
366 Avoid assignments in conditionals, but if they're unavoidable, use
367 extra paren, e.g. "if (a && (b = c)) ..."
368
369 =item *
370
371 "return foo;" rather than "return(foo);"
372
373 =item *
374
375 "if (!foo) ..." rather than "if (foo == FALSE) ..." etc.
376
377 =back
378
379 =head3 Test suite
380
381 If your patch changes code (rather than just changing documentation),
382 you should also include one or more test cases which illustrate the bug
383 you're fixing or validate the new functionality you're adding. In
384 general, you should update an existing test file rather than create a
385 new one.
386
387 Your test suite additions should generally follow these guidelines
388 (courtesy of Gurusamy Sarathy <gsar@activestate.com>):
389
390 =over 4
391
392 =item *
393
394 Know what you're testing. Read the docs, and the source.
395
396 =item *
397
398 Tend to fail, not succeed.
399
400 =item *
401
402 Interpret results strictly.
403
404 =item *
405
406 Use unrelated features (this will flush out bizarre interactions).
407
408 =item *
409
410 Use non-standard idioms (otherwise you are not testing TIMTOWTDI).
411
412 =item *
413
414 Avoid using hardcoded test numbers whenever possible (the EXPECTED/GOT
415 found in t/op/tie.t is much more maintainable, and gives better failure
416 reports).
417
418 =item *
419
420 Give meaningful error messages when a test fails.
421
422 =item *
423
424 Avoid using qx// and system() unless you are testing for them. If you
425 do use them, make sure that you cover _all_ perl platforms.
426
427 =item *
428
429 Unlink any temporary files you create.
430
431 =item *
432
433 Promote unforeseen warnings to errors with $SIG{__WARN__}.
434
435 =item *
436
437 Be sure to use the libraries and modules shipped with the version being
438 tested, not those that were already installed.
439
440 =item *
441
442 Add comments to the code explaining what you are testing for.
443
444 =item *
445
446 Make updating the '1..42' string unnecessary. Or make sure that you
447 update it.
448
449 =item *
450
451 Test _all_ behaviors of a given operator, library, or function.
452
453 Test all optional arguments.
454
455 Test return values in various contexts (boolean, scalar, list, lvalue).
456
457 Use both global and lexical variables.
458
459 Don't forget the exceptional, pathological cases.
460
461 =back
462
463 =head2 Patching a core module
464
465 This works just like patching anything else, with one extra
466 consideration.
467
468 Some core modules also live on CPAN and are maintained outside of the
469 Perl core. When the author updates the module, the updates are simply
470 copied into the core.
471
472 Modules in the F<cpan/> directory of the source tree are maintained
473 outside of the Perl core. See that module's listing on documentation or
474 its listing on L<http://search.cpan.org/> for more information on
475 reporting bugs and submitting patches.
476
477 In contrast, modules in the F<dist/> directory are maintained in the
478 core.
479
480 =head2 Updating perldelta
481
482 For changes significant enough to warrant a F<pod/perldelta.pod> entry,
483 the porters will greatly appreciate it if you submit a delta entry
484 along with your actual change. Significant changes include, but are not
485 limited to:
486
487 =over 4
488
489 =item *
490
491 Adding, deprecating, or removing core features
492
493 =item *
494
495 Adding, deprecating, removing, or upgrading core or dual-life modules
496
497 =item *
498
499 Adding new core tests
500
501 =item *
502
503 Fixing security issues and user-visible bugs in the core
504
505 =item *
506
507 Changes that might break existing code, either on the perl or C level
508
509 =item *
510
511 Significant performance improvements
512
513 =item *
514
515 Adding, removing, or significantly changing documentation in the
516 F<pod/> directory
517
518 =item *
519
520 Important platform-specific changes
521
522 =back
523
524 Please make sure you add the perldelta entry to the right section
525 within F<pod/perldelta.pod>. More information on how to write good
526 perldelta entries is available in the C<Style> section of
527 F<Porting/how_to_write_a_perldelta.pod>.
528
529 =head2 What makes for a good patch?
530
531 New features and extensions to the language can be contentious. There
532 is no specific set of criteria which determine what features get added,
533 but here are some questions to consider when developing a patch:
534
535 =head3 Does the concept match the general goals of Perl?
536
537 Our goals include, but are not limited to:
538
539 =over 4
540
541 =item 1.
542
543 Keep it fast, simple, and useful.
544
545 =item 2.
546
547 Keep features/concepts as orthogonal as possible.
548
549 =item 3.
550
551 No arbitrary limits (platforms, data sizes, cultures).
552
553 =item 4.
554
555 Keep it open and exciting to use/patch/advocate Perl everywhere.
556
557 =item 5.
558
559 Either assimilate new technologies, or build bridges to them.
560
561 =back
562
563 =head3 Where is the implementation?
564
565 All the talk in the world is useless without an implementation. In
566 almost every case, the person or people who argue for a new feature
567 will be expected to be the ones who implement it. Porters capable of
568 coding new features have their own agendas, and are not available to
569 implement your (possibly good) idea.
570
571 =head3 Backwards compatibility
572
573 It's a cardinal sin to break existing Perl programs. New warnings can
574 be contentious--some say that a program that emits warnings is not
575 broken, while others say it is. Adding keywords has the potential to
576 break programs, changing the meaning of existing token sequences or
577 functions might break programs.
578
579 The Perl 5 core includes mechanisms to help porters make backwards
580 incompatible changes more compatible such as the L<feature> and
581 L<deprecate> modules. Please use them when appropriate.
582
583 =head3 Could it be a module instead?
584
585 Perl 5 has extension mechanisms, modules and XS, specifically to avoid
586 the need to keep changing the Perl interpreter. You can write modules
587 that export functions, you can give those functions prototypes so they
588 can be called like built-in functions, you can even write XS code to
589 mess with the runtime data structures of the Perl interpreter if you
590 want to implement really complicated things.
591
592 Whenever possible, new features should be prototyped in a CPAN module
593 before they will be considered for the core.
594
595 =head3 Is the feature generic enough?
596
597 Is this something that only the submitter wants added to the language,
598 or is it broadly useful?  Sometimes, instead of adding a feature with a
599 tight focus, the porters might decide to wait until someone implements
600 the more generalized feature.
601
602 =head3 Does it potentially introduce new bugs?
603
604 Radical rewrites of large chunks of the Perl interpreter have the
605 potential to introduce new bugs.
606
607 =head3 How big is it?
608
609 The smaller and more localized the change, the better. Similarly, a
610 series of small patches is greatly preferred over a single large patch.
611
612 =head3 Does it preclude other desirable features?
613
614 A patch is likely to be rejected if it closes off future avenues of
615 development. For instance, a patch that placed a true and final
616 interpretation on prototypes is likely to be rejected because there are
617 still options for the future of prototypes that haven't been addressed.
618
619 =head3 Is the implementation robust?
620
621 Good patches (tight code, complete, correct) stand more chance of going
622 in. Sloppy or incorrect patches might be placed on the back burner
623 until the pumpking has time to fix, or might be discarded altogether
624 without further notice.
625
626 =head3 Is the implementation generic enough to be portable?
627
628 The worst patches make use of system-specific features. It's highly
629 unlikely that non-portable additions to the Perl language will be
630 accepted.
631
632 =head3 Is the implementation tested?
633
634 Patches which change behaviour (fixing bugs or introducing new
635 features) must include regression tests to verify that everything works
636 as expected.
637
638 Without tests provided by the original author, how can anyone else
639 changing perl in the future be sure that they haven't unwittingly
640 broken the behaviour the patch implements? And without tests, how can
641 the patch's author be confident that his/her hard work put into the
642 patch won't be accidentally thrown away by someone in the future?
643
644 =head3 Is there enough documentation?
645
646 Patches without documentation are probably ill-thought out or
647 incomplete. No features can be added or changed without documentation,
648 so submitting a patch for the appropriate pod docs as well as the
649 source code is important.
650
651 =head3 Is there another way to do it?
652
653 Larry said "Although the Perl Slogan is I<There's More Than One Way to
654 Do It>, I hesitate to make 10 ways to do something". This is a tricky
655 heuristic to navigate, though--one man's essential addition is another
656 man's pointless cruft.
657
658 =head3 Does it create too much work?
659
660 Work for the pumpking, work for Perl programmers, work for module
661 authors, ... Perl is supposed to be easy.
662
663 =head3 Patches speak louder than words
664
665 Working code is always preferred to pie-in-the-sky ideas. A patch to
666 add a feature stands a much higher chance of making it to the language
667 than does a random feature request, no matter how fervently argued the
668 request might be. This ties into "Will it be useful?", as the fact that
669 someone took the time to make the patch demonstrates a strong desire
670 for the feature.
671
672 =head1 TESTING
673
674 The core uses the same testing style as the rest of Perl, a simple
675 "ok/not ok" run through Test::Harness, but there are a few special
676 considerations.
677
678 There are three ways to write a test in the core. L<Test::More>,
679 F<t/test.pl> and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">. The
680 decision of which to use depends on what part of the test suite you're
681 working on. This is a measure to prevent a high-level failure (such as
682 Config.pm breaking) from causing basic functionality tests to fail.
683
684 The F<t/test.pl> library provides some of the features of
685 L<Test::More>, but avoids loading most modules and uses as few core
686 features as possible.
687
688 If you write your own test, use the L<Test Anything Protocol|http://testanything.org>.
689
690 =over 4
691
692 =item * F<t/base> and F<t/comp>
693
694 Since we don't know if require works, or even subroutines, use ad hoc
695 tests for these two. Step carefully to avoid using the feature being
696 tested.
697
698 =item * F<t/cmd>, F<t/run>, F<t/io> and F<t/op>
699
700 Now that basic require() and subroutines are tested, you can use the
701 F<t/test.pl> library.
702
703 You can also use certain libraries like Config conditionally, but be
704 sure to skip the test gracefully if it's not there.
705
706 =item * Everything else
707
708 Now that the core of Perl is tested, L<Test::More> can and should be
709 used. You can also use the full suite of core modules in the tests.
710
711 =back
712
713 When you say "make test", Perl uses the F<t/TEST> program to run the
714 test suite (except under Win32 where it uses F<t/harness> instead). All
715 tests are run from the F<t/> directory, B<not> the directory which
716 contains the test. This causes some problems with the tests in F<lib/>,
717 so here's some opportunity for some patching.
718
719 You must be triply conscious of cross-platform concerns. This usually
720 boils down to using L<File::Spec> and avoiding things like C<fork()>
721 and C<system()> unless absolutely necessary.
722
723 =head2 Special C<make test> targets
724
725 There are various special make targets that can be used to test Perl
726 slightly differently than the standard "test" target. Not all them are
727 expected to give a 100% success rate. Many of them have several
728 aliases, and many of them are not available on certain operating
729 systems.
730
731 =over 4
732
733 =item * test_porting
734
735 This runs some basic sanity tests on the source tree and helps catch
736 basic errors before you submit a patch.
737
738 =item * coretest
739
740 Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
741
742 (Not available on Win32)
743
744 =item * test.deparse
745
746 Run all the tests through L<B::Deparse>. Not all tests will succeed.
747
748 (Not available on Win32)
749
750 =item * test.taintwarn
751
752 Run all tests with the B<-t> command-line switch. Not all tests are
753 expected to succeed (until they're specifically fixed, of course).
754
755 (Not available on Win32)
756
757 =item * minitest
758
759 Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
760 F<t/op>, F<t/uni> and F<t/mro> tests.
761
762 =item * test.valgrind check.valgrind utest.valgrind ucheck.valgrind
763
764 (Only in Linux) Run all the tests using the memory leak + naughty
765 memory access tool "valgrind". The log files will be named
766 F<testname.valgrind>.
767
768 =item * test.torture torturetest
769
770 Run all the usual tests and some extra tests. As of Perl 5.8.0, the only
771 extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
772
773 You can also run the torture test with F<t/harness> by giving
774 C<-torture> argument to F<t/harness>.
775
776 =item * utest ucheck test.utf8 check.utf8
777
778 Run all the tests with -Mutf8. Not all tests will succeed.
779
780 (Not available on Win32)
781
782 =item * minitest.utf16 test.utf16
783
784 Runs the tests with UTF-16 encoded scripts, encoded with different
785 versions of this encoding.
786
787 C<make utest.utf16> runs the test suite with a combination of C<-utf8>
788 and C<-utf16> arguments to F<t/TEST>.
789
790 (Not available on Win32)
791
792 =item * test_harness
793
794 Run the test suite with the F<t/harness> controlling program, instead
795 of F<t/TEST>. F<t/harness> is more sophisticated, and uses the
796 L<Test::Harness> module, thus using this test target supposes that perl
797 mostly works. The main advantage for our purposes is that it prints a
798 detailed summary of failed tests at the end. Also, unlike F<t/TEST>, it
799 doesn't redirect stderr to stdout.
800
801 Note that under Win32 F<t/harness> is always used instead of F<t/TEST>,
802 so there is no special "test_harness" target.
803
804 Under Win32's "test" target you may use the TEST_SWITCHES and
805 TEST_FILES environment variables to control the behaviour of
806 F<t/harness>. This means you can say
807
808     nmake test TEST_FILES="op/*.t"
809     nmake test TEST_SWITCHES="-torture" TEST_FILES="op/*.t"
810
811 =item * test-notty test_notty
812
813 Sets PERL_SKIP_TTY_TEST to true before running normal test.
814
815 =back
816
817 =head2 Parallel tests
818
819 The core distribution can now run its regression tests in parallel on
820 Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS>
821 in your environment to the number of tests to run in parallel, and run
822 C<make test_harness>. On a Bourne-like shell, this can be done as
823
824     TEST_JOBS=3 make test_harness  # Run 3 tests in parallel
825
826 An environment variable is used, rather than parallel make itself,
827 because L<TAP::Harness> needs to be able to schedule individual
828 non-conflicting test scripts itself, and there is no standard interface
829 to C<make> utilities to interact with their job schedulers.
830
831 Note that currently some test scripts may fail when run in parallel (most
832 notably C<ext/IO/t/io_dir.t>). If necessary, run just the failing scripts
833 again sequentially and see if the failures go away.
834
835 =head2 Running tests by hand
836
837 You can run part of the test suite by hand by using one of the following
838 commands from the F<t/> directory:
839
840     ./perl -I../lib TEST list-of-.t-files
841
842 or
843
844     ./perl -I../lib harness list-of-.t-files
845
846 (If you don't specify test scripts, the whole test suite will be run.)
847
848 =head2 Using F<t/harness> for testing
849
850 If you use C<harness> for testing, you have several command line options
851 available to you. The arguments are as follows, and are in the order
852 that they must appear if used together.
853
854     harness -v -torture -re=pattern LIST OF FILES TO TEST
855     harness -v -torture -re LIST OF PATTERNS TO MATCH
856
857 If C<LIST OF FILES TO TEST> is omitted, the file list is obtained from
858 the manifest. The file list may include shell wildcards which will be
859 expanded out.
860
861 =over 4
862
863 =item * -v
864
865 Run the tests under verbose mode so you can see what tests were run,
866 and debug output.
867
868 =item * -torture
869
870 Run the torture tests as well as the normal set.
871
872 =item * -re=PATTERN
873
874 Filter the file list so that all the test files run match PATTERN. Note
875 that this form is distinct from the B<-re LIST OF PATTERNS> form below
876 in that it allows the file list to be provided as well.
877
878 =item * -re LIST OF PATTERNS
879
880 Filter the file list so that all the test files run match
881 /(LIST|OF|PATTERNS)/. Note that with this form the patterns are joined
882 by '|' and you cannot supply a list of files, instead the test files
883 are obtained from the MANIFEST.
884
885 =back
886
887 You can run an individual test by a command similar to
888
889     ./perl -I../lib path/to/foo.t
890
891 except that the harnesses set up some environment variables that may
892 affect the execution of the test:
893
894 =over 4
895
896 =item * PERL_CORE=1
897
898 indicates that we're running this test as part of the perl core test
899 suite. This is useful for modules that have a dual life on CPAN.
900
901 =item * PERL_DESTRUCT_LEVEL=2
902
903 is set to 2 if it isn't set already (see
904 L<perlhacktips/PERL_DESTRUCT_LEVEL>).
905
906 =item * PERL
907
908 (used only by F<t/TEST>) if set, overrides the path to the perl
909 executable that should be used to run the tests (the default being
910 F<./perl>).
911
912 =item * PERL_SKIP_TTY_TEST
913
914 if set, tells to skip the tests that need a terminal. It's actually set
915 automatically by the Makefile, but can also be forced artificially by
916 running 'make test_notty'.
917
918 =back
919
920 =head3 Other environment variables that may influence tests
921
922 =over 4
923
924 =item * PERL_TEST_Net_Ping
925
926 Setting this variable runs all the Net::Ping modules tests, otherwise
927 some tests that interact with the outside world are skipped. See
928 L<perl58delta>.
929
930 =item * PERL_TEST_NOVREXX
931
932 Setting this variable skips the vrexx.t tests for OS2::REXX.
933
934 =item * PERL_TEST_NUMCONVERTS
935
936 This sets a variable in op/numconvert.t.
937
938 =back
939
940 See also the documentation for the Test and Test::Harness modules, for
941 more environment variables that affect testing.
942
943 =head1 MORE READING FOR GUTS HACKERS
944
945 To hack on the Perl guts, you'll need to read the following things:
946
947 =over 4
948
949 =item * L<perlsource>
950
951 An overview of the Perl source tree. This will help you find the files
952 you're looking for.
953
954 =item * L<perlinterp>
955
956 An overview of the Perl interpreter source code and some details on how
957 Perl does what it does.
958
959 =item * L<perlhacktut>
960
961 This document walks through the creation of a small patch to Perl's C
962 code. If you're just getting started with Perl core hacking, this will
963 help you understand how it works.
964
965 =item * L<perlhacktips>
966
967 More details on hacking the Perl core. This document focuses on lower
968 level details such as how to write tests, compilation issues,
969 portability, debugging, etc.
970
971 If you plan on doing serious C hacking, make sure to read this.
972
973 =item * L<perlguts>
974
975 This is of paramount importance, since it's the documentation of what
976 goes where in the Perl source. Read it over a couple of times and it
977 might start to make sense - don't worry if it doesn't yet, because the
978 best way to study it is to read it in conjunction with poking at Perl
979 source, and we'll do that later on.
980
981 Gisle Aas's "illustrated perlguts", also known as I<illguts>, has very
982 helpful pictures:
983
984 L<http://search.cpan.org/dist/illguts/>
985
986 =item * L<perlxstut> and L<perlxs>
987
988 A working knowledge of XSUB programming is incredibly useful for core
989 hacking; XSUBs use techniques drawn from the PP code, the portion of
990 the guts that actually executes a Perl program. It's a lot gentler to
991 learn those techniques from simple examples and explanation than from
992 the core itself.
993
994 =item * L<perlapi>
995
996 The documentation for the Perl API explains what some of the internal
997 functions do, as well as the many macros used in the source.
998
999 =item * F<Porting/pumpkin.pod>
1000
1001 This is a collection of words of wisdom for a Perl porter; some of it
1002 is only useful to the pumpkin holder, but most of it applies to anyone
1003 wanting to go about Perl development.
1004
1005 =item * The perl5-porters FAQ
1006
1007 This should be available from
1008 http://dev.perl.org/perl5/docs/p5p-faq.html . It contains hints on
1009 reading perl5-porters, information on how perl5-porters works and how
1010 Perl development in general works.
1011
1012 =back
1013
1014 =head1 CPAN TESTERS AND PERL SMOKERS
1015
1016 The CPAN testers ( http://testers.cpan.org/ ) are a group of volunteers
1017 who test CPAN modules on a variety of platforms.
1018
1019 Perl Smokers ( http://www.nntp.perl.org/group/perl.daily-build/ and
1020 http://www.nntp.perl.org/group/perl.daily-build.reports/ )
1021 automatically test Perl source releases on platforms with various
1022 configurations.
1023
1024 Both efforts welcome volunteers. In order to get involved in smoke
1025 testing of the perl itself visit
1026 L<http://search.cpan.org/dist/Test-Smoke/>. In order to start smoke
1027 testing CPAN modules visit
1028 L<http://search.cpan.org/dist/CPANPLUS-YACSmoke/> or
1029 L<http://search.cpan.org/dist/minismokebox/> or
1030 L<http://search.cpan.org/dist/CPAN-Reporter/>.
1031
1032 =head1 WHAT NEXT?
1033
1034 If you've read all the documentation in the document and the ones
1035 listed above, you're more than ready to hack on Perl.
1036
1037 Here's some more recommendations
1038
1039 =over 4
1040
1041 =item *
1042
1043 Subscribe to perl5-porters, follow the patches and try and understand
1044 them; don't be afraid to ask if there's a portion you're not clear on -
1045 who knows, you may unearth a bug in the patch...
1046
1047 =item *
1048
1049 Do read the README associated with your operating system, e.g.
1050 README.aix on the IBM AIX OS. Don't hesitate to supply patches to that
1051 README if you find anything missing or changed over a new OS release.
1052
1053 =item *
1054
1055 Find an area of Perl that seems interesting to you, and see if you can
1056 work out how it works. Scan through the source, and step over it in the
1057 debugger. Play, poke, investigate, fiddle! You'll probably get to
1058 understand not just your chosen area but a much wider range of
1059 F<perl>'s activity as well, and probably sooner than you'd think.
1060
1061 =back
1062
1063 =head2 "The Road goes ever on and on, down from the door where it began."
1064
1065 If you can do these things, you've started on the long road to Perl
1066 porting. Thanks for wanting to help make Perl better - and happy
1067 hacking!
1068
1069 =head2 Metaphoric Quotations
1070
1071 If you recognized the quote about the Road above, you're in luck.
1072
1073 Most software projects begin each file with a literal description of
1074 each file's purpose. Perl instead begins each with a literary allusion
1075 to that file's purpose.
1076
1077 Like chapters in many books, all top-level Perl source files (along
1078 with a few others here and there) begin with an epigramic inscription
1079 that alludes, indirectly and metaphorically, to the material you're
1080 about to read.
1081
1082 Quotations are taken from writings of J.R.R. Tolkien pertaining to his
1083 Legendarium, almost always from I<The Lord of the Rings>. Chapters and
1084 page numbers are given using the following editions:
1085
1086 =over 4
1087
1088 =item *
1089
1090 I<The Hobbit>, by J.R.R. Tolkien. The hardcover, 70th-anniversary
1091 edition of 2007 was used, published in the UK by Harper Collins
1092 Publishers and in the US by the Houghton Mifflin Company.
1093
1094 =item *
1095
1096 I<The Lord of the Rings>, by J.R.R. Tolkien. The hardcover,
1097 50th-anniversary edition of 2004 was used, published in the UK by
1098 Harper Collins Publishers and in the US by the Houghton Mifflin
1099 Company.
1100
1101 =item *
1102
1103 I<The Lays of Beleriand>, by J.R.R. Tolkien and published posthumously
1104 by his son and literary executor, C.J.R. Tolkien, being the 3rd of the
1105 12 volumes in Christopher's mammoth I<History of Middle Earth>. Page
1106 numbers derive from the hardcover edition, first published in 1983 by
1107 George Allen & Unwin; no page numbers changed for the special 3-volume
1108 omnibus edition of 2002 or the various trade-paper editions, all again
1109 now by Harper Collins or Houghton Mifflin.
1110
1111 =back
1112
1113 Other JRRT books fair game for quotes would thus include I<The
1114 Adventures of Tom Bombadil>, I<The Silmarillion>, I<Unfinished Tales>,
1115 and I<The Tale of the Children of Hurin>, all but the first
1116 posthumously assembled by CJRT. But I<The Lord of the Rings> itself is
1117 perfectly fine and probably best to quote from, provided you can find a
1118 suitable quote there.
1119
1120 So if you were to supply a new, complete, top-level source file to add
1121 to Perl, you should conform to this peculiar practice by yourself
1122 selecting an appropriate quotation from Tolkien, retaining the original
1123 spelling and punctuation and using the same format the rest of the
1124 quotes are in. Indirect and oblique is just fine; remember, it's a
1125 metaphor, so being meta is, after all, what it's for.
1126
1127 =head1 AUTHOR
1128
1129 This document was originally written by Nathan Torkington, and is
1130 maintained by the perl5-porters mailing list.
1131