Merge pull request #670 from nulltoken/ntk/topic/clean-commit_message

Clean commit and tag messages

1 files changed, 6 insertions, 0 deletions

diff --git a/include/git2/commit.h b/include/git2/commit.h
index c274b6b95..e519bc128 100644
--- a/include/git2/commit.h
+++ b/include/git2/commit.h
@@ -182,6 +182,9 @@ 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'.
+ *
  * @param oid Pointer where to store the OID of the
  *	newly created commit
  *
@@ -238,6 +241,9 @@ GIT_EXTERN(int) git_commit_create(
  * Create a new commit in the repository using a variable
  * argument list.
  *
+ * The message will be cleaned up from excess whitespace
+ * it will be made sure that the last line ends with a '\n'.
+ *
  * The parents for the commit are specified as a variable
  * list of pointers to `const git_commit *`. Note that this
  * is a convenience method which may not be safe to export