include/git2/describe.h


Log

Author Commit Date CI Message
Edward Thomson 0b5ba0d7 2019-06-06T16:36:23 Rename opt init functions to `options_init` 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.
Etienne Samson 04c48afc 2018-04-20T21:07:17 docs: standardize struct git_*_options comments
Etienne Samson ca5a15e5 2018-03-22T23:27:27 docs: standardize comment block for git_*_init_options functions
Remy Suen db90e951 2018-03-27T20:09:45 Flag options in describe.h as being optional 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>
Ken Dreyer 38169764 2017-11-10T16:19:39 describe.h: fix spelling in comments optios -> options
Etienne Samson 8d2784d5 2016-11-01T17:46:20 describe: fix documentation
Yury G. Kudryashov c8022e6c 2015-05-13T06:21:12 Add `const` qualifier 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.
Ben Chatelain ec7e1c93 2015-02-10T08:31:48 Fix doc comment formatting
Carlos Martín Nieto a3b9270d 2014-09-30T09:32:24 describe: document the API
Carlos Martín Nieto 25345c0c 2014-09-30T09:18:22 describe: rename git_describe_opts to git_describe_options And implement the option init functions for this and the format options.
Carlos Martín Nieto fd8126e4 2014-09-30T08:54:52 describe: implement describing the workdir 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.
Carlos Martín Nieto 3b6534b8 2014-09-30T07:19:14 describe: split into gather and format steps 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.
Carlos Martín Nieto 1f501a08 2014-09-30T04:58:02 describe: rename _object() to _commit() We don't describe arbitrary object, so let's give it the name of the one object type we accept.
nulltoken 3a728fb5 2012-11-13T16:35:24 object: introduce git_describe_object()