Commit Diff

Commit:
4b0bb32784eb980751dcc4bc4cf3c8ffe40ef88d
From:
Stefan Sperling <stsp@stsp.name>
Date:
Message:
document got_repo_get_path() and got_repo_get_path_git_dir()
Actions:
Patch | Tree
commit - 6e9da951ccdba2e3e9ffe11c8a0ae030930fcd11
commit + 4b0bb32784eb980751dcc4bc4cf3c8ffe40ef88d
blob - 4f82cdfa003235ead5cafae41c7c29eb0812d7d0
blob + b69af8b04e06be897a793737ac50ac34004ed051
--- include/got_repository.h
+++ 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 *);
 
 /*