Documentation: basic configuration of notes.rewriteRef
[git/gitweb.git] / revision.h
blob3d64adad18e2c889b7a7b7367f99c239f958dc70
1 #ifndef REVISION_H
2 #define REVISION_H
4 #include "parse-options.h"
5 #include "grep.h"
6 #include "notes.h"
8 #define SEEN (1u<<0)
9 #define UNINTERESTING (1u<<1)
10 #define TREESAME (1u<<2)
11 #define SHOWN (1u<<3)
12 #define TMP_MARK (1u<<4) /* for isolated cases; clean after use */
13 #define BOUNDARY (1u<<5)
14 #define CHILD_SHOWN (1u<<6)
15 #define ADDED (1u<<7) /* Parents already parsed and added? */
16 #define SYMMETRIC_LEFT (1u<<8)
17 #define PATCHSAME (1u<<9)
18 #define ALL_REV_FLAGS ((1u<<10)-1)
20 #define DECORATE_SHORT_REFS 1
21 #define DECORATE_FULL_REFS 2
23 struct rev_info;
24 struct log_info;
25 struct string_list;
27 struct rev_info {
28 /* Starting list */
29 struct commit_list *commits;
30 struct object_array pending;
32 /* Parents of shown commits */
33 struct object_array boundary_commits;
35 /* Basic information */
36 const char *prefix;
37 const char *def;
38 struct pathspec prune_data;
39 unsigned int early_output:1,
40 ignore_missing:1;
42 /* Traversal flags */
43 unsigned int dense:1,
44 prune:1,
45 no_walk:1,
46 show_all:1,
47 remove_empty_trees:1,
48 simplify_history:1,
49 lifo:1,
50 topo_order:1,
51 simplify_merges:1,
52 simplify_by_decoration:1,
53 tag_objects:1,
54 tree_objects:1,
55 blob_objects:1,
56 edge_hint:1,
57 limited:1,
58 unpacked:1,
59 boundary:2,
60 count:1,
61 left_right:1,
62 left_only:1,
63 right_only:1,
64 rewrite_parents:1,
65 print_parents:1,
66 show_source:1,
67 show_decorations:1,
68 reverse:1,
69 reverse_output_stage:1,
70 cherry_pick:1,
71 cherry_mark:1,
72 bisect:1,
73 ancestry_path:1,
74 first_parent_only:1;
76 /* Diff flags */
77 unsigned int diff:1,
78 full_diff:1,
79 show_root_diff:1,
80 no_commit_id:1,
81 verbose_header:1,
82 ignore_merges:1,
83 combine_merges:1,
84 dense_combined_merges:1,
85 always_show_header:1;
87 /* Format info */
88 unsigned int shown_one:1,
89 show_merge:1,
90 show_notes:1,
91 show_notes_given:1,
92 pretty_given:1,
93 abbrev_commit:1,
94 abbrev_commit_given:1,
95 use_terminator:1,
96 missing_newline:1,
97 date_mode_explicit:1,
98 preserve_subject:1;
99 unsigned int disable_stdin:1;
101 enum date_mode date_mode;
103 unsigned int abbrev;
104 enum cmit_fmt commit_format;
105 struct log_info *loginfo;
106 int nr, total;
107 const char *mime_boundary;
108 const char *patch_suffix;
109 int numbered_files;
110 char *message_id;
111 struct string_list *ref_message_ids;
112 const char *add_signoff;
113 const char *extra_headers;
114 const char *log_reencode;
115 const char *subject_prefix;
116 int no_inline;
117 int show_log_size;
119 /* Filter by commit log message */
120 struct grep_opt grep_filter;
122 /* Display history graph */
123 struct git_graph *graph;
125 /* special limits */
126 int skip_count;
127 int max_count;
128 unsigned long max_age;
129 unsigned long min_age;
130 int min_parents;
131 int max_parents;
133 /* diff info for patches and for paths limiting */
134 struct diff_options diffopt;
135 struct diff_options pruning;
137 struct reflog_walk_info *reflog_info;
138 struct decoration children;
139 struct decoration merge_simplification;
141 /* notes-specific options: which refs to show */
142 struct display_notes_opt notes_opt;
144 /* commit counts */
145 int count_left;
146 int count_right;
147 int count_same;
150 #define REV_TREE_SAME 0
151 #define REV_TREE_NEW 1 /* Only new files */
152 #define REV_TREE_OLD 2 /* Only files removed */
153 #define REV_TREE_DIFFERENT 3 /* Mixed changes */
155 /* revision.c */
156 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
157 extern volatile show_early_output_fn_t show_early_output;
159 struct setup_revision_opt {
160 const char *def;
161 void (*tweak)(struct rev_info *, struct setup_revision_opt *);
162 const char *submodule;
165 extern void init_revisions(struct rev_info *revs, const char *prefix);
166 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, struct setup_revision_opt *);
167 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
168 const struct option *options,
169 const char * const usagestr[]);
170 extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
172 extern int prepare_revision_walk(struct rev_info *revs);
173 extern struct commit *get_revision(struct rev_info *revs);
174 extern char *get_revision_mark(const struct rev_info *revs, const struct commit *commit);
175 extern void put_revision_mark(const struct rev_info *revs, const struct commit *commit);
177 extern void mark_parents_uninteresting(struct commit *commit);
178 extern void mark_tree_uninteresting(struct tree *tree);
180 struct name_path {
181 struct name_path *up;
182 int elem_len;
183 const char *elem;
186 char *path_name(const struct name_path *path, const char *name);
188 extern void add_object(struct object *obj,
189 struct object_array *p,
190 struct name_path *path,
191 const char *name);
193 extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
195 extern void add_head_to_pending(struct rev_info *);
197 enum commit_action {
198 commit_ignore,
199 commit_show,
200 commit_error
203 extern enum commit_action get_commit_action(struct rev_info *revs, struct commit *commit);
204 extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
206 #endif