svn commit: r1461716 - /subversion/trunk/subversion/include/svn_io.h

[ph...@apache.org]

Author: philip
Date: Wed Mar 27 17:15:26 2013
New Revision: 1461716

URL: http://svn.apache.org/r1461716
Log:
* subversion/include/svn_io.h
  (svn_io_start_cmd3): Tweak documentation.

Modified:
    subversion/trunk/subversion/include/svn_io.h

Modified: subversion/trunk/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_io.h?rev=1461716&r1=1461715&r2=1461716&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Wed Mar 27 17:15:26 2013
@@ -1658,17 +1658,20 @@ svn_io_dir_walk(const char *dirname,
  *
  * If @a inherit is TRUE, the invoked program inherits its environment from
  * the caller and @a cmd, if not absolute, is searched for in PATH.
- * Otherwise, the invoked program runs with an empty environment and @a cmd
- * must be an absolute path.
  *
- * If @a inherit is FALSE and @a env is not NULL, the invoked program
- * inherits the environment defined by @a env, instead of an empty
- * environment or the caller's environment.
+ * If @a inherit is FALSE @a cmd must be an absolute path and the invoked
+ * program inherits the environment defined by @a env or runs with an empty
+ * environment in @a env is NULL.
  *
  * @note On some platforms, failure to execute @a cmd in the child process
  * will result in error output being written to @a errfile, if non-NULL, and
  * a non-zero exit status being returned to the parent process.
  *
+ * @note An APR bug affects Windows: passing a NULL @a env does not
+ * guarantee the invoked program to run with an empty environment when 
+ * @a inherits is FALSE, the program may inherit its parent's environment.
+ * Explicitly pass an empty @env to get an empty environment.
+ *
  * @since New in 1.8.
  */
 svn_error_t *svn_io_start_cmd3(apr_proc_t *cmd_proc,