Docs: send-email: Create logical groupings for --help text
[git/jrn.git] / commit.h
blobde15f4d715ded4d8fd4f882b44fd9a320e7cdb2e
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 unsigned commit_list_count(const struct commit_list *l);
45 struct commit_list * insert_by_date(struct commit *item, struct commit_list **list);
47 void free_commit_list(struct commit_list *list);
49 void sort_by_date(struct commit_list **list);
51 /* Commit formats */
52 enum cmit_fmt {
53 CMIT_FMT_RAW,
54 CMIT_FMT_MEDIUM,
55 CMIT_FMT_DEFAULT = CMIT_FMT_MEDIUM,
56 CMIT_FMT_SHORT,
57 CMIT_FMT_FULL,
58 CMIT_FMT_FULLER,
59 CMIT_FMT_ONELINE,
60 CMIT_FMT_EMAIL,
61 CMIT_FMT_USERFORMAT,
63 CMIT_FMT_UNSPECIFIED,
66 extern int non_ascii(int);
67 struct rev_info; /* in revision.h, it circularly uses enum cmit_fmt */
68 extern void get_commit_format(const char *arg, struct rev_info *);
69 extern void format_commit_message(const struct commit *commit,
70 const void *format, struct strbuf *sb,
71 enum date_mode dmode);
72 extern void pretty_print_commit(enum cmit_fmt fmt, const struct commit*,
73 struct strbuf *,
74 int abbrev, const char *subject,
75 const char *after_subject, enum date_mode,
76 int need_8bit_cte);
77 void pp_user_info(const char *what, enum cmit_fmt fmt, struct strbuf *sb,
78 const char *line, enum date_mode dmode,
79 const char *encoding);
80 void pp_title_line(enum cmit_fmt fmt,
81 const char **msg_p,
82 struct strbuf *sb,
83 const char *subject,
84 const char *after_subject,
85 const char *encoding,
86 int need_8bit_cte);
87 void pp_remainder(enum cmit_fmt fmt,
88 const char **msg_p,
89 struct strbuf *sb,
90 int indent);
93 /** Removes the first commit from a list sorted by date, and adds all
94 * of its parents.
95 **/
96 struct commit *pop_most_recent_commit(struct commit_list **list,
97 unsigned int mark);
99 struct commit *pop_commit(struct commit_list **stack);
101 void clear_commit_marks(struct commit *commit, unsigned int mark);
104 * Performs an in-place topological sort of list supplied.
106 * invariant of resulting list is:
107 * a reachable from b => ord(b) < ord(a)
108 * in addition, when lifo == 0, commits on parallel tracks are
109 * sorted in the dates order.
111 void sort_in_topological_order(struct commit_list ** list, int lifo);
113 struct commit_graft {
114 unsigned char sha1[20];
115 int nr_parent; /* < 0 if shallow commit */
116 unsigned char parent[FLEX_ARRAY][20]; /* more */
119 struct commit_graft *read_graft_line(char *buf, int len);
120 int register_commit_graft(struct commit_graft *, int);
121 int read_graft_file(const char *graft_file);
122 struct commit_graft *lookup_commit_graft(const unsigned char *sha1);
124 extern struct commit_list *get_merge_bases(struct commit *rev1, struct commit *rev2, int cleanup);
125 extern struct commit_list *get_merge_bases_many(struct commit *one, int n, struct commit **twos, int cleanup);
126 extern struct commit_list *get_octopus_merge_bases(struct commit_list *in);
128 extern int register_shallow(const unsigned char *sha1);
129 extern int unregister_shallow(const unsigned char *sha1);
130 extern int write_shallow_commits(int fd, int use_pack_protocol);
131 extern int is_repository_shallow(void);
132 extern struct commit_list *get_shallow_commits(struct object_array *heads,
133 int depth, int shallow_flag, int not_shallow_flag);
135 int in_merge_bases(struct commit *, struct commit **, int);
137 extern int interactive_add(int argc, const char **argv, const char *prefix);
139 static inline int single_parent(struct commit *commit)
141 return commit->parents && !commit->parents->next;
144 struct commit_list *reduce_heads(struct commit_list *heads);
146 #endif /* COMMIT_H */