blob: 28928833c544081f9c08971f7a4450e97154ebb3 [file] [log] [blame]
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -07001#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
Elijah Newrend4a4f922023-04-22 20:17:26 +00005
6struct signature_check;
7struct strbuf;
8struct tree;
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -07009
Derrick Stolee177722b2018-04-10 08:56:05 -040010#define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
Abhishek Kumard7f92782021-01-16 18:11:13 +000011#define GENERATION_NUMBER_INFINITY ((1ULL << 63) - 1)
12#define GENERATION_NUMBER_V1_MAX 0x3FFFFFFF
Derrick Stolee83073cc2018-04-25 14:37:55 +000013#define GENERATION_NUMBER_ZERO 0
Abhishek Kumare8b63002021-01-16 18:11:15 +000014#define GENERATION_NUMBER_V2_OFFSET_MAX ((1ULL << 31) - 1)
Derrick Stolee177722b2018-04-10 08:56:05 -040015
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070016struct commit_list {
17 struct commit *item;
18 struct commit_list *next;
19};
20
Nguyễn Thái Ngọc Duy9d2c9702018-05-19 07:28:31 +020021/*
22 * The size of this struct matters in full repo walk operations like
23 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
24 * to a commit instead of adding new fields here.
25 */
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070026struct commit {
27 struct object object;
Johannes Schindelindddbad72017-04-26 21:29:31 +020028 timestamp_t date;
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070029 struct commit_list *parents;
Derrick Stolee7b8a21d2018-04-06 19:09:46 +000030
31 /*
32 * If the commit is loaded from the commit-graph file, then this
Nguyễn Thái Ngọc Duy301b8c72019-04-16 16:33:19 +070033 * member may be NULL. Only access it through repo_get_commit_tree()
Derrick Stolee7b8a21d2018-04-06 19:09:46 +000034 * or get_commit_tree_oid().
35 */
Derrick Stolee891435d2018-04-06 19:09:32 +000036 struct tree *maybe_tree;
Nguyễn Thái Ngọc Duy25f859f2018-05-11 19:20:54 +020037 unsigned int index;
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070038};
39
Linus Torvalds60ab26d2005-09-15 14:43:17 -070040extern int save_commit_buffer;
Ævar Arnfjörð Bjarmasonab628582021-08-23 12:44:02 +020041extern int no_graft_file_deprecated_advice;
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070042extern const char *commit_type;
43
Linus Torvaldsca135e72007-04-16 16:05:10 -070044/* While we can decorate any object with a name, it's only used for commits.. */
Linus Torvaldsca135e72007-04-16 16:05:10 -070045struct name_decoration {
46 struct name_decoration *next;
Nazri Ramliyeb3005e2010-06-19 09:37:33 +080047 int type;
Jeff King2e3dfb22014-08-26 06:24:20 -040048 char name[FLEX_ARRAY];
Linus Torvaldsca135e72007-04-16 16:05:10 -070049};
50
Jeff King662174d2014-08-26 06:23:36 -040051enum decoration_type {
52 DECORATION_NONE = 0,
53 DECORATION_REF_LOCAL,
54 DECORATION_REF_REMOTE,
55 DECORATION_REF_TAG,
56 DECORATION_REF_STASH,
57 DECORATION_REF_HEAD,
58 DECORATION_GRAFTED,
59};
60
61void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
Jeff King2608c242014-08-26 06:23:54 -040062const struct name_decoration *get_name_decoration(const struct object *obj);
Jeff King662174d2014-08-26 06:23:36 -040063
Phillip Woodb8dbfd02022-10-17 13:17:40 +000064/*
65 * Look up commit named by "oid" respecting replacement objects.
66 * Returns NULL if "oid" is not a commit or does not exist.
67 */
68struct commit *lookup_commit_object(struct repository *r, const struct object_id *oid);
69
70/*
71 * Look up commit named by "oid" without replacement objects or
72 * checking for object existence. Returns the requested commit if it
73 * is found in the object cache, NULL if "oid" is in the object cache
74 * but is not a commit and a newly allocated unparsed commit object if
75 * "oid" is not in the object cache.
76 */
Stefan Bellerbacf1682018-06-28 18:22:10 -070077struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
Stefan Beller1f6c72f2018-06-28 18:22:22 -070078struct commit *lookup_commit_reference(struct repository *r,
79 const struct object_id *oid);
Stefan Bellerd9a05e72018-06-28 18:22:21 -070080struct commit *lookup_commit_reference_gently(struct repository *r,
Stefan Beller21e1ee82018-06-28 18:21:57 -070081 const struct object_id *oid,
Junio C Hamanof76412e2005-08-21 02:51:10 -070082 int quiet);
Pat Notza6fa5992010-11-02 13:59:07 -060083struct commit *lookup_commit_reference_by_name(const char *name);
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -070084
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 21:57:45 +100085/*
brian m. carlsonbc832662017-05-06 22:10:10 +000086 * Look up object named by "oid", dereference tag as necessary,
87 * get a commit and return it. If "oid" does not dereference to
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 21:57:45 +100088 * a commit, use ref_name to report an error and die.
89 */
brian m. carlsonbc832662017-05-06 22:10:10 +000090struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 21:57:45 +100091
Stefan Bellerfd8030c2018-06-28 18:22:13 -070092int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
Stefan Beller9e5252a2018-11-13 16:12:50 -080093int repo_parse_commit_internal(struct repository *r, struct commit *item,
94 int quiet_on_missing, int use_commit_graph);
95int repo_parse_commit_gently(struct repository *r,
96 struct commit *item,
97 int quiet_on_missing);
98static inline int repo_parse_commit(struct repository *r, struct commit *item)
Jeff King9cc2b072015-06-01 05:56:26 -040099{
Stefan Beller9e5252a2018-11-13 16:12:50 -0800100 return repo_parse_commit_gently(r, item, 0);
Jeff King9cc2b072015-06-01 05:56:26 -0400101}
Ævar Arnfjörð Bjarmason43d35612019-03-25 13:08:33 +0100102
Derrick Stoleec4cc0832021-02-01 17:15:03 +0000103static inline int repo_parse_commit_no_graph(struct repository *r,
104 struct commit *commit)
Ævar Arnfjörð Bjarmason43d35612019-03-25 13:08:33 +0100105{
Derrick Stoleec4cc0832021-02-01 17:15:03 +0000106 return repo_parse_commit_internal(r, commit, 0, 0);
Ævar Arnfjörð Bjarmason43d35612019-03-25 13:08:33 +0100107}
108
Jeff King7059dcc2013-10-24 04:52:36 -0400109void parse_commit_or_die(struct commit *item);
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -0700110
Stefan Beller65ea9d42018-06-28 18:22:15 -0700111struct buffer_slab;
112struct buffer_slab *allocate_commit_buffer_slab(void);
113void free_commit_buffer_slab(struct buffer_slab *bs);
114
Jeff King0fb370d2014-06-12 18:05:37 -0400115/*
Jeff King66c28272014-06-10 17:40:14 -0400116 * Associate an object buffer with the commit. The ownership of the
117 * memory is handed over to the commit, and must be free()-able.
118 */
Stefan Beller1a40fc42018-06-28 18:22:16 -0700119void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
Jeff King66c28272014-06-10 17:40:14 -0400120
121/*
Jeff King152ff1c2014-06-10 17:40:39 -0400122 * Get any cached object buffer associated with the commit. Returns NULL
123 * if none. The resulting memory should not be freed.
124 */
Stefan Beller4ff7e5c2018-06-28 18:22:17 -0700125const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
Jeff King152ff1c2014-06-10 17:40:39 -0400126
127/*
128 * Get the commit's object contents, either from cache or by reading the object
129 * from disk. The resulting memory should not be modified, and must be given
Ævar Arnfjörð Bjarmasonc7c33f52023-03-28 15:58:57 +0200130 * to repo_unuse_commit_buffer when the caller is done.
Jeff King152ff1c2014-06-10 17:40:39 -0400131 */
Stefan Beller07de3fd2018-11-13 16:12:57 -0800132const void *repo_get_commit_buffer(struct repository *r,
133 const struct commit *,
134 unsigned long *size);
Jeff King152ff1c2014-06-10 17:40:39 -0400135
136/*
Elijah Newren15beaaa2019-11-05 17:07:23 +0000137 * Tell the commit subsystem that we are done with a particular commit buffer.
Jeff King152ff1c2014-06-10 17:40:39 -0400138 * The commit and buffer should be the input and return value, respectively,
Ævar Arnfjörð Bjarmasonc7c33f52023-03-28 15:58:57 +0200139 * from an earlier call to repo_get_commit_buffer. The buffer may or may not be
Jeff King152ff1c2014-06-10 17:40:39 -0400140 * freed by this call; callers should not access the memory afterwards.
141 */
Stefan Beller70315372018-11-13 16:12:58 -0800142void repo_unuse_commit_buffer(struct repository *r,
143 const struct commit *,
144 const void *buffer);
Jeff King152ff1c2014-06-10 17:40:39 -0400145
146/*
Jeff King0fb370d2014-06-12 18:05:37 -0400147 * Free any cached object buffer associated with the commit.
148 */
Stefan Beller6a7895f2018-12-14 16:09:40 -0800149void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
Jeff King0fb370d2014-06-12 18:05:37 -0400150
Nguyễn Thái Ngọc Duy301b8c72019-04-16 16:33:19 +0700151struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
Derrick Stolee5bb03de2018-04-06 19:09:34 +0000152struct object_id *get_commit_tree_oid(const struct commit *);
153
Jeff King0fb370d2014-06-12 18:05:37 -0400154/*
Stefan Beller14ba97f2018-05-15 14:48:42 -0700155 * Release memory related to a commit, including the parent list and
156 * any cached object buffer.
157 */
Stefan Beller6a7895f2018-12-14 16:09:40 -0800158void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
Stefan Beller14ba97f2018-05-15 14:48:42 -0700159
160/*
Jeff King0fb370d2014-06-12 18:05:37 -0400161 * Disassociate any cached object buffer from the commit, but do not free it.
162 * The buffer (or NULL, if none) is returned.
163 */
Jeff King8597ea32014-06-10 17:44:13 -0400164const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
Jeff King0fb370d2014-06-12 18:05:37 -0400165
Christian Couder11af2aa2010-07-22 15:18:30 +0200166/* Find beginning and length of commit subject. */
167int find_commit_subject(const char *commit_buffer, const char **subject);
168
Charvi Mendiratta6e0e2882021-03-15 13:24:31 +0530169/* Return length of the commit subject from commit log message. */
170size_t commit_subject_length(const char *body);
171
Thiago Farina47e44ed2010-11-26 23:58:14 -0200172struct commit_list *commit_list_insert(struct commit *item,
173 struct commit_list **list);
Derrick Stolee597b2c32020-12-08 17:04:13 -0500174int commit_list_contains(struct commit *item,
175 struct commit_list *list);
René Scharfe89b5f1d2012-04-25 22:35:27 +0200176struct commit_list **commit_list_append(struct commit *commit,
177 struct commit_list **next);
Miklos Vajna65319472008-06-27 18:21:55 +0200178unsigned commit_list_count(const struct commit_list *l);
Thiago Farina47e44ed2010-11-26 23:58:14 -0200179struct commit_list *commit_list_insert_by_date(struct commit *item,
180 struct commit_list **list);
181void commit_list_sort_by_date(struct commit_list **list);
Daniel Barkalowdd97f852005-04-23 18:47:23 -0700182
Thomas Rast53d00b32013-07-31 22:13:20 +0200183/* Shallow copy of the input list */
184struct commit_list *copy_commit_list(struct commit_list *list);
185
Elijah Newrenb0ca1202020-12-16 22:27:59 +0000186/* Modify list in-place to reverse it, returning new head; list will be tail */
187struct commit_list *reverse_commit_list(struct commit_list *list);
188
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -0700189void free_commit_list(struct commit_list *list);
190
René Scharfe6d167fd2017-03-01 12:37:07 +0100191struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
192
Stefan Beller424510e2018-11-13 16:12:59 -0800193const char *repo_logmsg_reencode(struct repository *r,
194 const struct commit *commit,
195 char **commit_encoding,
196 const char *output_encoding);
Stefan Beller424510e2018-11-13 16:12:59 -0800197
Denton Liu55454422019-04-29 04:28:14 -0400198const char *skip_blank_lines(const char *msg);
Linus Torvaldse3bc7a32005-06-01 08:34:23 -0700199
Daniel Barkalowdd97f852005-04-23 18:47:23 -0700200/** Removes the first commit from a list sorted by date, and adds all
201 * of its parents.
202 **/
Junio C Hamanoa6080a02007-06-07 00:04:01 -0700203struct commit *pop_most_recent_commit(struct commit_list **list,
Daniel Barkalow58e28af2005-04-23 20:29:22 -0700204 unsigned int mark);
Daniel Barkalowdd97f852005-04-23 18:47:23 -0700205
jon@blackcubes.dyndns.orga3437b82005-06-06 15:39:40 +0000206struct commit *pop_commit(struct commit_list **stack);
207
Junio C Hamanof8f9c732006-01-07 18:52:42 -0800208void clear_commit_marks(struct commit *commit, unsigned int mark);
Junio C Hamanoe895cb52013-03-05 11:42:20 -0800209void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
Junio C Hamanof8f9c732006-01-07 18:52:42 -0800210
Junio C Hamano08f704f2013-06-06 16:07:14 -0700211
212enum rev_sort_order {
213 REV_SORT_IN_GRAPH_ORDER = 0,
Junio C Hamano81c6b382013-06-07 10:35:54 -0700214 REV_SORT_BY_COMMIT_DATE,
215 REV_SORT_BY_AUTHOR_DATE
Junio C Hamano08f704f2013-06-06 16:07:14 -0700216};
217
Jon Seymourab580ac2005-07-07 02:39:34 +1000218/*
219 * Performs an in-place topological sort of list supplied.
220 *
Jon Seymourab580ac2005-07-07 02:39:34 +1000221 * invariant of resulting list is:
222 * a reachable from b => ord(b) < ord(a)
Junio C Hamano08f704f2013-06-06 16:07:14 -0700223 * sort_order further specifies:
224 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
225 * chain together.
226 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
Jon Seymourab580ac2005-07-07 02:39:34 +1000227 */
Junio C Hamano08f704f2013-06-06 16:07:14 -0700228void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
Junio C Hamano5040f172006-04-06 23:58:51 -0700229
230struct commit_graft {
brian m. carlson7683e2e2015-03-13 23:39:34 +0000231 struct object_id oid;
Johannes Schindelined09aef2006-10-30 20:09:06 +0100232 int nr_parent; /* < 0 if shallow commit */
brian m. carlson7683e2e2015-03-13 23:39:34 +0000233 struct object_id parent[FLEX_ARRAY]; /* more */
Junio C Hamano5040f172006-04-06 23:58:51 -0700234};
Nguyễn Thái Ngọc Duy09d46642011-08-18 19:29:35 +0700235typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
Junio C Hamano5040f172006-04-06 23:58:51 -0700236
Patryk Obara9a934032017-08-18 20:33:12 +0200237struct commit_graft *read_graft_line(struct strbuf *line);
Taylor Blau183df642020-04-30 15:11:28 -0600238/* commit_graft_pos returns an index into r->parsed_objects->grafts. */
Jeff King98c431b2021-01-28 01:12:35 -0500239int commit_graft_pos(struct repository *r, const struct object_id *oid);
Brandon Williamsa3b78e82018-05-17 15:51:48 -0700240int register_commit_graft(struct repository *r, struct commit_graft *, int);
Derrick Stolee20fd6d52018-08-20 18:24:30 +0000241void prepare_commit_graft(struct repository *r);
Stefan Bellerb9dbddf2018-05-17 15:51:54 -0700242struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
Jonathan Tan2a69ff02022-03-17 11:24:47 -0700243void reset_commit_grafts(struct repository *r);
Junio C Hamano5040f172006-04-06 23:58:51 -0700244
Pratik Karki103148a2018-09-04 15:00:08 -0700245struct commit *get_fork_point(const char *refname, struct commit *commit);
246
Stefano Lattarini41ccfdd2013-04-12 00:36:10 +0200247/* largest positive number a signed 32-bit integer can contain */
Nguyễn Thái Ngọc Duy4dcb1672013-01-11 16:05:46 +0700248#define INFINITE_DEPTH 0x7fffffff
249
brian m. carlson910650d2017-03-31 01:40:00 +0000250struct oid_array;
Nguyễn Thái Ngọc Duy58babff2013-12-05 20:02:35 +0700251struct ref;
Denton Liu55454422019-04-29 04:28:14 -0400252int for_each_commit_graft(each_commit_graft_fn, void *);
Johannes Schindelined09aef2006-10-30 20:09:06 +0100253
Jeff Kinge885a842020-09-30 08:28:18 -0400254int interactive_add(const char **argv, const char *prefix, int patch);
Kristian Høgsberg58680162007-09-17 20:06:44 -0400255
Junio C Hamano5231c632011-11-07 16:21:32 -0800256struct commit_extra_header {
257 struct commit_extra_header *next;
258 char *key;
259 char *value;
260 size_t len;
261};
262
Denton Liu55454422019-04-29 04:28:14 -0400263void append_merge_tag_headers(struct commit_list *parents,
Denton Liuad6dad02019-04-29 04:28:23 -0400264 struct commit_extra_header ***tail);
Junio C Hamano5231c632011-11-07 16:21:32 -0800265
Denton Liu55454422019-04-29 04:28:14 -0400266int commit_tree(const char *msg, size_t msg_len,
Denton Liuad6dad02019-04-29 04:28:23 -0400267 const struct object_id *tree,
268 struct commit_list *parents, struct object_id *ret,
269 const char *author, const char *sign_commit);
Junio C Hamano5231c632011-11-07 16:21:32 -0800270
Denton Liu55454422019-04-29 04:28:14 -0400271int commit_tree_extended(const char *msg, size_t msg_len,
Denton Liuad6dad02019-04-29 04:28:23 -0400272 const struct object_id *tree,
Phillip Woode8cbe212020-08-17 18:40:01 +0100273 struct commit_list *parents, struct object_id *ret,
274 const char *author, const char *committer,
275 const char *sign_commit, struct commit_extra_header *);
Junio C Hamano5231c632011-11-07 16:21:32 -0800276
Denton Liu55454422019-04-29 04:28:14 -0400277struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
Junio C Hamanoed7a42a2011-11-08 15:38:07 -0800278
Denton Liu55454422019-04-29 04:28:14 -0400279void free_commit_extra_headers(struct commit_extra_header *extra);
Jeff King40d52ff2010-04-01 20:05:23 -0400280
Jeff Kingfe6eb7f2014-08-27 03:56:01 -0400281/*
282 * Search the commit object contents given by "msg" for the header "key".
John Caicfc5cf42022-01-06 20:07:35 +0000283 * Reads up to "len" bytes of "msg".
Jeff Kingfe6eb7f2014-08-27 03:56:01 -0400284 * Returns a pointer to the start of the header contents, or NULL. The length
285 * of the header, up to the first newline, is returned via out_len.
286 *
287 * Note that some headers (like mergetag) may be multi-line. It is the caller's
288 * responsibility to parse further in this case!
289 */
John Caicfc5cf42022-01-06 20:07:35 +0000290const char *find_header_mem(const char *msg, size_t len,
291 const char *key,
292 size_t *out_len);
293
Denton Liu55454422019-04-29 04:28:14 -0400294const char *find_commit_header(const char *msg, const char *key,
Denton Liuad6dad02019-04-29 04:28:23 -0400295 size_t *out_len);
Jeff Kingfe6eb7f2014-08-27 03:56:01 -0400296
Christian Couder8c384582014-11-09 10:23:41 +0100297/* Find the end of the log message, the right place for a new trailer. */
Denton Liu55454422019-04-29 04:28:14 -0400298size_t ignore_non_trailer(const char *buf, size_t len);
Christian Couder8c384582014-11-09 10:23:41 +0100299
Johannes Schindelinfef461e2018-04-25 11:54:04 +0200300typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
Denton Liuad6dad02019-04-29 04:28:23 -0400301 void *cb_data);
Christian Couder063da622014-07-07 08:35:37 +0200302
Denton Liu55454422019-04-29 04:28:14 -0400303int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
Christian Couder063da622014-07-07 08:35:37 +0200304
Junio C Hamanoae8e4c92011-11-07 13:26:22 -0800305struct merge_remote_desc {
306 struct object *obj; /* the named object, could be a tag */
René Scharfe5447a762016-08-13 14:21:27 +0200307 char name[FLEX_ARRAY];
Junio C Hamanoae8e4c92011-11-07 13:26:22 -0800308};
Denton Liu55454422019-04-29 04:28:14 -0400309struct merge_remote_desc *merge_remote_util(struct commit *);
310void set_merge_remote_desc(struct commit *commit,
Denton Liuad6dad02019-04-29 04:28:23 -0400311 const char *name, struct object *obj);
Junio C Hamanoae8e4c92011-11-07 13:26:22 -0800312
313/*
314 * Given "name" from the command line to merge, find the commit object
315 * and return it, while storing merge_remote_desc in its ->util field,
316 * to allow callers to tell if we are told to merge a tag.
317 */
318struct commit *get_merge_parent(const char *name);
319
Denton Liu55454422019-04-29 04:28:14 -0400320int parse_signed_commit(const struct commit *commit,
brian m. carlson1fb5cf02021-01-18 23:49:11 +0000321 struct strbuf *message, struct strbuf *signature,
322 const struct git_hash_algo *algop);
Denton Liu55454422019-04-29 04:28:14 -0400323int remove_signature(struct strbuf *buf);
Christian Couder0b05ab62014-07-19 17:01:12 +0200324
Sebastian Götteffb6d7d2013-03-31 18:00:14 +0200325/*
Sebastian Götteeb307ae2013-03-31 18:02:46 +0200326 * Check the signature of the given commit. The result of the check is stored
327 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
328 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
329 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
330 * sig->signer and sig->key.
Sebastian Götteffb6d7d2013-03-31 18:00:14 +0200331 */
Denton Liu55454422019-04-29 04:28:14 -0400332int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
Sebastian Götteffb6d7d2013-03-31 18:00:14 +0200333
Derrick Stolee5284fc52018-11-01 13:46:21 +0000334/* record author-date for each commit object */
335struct author_date_slab;
336void record_author_date(struct author_date_slab *author_date,
337 struct commit *commit);
338
339int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
Junio C Hamano6d2035e2018-11-18 18:23:54 +0900340
Jeff Kingedc4d472018-11-06 02:50:17 -0500341/*
342 * Verify a single commit with check_commit_signature() and die() if it is not
343 * a good signature. This isn't really suitable for general use, but is a
344 * helper to implement consistent logic for pull/merge --verify-signatures.
Hans Jerry Illikainen54887b42019-12-27 13:55:57 +0000345 *
346 * The check_trust parameter is meant for backward-compatibility. The GPG
347 * interface verifies key trust with a default trust level that is below the
348 * default trust level for merge operations. Its value should be non-zero if
349 * the user hasn't set a minimum trust level explicitly in their configuration.
350 *
351 * If the user has set a minimum trust level, then that value should be obeyed
352 * and check_trust should be zero, even if the configured trust level is below
353 * the default trust level for merges.
Jeff Kingedc4d472018-11-06 02:50:17 -0500354 */
Hans Jerry Illikainen54887b42019-12-27 13:55:57 +0000355void verify_merge_signature(struct commit *commit, int verbose,
356 int check_trust);
Jeff Kingedc4d472018-11-06 02:50:17 -0500357
Jeff King727377f2013-07-02 02:21:48 -0400358int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
Derrick Stolee3afc6792018-05-01 12:47:11 +0000359int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
Jeff King727377f2013-07-02 02:21:48 -0400360
Benoit Pierre15048f82014-03-18 11:00:53 +0100361LAST_ARG_MUST_BE_NULL
Ævar Arnfjörð Bjarmasona8cc5942022-03-07 13:33:46 +0100362int run_commit_hook(int editor_is_used, const char *index_file,
363 int *invoked_hook, const char *name, ...);
Benoit Pierre15048f82014-03-18 11:00:53 +0100364
brian m. carlson937032e2021-02-11 02:08:04 +0000365/* Sign a commit or tag buffer, storing the result in a header. */
366int sign_with_header(struct strbuf *buf, const char *keyid);
367/* Parse the signature out of a header. */
368int parse_buffer_signed_by_header(const char *buffer,
369 unsigned long size,
370 struct strbuf *payload,
371 struct strbuf *signature,
372 const struct git_hash_algo *algop);
373
Daniel Barkalow6eb8ae02005-04-18 11:39:48 -0700374#endif /* COMMIT_H */