Proposed doc string for review. Don't fully understand relationship
between the "db" and "wri" params. Gstein/neels/me just started talking
about this on IRC but I've got to go now. Please adjust as necessary and
commit.
[[[
* subversion/libsvn_wc/wc_db.h
(svn_wc__db_pristine_read): Add a doc string.
Index: subversion/libsvn_wc/wc_db.h
===================================================================
--- subversion/libsvn_wc/wc_db.h (revision 909475)
+++ subversion/libsvn_wc/wc_db.h (working copy)
@@ -784,7 +784,13 @@
} svn_wc__db_checkmode_t;
-/* ### @a contents may NOT be NULL. */
+/* Set *CONTENTS to a new stream, from which the caller can read the pristine
+ * text that matches CHECKSUM. Find the text in the database DB.
+ * ### ? Limit the search to texts associated with the WC rooted at
WRI_ABSPATH.
+ *
+ * Allocate the new stream in RESULT_POOL, and arrange for the stream to be
+ * closed on pool destruction if the caller has not already closed it by then.
+ * */
svn_error_t *
svn_wc__db_pristine_read(svn_stream_t **contents,
svn_wc__db_t *db,
]]]
- Julian
