Change git-gc documentation to reflect gc.packrefs implementation.
[git.git] / commit.h
blob10e2b5d4cfdc7ac129ead711421ccc51d2667f02
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
6 #include "strbuf.h"
7 #include "decorate.h"
9 struct commit_list {
10 struct commit *item;
11 struct commit_list *next;
14 struct commit {
15 struct object object;
16 void *util;
17 unsigned int indegree;
18 unsigned long date;
19 struct commit_list *parents;
20 struct tree *tree;
21 char *buffer;
24 extern int save_commit_buffer;
25 extern const char *commit_type;
27 /* While we can decorate any object with a name, it's only used for commits.. */
28 extern struct decoration name_decoration;
29 struct name_decoration {
30 struct name_decoration *next;
31 char name[1];
34 struct commit *lookup_commit(const unsigned char *sha1);
35 struct commit *lookup_commit_reference(const unsigned char *sha1);
36 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
37 int quiet);
39 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
41 int parse_commit(struct commit *item);
43 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
44 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
46 void free_commit_list(struct commit_list *list);
48 void sort_by_date(struct commit_list **list);
50 /* Commit formats */
51 enum cmit_fmt {
52 CMIT_FMT_RAW,
53 CMIT_FMT_MEDIUM,
54 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
55 CMIT_FMT_SHORT,
56 CMIT_FMT_FULL,
57 CMIT_FMT_FULLER,
58 CMIT_FMT_ONELINE,
59 CMIT_FMT_EMAIL,
60 CMIT_FMT_USERFORMAT,
62 CMIT_FMT_UNSPECIFIED,
65 extern int non_ascii(int);
66 extern enum cmit_fmt get_commit_format(const char *arg);
67 extern void format_commit_message(const struct commit *commit,
68 const void *format, struct strbuf *sb);
69 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
70 struct strbuf *,
71 int abbrev, const char *subject,
72 const char *after_subject, enum date_mode,
73 int non_ascii_present);
75 /** Removes the first commit from a list sorted by date, and adds all
76 * of its parents.
77 **/
78 struct commit *pop_most_recent_commit(struct commit_list **list,
79 unsigned int mark);
81 struct commit *pop_commit(struct commit_list **stack);
83 void clear_commit_marks(struct commit *commit, unsigned int mark);
86 * Performs an in-place topological sort of list supplied.
88 * invariant of resulting list is:
89 * a reachable from b => ord(b) < ord(a)
90 * in addition, when lifo == 0, commits on parallel tracks are
91 * sorted in the dates order.
93 void sort_in_topological_order(struct commit_list ** list, int lifo);
95 struct commit_graft {
96 unsigned char sha1[20];
97 int nr_parent; /* < 0 if shallow commit */
98 unsigned char parent[FLEX_ARRAY][20]; /* more */
101 struct commit_graft *read_graft_line(char *buf, int len);
102 int register_commit_graft(struct commit_graft *, int);
103 int read_graft_file(const char *graft_file);
105 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
107 extern int register_shallow(const unsigned char *sha1);
108 extern int unregister_shallow(const unsigned char *sha1);
109 extern int write_shallow_commits(int fd, int use_pack_protocol);
110 extern int is_repository_shallow(void);
111 extern struct commit_list *get_shallow_commits(struct object_array *heads,
112 int depth, int shallow_flag, int not_shallow_flag);
114 int in_merge_bases(struct commit *, struct commit **, int);
116 extern int interactive_add(int argc, const char **argv, const char *prefix);
117 extern int rerere(void);
119 static inline int single_parent(struct commit *commit)
121 return commit->parents && !commit->parents->next;
124 #endif /* COMMIT_H */