builtin.h 12.7 KB
Newer Older
1 2 3
#ifndef BUILTIN_H
#define BUILTIN_H

4
#include "git-compat-util.h"
5
#include "strbuf.h"
6 7
#include "cache.h"
#include "commit.h"
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/*
 * builtin API
 * ===========
 *
 * Adding a new built-in
 * ---------------------
 *
 * There are 4 things to do to add a built-in command implementation to
 * Git:
 *
 * . Define the implementation of the built-in command `foo` with
 *   signature:
 *
 *	int cmd_foo(int argc, const char **argv, const char *prefix);
 *
 * . Add the external declaration for the function to `builtin.h`.
 *
 * . Add the command to the `commands[]` table defined in `git.c`.
 *   The entry should look like:
 *
 *	{ "foo", cmd_foo, <options> },
 *
 * where options is the bitwise-or of:
 *
 * `RUN_SETUP`:
 *	If there is not a Git directory to work on, abort.  If there
 *	is a work tree, chdir to the top of it if the command was
 *	invoked in a subdirectory.  If there is no work tree, no
 *	chdir() is done.
 *
 * `RUN_SETUP_GENTLY`:
 *	If there is a Git directory, chdir as per RUN_SETUP, otherwise,
 *	don't chdir anywhere.
 *
 * `USE_PAGER`:
 *
 *	If the standard output is connected to a tty, spawn a pager and
 *	feed our output to it.
 *
 * `NEED_WORK_TREE`:
 *
 *	Make sure there is a work tree, i.e. the command cannot act
 *	on bare repositories.
 *	This only makes sense when `RUN_SETUP` is also set.
 *
 * `SUPPORT_SUPER_PREFIX`:
 *
 *	The built-in supports `--super-prefix`.
 *
58 59 60 61 62 63 64 65
 * `DELAY_PAGER_CONFIG`:
 *
 *	If RUN_SETUP or RUN_SETUP_GENTLY is set, git.c normally handles
 *	the `pager.<cmd>`-configuration. If this flag is used, git.c
 *	will skip that step, instead allowing the built-in to make a
 *	more informed decision, e.g., by ignoring `pager.<cmd>` for
 *	certain subcommands.
 *
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
 * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
 *
 * Additionally, if `foo` is a new command, there are 4 more things to do:
 *
 * . Add tests to `t/` directory.
 *
 * . Write documentation in `Documentation/git-foo.txt`.
 *
 * . Add an entry for `git-foo` to `command-list.txt`.
 *
 * . Add an entry for `/git-foo` to `.gitignore`.
 *
 *
 * How a built-in is called
 * ------------------------
 *
 * The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
 * and `prefix`.  The first two are similar to what `main()` of a
 * standalone command would be called with.
 *
 * When `RUN_SETUP` is specified in the `commands[]` table, and when you
 * were started from a subdirectory of the work tree, `cmd_foo()` is called
 * after chdir(2) to the top of the work tree, and `prefix` gets the path
 * to the subdirectory the command started from.  This allows you to
 * convert a user-supplied pathname (typically relative to that directory)
 * to a pathname relative to the top of the work tree.
 *
 * The return value from `cmd_foo()` becomes the exit status of the
 * command.
 */

97 98
#define DEFAULT_MERGE_LOG_LEN 20

99
extern const char git_usage_string[];
100
extern const char git_more_info_string[];
101

102 103 104
#define PRUNE_PACKED_DRY_RUN 01
#define PRUNE_PACKED_VERBOSE 02

105
extern void prune_packed_objects(int);
106 107

struct fmt_merge_msg_opts {
108 109
	unsigned add_title:1,
		credit_people:1;
110 111 112
	int shortlog_len;
};

113
extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
114
			 struct fmt_merge_msg_opts *);
115

116 117 118 119 120 121 122 123 124 125 126 127
/**
 * If a built-in has DELAY_PAGER_CONFIG set, the built-in should call this early
 * when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
 * the built-in, e.g., "foo". If a paging-choice has already been setup, this
 * does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
 * on" or -1 for "punt".
 *
 * You should most likely use a default of 0 or 1. "Punt" (-1) could be useful
 * to be able to fall back to some historical compatibility name.
 */
extern void setup_auto_pager(const char *cmd, int def);

128 129
extern int is_builtin(const char *s);

