libgit2

git_describe_workdir

Version:

Describe a commit

Perform the describe operation on the current commit and the worktree. After performing describe on HEAD, a status is run and the description is considered to be dirty if there are.

Signature

GitHub
int git_describe_workdir(git_describe_result **out, git_repository *repo, git_describe_options *opts);

Parameters

git_describe_result **
In
out

pointer to store the result. You must free this once you're done with it.

git_repository *
In
repo

the repository in which to perform the describe

git_describe_options *
In
opts

the lookup options (or NULL for defaults)

Returns

int

0 or an error code.

Versions