This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
mod_perl is special, and assigns meaning to a perl_destruct_level of
[perl5.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 0b72af6..ffbbf69 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -671,14 +671,14 @@ present, at run time.  Of course, you can still search other @INC
 directories ahead of those in APPLLIB_EXP by using any of the standard
 run-time methods: $PERLLIB, $PERL5LIB, -I, use lib, etc.
 
-=item USE_SITECUSTOMIZE
+=item usesitecustomize
 
 Run-time customization of @INC can be enabled with:
 
        sh Configure -Dusesitecustomize
 
-Which will define USE_SITECUSTOMIZE and $Config{usesitecustomize}.
-When enabled, make perl run F<$sitelibexp/sitecustomize.pl> before
+which will define USE_SITECUSTOMIZE and $Config{usesitecustomize}.
+When enabled, this makes perl run F<$sitelibexp/sitecustomize.pl> before
 anything else.  This script can then be set up to add additional
 entries to @INC.
 
@@ -1048,6 +1048,12 @@ To build without perl's malloc, you can use the Configure command
 
 or you can answer 'n' at the appropriate interactive Configure prompt.
 
+Note that Perl's malloc isn't always used by default; that actually
+depends on your system. For example, on Linux and FreeBSD (and many more
+systems), Configure chooses to use the system's malloc by default.
+See the appropriate file in the F<hints/> directory to see how the
+default is set.
+
 =item -DPERL_POLLUTE_MALLOC
 
 NOTE: This flag is enabled automatically on some platforms if you just
@@ -1142,7 +1148,7 @@ file, which also explains hint files known as callback-units.
 Note that any hint file is read before any Policy file, meaning that
 Policy overrides hints -- see L</Site-wide Policy settings>.
 
-=item *** WHOA THERE!!! ***
+=item WHOA THERE!!!
 
 If you are re-using an old config.sh, it's possible that Configure detects
 different values from the ones specified in this file.  You will almost
@@ -1314,7 +1320,7 @@ This will attempt to make perl in the current directory.
 
 =head2 Expected errors
 
-These errors are normal, and can be ignored:
+These error reports are normal, and can be ignored:
 
   ...
   make: [extra.pods] Error 1 (ignored)
@@ -1445,7 +1451,7 @@ If you can't, you can either link with the updated resolver library provided
 with BIND 8.1 or rename /usr/local/bin/arpa/inet.h during the Perl build and
 test process to avoid the problem.
 
-=item *_r() prototype NOT found
+=item .*_r() prototype NOT found
 
 On a related note, if you see a bunch of complaints like the above about
 reentrant functions - specifically networking-related ones - being present
@@ -1802,24 +1808,17 @@ If make test bombs out, just cd to the t directory and run ./TEST
 by hand to see if it makes any difference.  If individual tests
 bomb, you can run them by hand, e.g.,
 
-       ./perl op/groups.t
+       cd t ; ./perl -MTestInit op/groups.t
 
 Another way to get more detailed information about failed tests and
 individual subtests is to cd to the t directory and run
 
-       ./perl harness
+       cd t ; ./perl harness <list of tests>
 
 (this assumes that most basic tests succeed, since harness uses
-complicated constructs).  For extension and library tests you
-need a little bit more: you need to setup your environment variable
-PERL_CORE to a true value (like "1"), and you need to supply the
-right Perl library path:
-
-       setenv PERL_CORE 1
-       ./perl -I../lib ../ext/Socket/Socket.t
-       ./perl -I../lib ../lib/less.t
+complicated constructs). If no list of tests is provided, harness
+will run all tests.
 
-(For csh-like shells on UNIX; adjust appropriately for other platforms.)
 You should also read the individual tests to see if there are any helpful
 comments that apply to your system.  You may also need to setup your
 shared library path if you get errors like:
@@ -1834,7 +1833,7 @@ See L</"Building a shared Perl library"> earlier in this document.
 
 Note:  One possible reason for errors is that some external programs
 may be broken due to the combination of your environment and the way
-B<make test> exercises them.  For example, this may happen if you have
+'make test' exercises them.  For example, this may happen if you have
 one or more of these environment variables set:  LC_ALL LC_CTYPE
 LC_COLLATE LANG.  In some versions of UNIX, the non-English locales
 are known to cause programs to exhibit mysterious errors.
@@ -1863,9 +1862,14 @@ If your system is quite busy and doesn't respond quickly enough,
 these tests might fail.  If possible, try running the tests again
 with the system under a lighter load.  These timing-sensitive
 and load-sensitive tests include F<t/op/alarm.t>,
