Skip to content

G
git2
Commit a5886e9e by Josh Bleecher Snyder
Options

repository: improve commondir docs 

Fixes #5428
parent e23b8b44
Showing with 4 additions and 3 deletions
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
* 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.
* 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
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment