From: Han-Wen Nienhuys <hanwen@google.com>
Date: Mon, 25 Sep 2017 15:59:26 +0000 (+0200)
Subject: submodule.c: describe submodule_to_gitdir() in a new comment
X-Git-Tag: v2.15.0-rc0~23^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3ce08548bb8768259c98f7fcf30be4c0bae9c611;p=git

submodule.c: describe submodule_to_gitdir() in a new comment

Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/submodule.c b/submodule.c
index b12600fc79..50bf3fb09c 100644
--- a/submodule.c
+++ b/submodule.c
@@ -1997,6 +1997,10 @@ const char *get_superproject_working_tree(void)
 	return ret;
 }
 
+/*
+ * Put the gitdir for a submodule (given relative to the main
+ * repository worktree) into `buf`, or return -1 on error.
+ */
 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
 {
 	const struct submodule *sub;