commit.h: drop redundant comment
[git/git.git] / commit.h
CommitLineData
6eb8ae00
DB
1#ifndef COMMIT_H
2#define COMMIT_H
3
4#include "object.h"
5#include "tree.h"
674d1727 6#include "strbuf.h"
ca135e7a 7#include "decorate.h"
ffb6d7d5 8#include "gpg-interface.h"
a9080475 9#include "string-list.h"
6eb8ae00
DB
10
11struct commit_list {
12 struct commit *item;
13 struct commit_list *next;
14};
15
16struct commit {
17 struct object object;
d3ff6f55 18 void *util;
96c4f4a3 19 unsigned int index;
6eb8ae00
DB
20 unsigned long date;
21 struct commit_list *parents;
22 struct tree *tree;
bd1e17e2 23 char *buffer;
6eb8ae00
DB
24};
25
60ab26de 26extern int save_commit_buffer;
6eb8ae00
DB
27extern const char *commit_type;
28
ca135e7a
LT
29/* While we can decorate any object with a name, it's only used for commits.. */
30extern struct decoration name_decoration;
31struct name_decoration {
32 struct name_decoration *next;
eb3005e2 33 int type;
ca135e7a
LT
34 char name[1];
35};
36
5d6ccf5c
JM
37struct commit *lookup_commit(const unsigned char *sha1);
38struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
39struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
40 int quiet);
a6fa5992 41struct commit *lookup_commit_reference_by_name(const char *name);
6eb8ae00 42
baf18fc2
NTND
43/*
44 * Look up object named by "sha1", dereference tag as necessary,
45 * get a commit and return it. If "sha1" does not dereference to
46 * a commit, use ref_name to report an error and die.
47 */
48struct commit *lookup_commit_or_die(const unsigned char *sha1, const char *ref_name);
49
cf7b1cad 50int parse_commit_buffer(struct commit *item, const void *buffer, unsigned long size);
6eb8ae00
DB
51int parse_commit(struct commit *item);
52
11af2aae
CC
53/* Find beginning and length of commit subject. */
54int find_commit_subject(const char *commit_buffer, const char **subject);
55
47e44ed1
TF
56struct commit_list *commit_list_insert(struct commit *item,
57 struct commit_list **list);
89b5f1d9
RS
58struct commit_list **commit_list_append(struct commit *commit,
59 struct commit_list **next);
65319475 60unsigned commit_list_count(const struct commit_list *l);
47e44ed1
TF
61struct commit_list *commit_list_insert_by_date(struct commit *item,
62 struct commit_list **list);
63void commit_list_sort_by_date(struct commit_list **list);
dd97f850 64
6eb8ae00
DB
65void free_commit_list(struct commit_list *list);
66
000182ea
LT
67/* Commit formats */
68enum cmit_fmt {
69 CMIT_FMT_RAW,
70 CMIT_FMT_MEDIUM,
71 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
72 CMIT_FMT_SHORT,
73 CMIT_FMT_FULL,
ff56fe1c 74 CMIT_FMT_FULLER,
d87449c5 75 CMIT_FMT_ONELINE,
3eefc189 76 CMIT_FMT_EMAIL,
e52a5de4 77 CMIT_FMT_USERFORMAT,
6b9c58f4 78
4b05548f 79 CMIT_FMT_UNSPECIFIED
000182ea
LT
80};
81
9cba13ca 82struct pretty_print_context {
10f2fbff
JK
83 /*
84 * Callers should tweak these to change the behavior of pp_* functions.
85 */
6bf13944 86 enum cmit_fmt fmt;
dd2e794a
TR
87 int abbrev;
88 const char *subject;
89 const char *after_subject;
9553d2b2 90 int preserve_subject;
dd2e794a 91 enum date_mode date_mode;
f026c756 92 unsigned date_mode_explicit:1;
dd2e794a 93 int need_8bit_cte;
ddf333f6 94 char *notes_message;
8f8f5476 95 struct reflog_walk_info *reflog_info;
177b29dc 96 const char *output_encoding;
0e2913b0 97 struct string_list *mailmap;
30825178 98 int color;
a9080475 99 struct ident_split *from_ident;
10f2fbff
JK
100
101 /*
102 * Fields below here are manipulated internally by pp_* functions and
103 * should not be counted on by callers.
104 */
a9080475 105 struct string_list in_body_headers;
dd2e794a
TR
106};
107
5b163603
JG
108struct userformat_want {
109 unsigned notes:1;
110};
111
28e9cf65 112extern int has_non_ascii(const char *text);
4da45bef 113struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
177b29dc 114extern char *logmsg_reencode(const struct commit *commit,
5a10d236 115 char **commit_encoding,
177b29dc 116 const char *output_encoding);
dd0d388c 117extern void logmsg_free(char *msg, const struct commit *commit);
4da45bef 118extern void get_commit_format(const char *arg, struct rev_info *);
c8f1444d
RJ
119extern const char *format_subject(struct strbuf *sb, const char *msg,
120 const char *line_separator);
5b163603 121extern void userformat_find_requirements(const char *fmt, struct userformat_want *w);
674d1727 122extern void format_commit_message(const struct commit *commit,
7f98ebc8 123 const char *format, struct strbuf *sb,
dd2e794a 124 const struct pretty_print_context *context);
10f2fbff 125extern void pretty_print_commit(struct pretty_print_context *pp,
6bf13944
JK
126 const struct commit *commit,
127 struct strbuf *sb);
8b8a5374
JK
128extern void pp_commit_easy(enum cmit_fmt fmt, const struct commit *commit,
129 struct strbuf *sb);
10f2fbff 130void pp_user_info(struct pretty_print_context *pp,
6bf13944
JK
131 const char *what, struct strbuf *sb,
132 const char *line, const char *encoding);
10f2fbff 133void pp_title_line(struct pretty_print_context *pp,
b02bd65f
DB
134 const char **msg_p,
135 struct strbuf *sb,
b02bd65f 136 const char *encoding,
267123b4 137 int need_8bit_cte);
10f2fbff 138void pp_remainder(struct pretty_print_context *pp,
b02bd65f
DB
139 const char **msg_p,
140 struct strbuf *sb,
141 int indent);
142
e3bc7a3b 143
dd97f850
DB
144/** Removes the first commit from a list sorted by date, and adds all
145 * of its parents.
146 **/
a6080a0a 147struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 148 unsigned int mark);
dd97f850 149
a3437b8c
JS
150struct commit *pop_commit(struct commit_list **stack);
151
f8f9c73c 152void clear_commit_marks(struct commit *commit, unsigned int mark);
e895cb51 153void clear_commit_marks_many(int nr, struct commit **commit, unsigned int mark);
86a0a408 154void clear_commit_marks_for_object_array(struct object_array *a, unsigned mark);
f8f9c73c 155
08f704f2
JH
156
157enum rev_sort_order {
158 REV_SORT_IN_GRAPH_ORDER = 0,
81c6b38b
JH
159 REV_SORT_BY_COMMIT_DATE,
160 REV_SORT_BY_AUTHOR_DATE
08f704f2
JH
161};
162
ab580ace
JS
163/*
164 * Performs an in-place topological sort of list supplied.
165 *
ab580ace
JS
166 * invariant of resulting list is:
167 * a reachable from b => ord(b) < ord(a)
08f704f2
JH
168 * sort_order further specifies:
169 * REV_SORT_IN_GRAPH_ORDER: try to show a commit on a single-parent
170 * chain together.
171 * REV_SORT_BY_COMMIT_DATE: show eligible commits in committer-date order.
ab580ace 172 */
08f704f2 173void sort_in_topological_order(struct commit_list **, enum rev_sort_order);
5040f17e
JH
174
175struct commit_graft {
176 unsigned char sha1[20];
ed09aef0 177 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
178 unsigned char parent[FLEX_ARRAY][20]; /* more */
179};
09d46644 180typedef int (*each_commit_graft_fn)(const struct commit_graft *, void *);
5040f17e
JH
181
182struct commit_graft *read_graft_line(char *buf, int len);
183int register_commit_graft(struct commit_graft *, int);
45163382 184struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
5040f17e 185
c0fa8255 186extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
53eda89b 187extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
5240c9d7 188extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
7c6f8aaf 189
41ccfdd9 190/* largest positive number a signed 32-bit integer can contain */
4dcb167f
NTND
191#define INFINITE_DEPTH 0x7fffffff
192
ed09aef0 193extern int register_shallow(const unsigned char *sha1);
f53514bc 194extern int unregister_shallow(const unsigned char *sha1);
09d46644 195extern int for_each_commit_graft(each_commit_graft_fn, void *);
f43117a6 196extern int is_repository_shallow(void);
ed09aef0 197extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 198 int depth, int shallow_flag, int not_shallow_flag);
6035d6aa
NTND
199extern void check_shallow_file_for_update(void);
200extern void set_alternate_shallow_file(const char *path);
ed09aef0 201
7fcdb36e 202int is_descendant_of(struct commit *, struct commit_list *);
a20efee9 203int in_merge_bases(struct commit *, struct commit *);
4c4b27e8 204int in_merge_bases_many(struct commit *, int, struct commit **);
58680165 205
b4bd4668 206extern int interactive_add(int argc, const char **argv, const char *prefix, int patch);
46b5139c
TR
207extern int run_add_interactive(const char *revision, const char *patch_mode,
208 const char **pathspec);
58680165 209
53b2c823
LT
210static inline int single_parent(struct commit *commit)
211{
212 return commit->parents && !commit->parents->next;
213}
214
98cf9c3b
JH
215struct commit_list *reduce_heads(struct commit_list *heads);
216
5231c633
JH
217struct commit_extra_header {
218 struct commit_extra_header *next;
219 char *key;
220 char *value;
221 size_t len;
222};
223
224extern void append_merge_tag_headers(struct commit_list *parents,
225 struct commit_extra_header ***tail);
226
13f8b72d 227extern int commit_tree(const struct strbuf *msg, unsigned char *tree,
5231c633 228 struct commit_list *parents, unsigned char *ret,
ba3c69a9 229 const char *author, const char *sign_commit);
5231c633 230
f35ccd9b 231extern int commit_tree_extended(const struct strbuf *msg, unsigned char *tree,
5231c633 232 struct commit_list *parents, unsigned char *ret,
ba3c69a9 233 const char *author, const char *sign_commit,
5231c633
JH
234 struct commit_extra_header *);
235
c871a1d1 236extern struct commit_extra_header *read_commit_extra_headers(struct commit *, const char **);
ed7a42a0 237
5231c633 238extern void free_commit_extra_headers(struct commit_extra_header *extra);
40d52ff7 239
ae8e4c9c
JH
240struct merge_remote_desc {
241 struct object *obj; /* the named object, could be a tag */
242 const char *name;
243};
244#define merge_remote_util(commit) ((struct merge_remote_desc *)((commit)->util))
245
246/*
247 * Given "name" from the command line to merge, find the commit object
248 * and return it, while storing merge_remote_desc in its ->util field,
249 * to allow callers to tell if we are told to merge a tag.
250 */
251struct commit *get_merge_parent(const char *name);
252
0c37f1fc
JH
253extern int parse_signed_commit(const unsigned char *sha1,
254 struct strbuf *message, struct strbuf *signature);
efc7df45
NTND
255extern void print_commit_list(struct commit_list *list,
256 const char *format_cur,
257 const char *format_last);
258
ffb6d7d5 259/*
eb307ae7
SG
260 * Check the signature of the given commit. The result of the check is stored
261 * in sig->check_result, 'G' for a good signature, 'U' for a good signature
262 * from an untrusted signer, 'B' for a bad signature and 'N' for no signature
263 * at all. This may allocate memory for sig->gpg_output, sig->gpg_status,
264 * sig->signer and sig->key.
ffb6d7d5
SG
265 */
266extern void check_commit_signature(const struct commit* commit, struct signature_check *sigc);
267
727377ff
JK
268int compare_commits_by_commit_date(const void *a_, const void *b_, void *unused);
269
6eb8ae00 270#endif /* COMMIT_H */