12 Describe

Libgit2: Bindings for the libgit2 Git Library

1 Annotated Commit

3 Blob

13 Diff

14 Fetch

16 Graph

18 Index

20 Merge

22 Note

24 Object Database

27 Patch

29 Proxy

30 Push

32 Refdb

38 Reset

43 Stash

47 Tag

48 Tree

On this page:

git_describe_commit

git_describe_format

git_describe_result_free

git_describe_workdir

8.18

top ← prev up next →

12Describe🔗 i

(require libgit2/include/describe ) package: libgit2

procedure
( git_describe_commitcommittishopts)→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_formatoutresultopts)→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_freeresult)→void?
result:describe_result?

Free the describe result.

procedure
( git_describe_workdirrepoopts)→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 ← prev up next →