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

hanwen · gitster · commit 3ce08548bb87 · 2017-09-26T14:08:23.000+09:00
Signed-off-by: Han-Wen Nienhuys &lt;hanwen@google.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
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;

Original file line number	Diff line number	Diff line change
`@@ -1997,6 +1997,10 @@ const char *get_superproject_working_tree(void)`
`1997`	`1997`	`return ret;`
`1998`	`1998`	`}`
`1999`	`1999`
	`2000`	`+/*`
	`2001`	`+ * Put the gitdir for a submodule (given relative to the main`
	`2002`	+ * repository worktree) into `buf`, or return -1 on error.
	`2003`	`+ */`
`2000`	`2004`	`int submodule_to_gitdir(struct strbuf buf, const char submodule)`
`2001`	`2005`	`{`
`2002`	`2006`	`const struct submodule *sub;`