Documentation: git fmt-merge-msg does not have to be a script
[git/jnareb-git/bp-gitweb.git] / revision.h
blob9d0dddbcbc981c60fd1348cdf257c67fb9ee5f84
1 #ifndef REVISION_H
2 #define REVISION_H
4 #include "parse-options.h"
5 #include "grep.h"
7 #define SEEN (1u<<0)
8 #define UNINTERESTING (1u<<1)
9 #define TREESAME (1u<<2)
10 #define SHOWN (1u<<3)
11 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
12 #define BOUNDARY (1u<<5)
13 #define CHILD_SHOWN (1u<<6)
14 #define ADDED (1u<<7) /* Parents already parsed and added? */
15 #define SYMMETRIC_LEFT (1u<<8)
16 #define ALL_REV_FLAGS ((1u<<9)-1)
18 #define DECORATE_SHORT_REFS 1
19 #define DECORATE_FULL_REFS 2
21 struct rev_info;
22 struct log_info;
24 struct rev_info {
25 /* Starting list */
26 struct commit_list *commits;
27 struct object_array pending;
29 /* Parents of shown commits */
30 struct object_array boundary_commits;
32 /* Basic information */
33 const char *prefix;
34 const char *def;
35 void *prune_data;
36 unsigned int early_output;
38 /* Traversal flags */
39 unsigned int dense:1,
40 prune:1,
41 no_merges:1,
42 merges_only:1,
43 no_walk:1,
44 show_all:1,
45 remove_empty_trees:1,
46 simplify_history:1,
47 lifo:1,
48 topo_order:1,
49 simplify_merges:1,
50 simplify_by_decoration:1,
51 tag_objects:1,
52 tree_objects:1,
53 blob_objects:1,
54 edge_hint:1,
55 limited:1,
56 unpacked:1,
57 boundary:2,
58 left_right:1,
59 rewrite_parents:1,
60 print_parents:1,
61 show_source:1,
62 show_decorations:1,
63 reverse:1,
64 reverse_output_stage:1,
65 cherry_pick:1,
66 first_parent_only:1;
68 /* Diff flags */
69 unsigned int diff:1,
70 full_diff:1,
71 show_root_diff:1,
72 no_commit_id:1,
73 verbose_header:1,
74 ignore_merges:1,
75 combine_merges:1,
76 dense_combined_merges:1,
77 always_show_header:1;
79 /* Format info */
80 unsigned int shown_one:1,
81 show_merge:1,
82 abbrev_commit:1,
83 use_terminator:1,
84 missing_newline:1;
85 enum date_mode date_mode;
87 unsigned int abbrev;
88 enum cmit_fmt commit_format;
89 struct log_info *loginfo;
90 int nr, total;
91 const char *mime_boundary;
92 const char *patch_suffix;
93 int numbered_files;
94 char *message_id;
95 struct string_list *ref_message_ids;
96 const char *add_signoff;
97 const char *extra_headers;
98 const char *log_reencode;
99 const char *subject_prefix;
100 int no_inline;
101 int show_log_size;
103 /* Filter by commit log message */
104 struct grep_opt grep_filter;
106 /* Display history graph */
107 struct git_graph *graph;
109 /* special limits */
110 int skip_count;
111 int max_count;
112 unsigned long max_age;
113 unsigned long min_age;
115 /* diff info for patches and for paths limiting */
116 struct diff_options diffopt;
117 struct diff_options pruning;
119 struct reflog_walk_info *reflog_info;
120 struct decoration children;
121 struct decoration merge_simplification;
124 #define REV_TREE_SAME 0
125 #define REV_TREE_NEW 1 /* Only new files */
126 #define REV_TREE_OLD 2 /* Only files removed */
127 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
129 /* revision.c */
130 void read_revisions_from_stdin(struct rev_info *revs);
132 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
133 extern volatile show_early_output_fn_t show_early_output;
135 extern void init_revisions(struct rev_info *revs, const char *prefix);
136 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
137 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
138 const struct option *options,
139 const char * const usagestr[]);
140 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
142 extern int prepare_revision_walk(struct rev_info *revs);
143 extern struct commit *get_revision(struct rev_info *revs);
145 extern void mark_parents_uninteresting(struct commit *commit);
146 extern void mark_tree_uninteresting(struct tree *tree);
148 struct name_path {
149 struct name_path *up;
150 int elem_len;
151 const char *elem;
154 char *path_name(const struct name_path *path, const char *name);
156 extern void add_object(struct object *obj,
157 struct object_array *p,
158 struct name_path *path,
159 const char *name);
161 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
163 extern void add_head_to_pending(struct rev_info *);
165 enum commit_action {
166 commit_ignore,
167 commit_show,
168 commit_error
171 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
172 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
174 #endif