summaryrefslogtreecommitdiff
path: root/include/git2/signature.h
diff options
context:
space:
mode:
authorVicent Martí <vicent@github.com>2012-07-12 09:37:09 -0700
committerVicent Martí <vicent@github.com>2012-07-12 09:37:09 -0700
commit0cf6b2f29ebf9d6342bd205197938e881ccc246f (patch)
treecd0643f32aa82aa24deb3c888e629c6b808d046d /include/git2/signature.h
parentdb2d4061f60f9390b9d37100b15ba5e819927aa4 (diff)
parent8aedf1d5581f518da286ca4a33d6f7a98db38651 (diff)
downloadlibgit2-0cf6b2f29ebf9d6342bd205197938e881ccc246f.tar.gz
Merge pull request #805 from nulltoken/fix/revwalk-email-parsing
Fix revwalk email parsing
Diffstat (limited to 'include/git2/signature.h')
-rw-r--r--include/git2/signature.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/signature.h b/include/git2/signature.h
index cbf94269f..cdbe67879 100644
--- a/include/git2/signature.h
+++ b/include/git2/signature.h
@@ -23,6 +23,9 @@ GIT_BEGIN_DECL
* Create a new action signature. The signature must be freed
* manually or using git_signature_free
*
+ * Note: angle brackets ('<' and '>') characters are not allowed
+ * to be used in either the `name` or the `email` parameter.
+ *
* @param sig_out new signature, in case of error NULL
* @param name name of the person
* @param email email of the person