11. Describe¶
These Methods allow to read values for git describe
of a commit or a repository’s worktree.
11.1. describe_commit¶
parameters | Returns |
---|---|
luagit2_object | luagit2_describe_result |
luagit2_object
: The commit object which is to be described.
- Returns
luagit2_describe_result
or gives and error. Must be freed by describe_result_free().
11.2. describe_workdir¶
parameters | Returns |
---|---|
luagit2_repository | luagit2_describe_result |
luagit2_repository
: The repository which is to be described.
- Returns
luagit2_describe_result
or gives and error. Must be freed by describe_result_free().
11.3. describe_format¶
parameters | Returns |
---|---|
luagit2_describe_result | luagit2_buf |
luagit2_describe_result
: The describe result which is to be formatted into aluagit2_buf
.
- Returns
luagit2_buf
or gives an error.
11.4. describe_result_free¶
parameters | Returns |
---|---|
luagit2_describe_result | None |
luagit2_describe_result
: The describe result which is to be freed.
- Returns None or gives an error.