diff options
author | Michael Haggerty <mhagger@alum.mit.edu> | 2017-05-22 17:17:32 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-05-23 08:29:51 +0300 |
commit | fd2ce9c01c91a093fbc8f7e444d4d80c0d89432a (patch) | |
tree | a3f5143ac6bf0406d1a1d035ecae9b66af22fe62 | |
parent | 23739aa2b3d2546c3b3ff0e06eb5171b37e31a90 (diff) |
refs.h: clarify docstring for the ref_transaction_update()-related fns
In particular, make it clear that they make copies of the sha1
arguments.
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r-- | refs.h | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -427,6 +427,19 @@ struct ref_transaction *ref_transaction_begin(struct strbuf *err); * * refname -- the name of the reference to be affected. * + * new_sha1 -- the SHA-1 that should be set to be the new value of + * the reference. Some functions allow this parameter to be + * NULL, meaning that the reference is not changed, or + * null_sha1, meaning that the reference should be deleted. A + * copy of this value is made in the transaction. + * + * old_sha1 -- the SHA-1 value that the reference must have before + * the update. Some functions allow this parameter to be NULL, + * meaning that the old value of the reference is not checked, + * or null_sha1, meaning that the reference must not exist + * before the update. A copy of this value is made in the + * transaction. + * * flags -- flags affecting the update, passed to * update_ref_lock(). Can be REF_NODEREF, which means that * symbolic references should not be followed. |