]>
Commit | Line | Data |
---|---|---|
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 MÅ |
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 | * | |
c409824c MÅ |
58 | * `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 | * | |
ec14d4ec MÅ |
66 | * . 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 | ||
1876166a RR |
97 | #define DEFAULT_MERGE_LOG_LEN 20 |
98 | ||
822a7d50 | 99 | extern const char git_usage_string[]; |
b7d96819 | 100 | extern const char git_more_info_string[]; |
70827b15 | 101 | |
af0b4a3b NTND |
102 | #define PRUNE_PACKED_DRY_RUN 01 |
103 | #define PRUNE_PACKED_VERBOSE 02 | |
104 | ||
2eb53e65 | 105 | extern void prune_packed_objects(int); |
cbda121c JH |
106 | |
107 | struct fmt_merge_msg_opts { | |
9bcbb1c2 JH |
108 | unsigned add_title:1, |
109 | credit_people:1; | |
cbda121c JH |
110 | int shortlog_len; |
111 | }; | |
112 | ||
1876166a | 113 | extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out, |
cbda121c | 114 | struct fmt_merge_msg_opts *); |
6956f858 | 115 | |
033fe3d9 MÅ |
116 | /** |
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 | */ | |
126 | extern void setup_auto_pager(const char *cmd, int def); | |
127 | ||
c6127fa3 SS |
128 | extern int is_builtin(const char *s); |
129 | ||
a633fca0 | 130 | extern int cmd_add(int argc, const char **argv, const char *prefix); |
73c2779f | 131 | extern int cmd_am(int argc, const char **argv, const char *prefix); |
f789e347 | 132 | extern int cmd_annotate(int argc, const char **argv, const char *prefix); |
f754fa9c | 133 | extern int cmd_apply(int argc, const char **argv, const char *prefix); |
4df096a5 | 134 | extern int cmd_archive(int argc, const char **argv, const char *prefix); |
1bf072e3 | 135 | extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix); |
acca687f | 136 | extern int cmd_blame(int argc, const char **argv, const char *prefix); |
c31820c2 | 137 | extern int cmd_branch(int argc, const char **argv, const char *prefix); |
2e0afafe | 138 | extern int cmd_bundle(int argc, const char **argv, const char *prefix); |
f754fa9c | 139 | extern int cmd_cat_file(int argc, const char **argv, const char *prefix); |
782c2d65 | 140 | extern int cmd_checkout(int argc, const char **argv, const char *prefix); |
f754fa9c | 141 | extern int cmd_checkout_index(int argc, const char **argv, const char *prefix); |
d0bfd026 | 142 | extern int cmd_check_attr(int argc, const char **argv, const char *prefix); |
368aa529 | 143 | extern int cmd_check_ignore(int argc, const char **argv, const char *prefix); |
226ad348 | 144 | extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix); |
a633fca0 | 145 | extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix); |
e827633a | 146 | extern int cmd_cherry(int argc, const char **argv, const char *prefix); |
9509af68 | 147 | extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix); |
8434c2f1 | 148 | extern int cmd_clone(int argc, const char **argv, const char *prefix); |
113f10f2 | 149 | extern int cmd_clean(int argc, const char **argv, const char *prefix); |
7e29b825 | 150 | extern int cmd_column(int argc, const char **argv, const char *prefix); |
f5bbc322 | 151 | extern int cmd_commit(int argc, const char **argv, const char *prefix); |
4ce58ee3 | 152 | extern int cmd_commit_graph(int argc, const char **argv, const char *prefix); |
a633fca0 | 153 | extern int cmd_commit_tree(int argc, const char **argv, const char *prefix); |
6390c905 | 154 | extern int cmd_config(int argc, const char **argv, const char *prefix); |
f754fa9c | 155 | extern int cmd_count_objects(int argc, const char **argv, const char *prefix); |
e30b2feb | 156 | extern int cmd_credential(int argc, const char **argv, const char *prefix); |
9a0eaf83 | 157 | extern int cmd_describe(int argc, const char **argv, const char *prefix); |
a633fca0 LT |
158 | extern int cmd_diff_files(int argc, const char **argv, const char *prefix); |
159 | extern int cmd_diff_index(int argc, const char **argv, const char *prefix); | |
f754fa9c | 160 | extern int cmd_diff(int argc, const char **argv, const char *prefix); |
a633fca0 | 161 | extern int cmd_diff_tree(int argc, const char **argv, const char *prefix); |
be8a90e5 | 162 | extern int cmd_difftool(int argc, const char **argv, const char *prefix); |
f2dc849e | 163 | extern int cmd_fast_export(int argc, const char **argv, const char *prefix); |
b888d61c | 164 | extern int cmd_fetch(int argc, const char **argv, const char *prefix); |
2d4177c0 | 165 | extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix); |
a633fca0 | 166 | extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix); |
9f613ddd | 167 | extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix); |
f754fa9c | 168 | extern int cmd_format_patch(int argc, const char **argv, const char *prefix); |
b4dfefe0 | 169 | extern int cmd_fsck(int argc, const char **argv, const char *prefix); |
6757ada4 | 170 | extern int cmd_gc(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
171 | extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix); |
172 | extern int cmd_grep(int argc, const char **argv, const char *prefix); | |
b28a1ce0 | 173 | extern int cmd_hash_object(int argc, const char **argv, const char *prefix); |
f754fa9c | 174 | extern int cmd_help(int argc, const char **argv, const char *prefix); |
3bb72562 | 175 | extern int cmd_index_pack(int argc, const char **argv, const char *prefix); |
f754fa9c | 176 | extern int cmd_init_db(int argc, const char **argv, const char *prefix); |
6634f054 | 177 | extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix); |
f754fa9c | 178 | extern int cmd_log(int argc, const char **argv, const char *prefix); |
cf39f54e | 179 | extern int cmd_log_reflog(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
180 | extern int cmd_ls_files(int argc, const char **argv, const char *prefix); |
181 | extern int cmd_ls_tree(int argc, const char **argv, const char *prefix); | |
8951d7c1 | 182 | extern int cmd_ls_remote(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
183 | extern int cmd_mailinfo(int argc, const char **argv, const char *prefix); |
184 | extern int cmd_mailsplit(int argc, const char **argv, const char *prefix); | |
1c7b76be | 185 | extern int cmd_merge(int argc, const char **argv, const char *prefix); |
71dfbf22 | 186 | extern int cmd_merge_base(int argc, const char **argv, const char *prefix); |
0ecace72 | 187 | extern int cmd_merge_index(int argc, const char **argv, const char *prefix); |
a00a42ae | 188 | extern int cmd_merge_ours(int argc, const char **argv, const char *prefix); |
ba1f5f35 | 189 | extern int cmd_merge_file(int argc, const char **argv, const char *prefix); |
e1b3a2ca | 190 | extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix); |
907a7cb5 | 191 | extern int cmd_merge_tree(int argc, const char **argv, const char *prefix); |
112dd514 | 192 | extern int cmd_mktag(int argc, const char **argv, const char *prefix); |
633e3556 | 193 | extern int cmd_mktree(int argc, const char **argv, const char *prefix); |
7061cf0f | 194 | extern int cmd_mv(int argc, const char **argv, const char *prefix); |
d6b64ed0 | 195 | extern int cmd_name_rev(int argc, const char **argv, const char *prefix); |
cd067d3b | 196 | extern int cmd_notes(int argc, const char **argv, const char *prefix); |
5d4a6003 | 197 | extern int cmd_pack_objects(int argc, const char **argv, const char *prefix); |
377d0276 | 198 | extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix); |
dedc0ec5 | 199 | extern int cmd_patch_id(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
200 | extern int cmd_prune(int argc, const char **argv, const char *prefix); |
201 | extern int cmd_prune_packed(int argc, const char **argv, const char *prefix); | |
1e1ea69f | 202 | extern int cmd_pull(int argc, const char **argv, const char *prefix); |
f754fa9c | 203 | extern int cmd_push(int argc, const char **argv, const char *prefix); |
348ae56c | 204 | extern int cmd_range_diff(int argc, const char **argv, const char *prefix); |
f754fa9c | 205 | extern int cmd_read_tree(int argc, const char **argv, const char *prefix); |
4557f1ad | 206 | extern int cmd_rebase__helper(int argc, const char **argv, const char *prefix); |
be5908ae | 207 | extern int cmd_receive_pack(int argc, const char **argv, const char *prefix); |
4264dc15 | 208 | extern int cmd_reflog(int argc, const char **argv, const char *prefix); |
211c8968 | 209 | extern int cmd_remote(int argc, const char **argv, const char *prefix); |
7f3ecebf | 210 | extern int cmd_remote_ext(int argc, const char **argv, const char *prefix); |
3a9ed4bd | 211 | extern int cmd_remote_fd(int argc, const char **argv, const char *prefix); |
a1bbc6c0 | 212 | extern int cmd_repack(int argc, const char **argv, const char *prefix); |
658f3650 | 213 | extern int cmd_rerere(int argc, const char **argv, const char *prefix); |
0e5a7faa | 214 | extern int cmd_reset(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
215 | extern int cmd_rev_list(int argc, const char **argv, const char *prefix); |
216 | extern int cmd_rev_parse(int argc, const char **argv, const char *prefix); | |
9509af68 | 217 | extern int cmd_revert(int argc, const char **argv, const char *prefix); |
f754fa9c | 218 | extern int cmd_rm(int argc, const char **argv, const char *prefix); |
96249c04 | 219 | extern int cmd_send_pack(int argc, const char **argv, const char *prefix); |
ed10cb95 | 220 | extern int cmd_serve(int argc, const char **argv, const char *prefix); |
b8ec5923 | 221 | extern int cmd_shortlog(int argc, const char **argv, const char *prefix); |
f754fa9c | 222 | extern int cmd_show(int argc, const char **argv, const char *prefix); |
9f613ddd | 223 | extern int cmd_show_branch(int argc, const char **argv, const char *prefix); |
ff417260 | 224 | extern int cmd_show_index(int argc, const char **argv, const char *prefix); |
f5bbc322 | 225 | extern int cmd_status(int argc, const char **argv, const char *prefix); |
f754fa9c | 226 | extern int cmd_stripspace(int argc, const char **argv, const char *prefix); |
74703a1e | 227 | extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix); |
640ce105 | 228 | extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix); |
62e09ce9 | 229 | extern int cmd_tag(int argc, const char **argv, const char *prefix); |
f754fa9c | 230 | extern int cmd_tar_tree(int argc, const char **argv, const char *prefix); |
b5325818 | 231 | extern int cmd_unpack_file(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
232 | extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix); |
233 | extern int cmd_update_index(int argc, const char **argv, const char *prefix); | |
234 | extern int cmd_update_ref(int argc, const char **argv, const char *prefix); | |
53a1116c | 235 | extern int cmd_update_server_info(int argc, const char **argv, const char *prefix); |
39345a21 | 236 | extern int cmd_upload_archive(int argc, const char **argv, const char *prefix); |
1bc01efe | 237 | extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix); |
a3d6b53e | 238 | extern int cmd_upload_pack(int argc, const char **argv, const char *prefix); |
55b6745d | 239 | extern int cmd_var(int argc, const char **argv, const char *prefix); |
d07b00b7 | 240 | extern int cmd_verify_commit(int argc, const char **argv, const char *prefix); |
2ae68fcb | 241 | extern int cmd_verify_tag(int argc, const char **argv, const char *prefix); |
f754fa9c JH |
242 | extern int cmd_version(int argc, const char **argv, const char *prefix); |
243 | extern int cmd_whatchanged(int argc, const char **argv, const char *prefix); | |
df0b6cfb | 244 | extern int cmd_worktree(int argc, const char **argv, const char *prefix); |
a633fca0 | 245 | extern int cmd_write_tree(int argc, const char **argv, const char *prefix); |
2e3ed670 | 246 | extern int cmd_verify_pack(int argc, const char **argv, const char *prefix); |
358ddb62 | 247 | extern int cmd_show_ref(int argc, const char **argv, const char *prefix); |
e1e22e37 | 248 | extern int cmd_pack_refs(int argc, const char **argv, const char *prefix); |
54b0c1e0 | 249 | extern int cmd_replace(int argc, const char **argv, const char *prefix); |
34488e3c | 250 | |
70827b15 | 251 | #endif |