This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Porting/corelist-perldelta.pl - Remove trailing whitespace
[perl5.git] / Porting / pumpkin.pod
index 857b74c..a8c8fb0 100644 (file)
@@ -450,14 +450,14 @@ and effort by manually running C<make regen_headers> myself rather
 than answering all the questions and complaints about the failing
 command.
 
-=head2 global.sym, and perlio.sym
+=head2 globvar.sym, and perlio.sym
 
 Make sure these files are up-to-date.  Read the comments in these
 files and in F<perl_exp.SH> to see what to do.
 
 =head2 Binary compatibility
 
-If you do change F<global.sym> think carefully about
+If you do change F<embed.fnc> think carefully about
 what you are doing.  To the extent reasonable, we'd like to maintain
 source and binary compatibility with older releases of perl.  That way,
 extensions built under one version of perl will continue to work with
@@ -485,7 +485,7 @@ that no new macros fell through the cracks.
 
 =head2 Todo
 
-The F<pod/perltodo.pod> file contains a roughly-categorized unordered
+The F<Porting/todo.pod> file contains a roughly-categorized unordered
 list of aspects of Perl that could use enhancement, features that could
 be added, areas that could be cleaned up, and so on.  During your term
 as pumpkin-holder, you will probably address some of these issues, and
@@ -520,7 +520,7 @@ It is courteous to update that if necessary.
 
 I find the F<makepatch> utility quite handy for making patches.
 You can obtain it from any CPAN archive under
-http://www.cpan.org/authors/Johan_Vromans/ .  There are a couple
+L<http://www.cpan.org/authors/Johan_Vromans/>.  There are a couple
 of differences between my version and the standard one. I have mine do
 a
 
@@ -651,42 +651,6 @@ things.
 
 =back
 
-=head1 Running Purify
-
-Purify is a commercial tool that is helpful in identifying memory
-overruns, wild pointers, memory leaks and other such badness.  Perl
-must be compiled in a specific way for optimal testing with Purify.
-
-Use the following commands to test perl with Purify:
-
-       sh Configure -des -Doptimize=-g -Uusemymalloc -Dusemultiplicity \
-           -Accflags=-DPURIFY
-       setenv PURIFYOPTIONS "-chain-length=25"
-       make all pureperl
-       cd t
-       ln -s ../pureperl perl
-       setenv PERL_DESTRUCT_LEVEL 2
-       ./perl TEST
-
-Disabling Perl's malloc allows Purify to monitor allocations and leaks
-more closely; using Perl's malloc will make Purify report most leaks
-in the "potential" leaks category.  Enabling the multiplicity option
-allows perl to clean up thoroughly when the interpreter shuts down, which
-reduces the number of bogus leak reports from Purify.  The -DPURIFY
-enables any Purify-specific debugging code in the sources.
-
-Purify outputs messages in "Viewer" windows by default.  If you don't have
-a windowing environment or if you simply want the Purify output to
-unobtrusively go to a log file instead of to the interactive window,
-use the following options instead:
-
-       setenv PURIFYOPTIONS "-chain-length=25 -windows=no -log-file=perl.log \
-           -append-logfile=yes"
-
-The only currently known leaks happen when there are compile-time errors
-within eval or require.  (Fixing these is non-trivial, unfortunately, but
-they must be fixed eventually.)
-
 =head1 Common Gotchas
 
 =over 4
@@ -814,8 +778,8 @@ conflicting needs of dynamic loading and namespace protection.
 
 For dynamic loading to work on AIX (and VMS) we need to provide a list
 of symbols to be exported.  This is done by the script F<perl_exp.SH>,
-which reads F<global.sym>.  Thus, the C<pause>
-symbol would have to be added to F<global.sym>  So far, so good.
+which reads F<embed.fnc>.  Thus, the C<pause>
+symbol would have to be added to F<embed.fnc>  So far, so good.
 
 On the other hand, one of the goals of Perl5 is to make it easy to
 either extend or embed perl and link it with other libraries.  This
@@ -823,9 +787,9 @@ means we have to be careful to keep the visible namespace "clean".
 That is, we don't want perl's global variables to conflict with
 those in the other application library.  Although this work is still
 in progress, the way it is currently done is via the F<embed.h> file.
