setup: document prefix

Clemens Buchacher · gitster · commit e1e5ec868fab · 2010-06-05T08:41:39.000-07:00
Signed-off-by: Clemens Buchacher &lt;drizzd@aon.at&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/setup.c b/setup.c
@@ -519,6 +519,12 @@ int check_repository_format(void)
 	return check_repository_format_gently(NULL);
 }
 
+/*
+ * Returns the "prefix", a path to the current working directory
+ * relative to the work tree root, or NULL, if the current working
+ * directory is not a strict subdirectory of the work tree root. The
+ * prefix always ends with a '/' character.
+ */
 const char *setup_git_directory(void)
 {
 	const char *retval = setup_git_directory_gently(NULL);

Original file line number	Diff line number	Diff line change
`@@ -519,6 +519,12 @@ int check_repository_format(void)`
`519`	`519`	`return check_repository_format_gently(NULL);`
`520`	`520`	`}`
`521`	`521`
	`522`	`+/*`
	`523`	`+ * Returns the "prefix", a path to the current working directory`
	`524`	`+ * relative to the work tree root, or NULL, if the current working`
	`525`	`+ * directory is not a strict subdirectory of the work tree root. The`
	`526`	`+ * prefix always ends with a '/' character.`
	`527`	`+ */`
`522`	`528`	`const char *setup_git_directory(void)`
`523`	`529`	`{`
`524`	`530`	`const char *retval = setup_git_directory_gently(NULL);`