summaryrefslogtreecommitdiff
path: root/include/git2
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2014-05-18 10:06:49 +0200
committerCarlos Martín Nieto <cmn@dwim.me>2014-05-18 10:06:49 +0200
commit49e369b29d5bde227b162dd4681ecccff2f443df (patch)
tree30693d4febf21d5bfa2ba2aa1a8a4b31736f5886 /include/git2
parentd7a294633dc6420d2411500bd40c7dfd2aa76d37 (diff)
downloadlibgit2-49e369b29d5bde227b162dd4681ecccff2f443df.tar.gz
message: don't assume the comment charcmn/comment-char
The comment char is configurable and we need to provide a way for the user to specify which comment char they chose for their message.
Diffstat (limited to 'include/git2')
-rw-r--r--include/git2/message.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/include/git2/message.h b/include/git2/message.h
index bcdb72f6a..d78b1dce5 100644
--- a/include/git2/message.h
+++ b/include/git2/message.h
@@ -29,12 +29,14 @@ GIT_BEGIN_DECL
*
* @param message The message to be prettified.
*
- * @param strip_comments Non-zero to remove lines starting with "#", 0 to
- * leave them in.
+ * @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);
+GIT_EXTERN(int) git_message_prettify(git_buf *out, const char *message, int strip_comments, char comment_char);
/** @} */
GIT_END_DECL