Commit 8f68ad9df1b707bce1b5cd2cba3a00c6e87e5b15

Tyler Ang-Wanek 2019-07-02T10:14:46

documentation: add small explanation for commit signing

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
diff --git a/include/git2/commit.h b/include/git2/commit.h
index 2304484..e6c4656 100644
--- a/include/git2/commit.h
+++ b/include/git2/commit.h
@@ -507,7 +507,13 @@ GIT_EXTERN(int) git_commit_dup(git_commit **out, git_commit *source);
  *
  * The callback will be called with the commit content, giving a user an
  * opportunity to sign the commit content. The signature_field
- * buf may be left empty to specify the default field.
+ * buf may be left empty to specify the default field "gpgsig".
+ *
+ * Signatures can take the form of any string, and can be created on an arbitrary
+ * header field. Signatures are most commonly used for verifying authorship of a
+ * commit using GPG or a similar cryptographically secure signing algorithm.
+ * See https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work for more
+ * details.
  *
  * When the callback:
  * - returns GIT_PASSTHROUGH, no signature will be added to the commit.