diff options
| author | Josh Bleecher Snyder <josharian@gmail.com> | 2020-03-07 16:04:04 -0800 |
|---|---|---|
| committer | Josh Bleecher Snyder <josharian@gmail.com> | 2020-03-07 16:05:25 -0800 |
| commit | a5886e9e0e5bcc2b3b42082fa3f443189d3974a3 (patch) | |
| tree | df9ff4174c883439d9743e5d6762dfc414ae2cc2 | |
| parent | e23b8b446522f17eb3329b62201aae7674f06e13 (diff) | |
| download | libgit2-a5886e9e0e5bcc2b3b42082fa3f443189d3974a3.tar.gz | |
repository: improve commondir docs
Fixes #5428
| -rw-r--r-- | include/git2/repository.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/include/git2/repository.h b/include/git2/repository.h index 45d7962b2..9ddcd3404 100644 --- a/include/git2/repository.h +++ b/include/git2/repository.h @@ -481,10 +481,11 @@ GIT_EXTERN(const char *) git_repository_path(const git_repository *repo); GIT_EXTERN(const char *) git_repository_workdir(const git_repository *repo); /** - * Get the path of the shared common directory for this repository - * - * If the repository is bare is not a worktree, the git directory - * path is returned. + * Get the path of the shared common directory for this repository. + * + * If the repository is bare, it is the root directory for the repository. + * If the repository is a worktree, it is the parent repo's gitdir. + * Otherwise, it is the gitdir. * * @param repo A repository object * @return the path to the common dir |