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