File tree Expand file tree Collapse file tree 1 file changed +7
-1
lines changed
Expand file tree Collapse file tree 1 file changed +7
-1
lines changed Original file line number Diff line number Diff line change @@ -507,7 +507,13 @@ GIT_EXTERN(int) git_commit_dup(git_commit **out, git_commit *source);
507507 *
508508 * The callback will be called with the commit content, giving a user an
509509 * opportunity to sign the commit content. The signature_field
510- * buf may be left empty to specify the default field.
510+ * buf may be left empty to specify the default field "gpgsig".
511+ *
512+ * Signatures can take the form of any string, and can be created on an arbitrary
513+ * header field. Signatures are most commonly used for verifying authorship of a
514+ * commit using GPG or a similar cryptographically secure signing algorithm.
515+ * See https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work for more
516+ * details.
511517 *
512518 * When the callback:
513519 * - returns GIT_PASSTHROUGH, no signature will be added to the commit.
You can’t perform that action at this time.
0 commit comments