summaryrefslogtreecommitdiff
path: root/refs.h
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2011-12-12 05:38:18 (GMT)
committerJunio C Hamano <gitster@pobox.com>2011-12-12 17:08:53 (GMT)
commit7f820bd92008a366f391e243fbd51e076d75e3a6 (patch)
tree81c1a90e458dccf183e8848475aebe2f3a6dd067 /refs.h
parent3b12482358e58d95d4a8effc840862c87d995c4c (diff)
downloadgit-7f820bd92008a366f391e243fbd51e076d75e3a6.zip
git-7f820bd92008a366f391e243fbd51e076d75e3a6.tar.gz
git-7f820bd92008a366f391e243fbd51e076d75e3a6.tar.bz2
resolve_gitlink_ref(): improve docstring
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'refs.h')
-rw-r--r--refs.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/refs.h b/refs.h
index 4c5d570..d498291 100644
--- a/refs.h
+++ b/refs.h
@@ -133,8 +133,12 @@ extern char *shorten_unambiguous_ref(const char *refname, int strict);
/** rename ref, return 0 on success **/
extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
-/** resolve ref in nested "gitlink" repository */
-extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *sha1);
+/**
+ * Resolve refname in the nested "gitlink" repository that is located
+ * at path. If the resolution is successful, return 0 and set sha1 to
+ * the name of the object; otherwise, return a non-zero value.
+ */
+extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
/** lock a ref and then write its file */
enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };