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