From 7f820bd92008a366f391e243fbd51e076d75e3a6 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Mon, 12 Dec 2011 06:38:18 +0100 Subject: [PATCH] resolve_gitlink_ref(): improve docstring Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano --- refs.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/refs.h b/refs.h index 4c5d570639..d4982915c5 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 }; -- 2.43.2