summaryrefslogtreecommitdiff
path: root/include/git2/describe.h
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #6168 from punkymaniac/patch-documentation-2Edward Thomson2022-01-171-0/+5
|\ | | | | Improve documentation
| * Add documentation about parameter and return valuepunkymaniac2022-01-091-0/+5
| |
* | Fix typosDimitris Apostolou2022-01-051-1/+1
|/
* Make enum in includes C90 compliant by removing trailing comma.Peter Pettersson2021-11-151-1/+1
|
* Rename opt init functions to `options_init`Edward Thomson2019-06-141-4/+4
| | | | | | | | | | | | | In libgit2 nomenclature, when we need to verb a direct object, we name a function `git_directobject_verb`. Thus, if we need to init an options structure named `git_foo_options`, then the name of the function that does that should be `git_foo_options_init`. The previous names of `git_foo_init_options` is close - it _sounds_ as if it's initializing the options of a `foo`, but in fact `git_foo_options` is its own noun that should be respected. Deprecate the old names; they'll now call directly to the new ones.
* docs: standardize struct git_*_options commentsEtienne Samson2018-05-071-4/+7
|
* docs: standardize comment block for git_*_init_options functionsEtienne Samson2018-05-071-0/+20
|
* Flag options in describe.h as being optionalRemy Suen2018-03-271-3/+3
| | | | | | | | | | The git_describe_options in git_describe_commit and git_describe_workdir and the git_describe_format_options in git_describe_format are optional and can be NULL. State this in the documentation to make people's lives easier when calling these functions. Signed-off-by: Remy Suen <remy.suen@gmail.com>
* describe.h: fix spelling in commentsKen Dreyer2017-11-101-1/+1
| | | | optios -> options
* describe: fix documentationEtienne Samson2016-11-011-2/+5
|
* Add `const` qualifierYury G. Kudryashov2015-05-151-1/+1
| | | | | | This fixes a warning in `examples/describe.c` without breaking the main build. OTOH, I'm not sure if this is an API-compatible change.
* Fix doc comment formattingBen Chatelain2015-02-101-2/+3
|
* describe: document the APIcmn/describeCarlos Martín Nieto2014-09-301-3/+71
|
* describe: rename git_describe_opts to git_describe_optionsCarlos Martín Nieto2014-09-301-5/+9
| | | | And implement the option init functions for this and the format options.
* describe: implement describing the workdirCarlos Martín Nieto2014-09-301-0/+5
| | | | | | When we describe the workdir, we perform a describe on HEAD and then check to see if the worktree is dirty. If it is and we have a suffix string, we append that to the buffer.
* describe: split into gather and format stepsCarlos Martín Nieto2014-09-301-4/+23
| | | | | | | | Instead of printing out to the buffer inside the information-gathering phase, write the data to a intermediate result structure. This allows us to split the options into gathering options and formatting options, simplifying the gathering code.
* describe: rename _object() to _commit()Carlos Martín Nieto2014-09-301-1/+1
| | | | | We don't describe arbitrary object, so let's give it the name of the one object type we accept.
* object: introduce git_describe_object()nulltoken2014-04-301-0/+66