提交 fd2ce9c0 编写于 作者: M Michael Haggerty 提交者: Junio C Hamano

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: NMichael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: NJunio C Hamano <gitster@pobox.com>
上级 23739aa2
......@@ -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.
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册