Re: Documentation change for IPC::Open*.pm

Message-ID: <acc274b3050822083093357fe@mail.gmail.com>

p4raw-id: //depot/perl@25320

2 files changed, 25 insertions, 23 deletions

diff --git a/lib/IPC/Open2.pm b/lib/IPC/Open2.pm
index a5a3561794..ecd1e7f9de 100644
--- a/lib/IPC/Open2.pm
+++ b/lib/IPC/Open2.pm
@@ -6,7 +6,7 @@ our ($VERSION, @ISA, @EXPORT);
 require 5.000;
 require Exporter;
 
-$VERSION	= 1.01;
+$VERSION	= 1.02;
 @ISA		= qw(Exporter);
 @EXPORT		= qw(open2);
 
@@ -18,31 +18,31 @@ IPC::Open2, open2 - open a process for both reading and writing
 
     use IPC::Open2;
 
-    $pid = open2(\*RDRFH, \*WTRFH, 'some cmd and args');
+    $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'some cmd and args');
       # or without using the shell
-    $pid = open2(\*RDRFH, \*WTRFH, 'some', 'cmd', 'and', 'args');
+    $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'some', 'cmd', 'and', 'args');
 
     # or with handle autovivification
-    my($rdrfh, $wtrfh);
-    $pid = open2($rdrfh, $wtrfh, 'some cmd and args');
+    my($chld_out, $chld_in);
+    $pid = open2($chld_out, $chld_in, 'some cmd and args');
       # or without using the shell
-    $pid = open2($rdrfh, $wtrfh, 'some', 'cmd', 'and', 'args');
+    $pid = open2($chld_out, $chld_in, 'some', 'cmd', 'and', 'args');
 
 =head1 DESCRIPTION
 
-The open2() function runs the given $cmd and connects $rdrfh for
-reading and $wtrfh for writing.  It's what you think should work 
+The open2() function runs the given $cmd and connects $chld_out for
+reading and $chld_in for writing.  It's what you think should work 
 when you try
 
     $pid = open(HANDLE, "|cmd args|");
 
 The write filehandle will have autoflush turned on.
 
-If $rdrfh is a string (that is, a bareword filehandle rather than a glob
+If $chld_out is a string (that is, a bareword filehandle rather than a glob
 or a reference) and it begins with C<< >& >>, then the child will send output
-directly to that file handle.  If $wtrfh is a string that begins with
-C<< <& >>, then $wtrfh will be closed in the parent, and the child will read
-from it directly.  In both cases, there will be a dup(2) instead of a
+directly to that file handle.  If $chld_in is a string that begins with
+C<< <& >>, then $chld_in will be closed in the parent, and the child will
+read from it directly.  In both cases, there will be a dup(2) instead of a
 pipe(2) made.
 
 If either reader or writer is the null string, this will be replaced
diff --git a/lib/IPC/Open3.pm b/lib/IPC/Open3.pm
index da925182e7..084cd33c7e 100644
--- a/lib/IPC/Open3.pm
+++ b/lib/IPC/Open3.pm
@@ -9,7 +9,7 @@ require Exporter;
 use Carp;
 use Symbol qw(gensym qualify);
 
-$VERSION	= 1.0106;
+$VERSION	= 1.02;
 @ISA		= qw(Exporter);
 @EXPORT		= qw(open3);
 
@@ -19,7 +19,7 @@ IPC::Open3, open3 - open a process for reading, writing, and error handling
 
 =head1 SYNOPSIS
 
-    $pid = open3(\*WTRFH, \*RDRFH, \*ERRFH,
+    $pid = open3(\*CHLD_IN, \*CHLD_OUT, \*CHLD_ERR,
 		    'some cmd and args', 'optarg', ...);
 
     my($wtr, $rdr, $err);
@@ -29,15 +29,17 @@ IPC::Open3, open3 - open a process for reading, writing, and error handling
 =head1 DESCRIPTION
 
 Extremely similar to open2(), open3() spawns the given $cmd and
-connects RDRFH for reading, WTRFH for writing, and ERRFH for errors.  If
-ERRFH is false, or the same file descriptor as RDRFH, then STDOUT and 
-STDERR of the child are on the same filehandle.  The WTRFH will have
-autoflush turned on.
-
-If WTRFH begins with C<< <& >>, then WTRFH will be closed in the parent, and
-the child will read from it directly.  If RDRFH or ERRFH begins with
-C<< >& >>, then the child will send output directly to that filehandle.
-In both cases, there will be a dup(2) instead of a pipe(2) made.
+connects CHLD_OUT for reading from the child, CHLD_IN for writing to
+the child, and CHLD_ERR for errors.  If CHLD_ERR is false, or the
+same file descriptor as CHLD_OUT, then STDOUT and STDERR of the child
+are on the same filehandle.  The CHLD_IN will have autoflush turned
+on.
+
+If CHLD_IN begins with C<< <& >>, then CHLD_IN will be closed in the
+parent, and the child will read from it directly.  If CHLD_OUT or
+CHLD_ERR begins with C<< >& >>, then the child will send output
+directly to that filehandle.  In both cases, there will be a dup(2)
+instead of a pipe(2) made.
 
 If either reader or writer is the null string, this will be replaced
 by an autogenerated filehandle.  If so, you must pass a valid lvalue