[PATCH 3/4] Document submodule_to_gitdir

From: Han-Wen Nienhuys <hanwen@google.com>
Date: Sep 25, 2017, 15:59 UTC
Message-ID: <20170925155927.32328-4-hanwen@google.com>
In-Reply-To: <20170925155927.32328-1-hanwen@google.com>

Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
---
 submodule.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/submodule.c b/submodule.c
index b12600fc7..b66c23f5d 100644
--- a/submodule.c
+++ b/submodule.c
@@ -1997,6 +1997,9 @@ 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;

-- 
2.14.1.821.g8fa685d3b7-goog