12 Describe

8.12

12 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.

1	Annotated Commit
2	Blame
3	Blob
4	Branch
5	Buffer
6	Checkout
7	Cherrypick
8	Clone
9	Commit
10	Config
11	Credentials
12	Describe
13	Diff
14	Fetch
15	Filter
16	Graph
17	Ignore
18	Index
19	Indexer
20	Merge
21	Message
22	Note
23	Object
24	Object Database
25	Object IDs
26	Packbuilder
27	Patch
28	Pathspec
29	Proxy
30	Push
31	Rebase
32	Refdb
33	Reference
34	Reflog
35	Refspec
36	Remote
37	Repository
38	Reset
39	Revert
40	Revparse
41	Revwalk
42	Signature
43	Stash
44	Status
45	Strarray
46	Submodule
47	Tag
48	Tree
49	Treebuilder
	Bibliography
	Index