Andrew's git - gitweb.git/blob

   1#ifndef BUILTIN_H
   2#define BUILTIN_H
   3
   4#include "git-compat-util.h"
   5#include "strbuf.h"
   6#include "cache.h"
   7#include "commit.h"
   8
   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 * `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 *
  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
  97#define DEFAULT_MERGE_LOG_LEN 20
  98
  99extern const char git_usage_string[];
 100extern const char git_more_info_string[];
 101
 102#define PRUNE_PACKED_DRY_RUN 01
 103#define PRUNE_PACKED_VERBOSE 02
 104
 105extern void prune_packed_objects(int);
 106
 107struct fmt_merge_msg_opts {
 108        unsigned add_title:1,
 109                credit_people:1;
 110        int shortlog_len;
 111};
 112
 113extern int fmt_merge_msg(struct strbuf *in, struct strbuf *out,
 114                         struct fmt_merge_msg_opts *);
 115
 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 */
 126extern void setup_auto_pager(const char *cmd, int def);
 127
 128extern int is_builtin(const char *s);
 129
 130extern int cmd_add(int argc, const char **argv, const char *prefix);
 131extern int cmd_am(int argc, const char **argv, const char *prefix);
 132extern int cmd_annotate(int argc, const char **argv, const char *prefix);
 133extern int cmd_apply(int argc, const char **argv, const char *prefix);
 134extern int cmd_archive(int argc, const char **argv, const char *prefix);
 135extern int cmd_bisect__helper(int argc, const char **argv, const char *prefix);
 136extern int cmd_blame(int argc, const char **argv, const char *prefix);
 137extern int cmd_branch(int argc, const char **argv, const char *prefix);
 138extern int cmd_bundle(int argc, const char **argv, const char *prefix);
 139extern int cmd_cat_file(int argc, const char **argv, const char *prefix);
 140extern int cmd_checkout(int argc, const char **argv, const char *prefix);
 141extern int cmd_checkout_index(int argc, const char **argv, const char *prefix);
 142extern int cmd_check_attr(int argc, const char **argv, const char *prefix);
 143extern int cmd_check_ignore(int argc, const char **argv, const char *prefix);
 144extern int cmd_check_mailmap(int argc, const char **argv, const char *prefix);
 145extern int cmd_check_ref_format(int argc, const char **argv, const char *prefix);
 146extern int cmd_cherry(int argc, const char **argv, const char *prefix);
 147extern int cmd_cherry_pick(int argc, const char **argv, const char *prefix);
 148extern int cmd_clone(int argc, const char **argv, const char *prefix);
 149extern int cmd_clean(int argc, const char **argv, const char *prefix);
 150extern int cmd_column(int argc, const char **argv, const char *prefix);
 151extern int cmd_commit(int argc, const char **argv, const char *prefix);
 152extern int cmd_commit_graph(int argc, const char **argv, const char *prefix);
 153extern int cmd_commit_tree(int argc, const char **argv, const char *prefix);
 154extern int cmd_config(int argc, const char **argv, const char *prefix);
 155extern int cmd_count_objects(int argc, const char **argv, const char *prefix);
 156extern int cmd_credential(int argc, const char **argv, const char *prefix);
 157extern int cmd_describe(int argc, const char **argv, const char *prefix);
 158extern int cmd_diff_files(int argc, const char **argv, const char *prefix);
 159extern int cmd_diff_index(int argc, const char **argv, const char *prefix);
 160extern int cmd_diff(int argc, const char **argv, const char *prefix);
 161extern int cmd_diff_tree(int argc, const char **argv, const char *prefix);
 162extern int cmd_difftool(int argc, const char **argv, const char *prefix);
 163extern int cmd_fast_export(int argc, const char **argv, const char *prefix);
 164extern int cmd_fetch(int argc, const char **argv, const char *prefix);
 165extern int cmd_fetch_pack(int argc, const char **argv, const char *prefix);
 166extern int cmd_fmt_merge_msg(int argc, const char **argv, const char *prefix);
 167extern int cmd_for_each_ref(int argc, const char **argv, const char *prefix);
 168extern int cmd_format_patch(int argc, const char **argv, const char *prefix);
 169extern int cmd_fsck(int argc, const char **argv, const char *prefix);
 170extern int cmd_gc(int argc, const char **argv, const char *prefix);
 171extern int cmd_get_tar_commit_id(int argc, const char **argv, const char *prefix);
 172extern int cmd_grep(int argc, const char **argv, const char *prefix);
 173extern int cmd_hash_object(int argc, const char **argv, const char *prefix);
 174extern int cmd_help(int argc, const char **argv, const char *prefix);
 175extern int cmd_index_pack(int argc, const char **argv, const char *prefix);
 176extern int cmd_init_db(int argc, const char **argv, const char *prefix);
 177extern int cmd_interpret_trailers(int argc, const char **argv, const char *prefix);
 178extern int cmd_log(int argc, const char **argv, const char *prefix);
 179extern int cmd_log_reflog(int argc, const char **argv, const char *prefix);
 180extern int cmd_ls_files(int argc, const char **argv, const char *prefix);
 181extern int cmd_ls_tree(int argc, const char **argv, const char *prefix);
 182extern int cmd_ls_remote(int argc, const char **argv, const char *prefix);
 183extern int cmd_mailinfo(int argc, const char **argv, const char *prefix);
 184extern int cmd_mailsplit(int argc, const char **argv, const char *prefix);
 185extern int cmd_merge(int argc, const char **argv, const char *prefix);
 186extern int cmd_merge_base(int argc, const char **argv, const char *prefix);
 187extern int cmd_merge_index(int argc, const char **argv, const char *prefix);
 188extern int cmd_merge_ours(int argc, const char **argv, const char *prefix);
 189extern int cmd_merge_file(int argc, const char **argv, const char *prefix);
 190extern int cmd_merge_recursive(int argc, const char **argv, const char *prefix);
 191extern int cmd_merge_tree(int argc, const char **argv, const char *prefix);
 192extern int cmd_mktag(int argc, const char **argv, const char *prefix);
 193extern int cmd_mktree(int argc, const char **argv, const char *prefix);
 194extern int cmd_mv(int argc, const char **argv, const char *prefix);
 195extern int cmd_name_rev(int argc, const char **argv, const char *prefix);
 196extern int cmd_notes(int argc, const char **argv, const char *prefix);
 197extern int cmd_pack_objects(int argc, const char **argv, const char *prefix);
 198extern int cmd_pack_redundant(int argc, const char **argv, const char *prefix);
 199extern int cmd_patch_id(int argc, const char **argv, const char *prefix);
 200extern int cmd_prune(int argc, const char **argv, const char *prefix);
 201extern int cmd_prune_packed(int argc, const char **argv, const char *prefix);
 202extern int cmd_pull(int argc, const char **argv, const char *prefix);
 203extern int cmd_push(int argc, const char **argv, const char *prefix);
 204extern int cmd_read_tree(int argc, const char **argv, const char *prefix);
 205extern int cmd_rebase__helper(int argc, const char **argv, const char *prefix);
 206extern int cmd_receive_pack(int argc, const char **argv, const char *prefix);
 207extern int cmd_reflog(int argc, const char **argv, const char *prefix);
 208extern int cmd_remote(int argc, const char **argv, const char *prefix);
 209extern int cmd_remote_ext(int argc, const char **argv, const char *prefix);
 210extern int cmd_remote_fd(int argc, const char **argv, const char *prefix);
 211extern int cmd_repack(int argc, const char **argv, const char *prefix);
 212extern int cmd_rerere(int argc, const char **argv, const char *prefix);
 213extern int cmd_reset(int argc, const char **argv, const char *prefix);
 214extern int cmd_rev_list(int argc, const char **argv, const char *prefix);
 215extern int cmd_rev_parse(int argc, const char **argv, const char *prefix);
 216extern int cmd_revert(int argc, const char **argv, const char *prefix);
 217extern int cmd_rm(int argc, const char **argv, const char *prefix);
 218extern int cmd_send_pack(int argc, const char **argv, const char *prefix);
 219extern int cmd_shortlog(int argc, const char **argv, const char *prefix);
 220extern int cmd_show(int argc, const char **argv, const char *prefix);
 221extern int cmd_show_branch(int argc, const char **argv, const char *prefix);
 222extern int cmd_status(int argc, const char **argv, const char *prefix);
 223extern int cmd_stripspace(int argc, const char **argv, const char *prefix);
 224extern int cmd_submodule__helper(int argc, const char **argv, const char *prefix);
 225extern int cmd_symbolic_ref(int argc, const char **argv, const char *prefix);
 226extern int cmd_tag(int argc, const char **argv, const char *prefix);
 227extern int cmd_tar_tree(int argc, const char **argv, const char *prefix);
 228extern int cmd_unpack_file(int argc, const char **argv, const char *prefix);
 229extern int cmd_unpack_objects(int argc, const char **argv, const char *prefix);
 230extern int cmd_update_index(int argc, const char **argv, const char *prefix);
 231extern int cmd_update_ref(int argc, const char **argv, const char *prefix);
 232extern int cmd_update_server_info(int argc, const char **argv, const char *prefix);
 233extern int cmd_upload_archive(int argc, const char **argv, const char *prefix);
 234extern int cmd_upload_archive_writer(int argc, const char **argv, const char *prefix);
 235extern int cmd_var(int argc, const char **argv, const char *prefix);
 236extern int cmd_verify_commit(int argc, const char **argv, const char *prefix);
 237extern int cmd_verify_tag(int argc, const char **argv, const char *prefix);
 238extern int cmd_version(int argc, const char **argv, const char *prefix);
 239extern int cmd_whatchanged(int argc, const char **argv, const char *prefix);
 240extern int cmd_worktree(int argc, const char **argv, const char *prefix);
 241extern int cmd_write_tree(int argc, const char **argv, const char *prefix);
 242extern int cmd_verify_pack(int argc, const char **argv, const char *prefix);
 243extern int cmd_show_ref(int argc, const char **argv, const char *prefix);
 244extern int cmd_pack_refs(int argc, const char **argv, const char *prefix);
 245extern int cmd_replace(int argc, const char **argv, const char *prefix);
 246
 247#endif