[PATCH 06/14] resolve_gitlink_ref(): improve docstring
From: <hidden>
Date: 2016-06-15 22:52:14
Subsystem:
the rest · Maintainer:
Linus Torvalds
From: Michael Haggerty <redacted> Signed-off-by: Michael Haggerty <redacted> --- refs.h | 6 +++++- 1 files changed, 5 insertions(+), 1 deletions(-)
diff --git a/refs.h b/refs.h
index c6b8749..d9c90cf 100644
--- a/refs.h
+++ b/refs.h@@ -132,7 +132,11 @@ 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 */ +/** + * Resolve refname in the nested "gitlink" repository that is located + * at name. 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 *name, const char *refname, unsigned char *sha1); /** lock a ref and then write its file */
--
1.7.7.rc2