undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'dt/initial-ref-xn-commit-doc' into maint

Browse Source 
* dt/initial-ref-xn-commit-doc:
  refs: document transaction semantics
This commit is contained in:
Junio C Hamano 2016-03-10 11:13:49 -08:00
commit 3e6e43e130
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
refs.h
View File

@ -109,6 +109,11 @@ extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
* If this succeeds, the ref updates will have taken place and * If this succeeds, the ref updates will have taken place and
* the transaction cannot be rolled back. * the transaction cannot be rolled back.
* *
* - Instead of `ref_transaction_commit`, use
* `initial_ref_transaction_commit()` if the ref database is known
* to be empty (e.g. during clone). This is likely to be much
* faster.
*
* - At any time call `ref_transaction_free()` to discard the * - At any time call `ref_transaction_free()` to discard the
* transaction and free associated resources. In particular, * transaction and free associated resources. In particular,
* this rolls back the transaction if it has not been * this rolls back the transaction if it has not been
@ -124,6 +129,13 @@ extern int dwim_log(const char *str, int len, unsigned char *sha1, char **ref);
* *
* The message is appended to err without first clearing err. * The message is appended to err without first clearing err.
* err will not be '\n' terminated. * err will not be '\n' terminated.
*
* Caveats
* -------
*
* Note that no locks are taken, and no refs are read, until
* `ref_transaction_commit` is called. So `ref_transaction_verify`
* won't report a verification failure until the commit is attempted.
*/ */
struct ref_transaction; struct ref_transaction;