builtin.h: take over documentation from api-builtin.txt
[git/git.git] / builtin.h
CommitLineData
70827b15
LT
1#ifndef BUILTIN_H
2#define BUILTIN_H
3
d0c2449f 4#include "git-compat-util.h"
0b9a969e 5#include "strbuf.h"
7b9c0a69
MV
6#include "cache.h"
7#include "commit.h"
70827b15 8
ec14d4ec
9/*
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 *
58 * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
59 *
60 * Additionally, if `foo` is a new command, there are 4 more things to do:
61 *
62 * . Add tests to `t/` directory.
63 *
64 * . Write documentation in `Documentation/git-foo.txt`.
65 *
66 * . Add an entry for `git-foo` to `command-list.txt`.
67 *
68 * . Add an entry for `/git-foo` to `.gitignore`.
69 *
70 *
71 * How a built-in is called
72 * ------------------------
73 *
74 * The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
75 * and `prefix`. The first two are similar to what `main()` of a
76 * standalone command would be called with.
77 *
78 * When `RUN_SETUP` is specified in the `commands[]` table, and when you
79 * were started from a subdirectory of the work tree, `cmd_foo()` is called
80 * after chdir(2) to the top of the work tree, and `prefix` gets the path
81 * to the subdirectory the command started from. This allows you to
82 * convert a user-supplied pathname (typically relative to that directory)
83 * to a pathname relative to the top of the work tree.
84 *
85 * The return value from `cmd_foo()` becomes the exit status of the
86 * command.
87 */
88
1876166a
RR
89#define DEFAULT_MERGE_LOG_LEN 20
90
822a7d50 91extern const char git_usage_string[];
b7d96819 92extern const char git_more_info_string[];
70827b15 93
af0b4a3b
NTND
94#define PRUNE_PACKED_DRY_RUN 01
95#define PRUNE_PACKED_VERBOSE 02
96
2eb53e65 97extern void prune_packed_objects(int);
cbda121c
JH
98
99struct fmt_merge_msg_opts {
9bcbb1c2
JH
100 unsigned add_title:1,
101 credit_people:1;
cbda121c
JH
102 int shortlog_len;
103};
104
1876166a 105extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
cbda121c 106 struct fmt_merge_msg_opts *);
6956f858 107
c6127fa3
SS
108extern int is_builtin(const char *s);
109
a633fca0 110extern int cmd_add(int argc, const char **argv, const char *prefix);
73c2779f 111extern int cmd_am(int argc, const char **argv, const char *prefix);
f789e347 112extern int cmd_annotate(int argc, const char **argv, const char *prefix);
f754fa9c 113extern int cmd_apply(int argc, const char **argv, const char *prefix);
4df096a5 114extern int cmd_archive(int argc, const char **argv, const char *prefix);
1bf072e3 115extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix);
acca687f 116extern int cmd_blame(int argc, const char **argv, const char *prefix);
c31820c2 117extern int cmd_branch(int argc, const char **argv, const char *prefix);
2e0afafe 118extern int cmd_bundle(int argc, const char **argv, const char *prefix);
f754fa9c 119extern int cmd_cat_file(int argc, const char **argv, const char *prefix);
782c2d65 120extern int cmd_checkout(int argc, const char **argv, const char *prefix);
f754fa9c 121extern int cmd_checkout_index(int argc, const char **argv, const char *prefix);
d0bfd026 122extern int cmd_check_attr(int argc, const char **argv, const char *prefix);
368aa529 123extern int cmd_check_ignore(int argc, const char **argv, const char *prefix);
226ad348 124extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
a633fca0 125extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
e827633a 126extern int cmd_cherry(int argc, const char **argv, const char *prefix);
9509af68 127extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
8434c2f1 128extern int cmd_clone(int argc, const char **argv, const char *prefix);
113f10f2 129extern int cmd_clean(int argc, const char **argv, const char *prefix);
7e29b825 130extern int cmd_column(int argc, const char **argv, const char *prefix);
f5bbc322 131extern int cmd_commit(int argc, const char **argv, const char *prefix);
a633fca0 132extern int cmd_commit_tree(int argc, const char **argv, const char *prefix);
6390c905 133extern int cmd_config(int argc, const char **argv, const char *prefix);
f754fa9c 134extern int cmd_count_objects(int argc, const char **argv, const char *prefix);
e30b2feb 135extern int cmd_credential(int argc, const char **argv, const char *prefix);
9a0eaf83 136extern int cmd_describe(int argc, const char **argv, const char *prefix);
a633fca0
LT
137extern int cmd_diff_files(int argc, const char **argv, const char *prefix);
138extern int cmd_diff_index(int argc, const char **argv, const char *prefix);
f754fa9c 139extern int cmd_diff(int argc, const char **argv, const char *prefix);
a633fca0 140extern int cmd_diff_tree(int argc, const char **argv, const char *prefix);
be8a90e5 141extern int cmd_difftool(int argc, const char **argv, const char *prefix);
f2dc849e 142extern int cmd_fast_export(int argc, const char **argv, const char *prefix);
b888d61c 143extern int cmd_fetch(int argc, const char **argv, const char *prefix);
2d4177c0 144extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
a633fca0 145extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
9f613ddd 146extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
f754fa9c 147extern int cmd_format_patch(int argc, const char **argv, const char *prefix);
b4dfefe0 148extern int cmd_fsck(int argc, const char **argv, const char *prefix);
6757ada4 149extern int cmd_gc(int argc, const char **argv, const char *prefix);
f754fa9c
JH
150extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
151extern int cmd_grep(int argc, const char **argv, const char *prefix);
b28a1ce0 152extern int cmd_hash_object(int argc, const char **argv, const char *prefix);
f754fa9c 153extern int cmd_help(int argc, const char **argv, const char *prefix);
3bb72562 154extern int cmd_index_pack(int argc, const char **argv, const char *prefix);
f754fa9c 155extern int cmd_init_db(int argc, const char **argv, const char *prefix);
6634f054 156extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
f754fa9c 157extern int cmd_log(int argc, const char **argv, const char *prefix);
cf39f54e 158extern int cmd_log_reflog(int argc, const char **argv, const char *prefix);
f754fa9c
JH
159extern int cmd_ls_files(int argc, const char **argv, const char *prefix);
160extern int cmd_ls_tree(int argc, const char **argv, const char *prefix);
8951d7c1 161extern int cmd_ls_remote(int argc, const char **argv, const char *prefix);
f754fa9c
JH
162extern int cmd_mailinfo(int argc, const char **argv, const char *prefix);
163extern int cmd_mailsplit(int argc, const char **argv, const char *prefix);
1c7b76be 164extern int cmd_merge(int argc, const char **argv, const char *prefix);
71dfbf22 165extern int cmd_merge_base(int argc, const char **argv, const char *prefix);
0ecace72 166extern int cmd_merge_index(int argc, const char **argv, const char *prefix);
a00a42ae 167extern int cmd_merge_ours(int argc, const char **argv, const char *prefix);
ba1f5f35 168extern int cmd_merge_file(int argc, const char **argv, const char *prefix);
e1b3a2ca 169extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
907a7cb5 170extern int cmd_merge_tree(int argc, const char **argv, const char *prefix);
112dd514 171extern int cmd_mktag(int argc, const char **argv, const char *prefix);
633e3556 172extern int cmd_mktree(int argc, const char **argv, const char *prefix);
7061cf0f 173extern int cmd_mv(int argc, const char **argv, const char *prefix);
d6b64ed0 174extern int cmd_name_rev(int argc, const char **argv, const char *prefix);
cd067d3b 175extern int cmd_notes(int argc, const char **argv, const char *prefix);
5d4a6003 176extern int cmd_pack_objects(int argc, const char **argv, const char *prefix);
377d0276 177extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
dedc0ec5 178extern int cmd_patch_id(int argc, const char **argv, const char *prefix);
f754fa9c
JH
179extern int cmd_prune(int argc, const char **argv, const char *prefix);
180extern int cmd_prune_packed(int argc, const char **argv, const char *prefix);
1e1ea69f 181extern int cmd_pull(int argc, const char **argv, const char *prefix);
f754fa9c
JH
182extern int cmd_push(int argc, const char **argv, const char *prefix);
183extern int cmd_read_tree(int argc, const char **argv, const char *prefix);
4557f1ad 184extern int cmd_rebase__helper(int argc, const char **argv, const char *prefix);
be5908ae 185extern int cmd_receive_pack(int argc, const char **argv, const char *prefix);
4264dc15 186extern int cmd_reflog(int argc, const char **argv, const char *prefix);
211c8968 187extern int cmd_remote(int argc, const char **argv, const char *prefix);
7f3ecebf 188extern int cmd_remote_ext(int argc, const char **argv, const char *prefix);
3a9ed4bd 189extern int cmd_remote_fd(int argc, const char **argv, const char *prefix);
a1bbc6c0 190extern int cmd_repack(int argc, const char **argv, const char *prefix);
658f3650 191extern int cmd_rerere(int argc, const char **argv, const char *prefix);
0e5a7faa 192extern int cmd_reset(int argc, const char **argv, const char *prefix);
f754fa9c
JH
193extern int cmd_rev_list(int argc, const char **argv, const char *prefix);
194extern int cmd_rev_parse(int argc, const char **argv, const char *prefix);
9509af68 195extern int cmd_revert(int argc, const char **argv, const char *prefix);
f754fa9c 196extern int cmd_rm(int argc, const char **argv, const char *prefix);
96249c04 197extern int cmd_send_pack(int argc, const char **argv, const char *prefix);
b8ec5923 198extern int cmd_shortlog(int argc, const char **argv, const char *prefix);
f754fa9c 199extern int cmd_show(int argc, const char **argv, const char *prefix);
9f613ddd 200extern int cmd_show_branch(int argc, const char **argv, const char *prefix);
f5bbc322 201extern int cmd_status(int argc, const char **argv, const char *prefix);
f754fa9c 202extern int cmd_stripspace(int argc, const char **argv, const char *prefix);
74703a1e 203extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
640ce105 204extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
62e09ce9 205extern int cmd_tag(int argc, const char **argv, const char *prefix);
f754fa9c 206extern int cmd_tar_tree(int argc, const char **argv, const char *prefix);
b5325818 207extern int cmd_unpack_file(int argc, const char **argv, const char *prefix);
f754fa9c
JH
208extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
209extern int cmd_update_index(int argc, const char **argv, const char *prefix);
210extern int cmd_update_ref(int argc, const char **argv, const char *prefix);
53a1116c 211extern int cmd_update_server_info(int argc, const char **argv, const char *prefix);
39345a21 212extern int cmd_upload_archive(int argc, const char **argv, const char *prefix);
1bc01efe 213extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
55b6745d 214extern int cmd_var(int argc, const char **argv, const char *prefix);
d07b00b7 215extern int cmd_verify_commit(int argc, const char **argv, const char *prefix);
2ae68fcb 216extern int cmd_verify_tag(int argc, const char **argv, const char *prefix);
f754fa9c
JH
217extern int cmd_version(int argc, const char **argv, const char *prefix);
218extern int cmd_whatchanged(int argc, const char **argv, const char *prefix);
df0b6cfb 219extern int cmd_worktree(int argc, const char **argv, const char *prefix);
a633fca0 220extern int cmd_write_tree(int argc, const char **argv, const char *prefix);
2e3ed670 221extern int cmd_verify_pack(int argc, const char **argv, const char *prefix);
358ddb62 222extern int cmd_show_ref(int argc, const char **argv, const char *prefix);
e1e22e37 223extern int cmd_pack_refs(int argc, const char **argv, const char *prefix);
54b0c1e0 224extern int cmd_replace(int argc, const char **argv, const char *prefix);
34488e3c 225
70827b15 226#endif