Add docstrings for lookup_replace_object() and do_lookup_replace_object()

[thirdparty/git.git] / replace_object.c

diff --git a/replace_object.c b/replace_object.c
index c5cf9f4467c46e841a9fe02a42e7272f77de2556..31fabde72b5444cb965c72781ae451919ebc9797 100644 (file)
--- 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;