summaryrefslogtreecommitdiff
path: root/include/git2
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2')
-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