Documentation: add missing article in rev-list-options.txt
[git/git.git] / revision.h
CommitLineData
ae563542
LT
1#ifndef REVISION_H
2#define REVISION_H
3
6b61ec05 4#include "parse-options.h"
0843acfd 5#include "grep.h"
894a9d33 6#include "notes.h"
08f704f2 7#include "commit.h"
19ecb564 8#include "diff.h"
6b61ec05 9
208acbfb 10/* Remember to update object flag allocation in object.h */
ae563542
LT
11#define SEEN (1u<<0)
12#define UNINTERESTING (1u<<1)
7dc0fe3b 13#define TREESAME (1u<<2)
765ac8ec 14#define SHOWN (1u<<3)
7ae0b0cb 15#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4 16#define BOUNDARY (1u<<5)
2b064697 17#define CHILD_SHOWN (1u<<6)
1b65a5aa 18#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2 19#define SYMMETRIC_LEFT (1u<<8)
adbbb31e 20#define PATCHSAME (1u<<9)
7f34a46f 21#define BOTTOM (1u<<10)
1b32dece
NTND
22#define TRACK_LINEAR (1u<<26)
23#define ALL_REV_FLAGS (((1u<<11)-1) | TRACK_LINEAR)
ae563542 24
33e7018c
LH
25#define DECORATE_SHORT_REFS 1
26#define DECORATE_FULL_REFS 2
27
8efdc326 28struct rev_info;
91539833 29struct log_info;
894a9d33 30struct string_list;
53d00b39 31struct saved_parents;
8efdc326 32
281eee47
JH
33struct 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,
a765499a 44 REV_CMD_MERGE_BASE,
281eee47
JH
45 REV_CMD_REV
46 } whence;
47 unsigned flags;
48 } *rev;
49};
50
ca92e59e
MZ
51#define REVISION_WALK_WALK 0
52#define REVISION_WALK_NO_WALK_SORTED 1
53#define REVISION_WALK_NO_WALK_UNSORTED 2
54
ae563542
LT
55struct rev_info {
56 /* Starting list */
57 struct commit_list *commits;
1f1e895f 58 struct object_array pending;
ae563542 59
86ab4906
JH
60 /* Parents of shown commits */
61 struct object_array boundary_commits;
62
281eee47
JH
63 /* The end-points specified by the end user */
64 struct rev_cmdline_info cmdline;
65
e7b432c5
JH
66 /* excluding from --branches, --refs, etc. expansion */
67 struct string_list *ref_excludes;
68
ae563542
LT
69 /* Basic information */
70 const char *prefix;
02e54220 71 const char *def;
afe069d1 72 struct pathspec prune_data;
08f704f2
JH
73
74 /* topo-sort */
75 enum rev_sort_order sort_order;
76
cc243c3c 77 unsigned int early_output:1,
2db1a43f
VM
78 ignore_missing:1,
79 ignore_missing_links:1;
cdcefbc9 80
ae563542
LT
81 /* Traversal flags */
82 unsigned int dense:1,
53b2c823 83 prune:1,
ca92e59e 84 no_walk:2,
3131b713 85 show_all:1,
ae563542 86 remove_empty_trees:1,
9202434c 87 simplify_history:1,
ae563542 88 topo_order:1,
6546b593 89 simplify_merges:1,
78892e32 90 simplify_by_decoration:1,
ae563542
LT
91 tag_objects:1,
92 tree_objects:1,
93 blob_objects:1,
5a48d240 94 verify_objects:1,
d9a83684
LT
95 edge_hint:1,
96 limited:1,
03a9683d 97 unpacked:1,
86ab4906 98 boundary:2,
f69c5018 99 count:1,
74bd9029 100 left_right:1,
60adf7d7
MG
101 left_only:1,
102 right_only:1,
885cf808
AS
103 rewrite_parents:1,
104 print_parents:1,
0f3a290b 105 show_source:1,
d467a525 106 show_decorations:1,
0053e902 107 reverse:1,
498bcd31 108 reverse_output_stage:1,
d7a17cad 109 cherry_pick:1,
adbbb31e 110 cherry_mark:1,
ad3f9a71 111 bisect:1,
ebdc94f3 112 ancestry_path:1,
12da1d1f
TR
113 first_parent_only:1,
114 line_level_traverse:1;
ae563542 115
cd2bdc53
LT
116 /* Diff flags */
117 unsigned int diff:1,
118 full_diff:1,
119 show_root_diff:1,
120 no_commit_id:1,
121 verbose_header:1,
122 ignore_merges:1,
123 combine_merges:1,
124 dense_combined_merges:1,
125 always_show_header:1;
126
127 /* Format info */
91539833 128 unsigned int shown_one:1,
bd1470b8 129 shown_dashes:1,
02e54220 130 show_merge:1,
66b2ed09
JH
131 show_notes:1,
132 show_notes_given:1,
0c37f1fc 133 show_signature:1,
66b2ed09 134 pretty_given:1,
4da45bef 135 abbrev_commit:1,
0c47695a 136 abbrev_commit_given:1,
7fefda5c 137 use_terminator:1,
f4ea32f0 138 missing_newline:1,
9553d2b2
JK
139 date_mode_explicit:1,
140 preserve_subject:1;
8b3dce56 141 unsigned int disable_stdin:1;
4a43d374 142 unsigned int leak_pending:1;
1b32dece
NTND
143 /* --show-linear-break */
144 unsigned int track_linear:1,
145 track_first_time:1,
146 linear:1;
8b3dce56 147
a7b02ccf 148 enum date_mode date_mode;
106d710b 149
cd2bdc53
LT
150 unsigned int abbrev;
151 enum cmit_fmt commit_format;
91539833 152 struct log_info *loginfo;
596524b3 153 int nr, total;
698ce6f8 154 const char *mime_boundary;
108dab28
SB
155 const char *patch_suffix;
156 int numbered_files;
5fe10fe8 157 int reroll_count;
e1a37346 158 char *message_id;
a9080475 159 struct ident_split from_ident;
b079c50e 160 struct string_list *ref_message_ids;
5289c56a 161 int add_signoff;
20ff0680 162 const char *extra_headers;
52883fbd 163 const char *log_reencode;
2d9e4a47 164 const char *subject_prefix;
c112f689 165 int no_inline;
9fa3465d 166 int show_log_size;
0e2913b0 167 struct string_list *mailmap;
cd2bdc53 168
8ecae9b0 169 /* Filter by commit log message */
0843acfd 170 struct grep_opt grep_filter;
8ecae9b0 171
7fefda5c
AS
172 /* Display history graph */
173 struct git_graph *graph;
174
ae563542 175 /* special limits */
d5db6c9e 176 int skip_count;
ae563542
LT
177 int max_count;
178 unsigned long max_age;
179 unsigned long min_age;
ad5aeede
MG
180 int min_parents;
181 int max_parents;
a330de31
VM
182 int (*include_check)(struct commit *, void *);
183 void *include_check_data;
8efdc326 184
cd2bdc53 185 /* diff info for patches and for paths limiting */
c4e05b1a 186 struct diff_options diffopt;
cd2bdc53 187 struct diff_options pruning;
c4e05b1a 188
8860fd42 189 struct reflog_walk_info *reflog_info;
f35f5603 190 struct decoration children;
faf0156b 191 struct decoration merge_simplification;
d0af663e 192 struct decoration treesame;
894a9d33
TR
193
194 /* notes-specific options: which refs to show */
195 struct display_notes_opt notes_opt;
f69c5018
TR
196
197 /* commit counts */
198 int count_left;
199 int count_right;
b388e14b 200 int count_same;
12da1d1f
TR
201
202 /* line level range that we are chasing */
203 struct decoration line_log_data;
53d00b39
TR
204
205 /* copies of the parent lists, for --full-diff display */
206 struct saved_parents *saved_parents_slab;
1b32dece
NTND
207
208 struct commit_list *previous_parents;
209 const char *break_bar;
ae563542
LT
210};
211
ff32d342
JH
212extern int ref_excluded(struct string_list *, const char *path);
213void clear_ref_exclusion(struct string_list **);
214void add_ref_exclusion(struct string_list **, const char *exclude);
215
216
8efdc326 217#define REV_TREE_SAME 0
ceff8e7a
LT
218#define REV_TREE_NEW 1 /* Only new files */
219#define REV_TREE_OLD 2 /* Only files removed */
220#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326 221
ae563542 222/* revision.c */
cdcefbc9 223typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 224extern volatile show_early_output_fn_t show_early_output;
8efdc326 225
32962c9b
JH
226struct setup_revision_opt {
227 const char *def;
b4490059 228 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
9ef6aeb0 229 const char *submodule;
6d5b93f2 230 int assume_dashdash;
d5f6b1d7 231 unsigned revarg_opt;
32962c9b
JH
232};
233
db6296a5 234extern void init_revisions(struct rev_info *revs, const char *prefix);
ff5f5f26
MH
235extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
236 struct setup_revision_opt *);
6b61ec05 237extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
ff5f5f26
MH
238 const struct option *options,
239 const char * const usagestr[]);
8e676e8b 240#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 241#define REVARG_COMMITTISH 02
ff5f5f26
MH
242extern int handle_revision_arg(const char *arg, struct rev_info *revs,
243 int flags, unsigned revarg_opt);
5d6f0935 244
bcc0a3ea 245extern void reset_revision_walk(void);
cc0e6c5a 246extern int prepare_revision_walk(struct rev_info *revs);
a4a88b2b 247extern struct commit *get_revision(struct rev_info *revs);
ff5f5f26
MH
248extern char *get_revision_mark(const struct rev_info *revs,
249 const struct commit *commit);
250extern void put_revision_mark(const struct rev_info *revs,
251 const struct commit *commit);
a4a88b2b 252
ae563542
LT
253extern void mark_parents_uninteresting(struct commit *commit);
254extern void mark_tree_uninteresting(struct tree *tree);
255
256struct name_path {
257 struct name_path *up;
258 int elem_len;
259 const char *elem;
260};
261
cf2ab916 262char *path_name(const struct name_path *path, const char *name);
8d2dfc49 263
ff5f5f26
MH
264extern void show_object_with_name(FILE *, struct object *,
265 const struct name_path *, const char *);
91f17516 266
ff5f5f26
MH
267extern void add_pending_object(struct rev_info *revs,
268 struct object *obj, const char *name);
269extern void add_pending_sha1(struct rev_info *revs,
270 const char *name, const unsigned char *sha1,
271 unsigned int flags);
ae563542 272
3384a2df 273extern void add_head_to_pending(struct rev_info *);
718ccc97 274extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
4fe10219 275extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
3384a2df 276
252a7c02
LT
277enum commit_action {
278 commit_ignore,
279 commit_show,
280 commit_error
281};
282
ff5f5f26
MH
283extern enum commit_action get_commit_action(struct rev_info *revs,
284 struct commit *commit);
285extern enum commit_action simplify_commit(struct rev_info *revs,
286 struct commit *commit);
252a7c02 287
c7edcae0
BY
288enum rewrite_result {
289 rewrite_one_ok,
290 rewrite_one_noparents,
291 rewrite_one_error
292};
293
294typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
295
296extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
297 rewrite_parent_fn_t rewrite_parent);
53d00b39
TR
298
299/*
300 * Save a copy of the parent list, and return the saved copy. This is
301 * used by the log machinery to retrieve the original parents when
302 * commit->parents has been modified by history simpification.
303 *
304 * You may only call save_parents() once per commit (this is checked
305 * for non-root commits).
306 *
307 * get_saved_parents() will transparently return commit->parents if
308 * history simplification is off.
309 */
310extern void save_parents(struct rev_info *revs, struct commit *commit);
311extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
312extern void free_saved_parents(struct rev_info *revs);
313
ae563542 314#endif