Documentation: avoid "uninteresting"
[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"
6b61ec05 7
ae563542
LT
8#define SEEN (1u<<0)
9#define UNINTERESTING (1u<<1)
7dc0fe3b 10#define TREESAME (1u<<2)
765ac8ec 11#define SHOWN (1u<<3)
7ae0b0cb 12#define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
384e99a4 13#define BOUNDARY (1u<<5)
2b064697 14#define CHILD_SHOWN (1u<<6)
1b65a5aa 15#define ADDED (1u<<7) /* Parents already parsed and added? */
577ed5c2 16#define SYMMETRIC_LEFT (1u<<8)
adbbb31e
MG
17#define PATCHSAME (1u<<9)
18#define ALL_REV_FLAGS ((1u<<10)-1)
ae563542 19
33e7018c
LH
20#define DECORATE_SHORT_REFS 1
21#define DECORATE_FULL_REFS 2
22
8efdc326 23struct rev_info;
91539833 24struct log_info;
894a9d33 25struct string_list;
8efdc326 26
281eee47
JH
27struct rev_cmdline_info {
28 unsigned int nr;
29 unsigned int alloc;
30 struct rev_cmdline_entry {
31 struct object *item;
32 const char *name;
33 enum {
34 REV_CMD_REF,
35 REV_CMD_PARENTS_ONLY,
36 REV_CMD_LEFT,
37 REV_CMD_RIGHT,
a765499a 38 REV_CMD_MERGE_BASE,
281eee47
JH
39 REV_CMD_REV
40 } whence;
41 unsigned flags;
42 } *rev;
43};
44
ca92e59e
MZ
45#define REVISION_WALK_WALK 0
46#define REVISION_WALK_NO_WALK_SORTED 1
47#define REVISION_WALK_NO_WALK_UNSORTED 2
48
ae563542
LT
49struct rev_info {
50 /* Starting list */
51 struct commit_list *commits;
1f1e895f 52 struct object_array pending;
ae563542 53
86ab4906
JH
54 /* Parents of shown commits */
55 struct object_array boundary_commits;
56
281eee47
JH
57 /* The end-points specified by the end user */
58 struct rev_cmdline_info cmdline;
59
ae563542
LT
60 /* Basic information */
61 const char *prefix;
02e54220 62 const char *def;
afe069d1 63 struct pathspec prune_data;
cc243c3c
JH
64 unsigned int early_output:1,
65 ignore_missing:1;
cdcefbc9 66
ae563542
LT
67 /* Traversal flags */
68 unsigned int dense:1,
53b2c823 69 prune:1,
ca92e59e 70 no_walk:2,
3131b713 71 show_all:1,
ae563542 72 remove_empty_trees:1,
9202434c 73 simplify_history:1,
ae563542
LT
74 lifo:1,
75 topo_order:1,
6546b593 76 simplify_merges:1,
78892e32 77 simplify_by_decoration:1,
ae563542
LT
78 tag_objects:1,
79 tree_objects:1,
80 blob_objects:1,
5a48d240 81 verify_objects:1,
d9a83684
LT
82 edge_hint:1,
83 limited:1,
03a9683d 84 unpacked:1,
86ab4906 85 boundary:2,
f69c5018 86 count:1,
74bd9029 87 left_right:1,
60adf7d7
MG
88 left_only:1,
89 right_only:1,
885cf808
AS
90 rewrite_parents:1,
91 print_parents:1,
0f3a290b 92 show_source:1,
d467a525 93 show_decorations:1,
0053e902 94 reverse:1,
498bcd31 95 reverse_output_stage:1,
d7a17cad 96 cherry_pick:1,
adbbb31e 97 cherry_mark:1,
ad3f9a71 98 bisect:1,
ebdc94f3 99 ancestry_path:1,
0053e902 100 first_parent_only:1;
ae563542 101
cd2bdc53
LT
102 /* Diff flags */
103 unsigned int diff:1,
104 full_diff:1,
105 show_root_diff:1,
106 no_commit_id:1,
107 verbose_header:1,
108 ignore_merges:1,
109 combine_merges:1,
110 dense_combined_merges:1,
111 always_show_header:1;
112
113 /* Format info */
91539833 114 unsigned int shown_one:1,
bd1470b8 115 shown_dashes:1,
02e54220 116 show_merge:1,
66b2ed09
JH
117 show_notes:1,
118 show_notes_given:1,
0c37f1fc 119 show_signature:1,
66b2ed09 120 pretty_given:1,
4da45bef 121 abbrev_commit:1,
0c47695a 122 abbrev_commit_given:1,
7fefda5c 123 use_terminator:1,
f4ea32f0 124 missing_newline:1,
9553d2b2
JK
125 date_mode_explicit:1,
126 preserve_subject:1;
8b3dce56 127 unsigned int disable_stdin:1;
4a43d374 128 unsigned int leak_pending:1;
8b3dce56 129
a7b02ccf 130 enum date_mode date_mode;
106d710b 131
cd2bdc53
LT
132 unsigned int abbrev;
133 enum cmit_fmt commit_format;
91539833 134 struct log_info *loginfo;
596524b3 135 int nr, total;
698ce6f8 136 const char *mime_boundary;
108dab28
SB
137 const char *patch_suffix;
138 int numbered_files;
5fe10fe8 139 int reroll_count;
e1a37346 140 char *message_id;
b079c50e 141 struct string_list *ref_message_ids;
5289c56a 142 int add_signoff;
20ff0680 143 const char *extra_headers;
52883fbd 144 const char *log_reencode;
2d9e4a47 145 const char *subject_prefix;
c112f689 146 int no_inline;
9fa3465d 147 int show_log_size;
0e2913b0 148 struct string_list *mailmap;
cd2bdc53 149
8ecae9b0 150 /* Filter by commit log message */
0843acfd 151 struct grep_opt grep_filter;
8ecae9b0 152
7fefda5c
AS
153 /* Display history graph */
154 struct git_graph *graph;
155
ae563542 156 /* special limits */
d5db6c9e 157 int skip_count;
ae563542
LT
158 int max_count;
159 unsigned long max_age;
160 unsigned long min_age;
ad5aeede
MG
161 int min_parents;
162 int max_parents;
8efdc326 163
cd2bdc53 164 /* diff info for patches and for paths limiting */
c4e05b1a 165 struct diff_options diffopt;
cd2bdc53 166 struct diff_options pruning;
c4e05b1a 167
8860fd42 168 struct reflog_walk_info *reflog_info;
f35f5603 169 struct decoration children;
faf0156b 170 struct decoration merge_simplification;
894a9d33
TR
171
172 /* notes-specific options: which refs to show */
173 struct display_notes_opt notes_opt;
f69c5018
TR
174
175 /* commit counts */
176 int count_left;
177 int count_right;
b388e14b 178 int count_same;
ae563542
LT
179};
180
8efdc326 181#define REV_TREE_SAME 0
ceff8e7a
LT
182#define REV_TREE_NEW 1 /* Only new files */
183#define REV_TREE_OLD 2 /* Only files removed */
184#define REV_TREE_DIFFERENT 3 /* Mixed changes */
8efdc326 185
ae563542 186/* revision.c */
cdcefbc9 187typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
4dc1db0b 188extern volatile show_early_output_fn_t show_early_output;
8efdc326 189
32962c9b
JH
190struct setup_revision_opt {
191 const char *def;
b4490059 192 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
9ef6aeb0 193 const char *submodule;
6d5b93f2 194 int assume_dashdash;
d5f6b1d7 195 unsigned revarg_opt;
32962c9b
JH
196};
197
db6296a5 198extern void init_revisions(struct rev_info *revs, const char *prefix);
32962c9b 199extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
6b61ec05
PH
200extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
201 const struct option *options,
202 const char * const usagestr[]);
8e676e8b 203#define REVARG_CANNOT_BE_FILENAME 01
d5f6b1d7 204#define REVARG_COMMITTISH 02
8e676e8b 205extern int handle_revision_arg(const char *arg, struct rev_info *revs, int flags, unsigned revarg_opt);
5d6f0935 206
bcc0a3ea 207extern void reset_revision_walk(void);
cc0e6c5a 208extern int prepare_revision_walk(struct rev_info *revs);
a4a88b2b 209extern struct commit *get_revision(struct rev_info *revs);
1df2d656 210extern char *get_revision_mark(const struct rev_info *revs, const struct commit *commit);
b1b47554 211extern void put_revision_mark(const struct rev_info *revs, const struct commit *commit);
a4a88b2b 212
ae563542
LT
213extern void mark_parents_uninteresting(struct commit *commit);
214extern void mark_tree_uninteresting(struct tree *tree);
215
216struct name_path {
217 struct name_path *up;
218 int elem_len;
219 const char *elem;
220};
221
cf2ab916 222char *path_name(const struct name_path *path, const char *name);
8d2dfc49 223
91f17516
JH
224extern void show_object_with_name(FILE *, struct object *, const struct name_path *, const char *);
225
1f1e895f
LT
226extern void add_object(struct object *obj,
227 struct object_array *p,
228 struct name_path *path,
229 const char *name);
230
231extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
26c3177e 232extern void add_pending_sha1(struct rev_info *revs, const char *name, const unsigned char *sha1, unsigned int flags);
ae563542 233
3384a2df
JH
234extern void add_head_to_pending(struct rev_info *);
235
252a7c02
LT
236enum commit_action {
237 commit_ignore,
238 commit_show,
239 commit_error
240};
241
beb5af43 242extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
252a7c02
LT
243extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
244
ae563542 245#endif