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>


git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@391595 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 6 insertions, 0 deletions

diff --git a/include/apr_file_io.h b/include/apr_file_io.h
index 0c4a0bfdb..72c9e9bf0 100644
--- a/include/apr_file_io.h
+++ b/include/apr_file_io.h
@@ -213,6 +213,9 @@ typedef struct apr_file_t         apr_file_t;
  * @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,
@@ -618,6 +621,9 @@ APR_DECLARE(apr_status_t) apr_file_seek(apr_file_t *thefile,
  * @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,