thodg/libgit2/include/git2/signature.h

• Show log

  Commit

• Hash : bb742ede
  Author :
  Date : 2011-09-19T01:54:32
  

  Cleanup legal data 1. The license header is technically not valid if it doesn't have a copyright signature. 2. The COPYING file has been updated with the different licenses used in the project. 3. The full GPLv2 header in each file annoys me.

Download

• include/git2/signature.h

• /*
   * Copyright (C) 2009-2011 the libgit2 contributors
   *
   * 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_signature_h__
  #define INCLUDE_git_signature_h__
  
  #include "common.h"
  #include "types.h"
  
  /**
   * @file git2/signature.h
   * @brief Git signature creation
   * @defgroup git_signature Git signature creation
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Create a new action signature. The signature must be freed
   * manually or using git_signature_free
   *
   * @param sig_out new signature, in case of error NULL
   * @param name name of the person
   * @param email email of the person
   * @param time time when the action happened
   * @param offset timezone offset in minutes for the time
   * @return GIT_SUCCESS or an error code
   */
  GIT_EXTERN(int) git_signature_new(git_signature **sig_out, const char *name, const char *email, git_time_t time, int offset);
  
  /**
   * Create a new action signature with a timestamp of 'now'. The
   * signature must be freed manually or using git_signature_free
   *
   * @param sig_out new signature, in case of error NULL
   * @param name name of the person
   * @param email email of the person
   * @return GIT_SUCCESS or an error code
   */
  GIT_EXTERN(int) git_signature_now(git_signature **sig_out, const char *name, const char *email);
  
  
  /**
   * Create a copy of an existing signature.
   *
   * All internal strings are also duplicated.
   * @param sig signature to duplicated
   * @return a copy of sig, NULL on out of memory
   */
  GIT_EXTERN(git_signature *) git_signature_dup(const git_signature *sig);
  
  /**
   * Free an existing signature
   *
   * @param sig signature to free
   */
  GIT_EXTERN(void) git_signature_free(git_signature *sig);
  
  /** @} */
  GIT_END_DECL
  #endif
  

Download