setup: document check_repository_format()

peff · gitster · commit 4b0d1eebe95b · 2016-03-11T15:02:13.000-08:00
This function's interface is rather enigmatic, so let's
document it further.

While we're here, let's also drop the return value. It will
always either be "0" or the function will die (consequently,
neither of its two callers bothered to check the return).

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/cache.h b/cache.h
@@ -747,7 +747,14 @@ extern int grafts_replace_parents;
 #define GIT_REPO_VERSION_READ 1
 extern int repository_format_version;
 extern int repository_format_precious_objects;
-extern int check_repository_format(void);
+
+/*
+ * Check the repository format version in the path found in get_git_dir(),
+ * and die if it is a version we don't understand. Generally one would
+ * set_git_dir() before calling this, and use it only for "are we in a valid
+ * repo?".
+ */
+extern void check_repository_format(void);
 
 #define MTIME_CHANGED	0x0001
 #define CTIME_CHANGED	0x0002
diff --git a/setup.c b/setup.c
@@ -982,9 +982,9 @@ int check_repository_format_version(const char *var, const char *value, void *cb
 	return 0;
 }
 
-int check_repository_format(void)
+void check_repository_format(void)
 {
-	return check_repository_format_gently(get_git_dir(), NULL);
+	check_repository_format_gently(get_git_dir(), NULL);
 }
 
 /*

Original file line number	Diff line number	Diff line change
`@@ -982,9 +982,9 @@ int check_repository_format_version(const char var, const char value, void *cb`
`982`	`982`	`return 0;`
`983`	`983`	`}`
`984`	`984`
`985`		`-int check_repository_format(void)`
	`985`	`+void check_repository_format(void)`
`986`	`986`	`{`
`987`		`- return check_repository_format_gently(get_git_dir(), NULL);`
	`987`	`+ check_repository_format_gently(get_git_dir(), NULL);`
`988`	`988`	`}`
`989`	`989`
`990`	`990`	`/*`