[PATCH] Add some documentation.
[git/gitweb.git] / commit.h
blob9dda2f045fc96a145081fab74ea84976227e9787
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);
24 struct commit *lookup_commit_reference_gently(const unsigned char *sha1,
25 int quiet);
27 int parse_commit_buffer(struct commit *item, void *buffer, unsigned long size);
29 int parse_commit(struct commit *item);
31 struct commit_list * commit_list_insert(struct commit *item, struct commit_list **list_p);
32 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
34 void free_commit_list(struct commit_list *list);
36 void sort_by_date(struct commit_list **list);
38 /* Commit formats */
39 enum cmit_fmt {
40 CMIT_FMT_RAW,
41 CMIT_FMT_MEDIUM,
42 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
43 CMIT_FMT_SHORT,
44 CMIT_FMT_FULL,
45 CMIT_FMT_ONELINE,
48 extern enum cmit_fmt get_commit_format(const char *arg);
49 extern unsigned long pretty_print_commit(enum cmit_fmt fmt, const char *msg, unsigned long len, char *buf, unsigned long space);
51 /** Removes the first commit from a list sorted by date, and adds all
52 * of its parents.
53 **/
54 struct commit *pop_most_recent_commit(struct commit_list **list,
55 unsigned int mark);
57 struct commit *pop_commit(struct commit_list **stack);
59 int count_parents(struct commit * commit);
62 * Performs an in-place topological sort of list supplied.
64 * Pre-conditions:
65 * all commits in input list and all parents of those
66 * commits must have object.util == NULL
68 * Post-conditions:
69 * invariant of resulting list is:
70 * a reachable from b => ord(b) < ord(a)
72 void sort_in_topological_order(struct commit_list ** list);
73 #endif /* COMMIT_H */