summaryrefslogtreecommitdiff
path: root/include/git2/commit.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2012-06-15 22:24:59 +0200
committernulltoken <emeric.fermas@gmail.com>2012-06-19 10:02:22 +0200
commit743a4b3bdd0ff37eacf49e496ba2e5cd7b9a3f83 (patch)
tree70a6ea1a449e504bfe66dbf47168a360f049086f /include/git2/commit.h
parent68f527c4480f0c1e24f29dc0a2337469fe50967f (diff)
downloadlibgit2-743a4b3bdd0ff37eacf49e496ba2e5cd7b9a3f83.tar.gz
message: Expose git_message_prettify()
git_commit() and git_tag() no longer prettify the message by default. This has to be taken care of by the caller. This has the nice side effect of putting the caller in position to actually choose to strip the comments or not.
Diffstat (limited to 'include/git2/commit.h')
-rw-r--r--include/git2/commit.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/commit.h b/include/git2/commit.h
index a6d9bb0e3..640adf5c2 100644
--- a/include/git2/commit.h
+++ b/include/git2/commit.h
@@ -182,8 +182,8 @@ GIT_EXTERN(const git_oid *) git_commit_parent_oid(git_commit *commit, unsigned i
* Create a new commit in the repository using `git_object`
* instances as parameters.
*
- * The message will be cleaned up from excess whitespace
- * it will be made sure that the last line ends with a '\n'.
+ * The message will not be cleaned up. This can be achieved
+ * through `git_message_prettify()`.
*
* @param oid Pointer where to store the OID of the
* newly created commit