unpack-trees.hon commit Documentation/submodule: add command references and update options (402e8a6)
   1#ifndef UNPACK_TREES_H
   2#define UNPACK_TREES_H
   3
   4#include "string-list.h"
   5
   6#define MAX_UNPACK_TREES 8
   7
   8struct unpack_trees_options;
   9struct exclude_list;
  10
  11typedef int (*merge_fn_t)(struct cache_entry **src,
  12                struct unpack_trees_options *options);
  13
  14enum unpack_trees_error_types {
  15        ERROR_WOULD_OVERWRITE = 0,
  16        ERROR_NOT_UPTODATE_FILE,
  17        ERROR_NOT_UPTODATE_DIR,
  18        ERROR_WOULD_LOSE_UNTRACKED_OVERWRITTEN,
  19        ERROR_WOULD_LOSE_UNTRACKED_REMOVED,
  20        ERROR_BIND_OVERLAP,
  21        ERROR_SPARSE_NOT_UPTODATE_FILE,
  22        ERROR_WOULD_LOSE_ORPHANED_OVERWRITTEN,
  23        ERROR_WOULD_LOSE_ORPHANED_REMOVED,
  24        NB_UNPACK_TREES_ERROR_TYPES
  25};
  26
  27/*
  28 * Sets the list of user-friendly error messages to be used by the
  29 * command "cmd" (either merge or checkout), and show_all_errors to 1.
  30 */
  31void setup_unpack_trees_porcelain(struct unpack_trees_options *opts,
  32                                  const char *cmd);
  33
  34struct unpack_trees_options {
  35        unsigned int reset,
  36                     merge,
  37                     update,
  38                     index_only,
  39                     nontrivial_merge,
  40                     trivial_merges_only,
  41                     verbose_update,
  42                     aggressive,
  43                     skip_unmerged,
  44                     initial_checkout,
  45                     diff_index_cached,
  46                     debug_unpack,
  47                     skip_sparse_checkout,
  48                     gently,
  49                     show_all_errors,
  50                     dry_run;
  51        const char *prefix;
  52        int cache_bottom;
  53        struct dir_struct *dir;
  54        merge_fn_t fn;
  55        const char *msgs[NB_UNPACK_TREES_ERROR_TYPES];
  56        /*
  57         * Store error messages in an array, each case
  58         * corresponding to a error message type
  59         */
  60        struct string_list unpack_rejects[NB_UNPACK_TREES_ERROR_TYPES];
  61
  62        int head_idx;
  63        int merge_size;
  64
  65        struct cache_entry *df_conflict_entry;
  66        void *unpack_data;
  67
  68        struct index_state *dst_index;
  69        struct index_state *src_index;
  70        struct index_state result;
  71
  72        struct exclude_list *el; /* for internal use */
  73};
  74
  75extern int unpack_trees(unsigned n, struct tree_desc *t,
  76                struct unpack_trees_options *options);
  77
  78int threeway_merge(struct cache_entry **stages, struct unpack_trees_options *o);
  79int twoway_merge(struct cache_entry **src, struct unpack_trees_options *o);
  80int bind_merge(struct cache_entry **src, struct unpack_trees_options *o);
  81int oneway_merge(struct cache_entry **src, struct unpack_trees_options *o);
  82
  83#endif