Reorganize perlhack.pod
authorDavid Golden <dagolden@cpan.org>
Mon, 13 Dec 2010 22:36:33 +0000 (17:36 -0500)
committerDavid Golden <dagolden@cpan.org>
Mon, 27 Dec 2010 01:49:55 +0000 (20:49 -0500)
Following on an IRC conversation, I've attempted to reorganize
perlhack for greater clarity.  I have only cut and paste blocks
of text and amended section titles and levels.  (I have not addressed
any of the numerous factual issues which remain.)

The resulting guide should be clearer for those trying to skim the
table of contents to understand what is covered in perlhack and
whether it is worth an in-depth read.

I see this change as the first step towards future improvements.

pod/perlhack.pod

index cf692e8..c612684 100644 (file)
@@ -8,6 +8,10 @@ This document attempts to explain how Perl development takes place,
 and ends with some suggestions for people wanting to become bona fide
 porters.
 
+=head1 HOW PERL DEVELOPMENT HAPPENS
+
+=head2 Perl 5 Porters
+
 The perl5-porters mailing list is where the Perl standard distribution
 is maintained and developed.  The list can get anywhere from 10 to 150
 messages a day, depending on the heatedness of the debate.  Most days
@@ -76,6 +80,8 @@ regardless of whether he previously invoked Rule 1.
 Got that?  Larry is always right, even when he was wrong.  It's rare
 to see either Rule exercised, but they are often alluded to.
 
+=head2 What makes for a good patch?
+
 New features and extensions to the language are contentious, because
 the criteria used by the pumpkings, Larry, and other porters to decide
 which features should be implemented and incorporated are not codified
@@ -204,7 +210,7 @@ around.  It refers to the standard distribution.  "Hacking on the
 core" means you're changing the C source code to the Perl
 interpreter.  "A core module" is one that ships with Perl.
 
-=head2 Keeping in sync
+=head2 Getting the Perl source
 
 The source code to the Perl interpreter, in its different versions, is
 kept in a repository managed by the git revision control system. The
@@ -244,7 +250,7 @@ Needless to say, the source code in perl-current is usually in a perpetual
 state of evolution.  You should expect it to be very buggy.  Do B<not> use
 it for any purpose other than testing and development.
 
-=head2 Perlbug administration
+=head2 Bug tracking with Perlbug
 
 There is a single remote administrative interface for modifying bug status,
 category, open issues etc. using the B<RT> bugtracker system, maintained
@@ -314,6 +320,78 @@ If after all this you still think you want to join the perl5-porters
 mailing list, send mail to I<perl5-porters-subscribe@perl.org>.  To
 unsubscribe, send mail to I<perl5-porters-unsubscribe@perl.org>.
 