-F<ext/Time/HiRes/HiRes.t>, F<lib/Benchmark.t>,
+F<ext/Time/HiRes/t/HiRes.t>, F<ext/threads/shared/t/waithires.t>,
+F<ext/threads/shared/t/stress.t>, F<lib/Benchmark.t>,
 F<lib/Memoize/t/expmod_t.t>, and F<lib/Memoize/t/speed.t>.
 
+You might also experience some failures in F<t/op/stat.t> if you build
+perl on an NFS filesystem, if the remote clock and the system clock are
+different.
+
 =item Out of memory
 
 On some systems, particularly those with smaller amounts of RAM, some
@@ -1875,7 +1879,7 @@ test 85 will fail if run under either t/TEST or t/harness.
 
 Try stopping other jobs on the system and then running the test by itself:
 
-       cd t; ./perl op/pat.t
+       cd t; ./perl -MTestInit op/pat.t
 
 to see if you have any better luck.  If your perl still fails this
 test, it does not necessarily mean you have a broken perl.  This test
@@ -1996,25 +2000,44 @@ make install will install the following:
 
     scripts
 
-       cppstdin        This is used by perl -P, if your cc -E can't
-                       read from stdin.
+       cppstdin        This is used by the deprecated switch perl -P, if
+                       your cc -E can't read from stdin.
        c2ph, pstruct   Scripts for handling C structures in header files.
-       s2p             sed-to-perl translator
+       config_data     Manage Module::Build-like module configuration
+       corelist        Shows versions of modules that come with different
+                       versions of perl
+       cpan            The CPAN shell
+       cpan2dist       The CPANPLUS distribution creator
+       cpanp           The CPANPLUS shell
+       cpanp-run-perl  An helper for cpanp
+       dprofpp         Perl code profiler post-processor
+       enc2xs          Encoding module generator
        find2perl       find-to-perl translator
        h2ph            Extract constants and simple macros from C headers
        h2xs            Converts C .h header files to Perl extensions.
+       instmodsh       A shell to examine installed modules.
+       libnetcfg       Configure libnet.
        perlbug         Tool to report bugs in Perl.
        perldoc         Tool to read perl's pod documentation.
+       perlivp         Perl Installation Verification Procedure
+       piconv          A Perl implementation of the encoding conversion
+                       utility iconv
        pl2pm           Convert Perl 4 .pl files to Perl 5 .pm modules
        pod2html,       Converters from perl's pod documentation format
        pod2latex,      to other useful formats.
        pod2man,
        pod2text,
-       pod2checker,
-       pod2select,
        pod2usage
+       podchecker      POD syntax checker
+       podselect       Prints sections of POD documentation
+       prove           A command-line tool for running tests
+       psed            A Perl implementation of sed
+       ptar            A Perl implementation of tar
+       ptardiff        A diff for tar archives
+       s2p             sed-to-perl translator
+       shasum          A tool to print or check SHA checksums
        splain          Describe Perl warnings and errors
-       dprofpp         Perl code profile post-processor
+       xsubpp          Compiler to convert Perl XS code into C code
 
     library files
 
