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