Commit 4b0bb32784eb980751dcc4bc4cf3c8ffe40ef88d

Stefan Sperling 2019-01-06T10:49:53

document got_repo_get_path() and got_repo_get_path_git_dir()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
diff --git a/include/got_repository.h b/include/got_repository.h
index 4f82cdf..b69af8b 100644
--- a/include/got_repository.h
+++ b/include/got_repository.h
@@ -20,7 +20,13 @@ struct got_repository;
 const struct got_error *got_repo_open(struct got_repository**, const char *);
 const struct got_error *got_repo_close(struct got_repository*);
 
+/* Obtain the on-disk path to the repository. */
 const char *got_repo_get_path(struct got_repository *);
+
+/*
+ * Obtain the path to a non-bare repository's .git directory.
+ * For bare repositories, this returns the same result as got_repo_get_path().
+ */
 const char *got_repo_get_path_git_dir(struct got_repository *);
 
 /*