@@ -2028,7 +2051,7 @@ make install will install the following:
        pages           in $man3dir, usually /usr/local/man/man3.
        pod/*.pod       in $privlib/pod/.
 
-Installperl will also create the directories listed above
+installperl will also create the directories listed above
 in L<"Installation Directories">.
 
 Perl's *.h header files and the libperl library are also installed
@@ -2036,9 +2059,11 @@ under $archlib so that any user may later build new modules, run the
 optional Perl compiler, or embed the perl interpreter into another
 program even if the Perl source is no longer available.
 
+=head2 Installing only version-specific parts
+
 Sometimes you only want to install the version-specific parts of the perl
 installation.  For example, you may wish to install a newer version of
-perl alongside an already installed production version of perl without
+perl alongside an already installed production version without
 disabling installation of new modules for the production version.
 To only install the version-specific parts of the perl installation, run
 
@@ -2050,6 +2075,7 @@ you can just manually run
        ./perl installperl -v
 
 and skip installman altogether.
+
 See also L<"Maintaining completely separate versions"> for another
 approach.
 
@@ -2107,81 +2133,64 @@ Perl 5.10 is not binary compatible with earlier versions of Perl.
 In other words, you will have to recompile your XS modules.
 
 In general, you can usually safely upgrade from one version of Perl (e.g.
-5.8.0) to another similar version (e.g. 5.8.2) without re-compiling
-all of your add-on extensions.  You can also safely leave the old version
-around in case the new version causes you problems for some reason.
-For example, if you want to be sure that your script continues to run
-with 5.8.2, simply replace the '#!/usr/local/bin/perl' line at the
-top of the script with the particular version you want to run, e.g.
-#!/usr/local/bin/perl5.8.2.
+5.X.Y) to another similar minor version (e.g. 5.X.(Y+1))) without
+re-compiling all of your extensions.  You can also safely leave the old
+version around in case the new version causes you problems for some reason.
 
 Usually, most extensions will probably not need to be recompiled to be
 used with a newer version of Perl.  Here is how it is supposed to work.
 (These examples assume you accept all the Configure defaults.)
 
-Suppose you already have version 5.005_03 installed.  The directories
-searched by 5.005_03 are
+Suppose you already have version 5.8.7 installed.  The directories
+searched by 5.8.7 are typically like:
 
-       /usr/local/lib/perl5/5.00503/$archname
-       /usr/local/lib/perl5/5.00503
-       /usr/local/lib/perl5/site_perl/5.005/$archname
-       /usr/local/lib/perl5/site_perl/5.005
+       /usr/local/lib/perl5/5.8.7/$archname
+       /usr/local/lib/perl5/5.8.7
+       /usr/local/lib/perl5/site_perl/5.8.7/$archname
+       /usr/local/lib/perl5/site_perl/5.8.7
 
-Beginning with 5.6.0 the version number in the site libraries are
-fully versioned.  Now, suppose you install version 5.6.0.  The directories
-searched by version 5.6.0 will be
+Now, suppose you install version 5.8.8.  The directories
+searched by version 5.8.8 will be:
 
-       /usr/local/lib/perl5/5.6.0/$archname
-       /usr/local/lib/perl5/5.6.0
-       /usr/local/lib/perl5/site_perl/5.6.0/$archname
-       /usr/local/lib/perl5/site_perl/5.6.0
+       /usr/local/lib/perl5/5.8.8/$archname
+       /usr/local/lib/perl5/5.8.8
+       /usr/local/lib/perl5/site_perl/5.8.8/$archname
+       /usr/local/lib/perl5/site_perl/5.8.8
 
-       /usr/local/lib/perl5/site_perl/5.005/$archname
-       /usr/local/lib/perl5/site_perl/5.005
+       /usr/local/lib/perl5/site_perl/5.8.7/$archname
+       /usr/local/lib/perl5/site_perl/5.8.7
        /usr/local/lib/perl5/site_perl/
 
 Notice the last three entries -- Perl understands the default structure
 of the $sitelib directories and will look back in older, compatible
-directories.  This way, modules installed under 5.005_03 will continue
-to be usable by 5.005_03 but will also accessible to 5.6.0.  Further,
+directories.  This way, modules installed under 5.8.7 will continue
+to be usable by 5.8.7 but will also accessible to 5.8.8.  Further,
 suppose that you upgrade a module to one which requires features
-present only in 5.6.0.  That new module will get installed into
-/usr/local/lib/perl5/site_perl/5.6.0 and will be available to 5.6.0,
-but will not interfere with the 5.005_03 version.
+present only in 5.8.8.  That new module will get installed into
+/usr/local/lib/perl5/site_perl/5.8.8 and will be available to 5.8.8,
+but will not interfere with the 5.8.7 version.
 
 The last entry, /usr/local/lib/perl5/site_perl/, is there so that
 5.6.0 and above will look for 5.004-era pure perl modules.
 
-Lastly, suppose you now install 5.8.0, which is not binary compatible
-with 5.6.0.  The directories searched by 5.8.0 (if you don't change the
+Lastly, suppose you now install 5.10.0, which is not binary compatible
+with 5.8.x.  The directories searched by 5.10.0 (if you don't change the
 Configure defaults) will be:
 
-       /usr/local/lib/perl5/5.8.0/$archname
-       /usr/local/lib/perl5/5.8.0
-       /usr/local/lib/perl5/site_perl/5.8.0/$archname
-       /usr/local/lib/perl5/site_perl/5.8.0
+       /usr/local/lib/perl5/5.10.0/$archname
+       /usr/local/lib/perl5/5.10.0
+       /usr/local/lib/perl5/site_perl/5.10.0/$archname
+       /usr/local/lib/perl5/site_perl/5.10.0
 
-       /usr/local/lib/perl5/site_perl/5.6.0
+       /usr/local/lib/perl5/site_perl/5.8.8
 
-       /usr/local/lib/perl5/site_perl/5.005
+       /usr/local/lib/perl5/site_perl/5.8.7
 
        /usr/local/lib/perl5/site_perl/
 
 Note that the earlier $archname entries are now gone, but pure perl
 modules from earlier versions will still be found.
 
-Assuming the users in your site are still actively using perl 5.6.0 and
-5.005 after you installed 5.8.0, you can continue to install add-on
-extensions using any of perl 5.8.0, 5.6.0, or 5.005.  The installations
-of these different versions remain distinct, but remember that the
-newer versions of perl are automatically set up to search the
-compatible site libraries of the older ones.  This means that
-installing a new XS extension with 5.005 will make it visible to both
-5.005 and 5.6.0, but not to 5.8.0.  Installing a pure perl module with
-5.005 will make it visible to all three versions.  Later, if you
-install the same extension using, say, perl 5.8.0, it will override the
-5.005-installed version, but only for perl 5.8.0.
-
 This way, you can choose to share compatible extensions, but also upgrade
 to a newer version of an extension that may be incompatible with earlier
 versions, without breaking the earlier versions' installations.
@@ -2194,14 +2203,14 @@ won't interfere with another version.  (The defaults guarantee this for
 libraries after 5.6.0, but not for executables. TODO?)  One convenient
 way to do this is by using a separate prefix for each version, such as
 
-       sh Configure -Dprefix=/opt/perl5.8.2
+       sh Configure -Dprefix=/opt/perl5.10.0
 
-and adding /opt/perl5.8.2/bin to the shell PATH variable.  Such users
+and adding /opt/perl5.10.0/bin to the shell PATH variable.  Such users
 may also wish to add a symbolic link /usr/local/bin/perl so that
 scripts can still start with #!/usr/local/bin/perl.
 
 Others might share a common directory for maintenance sub-versions
-(e.g. 5.8 for all 5.8.x versions), but change directory with
+(e.g. 5.10 for all 5.10.x versions), but change directory with
 each major version.
 
 If you are installing a development subversion, you probably ought to
@@ -2292,36 +2301,13 @@ your old config.sh and Policy.sh files.
 
 If you are upgrading from a previous version of perl, or if you
 change systems or compilers or make other significant changes, or if
-you are experiencing difficulties building perl, you should probably
-not re-use your old config.sh.  Simply remove it:
-
-       rm -f config.sh
-
-If you wish to re-use your old config.sh, be especially attentive to the
-version and architecture-specific questions and answers.  For example,
-the default directory for architecture-dependent library modules
-includes the version name.  By default, Configure will reuse your old
-name (e.g. /opt/perl/lib/i86pc-solaris/5.003) even if you're running
-Configure for a different version, e.g. 5.004.  Similarly, if you used
-a shared libperl.so (see below) with version numbers, you will probably
-want to adjust them as well.
-
-Also, be careful to check your architecture name.  For example, some
-Linux distributions use i386, but Configure uses the output of the arch
-command, which might be i686 instead.  If you pick up a precompiled
-binary, or compile extensions on different systems, they might not all
-agree on the architecture name.
-
-In short, if you wish to use your old config.sh, I recommend running
-Configure interactively rather than blindly accepting the defaults.
+you are experiencing difficulties building perl, you should not re-use
+your old config.sh.
 
 If your reason to reuse your old config.sh is to save your particular
 installation choices, then you can probably achieve the same effect by
 using the Policy.sh file.  See the section on L<"Site-wide Policy
-settings"> above.  If you wish to start with a fresh distribution, you
-also need to remove any old Policy.sh files you may have with
-
-       rm -f Policy.sh
+settings"> above.
 
 =head1 Minimizing the Perl installation
 
@@ -2472,21 +2458,6 @@ build process.  Type B<man perl> to get started.  Alternatively, you
 can type B<perldoc perl> to use the supplied perldoc script.  This is
 sometimes useful for finding things in the library modules.
 
-Under UNIX, you can produce a documentation book in postscript form,
-along with its table of contents, by going to the pod/ subdirectory and
-running (either):
-
-       ./roffitall -groff              # If you have GNU groff installed
-       ./roffitall -psroff             # If you have psroff
-
-This will leave you with two postscript files ready to be printed.
-(You may need to fix the roffitall command to use your local troff
-set-up.)
-
-Note that you must have performed the installation already before running
-the above, since the script collects the installed files to generate
-the documentation.
-
 =head1 AUTHOR
 
 Original author:  Andy Dougherty doughera@lafayette.edu , borrowing very