stash: remove now superfluos help for "stash push"
[git.git] / builtin.h
blob42378f3aa471eb79594d96736ad2410b54d6c4dd
1 #ifndef BUILTIN_H
2 #define BUILTIN_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
6 #include "cache.h"
7 #include "commit.h"
9 /*
10 * builtin API
11 * ===========
13 * Adding a new built-in
14 * ---------------------
16 * There are 4 things to do to add a built-in command implementation to
17 * Git:
19 * . Define the implementation of the built-in command `foo` with
20 * signature:
22 * int cmd_foo(int argc, const char **argv, const char *prefix);
24 * . Add the external declaration for the function to `builtin.h`.
26 * . Add the command to the `commands[]` table defined in `git.c`.
27 * The entry should look like:
29 * { "foo", cmd_foo, <options> },
31 * where options is the bitwise-or of:
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.
39 * `RUN_SETUP_GENTLY`:
40 * If there is a Git directory, chdir as per RUN_SETUP, otherwise,
41 * don't chdir anywhere.
43 * `USE_PAGER`:
45 * If the standard output is connected to a tty, spawn a pager and
46 * feed our output to it.
48 * `NEED_WORK_TREE`:
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.
54 * `SUPPORT_SUPER_PREFIX`:
56 * The built-in supports `--super-prefix`.
58 * `DELAY_PAGER_CONFIG`:
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.
66 * . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
68 * Additionally, if `foo` is a new command, there are 4 more things to do:
70 * . Add tests to `t/` directory.
72 * . Write documentation in `Documentation/git-foo.txt`.
74 * . Add an entry for `git-foo` to `command-list.txt`.
76 * . Add an entry for `/git-foo` to `.gitignore`.
79 * How a built-in is called
80 * ------------------------
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.
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.
93 * The return value from `cmd_foo()` becomes the exit status of the
94 * command.
97 #define DEFAULT_MERGE_LOG_LEN 20
99 extern const char git_usage_string[];
100 extern const char git_more_info_string[];
102 #define PRUNE_PACKED_DRY_RUN 01
103 #define PRUNE_PACKED_VERBOSE 02
105 extern void prune_packed_objects(int);
107 struct fmt_merge_msg_opts {
108 unsigned add_title:1,
109 credit_people:1;
110 int shortlog_len;
113 extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
114 struct fmt_merge_msg_opts *);
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".
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.
126 extern void setup_auto_pager(const char *cmd, int def);
128 extern int is_builtin(const char *s);
130 extern int cmd_add(int argc, const char **argv, const char *prefix);
131 extern int cmd_am(int argc, const char **argv, const char *prefix);
132 extern int cmd_annotate(int argc, const char **argv, const char *prefix);
133 extern int cmd_apply(int argc, const char **argv, const char *prefix);
134 extern int cmd_archive(int argc, const char **argv, const char *prefix);
135 extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix);
136 extern int cmd_blame(int argc, const char **argv, const char *prefix);
137 extern int cmd_branch(int argc, const char **argv, const char *prefix);
138 extern int cmd_bundle(int argc, const char **argv, const char *prefix);
139 extern int cmd_cat_file(int argc, const char **argv, const char *prefix);
140 extern int cmd_checkout(int argc, const char **argv, const char *prefix);
141 extern int cmd_checkout_index(int argc, const char **argv, const char *prefix);
142 extern int cmd_check_attr(int argc, const char **argv, const char *prefix);
143 extern int cmd_check_ignore(int argc, const char **argv, const char *prefix);
144 extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
145 extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
146 extern int cmd_cherry(int argc, const char **argv, const char *prefix);
147 extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
148 extern int cmd_clone(int argc, const char **argv, const char *prefix);
149 extern int cmd_clean(int argc, const char **argv, const char *prefix);
150 extern int cmd_column(int argc, const char **argv, const char *prefix);
151 extern int cmd_commit(int argc, const char **argv, const char *prefix);
152 extern int cmd_commit_tree(int argc, const char **argv, const char *prefix);
153 extern int cmd_config(int argc, const char **argv, const char *prefix);
154 extern int cmd_count_objects(int argc, const char **argv, const char *prefix);
155 extern int cmd_credential(int argc, const char **argv, const char *prefix);
156 extern int cmd_describe(int argc, const char **argv, const char *prefix);
157 extern int cmd_diff_files(int argc, const char **argv, const char *prefix);
158 extern int cmd_diff_index(int argc, const char **argv, const char *prefix);
159 extern int cmd_diff(int argc, const char **argv, const char *prefix);
160 extern int cmd_diff_tree(int argc, const char **argv, const char *prefix);
161 extern int cmd_difftool(int argc, const char **argv, const char *prefix);
162 extern int cmd_fast_export(int argc, const char **argv, const char *prefix);
163 extern int cmd_fetch(int argc, const char **argv, const char *prefix);
164 extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
165 extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
166 extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
167 extern int cmd_format_patch(int argc, const char **argv, const char *prefix);
168 extern int cmd_fsck(int argc, const char **argv, const char *prefix);
169 extern int cmd_gc(int argc, const char **argv, const char *prefix);
170 extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
171 extern int cmd_grep(int argc, const char **argv, const char *prefix);
172 extern int cmd_hash_object(int argc, const char **argv, const char *prefix);
173 extern int cmd_help(int argc, const char **argv, const char *prefix);
174 extern int cmd_index_pack(int argc, const char **argv, const char *prefix);
175 extern int cmd_init_db(int argc, const char **argv, const char *prefix);
176 extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
177 extern int cmd_log(int argc, const char **argv, const char *prefix);
178 extern int cmd_log_reflog(int argc, const char **argv, const char *prefix);
179 extern int cmd_ls_files(int argc, const char **argv, const char *prefix);
180 extern int cmd_ls_tree(int argc, const char **argv, const char *prefix);
181 extern int cmd_ls_remote(int argc, const char **argv, const char *prefix);
182 extern int cmd_mailinfo(int argc, const char **argv, const char *prefix);
183 extern int cmd_mailsplit(int argc, const char **argv, const char *prefix);
184 extern int cmd_merge(int argc, const char **argv, const char *prefix);
185 extern int cmd_merge_base(int argc, const char **argv, const char *prefix);
186 extern int cmd_merge_index(int argc, const char **argv, const char *prefix);
187 extern int cmd_merge_ours(int argc, const char **argv, const char *prefix);
188 extern int cmd_merge_file(int argc, const char **argv, const char *prefix);
189 extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
190 extern int cmd_merge_tree(int argc, const char **argv, const char *prefix);
191 extern int cmd_mktag(int argc, const char **argv, const char *prefix);
192 extern int cmd_mktree(int argc, const char **argv, const char *prefix);
193 extern int cmd_mv(int argc, const char **argv, const char *prefix);
194 extern int cmd_name_rev(int argc, const char **argv, const char *prefix);
195 extern int cmd_notes(int argc, const char **argv, const char *prefix);
196 extern int cmd_pack_objects(int argc, const char **argv, const char *prefix);
197 extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
198 extern int cmd_patch_id(int argc, const char **argv, const char *prefix);
199 extern int cmd_prune(int argc, const char **argv, const char *prefix);
200 extern int cmd_prune_packed(int argc, const char **argv, const char *prefix);
201 extern int cmd_pull(int argc, const char **argv, const char *prefix);
202 extern int cmd_push(int argc, const char **argv, const char *prefix);
203 extern int cmd_read_tree(int argc, const char **argv, const char *prefix);
204 extern int cmd_rebase__helper(int argc, const char **argv, const char *prefix);
205 extern int cmd_receive_pack(int argc, const char **argv, const char *prefix);
206 extern int cmd_reflog(int argc, const char **argv, const char *prefix);
207 extern int cmd_remote(int argc, const char **argv, const char *prefix);
208 extern int cmd_remote_ext(int argc, const char **argv, const char *prefix);
209 extern int cmd_remote_fd(int argc, const char **argv, const char *prefix);
210 extern int cmd_repack(int argc, const char **argv, const char *prefix);
211 extern int cmd_rerere(int argc, const char **argv, const char *prefix);
212 extern int cmd_reset(int argc, const char **argv, const char *prefix);
213 extern int cmd_rev_list(int argc, const char **argv, const char *prefix);
214 extern int cmd_rev_parse(int argc, const char **argv, const char *prefix);
215 extern int cmd_revert(int argc, const char **argv, const char *prefix);
216 extern int cmd_rm(int argc, const char **argv, const char *prefix);
217 extern int cmd_send_pack(int argc, const char **argv, const char *prefix);
218 extern int cmd_shortlog(int argc, const char **argv, const char *prefix);
219 extern int cmd_show(int argc, const char **argv, const char *prefix);
220 extern int cmd_show_branch(int argc, const char **argv, const char *prefix);
221 extern int cmd_status(int argc, const char **argv, const char *prefix);
222 extern int cmd_stripspace(int argc, const char **argv, const char *prefix);
223 extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
224 extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
225 extern int cmd_tag(int argc, const char **argv, const char *prefix);
226 extern int cmd_tar_tree(int argc, const char **argv, const char *prefix);
227 extern int cmd_unpack_file(int argc, const char **argv, const char *prefix);
228 extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
229 extern int cmd_update_index(int argc, const char **argv, const char *prefix);
230 extern int cmd_update_ref(int argc, const char **argv, const char *prefix);
231 extern int cmd_update_server_info(int argc, const char **argv, const char *prefix);
232 extern int cmd_upload_archive(int argc, const char **argv, const char *prefix);
233 extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
234 extern int cmd_var(int argc, const char **argv, const char *prefix);
235 extern int cmd_verify_commit(int argc, const char **argv, const char *prefix);
236 extern int cmd_verify_tag(int argc, const char **argv, const char *prefix);
237 extern int cmd_version(int argc, const char **argv, const char *prefix);
238 extern int cmd_whatchanged(int argc, const char **argv, const char *prefix);
239 extern int cmd_worktree(int argc, const char **argv, const char *prefix);
240 extern int cmd_write_tree(int argc, const char **argv, const char *prefix);
241 extern int cmd_verify_pack(int argc, const char **argv, const char *prefix);
242 extern int cmd_show_ref(int argc, const char **argv, const char *prefix);
243 extern int cmd_pack_refs(int argc, const char **argv, const char *prefix);
244 extern int cmd_replace(int argc, const char **argv, const char *prefix);
246 #endif