cvs commit: perlfaq perlfaq7.pod

cvsuser     05/01/03 10:30:26

  Modified:    .        perlfaq7.pod
  Log:
  * How can I comment out a large block of perl code?
  	+ apparently the pod formatters (i.e. perldoc, pod2man)
  	actually don't respect the =for directive.  They do
  	understand =begin though.
  
  	+ I found that I can't rely on =cut to close the =begin,
  	either.
  
  Revision  Changes    Path
  1.19      +8 -4      perlfaq/perlfaq7.pod
  
  Index: perlfaq7.pod
  ===================================================================
  RCS file: /cvs/public/perlfaq/perlfaq7.pod,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- perlfaq7.pod	3 Nov 2004 22:54:08 -0000	1.18
  +++ perlfaq7.pod	3 Jan 2005 18:30:26 -0000	1.19
  @@ -1,6 +1,6 @@
   =head1 NAME
   
  -perlfaq7 - General Perl Language Issues ($Revision: 1.18 $, $Date: 2004/11/03 22:54:08 $)
  +perlfaq7 - General Perl Language Issues ($Revision: 1.19 $, $Date: 2005/01/03 18:30:26 $)
   
   =head1 DESCRIPTION
   
  @@ -736,18 +736,22 @@
   =head2 How can I comment out a large block of perl code?
   
   You can use embedded POD to discard it.  Enclose the blocks you want
  -to comment out in POD markers, for example C<=for nobody> and C<=cut>
  -(which marks ends of POD blocks).
  +to comment out in POD markers.  The <=begin> directive marks a section
  +for a specific formatter.  Use the C<comment> format, which no formatter
  +should claim to understand (by policy).  Mark the end of the block
  +with <=end>.
   
       # program is here
   
  -    =for nobody
  +    =begin comment
   
       all of this stuff
   
       here will be ignored
       by everyone
   
  +	=end comment
  +	
       =cut
   
       # program continues