Mention install-doc in INSTALL
[git.git] / diff.h
blob5696f2aff0644f331507679e0a58d7fcdc3501ec
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
7 #define DIFF_FILE_CANON_MODE(mode) \
8 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
9 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
11 struct tree_desc {
12 void *buf;
13 unsigned long size;
16 struct diff_options;
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);
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);
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 int abbrev;
49 change_fn_t change;
50 add_remove_fn_t add_remove;
53 extern void diff_tree_setup_paths(const char **paths);
54 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
55 const char *base, struct diff_options *opt);
56 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
57 const char *base, struct diff_options *opt);
59 extern void diff_addremove(struct diff_options *,
60 int addremove,
61 unsigned mode,
62 const unsigned char *sha1,
63 const char *base,
64 const char *path);
66 extern void diff_change(struct diff_options *,
67 unsigned mode1, unsigned mode2,
68 const unsigned char *sha1,
69 const unsigned char *sha2,
70 const char *base, const char *path);
72 extern void diff_unmerge(struct diff_options *,
73 const char *path);
75 extern int diff_scoreopt_parse(const char *opt);
77 #define DIFF_SETUP_REVERSE 1
78 #define DIFF_SETUP_USE_CACHE 2
79 #define DIFF_SETUP_USE_SIZE_CACHE 4
81 extern int git_diff_config(const char *var, const char *value);
82 extern void diff_setup(struct diff_options *);
83 extern int diff_opt_parse(struct diff_options *, const char **, int);
84 extern int diff_setup_done(struct diff_options *);
86 #define DIFF_DETECT_RENAME 1
87 #define DIFF_DETECT_COPY 2
89 #define DIFF_PICKAXE_ALL 1
91 #define DIFF_DEFAULT_INDEX_ABBREV 7 /* hex digits */
92 #define DIFF_DEFAULT_ABBREV 7 /* hex digits */
94 extern void diffcore_std(struct diff_options *);
96 extern void diffcore_std_no_resolve(struct diff_options *);
98 #define COMMON_DIFF_OPTIONS_HELP \
99 "\ncommon diff options:\n" \
100 " -z output diff-raw with lines terminated with NUL.\n" \
101 " -p output patch format.\n" \
102 " -u synonym for -p.\n" \
103 " --name-only show only names of changed files.\n" \
104 " --name-status show names and status of changed files.\n" \
105 " --full-index show full object name on index lines.\n" \
106 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
107 " -R swap input file pairs.\n" \
108 " -B detect complete rewrites.\n" \
109 " -M detect renames.\n" \
110 " -C detect copies.\n" \
111 " --find-copies-harder\n" \
112 " try unchanged files as candidate for copy detection.\n" \
113 " -l<n> limit rename attempts up to <n> paths.\n" \
114 " -O<file> reorder diffs according to the <file>.\n" \
115 " -S<string> find filepair whose only one side contains the string.\n" \
116 " --pickaxe-all\n" \
117 " show all files diff when -S is used and hit is found.\n"
119 extern int diff_queue_is_empty(void);
121 #define DIFF_FORMAT_RAW 1
122 #define DIFF_FORMAT_PATCH 2
123 #define DIFF_FORMAT_NO_OUTPUT 3
124 #define DIFF_FORMAT_NAME 4
125 #define DIFF_FORMAT_NAME_STATUS 5
127 extern void diff_flush(struct diff_options*);
129 /* diff-raw status letters */
130 #define DIFF_STATUS_ADDED 'A'
131 #define DIFF_STATUS_COPIED 'C'
132 #define DIFF_STATUS_DELETED 'D'
133 #define DIFF_STATUS_MODIFIED 'M'
134 #define DIFF_STATUS_RENAMED 'R'
135 #define DIFF_STATUS_TYPE_CHANGED 'T'
136 #define DIFF_STATUS_UNKNOWN 'X'
137 #define DIFF_STATUS_UNMERGED 'U'
139 /* these are not diff-raw status letters proper, but used by
140 * diffcore-filter insn to specify additional restrictions.
142 #define DIFF_STATUS_FILTER_AON '*'
143 #define DIFF_STATUS_FILTER_BROKEN 'B'
145 extern const char *diff_unique_abbrev(const unsigned char *, int);
147 #endif /* DIFF_H */