doc: describe git svn init --ignore-refs
[git/git-svn.git] / revision.h
bloba91dd3d5d97d9e609d770f418cb9f804b28e752d
1 #ifndef REVISION_H
2 #define REVISION_H
4 #include "parse-options.h"
5 #include "grep.h"
6 #include "notes.h"
7 #include "commit.h"
8 #include "diff.h"
10 /* Remember to update object flag allocation in object.h */
11 #define SEEN (1u<<0)
12 #define UNINTERESTING (1u<<1)
13 #define TREESAME (1u<<2)
14 #define SHOWN (1u<<3)
15 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
16 #define BOUNDARY (1u<<5)
17 #define CHILD_SHOWN (1u<<6)
18 #define ADDED (1u<<7) /* Parents already parsed and added? */
19 #define SYMMETRIC_LEFT (1u<<8)
20 #define PATCHSAME (1u<<9)
21 #define BOTTOM (1u<<10)
22 #define TRACK_LINEAR (1u<<26)
23 #define ALL_REV_FLAGS (((1u<<11)-1) | TRACK_LINEAR)
25 #define DECORATE_SHORT_REFS 1
26 #define DECORATE_FULL_REFS 2
28 struct rev_info;
29 struct log_info;
30 struct string_list;
31 struct saved_parents;
33 struct rev_cmdline_info {
34 unsigned int nr;
35 unsigned int alloc;
36 struct rev_cmdline_entry {
37 struct object *item;
38 const char *name;
39 enum {
40 REV_CMD_REF,
41 REV_CMD_PARENTS_ONLY,
42 REV_CMD_LEFT,
43 REV_CMD_RIGHT,
44 REV_CMD_MERGE_BASE,
45 REV_CMD_REV
46 } whence;
47 unsigned flags;
48 } *rev;
51 #define REVISION_WALK_WALK 0
52 #define REVISION_WALK_NO_WALK_SORTED 1
53 #define REVISION_WALK_NO_WALK_UNSORTED 2
55 struct rev_info {
56 /* Starting list */
57 struct commit_list *commits;
58 struct object_array pending;
60 /* Parents of shown commits */
61 struct object_array boundary_commits;
63 /* The end-points specified by the end user */
64 struct rev_cmdline_info cmdline;
66 /* excluding from --branches, --refs, etc. expansion */
67 struct string_list *ref_excludes;
69 /* Basic information */
70 const char *prefix;
71 const char *def;
72 struct pathspec prune_data;
74 /* topo-sort */
75 enum rev_sort_order sort_order;
77 unsigned int early_output:1,
78 ignore_missing:1,
79 ignore_missing_links:1;
81 /* Traversal flags */
82 unsigned int dense:1,
83 prune:1,
84 no_walk:2,
85 show_all:1,
86 remove_empty_trees:1,
87 simplify_history:1,
88 topo_order:1,
89 simplify_merges:1,
90 simplify_by_decoration:1,
91 tag_objects:1,
92 tree_objects:1,
93 blob_objects:1,
94 verify_objects:1,
95 edge_hint:1,
96 edge_hint_aggressive:1,
97 limited:1,
98 unpacked:1,
99 boundary:2,
100 count:1,
101 left_right:1,
102 left_only:1,
103 right_only:1,
104 rewrite_parents:1,
105 print_parents:1,
106 show_source:1,
107 show_decorations:1,
108 reverse:1,
109 reverse_output_stage:1,
110 cherry_pick:1,
111 cherry_mark:1,
112 bisect:1,
113 ancestry_path:1,
114 first_parent_only:1,
115 line_level_traverse:1;
117 /* Diff flags */
118 unsigned int diff:1,
119 full_diff:1,
120 show_root_diff:1,
121 no_commit_id:1,
122 verbose_header:1,
123 ignore_merges:1,
124 combine_merges:1,
125 dense_combined_merges:1,
126 always_show_header:1;
128 /* Format info */
129 unsigned int shown_one:1,
130 shown_dashes:1,
131 show_merge:1,
132 show_notes:1,
133 show_notes_given:1,
134 show_signature:1,
135 pretty_given:1,
136 abbrev_commit:1,
137 abbrev_commit_given:1,
138 zero_commit:1,
139 use_terminator:1,
140 missing_newline:1,
141 date_mode_explicit:1,
142 preserve_subject:1;
143 unsigned int disable_stdin:1;
144 unsigned int leak_pending:1;
145 /* --show-linear-break */
146 unsigned int track_linear:1,
147 track_first_time:1,
148 linear:1;
150 struct date_mode date_mode;
151 int expand_tabs_in_log; /* unset if negative */
152 int expand_tabs_in_log_default;
154 unsigned int abbrev;
155 enum cmit_fmt commit_format;
156 struct log_info *loginfo;
157 int nr, total;
158 const char *mime_boundary;
159 const char *patch_suffix;
160 int numbered_files;
161 int reroll_count;
162 char *message_id;
163 struct ident_split from_ident;
164 struct string_list *ref_message_ids;
165 int add_signoff;
166 const char *extra_headers;
167 const char *log_reencode;
168 const char *subject_prefix;
169 int no_inline;
170 int show_log_size;
171 struct string_list *mailmap;
173 /* Filter by commit log message */
174 struct grep_opt grep_filter;
175 /* Negate the match of grep_filter */
176 int invert_grep;
178 /* Display history graph */
179 struct git_graph *graph;
181 /* special limits */
182 int skip_count;
183 int max_count;
184 timestamp_t max_age;
185 timestamp_t min_age;
186 int min_parents;
187 int max_parents;
188 int (*include_check)(struct commit *, void *);
189 void *include_check_data;
191 /* diff info for patches and for paths limiting */
192 struct diff_options diffopt;
193 struct diff_options pruning;
195 struct reflog_walk_info *reflog_info;
196 struct decoration children;
197 struct decoration merge_simplification;
198 struct decoration treesame;
200 /* notes-specific options: which refs to show */
201 struct display_notes_opt notes_opt;
203 /* commit counts */
204 int count_left;
205 int count_right;
206 int count_same;
208 /* line level range that we are chasing */
209 struct decoration line_log_data;
211 /* copies of the parent lists, for --full-diff display */
212 struct saved_parents *saved_parents_slab;
214 struct commit_list *previous_parents;
215 const char *break_bar;
218 extern int ref_excluded(struct string_list *, const char *path);
219 void clear_ref_exclusion(struct string_list **);
220 void add_ref_exclusion(struct string_list **, const char *exclude);
223 #define REV_TREE_SAME 0
224 #define REV_TREE_NEW 1 /* Only new files */
225 #define REV_TREE_OLD 2 /* Only files removed */
226 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
228 /* revision.c */
229 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
230 extern volatile show_early_output_fn_t show_early_output;
232 struct setup_revision_opt {
233 const char *def;
234 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
235 const char *submodule;
236 int assume_dashdash;
237 unsigned revarg_opt;
240 extern void init_revisions(struct rev_info *revs, const char *prefix);
241 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
242 struct setup_revision_opt *);
243 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
244 const struct option *options,
245 const char * const usagestr[]);
246 #define REVARG_CANNOT_BE_FILENAME 01
247 #define REVARG_COMMITTISH 02
248 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
249 int flags, unsigned revarg_opt);
251 extern void reset_revision_walk(void);
252 extern int prepare_revision_walk(struct rev_info *revs);
253 extern struct commit *get_revision(struct rev_info *revs);
254 extern char *get_revision_mark(const struct rev_info *revs,
255 const struct commit *commit);
256 extern void put_revision_mark(const struct rev_info *revs,
257 const struct commit *commit);
259 extern void mark_parents_uninteresting(struct commit *commit);
260 extern void mark_tree_uninteresting(struct tree *tree);
262 extern void show_object_with_name(FILE *, struct object *, const char *);
264 extern void add_pending_object(struct rev_info *revs,
265 struct object *obj, const char *name);
266 extern void add_pending_oid(struct rev_info *revs,
267 const char *name, const struct object_id *oid,
268 unsigned int flags);
270 extern void add_head_to_pending(struct rev_info *);
271 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
272 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
274 enum commit_action {
275 commit_ignore,
276 commit_show,
277 commit_error
280 extern enum commit_action get_commit_action(struct rev_info *revs,
281 struct commit *commit);
282 extern enum commit_action simplify_commit(struct rev_info *revs,
283 struct commit *commit);
285 enum rewrite_result {
286 rewrite_one_ok,
287 rewrite_one_noparents,
288 rewrite_one_error
291 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
293 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
294 rewrite_parent_fn_t rewrite_parent);
297 * The log machinery saves the original parent list so that
298 * get_saved_parents() can later tell what the real parents of the
299 * commits are, when commit->parents has been modified by history
300 * simpification.
302 * get_saved_parents() will transparently return commit->parents if
303 * history simplification is off.
305 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
307 #endif