svn commit: r1471514 - in /subversion/branches/1.8.x: ./ STATUS subversion/include/svn_io.h

[sv...@apache.org]

Author: svn-role
Date: Wed Apr 24 16:35:04 2013
New Revision: 1471514

URL: http://svn.apache.org/r1471514
Log:
Merge r1471107 from trunk:

 * r1471107
   Improve doc strings of new API svn_stream_lazyopen_create() and its
   callback.
   Justification:
     Doc fix.
   Votes:
     +1: julianfoad, rhuijben, ivan

Modified:
    subversion/branches/1.8.x/   (props changed)
    subversion/branches/1.8.x/STATUS
    subversion/branches/1.8.x/subversion/include/svn_io.h

Propchange: subversion/branches/1.8.x/
------------------------------------------------------------------------------
  Merged /subversion/trunk:r1471107

Modified: subversion/branches/1.8.x/STATUS
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/STATUS?rev=1471514&r1=1471513&r2=1471514&view=diff
==============================================================================
--- subversion/branches/1.8.x/STATUS (original)
+++ subversion/branches/1.8.x/STATUS Wed Apr 24 16:35:04 2013
@@ -118,14 +118,6 @@ Veto-blocked changes:
 Approved changes:
 =================
 
- * r1471107
-   Improve doc strings of new API svn_stream_lazyopen_create() and its
-   callback.
-   Justification:
-     Doc fix.
-   Votes:
-     +1: julianfoad, rhuijben, ivan
-
  * r1468395, r1468566
    Introduce typedef for the svn_fs_freeze() callback function type,
    and give it the requisite SWIG/Python wrapper treatment.

Modified: subversion/branches/1.8.x/subversion/include/svn_io.h
URL: http://svn.apache.org/viewvc/subversion/branches/1.8.x/subversion/include/svn_io.h?rev=1471514&r1=1471513&r2=1471514&view=diff
==============================================================================
--- subversion/branches/1.8.x/subversion/include/svn_io.h (original)
+++ subversion/branches/1.8.x/subversion/include/svn_io.h Wed Apr 24 16:35:04 2013
@@ -1370,6 +1370,15 @@ svn_string_from_stream(svn_string_t **re
 /** A function type provided for use as a callback from
  * @c svn_stream_lazyopen_create().
  *
+ * The callback function shall open a new stream and set @a *stream to
+ * the stream object, allocated in @a result_pool.  @a baton is the
+ * callback baton that was passed to svn_stream_lazyopen_create().
+ *
+ * @a result_pool is the result pool that was passed to
+ * svn_stream_lazyopen_create().  The callback function may use
+ * @a scratch_pool for temporary allocations; the caller may clear or
+ * destroy @a scratch_pool any time after the function returns.
+ *
  * @since New in 1.8.
  */
 typedef svn_error_t *
@@ -1381,13 +1390,14 @@ typedef svn_error_t *
 
 /** Return a generic stream which wraps another primary stream,
  * delaying the "opening" of that stream until the first time the
- * stream is accessed.
+ * returned stream is accessed.
  *
  * @a open_func and @a open_baton are a callback function/baton pair
- * invoked upon the first read of @a *stream which are used to open the
- * "real" source stream.
+ * which will be invoked upon the first access of the returned
+ * stream (read, write, mark, seek, skip, or possibly close).  The
+ * callback shall open the primary stream.
  *
- * @note If the only "access" the returned stream gets is to close it
+ * If the only "access" the returned stream gets is to close it
  * then @a open_func will only be called if @a open_on_close is TRUE.
  *
  * @since New in 1.8.