Documentation: fix missing links to git(7)
[git.git] / diff.h
1 /*
2  * Copyright (C) 2005 Junio C Hamano
3  */
4 #ifndef DIFF_H
5 #define DIFF_H
6
7 #define DIFF_FILE_CANON_MODE(mode) \
8         (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
9         S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
10
11 struct tree_desc {
12         void *buf;
13         unsigned long size;
14 };
15
16 struct diff_options;
17
18 typedef void (*change_fn_t)(struct diff_options *options,
19                  unsigned old_mode, unsigned new_mode,
20                  const unsigned char *old_sha1,
21                  const unsigned char *new_sha1,
22                  const char *base, const char *path);
23
24 typedef void (*add_remove_fn_t)(struct diff_options *options,
25                     int addremove, unsigned mode,
26                     const unsigned char *sha1,
27                     const char *base, const char *path);
28
29 struct diff_options {
30         const char **paths;
31         const char *filter;
32         const char *orderfile;
33         const char *pickaxe;
34         unsigned recursive:1,
35                  tree_in_recursive:1,
36                  full_index:1;
37         int break_opt;
38         int detect_rename;
39         int find_copies_harder;
40         int line_termination;
41         int output_format;
42         int pickaxe_opts;
43         int rename_score;
44         int reverse_diff;
45         int rename_limit;
46         int setup;
47
48         change_fn_t change;
49         add_remove_fn_t add_remove;
50 };
51
52 extern void diff_tree_setup_paths(const char **paths);
53 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
54                      const char *base, struct diff_options *opt);
55 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
56                           const char *base, struct diff_options *opt);
57
58 extern void diff_addremove(struct diff_options *,
59                            int addremove,
60                            unsigned mode,
61                            const unsigned char *sha1,
62                            const char *base,
63                            const char *path);
64
65 extern void diff_change(struct diff_options *,
66                         unsigned mode1, unsigned mode2,
67                         const unsigned char *sha1,
68                         const unsigned char *sha2,
69                         const char *base, const char *path);
70
71 extern void diff_unmerge(struct diff_options *,
72                          const char *path);
73
74 extern int diff_scoreopt_parse(const char *opt);
75
76 #define DIFF_SETUP_REVERSE              1
77 #define DIFF_SETUP_USE_CACHE            2
78 #define DIFF_SETUP_USE_SIZE_CACHE       4
79
80 extern int git_diff_config(const char *var, const char *value);
81 extern void diff_setup(struct diff_options *);
82 extern int diff_opt_parse(struct diff_options *, const char **, int);
83 extern int diff_setup_done(struct diff_options *);
84
85 #define DIFF_DETECT_RENAME      1
86 #define DIFF_DETECT_COPY        2
87
88 #define DIFF_PICKAXE_ALL        1
89
90 extern void diffcore_std(struct diff_options *);
91
92 extern void diffcore_std_no_resolve(struct diff_options *);
93
94 #define COMMON_DIFF_OPTIONS_HELP \
95 "\ncommon diff options:\n" \
96 "  -z            output diff-raw with lines terminated with NUL.\n" \
97 "  -p            output patch format.\n" \
98 "  -u            synonym for -p.\n" \
99 "  --name-only   show only names of changed files.\n" \
100 "  --name-status show names and status of changed files.\n" \
101 "  --full-index  show full object name on index ines.\n" \
102 "  -R            swap input file pairs.\n" \
103 "  -B            detect complete rewrites.\n" \
104 "  -M            detect renames.\n" \
105 "  -C            detect copies.\n" \
106 "  --find-copies-harder\n" \
107 "                try unchanged files as candidate for copy detection.\n" \
108 "  -l<n>         limit rename attempts up to <n> paths.\n" \
109 "  -O<file>      reorder diffs according to the <file>.\n" \
110 "  -S<string>    find filepair whose only one side contains the string.\n" \
111 "  --pickaxe-all\n" \
112 "                show all files diff when -S is used and hit is found.\n"
113
114 extern int diff_queue_is_empty(void);
115
116 #define DIFF_FORMAT_RAW         1
117 #define DIFF_FORMAT_PATCH       2
118 #define DIFF_FORMAT_NO_OUTPUT   3
119 #define DIFF_FORMAT_NAME        4
120 #define DIFF_FORMAT_NAME_STATUS 5
121
122 extern void diff_flush(struct diff_options*);
123
124 /* diff-raw status letters */
125 #define DIFF_STATUS_ADDED               'A'
126 #define DIFF_STATUS_COPIED              'C'
127 #define DIFF_STATUS_DELETED             'D'
128 #define DIFF_STATUS_MODIFIED            'M'
129 #define DIFF_STATUS_RENAMED             'R'
130 #define DIFF_STATUS_TYPE_CHANGED        'T'
131 #define DIFF_STATUS_UNKNOWN             'X'
132 #define DIFF_STATUS_UNMERGED            'U'
133
134 /* these are not diff-raw status letters proper, but used by
135  * diffcore-filter insn to specify additional restrictions.
136  */
137 #define DIFF_STATUS_FILTER_AON          '*'
138 #define DIFF_STATUS_FILTER_BROKEN       'B'
139
140 #endif /* DIFF_H */