short status: improve reporting for submodule changes
[git] / submodule.c
1 #include "cache.h"
2 #include "submodule-config.h"
3 #include "submodule.h"
4 #include "dir.h"
5 #include "diff.h"
6 #include "commit.h"
7 #include "revision.h"
8 #include "run-command.h"
9 #include "diffcore.h"
10 #include "refs.h"
11 #include "string-list.h"
12 #include "sha1-array.h"
13 #include "argv-array.h"
14 #include "blob.h"
15 #include "thread-utils.h"
16 #include "quote.h"
17 #include "worktree.h"
18
19 static int config_fetch_recurse_submodules = RECURSE_SUBMODULES_ON_DEMAND;
20 static int parallel_jobs = 1;
21 static struct string_list changed_submodule_paths = STRING_LIST_INIT_NODUP;
22 static int initialized_fetch_ref_tips;
23 static struct sha1_array ref_tips_before_fetch;
24 static struct sha1_array ref_tips_after_fetch;
25
26 /*
27  * The following flag is set if the .gitmodules file is unmerged. We then
28  * disable recursion for all submodules where .git/config doesn't have a
29  * matching config entry because we can't guess what might be configured in
30  * .gitmodules unless the user resolves the conflict. When a command line
31  * option is given (which always overrides configuration) this flag will be
32  * ignored.
33  */
34 static int gitmodules_is_unmerged;
35
36 /*
37  * This flag is set if the .gitmodules file had unstaged modifications on
38  * startup. This must be checked before allowing modifications to the
39  * .gitmodules file with the intention to stage them later, because when
40  * continuing we would stage the modifications the user didn't stage herself
41  * too. That might change in a future version when we learn to stage the
42  * changes we do ourselves without staging any previous modifications.
43  */
44 static int gitmodules_is_modified;
45
46 int is_staging_gitmodules_ok(void)
47 {
48         return !gitmodules_is_modified;
49 }
50
51 /*
52  * Try to update the "path" entry in the "submodule.<name>" section of the
53  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
54  * with the correct path=<oldpath> setting was found and we could update it.
55  */
56 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
57 {
58         struct strbuf entry = STRBUF_INIT;
59         const struct submodule *submodule;
60
61         if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
62                 return -1;
63
64         if (gitmodules_is_unmerged)
65                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
66
67         submodule = submodule_from_path(null_sha1, oldpath);
68         if (!submodule || !submodule->name) {
69                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
70                 return -1;
71         }
72         strbuf_addstr(&entry, "submodule.");
73         strbuf_addstr(&entry, submodule->name);
74         strbuf_addstr(&entry, ".path");
75         if (git_config_set_in_file_gently(".gitmodules", entry.buf, newpath) < 0) {
76                 /* Maybe the user already did that, don't error out here */
77                 warning(_("Could not update .gitmodules entry %s"), entry.buf);
78                 strbuf_release(&entry);
79                 return -1;
80         }
81         strbuf_release(&entry);
82         return 0;
83 }
84
85 /*
86  * Try to remove the "submodule.<name>" section from .gitmodules where the given
87  * path is configured. Return 0 only if a .gitmodules file was found, a section
88  * with the correct path=<path> setting was found and we could remove it.
89  */
90 int remove_path_from_gitmodules(const char *path)
91 {
92         struct strbuf sect = STRBUF_INIT;
93         const struct submodule *submodule;
94
95         if (!file_exists(".gitmodules")) /* Do nothing without .gitmodules */
96                 return -1;
97
98         if (gitmodules_is_unmerged)
99                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
100
101         submodule = submodule_from_path(null_sha1, path);
102         if (!submodule || !submodule->name) {
103                 warning(_("Could not find section in .gitmodules where path=%s"), path);
104                 return -1;
105         }
106         strbuf_addstr(&sect, "submodule.");
107         strbuf_addstr(&sect, submodule->name);
108         if (git_config_rename_section_in_file(".gitmodules", sect.buf, NULL) < 0) {
109                 /* Maybe the user already did that, don't error out here */
110                 warning(_("Could not remove .gitmodules entry for %s"), path);
111                 strbuf_release(&sect);
112                 return -1;
113         }
114         strbuf_release(&sect);
115         return 0;
116 }
117
118 void stage_updated_gitmodules(void)
119 {
120         if (add_file_to_cache(".gitmodules", 0))
121                 die(_("staging updated .gitmodules failed"));
122 }
123
124 static int add_submodule_odb(const char *path)
125 {
126         struct strbuf objects_directory = STRBUF_INIT;
127         int ret = 0;
128
129         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
130         if (ret)
131                 goto done;
132         if (!is_directory(objects_directory.buf)) {
133                 ret = -1;
134                 goto done;
135         }
136         add_to_alternates_memory(objects_directory.buf);
137 done:
138         strbuf_release(&objects_directory);
139         return ret;
140 }
141
142 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
143                                              const char *path)
144 {
145         const struct submodule *submodule = submodule_from_path(null_sha1, path);
146         if (submodule) {
147                 if (submodule->ignore)
148                         handle_ignore_submodules_arg(diffopt, submodule->ignore);
149                 else if (gitmodules_is_unmerged)
150                         DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
151         }
152 }
153
154 int submodule_config(const char *var, const char *value, void *cb)
155 {
156         if (!strcmp(var, "submodule.fetchjobs")) {
157                 parallel_jobs = git_config_int(var, value);
158                 if (parallel_jobs < 0)
159                         die(_("negative values not allowed for submodule.fetchJobs"));
160                 return 0;
161         } else if (starts_with(var, "submodule."))
162                 return parse_submodule_config_option(var, value);
163         else if (!strcmp(var, "fetch.recursesubmodules")) {
164                 config_fetch_recurse_submodules = parse_fetch_recurse_submodules_arg(var, value);
165                 return 0;
166         }
167         return 0;
168 }
169
170 void gitmodules_config(void)
171 {
172         const char *work_tree = get_git_work_tree();
173         if (work_tree) {
174                 struct strbuf gitmodules_path = STRBUF_INIT;
175                 int pos;
176                 strbuf_addstr(&gitmodules_path, work_tree);
177                 strbuf_addstr(&gitmodules_path, "/.gitmodules");
178                 if (read_cache() < 0)
179                         die("index file corrupt");
180                 pos = cache_name_pos(".gitmodules", 11);
181                 if (pos < 0) { /* .gitmodules not found or isn't merged */
182                         pos = -1 - pos;
183                         if (active_nr > pos) {  /* there is a .gitmodules */
184                                 const struct cache_entry *ce = active_cache[pos];
185                                 if (ce_namelen(ce) == 11 &&
186                                     !memcmp(ce->name, ".gitmodules", 11))
187                                         gitmodules_is_unmerged = 1;
188                         }
189                 } else if (pos < active_nr) {
190                         struct stat st;
191                         if (lstat(".gitmodules", &st) == 0 &&
192                             ce_match_stat(active_cache[pos], &st, 0) & DATA_CHANGED)
193                                 gitmodules_is_modified = 1;
194                 }
195
196                 if (!gitmodules_is_unmerged)
197                         git_config_from_file(submodule_config, gitmodules_path.buf, NULL);
198                 strbuf_release(&gitmodules_path);
199         }
200 }
201
202 void gitmodules_config_sha1(const unsigned char *commit_sha1)
203 {
204         struct strbuf rev = STRBUF_INIT;
205         unsigned char sha1[20];
206
207         if (gitmodule_sha1_from_commit(commit_sha1, sha1, &rev)) {
208                 git_config_from_blob_sha1(submodule_config, rev.buf,
209                                           sha1, NULL);
210         }
211         strbuf_release(&rev);
212 }
213
214 /*
215  * Determine if a submodule has been initialized at a given 'path'
216  */
217 int is_submodule_initialized(const char *path)
218 {
219         int ret = 0;
220         const struct submodule *module = NULL;
221
222         module = submodule_from_path(null_sha1, path);
223
224         if (module) {
225                 char *key = xstrfmt("submodule.%s.url", module->name);
226                 char *value = NULL;
227
228                 ret = !git_config_get_string(key, &value);
229
230                 free(value);
231                 free(key);
232         }
233
234         return ret;
235 }
236
237 /*
238  * Determine if a submodule has been populated at a given 'path'
239  */
240 int is_submodule_populated(const char *path)
241 {
242         int ret = 0;
243         char *gitdir = xstrfmt("%s/.git", path);
244
245         if (resolve_gitdir(gitdir))
246                 ret = 1;
247
248         free(gitdir);
249         return ret;
250 }
251
252 int parse_submodule_update_strategy(const char *value,
253                 struct submodule_update_strategy *dst)
254 {
255         free((void*)dst->command);
256         dst->command = NULL;
257         if (!strcmp(value, "none"))
258                 dst->type = SM_UPDATE_NONE;
259         else if (!strcmp(value, "checkout"))
260                 dst->type = SM_UPDATE_CHECKOUT;
261         else if (!strcmp(value, "rebase"))
262                 dst->type = SM_UPDATE_REBASE;
263         else if (!strcmp(value, "merge"))
264                 dst->type = SM_UPDATE_MERGE;
265         else if (skip_prefix(value, "!", &value)) {
266                 dst->type = SM_UPDATE_COMMAND;
267                 dst->command = xstrdup(value);
268         } else
269                 return -1;
270         return 0;
271 }
272
273 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
274 {
275         struct strbuf sb = STRBUF_INIT;
276         switch (s->type) {
277         case SM_UPDATE_CHECKOUT:
278                 return "checkout";
279         case SM_UPDATE_MERGE:
280                 return "merge";
281         case SM_UPDATE_REBASE:
282                 return "rebase";
283         case SM_UPDATE_NONE:
284                 return "none";
285         case SM_UPDATE_UNSPECIFIED:
286                 return NULL;
287         case SM_UPDATE_COMMAND:
288                 strbuf_addf(&sb, "!%s", s->command);
289                 return strbuf_detach(&sb, NULL);
290         }
291         return NULL;
292 }
293
294 void handle_ignore_submodules_arg(struct diff_options *diffopt,
295                                   const char *arg)
296 {
297         DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
298         DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
299         DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
300
301         if (!strcmp(arg, "all"))
302                 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
303         else if (!strcmp(arg, "untracked"))
304                 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
305         else if (!strcmp(arg, "dirty"))
306                 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
307         else if (strcmp(arg, "none"))
308                 die("bad --ignore-submodules argument: %s", arg);
309 }
310
311 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
312                 struct commit *left, struct commit *right,
313                 struct commit_list *merge_bases)
314 {
315         struct commit_list *list;
316
317         init_revisions(rev, NULL);
318         setup_revisions(0, NULL, rev, NULL);
319         rev->left_right = 1;
320         rev->first_parent_only = 1;
321         left->object.flags |= SYMMETRIC_LEFT;
322         add_pending_object(rev, &left->object, path);
323         add_pending_object(rev, &right->object, path);
324         for (list = merge_bases; list; list = list->next) {
325                 list->item->object.flags |= UNINTERESTING;
326                 add_pending_object(rev, &list->item->object,
327                         oid_to_hex(&list->item->object.oid));
328         }
329         return prepare_revision_walk(rev);
330 }
331
332 static void print_submodule_summary(struct rev_info *rev, FILE *f,
333                 const char *line_prefix,
334                 const char *del, const char *add, const char *reset)
335 {
336         static const char format[] = "  %m %s";
337         struct strbuf sb = STRBUF_INIT;
338         struct commit *commit;
339
340         while ((commit = get_revision(rev))) {
341                 struct pretty_print_context ctx = {0};
342                 ctx.date_mode = rev->date_mode;
343                 ctx.output_encoding = get_log_output_encoding();
344                 strbuf_setlen(&sb, 0);
345                 strbuf_addstr(&sb, line_prefix);
346                 if (commit->object.flags & SYMMETRIC_LEFT) {
347                         if (del)
348                                 strbuf_addstr(&sb, del);
349                 }
350                 else if (add)
351                         strbuf_addstr(&sb, add);
352                 format_commit_message(commit, format, &sb, &ctx);
353                 if (reset)
354                         strbuf_addstr(&sb, reset);
355                 strbuf_addch(&sb, '\n');
356                 fprintf(f, "%s", sb.buf);
357         }
358         strbuf_release(&sb);
359 }
360
361 /* Helper function to display the submodule header line prior to the full
362  * summary output. If it can locate the submodule objects directory it will
363  * attempt to lookup both the left and right commits and put them into the
364  * left and right pointers.
365  */
366 static void show_submodule_header(FILE *f, const char *path,
367                 const char *line_prefix,
368                 struct object_id *one, struct object_id *two,
369                 unsigned dirty_submodule, const char *meta,
370                 const char *reset,
371                 struct commit **left, struct commit **right,
372                 struct commit_list **merge_bases)
373 {
374         const char *message = NULL;
375         struct strbuf sb = STRBUF_INIT;
376         int fast_forward = 0, fast_backward = 0;
377
378         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
379                 fprintf(f, "%sSubmodule %s contains untracked content\n",
380                         line_prefix, path);
381         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
382                 fprintf(f, "%sSubmodule %s contains modified content\n",
383                         line_prefix, path);
384
385         if (is_null_oid(one))
386                 message = "(new submodule)";
387         else if (is_null_oid(two))
388                 message = "(submodule deleted)";
389
390         if (add_submodule_odb(path)) {
391                 if (!message)
392                         message = "(not initialized)";
393                 goto output_header;
394         }
395
396         /*
397          * Attempt to lookup the commit references, and determine if this is
398          * a fast forward or fast backwards update.
399          */
400         *left = lookup_commit_reference(one->hash);
401         *right = lookup_commit_reference(two->hash);
402
403         /*
404          * Warn about missing commits in the submodule project, but only if
405          * they aren't null.
406          */
407         if ((!is_null_oid(one) && !*left) ||
408              (!is_null_oid(two) && !*right))
409                 message = "(commits not present)";
410
411         *merge_bases = get_merge_bases(*left, *right);
412         if (*merge_bases) {
413                 if ((*merge_bases)->item == *left)
414                         fast_forward = 1;
415                 else if ((*merge_bases)->item == *right)
416                         fast_backward = 1;
417         }
418
419         if (!oidcmp(one, two)) {
420                 strbuf_release(&sb);
421                 return;
422         }
423
424 output_header:
425         strbuf_addf(&sb, "%s%sSubmodule %s ", line_prefix, meta, path);
426         strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
427         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
428         strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
429         if (message)
430                 strbuf_addf(&sb, " %s%s\n", message, reset);
431         else
432                 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
433         fwrite(sb.buf, sb.len, 1, f);
434
435         strbuf_release(&sb);
436 }
437
438 void show_submodule_summary(FILE *f, const char *path,
439                 const char *line_prefix,
440                 struct object_id *one, struct object_id *two,
441                 unsigned dirty_submodule, const char *meta,
442                 const char *del, const char *add, const char *reset)
443 {
444         struct rev_info rev;
445         struct commit *left = NULL, *right = NULL;
446         struct commit_list *merge_bases = NULL;
447
448         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
449                               meta, reset, &left, &right, &merge_bases);
450
451         /*
452          * If we don't have both a left and a right pointer, there is no
453          * reason to try and display a summary. The header line should contain
454          * all the information the user needs.
455          */
456         if (!left || !right)
457                 goto out;
458
459         /* Treat revision walker failure the same as missing commits */
460         if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
461                 fprintf(f, "%s(revision walker failed)\n", line_prefix);
462                 goto out;
463         }
464
465         print_submodule_summary(&rev, f, line_prefix, del, add, reset);
466
467 out:
468         if (merge_bases)
469                 free_commit_list(merge_bases);
470         clear_commit_marks(left, ~0);
471         clear_commit_marks(right, ~0);
472 }
473
474 void show_submodule_inline_diff(FILE *f, const char *path,
475                 const char *line_prefix,
476                 struct object_id *one, struct object_id *two,
477                 unsigned dirty_submodule, const char *meta,
478                 const char *del, const char *add, const char *reset,
479                 const struct diff_options *o)
480 {
481         const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
482         struct commit *left = NULL, *right = NULL;
483         struct commit_list *merge_bases = NULL;
484         struct strbuf submodule_dir = STRBUF_INIT;
485         struct child_process cp = CHILD_PROCESS_INIT;
486
487         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
488                               meta, reset, &left, &right, &merge_bases);
489
490         /* We need a valid left and right commit to display a difference */
491         if (!(left || is_null_oid(one)) ||
492             !(right || is_null_oid(two)))
493                 goto done;
494
495         if (left)
496                 old = one;
497         if (right)
498                 new = two;
499
500         fflush(f);
501         cp.git_cmd = 1;
502         cp.dir = path;
503         cp.out = dup(fileno(f));
504         cp.no_stdin = 1;
505
506         /* TODO: other options may need to be passed here. */
507         argv_array_push(&cp.args, "diff");
508         argv_array_pushf(&cp.args, "--line-prefix=%s", line_prefix);
509         if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
510                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
511                                  o->b_prefix, path);
512                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
513                                  o->a_prefix, path);
514         } else {
515                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
516                                  o->a_prefix, path);
517                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
518                                  o->b_prefix, path);
519         }
520         argv_array_push(&cp.args, oid_to_hex(old));
521         /*
522          * If the submodule has modified content, we will diff against the
523          * work tree, under the assumption that the user has asked for the
524          * diff format and wishes to actually see all differences even if they
525          * haven't yet been committed to the submodule yet.
526          */
527         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
528                 argv_array_push(&cp.args, oid_to_hex(new));
529
530         if (run_command(&cp))
531                 fprintf(f, "(diff failed)\n");
532
533 done:
534         strbuf_release(&submodule_dir);
535         if (merge_bases)
536                 free_commit_list(merge_bases);
537         if (left)
538                 clear_commit_marks(left, ~0);
539         if (right)
540                 clear_commit_marks(right, ~0);
541 }
542
543 void set_config_fetch_recurse_submodules(int value)
544 {
545         config_fetch_recurse_submodules = value;
546 }
547
548 static int has_remote(const char *refname, const struct object_id *oid,
549                       int flags, void *cb_data)
550 {
551         return 1;
552 }
553
554 static int append_sha1_to_argv(const unsigned char sha1[20], void *data)
555 {
556         struct argv_array *argv = data;
557         argv_array_push(argv, sha1_to_hex(sha1));
558         return 0;
559 }
560
561 static int check_has_commit(const unsigned char sha1[20], void *data)
562 {
563         int *has_commit = data;
564
565         if (!lookup_commit_reference(sha1))
566                 *has_commit = 0;
567
568         return 0;
569 }
570
571 static int submodule_has_commits(const char *path, struct sha1_array *commits)
572 {
573         int has_commit = 1;
574
575         if (add_submodule_odb(path))
576                 return 0;
577
578         sha1_array_for_each_unique(commits, check_has_commit, &has_commit);
579         return has_commit;
580 }
581
582 static int submodule_needs_pushing(const char *path, struct sha1_array *commits)
583 {
584         if (!submodule_has_commits(path, commits))
585                 /*
586                  * NOTE: We do consider it safe to return "no" here. The
587                  * correct answer would be "We do not know" instead of
588                  * "No push needed", but it is quite hard to change
589                  * the submodule pointer without having the submodule
590                  * around. If a user did however change the submodules
591                  * without having the submodule around, this indicates
592                  * an expert who knows what they are doing or a
593                  * maintainer integrating work from other people. In
594                  * both cases it should be safe to skip this check.
595                  */
596                 return 0;
597
598         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
599                 struct child_process cp = CHILD_PROCESS_INIT;
600                 struct strbuf buf = STRBUF_INIT;
601                 int needs_pushing = 0;
602
603                 argv_array_push(&cp.args, "rev-list");
604                 sha1_array_for_each_unique(commits, append_sha1_to_argv, &cp.args);
605                 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
606
607                 prepare_submodule_repo_env(&cp.env_array);
608                 cp.git_cmd = 1;
609                 cp.no_stdin = 1;
610                 cp.out = -1;
611                 cp.dir = path;
612                 if (start_command(&cp))
613                         die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
614                                         path);
615                 if (strbuf_read(&buf, cp.out, 41))
616                         needs_pushing = 1;
617                 finish_command(&cp);
618                 close(cp.out);
619                 strbuf_release(&buf);
620                 return needs_pushing;
621         }
622
623         return 0;
624 }
625
626 static struct sha1_array *submodule_commits(struct string_list *submodules,
627                                             const char *path)
628 {
629         struct string_list_item *item;
630
631         item = string_list_insert(submodules, path);
632         if (item->util)
633                 return (struct sha1_array *) item->util;
634
635         /* NEEDSWORK: should we have sha1_array_init()? */
636         item->util = xcalloc(1, sizeof(struct sha1_array));
637         return (struct sha1_array *) item->util;
638 }
639
640 static void collect_submodules_from_diff(struct diff_queue_struct *q,
641                                          struct diff_options *options,
642                                          void *data)
643 {
644         int i;
645         struct string_list *submodules = data;
646
647         for (i = 0; i < q->nr; i++) {
648                 struct diff_filepair *p = q->queue[i];
649                 struct sha1_array *commits;
650                 if (!S_ISGITLINK(p->two->mode))
651                         continue;
652                 commits = submodule_commits(submodules, p->two->path);
653                 sha1_array_append(commits, p->two->oid.hash);
654         }
655 }
656
657 static void find_unpushed_submodule_commits(struct commit *commit,
658                 struct string_list *needs_pushing)
659 {
660         struct rev_info rev;
661
662         init_revisions(&rev, NULL);
663         rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
664         rev.diffopt.format_callback = collect_submodules_from_diff;
665         rev.diffopt.format_callback_data = needs_pushing;
666         diff_tree_combined_merge(commit, 1, &rev);
667 }
668
669 static void free_submodules_sha1s(struct string_list *submodules)
670 {
671         struct string_list_item *item;
672         for_each_string_list_item(item, submodules)
673                 sha1_array_clear((struct sha1_array *) item->util);
674         string_list_clear(submodules, 1);
675 }
676
677 int find_unpushed_submodules(struct sha1_array *commits,
678                 const char *remotes_name, struct string_list *needs_pushing)
679 {
680         struct rev_info rev;
681         struct commit *commit;
682         struct string_list submodules = STRING_LIST_INIT_DUP;
683         struct string_list_item *submodule;
684         struct argv_array argv = ARGV_ARRAY_INIT;
685
686         init_revisions(&rev, NULL);
687
688         /* argv.argv[0] will be ignored by setup_revisions */
689         argv_array_push(&argv, "find_unpushed_submodules");
690         sha1_array_for_each_unique(commits, append_sha1_to_argv, &argv);
691         argv_array_push(&argv, "--not");
692         argv_array_pushf(&argv, "--remotes=%s", remotes_name);
693
694         setup_revisions(argv.argc, argv.argv, &rev, NULL);
695         if (prepare_revision_walk(&rev))
696                 die("revision walk setup failed");
697
698         while ((commit = get_revision(&rev)) != NULL)
699                 find_unpushed_submodule_commits(commit, &submodules);
700
701         reset_revision_walk();
702         argv_array_clear(&argv);
703
704         for_each_string_list_item(submodule, &submodules) {
705                 struct sha1_array *commits = (struct sha1_array *) submodule->util;
706
707                 if (submodule_needs_pushing(submodule->string, commits))
708                         string_list_insert(needs_pushing, submodule->string);
709         }
710         free_submodules_sha1s(&submodules);
711
712         return needs_pushing->nr;
713 }
714
715 static int push_submodule(const char *path, int dry_run)
716 {
717         if (add_submodule_odb(path))
718                 return 1;
719
720         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
721                 struct child_process cp = CHILD_PROCESS_INIT;
722                 argv_array_push(&cp.args, "push");
723                 if (dry_run)
724                         argv_array_push(&cp.args, "--dry-run");
725
726                 prepare_submodule_repo_env(&cp.env_array);
727                 cp.git_cmd = 1;
728                 cp.no_stdin = 1;
729                 cp.dir = path;
730                 if (run_command(&cp))
731                         return 0;
732                 close(cp.out);
733         }
734
735         return 1;
736 }
737
738 int push_unpushed_submodules(struct sha1_array *commits,
739                              const char *remotes_name,
740                              int dry_run)
741 {
742         int i, ret = 1;
743         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
744
745         if (!find_unpushed_submodules(commits, remotes_name, &needs_pushing))
746                 return 1;
747
748         for (i = 0; i < needs_pushing.nr; i++) {
749                 const char *path = needs_pushing.items[i].string;
750                 fprintf(stderr, "Pushing submodule '%s'\n", path);
751                 if (!push_submodule(path, dry_run)) {
752                         fprintf(stderr, "Unable to push submodule '%s'\n", path);
753                         ret = 0;
754                 }
755         }
756
757         string_list_clear(&needs_pushing, 0);
758
759         return ret;
760 }
761
762 static int is_submodule_commit_present(const char *path, unsigned char sha1[20])
763 {
764         int is_present = 0;
765         if (!add_submodule_odb(path) && lookup_commit_reference(sha1)) {
766                 /* Even if the submodule is checked out and the commit is
767                  * present, make sure it is reachable from a ref. */
768                 struct child_process cp = CHILD_PROCESS_INIT;
769                 const char *argv[] = {"rev-list", "-n", "1", NULL, "--not", "--all", NULL};
770                 struct strbuf buf = STRBUF_INIT;
771
772                 argv[3] = sha1_to_hex(sha1);
773                 cp.argv = argv;
774                 prepare_submodule_repo_env(&cp.env_array);
775                 cp.git_cmd = 1;
776                 cp.no_stdin = 1;
777                 cp.dir = path;
778                 if (!capture_command(&cp, &buf, 1024) && !buf.len)
779                         is_present = 1;
780
781                 strbuf_release(&buf);
782         }
783         return is_present;
784 }
785
786 static void submodule_collect_changed_cb(struct diff_queue_struct *q,
787                                          struct diff_options *options,
788                                          void *data)
789 {
790         int i;
791         for (i = 0; i < q->nr; i++) {
792                 struct diff_filepair *p = q->queue[i];
793                 if (!S_ISGITLINK(p->two->mode))
794                         continue;
795
796                 if (S_ISGITLINK(p->one->mode)) {
797                         /* NEEDSWORK: We should honor the name configured in
798                          * the .gitmodules file of the commit we are examining
799                          * here to be able to correctly follow submodules
800                          * being moved around. */
801                         struct string_list_item *path;
802                         path = unsorted_string_list_lookup(&changed_submodule_paths, p->two->path);
803                         if (!path && !is_submodule_commit_present(p->two->path, p->two->oid.hash))
804                                 string_list_append(&changed_submodule_paths, xstrdup(p->two->path));
805                 } else {
806                         /* Submodule is new or was moved here */
807                         /* NEEDSWORK: When the .git directories of submodules
808                          * live inside the superprojects .git directory some
809                          * day we should fetch new submodules directly into
810                          * that location too when config or options request
811                          * that so they can be checked out from there. */
812                         continue;
813                 }
814         }
815 }
816
817 static int add_sha1_to_array(const char *ref, const struct object_id *oid,
818                              int flags, void *data)
819 {
820         sha1_array_append(data, oid->hash);
821         return 0;
822 }
823
824 void check_for_new_submodule_commits(unsigned char new_sha1[20])
825 {
826         if (!initialized_fetch_ref_tips) {
827                 for_each_ref(add_sha1_to_array, &ref_tips_before_fetch);
828                 initialized_fetch_ref_tips = 1;
829         }
830
831         sha1_array_append(&ref_tips_after_fetch, new_sha1);
832 }
833
834 static int add_sha1_to_argv(const unsigned char sha1[20], void *data)
835 {
836         argv_array_push(data, sha1_to_hex(sha1));
837         return 0;
838 }
839
840 static void calculate_changed_submodule_paths(void)
841 {
842         struct rev_info rev;
843         struct commit *commit;
844         struct argv_array argv = ARGV_ARRAY_INIT;
845
846         /* No need to check if there are no submodules configured */
847         if (!submodule_from_path(NULL, NULL))
848                 return;
849
850         init_revisions(&rev, NULL);
851         argv_array_push(&argv, "--"); /* argv[0] program name */
852         sha1_array_for_each_unique(&ref_tips_after_fetch,
853                                    add_sha1_to_argv, &argv);
854         argv_array_push(&argv, "--not");
855         sha1_array_for_each_unique(&ref_tips_before_fetch,
856                                    add_sha1_to_argv, &argv);
857         setup_revisions(argv.argc, argv.argv, &rev, NULL);
858         if (prepare_revision_walk(&rev))
859                 die("revision walk setup failed");
860
861         /*
862          * Collect all submodules (whether checked out or not) for which new
863          * commits have been recorded upstream in "changed_submodule_paths".
864          */
865         while ((commit = get_revision(&rev))) {
866                 struct commit_list *parent = commit->parents;
867                 while (parent) {
868                         struct diff_options diff_opts;
869                         diff_setup(&diff_opts);
870                         DIFF_OPT_SET(&diff_opts, RECURSIVE);
871                         diff_opts.output_format |= DIFF_FORMAT_CALLBACK;
872                         diff_opts.format_callback = submodule_collect_changed_cb;
873                         diff_setup_done(&diff_opts);
874                         diff_tree_sha1(parent->item->object.oid.hash, commit->object.oid.hash, "", &diff_opts);
875                         diffcore_std(&diff_opts);
876                         diff_flush(&diff_opts);
877                         parent = parent->next;
878                 }
879         }
880
881         argv_array_clear(&argv);
882         sha1_array_clear(&ref_tips_before_fetch);
883         sha1_array_clear(&ref_tips_after_fetch);
884         initialized_fetch_ref_tips = 0;
885 }
886
887 struct submodule_parallel_fetch {
888         int count;
889         struct argv_array args;
890         const char *work_tree;
891         const char *prefix;
892         int command_line_option;
893         int quiet;
894         int result;
895 };
896 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0}
897
898 static int get_next_submodule(struct child_process *cp,
899                               struct strbuf *err, void *data, void **task_cb)
900 {
901         int ret = 0;
902         struct submodule_parallel_fetch *spf = data;
903
904         for (; spf->count < active_nr; spf->count++) {
905                 struct strbuf submodule_path = STRBUF_INIT;
906                 struct strbuf submodule_git_dir = STRBUF_INIT;
907                 struct strbuf submodule_prefix = STRBUF_INIT;
908                 const struct cache_entry *ce = active_cache[spf->count];
909                 const char *git_dir, *default_argv;
910                 const struct submodule *submodule;
911
912                 if (!S_ISGITLINK(ce->ce_mode))
913                         continue;
914
915                 submodule = submodule_from_path(null_sha1, ce->name);
916                 if (!submodule)
917                         submodule = submodule_from_name(null_sha1, ce->name);
918
919                 default_argv = "yes";
920                 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
921                         if (submodule &&
922                             submodule->fetch_recurse !=
923                                                 RECURSE_SUBMODULES_NONE) {
924                                 if (submodule->fetch_recurse ==
925                                                 RECURSE_SUBMODULES_OFF)
926                                         continue;
927                                 if (submodule->fetch_recurse ==
928                                                 RECURSE_SUBMODULES_ON_DEMAND) {
929                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
930                                                 continue;
931                                         default_argv = "on-demand";
932                                 }
933                         } else {
934                                 if ((config_fetch_recurse_submodules == RECURSE_SUBMODULES_OFF) ||
935                                     gitmodules_is_unmerged)
936                                         continue;
937                                 if (config_fetch_recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) {
938                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
939                                                 continue;
940                                         default_argv = "on-demand";
941                                 }
942                         }
943                 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
944                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
945                                 continue;
946                         default_argv = "on-demand";
947                 }
948
949                 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
950                 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
951                 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
952                 git_dir = read_gitfile(submodule_git_dir.buf);
953                 if (!git_dir)
954                         git_dir = submodule_git_dir.buf;
955                 if (is_directory(git_dir)) {
956                         child_process_init(cp);
957                         cp->dir = strbuf_detach(&submodule_path, NULL);
958                         prepare_submodule_repo_env(&cp->env_array);
959                         cp->git_cmd = 1;
960                         if (!spf->quiet)
961                                 strbuf_addf(err, "Fetching submodule %s%s\n",
962                                             spf->prefix, ce->name);
963                         argv_array_init(&cp->args);
964                         argv_array_pushv(&cp->args, spf->args.argv);
965                         argv_array_push(&cp->args, default_argv);
966                         argv_array_push(&cp->args, "--submodule-prefix");
967                         argv_array_push(&cp->args, submodule_prefix.buf);
968                         ret = 1;
969                 }
970                 strbuf_release(&submodule_path);
971                 strbuf_release(&submodule_git_dir);
972                 strbuf_release(&submodule_prefix);
973                 if (ret) {
974                         spf->count++;
975                         return 1;
976                 }
977         }
978         return 0;
979 }
980
981 static int fetch_start_failure(struct strbuf *err,
982                                void *cb, void *task_cb)
983 {
984         struct submodule_parallel_fetch *spf = cb;
985
986         spf->result = 1;
987
988         return 0;
989 }
990
991 static int fetch_finish(int retvalue, struct strbuf *err,
992                         void *cb, void *task_cb)
993 {
994         struct submodule_parallel_fetch *spf = cb;
995
996         if (retvalue)
997                 spf->result = 1;
998
999         return 0;
1000 }
1001
1002 int fetch_populated_submodules(const struct argv_array *options,
1003                                const char *prefix, int command_line_option,
1004                                int quiet, int max_parallel_jobs)
1005 {
1006         int i;
1007         struct submodule_parallel_fetch spf = SPF_INIT;
1008
1009         spf.work_tree = get_git_work_tree();
1010         spf.command_line_option = command_line_option;
1011         spf.quiet = quiet;
1012         spf.prefix = prefix;
1013
1014         if (!spf.work_tree)
1015                 goto out;
1016
1017         if (read_cache() < 0)
1018                 die("index file corrupt");
1019
1020         argv_array_push(&spf.args, "fetch");
1021         for (i = 0; i < options->argc; i++)
1022                 argv_array_push(&spf.args, options->argv[i]);
1023         argv_array_push(&spf.args, "--recurse-submodules-default");
1024         /* default value, "--submodule-prefix" and its value are added later */
1025
1026         if (max_parallel_jobs < 0)
1027                 max_parallel_jobs = parallel_jobs;
1028
1029         calculate_changed_submodule_paths();
1030         run_processes_parallel(max_parallel_jobs,
1031                                get_next_submodule,
1032                                fetch_start_failure,
1033                                fetch_finish,
1034                                &spf);
1035
1036         argv_array_clear(&spf.args);
1037 out:
1038         string_list_clear(&changed_submodule_paths, 1);
1039         return spf.result;
1040 }
1041
1042 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1043 {
1044         struct child_process cp = CHILD_PROCESS_INIT;
1045         struct strbuf buf = STRBUF_INIT;
1046         FILE *fp;
1047         unsigned dirty_submodule = 0;
1048         const char *git_dir;
1049         int ignore_cp_exit_code = 0;
1050
1051         strbuf_addf(&buf, "%s/.git", path);
1052         git_dir = read_gitfile(buf.buf);
1053         if (!git_dir)
1054                 git_dir = buf.buf;
1055         if (!is_git_directory(git_dir)) {
1056                 if (is_directory(git_dir))
1057                         die(_("'%s' not recognized as a git repository"), git_dir);
1058                 strbuf_release(&buf);
1059                 /* The submodule is not checked out, so it is not modified */
1060                 return 0;
1061         }
1062         strbuf_reset(&buf);
1063
1064         argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1065         if (ignore_untracked)
1066                 argv_array_push(&cp.args, "-uno");
1067
1068         prepare_submodule_repo_env(&cp.env_array);
1069         cp.git_cmd = 1;
1070         cp.no_stdin = 1;
1071         cp.out = -1;
1072         cp.dir = path;
1073         if (start_command(&cp))
1074                 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1075
1076         fp = xfdopen(cp.out, "r");
1077         while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1078                 /* regular untracked files */
1079                 if (buf.buf[0] == '?')
1080                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1081                 else
1082                         dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1083
1084                 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1085                     ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1086                      ignore_untracked)) {
1087                         /*
1088                          * We're not interested in any further information from
1089                          * the child any more, neither output nor its exit code.
1090                          */
1091                         ignore_cp_exit_code = 1;
1092                         break;
1093                 }
1094         }
1095         fclose(fp);
1096
1097         if (finish_command(&cp) && !ignore_cp_exit_code)
1098                 die("'git status --porcelain=2' failed in submodule %s", path);
1099
1100         strbuf_release(&buf);
1101         return dirty_submodule;
1102 }
1103
1104 int submodule_uses_gitfile(const char *path)
1105 {
1106         struct child_process cp = CHILD_PROCESS_INIT;
1107         const char *argv[] = {
1108                 "submodule",
1109                 "foreach",
1110                 "--quiet",
1111                 "--recursive",
1112                 "test -f .git",
1113                 NULL,
1114         };
1115         struct strbuf buf = STRBUF_INIT;
1116         const char *git_dir;
1117
1118         strbuf_addf(&buf, "%s/.git", path);
1119         git_dir = read_gitfile(buf.buf);
1120         if (!git_dir) {
1121                 strbuf_release(&buf);
1122                 return 0;
1123         }
1124         strbuf_release(&buf);
1125
1126         /* Now test that all nested submodules use a gitfile too */
1127         cp.argv = argv;
1128         prepare_submodule_repo_env(&cp.env_array);
1129         cp.git_cmd = 1;
1130         cp.no_stdin = 1;
1131         cp.no_stderr = 1;
1132         cp.no_stdout = 1;
1133         cp.dir = path;
1134         if (run_command(&cp))
1135                 return 0;
1136
1137         return 1;
1138 }
1139
1140 /*
1141  * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1142  * when doing so.
1143  *
1144  * Return 1 if we'd lose data, return 0 if the removal is fine,
1145  * and negative values for errors.
1146  */
1147 int bad_to_remove_submodule(const char *path, unsigned flags)
1148 {
1149         ssize_t len;
1150         struct child_process cp = CHILD_PROCESS_INIT;
1151         struct strbuf buf = STRBUF_INIT;
1152         int ret = 0;
1153
1154         if (!file_exists(path) || is_empty_dir(path))
1155                 return 0;
1156
1157         if (!submodule_uses_gitfile(path))
1158                 return 1;
1159
1160         argv_array_pushl(&cp.args, "status", "--porcelain",
1161                                    "--ignore-submodules=none", NULL);
1162
1163         if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1164                 argv_array_push(&cp.args, "-uno");
1165         else
1166                 argv_array_push(&cp.args, "-uall");
1167
1168         if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1169                 argv_array_push(&cp.args, "--ignored");
1170
1171         prepare_submodule_repo_env(&cp.env_array);
1172         cp.git_cmd = 1;
1173         cp.no_stdin = 1;
1174         cp.out = -1;
1175         cp.dir = path;
1176         if (start_command(&cp)) {
1177                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1178                         die(_("could not start 'git status in submodule '%s'"),
1179                                 path);
1180                 ret = -1;
1181                 goto out;
1182         }
1183
1184         len = strbuf_read(&buf, cp.out, 1024);
1185         if (len > 2)
1186                 ret = 1;
1187         close(cp.out);
1188
1189         if (finish_command(&cp)) {
1190                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1191                         die(_("could not run 'git status in submodule '%s'"),
1192                                 path);
1193                 ret = -1;
1194         }
1195 out:
1196         strbuf_release(&buf);
1197         return ret;
1198 }
1199
1200 static int find_first_merges(struct object_array *result, const char *path,
1201                 struct commit *a, struct commit *b)
1202 {
1203         int i, j;
1204         struct object_array merges = OBJECT_ARRAY_INIT;
1205         struct commit *commit;
1206         int contains_another;
1207
1208         char merged_revision[42];
1209         const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1210                                    "--all", merged_revision, NULL };
1211         struct rev_info revs;
1212         struct setup_revision_opt rev_opts;
1213
1214         memset(result, 0, sizeof(struct object_array));
1215         memset(&rev_opts, 0, sizeof(rev_opts));
1216
1217         /* get all revisions that merge commit a */
1218         snprintf(merged_revision, sizeof(merged_revision), "^%s",
1219                         oid_to_hex(&a->object.oid));
1220         init_revisions(&revs, NULL);
1221         rev_opts.submodule = path;
1222         setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1223
1224         /* save all revisions from the above list that contain b */
1225         if (prepare_revision_walk(&revs))
1226                 die("revision walk setup failed");
1227         while ((commit = get_revision(&revs)) != NULL) {
1228                 struct object *o = &(commit->object);
1229                 if (in_merge_bases(b, commit))
1230                         add_object_array(o, NULL, &merges);
1231         }
1232         reset_revision_walk();
1233
1234         /* Now we've got all merges that contain a and b. Prune all
1235          * merges that contain another found merge and save them in
1236          * result.
1237          */
1238         for (i = 0; i < merges.nr; i++) {
1239                 struct commit *m1 = (struct commit *) merges.objects[i].item;
1240
1241                 contains_another = 0;
1242                 for (j = 0; j < merges.nr; j++) {
1243                         struct commit *m2 = (struct commit *) merges.objects[j].item;
1244                         if (i != j && in_merge_bases(m2, m1)) {
1245                                 contains_another = 1;
1246                                 break;
1247                         }
1248                 }
1249
1250                 if (!contains_another)
1251                         add_object_array(merges.objects[i].item, NULL, result);
1252         }
1253
1254         free(merges.objects);
1255         return result->nr;
1256 }
1257
1258 static void print_commit(struct commit *commit)
1259 {
1260         struct strbuf sb = STRBUF_INIT;
1261         struct pretty_print_context ctx = {0};
1262         ctx.date_mode.type = DATE_NORMAL;
1263         format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1264         fprintf(stderr, "%s\n", sb.buf);
1265         strbuf_release(&sb);
1266 }
1267
1268 #define MERGE_WARNING(path, msg) \
1269         warning("Failed to merge submodule %s (%s)", path, msg);
1270
1271 int merge_submodule(unsigned char result[20], const char *path,
1272                     const unsigned char base[20], const unsigned char a[20],
1273                     const unsigned char b[20], int search)
1274 {
1275         struct commit *commit_base, *commit_a, *commit_b;
1276         int parent_count;
1277         struct object_array merges;
1278
1279         int i;
1280
1281         /* store a in result in case we fail */
1282         hashcpy(result, a);
1283
1284         /* we can not handle deletion conflicts */
1285         if (is_null_sha1(base))
1286                 return 0;
1287         if (is_null_sha1(a))
1288                 return 0;
1289         if (is_null_sha1(b))
1290                 return 0;
1291
1292         if (add_submodule_odb(path)) {
1293                 MERGE_WARNING(path, "not checked out");
1294                 return 0;
1295         }
1296
1297         if (!(commit_base = lookup_commit_reference(base)) ||
1298             !(commit_a = lookup_commit_reference(a)) ||
1299             !(commit_b = lookup_commit_reference(b))) {
1300                 MERGE_WARNING(path, "commits not present");
1301                 return 0;
1302         }
1303
1304         /* check whether both changes are forward */
1305         if (!in_merge_bases(commit_base, commit_a) ||
1306             !in_merge_bases(commit_base, commit_b)) {
1307                 MERGE_WARNING(path, "commits don't follow merge-base");
1308                 return 0;
1309         }
1310
1311         /* Case #1: a is contained in b or vice versa */
1312         if (in_merge_bases(commit_a, commit_b)) {
1313                 hashcpy(result, b);
1314                 return 1;
1315         }
1316         if (in_merge_bases(commit_b, commit_a)) {
1317                 hashcpy(result, a);
1318                 return 1;
1319         }
1320
1321         /*
1322          * Case #2: There are one or more merges that contain a and b in
1323          * the submodule. If there is only one, then present it as a
1324          * suggestion to the user, but leave it marked unmerged so the
1325          * user needs to confirm the resolution.
1326          */
1327
1328         /* Skip the search if makes no sense to the calling context.  */
1329         if (!search)
1330                 return 0;
1331
1332         /* find commit which merges them */
1333         parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1334         switch (parent_count) {
1335         case 0:
1336                 MERGE_WARNING(path, "merge following commits not found");
1337                 break;
1338
1339         case 1:
1340                 MERGE_WARNING(path, "not fast-forward");
1341                 fprintf(stderr, "Found a possible merge resolution "
1342                                 "for the submodule:\n");
1343                 print_commit((struct commit *) merges.objects[0].item);
1344                 fprintf(stderr,
1345                         "If this is correct simply add it to the index "
1346                         "for example\n"
1347                         "by using:\n\n"
1348                         "  git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1349                         "which will accept this suggestion.\n",
1350                         oid_to_hex(&merges.objects[0].item->oid), path);
1351                 break;
1352
1353         default:
1354                 MERGE_WARNING(path, "multiple merges found");
1355                 for (i = 0; i < merges.nr; i++)
1356                         print_commit((struct commit *) merges.objects[i].item);
1357         }
1358
1359         free(merges.objects);
1360         return 0;
1361 }
1362
1363 int parallel_submodules(void)
1364 {
1365         return parallel_jobs;
1366 }
1367
1368 void prepare_submodule_repo_env(struct argv_array *out)
1369 {
1370         const char * const *var;
1371
1372         for (var = local_repo_env; *var; var++) {
1373                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
1374                         argv_array_push(out, *var);
1375         }
1376         argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
1377                          DEFAULT_GIT_DIR_ENVIRONMENT);
1378 }
1379
1380 /*
1381  * Embeds a single submodules git directory into the superprojects git dir,
1382  * non recursively.
1383  */
1384 static void relocate_single_git_dir_into_superproject(const char *prefix,
1385                                                       const char *path)
1386 {
1387         char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1388         const char *new_git_dir;
1389         const struct submodule *sub;
1390
1391         if (submodule_uses_worktrees(path))
1392                 die(_("relocate_gitdir for submodule '%s' with "
1393                       "more than one worktree not supported"), path);
1394
1395         old_git_dir = xstrfmt("%s/.git", path);
1396         if (read_gitfile(old_git_dir))
1397                 /* If it is an actual gitfile, it doesn't need migration. */
1398                 return;
1399
1400         real_old_git_dir = real_pathdup(old_git_dir, 1);
1401
1402         sub = submodule_from_path(null_sha1, path);
1403         if (!sub)
1404                 die(_("could not lookup name for submodule '%s'"), path);
1405
1406         new_git_dir = git_path("modules/%s", sub->name);
1407         if (safe_create_leading_directories_const(new_git_dir) < 0)
1408                 die(_("could not create directory '%s'"), new_git_dir);
1409         real_new_git_dir = real_pathdup(new_git_dir, 1);
1410
1411         if (!prefix)
1412                 prefix = get_super_prefix();
1413
1414         fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1415                 prefix ? prefix : "", path,
1416                 real_old_git_dir, real_new_git_dir);
1417
1418         relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1419
1420         free(old_git_dir);
1421         free(real_old_git_dir);
1422         free(real_new_git_dir);
1423 }
1424
1425 /*
1426  * Migrate the git directory of the submodule given by path from
1427  * having its git directory within the working tree to the git dir nested
1428  * in its superprojects git dir under modules/.
1429  */
1430 void absorb_git_dir_into_superproject(const char *prefix,
1431                                       const char *path,
1432                                       unsigned flags)
1433 {
1434         int err_code;
1435         const char *sub_git_dir;
1436         struct strbuf gitdir = STRBUF_INIT;
1437         strbuf_addf(&gitdir, "%s/.git", path);
1438         sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1439
1440         /* Not populated? */
1441         if (!sub_git_dir) {
1442                 char *real_new_git_dir;
1443                 const char *new_git_dir;
1444                 const struct submodule *sub;
1445
1446                 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1447                         /* unpopulated as expected */
1448                         strbuf_release(&gitdir);
1449                         return;
1450                 }
1451
1452                 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1453                         /* We don't know what broke here. */
1454                         read_gitfile_error_die(err_code, path, NULL);
1455
1456                 /*
1457                 * Maybe populated, but no git directory was found?
1458                 * This can happen if the superproject is a submodule
1459                 * itself and was just absorbed. The absorption of the
1460                 * superproject did not rewrite the git file links yet,
1461                 * fix it now.
1462                 */
1463                 sub = submodule_from_path(null_sha1, path);
1464                 if (!sub)
1465                         die(_("could not lookup name for submodule '%s'"), path);
1466                 new_git_dir = git_path("modules/%s", sub->name);
1467                 if (safe_create_leading_directories_const(new_git_dir) < 0)
1468                         die(_("could not create directory '%s'"), new_git_dir);
1469                 real_new_git_dir = real_pathdup(new_git_dir, 1);
1470                 connect_work_tree_and_git_dir(path, real_new_git_dir);
1471
1472                 free(real_new_git_dir);
1473         } else {
1474                 /* Is it already absorbed into the superprojects git dir? */
1475                 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1476                 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1477
1478                 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1479                         relocate_single_git_dir_into_superproject(prefix, path);
1480
1481                 free(real_sub_git_dir);
1482                 free(real_common_git_dir);
1483         }
1484         strbuf_release(&gitdir);
1485
1486         if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1487                 struct child_process cp = CHILD_PROCESS_INIT;
1488                 struct strbuf sb = STRBUF_INIT;
1489
1490                 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1491                         die("BUG: we don't know how to pass the flags down?");
1492
1493                 if (get_super_prefix())
1494                         strbuf_addstr(&sb, get_super_prefix());
1495                 strbuf_addstr(&sb, path);
1496                 strbuf_addch(&sb, '/');
1497
1498                 cp.dir = path;
1499                 cp.git_cmd = 1;
1500                 cp.no_stdin = 1;
1501                 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1502                                            "submodule--helper",
1503                                            "absorb-git-dirs", NULL);
1504                 prepare_submodule_repo_env(&cp.env_array);
1505                 if (run_command(&cp))
1506                         die(_("could not recurse into submodule '%s'"), path);
1507
1508                 strbuf_release(&sb);
1509         }
1510 }
1511
1512 const char *get_superproject_working_tree(void)
1513 {
1514         struct child_process cp = CHILD_PROCESS_INIT;
1515         struct strbuf sb = STRBUF_INIT;
1516         const char *one_up = real_path_if_valid("../");
1517         const char *cwd = xgetcwd();
1518         const char *ret = NULL;
1519         const char *subpath;
1520         int code;
1521         ssize_t len;
1522
1523         if (!is_inside_work_tree())
1524                 /*
1525                  * FIXME:
1526                  * We might have a superproject, but it is harder
1527                  * to determine.
1528                  */
1529                 return NULL;
1530
1531         if (!one_up)
1532                 return NULL;
1533
1534         subpath = relative_path(cwd, one_up, &sb);
1535
1536         prepare_submodule_repo_env(&cp.env_array);
1537         argv_array_pop(&cp.env_array);
1538
1539         argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1540                         "ls-files", "-z", "--stage", "--full-name", "--",
1541                         subpath, NULL);
1542         strbuf_reset(&sb);
1543
1544         cp.no_stdin = 1;
1545         cp.no_stderr = 1;
1546         cp.out = -1;
1547         cp.git_cmd = 1;
1548
1549         if (start_command(&cp))
1550                 die(_("could not start ls-files in .."));
1551
1552         len = strbuf_read(&sb, cp.out, PATH_MAX);
1553         close(cp.out);
1554
1555         if (starts_with(sb.buf, "160000")) {
1556                 int super_sub_len;
1557                 int cwd_len = strlen(cwd);
1558                 char *super_sub, *super_wt;
1559
1560                 /*
1561                  * There is a superproject having this repo as a submodule.
1562                  * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1563                  * We're only interested in the name after the tab.
1564                  */
1565                 super_sub = strchr(sb.buf, '\t') + 1;
1566                 super_sub_len = sb.buf + sb.len - super_sub - 1;
1567
1568                 if (super_sub_len > cwd_len ||
1569                     strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1570                         die (_("BUG: returned path string doesn't match cwd?"));
1571
1572                 super_wt = xstrdup(cwd);
1573                 super_wt[cwd_len - super_sub_len] = '\0';
1574
1575                 ret = real_path(super_wt);
1576                 free(super_wt);
1577         }
1578         strbuf_release(&sb);
1579
1580         code = finish_command(&cp);
1581
1582         if (code == 128)
1583                 /* '../' is not a git repository */
1584                 return NULL;
1585         if (code == 0 && len == 0)
1586                 /* There is an unrelated git repository at '../' */
1587                 return NULL;
1588         if (code)
1589                 die(_("ls-tree returned unexpected return code %d"), code);
1590
1591         return ret;
1592 }