-This file is built from the F<global.sym> file,
+This file is built from the F<embed.fnc> file,
 since those files already list the globally visible symbols.  If we
-had added C<pause> to global.sym, then F<embed.h> would contain the
+had added C<pause> to F<embed.fnc>, then F<embed.h> would contain the
 line
 
     #define pause      Perl_pause
@@ -859,20 +823,20 @@ The "fix" is to give the function a different name.  The one
 implemented in 5.003_05 isn't optimal, but here's what was done:
 
     #ifdef HAS_CHSIZE
-    # ifdef my_chsize  /* Probably #defined to Perl_my_chsize in embed.h */
-    #   undef my_chsize
+    # ifdef my_chsize      /* Probably #defined to Perl_my_chsize */
+    #   undef my_chsize    /* in embed.h */
     # endif
     # define my_chsize chsize
     #endif
 
 My explanatory comment in patch 5.003_05 said:
 
-     Undef and then re-define my_chsize from Perl_my_chsize to
-     just plain chsize if this system HAS_CHSIZE.  This probably only
-     applies to SCO.  This shows the perils of having internal
-     functions with the same name as external library functions :-).
+    Undef and then re-define my_chsize from Perl_my_chsize to
+    just plain chsize if this system HAS_CHSIZE.  This probably only
+    applies to SCO.  This shows the perils of having internal
+    functions with the same name as external library functions :-).
 
-Now, we can safely put C<my_chsize> in F<global.sym>, export it, and
+Now, we can safely put C<my_chsize> in C<embed.fnc>, export it, and
 hide it with F<embed.h>.
 
 To be consistent with what I did for C<pause>, I probably should have
@@ -942,7 +906,7 @@ then in some file (e.g. F<util.c> or F<doio.c>) do
     #endif
 
 Alternatively, we could just always use C<chsize> everywhere and move
-C<chsize> from F<global.sym> to the end of F<perl_exp.SH>.  That would
+C<chsize> from F<embed.fnc> to the end of F<perl_exp.SH>.  That would
 probably be fine as long as our C<chsize> function agreed with all the
 C<chsize> function prototypes in the various systems we'll be using.
 As long as the prototypes in actual use don't vary that much, this is
@@ -1053,16 +1017,17 @@ documented in config_h.SH).  Here's what APPLLIB_EXP is for, from
 a mail message from Larry:
 
     The main intent of APPLLIB_EXP is for folks who want to send out a
-    version of Perl embedded in their product.  They would set the symbol
-    to be the name of the library containing the files needed to run or to
-    support their particular application.  This works at the "override"
-    level to make sure they get their own versions of any library code that
-    they absolutely must have configuration control over.
+    version of Perl embedded in their product.  They would set the
+    symbol to be the name of the library containing the files needed
+    to run or to support their particular application.  This works at
+    the "override" level to make sure they get their own versions of
+    any library code that they absolutely must have configuration
+    control over.
 
     As such, I don't see any conflict with a sysadmin using it for a
-    override-ish sort of thing, when installing a generic Perl.  It should
-    probably have been named something to do with overriding though.  Since
-    it's undocumented we could still change it...  :-)
+    override-ish sort of thing, when installing a generic Perl.  It
+    should probably have been named something to do with overriding
+    though.  Since it's undocumented we could still change it...  :-)
 
 Given that it's already there, you can use it to override distribution modules.
 One way to do that is to add
@@ -1205,14 +1170,14 @@ function.
   /* Beginning of modification history */
   /* Written 02-01-02 by Nick Ing-Simmons (nick@ing-simmons.net) */
   /* End of modification history */
-  
+
   /* VOS doesn't supply a truncate function, so we build one up
      from the available POSIX functions.  */
-  
+
   #include <fcntl.h>
   #include <sys/types.h>
   #include <unistd.h>
-  
+
   int
   truncate(const char *path, off_t len)
   {
@@ -1250,7 +1215,7 @@ not "vos.c".
   # VOS does not have truncate() but we supply one in vos.c
   d_truncate="define"
   archobjs="vos.o"
-  
+
   # Help gmake find vos.c
   test -h vos.c || ln -s vos/vos.c vos.c