resolve_gitlink_ref(): improve docstring
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael Haggerty committed
Dec 12, 2011 at 06:38 UTC
7f820bd92008a366f391e243fbd51e076d75e3a6
1 file changed
+6
-2
refs.h
+6
-2
@@ -133,8 +133,12 @@ extern char *shorten_unambiguous_ref(const char *refname, int strict);
133
/** rename ref, return 0 on success **/
134
extern int rename_ref(const char *oldref, const char *newref, const char *logmsg);
135
136
-/** resolve ref in nested "gitlink" repository */
137
-extern int resolve_gitlink_ref(const char *name, const char *refname, unsigned char *sha1);
136
+/**
137
+ * Resolve refname in the nested "gitlink" repository that is located
138
+ * at path. If the resolution is successful, return 0 and set sha1 to
139
+ * the name of the object; otherwise, return a non-zero value.
140
+ */
141
+extern int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1);
142
143
/** lock a ref and then write its file */
144
enum action_on_err { MSG_ON_ERR, DIE_ON_ERR, QUIET_ON_ERR };