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