summaryrefslogtreecommitdiff
path: root/include/git2/deprecated.h
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2021-08-29 10:14:01 -0400
committerEdward Thomson <ethomson@edwardthomson.com>2021-08-29 10:16:56 -0400
commitef03e15038824c8951eede2f17ad9dafbd5a32d3 (patch)
treecfc3926004f3fd402a1903b3657912ccfff53b57 /include/git2/deprecated.h
parentd3bdf33b58f16939a4fd43ab541dcd2ee535b6a3 (diff)
downloadlibgit2-ethomson/commit_create_cb.tar.gz
rebase: deprecate signing_cbethomson/commit_create_cb
The signing callback should not be used; instead, callers should provide a commit_create_cb, perform the signing and commit creation themselves.
Diffstat (limited to 'include/git2/deprecated.h')
-rw-r--r--include/git2/deprecated.h21
1 files changed, 21 insertions, 0 deletions
diff --git a/include/git2/deprecated.h b/include/git2/deprecated.h
index ac60488ac..611848e10 100644
--- a/include/git2/deprecated.h
+++ b/include/git2/deprecated.h
@@ -205,6 +205,27 @@ GIT_EXTERN(void) git_buf_free(git_buf *buffer);
/**@}*/
+/** @name Deprecated Commit Definitions
+ */
+/**@{*/
+
+/**
+ * Provide a commit signature during commit creation.
+ *
+ * Callers should instead define a `git_commit_create_cb` that
+ * generates a commit buffer using `git_commit_create_buffer`, sign
+ * that buffer and call `git_commit_create_with_signature`.
+ *
+ * @deprecated use a `git_commit_create_cb` instead
+ */
+typedef int (*git_commit_signing_cb)(
+ git_buf *signature,
+ git_buf *signature_field,
+ const char *commit_content,
+ void *payload);
+
+/**@}*/
+
/** @name Deprecated Config Functions and Constants
*/
/**@{*/