Merge branch 'hn/submodule-comment'

* hn/submodule-comment: submodule.c: describe submodule_to_gitdir() in a new comment
git · Oct 3, 2017 · 2f777fa · 2f777fa
2 parents 3b48045 + 3ce0854
commit 2f777fa
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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;