🌐 AI搜索 & 代理 主页
blob: 5467786c7be332299e54a954eb9af55b64d58848 [file] [log] [blame]
Daniel Barkalow6eb8ae02005-04-18 18:39:481#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
Pierre Habouzit674d1722007-09-10 10:35:066#include "strbuf.h"
Linus Torvaldsca135e72007-04-16 23:05:107#include "decorate.h"
Sebastian Götteffb6d7d2013-03-31 16:00:148#include "gpg-interface.h"
Jeff Kinga9080472013-07-03 07:08:229#include "string-list.h"
Olga Telezhnayacf394712017-12-12 08:55:3510#include "pretty.h"
Derrick Stolee5284fc52018-11-01 13:46:2111#include "commit-slab.h"
Daniel Barkalow6eb8ae02005-04-18 18:39:4812
Derrick Stolee177722b2018-04-10 12:56:0513#define COMMIT_NOT_FROM_GRAPH 0xFFFFFFFF
Derrick Stolee83073cc2018-04-25 14:37:5514#define GENERATION_NUMBER_INFINITY 0xFFFFFFFF
15#define GENERATION_NUMBER_MAX 0x3FFFFFFF
16#define GENERATION_NUMBER_ZERO 0
Derrick Stolee177722b2018-04-10 12:56:0517
Daniel Barkalow6eb8ae02005-04-18 18:39:4818struct commit_list {
19 struct commit *item;
20 struct commit_list *next;
21};
22
Nguyễn Thái Ngọc Duy9d2c9702018-05-19 05:28:3123/*
24 * The size of this struct matters in full repo walk operations like
25 * 'git clone' or 'git gc'. Consider using commit-slab to attach data
26 * to a commit instead of adding new fields here.
27 */
Daniel Barkalow6eb8ae02005-04-18 18:39:4828struct commit {
29 struct object object;
Johannes Schindelindddbad72017-04-26 19:29:3130 timestamp_t date;
Daniel Barkalow6eb8ae02005-04-18 18:39:4831 struct commit_list *parents;
Derrick Stolee7b8a21d2018-04-06 19:09:4632
33 /*
34 * If the commit is loaded from the commit-graph file, then this
Nguyễn Thái Ngọc Duy301b8c72019-04-16 09:33:1935 * member may be NULL. Only access it through repo_get_commit_tree()
Derrick Stolee7b8a21d2018-04-06 19:09:4636 * or get_commit_tree_oid().
37 */
Derrick Stolee891435d2018-04-06 19:09:3238 struct tree *maybe_tree;
Nguyễn Thái Ngọc Duy25f859f2018-05-11 17:20:5439 unsigned int index;
Daniel Barkalow6eb8ae02005-04-18 18:39:4840};
41
Linus Torvalds60ab26d2005-09-15 21:43:1742extern int save_commit_buffer;
Daniel Barkalow6eb8ae02005-04-18 18:39:4843extern const char *commit_type;
44
Linus Torvaldsca135e72007-04-16 23:05:1045/* While we can decorate any object with a name, it's only used for commits.. */
Linus Torvaldsca135e72007-04-16 23:05:1046struct name_decoration {
47 struct name_decoration *next;
Nazri Ramliyeb3005e2010-06-19 01:37:3348 int type;
Jeff King2e3dfb22014-08-26 10:24:2049 char name[FLEX_ARRAY];
Linus Torvaldsca135e72007-04-16 23:05:1050};
51
Jeff King662174d2014-08-26 10:23:3652enum decoration_type {
53 DECORATION_NONE = 0,
54 DECORATION_REF_LOCAL,
55 DECORATION_REF_REMOTE,
56 DECORATION_REF_TAG,
57 DECORATION_REF_STASH,
58 DECORATION_REF_HEAD,
59 DECORATION_GRAFTED,
60};
61
62void add_name_decoration(enum decoration_type type, const char *name, struct object *obj);
Jeff King2608c242014-08-26 10:23:5463const struct name_decoration *get_name_decoration(const struct object *obj);
Jeff King662174d2014-08-26 10:23:3664
Stefan Bellerbacf1682018-06-29 01:22:1065struct commit *lookup_commit(struct repository *r, const struct object_id *oid);
Stefan Beller1f6c72f2018-06-29 01:22:2266struct commit *lookup_commit_reference(struct repository *r,
67 const struct object_id *oid);
Stefan Bellerd9a05e72018-06-29 01:22:2168struct commit *lookup_commit_reference_gently(struct repository *r,
Stefan Beller21e1ee82018-06-29 01:21:5769 const struct object_id *oid,
Junio C Hamanof76412e2005-08-21 09:51:1070 int quiet);
Pat Notza6fa5992010-11-02 19:59:0771struct commit *lookup_commit_reference_by_name(const char *name);
Daniel Barkalow6eb8ae02005-04-18 18:39:4872
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 11:57:4573/*
brian m. carlsonbc832662017-05-06 22:10:1074 * Look up object named by "oid", dereference tag as necessary,
75 * get a commit and return it. If "oid" does not dereference to
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 11:57:4576 * a commit, use ref_name to report an error and die.
77 */
brian m. carlsonbc832662017-05-06 22:10:1078struct commit *lookup_commit_or_die(const struct object_id *oid, const char *ref_name);
Nguyễn Thái Ngọc Duybaf18fc2011-09-17 11:57:4579
Stefan Bellerfd8030c2018-06-29 01:22:1380int parse_commit_buffer(struct repository *r, struct commit *item, const void *buffer, unsigned long size, int check_graph);
Stefan Beller9e5252a2018-11-14 00:12:5081int repo_parse_commit_internal(struct repository *r, struct commit *item,
82 int quiet_on_missing, int use_commit_graph);
83int repo_parse_commit_gently(struct repository *r,
84 struct commit *item,
85 int quiet_on_missing);
86static inline int repo_parse_commit(struct repository *r, struct commit *item)
Jeff King9cc2b072015-06-01 09:56:2687{
Stefan Beller9e5252a2018-11-14 00:12:5088 return repo_parse_commit_gently(r, item, 0);
Jeff King9cc2b072015-06-01 09:56:2689}
Ævar Arnfjörð Bjarmason43d35612019-03-25 12:08:3390
91static inline int parse_commit_no_graph(struct commit *commit)
92{
93 return repo_parse_commit_internal(the_repository, commit, 0, 0);
94}
95
Stefan Beller9e5252a2018-11-14 00:12:5096#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
97#define parse_commit_internal(item, quiet, use) repo_parse_commit_internal(the_repository, item, quiet, use)
Stefan Beller9e5252a2018-11-14 00:12:5098#define parse_commit(item) repo_parse_commit(the_repository, item)
99#endif
100
Jeff King7059dcc2013-10-24 08:52:36101void parse_commit_or_die(struct commit *item);
Daniel Barkalow6eb8ae02005-04-18 18:39:48102
Stefan Beller65ea9d42018-06-29 01:22:15103struct buffer_slab;
104struct buffer_slab *allocate_commit_buffer_slab(void);
105void free_commit_buffer_slab(struct buffer_slab *bs);
106
Jeff King0fb370d2014-06-12 22:05:37107/*
Jeff King66c28272014-06-10 21:40:14108 * Associate an object buffer with the commit. The ownership of the
109 * memory is handed over to the commit, and must be free()-able.
110 */
Stefan Beller1a40fc42018-06-29 01:22:16111void set_commit_buffer(struct repository *r, struct commit *, void *buffer, unsigned long size);
Jeff King66c28272014-06-10 21:40:14112
113/*
Jeff King152ff1c2014-06-10 21:40:39114 * Get any cached object buffer associated with the commit. Returns NULL
115 * if none. The resulting memory should not be freed.
116 */
Stefan Beller4ff7e5c2018-06-29 01:22:17117const void *get_cached_commit_buffer(struct repository *, const struct commit *, unsigned long *size);
Jeff King152ff1c2014-06-10 21:40:39118
119/*
120 * Get the commit's object contents, either from cache or by reading the object
121 * from disk. The resulting memory should not be modified, and must be given
122 * to unuse_commit_buffer when the caller is done.
123 */
Stefan Beller07de3fd2018-11-14 00:12:57124const void *repo_get_commit_buffer(struct repository *r,
125 const struct commit *,
126 unsigned long *size);
127#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
128#define get_commit_buffer(c, s) repo_get_commit_buffer(the_repository, c, s)
129#endif
Jeff King152ff1c2014-06-10 21:40:39130
131/*
Elijah Newren15beaaa2019-11-05 17:07:23132 * Tell the commit subsystem that we are done with a particular commit buffer.
Jeff King152ff1c2014-06-10 21:40:39133 * The commit and buffer should be the input and return value, respectively,
134 * from an earlier call to get_commit_buffer. The buffer may or may not be
135 * freed by this call; callers should not access the memory afterwards.
136 */
Stefan Beller70315372018-11-14 00:12:58137void repo_unuse_commit_buffer(struct repository *r,
138 const struct commit *,
139 const void *buffer);
140#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
141#define unuse_commit_buffer(c, b) repo_unuse_commit_buffer(the_repository, c, b)
142#endif
Jeff King152ff1c2014-06-10 21:40:39143
144/*
Jeff King0fb370d2014-06-12 22:05:37145 * Free any cached object buffer associated with the commit.
146 */
Stefan Beller6a7895f2018-12-15 00:09:40147void free_commit_buffer(struct parsed_object_pool *pool, struct commit *);
Jeff King0fb370d2014-06-12 22:05:37148
Nguyễn Thái Ngọc Duy301b8c72019-04-16 09:33:19149struct tree *repo_get_commit_tree(struct repository *, const struct commit *);
150#define get_commit_tree(c) repo_get_commit_tree(the_repository, c)
Derrick Stolee5bb03de2018-04-06 19:09:34151struct object_id *get_commit_tree_oid(const struct commit *);
152
Jeff King0fb370d2014-06-12 22:05:37153/*
Stefan Beller14ba97f2018-05-15 21:48:42154 * Release memory related to a commit, including the parent list and
155 * any cached object buffer.
156 */
Stefan Beller6a7895f2018-12-15 00:09:40157void release_commit_memory(struct parsed_object_pool *pool, struct commit *c);
Stefan Beller14ba97f2018-05-15 21:48:42158
159/*
Jeff King0fb370d2014-06-12 22:05:37160 * Disassociate any cached object buffer from the commit, but do not free it.
161 * The buffer (or NULL, if none) is returned.
162 */
Jeff King8597ea32014-06-10 21:44:13163const void *detach_commit_buffer(struct commit *, unsigned long *sizep);
Jeff King0fb370d2014-06-12 22:05:37164
Christian Couder11af2aa2010-07-22 13:18:30165/* Find beginning and length of commit subject. */
166int find_commit_subject(const char *commit_buffer, const char **subject);
167
Thiago Farina47e44ed2010-11-27 01:58:14168struct commit_list *commit_list_insert(struct commit *item,
169 struct commit_list **list);
René Scharfe89b5f1d2012-04-25 20:35:27170struct commit_list **commit_list_append(struct commit *commit,
171 struct commit_list **next);
Miklos Vajna65319472008-06-27 16:21:55172unsigned commit_list_count(const struct commit_list *l);
Thiago Farina47e44ed2010-11-27 01:58:14173struct commit_list *commit_list_insert_by_date(struct commit *item,
174 struct commit_list **list);
175void commit_list_sort_by_date(struct commit_list **list);
Daniel Barkalowdd97f852005-04-24 01:47:23176
Thomas Rast53d00b32013-07-31 20:13:20177/* Shallow copy of the input list */
178struct commit_list *copy_commit_list(struct commit_list *list);
179
Daniel Barkalow6eb8ae02005-04-18 18:39:48180void free_commit_list(struct commit_list *list);
181
René Scharfe6d167fd2017-03-01 11:37:07182struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
183
Denton Liu55454422019-04-29 08:28:14184int has_non_ascii(const char *text);
185const char *logmsg_reencode(const struct commit *commit,
Denton Liuad6dad02019-04-29 08:28:23186 char **commit_encoding,
187 const char *output_encoding);
Stefan Beller424510e2018-11-14 00:12:59188const char *repo_logmsg_reencode(struct repository *r,
189 const struct commit *commit,
190 char **commit_encoding,
191 const char *output_encoding);
192#ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
193#define logmsg_reencode(c, enc, out) repo_logmsg_reencode(the_repository, c, enc, out)
194#endif
195
Denton Liu55454422019-04-29 08:28:14196const char *skip_blank_lines(const char *msg);
Linus Torvaldse3bc7a32005-06-01 15:34:23197
Daniel Barkalowdd97f852005-04-24 01:47:23198/** Removes the first commit from a list sorted by date, and adds all
199 * of its parents.
200 **/
Junio C Hamanoa6080a02007-06-07 07:04:01201struct commit *pop_most_recent_commit(struct commit_list **list,
Daniel Barkalow58e28af2005-04-24 03:29:22202 unsigned int mark);
Daniel Barkalowdd97f852005-04-24 01:47:23203
jon@blackcubes.dyndns.orga3437b82005-06-06 15:39:40204struct commit *pop_commit(struct commit_list **stack);
205
Junio C Hamanof8f9c732006-01-08 02:52:42206void clear_commit_marks(struct commit *commit, unsigned int mark);
Junio C Hamanoe895cb52013-03-05 19:42:20207void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
Junio C Hamanof8f9c732006-01-08 02:52:42208
Junio C Hamano08f704f2013-06-06 23:07:14209
210enum rev_sort_order {
211 REV_SORT_IN_GRAPH_ORDER = 0,
Junio C Hamano81c6b382013-06-07 17:35:54212 REV_SORT_BY_COMMIT_DATE,
213 REV_SORT_BY_AUTHOR_DATE
Junio C Hamano08f704f2013-06-06 23:07:14214};
215
Jon Seymourab580ac2005-07-06 16:39:34216/*
217 * Performs an in-place topological sort of list supplied.
218 *
Jon Seymourab580ac2005-07-06 16:39:34219 * invariant of resulting list is:
220 * a reachable from b => ord(b) < ord(a)
Junio C Hamano08f704f2013-06-06 23:07:14221 * sort_order further specifies:
222 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
223 * chain together.
224 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
Jon Seymourab580ac2005-07-06 16:39:34225 */
Junio C Hamano08f704f2013-06-06 23:07:14226void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
Junio C Hamano5040f172006-04-07 06:58:51227
228struct commit_graft {
brian m. carlson7683e2e2015-03-13 23:39:34229 struct object_id oid;
Johannes Schindelined09aef2006-10-30 19:09:06230 int nr_parent; /* < 0 if shallow commit */
brian m. carlson7683e2e2015-03-13 23:39:34231 struct object_id parent[FLEX_ARRAY]; /* more */
Junio C Hamano5040f172006-04-07 06:58:51232};
Nguyễn Thái Ngọc Duy09d46642011-08-18 12:29:35233typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
Junio C Hamano5040f172006-04-07 06:58:51234
Patryk Obara9a934032017-08-18 18:33:12235struct commit_graft *read_graft_line(struct strbuf *line);
Taylor Blau183df642020-04-30 21:11:28236/* commit_graft_pos returns an index into r->parsed_objects->grafts. */
237int commit_graft_pos(struct repository *r, const unsigned char *sha1);
Brandon Williamsa3b78e82018-05-17 22:51:48238int register_commit_graft(struct repository *r, struct commit_graft *, int);
Derrick Stolee20fd6d52018-08-20 18:24:30239void prepare_commit_graft(struct repository *r);
Stefan Bellerb9dbddf2018-05-17 22:51:54240struct commit_graft *lookup_commit_graft(struct repository *r, const struct object_id *oid);
Junio C Hamano5040f172006-04-07 06:58:51241
Pratik Karki103148a2018-09-04 22:00:08242struct commit *get_fork_point(const char *refname, struct commit *commit);
243
Stefano Lattarini41ccfdd2013-04-11 22:36:10244/* largest positive number a signed 32-bit integer can contain */
Nguyễn Thái Ngọc Duy4dcb1672013-01-11 09:05:46245#define INFINITE_DEPTH 0x7fffffff
246
brian m. carlson910650d2017-03-31 01:40:00247struct oid_array;
Nguyễn Thái Ngọc Duy58babff2013-12-05 13:02:35248struct ref;
Denton Liu55454422019-04-29 08:28:14249int for_each_commit_graft(each_commit_graft_fn, void *);
Daniel Barkalow6eb8ae02005-04-18 18:39:48250
Jeff Kinge885a842020-09-30 12:28:18251int interactive_add(const char **argv, const char *prefix, int patch);
Denton Liu55454422019-04-29 08:28:14252int run_add_interactive(const char *revision, const char *patch_mode,
Denton Liuad6dad02019-04-29 08:28:23253 const struct pathspec *pathspec);
Kristian Høgsberg58680162007-09-18 00:06:44254
Junio C Hamano5231c632011-11-08 00:21:32255struct commit_extra_header {
256 struct commit_extra_header *next;
257 char *key;
258 char *value;
259 size_t len;
260};
261
Denton Liu55454422019-04-29 08:28:14262void append_merge_tag_headers(struct commit_list *parents,
Denton Liuad6dad02019-04-29 08:28:23263 struct commit_extra_header ***tail);
Junio C Hamano5231c632011-11-08 00:21:32264
Denton Liu55454422019-04-29 08:28:14265int commit_tree(const char *msg, size_t msg_len,
Denton Liuad6dad02019-04-29 08:28:23266 const struct object_id *tree,
267 struct commit_list *parents, struct object_id *ret,
268 const char *author, const char *sign_commit);
Junio C Hamano5231c632011-11-08 00:21:32269
Denton Liu55454422019-04-29 08:28:14270int commit_tree_extended(const char *msg, size_t msg_len,
Denton Liuad6dad02019-04-29 08:28:23271 const struct object_id *tree,
Phillip Woode8cbe212020-08-17 17:40:01272 struct commit_list *parents, struct object_id *ret,
273 const char *author, const char *committer,
274 const char *sign_commit, struct commit_extra_header *);
Junio C Hamano5231c632011-11-08 00:21:32275
Denton Liu55454422019-04-29 08:28:14276struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
Junio C Hamanoed7a42a2011-11-08 23:38:07277
Denton Liu55454422019-04-29 08:28:14278void free_commit_extra_headers(struct commit_extra_header *extra);
Jeff King40d52ff2010-04-02 00:05:23279
Jeff Kingfe6eb7f2014-08-27 07:56:01280/*
281 * Search the commit object contents given by "msg" for the header "key".
282 * Returns a pointer to the start of the header contents, or NULL. The length
283 * of the header, up to the first newline, is returned via out_len.
284 *
285 * Note that some headers (like mergetag) may be multi-line. It is the caller's
286 * responsibility to parse further in this case!
287 */
Denton Liu55454422019-04-29 08:28:14288const char *find_commit_header(const char *msg, const char *key,
Denton Liuad6dad02019-04-29 08:28:23289 size_t *out_len);
Jeff Kingfe6eb7f2014-08-27 07:56:01290
Christian Couder8c384582014-11-09 09:23:41291/* Find the end of the log message, the right place for a new trailer. */
Denton Liu55454422019-04-29 08:28:14292size_t ignore_non_trailer(const char *buf, size_t len);
Christian Couder8c384582014-11-09 09:23:41293
Johannes Schindelinfef461e2018-04-25 09:54:04294typedef int (*each_mergetag_fn)(struct commit *commit, struct commit_extra_header *extra,
Denton Liuad6dad02019-04-29 08:28:23295 void *cb_data);
Christian Couder063da622014-07-07 06:35:37296
Denton Liu55454422019-04-29 08:28:14297int for_each_mergetag(each_mergetag_fn fn, struct commit *commit, void *data);
Christian Couder063da622014-07-07 06:35:37298
Junio C Hamanoae8e4c92011-11-07 21:26:22299struct merge_remote_desc {
300 struct object *obj; /* the named object, could be a tag */
René Scharfe5447a762016-08-13 12:21:27301 char name[FLEX_ARRAY];
Junio C Hamanoae8e4c92011-11-07 21:26:22302};
Denton Liu55454422019-04-29 08:28:14303struct merge_remote_desc *merge_remote_util(struct commit *);
304void set_merge_remote_desc(struct commit *commit,
Denton Liuad6dad02019-04-29 08:28:23305 const char *name, struct object *obj);
Junio C Hamanoae8e4c92011-11-07 21:26:22306
307/*
308 * Given "name" from the command line to merge, find the commit object
309 * and return it, while storing merge_remote_desc in its ->util field,
310 * to allow callers to tell if we are told to merge a tag.
311 */
312struct commit *get_merge_parent(const char *name);
313
Denton Liu55454422019-04-29 08:28:14314int parse_signed_commit(const struct commit *commit,
Denton Liuad6dad02019-04-29 08:28:23315 struct strbuf *message, struct strbuf *signature);
Denton Liu55454422019-04-29 08:28:14316int remove_signature(struct strbuf *buf);
Christian Couder0b05ab62014-07-19 15:01:12317
Sebastian Götteffb6d7d2013-03-31 16:00:14318/*
Sebastian Götteeb307ae2013-03-31 16:02:46319 * Check the signature of the given commit. The result of the check is stored
320 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
321 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
322 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
323 * sig->signer and sig->key.
Sebastian Götteffb6d7d2013-03-31 16:00:14324 */
Denton Liu55454422019-04-29 08:28:14325int check_commit_signature(const struct commit *commit, struct signature_check *sigc);
Sebastian Götteffb6d7d2013-03-31 16:00:14326
Derrick Stolee5284fc52018-11-01 13:46:21327/* record author-date for each commit object */
328struct author_date_slab;
329void record_author_date(struct author_date_slab *author_date,
330 struct commit *commit);
331
332int compare_commits_by_author_date(const void *a_, const void *b_, void *unused);
Junio C Hamano6d2035e2018-11-18 09:23:54333
Jeff Kingedc4d472018-11-06 07:50:17334/*
335 * Verify a single commit with check_commit_signature() and die() if it is not
336 * a good signature. This isn't really suitable for general use, but is a
337 * helper to implement consistent logic for pull/merge --verify-signatures.
Hans Jerry Illikainen54887b42019-12-27 13:55:57338 *
339 * The check_trust parameter is meant for backward-compatibility. The GPG
340 * interface verifies key trust with a default trust level that is below the
341 * default trust level for merge operations. Its value should be non-zero if
342 * the user hasn't set a minimum trust level explicitly in their configuration.
343 *
344 * If the user has set a minimum trust level, then that value should be obeyed
345 * and check_trust should be zero, even if the configured trust level is below
346 * the default trust level for merges.
Jeff Kingedc4d472018-11-06 07:50:17347 */
Hans Jerry Illikainen54887b42019-12-27 13:55:57348void verify_merge_signature(struct commit *commit, int verbose,
349 int check_trust);
Jeff Kingedc4d472018-11-06 07:50:17350
Jeff King727377f2013-07-02 06:21:48351int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
Derrick Stolee3afc6792018-05-01 12:47:11352int compare_commits_by_gen_then_commit_date(const void *a_, const void *b_, void *unused);
Jeff King727377f2013-07-02 06:21:48353
Benoit Pierre15048f82014-03-18 10:00:53354LAST_ARG_MUST_BE_NULL
Denton Liub199d712019-04-29 08:28:20355int run_commit_hook(int editor_is_used, const char *index_file, const char *name, ...);
Benoit Pierre15048f82014-03-18 10:00:53356
Daniel Barkalow6eb8ae02005-04-18 18:39:48357#endif /* COMMIT_H */