From: Rafael Garcia-Suarez <rgarciasuarez@gmail.com>
Date: Sun, 21 Jun 2009 12:27:43 +0000 (+0200)
Subject: A few docs nits after the few last commits
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=2e5b50041f3643ca27385b211da60add40857ec8;p=p5sagit%2Fp5-mst-13.2.git

A few docs nits after the few last commits
---

diff --git a/pod/perlhack.pod b/pod/perlhack.pod
index 75fa1b7..b4cfc4f 100644
--- a/pod/perlhack.pod
+++ b/pod/perlhack.pod
@@ -321,12 +321,12 @@ might start to make sense - don't worry if it doesn't yet, because the
 best way to study it is to read it in conjunction with poking at Perl
 source, and we'll do that later on.
 
-Gisle Aas's illustrated perlguts (aka: illguts) is wonderful, although
-a little out of date wrt some size details; the various SV structures
-have since been reworked for smaller memory footprint.  The
-fundamentals are right however, and the pictures are very helpful.
+Gisle Aas's illustrated perlguts (also known as I<illguts>) is wonderful,
+although a little out of date with regard to some size details; the
+various SV structures have since been reworked for smaller memory footprint.
+The fundamentals are right however, and the pictures are very helpful.
 
-http://www.perl.org/tpc/1998/Perl_Language_and_Modules/Perl%20Illustrated/ 
+L<http://www.perl.org/tpc/1998/Perl_Language_and_Modules/Perl%20Illustrated/>
 
 =item L<perlxstut> and L<perlxs>
 
@@ -2946,17 +2946,17 @@ 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
+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)
+    $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 callers source code file and line
+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.
diff --git a/util.c b/util.c
index d3fe00a..d8d2864 100644
--- a/util.c
+++ b/util.c
@@ -5475,11 +5475,11 @@ Perl_free_global_struct(pTHX_ struct perl_vars *plvarsp)
  * the default implementation, unless -DPERL_MEM_LOG_NOIMPL is also
  * given, and you supply your own implementation.
  *
- * The default implementation reads a single envar; PERL_MEM_LOG,
+ * The default implementation reads a single env var, PERL_MEM_LOG,
  * expecting one or more of the following:
  *
  *    \d+ - fd		fd to write to		: must be 1st (atoi)
- *    'm' - memlog	was PERL_MEM_LOG=1	
+ *    'm' - memlog	was PERL_MEM_LOG=1
  *    's' - svlog	was PERL_SV_LOG=1
  *    't' - timestamp	was PERL_MEM_LOG_TIMESTAMP=1
  *