blob: 962f0489ab212cc613d98ac2577f3999278d099b [file] [log] [blame]
Linus Torvalds70827b12006-04-21 10:27:34 -07001#ifndef BUILTIN_H
2#define BUILTIN_H
3
Junio C Hamanod0c24492006-09-15 22:47:21 -07004#include "git-compat-util.h"
Miklos Vajna0b9a9692008-06-27 18:21:59 +02005#include "strbuf.h"
Miklos Vajna7b9c0a62008-07-01 04:37:49 +02006#include "cache.h"
7#include "commit.h"
Linus Torvalds70827b12006-04-21 10:27:34 -07008
Martin Ågrenec14d4e2017-08-02 21:40:49 +02009/*
10 * builtin API
11 * ===========
12 *
13 * Adding a new built-in
14 * ---------------------
15 *
16 * There are 4 things to do to add a built-in command implementation to
17 * Git:
18 *
19 * . Define the implementation of the built-in command `foo` with
20 * signature:
21 *
22 * int cmd_foo(int argc, const char **argv, const char *prefix);
23 *
24 * . Add the external declaration for the function to `builtin.h`.
25 *
26 * . Add the command to the `commands[]` table defined in `git.c`.
27 * The entry should look like:
28 *
29 * { "foo", cmd_foo, <options> },
30 *
31 * where options is the bitwise-or of:
32 *
33 * `RUN_SETUP`:
34 * If there is not a Git directory to work on, abort. If there
35 * is a work tree, chdir to the top of it if the command was
36 * invoked in a subdirectory. If there is no work tree, no
37 * chdir() is done.
38 *
39 * `RUN_SETUP_GENTLY`:
40 * If there is a Git directory, chdir as per RUN_SETUP, otherwise,
41 * don't chdir anywhere.
42 *
43 * `USE_PAGER`:
44 *
45 * If the standard output is connected to a tty, spawn a pager and
46 * feed our output to it.
47 *
48 * `NEED_WORK_TREE`:
49 *
50 * Make sure there is a work tree, i.e. the command cannot act
51 * on bare repositories.
52 * This only makes sense when `RUN_SETUP` is also set.
53 *
54 * `SUPPORT_SUPER_PREFIX`:
55 *
56 * The built-in supports `--super-prefix`.
57 *
Martin Ågrenc4098242017-08-02 21:40:50 +020058 * `DELAY_PAGER_CONFIG`:
59 *
60 * If RUN_SETUP or RUN_SETUP_GENTLY is set, git.c normally handles
61 * the `pager.<cmd>`-configuration. If this flag is used, git.c
62 * will skip that step, instead allowing the built-in to make a
63 * more informed decision, e.g., by ignoring `pager.<cmd>` for
64 * certain subcommands.
65 *
Martin Ågrenec14d4e2017-08-02 21:40:49 +020066 * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
67 *
68 * Additionally, if `foo` is a new command, there are 4 more things to do:
69 *
70 * . Add tests to `t/` directory.
71 *
72 * . Write documentation in `Documentation/git-foo.txt`.
73 *
74 * . Add an entry for `git-foo` to `command-list.txt`.
75 *
76 * . Add an entry for `/git-foo` to `.gitignore`.
77 *
78 *
79 * How a built-in is called
80 * ------------------------
81 *
82 * The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
83 * and `prefix`. The first two are similar to what `main()` of a
84 * standalone command would be called with.
85 *
86 * When `RUN_SETUP` is specified in the `commands[]` table, and when you
87 * were started from a subdirectory of the work tree, `cmd_foo()` is called
88 * after chdir(2) to the top of the work tree, and `prefix` gets the path
89 * to the subdirectory the command started from. This allows you to
90 * convert a user-supplied pathname (typically relative to that directory)
91 * to a pathname relative to the top of the work tree.
92 *
93 * The return value from `cmd_foo()` becomes the exit status of the
94 * command.
95 */
96
Ramkumar Ramachandra18761662010-09-08 23:29:53 +053097#define DEFAULT_MERGE_LOG_LEN 20
98
Ramsay Allan Jones822a7d52006-07-30 22:42:25 +010099extern const char git_usage_string[];
Teemu Likonenb7d96812008-06-06 00:15:36 +0300100extern const char git_more_info_string[];
Linus Torvalds70827b12006-04-21 10:27:34 -0700101
Nguyễn Thái Ngọc Duyaf0b4a32013-05-27 18:18:47 +0700102#define PRUNE_PACKED_DRY_RUN 01
103#define PRUNE_PACKED_VERBOSE 02
104
J. Bruce Fields2eb53e62006-10-22 19:01:23 -0400105extern void prune_packed_objects(int);
Junio C Hamanocbda1212011-11-04 17:35:42 -0700106
107struct fmt_merge_msg_opts {
Junio C Hamano9bcbb1c2012-12-28 15:29:31 -0800108 unsigned add_title:1,
109 credit_people:1;
Junio C Hamanocbda1212011-11-04 17:35:42 -0700110 int shortlog_len;
111};
112
Ramkumar Ramachandra18761662010-09-08 23:29:53 +0530113extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
Junio C Hamanocbda1212011-11-04 17:35:42 -0700114 struct fmt_merge_msg_opts *);
Thomas Rast6956f852010-03-12 18:04:32 +0100115
Martin Ågren033fe3d2017-08-02 21:40:51 +0200116/**
117 * If a built-in has DELAY_PAGER_CONFIG set, the built-in should call this early
118 * when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
119 * the built-in, e.g., "foo". If a paging-choice has already been setup, this
120 * does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
121 * on" or -1 for "punt".
122 *
123 * You should most likely use a default of 0 or 1. "Punt" (-1) could be useful
124 * to be able to fall back to some historical compatibility name.
125 */
126extern void setup_auto_pager(const char *cmd, int def);
127
Sebastian Schuberthc6127fa2014-01-02 17:17:11 +0100128extern int is_builtin(const char *s);
129
Junio C Hamanof754fa92006-08-04 01:51:04 -0700130extern int cmd_add(int argc, const char **argv, const char *prefix);
Paul Tan73c27792015-08-04 21:51:24 +0800131extern int cmd_am(int argc, const char **argv, const char *prefix);
Ryan Andersonf789e342006-10-09 03:32:05 -0700132extern int cmd_annotate(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700133extern int cmd_apply(int argc, const char **argv, const char *prefix);
Franck Bui-Huu4df096a2006-09-07 15:12:02 +0200134extern int cmd_archive(int argc, const char **argv, const char *prefix);
Christian Couder1bf072e2009-03-26 05:55:54 +0100135extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix);
Junio C Hamanoacca6872006-11-08 18:47:54 -0800136extern int cmd_blame(int argc, const char **argv, const char *prefix);
Lars Hjemlic31820c2006-10-23 23:27:45 +0200137extern int cmd_branch(int argc, const char **argv, const char *prefix);
Johannes Schindelin2e0afaf2007-02-22 01:59:14 +0100138extern int cmd_bundle(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700139extern int cmd_cat_file(int argc, const char **argv, const char *prefix);
Daniel Barkalow782c2d62008-02-07 11:40:23 -0500140extern int cmd_checkout(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700141extern int cmd_checkout_index(int argc, const char **argv, const char *prefix);
Junio C Hamanod0bfd022007-04-12 01:07:32 -0700142extern int cmd_check_attr(int argc, const char **argv, const char *prefix);
Adam Spiers368aa522013-01-06 16:58:13 +0000143extern int cmd_check_ignore(int argc, const char **argv, const char *prefix);
Eric Sunshine226ad342013-07-12 20:53:10 -0400144extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700145extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
Rene Scharfee8276332006-10-24 01:01:57 +0200146extern int cmd_cherry(int argc, const char **argv, const char *prefix);
Johannes Schindelin9509af62007-03-01 05:26:30 +0100147extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
Daniel Barkalow8434c2f2008-04-27 13:39:30 -0400148extern int cmd_clone(int argc, const char **argv, const char *prefix);
Shawn Bohrer113f10f2007-11-11 19:48:47 -0600149extern int cmd_clean(int argc, const char **argv, const char *prefix);
Nguyễn Thái Ngọc Duy7e29b822012-04-21 11:44:32 +0700150extern int cmd_column(int argc, const char **argv, const char *prefix);
Kristian Høgsbergf5bbc322007-11-08 11:59:00 -0500151extern int cmd_commit(int argc, const char **argv, const char *prefix);
Derrick Stolee4ce58ee2018-04-02 16:34:18 -0400152extern int cmd_commit_graph(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700153extern int cmd_commit_tree(int argc, const char **argv, const char *prefix);
René Scharfe6390c902011-02-12 14:24:10 +0100154extern int cmd_config(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700155extern int cmd_count_objects(int argc, const char **argv, const char *prefix);
Javier Roucher Iglesiase30b2fe2012-06-24 13:39:59 +0200156extern int cmd_credential(int argc, const char **argv, const char *prefix);
Shawn O. Pearce9a0eaf82007-01-10 06:36:36 -0500157extern int cmd_describe(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700158extern int cmd_diff_files(int argc, const char **argv, const char *prefix);
159extern int cmd_diff_index(int argc, const char **argv, const char *prefix);
160extern int cmd_diff(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700161extern int cmd_diff_tree(int argc, const char **argv, const char *prefix);
Johannes Schindelinbe8a90e2017-01-17 16:54:57 +0100162extern int cmd_difftool(int argc, const char **argv, const char *prefix);
Johannes Schindelinf2dc8492007-12-02 14:14:13 +0000163extern int cmd_fast_export(int argc, const char **argv, const char *prefix);
Daniel Barkalowb888d612007-09-10 23:03:25 -0400164extern int cmd_fetch(int argc, const char **argv, const char *prefix);
Daniel Barkalow2d4177c2007-09-10 23:03:00 -0400165extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700166extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
Junio C Hamano9f613dd2006-09-15 13:30:02 -0700167extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700168extern int cmd_format_patch(int argc, const char **argv, const char *prefix);
Mark Woodingb4dfefe2007-01-29 15:48:06 +0000169extern int cmd_fsck(int argc, const char **argv, const char *prefix);
James Bowes6757ada2007-03-13 21:58:22 -0400170extern int cmd_gc(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700171extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
172extern int cmd_grep(int argc, const char **argv, const char *prefix);
Linus Torvaldsb28a1ce2010-01-21 19:50:11 -0800173extern int cmd_hash_object(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700174extern int cmd_help(int argc, const char **argv, const char *prefix);
Linus Torvalds3bb72562010-01-22 07:55:19 -0800175extern int cmd_index_pack(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700176extern int cmd_init_db(int argc, const char **argv, const char *prefix);
Christian Couder6634f052014-10-13 20:16:29 +0200177extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700178extern int cmd_log(int argc, const char **argv, const char *prefix);
Linus Torvaldscf39f542007-02-08 09:51:56 -0800179extern int cmd_log_reflog(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700180extern int cmd_ls_files(int argc, const char **argv, const char *prefix);
181extern int cmd_ls_tree(int argc, const char **argv, const char *prefix);
Daniel Barkalow8951d7c2007-11-04 15:51:17 -0500182extern int cmd_ls_remote(int argc, const char **argv, const char *prefix);
Linus Torvaldsa633fca2006-07-28 22:44:25 -0700183extern int cmd_mailinfo(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700184extern int cmd_mailsplit(int argc, const char **argv, const char *prefix);
Miklos Vajna1c7b76b2008-07-07 19:24:20 +0200185extern int cmd_merge(int argc, const char **argv, const char *prefix);
Junio C Hamano71dfbf22007-01-09 00:50:02 -0800186extern int cmd_merge_base(int argc, const char **argv, const char *prefix);
Linus Torvalds0ecace72010-01-22 07:29:21 -0800187extern int cmd_merge_index(int argc, const char **argv, const char *prefix);
Thomas Harninga00a42a2007-11-22 15:19:40 -0500188extern int cmd_merge_ours(int argc, const char **argv, const char *prefix);
Johannes Schindelinba1f5f32006-12-06 16:26:06 +0100189extern int cmd_merge_file(int argc, const char **argv, const char *prefix);
Daniel Barkalowe1b3a2c2008-02-07 11:40:05 -0500190extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
Linus Torvalds907a7cb2010-01-21 18:25:20 -0800191extern int cmd_merge_tree(int argc, const char **argv, const char *prefix);
Linus Torvalds112dd512010-01-22 07:34:44 -0800192extern int cmd_mktag(int argc, const char **argv, const char *prefix);
Junio C Hamano633e3552009-05-10 10:28:18 -0700193extern int cmd_mktree(int argc, const char **argv, const char *prefix);
Derrick Stolee6a257f02018-07-12 15:39:20 -0400194extern int cmd_multi_pack_index(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700195extern int cmd_mv(int argc, const char **argv, const char *prefix);
196extern int cmd_name_rev(int argc, const char **argv, const char *prefix);
Johan Herlandcd067d32010-02-13 22:28:20 +0100197extern int cmd_notes(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700198extern int cmd_pack_objects(int argc, const char **argv, const char *prefix);
Linus Torvalds377d0272010-01-22 07:42:14 -0800199extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
Linus Torvaldsdedc0ec2010-01-21 20:31:25 -0800200extern int cmd_patch_id(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700201extern int cmd_prune(int argc, const char **argv, const char *prefix);
202extern int cmd_prune_packed(int argc, const char **argv, const char *prefix);
Paul Tan1e1ea692015-06-14 16:41:51 +0800203extern int cmd_pull(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700204extern int cmd_push(int argc, const char **argv, const char *prefix);
Johannes Schindelin348ae562018-08-13 04:33:02 -0700205extern int cmd_range_diff(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700206extern int cmd_read_tree(int argc, const char **argv, const char *prefix);
Johannes Schindelin4557f1a2017-02-09 23:23:06 +0100207extern int cmd_rebase__helper(int argc, const char **argv, const char *prefix);
Junio C Hamanobe5908a2008-09-09 01:27:08 -0700208extern int cmd_receive_pack(int argc, const char **argv, const char *prefix);
Junio C Hamano4264dc12006-12-19 00:23:12 -0800209extern int cmd_reflog(int argc, const char **argv, const char *prefix);
Johannes Schindelin211c8962008-02-29 01:45:45 +0000210extern int cmd_remote(int argc, const char **argv, const char *prefix);
Ilari Liusvaara7f3eceb2010-10-12 19:39:43 +0300211extern int cmd_remote_ext(int argc, const char **argv, const char *prefix);
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +0300212extern int cmd_remote_fd(int argc, const char **argv, const char *prefix);
Stefan Bellera1bbc6c2013-09-15 17:33:20 +0200213extern int cmd_repack(int argc, const char **argv, const char *prefix);
Johannes Schindelin658f3652006-12-20 17:39:41 +0100214extern int cmd_rerere(int argc, const char **argv, const char *prefix);
Carlos Rica0e5a7fa2007-09-11 05:19:34 +0200215extern int cmd_reset(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700216extern int cmd_rev_list(int argc, const char **argv, const char *prefix);
217extern int cmd_rev_parse(int argc, const char **argv, const char *prefix);
Johannes Schindelin9509af62007-03-01 05:26:30 +0100218extern int cmd_revert(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700219extern int cmd_rm(int argc, const char **argv, const char *prefix);
Daniel Barkalow96249c02007-10-29 22:03:39 -0400220extern int cmd_send_pack(int argc, const char **argv, const char *prefix);
Brandon Williamsed10cb92018-03-15 10:31:19 -0700221extern int cmd_serve(int argc, const char **argv, const char *prefix);
Johannes Schindelinb8ec5922006-10-22 13:23:31 +0200222extern int cmd_shortlog(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700223extern int cmd_show(int argc, const char **argv, const char *prefix);
Junio C Hamano9f613dd2006-09-15 13:30:02 -0700224extern int cmd_show_branch(int argc, const char **argv, const char *prefix);
Jeff Kingff417262018-05-28 05:38:53 -0400225extern int cmd_show_index(int argc, const char **argv, const char *prefix);
Kristian Høgsbergf5bbc322007-11-08 11:59:00 -0500226extern int cmd_status(int argc, const char **argv, const char *prefix);
Linus Torvaldsa633fca2006-07-28 22:44:25 -0700227extern int cmd_stripspace(int argc, const char **argv, const char *prefix);
Stefan Beller74703a12015-09-02 14:42:24 -0700228extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700229extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200230extern int cmd_tag(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700231extern int cmd_tar_tree(int argc, const char **argv, const char *prefix);
Linus Torvaldsb5325812010-01-22 07:38:03 -0800232extern int cmd_unpack_file(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700233extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
234extern int cmd_update_index(int argc, const char **argv, const char *prefix);
235extern int cmd_update_ref(int argc, const char **argv, const char *prefix);
René Scharfe53a11162009-08-29 11:04:52 +0200236extern int cmd_update_server_info(int argc, const char **argv, const char *prefix);
Franck Bui-Huu39345a22006-09-07 15:12:05 +0200237extern int cmd_upload_archive(int argc, const char **argv, const char *prefix);
Jeff King1bc01ef2011-11-19 02:40:04 -0500238extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
Brandon Williamsa3d6b532018-03-14 11:31:41 -0700239extern int cmd_upload_pack(int argc, const char **argv, const char *prefix);
Linus Torvalds55b67452010-01-21 20:21:55 -0800240extern int cmd_var(int argc, const char **argv, const char *prefix);
Michael J Gruberd07b00b2014-06-23 09:05:49 +0200241extern int cmd_verify_commit(int argc, const char **argv, const char *prefix);
Carlos Rica2ae68fc2007-07-27 06:07:34 +0200242extern int cmd_verify_tag(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700243extern int cmd_version(int argc, const char **argv, const char *prefix);
244extern int cmd_whatchanged(int argc, const char **argv, const char *prefix);
Nguyễn Thái Ngọc Duydf0b6cf2015-06-29 19:51:18 +0700245extern int cmd_worktree(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700246extern int cmd_write_tree(int argc, const char **argv, const char *prefix);
Rene Scharfe2e3ed672006-08-10 17:02:38 +0200247extern int cmd_verify_pack(int argc, const char **argv, const char *prefix);
Linus Torvalds358ddb62006-09-15 11:19:32 -0700248extern int cmd_show_ref(int argc, const char **argv, const char *prefix);
Linus Torvaldse1e22e32006-09-11 16:37:32 -0700249extern int cmd_pack_refs(int argc, const char **argv, const char *prefix);
Christian Couder54b0c1e2009-02-02 06:12:44 +0100250extern int cmd_replace(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 01:51:04 -0700251
Linus Torvalds70827b12006-04-21 10:27:34 -0700252#endif