thodg/libgit2/include/git2/message.h

• Show log

  Commit

• Hash : f984d97b
  Author :
  Date : 2012-11-27T15:00:28
  

  Clarify git_message_prettify comments

Download

• include/git2/message.h

• /*
   * Copyright (C) 2009-2012 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_message_h__
  #define INCLUDE_git_message_h__
  
  #include "common.h"
  
  /**
   * @file git2/message.h
   * @brief Git message management routines
   * @ingroup Git
   * @{
   */
  GIT_BEGIN_DECL
  
  /**
   * Clean up message from excess whitespace and make sure that the last line
   * ends with a '\n'.
   *
   * Optionally, can remove lines starting with a "#".
   *
   * @param out The user-allocated buffer which will be filled with the
   *     cleaned up message. Pass NULL if you just want to get the needed
   *     size of the prettified message as the output value.
   *
   * @param out_size Size of the `out` buffer in bytes.
   *
   * @param message The message to be prettified.
   *
   * @param strip_comments Non-zero to remove lines starting with "#", 0 to
   *     leave them in.
   *
   * @return -1 on error, else number of characters in prettified message
   *     including the trailing NUL byte
   */
  GIT_EXTERN(int) git_message_prettify(
  	char *out,
  	size_t out_size,
  	const char *message,
  	int strip_comments);
  
  /** @} */
  GIT_END_DECL
  
  #endif /* INCLUDE_git_message_h__ */
  

Download