summaryrefslogtreecommitdiff
path: root/refs.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-09-28 14:47:56 +0900
committerJunio C Hamano <gitster@pobox.com>2017-09-28 14:47:56 +0900
commit73ecdc606eedbfd98ec66d50d44b3374425fd13b (patch)
tree6a2aeb6eb0b30e1645c8af06b10c9f4ec2815dd8 /refs.h
parent2812ca7f0e11f6a46c8b1b5b4450df20412c22be (diff)
parent744c040b19412fa5075810eb1aced105fad96726 (diff)
downloadgit-73ecdc606eedbfd98ec66d50d44b3374425fd13b.tar.gz
Merge branch 'rs/resolve-ref-optional-result'
Code clean-up. * rs/resolve-ref-optional-result: refs: pass NULL to resolve_ref_unsafe() if hash is not needed refs: pass NULL to refs_resolve_ref_unsafe() if hash is not needed refs: make sha1 output parameter of refs_resolve_ref_unsafe() optional
Diffstat (limited to 'refs.h')
-rw-r--r--refs.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/refs.h b/refs.h
index ae33a5f74d..e1c5803f9a 100644
--- a/refs.h
+++ b/refs.h
@@ -10,10 +10,11 @@ struct worktree;
/*
* Resolve a reference, recursively following symbolic refererences.
*
- * Store the referred-to object's name in sha1 and return the name of
- * the non-symbolic reference that ultimately pointed at it. The
- * return value, if not NULL, is a pointer into either a static buffer
- * or the input ref.
+ * Return the name of the non-symbolic reference that ultimately pointed
+ * at the resolved object name. The return value, if not NULL, is a
+ * pointer into either a static buffer or the input ref.
+ *
+ * If sha1 is non-NULL, store the referred-to object's name in it.
*
* If the reference cannot be resolved to an object, the behavior
* depends on the RESOLVE_REF_READING flag: