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