Make man page building quiet when DOCBOOK_XSL_172 is defined
[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"
6eb8ae00
DB
8
9struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
12};
13
14struct commit {
15 struct object object;
d3ff6f55 16 void *util;
23c17d4a 17 unsigned int indegree;
6eb8ae00
DB
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
bd1e17e2 21 char *buffer;
6eb8ae00
DB
22};
23
60ab26de 24extern int save_commit_buffer;
6eb8ae00
DB
25extern const char *commit_type;
26
ca135e7a
LT
27/* While we can decorate any object with a name, it's only used for commits.. */
28extern struct decoration name_decoration;
29struct name_decoration {
30 struct name_decoration *next;
31 char name[1];
32};
33
5d6ccf5c
JM
34struct commit *lookup_commit(const unsigned char *sha1);
35struct commit *lookup_commit_reference(const unsigned char *sha1);
f76412ed
JH
36struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
37 int quiet);
6eb8ae00 38
bd2c39f5
NP
39int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
40
6eb8ae00
DB
41int parse_commit(struct commit *item);
42
ac5155ef 43struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
f755494c 44struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
dd97f850 45
6eb8ae00
DB
46void free_commit_list(struct commit_list *list);
47
dd97f850
DB
48void sort_by_date(struct commit_list **list);
49
000182ea
LT
50/* Commit formats */
51enum cmit_fmt {
52 CMIT_FMT_RAW,
53 CMIT_FMT_MEDIUM,
54 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
9b66ec04
LT
55 CMIT_FMT_SHORT,
56 CMIT_FMT_FULL,
ff56fe1c 57 CMIT_FMT_FULLER,
d87449c5 58 CMIT_FMT_ONELINE,
3eefc189 59 CMIT_FMT_EMAIL,
e52a5de4 60 CMIT_FMT_USERFORMAT,
6b9c58f4
JH
61
62 CMIT_FMT_UNSPECIFIED,
000182ea
LT
63};
64
4593fb84 65extern int non_ascii(int);
9b66ec04 66extern enum cmit_fmt get_commit_format(const char *arg);
674d1727
PH
67extern void format_commit_message(const struct commit *commit,
68 const void *format, struct strbuf *sb);
69extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
70 struct strbuf *,
71 int abbrev, const char *subject,
4593fb84
JH
72 const char *after_subject, enum date_mode,
73 int non_ascii_present);
e3bc7a3b 74
dd97f850
DB
75/** Removes the first commit from a list sorted by date, and adds all
76 * of its parents.
77 **/
a6080a0a 78struct commit *pop_most_recent_commit(struct commit_list **list,
58e28af6 79 unsigned int mark);
dd97f850 80
a3437b8c
JS
81struct commit *pop_commit(struct commit_list **stack);
82
f8f9c73c
JH
83void clear_commit_marks(struct commit *commit, unsigned int mark);
84
ab580ace
JS
85/*
86 * Performs an in-place topological sort of list supplied.
87 *
ab580ace
JS
88 * invariant of resulting list is:
89 * a reachable from b => ord(b) < ord(a)
4c8725f1
JH
90 * in addition, when lifo == 0, commits on parallel tracks are
91 * sorted in the dates order.
ab580ace 92 */
4c8725f1 93void sort_in_topological_order(struct commit_list ** list, int lifo);
5040f17e
JH
94
95struct commit_graft {
96 unsigned char sha1[20];
ed09aef0 97 int nr_parent; /* < 0 if shallow commit */
5040f17e
JH
98 unsigned char parent[FLEX_ARRAY][20]; /* more */
99};
100
101struct commit_graft *read_graft_line(char *buf, int len);
102int register_commit_graft(struct commit_graft *, int);
103int read_graft_file(const char *graft_file);
104
c0fa8255 105extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
7c6f8aaf 106
ed09aef0 107extern int register_shallow(const unsigned char *sha1);
f53514bc 108extern int unregister_shallow(const unsigned char *sha1);
ed09aef0 109extern int write_shallow_commits(int fd, int use_pack_protocol);
f43117a6 110extern int is_repository_shallow(void);
ed09aef0 111extern struct commit_list *get_shallow_commits(struct object_array *heads,
f53514bc 112 int depth, int shallow_flag, int not_shallow_flag);
ed09aef0 113
03840fc3 114int in_merge_bases(struct commit *, struct commit **, int);
58680165 115
3f061887 116extern int interactive_add(int argc, const char **argv, const char *prefix);
d8b7db0a 117extern int rerere(void);
58680165 118
53b2c823
LT
119static inline int single_parent(struct commit *commit)
120{
121 return commit->parents && !commit->parents->next;
122}
123
6eb8ae00 124#endif /* COMMIT_H */