{"size": 1007, "ext": "scrbl", "max_stars_repo_path": "libgit2/scribblings/describe.scrbl", "max_stars_repo_name": "guygastineau/libgit2", "max_stars_repo_stars_event_min_datetime": null, "max_stars_repo_stars_event_max_datetime": null, "max_issues_repo_path": "libgit2/scribblings/describe.scrbl", "max_issues_repo_name": "guygastineau/libgit2", "max_issues_repo_issues_event_min_datetime": null, "max_issues_repo_issues_event_max_datetime": null, "max_forks_repo_path": "libgit2/scribblings/describe.scrbl", "max_forks_repo_name": "guygastineau/libgit2", "max_forks_repo_forks_event_min_datetime": null, "max_forks_repo_forks_event_max_datetime": null}
{"max_stars_count": null, "max_issues_count": null, "max_forks_count": null, "avg_line_length": 22.8863636364, "max_line_length": 181, "alphanum_fraction": 0.6802383317}
#lang scribble/manual

@(require (for-label racket))

@title{Describe}

@defmodule[libgit2/include/describe]


@defproc[(git_describe_commit
          [committish object?]
          [opts (or/c git_describe_options? #f)])
         describe_result?]{
 Describe a commit

 Perform the describe operation on the given committish object.

}

@defproc[(git_describe_format
          [out buf?]
          [result describe_result?]
          [opts (or/c git_describe_format_options? #f)])
         integer?]{
 Print the describe result to a buffer

}

@defproc[(git_describe_result_free
          [result describe_result?])
         void?]{
 Free the describe result.

}

@defproc[(git_describe_workdir
          [repo repository?]
          [opts (or/c git_describe_options? #f)])
         describe_result?]{
 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.
}
