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