summaryrefslogtreecommitdiff
path: root/replace_object.c
diff options
context:
space:
mode:
authorMichael Haggerty <mhagger@alum.mit.edu>2014-02-28 17:29:16 +0100
committerJunio C Hamano <gitster@pobox.com>2014-02-28 13:17:56 -0800
commit1f91e79cf61eaa7cb26eb0aa1e257b7681c4c328 (patch)
tree181d07d3f639afa87294ea0f35ebb9ce363a21a7 /replace_object.c
parentafc711b8e1ee89626f0dddf0ef01fb73168d47ca (diff)
downloadgit-1f91e79cf61eaa7cb26eb0aa1e257b7681c4c328.tar.gz
Add docstrings for lookup_replace_object() and do_lookup_replace_object()
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'replace_object.c')
-rw-r--r--replace_object.c7
1 files changed, 7 insertions, 0 deletions
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;