Author: rhuijben
Date: Thu Dec 19 10:02:26 2013
New Revision: 1552276
URL: http://svn.apache.org/r1552276
Log:
* subversion/include/svn_io.h
(svn_io_file_flush_to_disk,
svn_io_write_atomic): Add note on when *not* to use these functions.
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=1552276&r1=1552275&r2=1552276&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_io.h (original)
+++ subversion/trunk/subversion/include/svn_io.h Thu Dec 19 10:02:26 2013
@@ -780,6 +780,12 @@ svn_io_unlock_open_file(apr_file_t *lock
* Flush any unwritten data from @a file to disk. Use @a pool for
* memory allocations.
*
+ * @note This function uses advanced file control operations to flush buffers
+ * to disk that aren't always accessible and can be very expensive on systems
+ * that implement flushing on all IO layers, like Windows. Please avoid using
+ * this function in cases where the file should just work on any network
+ * filesystem. In many cases a normal svn_io_file_flush() will work just fine.
+ *
* @since New in 1.1.
*/
svn_error_t *
@@ -2156,6 +2162,11 @@ svn_io_file_write_full(apr_file_t *file,
* If @a copy_perms_path is not NULL, copy the permissions applied on @a
* @a copy_perms_path on the temporary file before renaming.
*
+ * @note This function uses advanced file control operations to flush buffers
+ * to disk that aren't always accessible and can be very expensive. Avoid
+ * using this function in cases where the file should just work on any
+ * network filesystem.
+ *
* @since New in 1.9.
*/
svn_error_t *
