Author: julianfoad
Date: Wed May 8 19:51:37 2013
New Revision: 1480426
URL: http://svn.apache.org/r1480426
Log:
Clarify doc strings.
* subversion/include/svn_io.h
(svn_io_open_uniquely_named): Clarify that the 'delete_when'
parameter doesn't only have an effect when its value is 'on close',
and that 'on pool cleanup' refers to the result pool.
(svn_io_open_unique_file3,
svn_stream_open_unique): Clarify that 'delete on pool cleanup'
refers to the result pool.
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=1480426&r1=1480425&r2=1480426&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Wed May 8 19:51:37 2013
@@ -182,9 +182,10 @@ svn_io_check_resolved_path(const char *p
* may be @c NULL. If @a file is @c NULL, the file will be created but not
* open.
*
- * If @a delete_when is #svn_io_file_del_on_close, then the @c APR_DELONCLOSE
- * flag will be used when opening the file. The @c APR_BUFFERED flag will
- * always be used.
+ * The file will be deleted according to @a delete_when. If that is
+ * #svn_io_file_del_on_pool_cleanup, it refers to @a result_pool.
+ *
+ * The @c APR_BUFFERED flag will always be used when opening the file.
*
* The first attempt will just append @a suffix. If the result is not
* a unique name, then subsequent attempts will append a dot,
@@ -248,8 +249,9 @@ svn_io_open_uniquely_named(apr_file_t **
* be possible to atomically rename the resulting file due to cross-device
* issues.)
*
- * The file will be deleted according to @a delete_when. If @a delete_when
- * is @c svn_io_file_del_on_close and @a file is @c NULL, the file will be
+ * The file will be deleted according to @a delete_when. If that is
+ * #svn_io_file_del_on_pool_cleanup, it refers to @a result_pool. If it
+ * is #svn_io_file_del_on_close and @a file is @c NULL, the file will be
* deleted before this function returns.
*
* When passing @c svn_io_file_del_none please don't forget to eventually
@@ -972,7 +974,8 @@ svn_stream_open_writable(svn_stream_t **
* be possible to atomically rename the resulting file due to cross-device
* issues.)
*
- * The file will be deleted according to @a delete_when.
+ * The file will be deleted according to @a delete_when. If that is
+ * #svn_io_file_del_on_pool_cleanup, it refers to @a result_pool.
*
* Temporary allocations will be performed in @a scratch_pool.
*
