Bump $XS::Typemap::VERSION after previous commit.
[perl.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 are submitting a code patch there are several things that you
216 can do to help the Perl 5 Porters accept your patch.
217
218 =head3 Patch style
219
220 If you used git to check out the Perl source, then using C<git
221 format-patch> will produce a patch in a style suitable for Perl. The
222 C<format-patch> command produces one patch file for each commit you
223 made. If you prefer to send a single patch for all commits, you can use
224 C<git diff>.
225
226   % git checkout blead
227   % git pull
228   % git diff blead my-branch-name
229
230 This produces a patch based on the difference between blead and your
231 current branch. It's important to make sure that blead is up to date
232 before producing the diff, that's why we call C<git pull> first.
233
234 We strongly recommend that you use git if possible. It will make your
235 life easier, and ours as well.
236
237 However, if you're not using git, you can still produce a suitable
238 patch. You'll need a pristine copy of the Perl source to diff against.
239 The porters prefer unified diffs. Using GNU C<diff>, you can produce a
240 diff like this:
241
242   % diff -Npurd perl.pristine perl.mine
243
244 Make sure that you C<make realclean> in your copy of Perl to remove any
245 build artifacts, or you may get a confusing result.
246
247 =head3 Commit message
248
249 As you craft each patch you intend to submit to the Perl core, it's
250 important to write a good commit message. This is especially important
251 if your submission will consist of a series of commits.
252
253 The first line of the commit message should be a short description
254 without a period. It should be no longer than the subject line of an
255 email, 50 characters being a good rule of thumb.
256
257 A lot of Git tools (Gitweb, GitHub, git log --pretty=oneline, ...) will
258 only display the first line (cut off at 50 characters) when presenting
259 commit summaries.
260
261 The commit message should include a description of the problem that the
262 patch corrects or new functionality that the patch adds.
263
264 As a general rule of thumb, your commit message should help a
265 programmer who knows the Perl core quickly understand what you were
266 trying to do, how you were trying to do it, and why the change matters
267 to Perl.
268
269 =over 4
270
271 =item * Why
272
273 Your commit message should describe why the change you are making is
274 important. When someone looks at your change in six months or six
275 years, your intent should be clear.
276
277 If you're deprecating a feature with the intent of later simplifying
278 another bit of code, say so. If you're fixing a performance problem or
279 adding a new feature to support some other bit of the core, mention
280 that.
281
282 =item * What
283
284 Your commit message should describe what part of the Perl core you're
285 changing and what you expect your patch to do.
286
287 =item * How
288
289 While it's not necessary for documentation changes, new tests or
290 trivial patches, it's often worth explaining how your change works.
291 Even if it's clear to you today, it may not be clear to a porter next
292 month or next year.
293
294 =back
295
296 A commit message isn't intended to take the place of comments in your
297 code. Commit messages should describe the change you made, while code
298 comments should describe the current state of the code.
299
300 If you've just implemented a new feature, complete with doc, tests and
301 well-commented code, a brief commit message will often suffice. If,
302 however, you've just changed a single character deep in the parser or
303 lexer, you might need to write a small novel to ensure that future
304 readers understand what you did and why you did it.
305
306 =head3 Comments, Comments, Comments
307
308 Be sure to adequately comment your code. While commenting every line is
309 unnecessary, anything that takes advantage of side effects of
310 operators, that creates changes that will be felt outside of the
311 function being patched, or that others may find confusing should be
312 documented. If you are going to err, it is better to err on the side of
313 adding too many comments than too few.
314
315 The best comments explain I<why> the code does what it does, not I<what
316 it does>.
317
318 =head3 Style
319
320 In general, please follow the particular style of the code you are
321 patching.
322
323 In particular, follow these general guidelines for patching Perl
324 sources:
325
326 =over 4
327
328 =item *
329
330 8-wide tabs (no exceptions!)
331
332 =item *
333
334 4-wide indents for code, 2-wide indents for nested CPP #defines
335
336 =item *
337
338 Try hard not to exceed 79-columns
339
340 =item *
341
342 ANSI C prototypes
343
344 =item *
345
346 Uncuddled elses and "K&R" style for indenting control constructs
347
348 =item *
349
350 No C++ style (//) comments
351
352 =item *
353
354 Mark places that need to be revisited with XXX (and revisit often!)
355
356 =item *
357
358 Opening brace lines up with "if" when conditional spans multiple lines;
359 should be at end-of-line otherwise
360
361 =item *
362
363 In function definitions, name starts in column 0 (return value is on
364 previous line)
365
366 =item *
367
368 Single space after keywords that are followed by parens, no space
369 between function name and following paren
370
371 =item *
372
373 Avoid assignments in conditionals, but if they're unavoidable, use
374 extra paren, e.g. "if (a && (b = c)) ..."
375
376 =item *
377
378 "return foo;" rather than "return(foo);"
379
380 =item *
381
382 "if (!foo) ..." rather than "if (foo == FALSE) ..." etc.
383
384 =back
385
386 =head3 Test suite
387
388 If your patch changes code (rather than just changing documentation),
389 you should also include one or more test cases which illustrate the bug
390 you're fixing or validate the new functionality you're adding. In
391 general, you should update an existing test file rather than create a
392 new one.
393
394 Your test suite additions should generally follow these guidelines
395 (courtesy of Gurusamy Sarathy <gsar@activestate.com>):
396
397 =over 4
398
399 =item *
400
401 Know what you're testing. Read the docs, and the source.
402
403 =item *
404
405 Tend to fail, not succeed.
406
407 =item *
408
409 Interpret results strictly.
410
411 =item *
412
413 Use unrelated features (this will flush out bizarre interactions).
414
415 =item *
416
417 Use non-standard idioms (otherwise you are not testing TIMTOWTDI).
418
419 =item *
420
421 Avoid using hardcoded test numbers whenever possible (the EXPECTED/GOT
422 found in t/op/tie.t is much more maintainable, and gives better failure
423 reports).
424
425 =item *
426
427 Give meaningful error messages when a test fails.
428
429 =item *
430
431 Avoid using qx// and system() unless you are testing for them. If you
432 do use them, make sure that you cover _all_ perl platforms.
433
434 =item *
435
436 Unlink any temporary files you create.
437
438 =item *
439
440 Promote unforeseen warnings to errors with $SIG{__WARN__}.
441
442 =item *
443
444 Be sure to use the libraries and modules shipped with the version being
445 tested, not those that were already installed.
446
447 =item *
448
449 Add comments to the code explaining what you are testing for.
450
451 =item *
452
453 Make updating the '1..42' string unnecessary. Or make sure that you
454 update it.
455
456 =item *
457
458 Test _all_ behaviors of a given operator, library, or function.
459
460 Test all optional arguments.
461
462 Test return values in various contexts (boolean, scalar, list, lvalue).
463
464 Use both global and lexical variables.
465
466 Don't forget the exceptional, pathological cases.
467
468 =back
469
470 =head2 Patching a core module
471
472 This works just like patching anything else, with one extra
473 consideration.
474
475 Modules in the F<cpan/> directory of the source tree are maintained
476 outside of the Perl core. When the author updates the module, the
477 updates are simply copied into the core.  See that module's
478 documentation or its listing on L<http://search.cpan.org/> for more
479 information on reporting bugs and submitting patches.
480
481 In most cases, patches to modules in F<cpan/> should be sent upstream
482 and should not be applied to the Perl core individually.  If a patch to
483 a file in F<cpan/> absolutely cannot wait for the fix to be made
484 upstream, released to CPAN and copied to blead, you must add (or
485 update) a C<CUSTOMIZED> entry in the F<"Porting/Maintainers.pl"> file
486 to flag that a local modification has been made.  See
487 F<"Porting/Maintainers.pl"> for more details.
488
489 In contrast, modules in the F<dist/> directory are maintained in the
490 core.
491
492 =head2 Updating perldelta
493
494 For changes significant enough to warrant a F<pod/perldelta.pod> entry,
495 the porters will greatly appreciate it if you submit a delta entry
496 along with your actual change. Significant changes include, but are not
497 limited to:
498
499 =over 4
500
501 =item *
502
503 Adding, deprecating, or removing core features
504
505 =item *
506
507 Adding, deprecating, removing, or upgrading core or dual-life modules
508
509 =item *
510
511 Adding new core tests
512
513 =item *
514
515 Fixing security issues and user-visible bugs in the core
516
517 =item *
518
519 Changes that might break existing code, either on the perl or C level
520
521 =item *
522
523 Significant performance improvements
524
525 =item *
526
527 Adding, removing, or significantly changing documentation in the
528 F<pod/> directory
529
530 =item *
531
532 Important platform-specific changes
533
534 =back
535
536 Please make sure you add the perldelta entry to the right section
537 within F<pod/perldelta.pod>. More information on how to write good
538 perldelta entries is available in the C<Style> section of
539 F<Porting/how_to_write_a_perldelta.pod>.
540
541 =head2 What makes for a good patch?
542
543 New features and extensions to the language can be contentious. There
544 is no specific set of criteria which determine what features get added,
545 but here are some questions to consider when developing a patch:
546
547 =head3 Does the concept match the general goals of Perl?
548
549 Our goals include, but are not limited to:
550
551 =over 4
552
553 =item 1.
554
555 Keep it fast, simple, and useful.
556
557 =item 2.
558
559 Keep features/concepts as orthogonal as possible.
560
561 =item 3.
562
563 No arbitrary limits (platforms, data sizes, cultures).
564
565 =item 4.
566
567 Keep it open and exciting to use/patch/advocate Perl everywhere.
568
569 =item 5.
570
571 Either assimilate new technologies, or build bridges to them.
572
573 =back
574
575 =head3 Where is the implementation?
576
577 All the talk in the world is useless without an implementation. In
578 almost every case, the person or people who argue for a new feature
579 will be expected to be the ones who implement it. Porters capable of
580 coding new features have their own agendas, and are not available to
581 implement your (possibly good) idea.
582
583 =head3 Backwards compatibility
584
585 It's a cardinal sin to break existing Perl programs. New warnings can
586 be contentious--some say that a program that emits warnings is not
587 broken, while others say it is. Adding keywords has the potential to
588 break programs, changing the meaning of existing token sequences or
589 functions might break programs.
590
591 The Perl 5 core includes mechanisms to help porters make backwards
592 incompatible changes more compatible such as the L<feature> and
593 L<deprecate> modules. Please use them when appropriate.
594
595 =head3 Could it be a module instead?
596
597 Perl 5 has extension mechanisms, modules and XS, specifically to avoid
598 the need to keep changing the Perl interpreter. You can write modules
599 that export functions, you can give those functions prototypes so they
600 can be called like built-in functions, you can even write XS code to
601 mess with the runtime data structures of the Perl interpreter if you
602 want to implement really complicated things.
603
604 Whenever possible, new features should be prototyped in a CPAN module
605 before they will be considered for the core.
606
607 =head3 Is the feature generic enough?
608
609 Is this something that only the submitter wants added to the language,
610 or is it broadly useful?  Sometimes, instead of adding a feature with a
611 tight focus, the porters might decide to wait until someone implements
612 the more generalized feature.
613
614 =head3 Does it potentially introduce new bugs?
615
616 Radical rewrites of large chunks of the Perl interpreter have the
617 potential to introduce new bugs.
618
619 =head3 How big is it?
620
621 The smaller and more localized the change, the better. Similarly, a
622 series of small patches is greatly preferred over a single large patch.
623
624 =head3 Does it preclude other desirable features?
625
626 A patch is likely to be rejected if it closes off future avenues of
627 development. For instance, a patch that placed a true and final
628 interpretation on prototypes is likely to be rejected because there are
629 still options for the future of prototypes that haven't been addressed.
630
631 =head3 Is the implementation robust?
632
633 Good patches (tight code, complete, correct) stand more chance of going
634 in. Sloppy or incorrect patches might be placed on the back burner
635 until the pumpking has time to fix, or might be discarded altogether
636 without further notice.
637
638 =head3 Is the implementation generic enough to be portable?
639
640 The worst patches make use of system-specific features. It's highly
641 unlikely that non-portable additions to the Perl language will be
642 accepted.
643
644 =head3 Is the implementation tested?
645
646 Patches which change behaviour (fixing bugs or introducing new
647 features) must include regression tests to verify that everything works
648 as expected.
649
650 Without tests provided by the original author, how can anyone else
651 changing perl in the future be sure that they haven't unwittingly
652 broken the behaviour the patch implements? And without tests, how can
653 the patch's author be confident that his/her hard work put into the
654 patch won't be accidentally thrown away by someone in the future?
655
656 =head3 Is there enough documentation?
657
658 Patches without documentation are probably ill-thought out or
659 incomplete. No features can be added or changed without documentation,
660 so submitting a patch for the appropriate pod docs as well as the
661 source code is important.
662
663 =head3 Is there another way to do it?
664
665 Larry said "Although the Perl Slogan is I<There's More Than One Way to
666 Do It>, I hesitate to make 10 ways to do something". This is a tricky
667 heuristic to navigate, though--one man's essential addition is another
668 man's pointless cruft.
669
670 =head3 Does it create too much work?
671
672 Work for the pumpking, work for Perl programmers, work for module
673 authors, ... Perl is supposed to be easy.
674
675 =head3 Patches speak louder than words
676
677 Working code is always preferred to pie-in-the-sky ideas. A patch to
678 add a feature stands a much higher chance of making it to the language
679 than does a random feature request, no matter how fervently argued the
680 request might be. This ties into "Will it be useful?", as the fact that
681 someone took the time to make the patch demonstrates a strong desire
682 for the feature.
683
684 =head1 TESTING
685
686 The core uses the same testing style as the rest of Perl, a simple
687 "ok/not ok" run through Test::Harness, but there are a few special
688 considerations.
689
690 There are three ways to write a test in the core. L<Test::More>,
691 F<t/test.pl> and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">. The
692 decision of which to use depends on what part of the test suite you're
693 working on. This is a measure to prevent a high-level failure (such as
694 Config.pm breaking) from causing basic functionality tests to fail.
695
696 The F<t/test.pl> library provides some of the features of
697 L<Test::More>, but avoids loading most modules and uses as few core
698 features as possible.
699
700 If you write your own test, use the L<Test Anything
701 Protocol|http://testanything.org>.
702
703 =over 4
704
705 =item * F<t/base> and F<t/comp>
706
707 Since we don't know if require works, or even subroutines, use ad hoc
708 tests for these two. Step carefully to avoid using the feature being
709 tested.
710
711 =item * F<t/cmd>, F<t/run>, F<t/io> and F<t/op>
712
713 Now that basic require() and subroutines are tested, you can use the
714 F<t/test.pl> library.
715
716 Note, however, that some test scripts still avoid F<t/test.pl> if they test
717 features that F<t/test.pl> relies on heavily. 
718
719 You can also use certain libraries like Config conditionally, but be
720 sure to skip the test gracefully if it's not there.
721
722 =item * Everything else
723
724 Now that the core of Perl is tested, L<Test::More> can and should be
725 used. You can also use the full suite of core modules in the tests.
726
727 =back
728
729 When you say "make test", Perl uses the F<t/TEST> program to run the
730 test suite (except under Win32 where it uses F<t/harness> instead). All
731 tests are run from the F<t/> directory, B<not> the directory which
732 contains the test. This causes some problems with the tests in F<lib/>,
733 so here's some opportunity for some patching.
734
735 You must be triply conscious of cross-platform concerns. This usually
736 boils down to using L<File::Spec> and avoiding things like C<fork()>
737 and C<system()> unless absolutely necessary.
738
739 =head2 Special C<make test> targets
740
741 There are various special make targets that can be used to test Perl
742 slightly differently than the standard "test" target. Not all them are
743 expected to give a 100% success rate. Many of them have several
744 aliases, and many of them are not available on certain operating
745 systems.
746
747 =over 4
748
749 =item * test_porting
750
751 This runs some basic sanity tests on the source tree and helps catch
752 basic errors before you submit a patch.
753
754 =item * coretest
755
756 Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
757
758 (Not available on Win32)
759
760 =item * test.deparse
761
762 Run all the tests through L<B::Deparse>. Not all tests will succeed.
763
764 (Not available on Win32)
765
766 =item * test.taintwarn
767
768 Run all tests with the B<-t> command-line switch. Not all tests are
769 expected to succeed (until they're specifically fixed, of course).
770
771 (Not available on Win32)
772
773 =item * minitest
774
775 Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
776 F<t/op>, F<t/uni> and F<t/mro> tests.
777
778 =item * test.valgrind check.valgrind utest.valgrind ucheck.valgrind
779
780 (Only in Linux) Run all the tests using the memory leak + naughty
781 memory access tool "valgrind". The log files will be named
782 F<testname.valgrind>.
783
784 =item * test.torture torturetest
785
786 Run all the usual tests and some extra tests. As of Perl 5.8.0, the
787 only extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
788
789 You can also run the torture test with F<t/harness> by giving
790 C<-torture> argument to F<t/harness>.
791
792 =item * utest ucheck test.utf8 check.utf8
793
794 Run all the tests with -Mutf8. Not all tests will succeed.
795
796 (Not available on Win32)
797
798 =item * minitest.utf16 test.utf16
799
800 Runs the tests with UTF-16 encoded scripts, encoded with different
801 versions of this encoding.
802
803 C<make utest.utf16> runs the test suite with a combination of C<-utf8>
804 and C<-utf16> arguments to F<t/TEST>.
805
806 (Not available on Win32)
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>, it
815 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 failing
849 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. Note
891 that this form is distinct from the B<-re LIST OF PATTERNS> form below
892 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 set
931 automatically by the Makefile, but can also be forced artificially by
932 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,
958 eg. 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 =item * The perl5-porters FAQ
1029
1030 This should be available from
1031 http://dev.perl.org/perl5/docs/p5p-faq.html . It contains hints on
1032 reading perl5-porters, information on how perl5-porters works and how
1033 Perl development in general works.
1034
1035 =back
1036
1037 =head1 CPAN TESTERS AND PERL SMOKERS
1038
1039 The CPAN testers ( http://testers.cpan.org/ ) are a group of volunteers
1040 who test CPAN modules on a variety of platforms.
1041
1042 Perl Smokers ( http://www.nntp.perl.org/group/perl.daily-build/ and
1043 http://www.nntp.perl.org/group/perl.daily-build.reports/ )
1044 automatically test Perl source releases on platforms with various
1045 configurations.
1046
1047 Both efforts welcome volunteers. In order to get involved in smoke
1048 testing of the perl itself visit
1049 L<http://search.cpan.org/dist/Test-Smoke/>. In order to start smoke
1050 testing CPAN modules visit
1051 L<http://search.cpan.org/dist/CPANPLUS-YACSmoke/> or
1052 L<http://search.cpan.org/dist/minismokebox/> or
1053 L<http://search.cpan.org/dist/CPAN-Reporter/>.
1054
1055 =head1 WHAT NEXT?
1056
1057 If you've read all the documentation in the document and the ones
1058 listed above, you're more than ready to hack on Perl.
1059
1060 Here's some more recommendations
1061
1062 =over 4
1063
1064 =item *
1065
1066 Subscribe to perl5-porters, follow the patches and try and understand
1067 them; don't be afraid to ask if there's a portion you're not clear on -
1068 who knows, you may unearth a bug in the patch...
1069
1070 =item *
1071
1072 Do read the README associated with your operating system, e.g.
1073 README.aix on the IBM AIX OS. Don't hesitate to supply patches to that
1074 README if you find anything missing or changed over a new OS release.
1075
1076 =item *
1077
1078 Find an area of Perl that seems interesting to you, and see if you can
1079 work out how it works. Scan through the source, and step over it in the
1080 debugger. Play, poke, investigate, fiddle! You'll probably get to
1081 understand not just your chosen area but a much wider range of
1082 F<perl>'s activity as well, and probably sooner than you'd think.
1083
1084 =back
1085
1086 =head2 "The Road goes ever on and on, down from the door where it began."
1087
1088 If you can do these things, you've started on the long road to Perl
1089 porting. Thanks for wanting to help make Perl better - and happy
1090 hacking!
1091
1092 =head2 Metaphoric Quotations
1093
1094 If you recognized the quote about the Road above, you're in luck.
1095
1096 Most software projects begin each file with a literal description of
1097 each file's purpose. Perl instead begins each with a literary allusion
1098 to that file's purpose.
1099
1100 Like chapters in many books, all top-level Perl source files (along
1101 with a few others here and there) begin with an epigrammatic
1102 inscription that alludes, indirectly and metaphorically, to the
1103 material you're about to read.
1104
1105 Quotations are taken from writings of J.R.R. Tolkien pertaining to his
1106 Legendarium, almost always from I<The Lord of the Rings>. Chapters and
1107 page numbers are given using the following editions:
1108
1109 =over 4
1110
1111 =item *
1112
1113 I<The Hobbit>, by J.R.R. Tolkien. The hardcover, 70th-anniversary
1114 edition of 2007 was used, published in the UK by Harper Collins
1115 Publishers and in the US by the Houghton Mifflin Company.
1116
1117 =item *
1118
1119 I<The Lord of the Rings>, by J.R.R. Tolkien. The hardcover,
1120 50th-anniversary edition of 2004 was used, published in the UK by
1121 Harper Collins Publishers and in the US by the Houghton Mifflin
1122 Company.
1123
1124 =item *
1125
1126 I<The Lays of Beleriand>, by J.R.R. Tolkien and published posthumously
1127 by his son and literary executor, C.J.R. Tolkien, being the 3rd of the
1128 12 volumes in Christopher's mammoth I<History of Middle Earth>. Page
1129 numbers derive from the hardcover edition, first published in 1983 by
1130 George Allen & Unwin; no page numbers changed for the special 3-volume
1131 omnibus edition of 2002 or the various trade-paper editions, all again
1132 now by Harper Collins or Houghton Mifflin.
1133
1134 =back
1135
1136 Other JRRT books fair game for quotes would thus include I<The
1137 Adventures of Tom Bombadil>, I<The Silmarillion>, I<Unfinished Tales>,
1138 and I<The Tale of the Children of Hurin>, all but the first
1139 posthumously assembled by CJRT. But I<The Lord of the Rings> itself is
1140 perfectly fine and probably best to quote from, provided you can find a
1141 suitable quote there.
1142
1143 So if you were to supply a new, complete, top-level source file to add
1144 to Perl, you should conform to this peculiar practice by yourself
1145 selecting an appropriate quotation from Tolkien, retaining the original
1146 spelling and punctuation and using the same format the rest of the
1147 quotes are in. Indirect and oblique is just fine; remember, it's a
1148 metaphor, so being meta is, after all, what it's for.
1149
1150 =head1 AUTHOR
1151
1152 This document was originally written by Nathan Torkington, and is
1153 maintained by the perl5-porters mailing list.
1154