+=head2 Patching a core module
+
+This works just like patching anything else, with an extra
+consideration.  Many core modules also live on CPAN.  If this is so,
+patch the CPAN version instead of the core and send the patch off to
+the module maintainer (with a copy to p5p).  This will help the module
+maintainer keep the CPAN version in sync with the core version without
+constantly scanning p5p.
+
+The list of maintainers of core modules is usefully documented in
+F<Porting/Maintainers.pl>.
+
+=head2 Adding a new function to the core
+
+If, as part of a patch to fix a bug, or just because you have an
+especially good idea, you decide to add a new function to the core,
+discuss your ideas on p5p well before you start work.  It may be that
+someone else has already attempted to do what you are considering and
+can give lots of good advice or even provide you with bits of code
+that they already started (but never finished).
+
+You have to follow all of the advice given above for patching.  It is
+extremely important to test any addition thoroughly and add new tests
+to explore all boundary conditions that your new function is expected
+to handle.  If your new function is used only by one module (e.g. toke),
+then it should probably be named S_your_function (for static); on the
+other hand, if you expect it to accessible from other functions in
+Perl, you should name it Perl_your_function.  See L<perlguts/Internal Functions>
+for more details.
+
+The location of any new code is also an important consideration.  Don't
+just create a new top level .c file and put your code there; you would
+have to make changes to Configure (so the Makefile is created properly),
+as well as possibly lots of include files.  This is strictly pumpking
+business.
+
+It is better to add your function to one of the existing top level
+source code files, but your choice is complicated by the nature of
+the Perl distribution.  Only the files that are marked as compiled
+static are located in the perl executable.  Everything else is located
+in the shared library (or DLL if you are running under WIN32).  So,
+for example, if a function was only used by functions located in
+toke.c, then your code can go in toke.c.  If, however, you want to call
+the function from universal.c, then you should put your code in another
+location, for example util.c.
+
+In addition to writing your c-code, you will need to create an
+appropriate entry in embed.pl describing your function, then run
+'make regen_headers' to create the entries in the numerous header
+files that perl needs to compile correctly.  See L<perlguts/Internal Functions>
+for information on the various options that you can set in embed.pl.
+You will forget to do this a few (or many) times and you will get
+warnings during the compilation phase.  Make sure that you mention
+this when you post your patch to P5P; the pumpking needs to know this.
+
+When you write your new code, please be conscious of existing code
+conventions used in the perl source files.  See L<perlstyle> for
+details.  Although most of the guidelines discussed seem to focus on
+Perl code, rather than c, they all apply (except when they don't ;).
+Also see L<perlrepository> for lots of details about both formatting and
+submitting patches of your changes.
+
+Lastly, TEST TEST TEST TEST TEST any code before posting to p5p.
+Test on as many platforms as you can find.  Test as many perl
+Configure options as you can (e.g. MULTIPLICITY).  If you have
+profiling or memory tools, see L<EXTERNAL TOOLS FOR DEBUGGING PERL>
+below for how to use them to further test your code.  Remember that
+most of the people on P5P are doing this on their own time and
+don't have the time to debug your code.
+
+=head2 Background reading
+
 To hack on the Perl guts, you'll need to read the following things:
 
 =over 3
@@ -358,7 +436,9 @@ perl5-porters works and how Perl development in general works.
 
 =back
 
-=head2 Finding Your Way Around
+=head1 UNDERSTANDING THE SOURCE
+
+=head2 Finding your way around
 
 Perl maintenance can be split into a number of areas, and certain people
 (pumpkins) will have responsibility for each area. These areas sometimes
@@ -1170,361 +1250,361 @@ You can expand the macros in a F<foo.c> file by saying
 
 which will expand the macros using cpp.  Don't be scared by the results.
 
-=head1 SOURCE CODE STATIC ANALYSIS
+=head1 TESTING
 
-Various tools exist for analysing C source code B<statically>, as
-opposed to B<dynamically>, that is, without executing the code.
-It is possible to detect resource leaks, undefined behaviour, type
-mismatches, portability problems, code paths that would cause illegal
-memory accesses, and other similar problems by just parsing the C code
-and looking at the resulting graph, what does it tell about the
-execution and data flows.  As a matter of fact, this is exactly
-how C compilers know to give warnings about dubious code.
+Every module and built-in function has an associated test file (or
+should...).  If you add or change functionality, you have to write a
+test.  If you fix a bug, you have to write a test so that bug never
+comes back.  If you alter the docs, it would be nice to test what the
+new documentation says.
 
-=head2 lint, splint
+In short, if you submit a patch you probably also have to patch the
+tests.
 
-The good old C code quality inspector, C<lint>, is available in
-several platforms, but please be aware that there are several
-different implementations of it by different vendors, which means that
-the flags are not identical across different platforms.
+=head2 Where to find test files
 
-There is a lint variant called C<splint> (Secure Programming Lint)
-available from http://www.splint.org/ that should compile on any
-Unix-like platform.
+For modules, the test file is right next to the module itself.
+F<lib/strict.t> tests F<lib/strict.pm>.  This is a recent innovation,
+so there are some snags (and it would be wonderful for you to brush
+them out), but it basically works that way.  Everything else lives in
+F<t/>.
 
-There are C<lint> and <splint> targets in Makefile, but you may have
-to diddle with the flags (see above).
+Testing of warning messages is often separately done by using expect scripts in
+F<t/lib/warnings>.  This is because much of the setup for them is already done
+for you.
 
-=head2 Coverity
+If you add a new test directory under F<t/>, it is imperative that you 
+add that directory to F<t/HARNESS> and F<t/TEST>.
 
-Coverity (http://www.coverity.com/) is a product similar to lint and
-as a testbed for their product they periodically check several open
-source projects, and they give out accounts to open source developers
-to the defect databases.
+=over 3
 
-=head2 cpd (cut-and-paste detector)
+=item F<t/base/>
 
-The cpd tool detects cut-and-paste coding.  If one instance of the
-cut-and-pasted code changes, all the other spots should probably be
-changed, too.  Therefore such code should probably be turned into a
-subroutine or a macro.
+Testing of the absolute basic functionality of Perl.  Things like
+C<if>, basic file reads and writes, simple regexes, etc.  These are
+run first in the test suite and if any of them fail, something is
+I<really> broken.
 
-cpd (http://pmd.sourceforge.net/cpd.html) is part of the pmd project
-(http://pmd.sourceforge.net/).  pmd was originally written for static
-analysis of Java code, but later the cpd part of it was extended to
-parse also C and C++.
+=item F<t/cmd/>
 
-Download the pmd-bin-X.Y.zip () from the SourceForge site, extract the
-pmd-X.Y.jar from it, and then run that on source code thusly:
+These test the basic control structures, C<if/else>, C<while>,
+subroutines, etc.
 
-  java -cp pmd-X.Y.jar net.sourceforge.pmd.cpd.CPD --minimum-tokens 100 --files /some/where/src --language c > cpd.txt
+=item F<t/comp/>
 
-You may run into memory limits, in which case you should use the -Xmx option:
+Tests basic issues of how Perl parses and compiles itself.
 
-  java -Xmx512M ...
+=item F<t/io/>
 
-=head2 gcc warnings
+Tests for built-in IO functions, including command line arguments.
 
-Though much can be written about the inconsistency and coverage
-problems of gcc warnings (like C<-Wall> not meaning "all the
-warnings", or some common portability problems not being covered by
-C<-Wall>, or C<-ansi> and C<-pedantic> both being a poorly defined
-collection of warnings, and so forth), gcc is still a useful tool in
-keeping our coding nose clean.
+=item F<t/lib/>
 
-The C<-Wall> is by default on.
+The old home for the module tests, you shouldn't put anything new in
+here.  There are still some bits and pieces hanging around in here
+that need to be moved.  Perhaps you could move them?  Thanks!
 
-The C<-ansi> (and its sidekick, C<-pedantic>) would be nice to be on
-always, but unfortunately they are not safe on all platforms, they can
-for example cause fatal conflicts with the system headers (Solaris
-being a prime example).  If Configure C<-Dgccansipedantic> is used,
-the C<cflags> frontend selects C<-ansi -pedantic> for the platforms
-where they are known to be safe.
+=item F<t/mro/>
 
-Starting from Perl 5.9.4 the following extra flags are added:
+Tests for perl's method resolution order implementations
+(see L<mro>).
 
-=over 4
+=item F<t/op/>
 
-=item *
+Tests for perl's built in functions that don't fit into any of the
+other directories.
 
-C<-Wendif-labels>
+=item F<t/re/>
 
-=item *
+Tests for regex related functions or behaviour. (These used to live
+in t/op).
 
-C<-Wextra>
+=item F<t/run/>
 
-=item *
+Testing features of how perl actually runs, including exit codes and
+handling of PERL* environment variables.
 
-C<-Wdeclaration-after-statement>
+=item F<t/uni/>
 
-=back
+Tests for the core support of Unicode.
 
-The following flags would be nice to have but they would first need
-their own Augean stablemaster:
+=item F<t/win32/>
 
-=over 4
+Windows-specific tests.
 
-=item *
+=item F<t/x2p>
 
-C<-Wpointer-arith>
+A test suite for the s2p converter.
 
-=item *
+=back
 
-C<-Wshadow>
+The core uses the same testing style as the rest of Perl, a simple
+"ok/not ok" run through Test::Harness, but there are a few special
+considerations.
 
-=item *
+There are three ways to write a test in the core.  Test::More,
+t/test.pl and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">.  The
+decision of which to use depends on what part of the test suite you're
+working on.  This is a measure to prevent a high-level failure (such
+as Config.pm breaking) from causing basic functionality tests to fail.
+If you write your own test, use the L<Test Anything Protocol|TAP>.
 
-C<-Wstrict-prototypes>
+=over 4
 
-=back
+=item t/base t/comp
 
-The C<-Wtraditional> is another example of the annoying tendency of
-gcc to bundle a lot of warnings under one switch (it would be
-impossible to deploy in practice because it would complain a lot) but
-it does contain some warnings that would be beneficial to have available
-on their own, such as the warning about string constants inside macros
-containing the macro arguments: this behaved differently pre-ANSI
-than it does in ANSI, and some C compilers are still in transition,
-AIX being an example.
+Since we don't know if require works, or even subroutines, use ad hoc
+tests for these two.  Step carefully to avoid using the feature being
+tested.
 
-=head2 Warnings of other C compilers
+=item t/cmd t/run t/io t/op
 
-Other C compilers (yes, there B<are> other C compilers than gcc) often
-have their "strict ANSI" or "strict ANSI with some portability extensions"
-modes on, like for example the Sun Workshop has its C<-Xa> mode on
-(though implicitly), or the DEC (these days, HP...) has its C<-std1>
-mode on.
+Now that basic require() and subroutines are tested, you can use the
+t/test.pl library which emulates the important features of Test::More
+while using a minimum of core features.
 
-=head2 DEBUGGING
+You can also conditionally use certain libraries like Config, but be
+sure to skip the test gracefully if it's not there.
 
-You can compile a special debugging version of Perl, which allows you
-to use the C<-D> option of Perl to tell more about what Perl is doing.
-But sometimes there is no alternative than to dive in with a debugger,
-either to see the stack trace of a core dump (very useful in a bug
-report), or trying to figure out what went wrong before the core dump
-happened, or how did we end up having wrong or unexpected results.
+=item t/lib ext lib
 
-=head2 Poking at Perl
+Now that the core of Perl is tested, Test::More can be used.  You can
+also use the full suite of core modules in the tests.
 
-To really poke around with Perl, you'll probably want to build Perl for
-debugging, like this:
+=back
 
-    ./Configure -d -D optimize=-g
-    make
+When you say "make test" Perl uses the F<t/TEST> program to run the
+test suite (except under Win32 where it uses F<t/harness> instead.)
+All tests are run from the F<t/> directory, B<not> the directory
+which contains the test.  This causes some problems with the tests
+in F<lib/>, so here's some opportunity for some patching.
 
-C<-g> is a flag to the C compiler to have it produce debugging
-information which will allow us to step through a running program,
-and to see in which C function we are at (without the debugging
-information we might see only the numerical addresses of the functions,
-which is not very helpful).
+You must be triply conscious of cross-platform concerns.  This usually
+boils down to using File::Spec and avoiding things like C<fork()> and
+C<system()> unless absolutely necessary.
 
-F<Configure> will also turn on the C<DEBUGGING> compilation symbol which
-enables all the internal debugging code in Perl. There are a whole bunch
-of things you can debug with this: L<perlrun> lists them all, and the
-best way to find out about them is to play about with them. The most
-useful options are probably
+=head2 Special Make Test Targets
 
-    l  Context (loop) stack processing
-    t  Trace execution
-    o  Method and overloading resolution
-    c  String/numeric conversions
+There are various special make targets that can be used to test Perl
+slightly differently than the standard "test" target.  Not all them
+are expected to give a 100% success rate.  Many of them have several
+aliases, and many of them are not available on certain operating
+systems.
 
-Some of the functionality of the debugging code can be achieved using XS
-modules.
+=over 4
 
-    -Dr => use re 'debug'
-    -Dx => use O 'Debug'
+=item coretest
 
-=head2 Using a source-level debugger
+Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
 
-If the debugging output of C<-D> doesn't help you, it's time to step
-through perl's execution with a source-level debugger.
+(Not available on Win32)
 
-=over 3
+=item test.deparse
 
-=item *
+Run all the tests through B::Deparse.  Not all tests will succeed.
 
-We'll use C<gdb> for our examples here; the principles will apply to
-any debugger (many vendors call their debugger C<dbx>), but check the
-manual of the one you're using.
+(Not available on Win32)
 
-=back
+=item test.taintwarn
 
-To fire up the debugger, type
+Run all tests with the B<-t> command-line switch.  Not all tests
+are expected to succeed (until they're specifically fixed, of course).
 
-    gdb ./perl
+(Not available on Win32)
 
-Or if you have a core dump:
+=item minitest
 
-    gdb ./perl core
+Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
+F<t/op>, F<t/uni> and F<t/mro> tests.
 
-You'll want to do that in your Perl source tree so the debugger can read
-the source code. You should see the copyright message, followed by the
-prompt.
+=item test.valgrind check.valgrind utest.valgrind ucheck.valgrind
 
-    (gdb)
+(Only in Linux) Run all the tests using the memory leak + naughty
+memory access tool "valgrind".  The log files will be named
+F<testname.valgrind>.
 
-C<help> will get you into the documentation, but here are the most
-useful commands:
+=item test.third check.third utest.third ucheck.third
 
-=over 3
+(Only in Tru64)  Run all the tests using the memory leak + naughty
+memory access tool "Third Degree".  The log files will be named
+F<perl.3log.testname>.
 
-=item run [args]
+=item test.torture torturetest
 
-Run the program with the given arguments.
+Run all the usual tests and some extra tests.  As of Perl 5.8.0 the
+only extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
 
-=item break function_name
+You can also run the torture test with F<t/harness> by giving
+C<-torture> argument to F<t/harness>.
 
-=item break source.c:xxx
+=item utest ucheck test.utf8 check.utf8
 
-Tells the debugger that we'll want to pause execution when we reach
-either the named function (but see L<perlguts/Internal Functions>!) or the given
-line in the named source file.
+Run all the tests with -Mutf8.  Not all tests will succeed.
 
-=item step
+(Not available on Win32)
 
-Steps through the program a line at a time.
+=item minitest.utf16 test.utf16
 
-=item next
+Runs the tests with UTF-16 encoded scripts, encoded with different
+versions of this encoding.
 
-Steps through the program a line at a time, without descending into
-functions.
+C<make utest.utf16> runs the test suite with a combination of C<-utf8> and
+C<-utf16> arguments to F<t/TEST>.
 
-=item continue
+(Not available on Win32)
 
-Run until the next breakpoint.
+=item test_harness
 
-=item finish
+Run the test suite with the F<t/harness> controlling program, instead of
+F<t/TEST>. F<t/harness> is more sophisticated, and uses the
+L<Test::Harness> module, thus using this test target supposes that perl
+mostly works. The main advantage for our purposes is that it prints a
+detailed summary of failed tests at the end. Also, unlike F<t/TEST>, it
+doesn't redirect stderr to stdout.
 
-Run until the end of the current function, then stop again.
+Note that under Win32 F<t/harness> is always used instead of F<t/TEST>, so
+there is no special "test_harness" target.
 
-=item 'enter'
+Under Win32's "test" target you may use the TEST_SWITCHES and TEST_FILES
+environment variables to control the behaviour of F<t/harness>.  This means
+you can say
 
-Just pressing Enter will do the most recent operation again - it's a
-blessing when stepping through miles of source code.
+    nmake test TEST_FILES="op/*.t"
+    nmake test TEST_SWITCHES="-torture" TEST_FILES="op/*.t"
 
-=item print
+=item Parallel tests
 
-Execute the given C code and print its results. B<WARNING>: Perl makes
-heavy use of macros, and F<gdb> does not necessarily support macros
-(see later L</"gdb macro support">).  You'll have to substitute them
-yourself, or to invoke cpp on the source code files
-(see L</"The .i Targets">)
-So, for instance, you can't say
+The core distribution can now run its regression tests in parallel on
+Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS> in
+your environment to the number of tests to run in parallel, and run
+C<make test_harness>. On a Bourne-like shell, this can be done as
 
-    print SvPV_nolen(sv)
+    TEST_JOBS=3 make test_harness  # Run 3 tests in parallel
 
-but you have to say
+An environment variable is used, rather than parallel make itself, because
+L<TAP::Harness> needs to be able to schedule individual non-conflicting test
+scripts itself, and there is no standard interface to C<make> utilities to
+interact with their job schedulers.
 
-    print Perl_sv_2pv_nolen(sv)
+Note that currently some test scripts may fail when run in parallel (most
+notably C<ext/IO/t/io_dir.t>). If necessary run just the failing scripts
+again sequentially and see if the failures go away.
+=item test-notty test_notty
+
+Sets PERL_SKIP_TTY_TEST to true before running normal test.
 
 =back
 
-You may find it helpful to have a "macro dictionary", which you can
-produce by saying C<cpp -dM perl.c | sort>. Even then, F<cpp> won't
-recursively apply those macros for you.
+=head2 Running tests by hand
 
-=head2 gdb macro support
+You can run part of the test suite by hand by using one the following
+commands from the F<t/> directory :
 
-Recent versions of F<gdb> have fairly good macro support, but
-in order to use it you'll need to compile perl with macro definitions
-included in the debugging information.  Using F<gcc> version 3.1, this
-means configuring with C<-Doptimize=-g3>.  Other compilers might use a
-different switch (if they support debugging macros at all).
+    ./perl -I../lib TEST list-of-.t-files
 
-=head2 Dumping Perl Data Structures
+or
 
-One way to get around this macro hell is to use the dumping functions in
-F<dump.c>; these work a little like an internal
-L<Devel::Peek|Devel::Peek>, but they also cover OPs and other structures
-that you can't get at from Perl. Let's take an example. We'll use the
-C<$a = $b + $c> we used before, but give it a bit of context:
-C<$b = "6XXXX"; $c = 2.3;>. Where's a good place to stop and poke around?
+    ./perl -I../lib harness list-of-.t-files
 
-What about C<pp_add>, the function we examined earlier to implement the
-C<+> operator:
+(if you don't specify test scripts, the whole test suite will be run.)
 
-    (gdb) break Perl_pp_add
-    Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
+=head3 Using t/harness for testing
 
-Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Internal Functions>.
-With the breakpoint in place, we can run our program:
+If you use C<harness> for testing you have several command line options
+available to you. The arguments are as follows, and are in the order
+that they must appear if used together.
 
-    (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
+    harness -v -torture -re=pattern LIST OF FILES TO TEST
+    harness -v -torture -re LIST OF PATTERNS TO MATCH
 
-Lots of junk will go past as gdb reads in the relevant source files and
-libraries, and then:
+If C<LIST OF FILES TO TEST> is omitted the file list is obtained from
+the manifest. The file list may include shell wildcards which will be
+expanded out.
 
-    Breakpoint 1, Perl_pp_add () at pp_hot.c:309
-    309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
-    (gdb) step
-    311           dPOPTOPnnrl_ul;
-    (gdb)
+=over 4
 
-We looked at this bit of code before, and we said that C<dPOPTOPnnrl_ul>
-arranges for two C<NV>s to be placed into C<left> and C<right> - let's
-slightly expand it:
+=item -v
 
- #define dPOPTOPnnrl_ul  NV right = POPn; \
-                         SV *leftsv = TOPs; \
-                         NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
+Run the tests under verbose mode so you can see what tests were run,
+and debug output.
 
-C<POPn> takes the SV from the top of the stack and obtains its NV either
-directly (if C<SvNOK> is set) or by calling the C<sv_2nv> function.
-C<TOPs> takes the next SV from the top of the stack - yes, C<POPn> uses
-C<TOPs> - but doesn't remove it. We then use C<SvNV> to get the NV from
-C<leftsv> in the same way as before - yes, C<POPn> uses C<SvNV>.
+=item -torture
 
-Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
-convert it. If we step again, we'll find ourselves there:
+Run the torture tests as well as the normal set.
 
-    Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
-    1669        if (!sv)
-    (gdb)
+=item -re=PATTERN
 
-We can now use C<Perl_sv_dump> to investigate the SV:
+Filter the file list so that all the test files run match PATTERN.
+Note that this form is distinct from the B<-re LIST OF PATTERNS> form below
+in that it allows the file list to be provided as well.
 
-    SV = PV(0xa057cc0) at 0xa0675d0
-    REFCNT = 1
-    FLAGS = (POK,pPOK)
-    PV = 0xa06a510 "6XXXX"\0
-    CUR = 5
-    LEN = 6
-    $1 = void
+=item -re LIST OF PATTERNS
 
-We know we're going to get C<6> from this, so let's finish the
-subroutine:
+Filter the file list so that all the test files run match
+/(LIST|OF|PATTERNS)/. Note that with this form the patterns
+are joined by '|' and you cannot supply a list of files, instead
+the test files are obtained from the MANIFEST.
 
-    (gdb) finish
-    Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
-    0x462669 in Perl_pp_add () at pp_hot.c:311
-    311           dPOPTOPnnrl_ul;
+=back
 
-We can also dump out this op: the current op is always stored in
-C<PL_op>, and we can dump it with C<Perl_op_dump>. This'll give us
-similar output to L<B::Debug|B::Debug>.
+You can run an individual test by a command similar to
 
-    {
-    13  TYPE = add  ===> 14
-        TARG = 1
-        FLAGS = (SCALAR,KIDS)
-        {
-            TYPE = null  ===> (12)
-              (was rv2sv)
-            FLAGS = (SCALAR,KIDS)
-            {
-    11          TYPE = gvsv  ===> 12
-                FLAGS = (SCALAR)
-                GV = main::b
-            }
-        }
+    ./perl -I../lib patho/to/foo.t
 
-# finish this later #
+except that the harnesses set up some environment variables that may
+affect the execution of the test :
 
-=head2 Patching
+=over 4
 
-All right, we've now had a look at how to navigate the Perl sources and
-some things you'll need to know when fiddling with them. Let's now get
+=item PERL_CORE=1
+
+indicates that we're running this test part of the perl core test suite.
+This is useful for modules that have a dual life on CPAN.
+
+=item PERL_DESTRUCT_LEVEL=2
+
+is set to 2 if it isn't set already (see L</PERL_DESTRUCT_LEVEL>)
+
+=item PERL
+
+(used only by F<t/TEST>) if set, overrides the path to the perl executable
+that should be used to run the tests (the default being F<./perl>).
+
+=item PERL_SKIP_TTY_TEST
+
+if set, tells to skip the tests that need a terminal. It's actually set
+automatically by the Makefile, but can also be forced artificially by
+running 'make test_notty'.
+
+=back
+
+=head3 Other environment variables that may influence tests
+
+=over 4
+
+=item PERL_TEST_Net_Ping
+
+Setting this variable runs all the Net::Ping modules tests,
+otherwise some tests that interact with the outside world are skipped.
+See L<perl58delta>.
+
+=item PERL_TEST_NOVREXX
+
+Setting this variable skips the vrexx.t tests for OS2::REXX.
+
+=item PERL_TEST_NUMCONVERTS
+
+This sets a variable in op/numconvert.t.
+
+=back
+
+See also the documentation for the Test and Test::Harness modules,
+for more environment variables that affect testing.
+
+=head1 EXAMPLE OF A SIMPLE PATCH
+
+All right, we've now had a look at how to navigate the Perl sources and
+some things you'll need to know when fiddling with them. Let's now get
 on and create a simple patch. Here's something Larry suggested: if a
 C<U> is the first active format during a C<pack>, (for example,
 C<pack "U3C8", @stuff>) then the resulting string should be treated as
@@ -1534,6 +1614,8 @@ If you are working with a git clone of the Perl repository, you will want to
 create a branch for your changes. This will make creating a proper patch much
 simpler. See the L<perlrepository> for details on how to do this.
 
+=head2 Writing the patch
+
 How do we prepare to fix this up? First we locate the code in question -
 the C<pack> happens at runtime, so it's going to be in one of the F<pp>
 files. Sure enough, C<pp_pack> is in F<pp.c>. Since we're going to be
@@ -1613,6 +1695,8 @@ we must document that change. We must also provide some more regression
 tests to make sure our patch works and doesn't create a bug somewhere
 else along the line.
 
+=head2 Testing the patch
+
 The regression tests for each operator live in F<t/op/>, and so we
 make a copy of F<t/op/pack.t> to F<t/op/pack.t~>. Now we can add our
 tests to the end. First, we'll test that the C<U> does indeed create
@@ -1660,6 +1744,8 @@ or this:
 We now compile up Perl, and run it through the test suite. Our new
 tests pass, hooray!
 
+=head2 Documenting the patch
+
 Finally, the documentation. The job is never done until the paperwork is
 over, so let's describe the change we've just made. The relevant place
 is F<pod/perlfunc.pod>; again, we make a copy, and then we'll insert
@@ -1675,1025 +1761,952 @@ this text in the description of C<pack>:
  encode your string, and then follow this with a C<U*> somewhere in your
  pattern.
 
-=head2 Patching a core module
+=head1 COMMON PROBLEMS
 
-This works just like patching anything else, with an extra
-consideration.  Many core modules also live on CPAN.  If this is so,
-patch the CPAN version instead of the core and send the patch off to
-the module maintainer (with a copy to p5p).  This will help the module
-maintainer keep the CPAN version in sync with the core version without
-constantly scanning p5p.
+Perl source plays by ANSI C89 rules: no C99 (or C++) extensions.  In
+some cases we have to take pre-ANSI requirements into consideration.
+You don't care about some particular platform having broken Perl?
+I hear there is still a strong demand for J2EE programmers.
 
-The list of maintainers of core modules is usefully documented in
-F<Porting/Maintainers.pl>.
+=head2 Perl environment problems
 
-=head2 Adding a new function to the core
+=over 4
 
-If, as part of a patch to fix a bug, or just because you have an
-especially good idea, you decide to add a new function to the core,
-discuss your ideas on p5p well before you start work.  It may be that
-someone else has already attempted to do what you are considering and
-can give lots of good advice or even provide you with bits of code
-that they already started (but never finished).
+=item *
 
-You have to follow all of the advice given above for patching.  It is
-extremely important to test any addition thoroughly and add new tests
-to explore all boundary conditions that your new function is expected
-to handle.  If your new function is used only by one module (e.g. toke),
-then it should probably be named S_your_function (for static); on the
-other hand, if you expect it to accessible from other functions in
-Perl, you should name it Perl_your_function.  See L<perlguts/Internal Functions>
-for more details.
+Not compiling with threading
 
-The location of any new code is also an important consideration.  Don't
-just create a new top level .c file and put your code there; you would
-have to make changes to Configure (so the Makefile is created properly),
-as well as possibly lots of include files.  This is strictly pumpking
-business.
+Compiling with threading (-Duseithreads) completely rewrites
+the function prototypes of Perl.  You better try your changes
+with that.  Related to this is the difference between "Perl_-less"
+and "Perl_-ly" APIs, for example:
 
-It is better to add your function to one of the existing top level
-source code files, but your choice is complicated by the nature of
-the Perl distribution.  Only the files that are marked as compiled
-static are located in the perl executable.  Everything else is located
-in the shared library (or DLL if you are running under WIN32).  So,
-for example, if a function was only used by functions located in
-toke.c, then your code can go in toke.c.  If, however, you want to call
-the function from universal.c, then you should put your code in another
-location, for example util.c.
+  Perl_sv_setiv(aTHX_ ...);
+  sv_setiv(...);
 
-In addition to writing your c-code, you will need to create an
-appropriate entry in embed.pl describing your function, then run
-'make regen_headers' to create the entries in the numerous header
-files that perl needs to compile correctly.  See L<perlguts/Internal Functions>
-for information on the various options that you can set in embed.pl.
-You will forget to do this a few (or many) times and you will get
-warnings during the compilation phase.  Make sure that you mention
-this when you post your patch to P5P; the pumpking needs to know this.
+The first one explicitly passes in the context, which is needed for e.g.
+threaded builds.  The second one does that implicitly; do not get them
+mixed.  If you are not passing in a aTHX_, you will need to do a dTHX
+(or a dVAR) as the first thing in the function.
 
-When you write your new code, please be conscious of existing code
-conventions used in the perl source files.  See L<perlstyle> for
-details.  Although most of the guidelines discussed seem to focus on
-Perl code, rather than c, they all apply (except when they don't ;).
-Also see L<perlrepository> for lots of details about both formatting and
-submitting patches of your changes.
+See L<perlguts/"How multiple interpreters and concurrency are supported">
+for further discussion about context.
 
-Lastly, TEST TEST TEST TEST TEST any code before posting to p5p.
-Test on as many platforms as you can find.  Test as many perl
-Configure options as you can (e.g. MULTIPLICITY).  If you have
-profiling or memory tools, see L<EXTERNAL TOOLS FOR DEBUGGING PERL>
-below for how to use them to further test your code.  Remember that
-most of the people on P5P are doing this on their own time and
-don't have the time to debug your code.
+=item *
 
-=head2 Writing a test
+Not compiling with -DDEBUGGING
 
-Every module and built-in function has an associated test file (or
-should...).  If you add or change functionality, you have to write a
-test.  If you fix a bug, you have to write a test so that bug never
-comes back.  If you alter the docs, it would be nice to test what the
-new documentation says.
+The DEBUGGING define exposes more code to the compiler,
+therefore more ways for things to go wrong.  You should try it.
 
-In short, if you submit a patch you probably also have to patch the
-tests.
+=item *
 
-For modules, the test file is right next to the module itself.
-F<lib/strict.t> tests F<lib/strict.pm>.  This is a recent innovation,
-so there are some snags (and it would be wonderful for you to brush
-them out), but it basically works that way.  Everything else lives in
-F<t/>.
+Introducing (non-read-only) globals
 
-Testing of warning messages is often separately done by using expect scripts in
-F<t/lib/warnings>.  This is because much of the setup for them is already done
-for you.
+Do not introduce any modifiable globals, truly global or file static.
+They are bad form and complicate multithreading and other forms of
+concurrency.  The right way is to introduce them as new interpreter
+variables, see F<intrpvar.h> (at the very end for binary compatibility).
 
-If you add a new test directory under F<t/>, it is imperative that you 
-add that directory to F<t/HARNESS> and F<t/TEST>.
+Introducing read-only (const) globals is okay, as long as you verify
+with e.g. C<nm libperl.a|egrep -v ' [TURtr] '> (if your C<nm> has
+BSD-style output) that the data you added really is read-only.
+(If it is, it shouldn't show up in the output of that command.)
 
-=over 3
+If you want to have static strings, make them constant:
 
-=item F<t/base/>
+  static const char etc[] = "...";
 
-Testing of the absolute basic functionality of Perl.  Things like
-C<if>, basic file reads and writes, simple regexes, etc.  These are
-run first in the test suite and if any of them fail, something is
-I<really> broken.
+If you want to have arrays of constant strings, note carefully
+the right combination of C<const>s:
 
-=item F<t/cmd/>
+    static const char * const yippee[] =
+       {"hi", "ho", "silver"};
 
-These test the basic control structures, C<if/else>, C<while>,
-subroutines, etc.
+There is a way to completely hide any modifiable globals (they are all
+moved to heap), the compilation setting C<-DPERL_GLOBAL_STRUCT_PRIVATE>.
+It is not normally used, but can be used for testing, read more
+about it in L<perlguts/"Background and PERL_IMPLICIT_CONTEXT">.
 
-=item F<t/comp/>
+=item *
 
-Tests basic issues of how Perl parses and compiles itself.
+Not exporting your new function
 
-=item F<t/io/>
+Some platforms (Win32, AIX, VMS, OS/2, to name a few) require any
+function that is part of the public API (the shared Perl library)
+to be explicitly marked as exported.  See the discussion about
+F<embed.pl> in L<perlguts>.
 
-Tests for built-in IO functions, including command line arguments.
+=item *
 
-=item F<t/lib/>
+Exporting your new function
 
-The old home for the module tests, you shouldn't put anything new in
-here.  There are still some bits and pieces hanging around in here
-that need to be moved.  Perhaps you could move them?  Thanks!
+The new shiny result of either genuine new functionality or your
+arduous refactoring is now ready and correctly exported.  So what
+could possibly go wrong?
 
-=item F<t/mro/>
+Maybe simply that your function did not need to be exported in the
+first place.  Perl has a long and not so glorious history of exporting
+functions that it should not have.
 
-Tests for perl's method resolution order implementations
-(see L<mro>).
+If the function is used only inside one source code file, make it
+static.  See the discussion about F<embed.pl> in L<perlguts>.
 
-=item F<t/op/>
+If the function is used across several files, but intended only for
+Perl's internal use (and this should be the common case), do not
+export it to the public API.  See the discussion about F<embed.pl>
+in L<perlguts>.
 
-Tests for perl's built in functions that don't fit into any of the
-other directories.
+=back
 
-=item F<t/re/>
+=head2 Portability problems
 
-Tests for regex related functions or behaviour. (These used to live
-in t/op).
+The following are common causes of compilation and/or execution
+failures, not common to Perl as such.  The C FAQ is good bedtime
+reading.  Please test your changes with as many C compilers and
+platforms as possible; we will, anyway, and it's nice to save
+oneself from public embarrassment.
 
-=item F<t/run/>
+If using gcc, you can add the C<-std=c89> option which will hopefully
+catch most of these unportabilities. (However it might also catch
+incompatibilities in your system's header files.)
 
-Testing features of how perl actually runs, including exit codes and
-handling of PERL* environment variables.
+Use the Configure C<-Dgccansipedantic> flag to enable the gcc
+C<-ansi -pedantic> flags which enforce stricter ANSI rules.
 
-=item F<t/uni/>
+If using the C<gcc -Wall> note that not all the possible warnings
+(like C<-Wunitialized>) are given unless you also compile with C<-O>.
 
-Tests for the core support of Unicode.
+Note that if using gcc, starting from Perl 5.9.5 the Perl core source
+code files (the ones at the top level of the source code distribution,
+but not e.g. the extensions under ext/) are automatically compiled
+with as many as possible of the C<-std=c89>, C<-ansi>, C<-pedantic>,
+and a selection of C<-W> flags (see cflags.SH).
 
-=item F<t/win32/>
+Also study L<perlport> carefully to avoid any bad assumptions
+about the operating system, filesystems, and so forth.
 
-Windows-specific tests.
+You may once in a while try a "make microperl" to see whether we
+can still compile Perl with just the bare minimum of interfaces.
+(See README.micro.)
 
-=item F<t/x2p>
+Do not assume an operating system indicates a certain compiler.
 
-A test suite for the s2p converter.
+=over 4
 
-=back
+=item *
 
-The core uses the same testing style as the rest of Perl, a simple
-"ok/not ok" run through Test::Harness, but there are a few special
-considerations.
+Casting pointers to integers or casting integers to pointers
 
-There are three ways to write a test in the core.  Test::More,
-t/test.pl and ad hoc C<print $test ? "ok 42\n" : "not ok 42\n">.  The
-decision of which to use depends on what part of the test suite you're
-working on.  This is a measure to prevent a high-level failure (such
-as Config.pm breaking) from causing basic functionality tests to fail.
-If you write your own test, use the L<Test Anything Protocol|TAP>.
+    void castaway(U8* p)
+    {
+      IV i = p;
 
-=over 4
+or
 
-=item t/base t/comp
+    void castaway(U8* p)
+    {
+      IV i = (IV)p;
 
-Since we don't know if require works, or even subroutines, use ad hoc
-tests for these two.  Step carefully to avoid using the feature being
-tested.
+Both are bad, and broken, and unportable.  Use the PTR2IV()
+macro that does it right.  (Likewise, there are PTR2UV(), PTR2NV(),
+INT2PTR(), and NUM2PTR().)
 
-=item t/cmd t/run t/io t/op
+=item *
 
-Now that basic require() and subroutines are tested, you can use the
-t/test.pl library which emulates the important features of Test::More
-while using a minimum of core features.
+Casting between data function pointers and data pointers
 
-You can also conditionally use certain libraries like Config, but be
-sure to skip the test gracefully if it's not there.
+Technically speaking casting between function pointers and data
+pointers is unportable and undefined, but practically speaking
+it seems to work, but you should use the FPTR2DPTR() and DPTR2FPTR()
+macros.  Sometimes you can also play games with unions.
 
-=item t/lib ext lib
+=item *
 
-Now that the core of Perl is tested, Test::More can be used.  You can
-also use the full suite of core modules in the tests.
+Assuming sizeof(int) == sizeof(long)
 
-=back
+There are platforms where longs are 64 bits, and platforms where ints
+are 64 bits, and while we are out to shock you, even platforms where
+shorts are 64 bits.  This is all legal according to the C standard.
+(In other words, "long long" is not a portable way to specify 64 bits,
+and "long long" is not even guaranteed to be any wider than "long".)
 
-When you say "make test" Perl uses the F<t/TEST> program to run the
-test suite (except under Win32 where it uses F<t/harness> instead.)
-All tests are run from the F<t/> directory, B<not> the directory
-which contains the test.  This causes some problems with the tests
-in F<lib/>, so here's some opportunity for some patching.
+Instead, use the definitions IV, UV, IVSIZE, I32SIZE, and so forth.
+Avoid things like I32 because they are B<not> guaranteed to be
+I<exactly> 32 bits, they are I<at least> 32 bits, nor are they
+guaranteed to be B<int> or B<long>.  If you really explicitly need
+64-bit variables, use I64 and U64, but only if guarded by HAS_QUAD.
 
-You must be triply conscious of cross-platform concerns.  This usually
-boils down to using File::Spec and avoiding things like C<fork()> and
-C<system()> unless absolutely necessary.
+=item *
 
-=head2 Special Make Test Targets
+Assuming one can dereference any type of pointer for any type of data
 
-There are various special make targets that can be used to test Perl
-slightly differently than the standard "test" target.  Not all them
-are expected to give a 100% success rate.  Many of them have several
-aliases, and many of them are not available on certain operating
-systems.
+  char *p = ...;
+  long pony = *p;    /* BAD */
 
-=over 4
+Many platforms, quite rightly so, will give you a core dump instead
+of a pony if the p happens not be correctly aligned.
 
-=item coretest
+=item *
 
-Run F<perl> on all core tests (F<t/*> and F<lib/[a-z]*> pragma tests).
+Lvalue casts
 
-(Not available on Win32)
+  (int)*p = ...;    /* BAD */
 
-=item test.deparse
+Simply not portable.  Get your lvalue to be of the right type,
+or maybe use temporary variables, or dirty tricks with unions.
 
-Run all the tests through B::Deparse.  Not all tests will succeed.
+=item *
 
-(Not available on Win32)
+Assume B<anything> about structs (especially the ones you
+don't control, like the ones coming from the system headers)
 
-=item test.taintwarn
+=over 8
 
-Run all tests with the B<-t> command-line switch.  Not all tests
-are expected to succeed (until they're specifically fixed, of course).
+=item *
 
-(Not available on Win32)
+That a certain field exists in a struct
 
-=item minitest
+=item *
 
-Run F<miniperl> on F<t/base>, F<t/comp>, F<t/cmd>, F<t/run>, F<t/io>,
-F<t/op>, F<t/uni> and F<t/mro> tests.
+That no other fields exist besides the ones you know of
 
-=item test.valgrind check.valgrind utest.valgrind ucheck.valgrind
+=item *
 
-(Only in Linux) Run all the tests using the memory leak + naughty
-memory access tool "valgrind".  The log files will be named
-F<testname.valgrind>.
+That a field is of certain signedness, sizeof, or type
 
-=item test.third check.third utest.third ucheck.third
+=item *
 
-(Only in Tru64)  Run all the tests using the memory leak + naughty
-memory access tool "Third Degree".  The log files will be named
-F<perl.3log.testname>.
+That the fields are in a certain order
 
-=item test.torture torturetest
+=over 8
 
-Run all the usual tests and some extra tests.  As of Perl 5.8.0 the
-only extra tests are Abigail's JAPHs, F<t/japh/abigail.t>.
+=item *
 
-You can also run the torture test with F<t/harness> by giving
-C<-torture> argument to F<t/harness>.
+While C guarantees the ordering specified in the struct definition,
+between different platforms the definitions might differ
 
-=item utest ucheck test.utf8 check.utf8
+=back
 
-Run all the tests with -Mutf8.  Not all tests will succeed.
+=item *
 
-(Not available on Win32)
+That the sizeof(struct) or the alignments are the same everywhere
 
-=item minitest.utf16 test.utf16
+=over 8
 
-Runs the tests with UTF-16 encoded scripts, encoded with different
-versions of this encoding.
+=item *
 
-C<make utest.utf16> runs the test suite with a combination of C<-utf8> and
-C<-utf16> arguments to F<t/TEST>.
+There might be padding bytes between the fields to align the fields -
+the bytes can be anything
 
-(Not available on Win32)
+=item *
 
-=item test_harness
+Structs are required to be aligned to the maximum alignment required
+by the fields - which for native types is for usually equivalent to
+sizeof() of the field
 
-Run the test suite with the F<t/harness> controlling program, instead of
-F<t/TEST>. F<t/harness> is more sophisticated, and uses the
-L<Test::Harness> module, thus using this test target supposes that perl
-mostly works. The main advantage for our purposes is that it prints a
-detailed summary of failed tests at the end. Also, unlike F<t/TEST>, it
-doesn't redirect stderr to stdout.
+=back
 
-Note that under Win32 F<t/harness> is always used instead of F<t/TEST>, so
-there is no special "test_harness" target.
+=back
 
-Under Win32's "test" target you may use the TEST_SWITCHES and TEST_FILES
-environment variables to control the behaviour of F<t/harness>.  This means
-you can say
+=item *
 
-    nmake test TEST_FILES="op/*.t"
-    nmake test TEST_SWITCHES="-torture" TEST_FILES="op/*.t"
+Assuming the character set is ASCIIish
 
-=item Parallel tests
+Perl can compile and run under EBCDIC platforms.  See L<perlebcdic>.
+This is transparent for the most part, but because the character sets
+differ, you shouldn't use numeric (decimal, octal, nor hex) constants
+to refer to characters.  You can safely say 'A', but not 0x41.
+You can safely say '\n', but not \012.
+If a character doesn't have a trivial input form, you can
+create a #define for it in both C<utfebcdic.h> and C<utf8.h>, so that
+it resolves to different values depending on the character set being used.
+(There are three different EBCDIC character sets defined in C<utfebcdic.h>,
+so it might be best to insert the #define three times in that file.)
 
-The core distribution can now run its regression tests in parallel on
-Unix-like platforms. Instead of running C<make test>, set C<TEST_JOBS> in
-your environment to the number of tests to run in parallel, and run
-C<make test_harness>. On a Bourne-like shell, this can be done as
+Also, the range 'A' - 'Z' in ASCII is an unbroken sequence of 26 upper case
+alphabetic characters.  That is not true in EBCDIC.  Nor for 'a' to 'z'.
+But '0' - '9' is an unbroken range in both systems.  Don't assume anything
+about other ranges.
 
-    TEST_JOBS=3 make test_harness  # Run 3 tests in parallel
+Many of the comments in the existing code ignore the possibility of EBCDIC,
+and may be wrong therefore, even if the code works.
+This is actually a tribute to the successful transparent insertion of being
+able to handle EBCDIC without having to change pre-existing code.
 
-An environment variable is used, rather than parallel make itself, because
-L<TAP::Harness> needs to be able to schedule individual non-conflicting test
-scripts itself, and there is no standard interface to C<make> utilities to
-interact with their job schedulers.
+UTF-8 and UTF-EBCDIC are two different encodings used to represent Unicode
+code points as sequences of bytes.  Macros 
+with the same names (but different definitions)
+in C<utf8.h> and C<utfebcdic.h>
+are used to allow the calling code to think that there is only one such
+encoding.
+This is almost always referred to as C<utf8>, but it means the EBCDIC version
+as well.  Again, comments in the code may well be wrong even if the code itself
+is right.
+For example, the concept of C<invariant characters> differs between ASCII and
+EBCDIC.
+On ASCII platforms, only characters that do not have the high-order
+bit set (i.e. whose ordinals are strict ASCII, 0 - 127)
+are invariant, and the documentation and comments in the code
+may assume that,
+often referring to something like, say, C<hibit>.
+The situation differs and is not so simple on EBCDIC machines, but as long as
+the code itself uses the C<NATIVE_IS_INVARIANT()> macro appropriately, it
+works, even if the comments are wrong.
 
-Note that currently some test scripts may fail when run in parallel (most
-notably C<ext/IO/t/io_dir.t>). If necessary run just the failing scripts
-again sequentially and see if the failures go away.
-=item test-notty test_notty
+=item *
 
-Sets PERL_SKIP_TTY_TEST to true before running normal test.
+Assuming the character set is just ASCII
 
-=back
+ASCII is a 7 bit encoding, but bytes have 8 bits in them.  The 128 extra
+characters have different meanings depending on the locale.  Absent a locale,
+currently these extra characters are generally considered to be unassigned,
+and this has presented some problems.
+This is being changed starting in 5.12 so that these characters will
+be considered to be Latin-1 (ISO-8859-1).
 
-=head2 Running tests by hand
+=item *
 
-You can run part of the test suite by hand by using one the following
-commands from the F<t/> directory :
+Mixing #define and #ifdef
 
-    ./perl -I../lib TEST list-of-.t-files
+  #define BURGLE(x) ... \
+  #ifdef BURGLE_OLD_STYLE        /* BAD */
+  ... do it the old way ... \
+  #else
+  ... do it the new way ... \
+  #endif
 
-or
+You cannot portably "stack" cpp directives.  For example in the above
+you need two separate BURGLE() #defines, one for each #ifdef branch.
 
-    ./perl -I../lib harness list-of-.t-files
+=item *
 
-(if you don't specify test scripts, the whole test suite will be run.)
+Adding non-comment stuff after #endif or #else
 
-=head3 Using t/harness for testing
+  #ifdef SNOSH
+  ...
+  #else !SNOSH    /* BAD */
+  ...
+  #endif SNOSH    /* BAD */
 
-If you use C<harness> for testing you have several command line options
-available to you. The arguments are as follows, and are in the order
-that they must appear if used together.
+The #endif and #else cannot portably have anything non-comment after
+them.  If you want to document what is going (which is a good idea
+especially if the branches are long), use (C) comments:
 
-    harness -v -torture -re=pattern LIST OF FILES TO TEST
-    harness -v -torture -re LIST OF PATTERNS TO MATCH
+  #ifdef SNOSH
+  ...
+  #else /* !SNOSH */
+  ...
+  #endif /* SNOSH */
 
-If C<LIST OF FILES TO TEST> is omitted the file list is obtained from
-the manifest. The file list may include shell wildcards which will be
-expanded out.
+The gcc option C<-Wendif-labels> warns about the bad variant
+(by default on starting from Perl 5.9.4).
 
-=over 4
+=item *
 
-=item -v
+Having a comma after the last element of an enum list
 
-Run the tests under verbose mode so you can see what tests were run,
-and debug output.
+  enum color {
+    CERULEAN,
+    CHARTREUSE,
+    CINNABAR,     /* BAD */
+  };
 
-=item -torture
+is not portable.  Leave out the last comma.
 
-Run the torture tests as well as the normal set.
+Also note that whether enums are implicitly morphable to ints
+varies between compilers, you might need to (int).
 
-=item -re=PATTERN
+=item *
 
-Filter the file list so that all the test files run match PATTERN.
-Note that this form is distinct from the B<-re LIST OF PATTERNS> form below
-in that it allows the file list to be provided as well.
+Using //-comments
 
-=item -re LIST OF PATTERNS
+  // This function bamfoodles the zorklator.    /* BAD */
 
-Filter the file list so that all the test files run match
-/(LIST|OF|PATTERNS)/. Note that with this form the patterns
-are joined by '|' and you cannot supply a list of files, instead
-the test files are obtained from the MANIFEST.
+That is C99 or C++.  Perl is C89.  Using the //-comments is silently
+allowed by many C compilers but cranking up the ANSI C89 strictness
+(which we like to do) causes the compilation to fail.
 
-=back
+=item *
 
-You can run an individual test by a command similar to
+Mixing declarations and code
 
-    ./perl -I../lib patho/to/foo.t
+  void zorklator()
+  {
+    int n = 3;
+    set_zorkmids(n);    /* BAD */
+    int q = 4;
 
-except that the harnesses set up some environment variables that may
-affect the execution of the test :
+That is C99 or C++.  Some C compilers allow that, but you shouldn't.
 
-=over 4
+The gcc option C<-Wdeclaration-after-statements> scans for such problems
+(by default on starting from Perl 5.9.4).
 
-=item PERL_CORE=1
+=item *
 
-indicates that we're running this test part of the perl core test suite.
-This is useful for modules that have a dual life on CPAN.
+Introducing variables inside for()
 
-=item PERL_DESTRUCT_LEVEL=2
+  for(int i = ...; ...; ...) {    /* BAD */
 
-is set to 2 if it isn't set already (see L</PERL_DESTRUCT_LEVEL>)
+That is C99 or C++.  While it would indeed be awfully nice to have that
+also in C89, to limit the scope of the loop variable, alas, we cannot.
 
-=item PERL
+=item *
 
-(used only by F<t/TEST>) if set, overrides the path to the perl executable
-that should be used to run the tests (the default being F<./perl>).
+Mixing signed char pointers with unsigned char pointers
 
-=item PERL_SKIP_TTY_TEST
+  int foo(char *s) { ... }
+  ...
+  unsigned char *t = ...; /* Or U8* t = ... */
+  foo(t);   /* BAD */
 
-if set, tells to skip the tests that need a terminal. It's actually set
-automatically by the Makefile, but can also be forced artificially by
-running 'make test_notty'.
+While this is legal practice, it is certainly dubious, and downright
+fatal in at least one platform: for example VMS cc considers this a
+fatal error.  One cause for people often making this mistake is that a
+"naked char" and therefore dereferencing a "naked char pointer" have
+an undefined signedness: it depends on the compiler and the flags of
+the compiler and the underlying platform whether the result is signed
+or unsigned.  For this very same reason using a 'char' as an array
+index is bad.
 
-=back
+=item *
 
-=head3 Other environment variables that may influence tests
+Macros that have string constants and their arguments as substrings of
+the string constants
 
-=over 4
+  #define FOO(n) printf("number = %d\n", n)    /* BAD */
+  FOO(10);
 
-=item PERL_TEST_Net_Ping
+Pre-ANSI semantics for that was equivalent to
 
-Setting this variable runs all the Net::Ping modules tests,
-otherwise some tests that interact with the outside world are skipped.
-See L<perl58delta>.
+  printf("10umber = %d\10");
 
-=item PERL_TEST_NOVREXX
+which is probably not what you were expecting.  Unfortunately at least
+one reasonably common and modern C compiler does "real backward
+compatibility" here, in AIX that is what still happens even though the
+rest of the AIX compiler is very happily C89.
 
-Setting this variable skips the vrexx.t tests for OS2::REXX.
+=item *
 
-=item PERL_TEST_NUMCONVERTS
+Using printf formats for non-basic C types
 
-This sets a variable in op/numconvert.t.
+   IV i = ...;
+   printf("i = %d\n", i);    /* BAD */
 
-=back
+While this might by accident work in some platform (where IV happens
+to be an C<int>), in general it cannot.  IV might be something larger.
+Even worse the situation is with more specific types (defined by Perl's
+configuration step in F<config.h>):
 
-See also the documentation for the Test and Test::Harness modules,
-for more environment variables that affect testing.
+   Uid_t who = ...;
+   printf("who = %d\n", who);    /* BAD */
 
-=head2 Common problems when patching Perl source code
+The problem here is that Uid_t might be not only not C<int>-wide
+but it might also be unsigned, in which case large uids would be
+printed as negative values.
 
-Perl source plays by ANSI C89 rules: no C99 (or C++) extensions.  In
-some cases we have to take pre-ANSI requirements into consideration.
-You don't care about some particular platform having broken Perl?
-I hear there is still a strong demand for J2EE programmers.
+There is no simple solution to this because of printf()'s limited
+intelligence, but for many types the right format is available as
+with either 'f' or '_f' suffix, for example:
 
-=head2 Perl environment problems
+   IVdf /* IV in decimal */
+   UVxf /* UV is hexadecimal */
 
-=over 4
+   printf("i = %"IVdf"\n", i); /* The IVdf is a string constant. */
 
-=item *
+   Uid_t_f /* Uid_t in decimal */
 
-Not compiling with threading
+   printf("who = %"Uid_t_f"\n", who);
 
-Compiling with threading (-Duseithreads) completely rewrites
-the function prototypes of Perl.  You better try your changes
-with that.  Related to this is the difference between "Perl_-less"
-and "Perl_-ly" APIs, for example:
+Or you can try casting to a "wide enough" type:
 
-  Perl_sv_setiv(aTHX_ ...);
-  sv_setiv(...);
+   printf("i = %"IVdf"\n", (IV)something_very_small_and_signed);
 
-The first one explicitly passes in the context, which is needed for e.g.
-threaded builds.  The second one does that implicitly; do not get them
-mixed.  If you are not passing in a aTHX_, you will need to do a dTHX
-(or a dVAR) as the first thing in the function.
+Also remember that the C<%p> format really does require a void pointer:
 
-See L<perlguts/"How multiple interpreters and concurrency are supported">
-for further discussion about context.
+   U8* p = ...;
+   printf("p = %p\n", (void*)p);
+
+The gcc option C<-Wformat> scans for such problems.
 
 =item *
 
-Not compiling with -DDEBUGGING
+Blindly using variadic macros
 
-The DEBUGGING define exposes more code to the compiler,
-therefore more ways for things to go wrong.  You should try it.
+gcc has had them for a while with its own syntax, and C99 brought
+them with a standardized syntax.  Don't use the former, and use
+the latter only if the HAS_C99_VARIADIC_MACROS is defined.
 
 =item *
 
-Introducing (non-read-only) globals
-
-Do not introduce any modifiable globals, truly global or file static.
-They are bad form and complicate multithreading and other forms of
-concurrency.  The right way is to introduce them as new interpreter
-variables, see F<intrpvar.h> (at the very end for binary compatibility).
-
-Introducing read-only (const) globals is okay, as long as you verify
-with e.g. C<nm libperl.a|egrep -v ' [TURtr] '> (if your C<nm> has
-BSD-style output) that the data you added really is read-only.
-(If it is, it shouldn't show up in the output of that command.)
+Blindly passing va_list
 
-If you want to have static strings, make them constant:
+Not all platforms support passing va_list to further varargs (stdarg)
+functions.  The right thing to do is to copy the va_list using the
+Perl_va_copy() if the NEED_VA_COPY is defined.
 
-  static const char etc[] = "...";
+=item *
 
-If you want to have arrays of constant strings, note carefully
-the right combination of C<const>s:
+Using gcc statement expressions
 
-    static const char * const yippee[] =
-       {"hi", "ho", "silver"};
+   val = ({...;...;...});    /* BAD */
 
-There is a way to completely hide any modifiable globals (they are all
-moved to heap), the compilation setting C<-DPERL_GLOBAL_STRUCT_PRIVATE>.
-It is not normally used, but can be used for testing, read more
-about it in L<perlguts/"Background and PERL_IMPLICIT_CONTEXT">.
+While a nice extension, it's not portable.  The Perl code does
+admittedly use them if available to gain some extra speed
+(essentially as a funky form of inlining), but you shouldn't.
 
 =item *
 
-Not exporting your new function
+Binding together several statements in a macro
 
-Some platforms (Win32, AIX, VMS, OS/2, to name a few) require any
-function that is part of the public API (the shared Perl library)
-to be explicitly marked as exported.  See the discussion about
-F<embed.pl> in L<perlguts>.
+Use the macros STMT_START and STMT_END.
+
+   STMT_START {
+      ...
+   } STMT_END
 
 =item *
 
-Exporting your new function
+Testing for operating systems or versions when should be testing for features
 
-The new shiny result of either genuine new functionality or your
-arduous refactoring is now ready and correctly exported.  So what
-could possibly go wrong?
+  #ifdef __FOONIX__    /* BAD */
+  foo = quux();
+  #endif
 
-Maybe simply that your function did not need to be exported in the
-first place.  Perl has a long and not so glorious history of exporting
-functions that it should not have.
+Unless you know with 100% certainty that quux() is only ever available
+for the "Foonix" operating system B<and> that is available B<and>
+correctly working for B<all> past, present, B<and> future versions of
+"Foonix", the above is very wrong.  This is more correct (though still
+not perfect, because the below is a compile-time check):
 
-If the function is used only inside one source code file, make it
-static.  See the discussion about F<embed.pl> in L<perlguts>.
+  #ifdef HAS_QUUX
+  foo = quux();
+  #endif
 
-If the function is used across several files, but intended only for
-Perl's internal use (and this should be the common case), do not
-export it to the public API.  See the discussion about F<embed.pl>
-in L<perlguts>.
+How does the HAS_QUUX become defined where it needs to be?  Well, if
+Foonix happens to be Unixy enough to be able to run the Configure
+script, and Configure has been taught about detecting and testing
+quux(), the HAS_QUUX will be correctly defined.  In other platforms,
+the corresponding configuration step will hopefully do the same.
 
-=back
+In a pinch, if you cannot wait for Configure to be educated,
+or if you have a good hunch of where quux() might be available,
+you can temporarily try the following:
 
-=head2 Portability problems
+  #if (defined(__FOONIX__) || defined(__BARNIX__))
+  # define HAS_QUUX
+  #endif
 
-The following are common causes of compilation and/or execution
-failures, not common to Perl as such.  The C FAQ is good bedtime
-reading.  Please test your changes with as many C compilers and
-platforms as possible; we will, anyway, and it's nice to save
-oneself from public embarrassment.
+  ...
 
-If using gcc, you can add the C<-std=c89> option which will hopefully
-catch most of these unportabilities. (However it might also catch
-incompatibilities in your system's header files.)
+  #ifdef HAS_QUUX
+  foo = quux();
+  #endif
 
-Use the Configure C<-Dgccansipedantic> flag to enable the gcc
-C<-ansi -pedantic> flags which enforce stricter ANSI rules.
-
-If using the C<gcc -Wall> note that not all the possible warnings
-(like C<-Wunitialized>) are given unless you also compile with C<-O>.
-
-Note that if using gcc, starting from Perl 5.9.5 the Perl core source
-code files (the ones at the top level of the source code distribution,
-but not e.g. the extensions under ext/) are automatically compiled
-with as many as possible of the C<-std=c89>, C<-ansi>, C<-pedantic>,
-and a selection of C<-W> flags (see cflags.SH).
-
-Also study L<perlport> carefully to avoid any bad assumptions
-about the operating system, filesystems, and so forth.
+But in any case, try to keep the features and operating systems separate.
 
-You may once in a while try a "make microperl" to see whether we
-can still compile Perl with just the bare minimum of interfaces.
-(See README.micro.)
+=back
 
-Do not assume an operating system indicates a certain compiler.
+=head2 Problematic System Interfaces
 
 =over 4
 
 =item *
 
-Casting pointers to integers or casting integers to pointers
-
-    void castaway(U8* p)
-    {
-      IV i = p;
-
-or
-
-    void castaway(U8* p)
-    {
-      IV i = (IV)p;
-
-Both are bad, and broken, and unportable.  Use the PTR2IV()
-macro that does it right.  (Likewise, there are PTR2UV(), PTR2NV(),
-INT2PTR(), and NUM2PTR().)
-
-=item *
-
-Casting between data function pointers and data pointers
-
-Technically speaking casting between function pointers and data
-pointers is unportable and undefined, but practically speaking
-it seems to work, but you should use the FPTR2DPTR() and DPTR2FPTR()
-macros.  Sometimes you can also play games with unions.
-
-=item *
-
-Assuming sizeof(int) == sizeof(long)
-
-There are platforms where longs are 64 bits, and platforms where ints
-are 64 bits, and while we are out to shock you, even platforms where
-shorts are 64 bits.  This is all legal according to the C standard.
-(In other words, "long long" is not a portable way to specify 64 bits,
-and "long long" is not even guaranteed to be any wider than "long".)
-
-Instead, use the definitions IV, UV, IVSIZE, I32SIZE, and so forth.
-Avoid things like I32 because they are B<not> guaranteed to be
-I<exactly> 32 bits, they are I<at least> 32 bits, nor are they
-guaranteed to be B<int> or B<long>.  If you really explicitly need
-64-bit variables, use I64 and U64, but only if guarded by HAS_QUAD.
-
-=item *
-
-Assuming one can dereference any type of pointer for any type of data
-
-  char *p = ...;
-  long pony = *p;    /* BAD */
-
-Many platforms, quite rightly so, will give you a core dump instead
-of a pony if the p happens not be correctly aligned.
-
-=item *
-
-Lvalue casts
-
-  (int)*p = ...;    /* BAD */
-
-Simply not portable.  Get your lvalue to be of the right type,
-or maybe use temporary variables, or dirty tricks with unions.
-
-=item *
-
-Assume B<anything> about structs (especially the ones you
-don't control, like the ones coming from the system headers)
-
-=over 8
-
-=item *
-
-That a certain field exists in a struct
+malloc(0), realloc(0), calloc(0, 0) are non-portable.  To be portable
+allocate at least one byte.  (In general you should rarely need to
+work at this low level, but instead use the various malloc wrappers.)
 
 =item *
 
-That no other fields exist besides the ones you know of
-
-=item *
+snprintf() - the return type is unportable.  Use my_snprintf() instead.
 
-That a field is of certain signedness, sizeof, or type
+=back
 
-=item *
+=head2 Security problems
 
-That the fields are in a certain order
+Last but not least, here are various tips for safer coding.
 
-=over 8
+=over 4
 
 =item *
 
-While C guarantees the ordering specified in the struct definition,
-between different platforms the definitions might differ
+Do not use gets()
 
-=back
+Or we will publicly ridicule you.  Seriously.
 
 =item *
 
-That the sizeof(struct) or the alignments are the same everywhere
+Do not use strcpy() or strcat() or strncpy() or strncat()
 
-=over 8
+Use my_strlcpy() and my_strlcat() instead: they either use the native
+implementation, or Perl's own implementation (borrowed from the public
+domain implementation of INN).
 
 =item *
 
-There might be padding bytes between the fields to align the fields -
-the bytes can be anything
-
-=item *
+Do not use sprintf() or vsprintf()
 
-Structs are required to be aligned to the maximum alignment required
-by the fields - which for native types is for usually equivalent to
-sizeof() of the field
+If you really want just plain byte strings, use my_snprintf()
+and my_vsnprintf() instead, which will try to use snprintf() and
+vsnprintf() if those safer APIs are available.  If you want something
+fancier than a plain byte string, use SVs and Perl_sv_catpvf().
 
 =back
 
-=back
 
-=item *
+=head1 DEBUGGING
 
-Assuming the character set is ASCIIish
+You can compile a special debugging version of Perl, which allows you
+to use the C<-D> option of Perl to tell more about what Perl is doing.
+But sometimes there is no alternative than to dive in with a debugger,
+either to see the stack trace of a core dump (very useful in a bug
+report), or trying to figure out what went wrong before the core dump
+happened, or how did we end up having wrong or unexpected results.
 
-Perl can compile and run under EBCDIC platforms.  See L<perlebcdic>.
-This is transparent for the most part, but because the character sets
-differ, you shouldn't use numeric (decimal, octal, nor hex) constants
-to refer to characters.  You can safely say 'A', but not 0x41.
-You can safely say '\n', but not \012.
-If a character doesn't have a trivial input form, you can
-create a #define for it in both C<utfebcdic.h> and C<utf8.h>, so that
-it resolves to different values depending on the character set being used.
-(There are three different EBCDIC character sets defined in C<utfebcdic.h>,
-so it might be best to insert the #define three times in that file.)
+=head2 Poking at Perl
 
-Also, the range 'A' - 'Z' in ASCII is an unbroken sequence of 26 upper case
-alphabetic characters.  That is not true in EBCDIC.  Nor for 'a' to 'z'.
-But '0' - '9' is an unbroken range in both systems.  Don't assume anything
-about other ranges.
+To really poke around with Perl, you'll probably want to build Perl for
+debugging, like this:
 
-Many of the comments in the existing code ignore the possibility of EBCDIC,
-and may be wrong therefore, even if the code works.
-This is actually a tribute to the successful transparent insertion of being
-able to handle EBCDIC without having to change pre-existing code.
+    ./Configure -d -D optimize=-g
+    make
 
-UTF-8 and UTF-EBCDIC are two different encodings used to represent Unicode
-code points as sequences of bytes.  Macros 
-with the same names (but different definitions)
-in C<utf8.h> and C<utfebcdic.h>
-are used to allow the calling code to think that there is only one such
-encoding.
-This is almost always referred to as C<utf8>, but it means the EBCDIC version
-as well.  Again, comments in the code may well be wrong even if the code itself
-is right.
-For example, the concept of C<invariant characters> differs between ASCII and
-EBCDIC.
-On ASCII platforms, only characters that do not have the high-order
-bit set (i.e. whose ordinals are strict ASCII, 0 - 127)
-are invariant, and the documentation and comments in the code
-may assume that,
-often referring to something like, say, C<hibit>.
-The situation differs and is not so simple on EBCDIC machines, but as long as
-the code itself uses the C<NATIVE_IS_INVARIANT()> macro appropriately, it
-works, even if the comments are wrong.
+C<-g> is a flag to the C compiler to have it produce debugging
+information which will allow us to step through a running program,
+and to see in which C function we are at (without the debugging
+information we might see only the numerical addresses of the functions,
+which is not very helpful).
 
-=item *
+F<Configure> will also turn on the C<DEBUGGING> compilation symbol which
+enables all the internal debugging code in Perl. There are a whole bunch
+of things you can debug with this: L<perlrun> lists them all, and the
+best way to find out about them is to play about with them. The most
+useful options are probably
 
-Assuming the character set is just ASCII
+    l  Context (loop) stack processing
+    t  Trace execution
+    o  Method and overloading resolution
+    c  String/numeric conversions
 
-ASCII is a 7 bit encoding, but bytes have 8 bits in them.  The 128 extra
-characters have different meanings depending on the locale.  Absent a locale,
-currently these extra characters are generally considered to be unassigned,
-and this has presented some problems.
-This is being changed starting in 5.12 so that these characters will
-be considered to be Latin-1 (ISO-8859-1).
+Some of the functionality of the debugging code can be achieved using XS
+modules.
 
-=item *
+    -Dr => use re 'debug'
+    -Dx => use O 'Debug'
 
-Mixing #define and #ifdef
+=head2 Using a source-level debugger
 
-  #define BURGLE(x) ... \
-  #ifdef BURGLE_OLD_STYLE        /* BAD */
-  ... do it the old way ... \
-  #else
-  ... do it the new way ... \
-  #endif
+If the debugging output of C<-D> doesn't help you, it's time to step
+through perl's execution with a source-level debugger.
 
-You cannot portably "stack" cpp directives.  For example in the above
-you need two separate BURGLE() #defines, one for each #ifdef branch.
+=over 3
 
 =item *
 
-Adding non-comment stuff after #endif or #else
-
-  #ifdef SNOSH
-  ...
-  #else !SNOSH    /* BAD */
-  ...
-  #endif SNOSH    /* BAD */
-
-The #endif and #else cannot portably have anything non-comment after
-them.  If you want to document what is going (which is a good idea
-especially if the branches are long), use (C) comments:
-
-  #ifdef SNOSH
-  ...
-  #else /* !SNOSH */
-  ...
-  #endif /* SNOSH */
+We'll use C<gdb> for our examples here; the principles will apply to
+any debugger (many vendors call their debugger C<dbx>), but check the
+manual of the one you're using.
 
-The gcc option C<-Wendif-labels> warns about the bad variant
-(by default on starting from Perl 5.9.4).
+=back
 
-=item *
+To fire up the debugger, type
 
-Having a comma after the last element of an enum list
+    gdb ./perl
 
-  enum color {
-    CERULEAN,
-    CHARTREUSE,
-    CINNABAR,     /* BAD */
-  };
+Or if you have a core dump:
 
-is not portable.  Leave out the last comma.
+    gdb ./perl core
 
-Also note that whether enums are implicitly morphable to ints
-varies between compilers, you might need to (int).
+You'll want to do that in your Perl source tree so the debugger can read
+the source code. You should see the copyright message, followed by the
+prompt.
 
-=item *
+    (gdb)
 
-Using //-comments
+C<help> will get you into the documentation, but here are the most
+useful commands:
 
-  // This function bamfoodles the zorklator.    /* BAD */
+=over 3
 
-That is C99 or C++.  Perl is C89.  Using the //-comments is silently
-allowed by many C compilers but cranking up the ANSI C89 strictness
-(which we like to do) causes the compilation to fail.
+=item run [args]
 
-=item *
+Run the program with the given arguments.
 
-Mixing declarations and code
+=item break function_name
 
-  void zorklator()
-  {
-    int n = 3;
-    set_zorkmids(n);    /* BAD */
-    int q = 4;
+=item break source.c:xxx
 
-That is C99 or C++.  Some C compilers allow that, but you shouldn't.
+Tells the debugger that we'll want to pause execution when we reach
+either the named function (but see L<perlguts/Internal Functions>!) or the given
+line in the named source file.
 
-The gcc option C<-Wdeclaration-after-statements> scans for such problems
-(by default on starting from Perl 5.9.4).
+=item step
 
-=item *
+Steps through the program a line at a time.
 
-Introducing variables inside for()
+=item next
 
-  for(int i = ...; ...; ...) {    /* BAD */
+Steps through the program a line at a time, without descending into
+functions.
 
-That is C99 or C++.  While it would indeed be awfully nice to have that
-also in C89, to limit the scope of the loop variable, alas, we cannot.
+=item continue
 
-=item *
+Run until the next breakpoint.
 
-Mixing signed char pointers with unsigned char pointers
+=item finish
 
-  int foo(char *s) { ... }
-  ...
-  unsigned char *t = ...; /* Or U8* t = ... */
-  foo(t);   /* BAD */
+Run until the end of the current function, then stop again.
 
-While this is legal practice, it is certainly dubious, and downright
-fatal in at least one platform: for example VMS cc considers this a
-fatal error.  One cause for people often making this mistake is that a
-"naked char" and therefore dereferencing a "naked char pointer" have
-an undefined signedness: it depends on the compiler and the flags of
-the compiler and the underlying platform whether the result is signed
-or unsigned.  For this very same reason using a 'char' as an array
-index is bad.
+=item 'enter'
 
-=item *
+Just pressing Enter will do the most recent operation again - it's a
+blessing when stepping through miles of source code.
 
-Macros that have string constants and their arguments as substrings of
-the string constants
+=item print
 
-  #define FOO(n) printf("number = %d\n", n)    /* BAD */
-  FOO(10);
+Execute the given C code and print its results. B<WARNING>: Perl makes
+heavy use of macros, and F<gdb> does not necessarily support macros
+(see later L</"gdb macro support">).  You'll have to substitute them
+yourself, or to invoke cpp on the source code files
+(see L</"The .i Targets">)
+So, for instance, you can't say
 
-Pre-ANSI semantics for that was equivalent to
+    print SvPV_nolen(sv)
 
-  printf("10umber = %d\10");
+but you have to say
 
-which is probably not what you were expecting.  Unfortunately at least
-one reasonably common and modern C compiler does "real backward
-compatibility" here, in AIX that is what still happens even though the
-rest of the AIX compiler is very happily C89.
+    print Perl_sv_2pv_nolen(sv)
 
-=item *
+=back
 
-Using printf formats for non-basic C types
+You may find it helpful to have a "macro dictionary", which you can
+produce by saying C<cpp -dM perl.c | sort>. Even then, F<cpp> won't
+recursively apply those macros for you.
 
-   IV i = ...;
-   printf("i = %d\n", i);    /* BAD */
+=head2 gdb macro support
 
-While this might by accident work in some platform (where IV happens
-to be an C<int>), in general it cannot.  IV might be something larger.
-Even worse the situation is with more specific types (defined by Perl's
-configuration step in F<config.h>):
+Recent versions of F<gdb> have fairly good macro support, but
+in order to use it you'll need to compile perl with macro definitions
+included in the debugging information.  Using F<gcc> version 3.1, this
+means configuring with C<-Doptimize=-g3>.  Other compilers might use a
+different switch (if they support debugging macros at all).
 
-   Uid_t who = ...;
-   printf("who = %d\n", who);    /* BAD */
+=head2 Dumping Perl Data Structures
 
-The problem here is that Uid_t might be not only not C<int>-wide
-but it might also be unsigned, in which case large uids would be
-printed as negative values.
+One way to get around this macro hell is to use the dumping functions in
+F<dump.c>; these work a little like an internal
+L<Devel::Peek|Devel::Peek>, but they also cover OPs and other structures
+that you can't get at from Perl. Let's take an example. We'll use the
+C<$a = $b + $c> we used before, but give it a bit of context:
+C<$b = "6XXXX"; $c = 2.3;>. Where's a good place to stop and poke around?
 
-There is no simple solution to this because of printf()'s limited
-intelligence, but for many types the right format is available as
-with either 'f' or '_f' suffix, for example:
+What about C<pp_add>, the function we examined earlier to implement the
+C<+> operator:
 
-   IVdf /* IV in decimal */
-   UVxf /* UV is hexadecimal */
+    (gdb) break Perl_pp_add
+    Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
 
-   printf("i = %"IVdf"\n", i); /* The IVdf is a string constant. */
+Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Internal Functions>.
+With the breakpoint in place, we can run our program:
 
-   Uid_t_f /* Uid_t in decimal */
+    (gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
 
-   printf("who = %"Uid_t_f"\n", who);
+Lots of junk will go past as gdb reads in the relevant source files and
+libraries, and then:
 
-Or you can try casting to a "wide enough" type:
+    Breakpoint 1, Perl_pp_add () at pp_hot.c:309
+    309         dSP; dATARGET; tryAMAGICbin(add,opASSIGN);
+    (gdb) step
+    311           dPOPTOPnnrl_ul;
+    (gdb)
 
-   printf("i = %"IVdf"\n", (IV)something_very_small_and_signed);
+We looked at this bit of code before, and we said that C<dPOPTOPnnrl_ul>
+arranges for two C<NV>s to be placed into C<left> and C<right> - let's
+slightly expand it:
 
-Also remember that the C<%p> format really does require a void pointer:
+ #define dPOPTOPnnrl_ul  NV right = POPn; \
+                         SV *leftsv = TOPs; \
+                         NV left = USE_LEFT(leftsv) ? SvNV(leftsv) : 0.0
 
-   U8* p = ...;
-   printf("p = %p\n", (void*)p);
+C<POPn> takes the SV from the top of the stack and obtains its NV either
+directly (if C<SvNOK> is set) or by calling the C<sv_2nv> function.
+C<TOPs> takes the next SV from the top of the stack - yes, C<POPn> uses
+C<TOPs> - but doesn't remove it. We then use C<SvNV> to get the NV from
+C<leftsv> in the same way as before - yes, C<POPn> uses C<SvNV>.
 
-The gcc option C<-Wformat> scans for such problems.
+Since we don't have an NV for C<$b>, we'll have to use C<sv_2nv> to
+convert it. If we step again, we'll find ourselves there:
 
-=item *
+    Perl_sv_2nv (sv=0xa0675d0) at sv.c:1669
+    1669        if (!sv)
+    (gdb)
 
-Blindly using variadic macros
+We can now use C<Perl_sv_dump> to investigate the SV:
 
-gcc has had them for a while with its own syntax, and C99 brought
-them with a standardized syntax.  Don't use the former, and use
-the latter only if the HAS_C99_VARIADIC_MACROS is defined.
+    SV = PV(0xa057cc0) at 0xa0675d0
+    REFCNT = 1
+    FLAGS = (POK,pPOK)
+    PV = 0xa06a510 "6XXXX"\0
+    CUR = 5
+    LEN = 6
+    $1 = void
 
-=item *
+We know we're going to get C<6> from this, so let's finish the
+subroutine:
 
-Blindly passing va_list
+    (gdb) finish
+    Run till exit from #0  Perl_sv_2nv (sv=0xa0675d0) at sv.c:1671
+    0x462669 in Perl_pp_add () at pp_hot.c:311
+    311           dPOPTOPnnrl_ul;
 
-Not all platforms support passing va_list to further varargs (stdarg)
-functions.  The right thing to do is to copy the va_list using the
-Perl_va_copy() if the NEED_VA_COPY is defined.
+We can also dump out this op: the current op is always stored in
+C<PL_op>, and we can dump it with C<Perl_op_dump>. This'll give us
+similar output to L<B::Debug|B::Debug>.
 
-=item *
+    {
+    13  TYPE = add  ===> 14
+        TARG = 1
+        FLAGS = (SCALAR,KIDS)
+        {
+            TYPE = null  ===> (12)
+              (was rv2sv)
+            FLAGS = (SCALAR,KIDS)
+            {
+    11          TYPE = gvsv  ===> 12
+                FLAGS = (SCALAR)
+                GV = main::b
+            }
+        }
 
-Using gcc statement expressions
+# finish this later #
 
-   val = ({...;...;...});    /* BAD */
+=head1 SOURCE CODE STATIC ANALYSIS
 
-While a nice extension, it's not portable.  The Perl code does
-admittedly use them if available to gain some extra speed
-(essentially as a funky form of inlining), but you shouldn't.
+Various tools exist for analysing C source code B<statically>, as
+opposed to B<dynamically>, that is, without executing the code.
+It is possible to detect resource leaks, undefined behaviour, type
+mismatches, portability problems, code paths that would cause illegal
+memory accesses, and other similar problems by just parsing the C code
+and looking at the resulting graph, what does it tell about the
+execution and data flows.  As a matter of fact, this is exactly
+how C compilers know to give warnings about dubious code.
 
-=item *
+=head2 lint, splint
 
-Binding together several statements in a macro
+The good old C code quality inspector, C<lint>, is available in
+several platforms, but please be aware that there are several
+different implementations of it by different vendors, which means that
+the flags are not identical across different platforms.
 
-Use the macros STMT_START and STMT_END.
+There is a lint variant called C<splint> (Secure Programming Lint)
+available from http://www.splint.org/ that should compile on any
+Unix-like platform.
 
-   STMT_START {
-      ...
-   } STMT_END
+There are C<lint> and <splint> targets in Makefile, but you may have
+to diddle with the flags (see above).
 
-=item *
+=head2 Coverity
 
-Testing for operating systems or versions when should be testing for features
+Coverity (http://www.coverity.com/) is a product similar to lint and
+as a testbed for their product they periodically check several open
+source projects, and they give out accounts to open source developers
+to the defect databases.
 
-  #ifdef __FOONIX__    /* BAD */
-  foo = quux();
-  #endif
+=head2 cpd (cut-and-paste detector)
 
-Unless you know with 100% certainty that quux() is only ever available
-for the "Foonix" operating system B<and> that is available B<and>
-correctly working for B<all> past, present, B<and> future versions of
-"Foonix", the above is very wrong.  This is more correct (though still
-not perfect, because the below is a compile-time check):
+The cpd tool detects cut-and-paste coding.  If one instance of the
+cut-and-pasted code changes, all the other spots should probably be
+changed, too.  Therefore such code should probably be turned into a
+subroutine or a macro.
 
-  #ifdef HAS_QUUX
-  foo = quux();
-  #endif
+cpd (http://pmd.sourceforge.net/cpd.html) is part of the pmd project
+(http://pmd.sourceforge.net/).  pmd was originally written for static
+analysis of Java code, but later the cpd part of it was extended to
+parse also C and C++.
 
-How does the HAS_QUUX become defined where it needs to be?  Well, if
-Foonix happens to be Unixy enough to be able to run the Configure
-script, and Configure has been taught about detecting and testing
-quux(), the HAS_QUUX will be correctly defined.  In other platforms,
-the corresponding configuration step will hopefully do the same.
+Download the pmd-bin-X.Y.zip () from the SourceForge site, extract the
+pmd-X.Y.jar from it, and then run that on source code thusly:
 
-In a pinch, if you cannot wait for Configure to be educated,
-or if you have a good hunch of where quux() might be available,
-you can temporarily try the following:
+  java -cp pmd-X.Y.jar net.sourceforge.pmd.cpd.CPD --minimum-tokens 100 --files /some/where/src --language c > cpd.txt
 
-  #if (defined(__FOONIX__) || defined(__BARNIX__))
-  # define HAS_QUUX
-  #endif
+You may run into memory limits, in which case you should use the -Xmx option:
 
-  ...
+  java -Xmx512M ...
 
-  #ifdef HAS_QUUX
-  foo = quux();
-  #endif
+=head2 gcc warnings
 
-But in any case, try to keep the features and operating systems separate.
+Though much can be written about the inconsistency and coverage
+problems of gcc warnings (like C<-Wall> not meaning "all the
+warnings", or some common portability problems not being covered by
+C<-Wall>, or C<-ansi> and C<-pedantic> both being a poorly defined
+collection of warnings, and so forth), gcc is still a useful tool in
+keeping our coding nose clean.
 
-=back
+The C<-Wall> is by default on.
 
-=head2 Problematic System Interfaces
+The C<-ansi> (and its sidekick, C<-pedantic>) would be nice to be on
+always, but unfortunately they are not safe on all platforms, they can
+for example cause fatal conflicts with the system headers (Solaris
+being a prime example).  If Configure C<-Dgccansipedantic> is used,
+the C<cflags> frontend selects C<-ansi -pedantic> for the platforms
+where they are known to be safe.
+
+Starting from Perl 5.9.4 the following extra flags are added:
 
 =over 4
 
 =item *
 
-malloc(0), realloc(0), calloc(0, 0) are non-portable.  To be portable
-allocate at least one byte.  (In general you should rarely need to
-work at this low level, but instead use the various malloc wrappers.)
+C<-Wendif-labels>
 
 =item *
 
-snprintf() - the return type is unportable.  Use my_snprintf() instead.
+C<-Wextra>
 
-=back
+=item *
 
-=head2 Security problems
+C<-Wdeclaration-after-statement>
 
-Last but not least, here are various tips for safer coding.
+=back
+
+The following flags would be nice to have but they would first need
+their own Augean stablemaster:
 
 =over 4
 
 =item *
 
-Do not use gets()
-
-Or we will publicly ridicule you.  Seriously.
+C<-Wpointer-arith>
 
 =item *
 
-Do not use strcpy() or strcat() or strncpy() or strncat()
-
-Use my_strlcpy() and my_strlcat() instead: they either use the native
-implementation, or Perl's own implementation (borrowed from the public
-domain implementation of INN).
+C<-Wshadow>
 
 =item *
 
-Do not use sprintf() or vsprintf()
-
-If you really want just plain byte strings, use my_snprintf()
-and my_vsnprintf() instead, which will try to use snprintf() and
-vsnprintf() if those safer APIs are available.  If you want something
-fancier than a plain byte string, use SVs and Perl_sv_catpvf().
+C<-Wstrict-prototypes>
 
 =back
 
-=head1 EXTERNAL TOOLS FOR DEBUGGING PERL
+The C<-Wtraditional> is another example of the annoying tendency of
+gcc to bundle a lot of warnings under one switch (it would be
+impossible to deploy in practice because it would complain a lot) but
+it does contain some warnings that would be beneficial to have available
+on their own, such as the warning about string constants inside macros
+containing the macro arguments: this behaved differently pre-ANSI
+than it does in ANSI, and some C compilers are still in transition,
+AIX being an example.
+
+=head2 Warnings of other C compilers
+
+Other C compilers (yes, there B<are> other C compilers than gcc) often
+have their "strict ANSI" or "strict ANSI with some portability extensions"
+modes on, like for example the Sun Workshop has its C<-Xa> mode on
+(though implicitly), or the DEC (these days, HP...) has its C<-std1>
+mode on.
 
-Sometimes it helps to use external tools while debugging and
-testing Perl.  This section tries to guide you through using
-some common testing and debugging tools with Perl.  This is
-meant as a guide to interfacing these tools with Perl, not
-as any kind of guide to the use of the tools themselves.
+=head1 MEMORY DEBUGGERS
 
 B<NOTE 1>: Running under memory debuggers such as Purify, valgrind, or
 Third Degree greatly slows down the execution: seconds become minutes,
@@ -2739,7 +2752,7 @@ badness.  Perl must be compiled in a specific way for
 optimal testing with Purify.  Purify is available under
 Windows NT, Solaris, HP-UX, SGI, and Siemens Unix.
 
-=head2 Purify on Unix
+=head3 Purify on Unix
 
 On Unix, Purify creates a new Perl binary.  To get the most
 benefit out of Purify, you should create the perl to Purify
@@ -2819,7 +2832,7 @@ or if you have the "env" utility:
 
     env PURIFYOPTIONS="..." ../pureperl ...
 
-=head2 Purify on NT
+=head3 Purify on NT
 
 Purify on Windows NT instruments the Perl binary 'perl.exe'
 on the fly.  There are several options in the makefile you
@@ -2919,85 +2932,7 @@ the F<*.3log> files.
 There are also leaks that for given certain definition of a leak,
 aren't.  See L</PERL_DESTRUCT_LEVEL> for more information.
 
-=head2 PERL_DESTRUCT_LEVEL
-
-If you want to run any of the tests yourself manually using e.g.
-valgrind, or the pureperl or perl.third executables, please note that
-by default perl B<does not> explicitly cleanup all the memory it has
-allocated (such as global memory arenas) but instead lets the exit()
-of the whole program "take care" of such allocations, also known as
-"global destruction of objects".
-
-There is a way to tell perl to do complete cleanup: set the
-environment variable PERL_DESTRUCT_LEVEL to a non-zero value.
-The t/TEST wrapper does set this to 2, and this is what you
-need to do too, if you don't want to see the "global leaks":
-For example, for "third-degreed" Perl:
-
-       env PERL_DESTRUCT_LEVEL=2 ./perl.third -Ilib t/foo/bar.t
-
-(Note: the mod_perl apache module uses also this environment variable
-for its own purposes and extended its semantics. Refer to the mod_perl
-documentation for more information. Also, spawned threads do the
-equivalent of setting this variable to the value 1.)
-
-If, at the end of a run you get the message I<N scalars leaked>, you can
-recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause the addresses
-of all those leaked SVs to be dumped along with details as to where each
-SV was originally allocated. This information is also displayed by
-Devel::Peek. Note that the extra details recorded with each SV increases
-memory usage, so it shouldn't be used in production environments. It also
-converts C<new_SV()> from a macro into a real function, so you can use
-your favourite debugger to discover where those pesky SVs were allocated.
-
-If you see that you're leaking memory at runtime, but neither valgrind
-nor C<-DDEBUG_LEAKING_SCALARS> will find anything, you're probably
-leaking SVs that are still reachable and will be properly cleaned up
-during destruction of the interpreter. In such cases, using the C<-Dm>
-switch can point you to the source of the leak. If the executable was
-built with C<-DDEBUG_LEAKING_SCALARS>, C<-Dm> will output SV allocations
-in addition to memory allocations. Each SV allocation has a distinct
-serial number that will be written on creation and destruction of the SV. 
-So if you're executing the leaking code in a loop, you need to look for
-SVs that are created, but never destroyed between each cycle. If such an
-SV is found, set a conditional breakpoint within C<new_SV()> and make it
-break only when C<PL_sv_serial> is equal to the serial number of the
-leaking SV. Then you will catch the interpreter in exactly the state
-where the leaking SV is allocated, which is sufficient in many cases to
-find the source of the leak.
-
-As C<-Dm> is using the PerlIO layer for output, it will by itself
-allocate quite a bunch of SVs, which are hidden to avoid recursion.
-You can bypass the PerlIO layer if you use the SV logging provided
-by C<-DPERL_MEM_LOG> instead.
-
-=head2 PERL_MEM_LOG
-
-If compiled with C<-DPERL_MEM_LOG>, both memory and SV allocations go
-through logging functions, which is handy for breakpoint setting.
-
-Unless C<-DPERL_MEM_LOG_NOIMPL> is also compiled, the logging
-functions read $ENV{PERL_MEM_LOG} to determine whether to log the
-event, and if so how:
-
-    $ENV{PERL_MEM_LOG} =~ /m/          Log all memory ops
-    $ENV{PERL_MEM_LOG} =~ /s/          Log all SV ops
-    $ENV{PERL_MEM_LOG} =~ /t/          include timestamp in Log
-    $ENV{PERL_MEM_LOG} =~ /^(\d+)/     write to FD given (default is 2)
-
-Memory logging is somewhat similar to C<-Dm> but is independent of
-C<-DDEBUGGING>, and at a higher level; all uses of Newx(), Renew(),
-and Safefree() are logged with the caller's source code file and line
-number (and C function name, if supported by the C compiler).  In
-contrast, C<-Dm> is directly at the point of C<malloc()>.  SV logging
-is similar.
-
-Since the logging doesn't use PerlIO, all SV allocations are logged
-and no extra SV allocations are introduced by enabling the logging.
-If compiled with C<-DDEBUG_LEAKING_SCALARS>, the serial number for
-each SV allocation is also logged.
-
-=head2 Profiling
+=head1 PROFILING
 
 Depending on your platform there are various ways of profiling Perl.
 
@@ -3201,11 +3136,87 @@ Unexecuted procedures.
 
 For further information, see your system's manual pages for pixie and prof.
 
-=head2 Miscellaneous tricks
+=head1 MISCELLANEOUS TRICKS
 
-=over 4
+=head2 PERL_DESTRUCT_LEVEL
 
-=item *
+If you want to run any of the tests yourself manually using e.g.
+valgrind, or the pureperl or perl.third executables, please note that
+by default perl B<does not> explicitly cleanup all the memory it has
+allocated (such as global memory arenas) but instead lets the exit()
+of the whole program "take care" of such allocations, also known as
+"global destruction of objects".
+
+There is a way to tell perl to do complete cleanup: set the
+environment variable PERL_DESTRUCT_LEVEL to a non-zero value.
+The t/TEST wrapper does set this to 2, and this is what you
+need to do too, if you don't want to see the "global leaks":
+For example, for "third-degreed" Perl:
+
+       env PERL_DESTRUCT_LEVEL=2 ./perl.third -Ilib t/foo/bar.t
+
+(Note: the mod_perl apache module uses also this environment variable
+for its own purposes and extended its semantics. Refer to the mod_perl
+documentation for more information. Also, spawned threads do the
+equivalent of setting this variable to the value 1.)
+
+If, at the end of a run you get the message I<N scalars leaked>, you can
+recompile with C<-DDEBUG_LEAKING_SCALARS>, which will cause the addresses
+of all those leaked SVs to be dumped along with details as to where each
+SV was originally allocated. This information is also displayed by
+Devel::Peek. Note that the extra details recorded with each SV increases
+memory usage, so it shouldn't be used in production environments. It also
+converts C<new_SV()> from a macro into a real function, so you can use
+your favourite debugger to discover where those pesky SVs were allocated.
+
+If you see that you're leaking memory at runtime, but neither valgrind
+nor C<-DDEBUG_LEAKING_SCALARS> will find anything, you're probably
+leaking SVs that are still reachable and will be properly cleaned up
+during destruction of the interpreter. In such cases, using the C<-Dm>
+switch can point you to the source of the leak. If the executable was
+built with C<-DDEBUG_LEAKING_SCALARS>, C<-Dm> will output SV allocations
+in addition to memory allocations. Each SV allocation has a distinct
+serial number that will be written on creation and destruction of the SV.
+So if you're executing the leaking code in a loop, you need to look for
+SVs that are created, but never destroyed between each cycle. If such an
+SV is found, set a conditional breakpoint within C<new_SV()> and make it
+break only when C<PL_sv_serial> is equal to the serial number of the
+leaking SV. Then you will catch the interpreter in exactly the state
+where the leaking SV is allocated, which is sufficient in many cases to
+find the source of the leak.
+
+As C<-Dm> is using the PerlIO layer for output, it will by itself
+allocate quite a bunch of SVs, which are hidden to avoid recursion.
+You can bypass the PerlIO layer if you use the SV logging provided
+by C<-DPERL_MEM_LOG> instead.
+
+=head2 PERL_MEM_LOG
+
+If compiled with C<-DPERL_MEM_LOG>, both memory and SV allocations go
+through logging functions, which is handy for breakpoint setting.
+
+Unless C<-DPERL_MEM_LOG_NOIMPL> is also compiled, the logging
+functions read $ENV{PERL_MEM_LOG} to determine whether to log the
+event, and if so how:
+
+    $ENV{PERL_MEM_LOG} =~ /m/          Log all memory ops
+    $ENV{PERL_MEM_LOG} =~ /s/          Log all SV ops
+    $ENV{PERL_MEM_LOG} =~ /t/          include timestamp in Log
+    $ENV{PERL_MEM_LOG} =~ /^(\d+)/     write to FD given (default is 2)
+
+Memory logging is somewhat similar to C<-Dm> but is independent of
+C<-DDEBUGGING>, and at a higher level; all uses of Newx(), Renew(),
+and Safefree() are logged with the caller's source code file and line
+number (and C function name, if supported by the C compiler).  In
+contrast, C<-Dm> is directly at the point of C<malloc()>.  SV logging
+is similar.
+
+Since the logging doesn't use PerlIO, all SV allocations are logged
+and no extra SV allocations are introduced by enabling the logging.
+If compiled with C<-DDEBUG_LEAKING_SCALARS>, the serial number for
+each SV allocation is also logged.
+
+=head2 DDD over gdb
 
 Those debugging perl with the DDD frontend over gdb may find the
 following useful:
@@ -3240,13 +3251,13 @@ Alternatively edit the init file interactively via:
 Note: you can define up to 20 conversion shortcuts in the gdb
 section.
 
-=item *
+=head2 Poison
 
 If you see in a debugger a memory area mysteriously full of 0xABABABAB
 or 0xEFEFEFEF, you may be seeing the effect of the Poison() macros,
 see L<perlclib>.
 
-=item *
+=head2 Read-only optrees
 
 Under ithreads the optree is read only. If you want to enforce this, to check
 for write accesses from buggy code, compile with C<-DPL_OP_SLAB_ALLOC> to
@@ -3284,9 +3295,6 @@ However, as an 80% solution it is still effective, as currently it catches
 a write access during the generation of F<Config.pm>, which means that we
 can't yet build F<perl> with this enabled.
 
-=back
-
-
 =head1 CONCLUSION
 
 We've had a brief look around the Perl source, how to maintain quality