revision.hon commit help: check early if we have a command, if not try a documentation topic (2dce956)
   1#ifndef REVISION_H
   2#define REVISION_H
   3
   4#define SEEN            (1u<<0)
   5#define UNINTERESTING   (1u<<1)
   6#define TREESAME        (1u<<2)
   7#define SHOWN           (1u<<3)
   8#define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
   9#define BOUNDARY        (1u<<5)
  10#define CHILD_SHOWN     (1u<<6)
  11#define ADDED           (1u<<7) /* Parents already parsed and added? */
  12#define SYMMETRIC_LEFT  (1u<<8)
  13#define TOPOSORT        (1u<<9) /* In the active toposort list.. */
  14
  15struct rev_info;
  16struct log_info;
  17
  18struct rev_info {
  19        /* Starting list */
  20        struct commit_list *commits;
  21        struct object_array pending;
  22
  23        /* Parents of shown commits */
  24        struct object_array boundary_commits;
  25
  26        /* Basic information */
  27        const char *prefix;
  28        void *prune_data;
  29        unsigned int early_output;
  30
  31        /* Traversal flags */
  32        unsigned int    dense:1,
  33                        prune:1,
  34                        no_merges:1,
  35                        no_walk:1,
  36                        show_all:1,
  37                        remove_empty_trees:1,
  38                        simplify_history:1,
  39                        lifo:1,
  40                        topo_order:1,
  41                        tag_objects:1,
  42                        tree_objects:1,
  43                        blob_objects:1,
  44                        edge_hint:1,
  45                        limited:1,
  46                        unpacked:1, /* see also ignore_packed below */
  47                        boundary:2,
  48                        left_right:1,
  49                        rewrite_parents:1,
  50                        print_parents:1,
  51                        reverse:1,
  52                        cherry_pick:1,
  53                        first_parent_only:1;
  54
  55        /* Diff flags */
  56        unsigned int    diff:1,
  57                        full_diff:1,
  58                        show_root_diff:1,
  59                        no_commit_id:1,
  60                        verbose_header:1,
  61                        ignore_merges:1,
  62                        combine_merges:1,
  63                        dense_combined_merges:1,
  64                        always_show_header:1;
  65
  66        /* Format info */
  67        unsigned int    shown_one:1,
  68                        abbrev_commit:1,
  69                        use_terminator:1,
  70                        missing_newline:1;
  71        enum date_mode date_mode;
  72
  73        const char **ignore_packed; /* pretend objects in these are unpacked */
  74        int num_ignore_packed;
  75
  76        unsigned int    abbrev;
  77        enum cmit_fmt   commit_format;
  78        struct log_info *loginfo;
  79        int             nr, total;
  80        const char      *mime_boundary;
  81        char            *message_id;
  82        const char      *ref_message_id;
  83        const char      *add_signoff;
  84        const char      *extra_headers;
  85        const char      *log_reencode;
  86        const char      *subject_prefix;
  87        int             no_inline;
  88        int             show_log_size;
  89
  90        /* Filter by commit log message */
  91        struct grep_opt *grep_filter;
  92
  93        /* Display history graph */
  94        struct git_graph *graph;
  95
  96        /* special limits */
  97        int skip_count;
  98        int max_count;
  99        unsigned long max_age;
 100        unsigned long min_age;
 101
 102        /* diff info for patches and for paths limiting */
 103        struct diff_options diffopt;
 104        struct diff_options pruning;
 105
 106        struct reflog_walk_info *reflog_info;
 107};
 108
 109#define REV_TREE_SAME           0
 110#define REV_TREE_NEW            1
 111#define REV_TREE_DIFFERENT      2
 112
 113/* revision.c */
 114typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 115volatile show_early_output_fn_t show_early_output;
 116
 117extern void init_revisions(struct rev_info *revs, const char *prefix);
 118extern int setup_revisions(int argc, const char **argv, struct rev_info *revs, const char *def);
 119extern int handle_revision_arg(const char *arg, struct rev_info *revs,int flags,int cant_be_filename);
 120
 121extern int prepare_revision_walk(struct rev_info *revs);
 122extern struct commit *get_revision(struct rev_info *revs);
 123
 124extern void mark_parents_uninteresting(struct commit *commit);
 125extern void mark_tree_uninteresting(struct tree *tree);
 126
 127struct name_path {
 128        struct name_path *up;
 129        int elem_len;
 130        const char *elem;
 131};
 132
 133extern void add_object(struct object *obj,
 134                       struct object_array *p,
 135                       struct name_path *path,
 136                       const char *name);
 137
 138extern void add_pending_object(struct rev_info *revs, struct object *obj, const char *name);
 139
 140extern void add_head_to_pending(struct rev_info *);
 141
 142enum commit_action {
 143        commit_ignore,
 144        commit_show,
 145        commit_error
 146};
 147
 148extern enum commit_action simplify_commit(struct rev_info *revs, struct commit *commit);
 149
 150#endif