diff options
author | Junio C Hamano <gitster@pobox.com> | 2016-02-27 00:37:27 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2016-02-27 00:37:27 +0300 |
commit | 69616f7436ed52476180f602727b387408266873 (patch) | |
tree | e3af9556382f8d709258f9d3481867de6db9145c | |
parent | d3faba840e758e6b5340b59a69e919fec77ce1c3 (diff) | |
parent | 49386868de1cebebfb1e9f9527560e17197ad94f (diff) |
Merge branch 'dt/initial-ref-xn-commit-doc'
* dt/initial-ref-xn-commit-doc:
refs: document transaction semantics
-rw-r--r-- | refs.h | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -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 * 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 * transaction and free associated resources. In particular, * 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. * 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; |