▼Libgit2:   Bindings for the libgit2 Git Library
On this page:
git_  describe_  commit
git_  describe_  format
git_  describe_  result_  free
git_  describe_  workdir
8.16.0.4
  top  contents    up   

12 Describe🔗ℹ

 (require libgit2/include/describe) package: libgit2

procedure

(git_describe_commit committish opts) → describe_result?

  committish : object?
  opts : (or/c git_describe_options? #f)
Describe a commit

Perform the describe operation on the given committish object.

procedure

(git_describe_format out result opts) → integer?

  out : buf?
  result : describe_result?
  opts : (or/c git_describe_format_options? #f)
Print the describe result to a buffer

procedure

(git_describe_result_free result) → void?

  result : describe_result?
Free the describe result.

procedure

(git_describe_workdir repo opts) → describe_result?

  repo : repository?
  opts : (or/c git_describe_options? #f)
Describe a commit

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

  top  contents    up