diff options
| author | Edward Thomson <ethomson@edwardthomson.com> | 2020-03-23 10:20:46 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-23 10:20:46 +0000 |
| commit | 43fb0c2925668ed092bb37f7949b816973b6fbce (patch) | |
| tree | 1f03d2b9da929c763828752fe3e7116d78d7741a | |
| parent | 9a1024465cf3650d513d3e997435683fcf518e2b (diff) | |
| parent | a5886e9e0e5bcc2b3b42082fa3f443189d3974a3 (diff) | |
| download | libgit2-43fb0c2925668ed092bb37f7949b816973b6fbce.tar.gz | |
Merge pull request #5444 from josharian/issue5428
repository: improve commondir docs
| -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 |