🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.43.1 / . / builtin.h
blob: d560baa6618ac9e021dc7f957b942466ac6e35b3 [file] [log] [blame]
Linus Torvalds70827b12006-04-21 17:27:34[diff] [blame]1#ifndef BUILTIN_H
2#define BUILTIN_H
3
Junio C Hamanod0c24492006-09-16 05:47:21[diff] [blame]4#include "git-compat-util.h"
Linus Torvalds70827b12006-04-21 17:27:34[diff] [blame]5
Martin Ågrenec14d4e2017-08-02 19:40:49[diff] [blame]6/*
7 * builtin API
8 * ===========
9 *
10 * Adding a new built-in
11 * ---------------------
12 *
13 * There are 4 things to do to add a built-in command implementation to
14 * Git:
15 *
16 * . Define the implementation of the built-in command `foo` with
17 * signature:
18 *
19 * int cmd_foo(int argc, const char **argv, const char *prefix);
20 *
21 * . Add the external declaration for the function to `builtin.h`.
22 *
23 * . Add the command to the `commands[]` table defined in `git.c`.
24 * The entry should look like:
25 *
26 * { "foo", cmd_foo, <options> },
27 *
28 * where options is the bitwise-or of:
29 *
30 * `RUN_SETUP`:
31 * If there is not a Git directory to work on, abort. If there
32 * is a work tree, chdir to the top of it if the command was
33 * invoked in a subdirectory. If there is no work tree, no
34 * chdir() is done.
35 *
36 * `RUN_SETUP_GENTLY`:
37 * If there is a Git directory, chdir as per RUN_SETUP, otherwise,
38 * don't chdir anywhere.
39 *
40 * `USE_PAGER`:
41 *
42 * If the standard output is connected to a tty, spawn a pager and
43 * feed our output to it.
44 *
45 * `NEED_WORK_TREE`:
46 *
47 * Make sure there is a work tree, i.e. the command cannot act
48 * on bare repositories.
49 * This only makes sense when `RUN_SETUP` is also set.
50 *
Martin Ågrenc4098242017-08-02 19:40:50[diff] [blame]51 * `DELAY_PAGER_CONFIG`:
52 *
53 * If RUN_SETUP or RUN_SETUP_GENTLY is set, git.c normally handles
54 * the `pager.<cmd>`-configuration. If this flag is used, git.c
55 * will skip that step, instead allowing the built-in to make a
56 * more informed decision, e.g., by ignoring `pager.<cmd>` for
57 * certain subcommands.
58 *
Martin Ågrenec14d4e2017-08-02 19:40:49[diff] [blame]59 * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
60 *
61 * Additionally, if `foo` is a new command, there are 4 more things to do:
62 *
63 * . Add tests to `t/` directory.
64 *
65 * . Write documentation in `Documentation/git-foo.txt`.
66 *
67 * . Add an entry for `git-foo` to `command-list.txt`.
68 *
69 * . Add an entry for `/git-foo` to `.gitignore`.
70 *
71 *
72 * How a built-in is called
73 * ------------------------
74 *
75 * The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
76 * and `prefix`. The first two are similar to what `main()` of a
77 * standalone command would be called with.
78 *
79 * When `RUN_SETUP` is specified in the `commands[]` table, and when you
80 * were started from a subdirectory of the work tree, `cmd_foo()` is called
81 * after chdir(2) to the top of the work tree, and `prefix` gets the path
82 * to the subdirectory the command started from. This allows you to
83 * convert a user-supplied pathname (typically relative to that directory)
84 * to a pathname relative to the top of the work tree.
85 *
86 * The return value from `cmd_foo()` becomes the exit status of the
87 * command.
88 */
89
Ramsay Allan Jones822a7d52006-07-30 21:42:25[diff] [blame]90extern const char git_usage_string[];
Teemu Likonenb7d96812008-06-05 21:15:36[diff] [blame]91extern const char git_more_info_string[];
Linus Torvalds70827b12006-04-21 17:27:34[diff] [blame]92
Martin Ågren033fe3d2017-08-02 19:40:51[diff] [blame]93/**
94 * If a built-in has DELAY_PAGER_CONFIG set, the built-in should call this early
95 * when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
96 * the built-in, e.g., "foo". If a paging-choice has already been setup, this
97 * does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
98 * on" or -1 for "punt".
99 *
100 * You should most likely use a default of 0 or 1. "Punt" (-1) could be useful
101 * to be able to fall back to some historical compatibility name.
102 */
Denton Liu55454422019-04-29 08:28:14[diff] [blame]103void setup_auto_pager(const char *cmd, int def);
Martin Ågren033fe3d2017-08-02 19:40:51[diff] [blame]104
Denton Liu55454422019-04-29 08:28:14[diff] [blame]105int is_builtin(const char *s);
Sebastian Schuberthc6127fa2014-01-02 16:17:11[diff] [blame]106
Jeff King79156912023-03-28 20:55:17[diff] [blame]107/*
108 * Builtins which do not use RUN_SETUP should never see
109 * a prefix that is not empty; use this to protect downstream
110 * code which is not prepared to call prefix_filename(), etc.
111 */
112#define BUG_ON_NON_EMPTY_PREFIX(prefix) do { \
113 if ((prefix)) \
114 BUG("unexpected prefix in builtin: %s", (prefix)); \
115} while (0)
116
Denton Liu55454422019-04-29 08:28:14[diff] [blame]117int cmd_add(int argc, const char **argv, const char *prefix);
118int cmd_am(int argc, const char **argv, const char *prefix);
119int cmd_annotate(int argc, const char **argv, const char *prefix);
120int cmd_apply(int argc, const char **argv, const char *prefix);
121int cmd_archive(int argc, const char **argv, const char *prefix);
Johannes Schindelin73fce292022-11-10 16:36:46[diff] [blame]122int cmd_bisect(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]123int cmd_blame(int argc, const char **argv, const char *prefix);
124int cmd_branch(int argc, const char **argv, const char *prefix);
Jeff Kingd7a56492020-08-13 14:59:36[diff] [blame]125int cmd_bugreport(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]126int cmd_bundle(int argc, const char **argv, const char *prefix);
127int cmd_cat_file(int argc, const char **argv, const char *prefix);
128int cmd_checkout(int argc, const char **argv, const char *prefix);
Matheus Tavarese9e8adf2021-04-19 00:14:54[diff] [blame]129int cmd_checkout__worker(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]130int cmd_checkout_index(int argc, const char **argv, const char *prefix);
131int cmd_check_attr(int argc, const char **argv, const char *prefix);
132int cmd_check_ignore(int argc, const char **argv, const char *prefix);
133int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
134int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
135int cmd_cherry(int argc, const char **argv, const char *prefix);
136int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
137int cmd_clone(int argc, const char **argv, const char *prefix);
138int cmd_clean(int argc, const char **argv, const char *prefix);
139int cmd_column(int argc, const char **argv, const char *prefix);
140int cmd_commit(int argc, const char **argv, const char *prefix);
141int cmd_commit_graph(int argc, const char **argv, const char *prefix);
142int cmd_commit_tree(int argc, const char **argv, const char *prefix);
143int cmd_config(int argc, const char **argv, const char *prefix);
144int cmd_count_objects(int argc, const char **argv, const char *prefix);
145int cmd_credential(int argc, const char **argv, const char *prefix);
Jeff Kingb5dd96b2020-08-13 14:58:55[diff] [blame]146int cmd_credential_cache(int argc, const char **argv, const char *prefix);
147int cmd_credential_cache_daemon(int argc, const char **argv, const char *prefix);
148int cmd_credential_store(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]149int cmd_describe(int argc, const char **argv, const char *prefix);
Victoria Dye6783fd32022-08-12 20:10:15[diff] [blame]150int cmd_diagnose(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]151int cmd_diff_files(int argc, const char **argv, const char *prefix);
152int cmd_diff_index(int argc, const char **argv, const char *prefix);
153int cmd_diff(int argc, const char **argv, const char *prefix);
154int cmd_diff_tree(int argc, const char **argv, const char *prefix);
155int cmd_difftool(int argc, const char **argv, const char *prefix);
Ævar Arnfjörð Bjarmasonb4f207f2019-06-21 10:18:06[diff] [blame]156int cmd_env__helper(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]157int cmd_fast_export(int argc, const char **argv, const char *prefix);
Jeff Kinga006f872020-08-13 14:59:45[diff] [blame]158int cmd_fast_import(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]159int cmd_fetch(int argc, const char **argv, const char *prefix);
160int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
161int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
162int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
Derrick Stolee4950b2a2020-09-11 17:49:16[diff] [blame]163int cmd_for_each_repo(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]164int cmd_format_patch(int argc, const char **argv, const char *prefix);
165int cmd_fsck(int argc, const char **argv, const char *prefix);
Jeff Hostetler16d9d612022-03-25 18:02:49[diff] [blame]166int cmd_fsmonitor__daemon(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]167int cmd_gc(int argc, const char **argv, const char *prefix);
168int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
169int cmd_grep(int argc, const char **argv, const char *prefix);
170int cmd_hash_object(int argc, const char **argv, const char *prefix);
171int cmd_help(int argc, const char **argv, const char *prefix);
Emily Shaffer96e72252021-12-22 03:59:27[diff] [blame]172int cmd_hook(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]173int cmd_index_pack(int argc, const char **argv, const char *prefix);
174int cmd_init_db(int argc, const char **argv, const char *prefix);
175int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
176int cmd_log(int argc, const char **argv, const char *prefix);
177int cmd_log_reflog(int argc, const char **argv, const char *prefix);
178int cmd_ls_files(int argc, const char **argv, const char *prefix);
179int cmd_ls_tree(int argc, const char **argv, const char *prefix);
180int cmd_ls_remote(int argc, const char **argv, const char *prefix);
181int cmd_mailinfo(int argc, const char **argv, const char *prefix);
182int cmd_mailsplit(int argc, const char **argv, const char *prefix);
Derrick Stolee2057d752020-09-17 18:11:42[diff] [blame]183int cmd_maintenance(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]184int cmd_merge(int argc, const char **argv, const char *prefix);
185int cmd_merge_base(int argc, const char **argv, const char *prefix);
186int cmd_merge_index(int argc, const char **argv, const char *prefix);
187int cmd_merge_ours(int argc, const char **argv, const char *prefix);
188int cmd_merge_file(int argc, const char **argv, const char *prefix);
189int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
190int cmd_merge_tree(int argc, const char **argv, const char *prefix);
191int cmd_mktag(int argc, const char **argv, const char *prefix);
192int cmd_mktree(int argc, const char **argv, const char *prefix);
193int cmd_multi_pack_index(int argc, const char **argv, const char *prefix);
194int cmd_mv(int argc, const char **argv, const char *prefix);
195int cmd_name_rev(int argc, const char **argv, const char *prefix);
196int cmd_notes(int argc, const char **argv, const char *prefix);
197int cmd_pack_objects(int argc, const char **argv, const char *prefix);
198int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
199int cmd_patch_id(int argc, const char **argv, const char *prefix);
200int cmd_prune(int argc, const char **argv, const char *prefix);
201int cmd_prune_packed(int argc, const char **argv, const char *prefix);
202int cmd_pull(int argc, const char **argv, const char *prefix);
203int cmd_push(int argc, const char **argv, const char *prefix);
204int cmd_range_diff(int argc, const char **argv, const char *prefix);
205int cmd_read_tree(int argc, const char **argv, const char *prefix);
206int cmd_rebase(int argc, const char **argv, const char *prefix);
207int cmd_rebase__interactive(int argc, const char **argv, const char *prefix);
208int cmd_receive_pack(int argc, const char **argv, const char *prefix);
209int cmd_reflog(int argc, const char **argv, const char *prefix);
210int cmd_remote(int argc, const char **argv, const char *prefix);
211int cmd_remote_ext(int argc, const char **argv, const char *prefix);
212int cmd_remote_fd(int argc, const char **argv, const char *prefix);
213int cmd_repack(int argc, const char **argv, const char *prefix);
214int cmd_rerere(int argc, const char **argv, const char *prefix);
215int cmd_reset(int argc, const char **argv, const char *prefix);
Junio C Hamanof496b062019-07-09 22:25:44[diff] [blame]216int cmd_restore(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]217int cmd_rev_list(int argc, const char **argv, const char *prefix);
218int cmd_rev_parse(int argc, const char **argv, const char *prefix);
219int cmd_revert(int argc, const char **argv, const char *prefix);
220int cmd_rm(int argc, const char **argv, const char *prefix);
221int cmd_send_pack(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]222int cmd_shortlog(int argc, const char **argv, const char *prefix);
223int cmd_show(int argc, const char **argv, const char *prefix);
224int cmd_show_branch(int argc, const char **argv, const char *prefix);
225int cmd_show_index(int argc, const char **argv, const char *prefix);
Derrick Stolee94c09562019-11-21 22:04:33[diff] [blame]226int cmd_sparse_checkout(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]227int cmd_status(int argc, const char **argv, const char *prefix);
Junio C Hamano4aeeef32019-05-13 14:50:32[diff] [blame]228int cmd_stash(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]229int cmd_stripspace(int argc, const char **argv, const char *prefix);
230int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
Junio C Hamanof496b062019-07-09 22:25:44[diff] [blame]231int cmd_switch(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]232int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
233int cmd_tag(int argc, const char **argv, const char *prefix);
Denton Liu55454422019-04-29 08:28:14[diff] [blame]234int cmd_unpack_file(int argc, const char **argv, const char *prefix);
235int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
236int cmd_update_index(int argc, const char **argv, const char *prefix);
237int cmd_update_ref(int argc, const char **argv, const char *prefix);
238int cmd_update_server_info(int argc, const char **argv, const char *prefix);
239int cmd_upload_archive(int argc, const char **argv, const char *prefix);
240int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
241int cmd_upload_pack(int argc, const char **argv, const char *prefix);
242int cmd_var(int argc, const char **argv, const char *prefix);
243int cmd_verify_commit(int argc, const char **argv, const char *prefix);
244int cmd_verify_tag(int argc, const char **argv, const char *prefix);
245int cmd_version(int argc, const char **argv, const char *prefix);
246int cmd_whatchanged(int argc, const char **argv, const char *prefix);
247int cmd_worktree(int argc, const char **argv, const char *prefix);
248int cmd_write_tree(int argc, const char **argv, const char *prefix);
249int cmd_verify_pack(int argc, const char **argv, const char *prefix);
250int cmd_show_ref(int argc, const char **argv, const char *prefix);
251int cmd_pack_refs(int argc, const char **argv, const char *prefix);
252int cmd_replace(int argc, const char **argv, const char *prefix);
Junio C Hamanof754fa92006-08-04 08:51:04[diff] [blame]253
Linus Torvalds70827b12006-04-21 17:27:34[diff] [blame]254#endif