stash: remove now superfluos help for "stash push"
[git.git] / revision.h
blob54761200adf2d5111b8aba097299bd2fd080a949
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;
75 * Whether the arguments parsed by setup_revisions() included any
76 * "input" revisions that might still have yielded an empty pending
77 * list (e.g., patterns like "--all" or "--glob").
79 int rev_input_given;
81 /* topo-sort */
82 enum rev_sort_order sort_order;
84 unsigned int early_output;
86 unsigned int ignore_missing:1,
87 ignore_missing_links:1;
89 /* Traversal flags */
90 unsigned int dense:1,
91 prune:1,
92 no_walk:2,
93 show_all:1,
94 remove_empty_trees:1,
95 simplify_history:1,
96 topo_order:1,
97 simplify_merges:1,
98 simplify_by_decoration:1,
99 single_worktree:1,
100 tag_objects:1,
101 tree_objects:1,
102 blob_objects:1,
103 verify_objects:1,
104 edge_hint:1,
105 edge_hint_aggressive:1,
106 limited:1,
107 unpacked:1,
108 boundary:2,
109 count:1,
110 left_right:1,
111 left_only:1,
112 right_only:1,
113 rewrite_parents:1,
114 print_parents:1,
115 show_source:1,
116 show_decorations:1,
117 reverse:1,
118 reverse_output_stage:1,
119 cherry_pick:1,
120 cherry_mark:1,
121 bisect:1,
122 ancestry_path:1,
123 first_parent_only:1,
124 line_level_traverse:1;
126 /* Diff flags */
127 unsigned int diff:1,
128 full_diff:1,
129 show_root_diff:1,
130 no_commit_id:1,
131 verbose_header:1,
132 ignore_merges:1,
133 combine_merges:1,
134 dense_combined_merges:1,
135 always_show_header:1;
137 /* Format info */
138 unsigned int shown_one:1,
139 shown_dashes:1,
140 show_merge:1,
141 show_notes:1,
142 show_notes_given:1,
143 show_signature:1,
144 pretty_given:1,
145 abbrev_commit:1,
146 abbrev_commit_given:1,
147 zero_commit:1,
148 use_terminator:1,
149 missing_newline:1,
150 date_mode_explicit:1,
151 preserve_subject:1;
152 unsigned int disable_stdin:1;
154 * Set `leak_pending` to prevent `prepare_revision_walk()` from clearing
155 * the array of pending objects (`pending`). It will still forget about
156 * the array and its entries, so they really are leaked. This can be
157 * useful if the `struct object_array` `pending` is copied before
158 * calling `prepare_revision_walk()`. By setting `leak_pending`, you
159 * effectively claim ownership of the old array, so you should most
160 * likely call `object_array_clear(&pending_copy)` once you are done.
161 * Observe that this is about ownership of the array and its entries,
162 * not the commits referenced by those entries.
164 unsigned int leak_pending:1;
165 /* --show-linear-break */
166 unsigned int track_linear:1,
167 track_first_time:1,
168 linear:1;
170 struct date_mode date_mode;
171 int expand_tabs_in_log; /* unset if negative */
172 int expand_tabs_in_log_default;
174 unsigned int abbrev;
175 enum cmit_fmt commit_format;
176 struct log_info *loginfo;
177 int nr, total;
178 const char *mime_boundary;
179 const char *patch_suffix;
180 int numbered_files;
181 int reroll_count;
182 char *message_id;
183 struct ident_split from_ident;
184 struct string_list *ref_message_ids;
185 int add_signoff;
186 const char *extra_headers;
187 const char *log_reencode;
188 const char *subject_prefix;
189 int no_inline;
190 int show_log_size;
191 struct string_list *mailmap;
193 /* Filter by commit log message */
194 struct grep_opt grep_filter;
195 /* Negate the match of grep_filter */
196 int invert_grep;
198 /* Display history graph */
199 struct git_graph *graph;
201 /* special limits */
202 int skip_count;
203 int max_count;
204 timestamp_t max_age;
205 timestamp_t min_age;
206 int min_parents;
207 int max_parents;
208 int (*include_check)(struct commit *, void *);
209 void *include_check_data;
211 /* diff info for patches and for paths limiting */
212 struct diff_options diffopt;
213 struct diff_options pruning;
215 struct reflog_walk_info *reflog_info;
216 struct decoration children;
217 struct decoration merge_simplification;
218 struct decoration treesame;
220 /* notes-specific options: which refs to show */
221 struct display_notes_opt notes_opt;
223 /* commit counts */
224 int count_left;
225 int count_right;
226 int count_same;
228 /* line level range that we are chasing */
229 struct decoration line_log_data;
231 /* copies of the parent lists, for --full-diff display */
232 struct saved_parents *saved_parents_slab;
234 struct commit_list *previous_parents;
235 const char *break_bar;
238 extern int ref_excluded(struct string_list *, const char *path);
239 void clear_ref_exclusion(struct string_list **);
240 void add_ref_exclusion(struct string_list **, const char *exclude);
243 #define REV_TREE_SAME 0
244 #define REV_TREE_NEW 1 /* Only new files */
245 #define REV_TREE_OLD 2 /* Only files removed */
246 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
248 /* revision.c */
249 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
250 extern volatile show_early_output_fn_t show_early_output;
252 struct setup_revision_opt {
253 const char *def;
254 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
255 const char *submodule;
256 int assume_dashdash;
257 unsigned revarg_opt;
260 extern void init_revisions(struct rev_info *revs, const char *prefix);
261 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
262 struct setup_revision_opt *);
263 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
264 const struct option *options,
265 const char * const usagestr[]);
266 #define REVARG_CANNOT_BE_FILENAME 01
267 #define REVARG_COMMITTISH 02
268 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
269 int flags, unsigned revarg_opt);
271 extern void reset_revision_walk(void);
272 extern int prepare_revision_walk(struct rev_info *revs);
273 extern struct commit *get_revision(struct rev_info *revs);
274 extern char *get_revision_mark(const struct rev_info *revs,
275 const struct commit *commit);
276 extern void put_revision_mark(const struct rev_info *revs,
277 const struct commit *commit);
279 extern void mark_parents_uninteresting(struct commit *commit);
280 extern void mark_tree_uninteresting(struct tree *tree);
282 extern void show_object_with_name(FILE *, struct object *, const char *);
284 extern void add_pending_object(struct rev_info *revs,
285 struct object *obj, const char *name);
286 extern void add_pending_oid(struct rev_info *revs,
287 const char *name, const struct object_id *oid,
288 unsigned int flags);
290 extern void add_head_to_pending(struct rev_info *);
291 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
292 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
294 enum commit_action {
295 commit_ignore,
296 commit_show,
297 commit_error
300 extern enum commit_action get_commit_action(struct rev_info *revs,
301 struct commit *commit);
302 extern enum commit_action simplify_commit(struct rev_info *revs,
303 struct commit *commit);
305 enum rewrite_result {
306 rewrite_one_ok,
307 rewrite_one_noparents,
308 rewrite_one_error
311 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
313 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
314 rewrite_parent_fn_t rewrite_parent);
317 * The log machinery saves the original parent list so that
318 * get_saved_parents() can later tell what the real parents of the
319 * commits are, when commit->parents has been modified by history
320 * simpification.
322 * get_saved_parents() will transparently return commit->parents if
323 * history simplification is off.
325 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
327 #endif