Add hints to revert documentation about other ways to undo changes
[git/dscho.git] / revision.h
blobf64e8ce7ff999e9fe4a01205ae51775827484ed4
1 #ifndef REVISION_H
2 #define REVISION_H
4 #include "parse-options.h"
6 #define SEEN (1u<<0)
7 #define UNINTERESTING (1u<<1)
8 #define TREESAME (1u<<2)
9 #define SHOWN (1u<<3)
10 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
11 #define BOUNDARY (1u<<5)
12 #define CHILD_SHOWN (1u<<6)
13 #define ADDED (1u<<7) /* Parents already parsed and added? */
14 #define SYMMETRIC_LEFT (1u<<8)
15 #define ALL_REV_FLAGS ((1u<<9)-1)
17 struct rev_info;
18 struct log_info;
20 struct rev_info {
21 /* Starting list */
22 struct commit_list *commits;
23 struct object_array pending;
25 /* Parents of shown commits */
26 struct object_array boundary_commits;
28 /* Basic information */
29 const char *prefix;
30 const char *def;
31 void *prune_data;
32 unsigned int early_output;
34 /* Traversal flags */
35 unsigned int dense:1,
36 prune:1,
37 no_merges:1,
38 no_walk:1,
39 show_all:1,
40 remove_empty_trees:1,
41 simplify_history:1,
42 lifo:1,
43 topo_order:1,
44 tag_objects:1,
45 tree_objects:1,
46 blob_objects:1,
47 edge_hint:1,
48 limited:1,
49 unpacked:1, /* see also ignore_packed below */
50 boundary:2,
51 left_right:1,
52 rewrite_parents:1,
53 print_parents:1,
54 reverse:1,
55 cherry_pick:1,
56 first_parent_only:1;
58 /* Diff flags */
59 unsigned int diff:1,
60 full_diff:1,
61 show_root_diff:1,
62 no_commit_id:1,
63 verbose_header:1,
64 ignore_merges:1,
65 combine_merges:1,
66 dense_combined_merges:1,
67 always_show_header:1;
69 /* Format info */
70 unsigned int shown_one:1,
71 show_merge:1,
72 abbrev_commit:1,
73 use_terminator:1,
74 missing_newline:1;
75 enum date_mode date_mode;
77 const char **ignore_packed; /* pretend objects in these are unpacked */
78 int num_ignore_packed;
80 unsigned int abbrev;
81 enum cmit_fmt commit_format;
82 struct log_info *loginfo;
83 int nr, total;
84 const char *mime_boundary;
85 char *message_id;
86 const char *ref_message_id;
87 const char *add_signoff;
88 const char *extra_headers;
89 const char *log_reencode;
90 const char *subject_prefix;
91 int no_inline;
92 int show_log_size;
94 /* Filter by commit log message */
95 struct grep_opt *grep_filter;
97 /* Display history graph */
98 struct git_graph *graph;
100 /* special limits */
101 int skip_count;
102 int max_count;
103 unsigned long max_age;
104 unsigned long min_age;
106 /* diff info for patches and for paths limiting */
107 struct diff_options diffopt;
108 struct diff_options pruning;
110 struct reflog_walk_info *reflog_info;
111 struct decoration children;
114 #define REV_TREE_SAME 0
115 #define REV_TREE_NEW 1
116 #define REV_TREE_DIFFERENT 2
118 /* revision.c */
119 void read_revisions_from_stdin(struct rev_info *revs);
121 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
122 volatile show_early_output_fn_t show_early_output;
124 extern void init_revisions(struct rev_info *revs, const char *prefix);
125 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
126 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
127 const struct option *options,
128 const char * const usagestr[]);
129 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
131 extern int prepare_revision_walk(struct rev_info *revs);
132 extern struct commit *get_revision(struct rev_info *revs);
134 extern void mark_parents_uninteresting(struct commit *commit);
135 extern void mark_tree_uninteresting(struct tree *tree);
137 struct name_path {
138 struct name_path *up;
139 int elem_len;
140 const char *elem;
143 extern void add_object(struct object *obj,
144 struct object_array *p,
145 struct name_path *path,
146 const char *name);
148 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
150 extern void add_head_to_pending(struct rev_info *);
152 enum commit_action {
153 commit_ignore,
154 commit_show,
155 commit_error
158 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
160 #endif