thodg/libgit2/include/git2/describe.h

• Show log

  Commit

• Hash : 25345c0c
  Author :
  Date : 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.

Download

• include/git2/describe.h

• /*
   * Copyright (C) the libgit2 contributors. All rights reserved.
   *
   * This file is part of libgit2, distributed under the GNU GPL v2 with
   * a Linking Exception. For full terms see the included COPYING file.
   */
  #ifndef INCLUDE_git_describe_h__
  #define INCLUDE_git_describe_h__
  
  #include "common.h"
  #include "types.h"
  #include "buffer.h"
  
  /**
   * @file git2/describe.h
   * @brief Git describing routines
   * @defgroup git_describe Git describing routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  typedef enum {
  	GIT_DESCRIBE_DEFAULT,
  	GIT_DESCRIBE_TAGS,
  	GIT_DESCRIBE_ALL,
  } git_describe_strategy_t;
  
  /**
   * Describe options structure
   *
   * Zero out for defaults.  Initialize with `GIT_DESCRIBE_OPTIONS_INIT` macro to
   * correctly set the `version` field.  E.g.
   *
   *		git_describe_options opts = GIT_DESCRIBE_OPTIONS_INIT;
   */
  typedef struct git_describe_options {
  	unsigned int version;
  
  	unsigned int max_candidates_tags; /** default: 10 */
  	unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */
  	const char *pattern;
  	int only_follow_first_parent;
  	int show_commit_oid_as_fallback;
  } git_describe_options;
  
  #define GIT_DESCRIBE_DEFAULT_MAX_CANDIDATES_TAGS 10
  #define GIT_DESCRIBE_DEFAULT_ABBREVIATED_SIZE 7
  
  #define GIT_DESCRIBE_OPTIONS_VERSION 1
  #define GIT_DESCRIBE_OPTIONS_INIT { \
  	GIT_DESCRIBE_OPTIONS_VERSION, \
  	GIT_DESCRIBE_DEFAULT_MAX_CANDIDATES_TAGS, \
  }
  
  GIT_EXTERN(int) git_describe_init_options(git_describe_options *opts, unsigned int version);
  
  typedef struct {
  	unsigned int version;
  
  	unsigned int abbreviated_size;
  
  	int always_use_long_format;
  	char *dirty_suffix;
  } git_describe_format_options;
  
  #define GIT_DESCRIBE_FORMAT_OPTIONS_VERSION 1
  #define GIT_DESCRIBE_FORMAT_OPTIONS_INIT { \
  		GIT_DESCRIBE_FORMAT_OPTIONS_VERSION,   \
  		GIT_DESCRIBE_DEFAULT_ABBREVIATED_SIZE, \
   }
  
  GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version);
  
  typedef struct git_describe_result git_describe_result;
  
  GIT_EXTERN(int) git_describe_commit(
  	git_describe_result **result,
  	git_object *committish,
  	git_describe_options *opts);
  
  GIT_EXTERN(int) git_describe_workdir(
  	git_describe_result **out,
  	git_repository *repo,
  	git_describe_options *opts);
  
  GIT_EXTERN(int) git_describe_format(git_buf *out, const git_describe_result *result, const git_describe_format_options *opts);
  
  GIT_EXTERN(void) git_describe_result_free(git_describe_result *result);
  
  /** @} */
  GIT_END_DECL
  
  #endif
  

Download