setup: document check_repository_format()

[thirdparty/git.git] / cache.h

diff --git a/cache.h b/cache.h
index b829410f6da0afc14353b4621d2fdf874181a9f7..02e38d1a91e25ed76660b5cde5d4e2db9d2c88e9 100644 (file)
--- 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