Code

git ls-remote: make usage string match manpage
[git.git] / builtin-diff.c
1 /*
2  * Builtin "git diff"
3  *
4  * Copyright (c) 2006 Junio C Hamano
5  */
6 #include "cache.h"
7 #include "color.h"
8 #include "commit.h"
9 #include "blob.h"
10 #include "tag.h"
11 #include "diff.h"
12 #include "diffcore.h"
13 #include "revision.h"
14 #include "log-tree.h"
15 #include "builtin.h"
17 struct blobinfo {
18         unsigned char sha1[20];
19         const char *name;
20         unsigned mode;
21 };
23 static const char builtin_diff_usage[] =
24 "git diff <options> <rev>{0,2} -- <path>*";
26 static void stuff_change(struct diff_options *opt,
27                          unsigned old_mode, unsigned new_mode,
28                          const unsigned char *old_sha1,
29                          const unsigned char *new_sha1,
30                          const char *old_name,
31                          const char *new_name)
32 {
33         struct diff_filespec *one, *two;
35         if (!is_null_sha1(old_sha1) && !is_null_sha1(new_sha1) &&
36             !hashcmp(old_sha1, new_sha1) && (old_mode == new_mode))
37                 return;
39         if (DIFF_OPT_TST(opt, REVERSE_DIFF)) {
40                 unsigned tmp;
41                 const unsigned char *tmp_u;
42                 const char *tmp_c;
43                 tmp = old_mode; old_mode = new_mode; new_mode = tmp;
44                 tmp_u = old_sha1; old_sha1 = new_sha1; new_sha1 = tmp_u;
45                 tmp_c = old_name; old_name = new_name; new_name = tmp_c;
46         }
48         if (opt->prefix &&
49             (strncmp(old_name, opt->prefix, opt->prefix_length) ||
50              strncmp(new_name, opt->prefix, opt->prefix_length)))
51                 return;
53         one = alloc_filespec(old_name);
54         two = alloc_filespec(new_name);
55         fill_filespec(one, old_sha1, old_mode);
56         fill_filespec(two, new_sha1, new_mode);
58         diff_queue(&diff_queued_diff, one, two);
59 }
61 static int builtin_diff_b_f(struct rev_info *revs,
62                             int argc, const char **argv,
63                             struct blobinfo *blob,
64                             const char *path)
65 {
66         /* Blob vs file in the working tree*/
67         struct stat st;
69         if (argc > 1)
70                 usage(builtin_diff_usage);
72         if (lstat(path, &st))
73                 die("'%s': %s", path, strerror(errno));
74         if (!(S_ISREG(st.st_mode) || S_ISLNK(st.st_mode)))
75                 die("'%s': not a regular file or symlink", path);
77         if (blob[0].mode == S_IFINVALID)
78                 blob[0].mode = canon_mode(st.st_mode);
80         stuff_change(&revs->diffopt,
81                      blob[0].mode, canon_mode(st.st_mode),
82                      blob[0].sha1, null_sha1,
83                      path, path);
84         diffcore_std(&revs->diffopt);
85         diff_flush(&revs->diffopt);
86         return 0;
87 }
89 static int builtin_diff_blobs(struct rev_info *revs,
90                               int argc, const char **argv,
91                               struct blobinfo *blob)
92 {
93         unsigned mode = canon_mode(S_IFREG | 0644);
95         if (argc > 1)
96                 usage(builtin_diff_usage);
98         if (blob[0].mode == S_IFINVALID)
99                 blob[0].mode = mode;
101         if (blob[1].mode == S_IFINVALID)
102                 blob[1].mode = mode;
104         stuff_change(&revs->diffopt,
105                      blob[0].mode, blob[1].mode,
106                      blob[0].sha1, blob[1].sha1,
107                      blob[0].name, blob[1].name);
108         diffcore_std(&revs->diffopt);
109         diff_flush(&revs->diffopt);
110         return 0;
113 static int builtin_diff_index(struct rev_info *revs,
114                               int argc, const char **argv)
116         int cached = 0;
117         while (1 < argc) {
118                 const char *arg = argv[1];
119                 if (!strcmp(arg, "--cached"))
120                         cached = 1;
121                 else
122                         usage(builtin_diff_usage);
123                 argv++; argc--;
124         }
125         if (!cached)
126                 setup_work_tree();
127         /*
128          * Make sure there is one revision (i.e. pending object),
129          * and there is no revision filtering parameters.
130          */
131         if (revs->pending.nr != 1 ||
132             revs->max_count != -1 || revs->min_age != -1 ||
133             revs->max_age != -1)
134                 usage(builtin_diff_usage);
135         if (read_cache() < 0) {
136                 perror("read_cache");
137                 return -1;
138         }
139         return run_diff_index(revs, cached);
142 static int builtin_diff_tree(struct rev_info *revs,
143                              int argc, const char **argv,
144                              struct object_array_entry *ent)
146         const unsigned char *(sha1[2]);
147         int swap = 0;
149         if (argc > 1)
150                 usage(builtin_diff_usage);
152         /* We saw two trees, ent[0] and ent[1].
153          * if ent[1] is uninteresting, they are swapped
154          */
155         if (ent[1].item->flags & UNINTERESTING)
156                 swap = 1;
157         sha1[swap] = ent[0].item->sha1;
158         sha1[1-swap] = ent[1].item->sha1;
159         diff_tree_sha1(sha1[0], sha1[1], "", &revs->diffopt);
160         log_tree_diff_flush(revs);
161         return 0;
164 static int builtin_diff_combined(struct rev_info *revs,
165                                  int argc, const char **argv,
166                                  struct object_array_entry *ent,
167                                  int ents)
169         const unsigned char (*parent)[20];
170         int i;
172         if (argc > 1)
173                 usage(builtin_diff_usage);
175         if (!revs->dense_combined_merges && !revs->combine_merges)
176                 revs->dense_combined_merges = revs->combine_merges = 1;
177         parent = xmalloc(ents * sizeof(*parent));
178         /* Again, the revs are all reverse */
179         for (i = 0; i < ents; i++)
180                 hashcpy((unsigned char *)(parent + i),
181                         ent[ents - 1 - i].item->sha1);
182         diff_tree_combined(parent[0], parent + 1, ents - 1,
183                            revs->dense_combined_merges, revs);
184         return 0;
187 static void refresh_index_quietly(void)
189         struct lock_file *lock_file;
190         int fd;
192         lock_file = xcalloc(1, sizeof(struct lock_file));
193         fd = hold_locked_index(lock_file, 0);
194         if (fd < 0)
195                 return;
196         discard_cache();
197         read_cache();
198         refresh_cache(REFRESH_QUIET|REFRESH_UNMERGED);
200         if (active_cache_changed &&
201             !write_cache(fd, active_cache, active_nr))
202                 commit_locked_index(lock_file);
204         rollback_lock_file(lock_file);
207 static int builtin_diff_files(struct rev_info *revs, int argc, const char **argv)
209         int result;
210         unsigned int options = 0;
212         while (1 < argc && argv[1][0] == '-') {
213                 if (!strcmp(argv[1], "--base"))
214                         revs->max_count = 1;
215                 else if (!strcmp(argv[1], "--ours"))
216                         revs->max_count = 2;
217                 else if (!strcmp(argv[1], "--theirs"))
218                         revs->max_count = 3;
219                 else if (!strcmp(argv[1], "-q"))
220                         options |= DIFF_SILENT_ON_REMOVED;
221                 else
222                         return error("invalid option: %s", argv[1]);
223                 argv++; argc--;
224         }
226         /*
227          * "diff --base" should not combine merges because it was not
228          * asked to.  "diff -c" should not densify (if the user wants
229          * dense one, --cc can be explicitly asked for, or just rely
230          * on the default).
231          */
232         if (revs->max_count == -1 && !revs->combine_merges &&
233             (revs->diffopt.output_format & DIFF_FORMAT_PATCH))
234                 revs->combine_merges = revs->dense_combined_merges = 1;
236         setup_work_tree();
237         if (read_cache() < 0) {
238                 perror("read_cache");
239                 return -1;
240         }
241         result = run_diff_files(revs, options);
242         return diff_result_code(&revs->diffopt, result);
245 int cmd_diff(int argc, const char **argv, const char *prefix)
247         int i;
248         struct rev_info rev;
249         struct object_array_entry ent[100];
250         int ents = 0, blobs = 0, paths = 0;
251         const char *path = NULL;
252         struct blobinfo blob[2];
253         int nongit;
254         int result = 0;
256         /*
257          * We could get N tree-ish in the rev.pending_objects list.
258          * Also there could be M blobs there, and P pathspecs.
259          *
260          * N=0, M=0:
261          *      cache vs files (diff-files)
262          * N=0, M=2:
263          *      compare two random blobs.  P must be zero.
264          * N=0, M=1, P=1:
265          *      compare a blob with a working tree file.
266          *
267          * N=1, M=0:
268          *      tree vs cache (diff-index --cached)
269          *
270          * N=2, M=0:
271          *      tree vs tree (diff-tree)
272          *
273          * N=0, M=0, P=2:
274          *      compare two filesystem entities (aka --no-index).
275          *
276          * Other cases are errors.
277          */
279         prefix = setup_git_directory_gently(&nongit);
280         git_config(git_diff_ui_config, NULL);
282         if (diff_use_color_default == -1)
283                 diff_use_color_default = git_use_color_default;
285         init_revisions(&rev, prefix);
287         /* If this is a no-index diff, just run it and exit there. */
288         diff_no_index(&rev, argc, argv, nongit, prefix);
290         /* Otherwise, we are doing the usual "git" diff */
291         rev.diffopt.skip_stat_unmatch = !!diff_auto_refresh_index;
293         if (nongit)
294                 die("Not a git repository");
295         argc = setup_revisions(argc, argv, &rev, NULL);
296         if (!rev.diffopt.output_format) {
297                 rev.diffopt.output_format = DIFF_FORMAT_PATCH;
298                 if (diff_setup_done(&rev.diffopt) < 0)
299                         die("diff_setup_done failed");
300         }
301         DIFF_OPT_SET(&rev.diffopt, ALLOW_EXTERNAL);
302         DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
304         /*
305          * If the user asked for our exit code then don't start a
306          * pager or we would end up reporting its exit code instead.
307          */
308         if (!DIFF_OPT_TST(&rev.diffopt, EXIT_WITH_STATUS) &&
309             check_pager_config("diff") != 0)
310                 setup_pager();
312         /*
313          * Do we have --cached and not have a pending object, then
314          * default to HEAD by hand.  Eek.
315          */
316         if (!rev.pending.nr) {
317                 int i;
318                 for (i = 1; i < argc; i++) {
319                         const char *arg = argv[i];
320                         if (!strcmp(arg, "--"))
321                                 break;
322                         else if (!strcmp(arg, "--cached")) {
323                                 add_head_to_pending(&rev);
324                                 if (!rev.pending.nr)
325                                         die("No HEAD commit to compare with (yet)");
326                                 break;
327                         }
328                 }
329         }
331         for (i = 0; i < rev.pending.nr; i++) {
332                 struct object_array_entry *list = rev.pending.objects+i;
333                 struct object *obj = list->item;
334                 const char *name = list->name;
335                 int flags = (obj->flags & UNINTERESTING);
336                 if (!obj->parsed)
337                         obj = parse_object(obj->sha1);
338                 obj = deref_tag(obj, NULL, 0);
339                 if (!obj)
340                         die("invalid object '%s' given.", name);
341                 if (obj->type == OBJ_COMMIT)
342                         obj = &((struct commit *)obj)->tree->object;
343                 if (obj->type == OBJ_TREE) {
344                         if (ARRAY_SIZE(ent) <= ents)
345                                 die("more than %d trees given: '%s'",
346                                     (int) ARRAY_SIZE(ent), name);
347                         obj->flags |= flags;
348                         ent[ents].item = obj;
349                         ent[ents].name = name;
350                         ents++;
351                         continue;
352                 }
353                 if (obj->type == OBJ_BLOB) {
354                         if (2 <= blobs)
355                                 die("more than two blobs given: '%s'", name);
356                         hashcpy(blob[blobs].sha1, obj->sha1);
357                         blob[blobs].name = name;
358                         blob[blobs].mode = list->mode;
359                         blobs++;
360                         continue;
362                 }
363                 die("unhandled object '%s' given.", name);
364         }
365         if (rev.prune_data) {
366                 const char **pathspec = rev.prune_data;
367                 while (*pathspec) {
368                         if (!path)
369                                 path = *pathspec;
370                         paths++;
371                         pathspec++;
372                 }
373         }
375         /*
376          * Now, do the arguments look reasonable?
377          */
378         if (!ents) {
379                 switch (blobs) {
380                 case 0:
381                         result = builtin_diff_files(&rev, argc, argv);
382                         break;
383                 case 1:
384                         if (paths != 1)
385                                 usage(builtin_diff_usage);
386                         result = builtin_diff_b_f(&rev, argc, argv, blob, path);
387                         break;
388                 case 2:
389                         if (paths)
390                                 usage(builtin_diff_usage);
391                         result = builtin_diff_blobs(&rev, argc, argv, blob);
392                         break;
393                 default:
394                         usage(builtin_diff_usage);
395                 }
396         }
397         else if (blobs)
398                 usage(builtin_diff_usage);
399         else if (ents == 1)
400                 result = builtin_diff_index(&rev, argc, argv);
401         else if (ents == 2)
402                 result = builtin_diff_tree(&rev, argc, argv, ent);
403         else if ((ents == 3) && (ent[0].item->flags & UNINTERESTING)) {
404                 /* diff A...B where there is one sane merge base between
405                  * A and B.  We have ent[0] == merge-base, ent[1] == A,
406                  * and ent[2] == B.  Show diff between the base and B.
407                  */
408                 ent[1] = ent[2];
409                 result = builtin_diff_tree(&rev, argc, argv, ent);
410         }
411         else
412                 result = builtin_diff_combined(&rev, argc, argv,
413                                              ent, ents);
414         result = diff_result_code(&rev.diffopt, result);
415         if (1 < rev.diffopt.skip_stat_unmatch)
416                 refresh_index_quietly();
417         return result;