svn commit: r414266 - /apr/apr/branches/1.2.x/include/apr_file_io.h

[jo...@apache.org]

Author: jorton
Date: Wed Jun 14 07:14:27 2006
New Revision: 414266

URL: http://svn.apache.org/viewvc?rev=414266&view=rev
Log:
Merge r391595 from trunk:

Docstring fix.

* include/apr_file_io.h (apr_file_open, apr_file_pipe_create): Clarify
the default inheritance rules.

Submitted by: Peter N. Lundblad <peter famlundblad.se>

Modified:
    apr/apr/branches/1.2.x/include/apr_file_io.h

Modified: apr/apr/branches/1.2.x/include/apr_file_io.h
URL: http://svn.apache.org/viewvc/apr/apr/branches/1.2.x/include/apr_file_io.h?rev=414266&r1=414265&r2=414266&view=diff
==============================================================================
--- apr/apr/branches/1.2.x/include/apr_file_io.h (original)
+++ apr/apr/branches/1.2.x/include/apr_file_io.h Wed Jun 14 07:14:27 2006
@@ -213,6 +213,9 @@
  * @param pool The pool to use.
  * @remark If perm is APR_OS_DEFAULT and the file is being created,
  * appropriate default permissions will be used.
+ * @remark By default, the returned file descriptor will not be
+ * inherited by child processes created by apr_proc_create().  This
+ * can be changed using apr_file_inherit_set().
  */
 APR_DECLARE(apr_status_t) apr_file_open(apr_file_t **newf, const char *fname,
                                         apr_int32_t flag, apr_fileperms_t perm,
@@ -552,6 +555,9 @@
  * @param in The file descriptor to use as input to the pipe.
  * @param out The file descriptor to use as output from the pipe.
  * @param pool The pool to operate on.
+ * @remark By default, the returned file descriptors will be inherited
+ * by child processes created using apr_proc_create().  This can be
+ * changed using apr_file_inherit_unset().
  */
 APR_DECLARE(apr_status_t) apr_file_pipe_create(apr_file_t **in, 
                                                apr_file_t **out,