subversion-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gst...@apache.org
Subject svn commit: r1329586 - /subversion/trunk/subversion/include/svn_fs.h
Date Tue, 24 Apr 2012 08:02:48 GMT
Author: gstein
Date: Tue Apr 24 08:02:48 2012
New Revision: 1329586

URL: http://svn.apache.org/viewvc?rev=1329586&view=rev
Log:
Document some invariants after discussion with danielsh.

* subversion/include/svn_fs.h:
  (svn_fs_commit_txn): document some invariants

Modified:
    subversion/trunk/subversion/include/svn_fs.h

Modified: subversion/trunk/subversion/include/svn_fs.h
URL: http://svn.apache.org/viewvc/subversion/trunk/subversion/include/svn_fs.h?rev=1329586&r1=1329585&r2=1329586&view=diff
==============================================================================
--- subversion/trunk/subversion/include/svn_fs.h (original)
+++ subversion/trunk/subversion/include/svn_fs.h Tue Apr 24 08:02:48 2012
@@ -887,6 +887,15 @@ svn_fs_begin_txn(svn_fs_txn_t **txn_p,
  * ### 2) err=SVN_ERR_FS_CONFLICT. conflict is set. new_rev=SVN_INVALID_REVNUM
  * ### 3) err=!NULL. conflict=NULL. new_rev is valid
  * ### 4) err=!NULL. conflict=NULL. new_rev=SVN_INVALID_REVNUM
+ * ###
+ * ### some invariants:
+ * ###   *conflict_p will be non-NULL IFF SVN_ERR_FS_CONFLICT
+ * ###   if *conflict_p is set (and SVN_ERR_FS_CONFLICT), then new_rev
+ * ###     will always be SVN_INVALID_REVNUM
+ * ###   *conflict_p will always be initialized to NULL, or to a valid
+ * ###     conflict string
+ * ###   *new_rev will always be initialized to SVN_INVALID_REVNUM, or
+ * ###     to a valid, committed revision number
  */
 svn_error_t *
 svn_fs_commit_txn(const char **conflict_p,



Mime
View raw message