Author: philip
Date: Wed Apr 4 10:12:55 2012
New Revision: 1309320
URL: http://svn.apache.org/viewvc?rev=1309320&view=rev
Log:
* subversion/include/svn_string.h
(svn_stringbuf_create_ensure, svn_stringbuf_ensure): Tweak doc string.
Modified:
subversion/trunk/subversion/include/svn_string.h
Modified: subversion/trunk/subversion/include/svn_string.h
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_string.h?rev=1309320&r1=1309319&r2=1309320&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_string.h (original)
+++ subversion/trunk/subversion/include/svn_string.h Wed Apr 4 10:12:55 2012
@@ -209,8 +209,8 @@ svn_stringbuf_create_empty(apr_pool_t *p
/** Create a new empty bytestring with at least @a minimum_size bytes of
* space available in the memory block.
*
- * The allocated string buffer will be one byte larger than @a minimum_size
- * to account for a final '\\0'.
+ * The allocated string buffer will be at least one byte larger than
+ * @a minimum_size to account for a final '\\0'.
*
* @since New in 1.6.
*/
@@ -235,12 +235,16 @@ svn_stringbuf_t *
svn_stringbuf_createv(apr_pool_t *pool, const char *fmt, va_list ap)
__attribute__((format(printf, 2, 0)));
-/** Make sure that the string @a str has allocated at least enough space
- * to hold a string of length @a minimum_size bytes (as well as the
- * terminating null character).
+/** Make sure that the stringbuf @a str has at least @a minimum_size
+ * bytes of space available in the memory block.
*
- * @note: Before Subversion 1.8, the caller was supposed to include one
- * byte for the null terminator in the value of @a minimum_size.
+ * The allocated string buffer will be at least one byte larger than
+ * @a minimum_size to account for a final '\\0'.
+ *
+ * @note: Before Subversion 1.8 this function did not ensure space for
+ * one byte more than @a minimum_size. If compatibility with pre-1.8
+ * behaviour is required callers must assume space for only
+ * @a minimum_size-1 data bytes plus a final '\\0'.
*/
void
svn_stringbuf_ensure(svn_stringbuf_t *str, apr_size_t minimum_size);
