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

[ju...@apache.org]

Author: julianfoad
Date: Tue Jan  6 15:29:40 2015
New Revision: 1649832

URL: http://svn.apache.org/r1649832
Log:
* subversion/include/svn_io.h
  (svn_io_file_create,
   svn_io_file_create_bytes,
   svn_io_file_create_empty): Update doc strings following r1505219.

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=1649832&r1=1649831&r2=1649832&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Tue Jan  6 15:29:40 2015
@@ -682,17 +682,33 @@ svn_io_files_contents_three_same_p(svn_b
                                    const char *file3,
                                    apr_pool_t *scratch_pool);
 
-/** Create file at utf8-encoded @a file with contents @a contents.
- * @a file must not already exist.
+/** Create a file at utf8-encoded path @a file with the contents given
+ * by the null-terminated string @a contents.
+ *
+ * @a file must not already exist. If an error occurs while writing or
+ * closing the file, attempt to delete the file before returning the error.
+ *
+ * Write the data in 'binary' mode (#APR_FOPEN_BINARY). If @a contents
+ * is null, create an empty file.
+ *
  * Use @a pool for memory allocations.
+ *
+ * @since 
  */
 svn_error_t *
 svn_io_file_create(const char *file,
                    const char *contents,
                    apr_pool_t *pool);
 
-/** Create file at utf8-encoded @a file with contents @a contents
- * of @a length bytes.  @a file must not already exist.
+/** Create a file at utf8-encoded path @a file with the contents given
+ * by @a contents of @a length bytes.
+ *
+ * @a file must not already exist. If an error occurs while writing or
+ * closing the file, attempt to delete the file before returning the error.
+ *
+ * Write the data in 'binary' mode (#APR_FOPEN_BINARY). If @a length is
+ * zero, create an empty file; in this case @a contents may be null.
+ *
  * Use @a pool for memory allocations.
  *
  * @since New in 1.9.
@@ -703,7 +719,11 @@ svn_io_file_create_bytes(const char *fil
                          apr_size_t length,
                          apr_pool_t *pool);
 
-/** Create empty file at utf8-encoded @a file, which must not already exist.
+/** Create an empty file at utf8-encoded path @a file.
+ * 
+ * @a file must not already exist. If an error occurs while
+ * closing the file, attempt to delete the file before returning the error.
+ *
  * Use @a pool for memory allocations.
  *
  * @since New in 1.9.