| /* |
| * 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_message_h__ |
| #define INCLUDE_git_message_h__ |
| |
| #include "common.h" |
| #include "buffer.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 git_buf which will be filled with the |
| * cleaned up message. |
| * |
| * @param message The message to be prettified. |
| * |
| * @param strip_comments Non-zero to remove comment lines, 0 to leave them in. |
| * |
| * @param comment_char Comment character. Lines starting with this character |
| * are considered to be comments and removed if `strip_comments` is non-zero. |
| * |
| * @return 0 or an error code. |
| */ |
| GIT_EXTERN(int) git_message_prettify(git_buf *out, const char *message, int strip_comments, char comment_char); |
| |
| /** @} */ |
| GIT_END_DECL |
| |
| #endif /* INCLUDE_git_message_h__ */ |