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