svn commit: r1350236 - /subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h

[gs...@apache.org]

Author: gstein
Date: Thu Jun 14 13:40:59 2012
New Revision: 1350236

URL: http://svn.apache.org/viewvc?rev=1350236&view=rev
Log:
Add a little warning.

* subversion/libsvn_ra_serf/ra_serf.h:
  (svn_ra_serf__xml_state_pool): add note about the lazy pool
    creation, and avoiding this function until necessary

Modified:
    subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h

Modified: subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h?rev=1350236&r1=1350235&r2=1350236&view=diff
==============================================================================
--- subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h (original)
+++ subversion/trunk/subversion/libsvn_ra_serf/ra_serf.h Thu Jun 14 13:40:59 2012
@@ -777,7 +777,10 @@ svn_ra_serf__xml_note(svn_ra_serf__xml_e
 
 
 /* Returns XES->STATE_POOL for allocating structures that should live
-   as long as the state identified by XES.  */
+   as long as the state identified by XES.
+
+   Note: a state pool is created upon demand, so only use this function
+   when memory is required for a given state.  */
 apr_pool_t *
 svn_ra_serf__xml_state_pool(svn_ra_serf__xml_estate_t *xes);