From 1f91e79cf61eaa7cb26eb0aa1e257b7681c4c328 Mon Sep 17 00:00:00 2001 From: Michael Haggerty Date: Fri, 28 Feb 2014 17:29:16 +0100 Subject: Add docstrings for lookup_replace_object() and do_lookup_replace_object() Signed-off-by: Michael Haggerty Signed-off-by: Junio C Hamano --- replace_object.c | 7 +++++++ 1 file changed, 7 insertions(+) (limited to 'replace_object.c') diff --git a/replace_object.c b/replace_object.c index c5cf9f4467..31fabde72b 100644 --- a/replace_object.c +++ b/replace_object.c @@ -92,6 +92,13 @@ static void prepare_replace_object(void) /* We allow "recursive" replacement. Only within reason, though */ #define MAXREPLACEDEPTH 5 +/* + * If a replacement for object sha1 has been set up, return the + * replacement object's name (replaced recursively, if necessary). + * The return value is either sha1 or a pointer to a + * permanently-allocated value. This function always respects replace + * references, regardless of the value of check_replace_refs. + */ const unsigned char *do_lookup_replace_object(const unsigned char *sha1) { int pos, depth = MAXREPLACEDEPTH; -- cgit v1.2.1