Documentation updates.
[git/spearce.git] / diff.h
blob3deb7fa4e8b6a572d5ab8d2c6a4da80478074244
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 extern void diff_addremove(int addremove,
12 unsigned mode,
13 const unsigned char *sha1,
14 const char *base,
15 const char *path);
17 extern void diff_change(unsigned mode1, unsigned mode2,
18 const unsigned char *sha1,
19 const unsigned char *sha2,
20 const char *base, const char *path);
22 extern void diff_helper_input(unsigned mode1,
23 unsigned mode2,
24 const unsigned char *sha1,
25 const unsigned char *sha2,
26 const char *path1,
27 int status,
28 int score,
29 const char *path2);
31 extern void diff_unmerge(const char *path);
33 extern int diff_scoreopt_parse(const char *opt);
35 #define DIFF_SETUP_REVERSE 1
36 #define DIFF_SETUP_USE_CACHE 2
37 #define DIFF_SETUP_USE_SIZE_CACHE 4
39 extern void diff_setup(int flags);
41 #define DIFF_DETECT_RENAME 1
42 #define DIFF_DETECT_COPY 2
44 #define DIFF_PICKAXE_ALL 1
46 extern void diffcore_std(const char **paths,
47 int detect_rename, int rename_score,
48 const char *pickaxe, int pickaxe_opts,
49 int break_opt,
50 const char *orderfile, const char *filter);
52 extern void diffcore_std_no_resolve(const char **paths,
53 const char *pickaxe, int pickaxe_opts,
54 const char *orderfile, const char *filter);
56 #define COMMON_DIFF_OPTIONS_HELP \
57 "\ncommon diff options:\n" \
58 " -r diff recursively (only meaningful in diff-tree)\n" \
59 " -z output diff-raw with lines terminated with NUL.\n" \
60 " -p output patch format.\n" \
61 " -u synonym for -p.\n" \
62 " --name-only show only names of changed files.\n" \
63 " --name-only-z\n" \
64 " same as --name-only but terminate lines with NUL.\n" \
65 " -R swap input file pairs.\n" \
66 " -B detect complete rewrites.\n" \
67 " -M detect renames.\n" \
68 " -C detect copies.\n" \
69 " --find-copies-harder\n" \
70 " try unchanged files as candidate for copy detection.\n" \
71 " -O<file> reorder diffs according to the <file>.\n" \
72 " -S<string> find filepair whose only one side contains the string.\n" \
73 " --pickaxe-all\n" \
74 " show all files diff when -S is used and hit is found.\n"
76 extern int diff_queue_is_empty(void);
78 #define DIFF_FORMAT_RAW 1
79 #define DIFF_FORMAT_PATCH 2
80 #define DIFF_FORMAT_NO_OUTPUT 3
81 #define DIFF_FORMAT_NAME 4
83 extern void diff_flush(int output_style, int line_terminator);
85 /* diff-raw status letters */
86 #define DIFF_STATUS_ADDED 'A'
87 #define DIFF_STATUS_COPIED 'C'
88 #define DIFF_STATUS_DELETED 'D'
89 #define DIFF_STATUS_MODIFIED 'M'
90 #define DIFF_STATUS_RENAMED 'R'
91 #define DIFF_STATUS_TYPE_CHANGED 'T'
92 #define DIFF_STATUS_UNKNOWN 'X'
93 #define DIFF_STATUS_UNMERGED 'U'
95 /* these are not diff-raw status letters proper, but used by
96 * diffcore-filter insn to specify additional restrictions.
98 #define DIFF_STATUS_FILTER_AON 'A'
99 #define DIFF_STATUS_FILTER_BROKEN 'B'
101 #endif /* DIFF_H */