Documentation: Split description of pretty formats of commit log
[git/repo.git] / revision.h
blob2845167746ce4632894fce88e840df60513933aa
1 #ifndef REVISION_H
2 #define REVISION_H
4 #define SEEN (1u<<0)
5 #define UNINTERESTING (1u<<1)
6 #define TREECHANGE (1u<<2)
7 #define SHOWN (1u<<3)
8 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
9 #define BOUNDARY (1u<<5)
10 #define CHILD_SHOWN (1u<<6)
11 #define ADDED (1u<<7) /* Parents already parsed and added? */
12 #define SYMMETRIC_LEFT (1u<<8)
14 struct rev_info;
15 struct log_info;
17 typedef void (prune_fn_t)(struct rev_info *revs, struct commit *commit);
19 struct rev_info {
20 /* Starting list */
21 struct commit_list *commits;
22 struct object_array pending;
24 /* Parents of shown commits */
25 struct object_array boundary_commits;
27 /* Basic information */
28 const char *prefix;
29 void *prune_data;
30 prune_fn_t *prune_fn;
32 /* Traversal flags */
33 unsigned int dense:1,
34 no_merges:1,
35 no_walk:1,
36 remove_empty_trees:1,
37 simplify_history:1,
38 lifo:1,
39 topo_order:1,
40 tag_objects:1,
41 tree_objects:1,
42 blob_objects:1,
43 edge_hint:1,
44 limited:1,
45 unpacked:1, /* see also ignore_packed below */
46 boundary:2,
47 left_right:1,
48 parents:1,
49 reverse:1,
50 cherry_pick:1,
51 first_parent_only:1;
53 /* Diff flags */
54 unsigned int diff:1,
55 full_diff:1,
56 show_root_diff:1,
57 no_commit_id:1,
58 verbose_header:1,
59 ignore_merges:1,
60 combine_merges:1,
61 dense_combined_merges:1,
62 always_show_header:1;
64 /* Format info */
65 unsigned int shown_one:1,
66 abbrev_commit:1;
67 enum date_mode date_mode;
69 const char **ignore_packed; /* pretend objects in these are unpacked */
70 int num_ignore_packed;
72 unsigned int abbrev;
73 enum cmit_fmt commit_format;
74 struct log_info *loginfo;
75 int nr, total;
76 const char *mime_boundary;
77 const char *message_id;
78 const char *ref_message_id;
79 const char *add_signoff;
80 const char *extra_headers;
81 const char *log_reencode;
82 const char *subject_prefix;
83 int no_inline;
85 /* Filter by commit log message */
86 struct grep_opt *grep_filter;
88 /* special limits */
89 int skip_count;
90 int max_count;
91 unsigned long max_age;
92 unsigned long min_age;
94 /* diff info for patches and for paths limiting */
95 struct diff_options diffopt;
96 struct diff_options pruning;
98 topo_sort_set_fn_t topo_setter;
99 topo_sort_get_fn_t topo_getter;
101 struct reflog_walk_info *reflog_info;
104 #define REV_TREE_SAME 0
105 #define REV_TREE_NEW 1
106 #define REV_TREE_DIFFERENT 2
108 /* revision.c */
109 extern int rev_same_tree_as_empty(struct rev_info *, struct tree *t1);
110 extern int rev_compare_tree(struct rev_info *, struct tree *t1, struct tree *t2);
112 extern void init_revisions(struct rev_info *revs, const char *prefix);
113 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
114 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
116 extern int prepare_revision_walk(struct rev_info *revs);
117 extern struct commit *get_revision(struct rev_info *revs);
119 extern void mark_parents_uninteresting(struct commit *commit);
120 extern void mark_tree_uninteresting(struct tree *tree);
122 struct name_path {
123 struct name_path *up;
124 int elem_len;
125 const char *elem;
128 extern void add_object(struct object *obj,
129 struct object_array *p,
130 struct name_path *path,
131 const char *name);
133 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
134 extern void add_pending_object_with_mode(struct rev_info *revs, struct object *obj, const char *name, unsigned mode);
136 #endif