130
extern int cmd_add(int argc, const char **argv, const char *prefix);
131
extern int cmd_am(int argc, const char **argv, const char *prefix);
132
extern int cmd_annotate(int argc, const char **argv, const char *prefix);
133
extern int cmd_apply(int argc, const char **argv, const char *prefix);
Franck Bui-Huu's avatar
Franck Bui-Huu committed
134
extern int cmd_archive(int argc, const char **argv, const char *prefix);
135
extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix);
136
extern int cmd_blame(int argc, const char **argv, const char *prefix);
Lars Hjemli's avatar
Lars Hjemli committed
137
extern int cmd_branch(int argc, const char **argv, const char *prefix);
138
extern int cmd_bundle(int argc, const char **argv, const char *prefix);
139
extern int cmd_cat_file(int argc, const char **argv, const char *prefix);
Daniel Barkalow's avatar
Daniel Barkalow committed
140
extern int cmd_checkout(int argc, const char **argv, const char *prefix);
141
extern int cmd_checkout_index(int argc, const char **argv, const char *prefix);
142
extern int cmd_check_attr(int argc, const char **argv, const char *prefix);
143
extern int cmd_check_ignore(int argc, const char **argv, const char *prefix);
144
extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
145
extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
Rene Scharfe's avatar
Rene Scharfe committed
146
extern int cmd_cherry(int argc, const char **argv, const char *prefix);
147
extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
Daniel Barkalow's avatar
Daniel Barkalow committed
148
extern int cmd_clone(int argc, const char **argv, const char *prefix);
Shawn Bohrer's avatar
Shawn Bohrer committed
149
extern int cmd_clean(int argc, const char **argv, const char *prefix);
150
extern int cmd_column(int argc, const char **argv, const char *prefix);
151
extern int cmd_commit(int argc, const char **argv, const char *prefix);
152
extern int cmd_commit_graph(int argc, const char **argv, const char *prefix);
153
extern int cmd_commit_tree(int argc, const char **argv, const char *prefix);
154
extern int cmd_config(int argc, const char **argv, const char *prefix);
155
extern int cmd_count_objects(int argc, const char **argv, const char *prefix);
156
extern int cmd_credential(int argc, const char **argv, const char *prefix);
157
extern int cmd_describe(int argc, const char **argv, const char *prefix);
158 159
extern int cmd_diff_files(int argc, const char **argv, const char *prefix);
extern int cmd_diff_index(int argc, const char **argv, const char *prefix);
160
extern int cmd_diff(int argc, const char **argv, const char *prefix);
161
extern int cmd_diff_tree(int argc, const char **argv, const char *prefix);
162
extern int cmd_difftool(int argc, const char **argv, const char *prefix);
163
extern int cmd_fast_export(int argc, const char **argv, const char *prefix);
Daniel Barkalow's avatar
Daniel Barkalow committed
164
extern int cmd_fetch(int argc, const char **argv, const char *prefix);
165
extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
166
extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
167
extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
168
extern int cmd_format_patch(int argc, const char **argv, const char *prefix);
169
extern int cmd_fsck(int argc, const char **argv, const char *prefix);
James Bowes's avatar
James Bowes committed
170
extern int cmd_gc(int argc, const char **argv, const char *prefix);
171 172
extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
extern int cmd_grep(int argc, const char **argv, const char *prefix);
173
extern int cmd_hash_object(int argc, const char **argv, const char *prefix);
174
extern int cmd_help(int argc, const char **argv, const char *prefix);
175
extern int cmd_index_pack(int argc, const char **argv, const char *prefix);
176
extern int cmd_init_db(int argc, const char **argv, const char *prefix);
177
extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
178
extern int cmd_log(int argc, const char **argv, const char *prefix);
Linus Torvalds's avatar
Linus Torvalds committed
179
extern int cmd_log_reflog(int argc, const char **argv, const char *prefix);
180 181
extern int cmd_ls_files(int argc, const char **argv, const char *prefix);
extern int cmd_ls_tree(int argc, const char **argv, const char *prefix);
Daniel Barkalow's avatar
Daniel Barkalow committed
182
extern int cmd_ls_remote(int argc, const char **argv, const char *prefix);
183 184
extern int cmd_mailinfo(int argc, const char **argv, const char *prefix);
extern int cmd_mailsplit(int argc, const char **argv, const char *prefix);
Miklos Vajna's avatar
Miklos Vajna committed
185
extern int cmd_merge(int argc, const char **argv, const char *prefix);
186
extern int cmd_merge_base(int argc, const char **argv, const char *prefix);
187
extern int cmd_merge_index(int argc, const char **argv, const char *prefix);
188
extern int cmd_merge_ours(int argc, const char **argv, const char *prefix);
189
extern int cmd_merge_file(int argc, const char **argv, const char *prefix);
190
extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
191
extern int cmd_merge_tree(int argc, const char **argv, const char *prefix);
Linus Torvalds's avatar
Linus Torvalds committed
192
extern int cmd_mktag(int argc, const char **argv, const char *prefix);
Junio C Hamano's avatar
Junio C Hamano committed
193
extern int cmd_mktree(int argc, const char **argv, const char *prefix);
194
extern int cmd_multi_pack_index(int argc, const char **argv, const char *prefix);
195
extern int cmd_mv(int argc, const char **argv, const char *prefix);
196
extern int cmd_name_rev(int argc, const char **argv, const char *prefix);
Johan Herland's avatar
Johan Herland committed
197
extern int cmd_notes(int argc, const char **argv, const char *prefix);
198
extern int cmd_pack_objects(int argc, const char **argv, const char *prefix);
199
extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
200
extern int cmd_patch_id(int argc, const char **argv, const char *prefix);
201 202
extern int cmd_prune(int argc, const char **argv, const char *prefix);
extern int cmd_prune_packed(int argc, const char **argv, const char *prefix);
203
extern int cmd_pull(int argc, const char **argv, const char *prefix);
204
extern int cmd_push(int argc, const char **argv, const char *prefix);
205
extern int cmd_range_diff(int argc, const char **argv, const char *prefix);
206
extern int cmd_read_tree(int argc, const char **argv, const char *prefix);
207
extern int cmd_rebase(int argc, const char **argv, const char *prefix);
208
extern int cmd_rebase__interactive(int argc, const char **argv, const char *prefix);
209
extern int cmd_receive_pack(int argc, const char **argv, const char *prefix);
Junio C Hamano's avatar
Junio C Hamano committed
210
extern int cmd_reflog(int argc, const char **argv, const char *prefix);
211
extern int cmd_remote(int argc, const char **argv, const char *prefix);
Ilari Liusvaara's avatar
Ilari Liusvaara committed
212
extern int cmd_remote_ext(int argc, const char **argv, const char *prefix);
Ilari Liusvaara's avatar
Ilari Liusvaara committed
213
extern int cmd_remote_fd(int argc, const char **argv, const char *prefix);
214
extern int cmd_repack(int argc, const char **argv, const char *prefix);
215
extern int cmd_rerere(int argc, const char **argv, const char *prefix);
216
extern int cmd_reset(int argc, const char **argv, const char *prefix);
217 218
extern int cmd_rev_list(int argc, const char **argv, const char *prefix);
extern int cmd_rev_parse(int argc, const char **argv, const char *prefix);
219
extern int cmd_revert(int argc, const char **argv, const char *prefix);
220
extern int cmd_rm(int argc, const char **argv, const char *prefix);
221
extern int cmd_send_pack(int argc, const char **argv, const char *prefix);
222
extern int cmd_serve(int argc, const char **argv, const char *prefix);
Johannes Schindelin's avatar
Johannes Schindelin committed
223
extern int cmd_shortlog(int argc, const char **argv, const char *prefix);
224
extern int cmd_show(int argc, const char **argv, const char *prefix);
225
extern int cmd_show_branch(int argc, const char **argv, const char *prefix);
Jeff King's avatar
Jeff King committed
226
extern int cmd_show_index(int argc, const char **argv, const char *prefix);
227
extern int cmd_status(int argc, const char **argv, const char *prefix);
228
extern int cmd_stripspace(int argc, const char **argv, const char *prefix);
229
extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
230
extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
Carlos Rica's avatar
Carlos Rica committed
231
extern int cmd_tag(int argc, const char **argv, const char *prefix);
232
extern int cmd_tar_tree(int argc, const char **argv, const char *prefix);
233
extern int cmd_unpack_file(int argc, const char **argv, const char *prefix);
234 235 236
extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
extern int cmd_update_index(int argc, const char **argv, const char *prefix);
extern int cmd_update_ref(int argc, const char **argv, const char *prefix);
237
extern int cmd_update_server_info(int argc, const char **argv, const char *prefix);
Franck Bui-Huu's avatar
Franck Bui-Huu committed
238
extern int cmd_upload_archive(int argc, const char **argv, const char *prefix);
239
extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
240
extern int cmd_upload_pack(int argc, const char **argv, const char *prefix);
241
extern int cmd_var(int argc, const char **argv, const char *prefix);
242
extern int cmd_verify_commit(int argc, const char **argv, const char *prefix);
Carlos Rica's avatar
Carlos Rica committed
243
extern int cmd_verify_tag(int argc, const char **argv, const char *prefix);
244 245
extern int cmd_version(int argc, const char **argv, const char *prefix);
extern int cmd_whatchanged(int argc, const char **argv, const char *prefix);
246
extern int cmd_worktree(int argc, const char **argv, const char *prefix);
247
extern int cmd_write_tree(int argc, const char **argv, const char *prefix);
248
extern int cmd_verify_pack(int argc, const char **argv, const char *prefix);
249
extern int cmd_show_ref(int argc, const char **argv, const char *prefix);
250
extern int cmd_pack_refs(int argc, const char **argv, const char *prefix);
251
extern int cmd_replace(int argc, const char **argv, const char *prefix);
252

253
#endif