git-send-pack: documentation
[git/git-svn.git] / commit.h
blobc24ab210611815938f4d61f662f1c82e4959e61f
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 const char *commit_type;
22 struct commit *lookup_commit(const unsigned char *sha1);
23 struct commit *lookup_commit_reference(const unsigned char *sha1);
25 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
27 int parse_commit(struct commit *item);
29 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
30 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
32 void free_commit_list(struct commit_list *list);
34 void sort_by_date(struct commit_list **list);
36 /* Commit formats */
37 enum cmit_fmt {
38 CMIT_FMT_RAW,
39 CMIT_FMT_MEDIUM,
40 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
41 CMIT_FMT_SHORT,
42 CMIT_FMT_FULL,
45 extern enum cmit_fmt get_commit_format(const char *arg);
46 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const char *msg, unsigned long len, char *buf, unsigned long space);
48 /** Removes the first commit from a list sorted by date, and adds all
49 * of its parents.
50 **/
51 struct commit *pop_most_recent_commit(struct commit_list **list,
52 unsigned int mark);
54 struct commit *pop_commit(struct commit_list **stack);
56 int count_parents(struct commit * commit);
59 * Performs an in-place topological sort of list supplied.
61 * Pre-conditions:
62 * all commits in input list and all parents of those
63 * commits must have object.util == NULL
65 * Post-conditions:
66 * invariant of resulting list is:
67 * a reachable from b => ord(b) < ord(a)
69 void sort_in_topological_order(struct commit_list ** list);
70 #endif /* COMMIT_H */