git-branch: Documentation fixes
[git/mingw/4msysgit/kblees.git] / commit.h
blob9c4a244bd90cd96a461a6d6774106b0e6a11fe1e
1 #ifndef COMMIT_H
2 #define COMMIT_H
4 #include "object.h"
5 #include "tree.h"
7 struct commit_list {
8 struct commit *item;
9 struct commit_list *next;
12 struct commit {
13 struct object object;
14 unsigned long date;
15 struct commit_list *parents;
16 struct tree *tree;
17 char *buffer;
20 extern int save_commit_buffer;
21 extern const char *commit_type;
23 struct commit *lookup_commit(const unsigned char *sha1);
24 struct commit *lookup_commit_reference(const unsigned char *sha1);
25 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
26 int quiet);
28 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
30 int parse_commit(struct commit *item);
32 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
33 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
35 void free_commit_list(struct commit_list *list);
37 void sort_by_date(struct commit_list **list);
39 /* Commit formats */
40 enum cmit_fmt {
41 CMIT_FMT_RAW,
42 CMIT_FMT_MEDIUM,
43 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
44 CMIT_FMT_SHORT,
45 CMIT_FMT_FULL,
46 CMIT_FMT_FULLER,
47 CMIT_FMT_ONELINE,
50 extern enum cmit_fmt get_commit_format(const char *arg);
51 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const char *msg, unsigned long len, char *buf, unsigned long space);
53 /** Removes the first commit from a list sorted by date, and adds all
54 * of its parents.
55 **/
56 struct commit *pop_most_recent_commit(struct commit_list **list,
57 unsigned int mark);
59 struct commit *pop_commit(struct commit_list **stack);
61 void clear_commit_marks(struct commit *commit, unsigned int mark);
63 int count_parents(struct commit * commit);
66 * Performs an in-place topological sort of list supplied.
68 * Pre-conditions:
69 * all commits in input list and all parents of those
70 * commits must have object.util == NULL
72 * Post-conditions:
73 * invariant of resulting list is:
74 * a reachable from b => ord(b) < ord(a)
76 void sort_in_topological_order(struct commit_list ** list);
77 #endif /* COMMIT_H */