2.12 Describe

7.7

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

top ← prev up next →

1	Background
2	Functions
	Bibliography
	Index

2.1	Annotated Commit
2.2	Blame
2.3	Blob
2.4	Branch
2.5	Buffer
2.6	Checkout
2.7	Cherrypick
2.8	Clone
2.9	Commit
2.10	Config
2.11	Credentials
2.12	Describe
2.13	Diff
2.14	Fetch
2.15	Filter
2.16	Errors
2.17	Graph
2.18	Ignore
2.19	Index
2.20	Indexer
2.21	Global
2.22	Merge
2.23	Message
2.24	Note
2.25	Object
2.26	Object Database
2.27	Oid
2.28	Oid Array
2.29	Packbuilder
2.30	Patch
2.31	Pathspec
2.32	Proxy
2.33	Push
2.34	Rebase
2.35	Refdb
2.36	Reference
2.37	Reflog
2.38	Refspec
2.39	Remote
2.40	Repository
2.41	Reset
2.42	Revert
2.43	Revparse
2.44	Revwalk
2.45	Signature
2.46	Stash
2.47	Status
2.48	Strarray
2.49	Submodule
2.50	Tag
2.51	Tree
2.52	Treebuilder