submodule: check for unstaged .gitmodules outside of config parsing
[git] / submodule.c
1 #include "cache.h"
2 #include "repository.h"
3 #include "config.h"
4 #include "submodule-config.h"
5 #include "submodule.h"
6 #include "dir.h"
7 #include "diff.h"
8 #include "commit.h"
9 #include "revision.h"
10 #include "run-command.h"
11 #include "diffcore.h"
12 #include "refs.h"
13 #include "string-list.h"
14 #include "sha1-array.h"
15 #include "argv-array.h"
16 #include "blob.h"
17 #include "thread-utils.h"
18 #include "quote.h"
19 #include "remote.h"
20 #include "worktree.h"
21 #include "parse-options.h"
22
23 static int config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
24 static struct string_list changed_submodule_paths = STRING_LIST_INIT_DUP;
25 static int initialized_fetch_ref_tips;
26 static struct oid_array ref_tips_before_fetch;
27 static struct oid_array ref_tips_after_fetch;
28
29 /*
30  * The following flag is set if the .gitmodules file is unmerged. We then
31  * disable recursion for all submodules where .git/config doesn't have a
32  * matching config entry because we can't guess what might be configured in
33  * .gitmodules unless the user resolves the conflict. When a command line
34  * option is given (which always overrides configuration) this flag will be
35  * ignored.
36  */
37 static int gitmodules_is_unmerged;
38
39 /*
40  * Check if the .gitmodules file has unstaged modifications.  This must be
41  * checked before allowing modifications to the .gitmodules file with the
42  * intention to stage them later, because when continuing we would stage the
43  * modifications the user didn't stage herself too. That might change in a
44  * future version when we learn to stage the changes we do ourselves without
45  * staging any previous modifications.
46  */
47 int is_staging_gitmodules_ok(const struct index_state *istate)
48 {
49         int pos = index_name_pos(istate, GITMODULES_FILE, strlen(GITMODULES_FILE));
50
51         if ((pos >= 0) && (pos < istate->cache_nr)) {
52                 struct stat st;
53                 if (lstat(GITMODULES_FILE, &st) == 0 &&
54                     ce_match_stat(istate->cache[pos], &st, 0) & DATA_CHANGED)
55                         return 0;
56         }
57
58         return 1;
59 }
60
61 /*
62  * Try to update the "path" entry in the "submodule.<name>" section of the
63  * .gitmodules file. Return 0 only if a .gitmodules file was found, a section
64  * with the correct path=<oldpath> setting was found and we could update it.
65  */
66 int update_path_in_gitmodules(const char *oldpath, const char *newpath)
67 {
68         struct strbuf entry = STRBUF_INIT;
69         const struct submodule *submodule;
70
71         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
72                 return -1;
73
74         if (gitmodules_is_unmerged)
75                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
76
77         submodule = submodule_from_path(null_sha1, oldpath);
78         if (!submodule || !submodule->name) {
79                 warning(_("Could not find section in .gitmodules where path=%s"), oldpath);
80                 return -1;
81         }
82         strbuf_addstr(&entry, "submodule.");
83         strbuf_addstr(&entry, submodule->name);
84         strbuf_addstr(&entry, ".path");
85         if (git_config_set_in_file_gently(GITMODULES_FILE, entry.buf, newpath) < 0) {
86                 /* Maybe the user already did that, don't error out here */
87                 warning(_("Could not update .gitmodules entry %s"), entry.buf);
88                 strbuf_release(&entry);
89                 return -1;
90         }
91         strbuf_release(&entry);
92         return 0;
93 }
94
95 /*
96  * Try to remove the "submodule.<name>" section from .gitmodules where the given
97  * path is configured. Return 0 only if a .gitmodules file was found, a section
98  * with the correct path=<path> setting was found and we could remove it.
99  */
100 int remove_path_from_gitmodules(const char *path)
101 {
102         struct strbuf sect = STRBUF_INIT;
103         const struct submodule *submodule;
104
105         if (!file_exists(GITMODULES_FILE)) /* Do nothing without .gitmodules */
106                 return -1;
107
108         if (gitmodules_is_unmerged)
109                 die(_("Cannot change unmerged .gitmodules, resolve merge conflicts first"));
110
111         submodule = submodule_from_path(null_sha1, path);
112         if (!submodule || !submodule->name) {
113                 warning(_("Could not find section in .gitmodules where path=%s"), path);
114                 return -1;
115         }
116         strbuf_addstr(&sect, "submodule.");
117         strbuf_addstr(&sect, submodule->name);
118         if (git_config_rename_section_in_file(GITMODULES_FILE, sect.buf, NULL) < 0) {
119                 /* Maybe the user already did that, don't error out here */
120                 warning(_("Could not remove .gitmodules entry for %s"), path);
121                 strbuf_release(&sect);
122                 return -1;
123         }
124         strbuf_release(&sect);
125         return 0;
126 }
127
128 void stage_updated_gitmodules(void)
129 {
130         if (add_file_to_cache(GITMODULES_FILE, 0))
131                 die(_("staging updated .gitmodules failed"));
132 }
133
134 static int add_submodule_odb(const char *path)
135 {
136         struct strbuf objects_directory = STRBUF_INIT;
137         int ret = 0;
138
139         ret = strbuf_git_path_submodule(&objects_directory, path, "objects/");
140         if (ret)
141                 goto done;
142         if (!is_directory(objects_directory.buf)) {
143                 ret = -1;
144                 goto done;
145         }
146         add_to_alternates_memory(objects_directory.buf);
147 done:
148         strbuf_release(&objects_directory);
149         return ret;
150 }
151
152 void set_diffopt_flags_from_submodule_config(struct diff_options *diffopt,
153                                              const char *path)
154 {
155         const struct submodule *submodule = submodule_from_path(null_sha1, path);
156         if (submodule) {
157                 if (submodule->ignore)
158                         handle_ignore_submodules_arg(diffopt, submodule->ignore);
159                 else if (gitmodules_is_unmerged)
160                         DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
161         }
162 }
163
164 /* For loading from the .gitmodules file. */
165 static int git_modules_config(const char *var, const char *value, void *cb)
166 {
167         if (starts_with(var, "submodule."))
168                 return parse_submodule_config_option(var, value);
169         return 0;
170 }
171
172 /* Loads all submodule settings from the config. */
173 int submodule_config(const char *var, const char *value, void *cb)
174 {
175         if (!strcmp(var, "submodule.recurse")) {
176                 int v = git_config_bool(var, value) ?
177                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
178                 config_update_recurse_submodules = v;
179                 return 0;
180         } else {
181                 return git_modules_config(var, value, cb);
182         }
183 }
184
185 /* Cheap function that only determines if we're interested in submodules at all */
186 int git_default_submodule_config(const char *var, const char *value, void *cb)
187 {
188         if (!strcmp(var, "submodule.recurse")) {
189                 int v = git_config_bool(var, value) ?
190                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
191                 config_update_recurse_submodules = v;
192         }
193         return 0;
194 }
195
196 int option_parse_recurse_submodules_worktree_updater(const struct option *opt,
197                                                      const char *arg, int unset)
198 {
199         if (unset) {
200                 config_update_recurse_submodules = RECURSE_SUBMODULES_OFF;
201                 return 0;
202         }
203         if (arg)
204                 config_update_recurse_submodules =
205                         parse_update_recurse_submodules_arg(opt->long_name,
206                                                             arg);
207         else
208                 config_update_recurse_submodules = RECURSE_SUBMODULES_ON;
209
210         return 0;
211 }
212
213 void load_submodule_cache(void)
214 {
215         if (config_update_recurse_submodules == RECURSE_SUBMODULES_OFF)
216                 return;
217
218         gitmodules_config();
219         git_config(submodule_config, NULL);
220 }
221
222 void gitmodules_config(void)
223 {
224         const char *work_tree = get_git_work_tree();
225         if (work_tree) {
226                 struct strbuf gitmodules_path = STRBUF_INIT;
227                 int pos;
228                 strbuf_addstr(&gitmodules_path, work_tree);
229                 strbuf_addstr(&gitmodules_path, "/" GITMODULES_FILE);
230                 if (read_cache() < 0)
231                         die("index file corrupt");
232                 pos = cache_name_pos(GITMODULES_FILE, 11);
233                 if (pos < 0) { /* .gitmodules not found or isn't merged */
234                         pos = -1 - pos;
235                         if (active_nr > pos) {  /* there is a .gitmodules */
236                                 const struct cache_entry *ce = active_cache[pos];
237                                 if (ce_namelen(ce) == 11 &&
238                                     !memcmp(ce->name, GITMODULES_FILE, 11))
239                                         gitmodules_is_unmerged = 1;
240                         }
241                 }
242
243                 if (!gitmodules_is_unmerged)
244                         git_config_from_file(git_modules_config,
245                                 gitmodules_path.buf, NULL);
246                 strbuf_release(&gitmodules_path);
247         }
248 }
249
250 static int gitmodules_cb(const char *var, const char *value, void *data)
251 {
252         struct repository *repo = data;
253         return submodule_config_option(repo, var, value);
254 }
255
256 void repo_read_gitmodules(struct repository *repo)
257 {
258         char *gitmodules_path = repo_worktree_path(repo, GITMODULES_FILE);
259
260         git_config_from_file(gitmodules_cb, gitmodules_path, repo);
261         free(gitmodules_path);
262 }
263
264 void gitmodules_config_sha1(const unsigned char *commit_sha1)
265 {
266         struct strbuf rev = STRBUF_INIT;
267         unsigned char sha1[20];
268
269         if (gitmodule_sha1_from_commit(commit_sha1, sha1, &rev)) {
270                 git_config_from_blob_sha1(git_modules_config, rev.buf,
271                                           sha1, NULL);
272         }
273         strbuf_release(&rev);
274 }
275
276 /*
277  * Determine if a submodule has been initialized at a given 'path'
278  */
279 int is_submodule_active(struct repository *repo, const char *path)
280 {
281         int ret = 0;
282         char *key = NULL;
283         char *value = NULL;
284         const struct string_list *sl;
285         const struct submodule *module;
286
287         module = submodule_from_cache(repo, null_sha1, path);
288
289         /* early return if there isn't a path->module mapping */
290         if (!module)
291                 return 0;
292
293         /* submodule.<name>.active is set */
294         key = xstrfmt("submodule.%s.active", module->name);
295         if (!repo_config_get_bool(repo, key, &ret)) {
296                 free(key);
297                 return ret;
298         }
299         free(key);
300
301         /* submodule.active is set */
302         sl = repo_config_get_value_multi(repo, "submodule.active");
303         if (sl) {
304                 struct pathspec ps;
305                 struct argv_array args = ARGV_ARRAY_INIT;
306                 const struct string_list_item *item;
307
308                 for_each_string_list_item(item, sl) {
309                         argv_array_push(&args, item->string);
310                 }
311
312                 parse_pathspec(&ps, 0, 0, NULL, args.argv);
313                 ret = match_pathspec(&ps, path, strlen(path), 0, NULL, 1);
314
315                 argv_array_clear(&args);
316                 clear_pathspec(&ps);
317                 return ret;
318         }
319
320         /* fallback to checking if the URL is set */
321         key = xstrfmt("submodule.%s.url", module->name);
322         ret = !repo_config_get_string(repo, key, &value);
323
324         free(value);
325         free(key);
326         return ret;
327 }
328
329 int is_submodule_populated_gently(const char *path, int *return_error_code)
330 {
331         int ret = 0;
332         char *gitdir = xstrfmt("%s/.git", path);
333
334         if (resolve_gitdir_gently(gitdir, return_error_code))
335                 ret = 1;
336
337         free(gitdir);
338         return ret;
339 }
340
341 /*
342  * Dies if the provided 'prefix' corresponds to an unpopulated submodule
343  */
344 void die_in_unpopulated_submodule(const struct index_state *istate,
345                                   const char *prefix)
346 {
347         int i, prefixlen;
348
349         if (!prefix)
350                 return;
351
352         prefixlen = strlen(prefix);
353
354         for (i = 0; i < istate->cache_nr; i++) {
355                 struct cache_entry *ce = istate->cache[i];
356                 int ce_len = ce_namelen(ce);
357
358                 if (!S_ISGITLINK(ce->ce_mode))
359                         continue;
360                 if (prefixlen <= ce_len)
361                         continue;
362                 if (strncmp(ce->name, prefix, ce_len))
363                         continue;
364                 if (prefix[ce_len] != '/')
365                         continue;
366
367                 die(_("in unpopulated submodule '%s'"), ce->name);
368         }
369 }
370
371 /*
372  * Dies if any paths in the provided pathspec descends into a submodule
373  */
374 void die_path_inside_submodule(const struct index_state *istate,
375                                const struct pathspec *ps)
376 {
377         int i, j;
378
379         for (i = 0; i < istate->cache_nr; i++) {
380                 struct cache_entry *ce = istate->cache[i];
381                 int ce_len = ce_namelen(ce);
382
383                 if (!S_ISGITLINK(ce->ce_mode))
384                         continue;
385
386                 for (j = 0; j < ps->nr ; j++) {
387                         const struct pathspec_item *item = &ps->items[j];
388
389                         if (item->len <= ce_len)
390                                 continue;
391                         if (item->match[ce_len] != '/')
392                                 continue;
393                         if (strncmp(ce->name, item->match, ce_len))
394                                 continue;
395                         if (item->len == ce_len + 1)
396                                 continue;
397
398                         die(_("Pathspec '%s' is in submodule '%.*s'"),
399                             item->original, ce_len, ce->name);
400                 }
401         }
402 }
403
404 int parse_submodule_update_strategy(const char *value,
405                 struct submodule_update_strategy *dst)
406 {
407         free((void*)dst->command);
408         dst->command = NULL;
409         if (!strcmp(value, "none"))
410                 dst->type = SM_UPDATE_NONE;
411         else if (!strcmp(value, "checkout"))
412                 dst->type = SM_UPDATE_CHECKOUT;
413         else if (!strcmp(value, "rebase"))
414                 dst->type = SM_UPDATE_REBASE;
415         else if (!strcmp(value, "merge"))
416                 dst->type = SM_UPDATE_MERGE;
417         else if (skip_prefix(value, "!", &value)) {
418                 dst->type = SM_UPDATE_COMMAND;
419                 dst->command = xstrdup(value);
420         } else
421                 return -1;
422         return 0;
423 }
424
425 const char *submodule_strategy_to_string(const struct submodule_update_strategy *s)
426 {
427         struct strbuf sb = STRBUF_INIT;
428         switch (s->type) {
429         case SM_UPDATE_CHECKOUT:
430                 return "checkout";
431         case SM_UPDATE_MERGE:
432                 return "merge";
433         case SM_UPDATE_REBASE:
434                 return "rebase";
435         case SM_UPDATE_NONE:
436                 return "none";
437         case SM_UPDATE_UNSPECIFIED:
438                 return NULL;
439         case SM_UPDATE_COMMAND:
440                 strbuf_addf(&sb, "!%s", s->command);
441                 return strbuf_detach(&sb, NULL);
442         }
443         return NULL;
444 }
445
446 void handle_ignore_submodules_arg(struct diff_options *diffopt,
447                                   const char *arg)
448 {
449         DIFF_OPT_CLR(diffopt, IGNORE_SUBMODULES);
450         DIFF_OPT_CLR(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
451         DIFF_OPT_CLR(diffopt, IGNORE_DIRTY_SUBMODULES);
452
453         if (!strcmp(arg, "all"))
454                 DIFF_OPT_SET(diffopt, IGNORE_SUBMODULES);
455         else if (!strcmp(arg, "untracked"))
456                 DIFF_OPT_SET(diffopt, IGNORE_UNTRACKED_IN_SUBMODULES);
457         else if (!strcmp(arg, "dirty"))
458                 DIFF_OPT_SET(diffopt, IGNORE_DIRTY_SUBMODULES);
459         else if (strcmp(arg, "none"))
460                 die("bad --ignore-submodules argument: %s", arg);
461 }
462
463 static int prepare_submodule_summary(struct rev_info *rev, const char *path,
464                 struct commit *left, struct commit *right,
465                 struct commit_list *merge_bases)
466 {
467         struct commit_list *list;
468
469         init_revisions(rev, NULL);
470         setup_revisions(0, NULL, rev, NULL);
471         rev->left_right = 1;
472         rev->first_parent_only = 1;
473         left->object.flags |= SYMMETRIC_LEFT;
474         add_pending_object(rev, &left->object, path);
475         add_pending_object(rev, &right->object, path);
476         for (list = merge_bases; list; list = list->next) {
477                 list->item->object.flags |= UNINTERESTING;
478                 add_pending_object(rev, &list->item->object,
479                         oid_to_hex(&list->item->object.oid));
480         }
481         return prepare_revision_walk(rev);
482 }
483
484 static void print_submodule_summary(struct rev_info *rev, FILE *f,
485                 const char *line_prefix,
486                 const char *del, const char *add, const char *reset)
487 {
488         static const char format[] = "  %m %s";
489         struct strbuf sb = STRBUF_INIT;
490         struct commit *commit;
491
492         while ((commit = get_revision(rev))) {
493                 struct pretty_print_context ctx = {0};
494                 ctx.date_mode = rev->date_mode;
495                 ctx.output_encoding = get_log_output_encoding();
496                 strbuf_setlen(&sb, 0);
497                 strbuf_addstr(&sb, line_prefix);
498                 if (commit->object.flags & SYMMETRIC_LEFT) {
499                         if (del)
500                                 strbuf_addstr(&sb, del);
501                 }
502                 else if (add)
503                         strbuf_addstr(&sb, add);
504                 format_commit_message(commit, format, &sb, &ctx);
505                 if (reset)
506                         strbuf_addstr(&sb, reset);
507                 strbuf_addch(&sb, '\n');
508                 fprintf(f, "%s", sb.buf);
509         }
510         strbuf_release(&sb);
511 }
512
513 static void prepare_submodule_repo_env_no_git_dir(struct argv_array *out)
514 {
515         const char * const *var;
516
517         for (var = local_repo_env; *var; var++) {
518                 if (strcmp(*var, CONFIG_DATA_ENVIRONMENT))
519                         argv_array_push(out, *var);
520         }
521 }
522
523 void prepare_submodule_repo_env(struct argv_array *out)
524 {
525         prepare_submodule_repo_env_no_git_dir(out);
526         argv_array_pushf(out, "%s=%s", GIT_DIR_ENVIRONMENT,
527                          DEFAULT_GIT_DIR_ENVIRONMENT);
528 }
529
530 /* Helper function to display the submodule header line prior to the full
531  * summary output. If it can locate the submodule objects directory it will
532  * attempt to lookup both the left and right commits and put them into the
533  * left and right pointers.
534  */
535 static void show_submodule_header(FILE *f, const char *path,
536                 const char *line_prefix,
537                 struct object_id *one, struct object_id *two,
538                 unsigned dirty_submodule, const char *meta,
539                 const char *reset,
540                 struct commit **left, struct commit **right,
541                 struct commit_list **merge_bases)
542 {
543         const char *message = NULL;
544         struct strbuf sb = STRBUF_INIT;
545         int fast_forward = 0, fast_backward = 0;
546
547         if (dirty_submodule & DIRTY_SUBMODULE_UNTRACKED)
548                 fprintf(f, "%sSubmodule %s contains untracked content\n",
549                         line_prefix, path);
550         if (dirty_submodule & DIRTY_SUBMODULE_MODIFIED)
551                 fprintf(f, "%sSubmodule %s contains modified content\n",
552                         line_prefix, path);
553
554         if (is_null_oid(one))
555                 message = "(new submodule)";
556         else if (is_null_oid(two))
557                 message = "(submodule deleted)";
558
559         if (add_submodule_odb(path)) {
560                 if (!message)
561                         message = "(not initialized)";
562                 goto output_header;
563         }
564
565         /*
566          * Attempt to lookup the commit references, and determine if this is
567          * a fast forward or fast backwards update.
568          */
569         *left = lookup_commit_reference(one);
570         *right = lookup_commit_reference(two);
571
572         /*
573          * Warn about missing commits in the submodule project, but only if
574          * they aren't null.
575          */
576         if ((!is_null_oid(one) && !*left) ||
577              (!is_null_oid(two) && !*right))
578                 message = "(commits not present)";
579
580         *merge_bases = get_merge_bases(*left, *right);
581         if (*merge_bases) {
582                 if ((*merge_bases)->item == *left)
583                         fast_forward = 1;
584                 else if ((*merge_bases)->item == *right)
585                         fast_backward = 1;
586         }
587
588         if (!oidcmp(one, two)) {
589                 strbuf_release(&sb);
590                 return;
591         }
592
593 output_header:
594         strbuf_addf(&sb, "%s%sSubmodule %s ", line_prefix, meta, path);
595         strbuf_add_unique_abbrev(&sb, one->hash, DEFAULT_ABBREV);
596         strbuf_addstr(&sb, (fast_backward || fast_forward) ? ".." : "...");
597         strbuf_add_unique_abbrev(&sb, two->hash, DEFAULT_ABBREV);
598         if (message)
599                 strbuf_addf(&sb, " %s%s\n", message, reset);
600         else
601                 strbuf_addf(&sb, "%s:%s\n", fast_backward ? " (rewind)" : "", reset);
602         fwrite(sb.buf, sb.len, 1, f);
603
604         strbuf_release(&sb);
605 }
606
607 void show_submodule_summary(FILE *f, const char *path,
608                 const char *line_prefix,
609                 struct object_id *one, struct object_id *two,
610                 unsigned dirty_submodule, const char *meta,
611                 const char *del, const char *add, const char *reset)
612 {
613         struct rev_info rev;
614         struct commit *left = NULL, *right = NULL;
615         struct commit_list *merge_bases = NULL;
616
617         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
618                               meta, reset, &left, &right, &merge_bases);
619
620         /*
621          * If we don't have both a left and a right pointer, there is no
622          * reason to try and display a summary. The header line should contain
623          * all the information the user needs.
624          */
625         if (!left || !right)
626                 goto out;
627
628         /* Treat revision walker failure the same as missing commits */
629         if (prepare_submodule_summary(&rev, path, left, right, merge_bases)) {
630                 fprintf(f, "%s(revision walker failed)\n", line_prefix);
631                 goto out;
632         }
633
634         print_submodule_summary(&rev, f, line_prefix, del, add, reset);
635
636 out:
637         if (merge_bases)
638                 free_commit_list(merge_bases);
639         clear_commit_marks(left, ~0);
640         clear_commit_marks(right, ~0);
641 }
642
643 void show_submodule_inline_diff(FILE *f, const char *path,
644                 const char *line_prefix,
645                 struct object_id *one, struct object_id *two,
646                 unsigned dirty_submodule, const char *meta,
647                 const char *del, const char *add, const char *reset,
648                 const struct diff_options *o)
649 {
650         const struct object_id *old = &empty_tree_oid, *new = &empty_tree_oid;
651         struct commit *left = NULL, *right = NULL;
652         struct commit_list *merge_bases = NULL;
653         struct strbuf submodule_dir = STRBUF_INIT;
654         struct child_process cp = CHILD_PROCESS_INIT;
655
656         show_submodule_header(f, path, line_prefix, one, two, dirty_submodule,
657                               meta, reset, &left, &right, &merge_bases);
658
659         /* We need a valid left and right commit to display a difference */
660         if (!(left || is_null_oid(one)) ||
661             !(right || is_null_oid(two)))
662                 goto done;
663
664         if (left)
665                 old = one;
666         if (right)
667                 new = two;
668
669         fflush(f);
670         cp.git_cmd = 1;
671         cp.dir = path;
672         cp.out = dup(fileno(f));
673         cp.no_stdin = 1;
674
675         /* TODO: other options may need to be passed here. */
676         argv_array_pushl(&cp.args, "diff", "--submodule=diff", NULL);
677
678         argv_array_pushf(&cp.args, "--line-prefix=%s", line_prefix);
679         if (DIFF_OPT_TST(o, REVERSE_DIFF)) {
680                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
681                                  o->b_prefix, path);
682                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
683                                  o->a_prefix, path);
684         } else {
685                 argv_array_pushf(&cp.args, "--src-prefix=%s%s/",
686                                  o->a_prefix, path);
687                 argv_array_pushf(&cp.args, "--dst-prefix=%s%s/",
688                                  o->b_prefix, path);
689         }
690         argv_array_push(&cp.args, oid_to_hex(old));
691         /*
692          * If the submodule has modified content, we will diff against the
693          * work tree, under the assumption that the user has asked for the
694          * diff format and wishes to actually see all differences even if they
695          * haven't yet been committed to the submodule yet.
696          */
697         if (!(dirty_submodule & DIRTY_SUBMODULE_MODIFIED))
698                 argv_array_push(&cp.args, oid_to_hex(new));
699
700         prepare_submodule_repo_env(&cp.env_array);
701         if (run_command(&cp))
702                 fprintf(f, "(diff failed)\n");
703
704 done:
705         strbuf_release(&submodule_dir);
706         if (merge_bases)
707                 free_commit_list(merge_bases);
708         if (left)
709                 clear_commit_marks(left, ~0);
710         if (right)
711                 clear_commit_marks(right, ~0);
712 }
713
714 int should_update_submodules(void)
715 {
716         return config_update_recurse_submodules == RECURSE_SUBMODULES_ON;
717 }
718
719 const struct submodule *submodule_from_ce(const struct cache_entry *ce)
720 {
721         if (!S_ISGITLINK(ce->ce_mode))
722                 return NULL;
723
724         if (!should_update_submodules())
725                 return NULL;
726
727         return submodule_from_path(null_sha1, ce->name);
728 }
729
730 static struct oid_array *submodule_commits(struct string_list *submodules,
731                                            const char *path)
732 {
733         struct string_list_item *item;
734
735         item = string_list_insert(submodules, path);
736         if (item->util)
737                 return (struct oid_array *) item->util;
738
739         /* NEEDSWORK: should we have oid_array_init()? */
740         item->util = xcalloc(1, sizeof(struct oid_array));
741         return (struct oid_array *) item->util;
742 }
743
744 static void collect_changed_submodules_cb(struct diff_queue_struct *q,
745                                           struct diff_options *options,
746                                           void *data)
747 {
748         int i;
749         struct string_list *changed = data;
750
751         for (i = 0; i < q->nr; i++) {
752                 struct diff_filepair *p = q->queue[i];
753                 struct oid_array *commits;
754                 if (!S_ISGITLINK(p->two->mode))
755                         continue;
756
757                 if (S_ISGITLINK(p->one->mode)) {
758                         /*
759                          * NEEDSWORK: We should honor the name configured in
760                          * the .gitmodules file of the commit we are examining
761                          * here to be able to correctly follow submodules
762                          * being moved around.
763                          */
764                         commits = submodule_commits(changed, p->two->path);
765                         oid_array_append(commits, &p->two->oid);
766                 } else {
767                         /* Submodule is new or was moved here */
768                         /*
769                          * NEEDSWORK: When the .git directories of submodules
770                          * live inside the superprojects .git directory some
771                          * day we should fetch new submodules directly into
772                          * that location too when config or options request
773                          * that so they can be checked out from there.
774                          */
775                         continue;
776                 }
777         }
778 }
779
780 /*
781  * Collect the paths of submodules in 'changed' which have changed based on
782  * the revisions as specified in 'argv'.  Each entry in 'changed' will also
783  * have a corresponding 'struct oid_array' (in the 'util' field) which lists
784  * what the submodule pointers were updated to during the change.
785  */
786 static void collect_changed_submodules(struct string_list *changed,
787                                        struct argv_array *argv)
788 {
789         struct rev_info rev;
790         const struct commit *commit;
791
792         init_revisions(&rev, NULL);
793         setup_revisions(argv->argc, argv->argv, &rev, NULL);
794         if (prepare_revision_walk(&rev))
795                 die("revision walk setup failed");
796
797         while ((commit = get_revision(&rev))) {
798                 struct rev_info diff_rev;
799
800                 init_revisions(&diff_rev, NULL);
801                 diff_rev.diffopt.output_format |= DIFF_FORMAT_CALLBACK;
802                 diff_rev.diffopt.format_callback = collect_changed_submodules_cb;
803                 diff_rev.diffopt.format_callback_data = changed;
804                 diff_tree_combined_merge(commit, 1, &diff_rev);
805         }
806
807         reset_revision_walk();
808 }
809
810 static void free_submodules_oids(struct string_list *submodules)
811 {
812         struct string_list_item *item;
813         for_each_string_list_item(item, submodules)
814                 oid_array_clear((struct oid_array *) item->util);
815         string_list_clear(submodules, 1);
816 }
817
818 static int has_remote(const char *refname, const struct object_id *oid,
819                       int flags, void *cb_data)
820 {
821         return 1;
822 }
823
824 static int append_oid_to_argv(const struct object_id *oid, void *data)
825 {
826         struct argv_array *argv = data;
827         argv_array_push(argv, oid_to_hex(oid));
828         return 0;
829 }
830
831 static int check_has_commit(const struct object_id *oid, void *data)
832 {
833         int *has_commit = data;
834
835         if (!lookup_commit_reference(oid))
836                 *has_commit = 0;
837
838         return 0;
839 }
840
841 static int submodule_has_commits(const char *path, struct oid_array *commits)
842 {
843         int has_commit = 1;
844
845         /*
846          * Perform a cheap, but incorrect check for the existence of 'commits'.
847          * This is done by adding the submodule's object store to the in-core
848          * object store, and then querying for each commit's existence.  If we
849          * do not have the commit object anywhere, there is no chance we have
850          * it in the object store of the correct submodule and have it
851          * reachable from a ref, so we can fail early without spawning rev-list
852          * which is expensive.
853          */
854         if (add_submodule_odb(path))
855                 return 0;
856
857         oid_array_for_each_unique(commits, check_has_commit, &has_commit);
858
859         if (has_commit) {
860                 /*
861                  * Even if the submodule is checked out and the commit is
862                  * present, make sure it exists in the submodule's object store
863                  * and that it is reachable from a ref.
864                  */
865                 struct child_process cp = CHILD_PROCESS_INIT;
866                 struct strbuf out = STRBUF_INIT;
867
868                 argv_array_pushl(&cp.args, "rev-list", "-n", "1", NULL);
869                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
870                 argv_array_pushl(&cp.args, "--not", "--all", NULL);
871
872                 prepare_submodule_repo_env(&cp.env_array);
873                 cp.git_cmd = 1;
874                 cp.no_stdin = 1;
875                 cp.dir = path;
876
877                 if (capture_command(&cp, &out, GIT_MAX_HEXSZ + 1) || out.len)
878                         has_commit = 0;
879
880                 strbuf_release(&out);
881         }
882
883         return has_commit;
884 }
885
886 static int submodule_needs_pushing(const char *path, struct oid_array *commits)
887 {
888         if (!submodule_has_commits(path, commits))
889                 /*
890                  * NOTE: We do consider it safe to return "no" here. The
891                  * correct answer would be "We do not know" instead of
892                  * "No push needed", but it is quite hard to change
893                  * the submodule pointer without having the submodule
894                  * around. If a user did however change the submodules
895                  * without having the submodule around, this indicates
896                  * an expert who knows what they are doing or a
897                  * maintainer integrating work from other people. In
898                  * both cases it should be safe to skip this check.
899                  */
900                 return 0;
901
902         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
903                 struct child_process cp = CHILD_PROCESS_INIT;
904                 struct strbuf buf = STRBUF_INIT;
905                 int needs_pushing = 0;
906
907                 argv_array_push(&cp.args, "rev-list");
908                 oid_array_for_each_unique(commits, append_oid_to_argv, &cp.args);
909                 argv_array_pushl(&cp.args, "--not", "--remotes", "-n", "1" , NULL);
910
911                 prepare_submodule_repo_env(&cp.env_array);
912                 cp.git_cmd = 1;
913                 cp.no_stdin = 1;
914                 cp.out = -1;
915                 cp.dir = path;
916                 if (start_command(&cp))
917                         die("Could not run 'git rev-list <commits> --not --remotes -n 1' command in submodule %s",
918                                         path);
919                 if (strbuf_read(&buf, cp.out, 41))
920                         needs_pushing = 1;
921                 finish_command(&cp);
922                 close(cp.out);
923                 strbuf_release(&buf);
924                 return needs_pushing;
925         }
926
927         return 0;
928 }
929
930 int find_unpushed_submodules(struct oid_array *commits,
931                 const char *remotes_name, struct string_list *needs_pushing)
932 {
933         struct string_list submodules = STRING_LIST_INIT_DUP;
934         struct string_list_item *submodule;
935         struct argv_array argv = ARGV_ARRAY_INIT;
936
937         /* argv.argv[0] will be ignored by setup_revisions */
938         argv_array_push(&argv, "find_unpushed_submodules");
939         oid_array_for_each_unique(commits, append_oid_to_argv, &argv);
940         argv_array_push(&argv, "--not");
941         argv_array_pushf(&argv, "--remotes=%s", remotes_name);
942
943         collect_changed_submodules(&submodules, &argv);
944
945         for_each_string_list_item(submodule, &submodules) {
946                 struct oid_array *commits = submodule->util;
947                 const char *path = submodule->string;
948
949                 if (submodule_needs_pushing(path, commits))
950                         string_list_insert(needs_pushing, path);
951         }
952
953         free_submodules_oids(&submodules);
954         argv_array_clear(&argv);
955
956         return needs_pushing->nr;
957 }
958
959 static int push_submodule(const char *path,
960                           const struct remote *remote,
961                           const char **refspec, int refspec_nr,
962                           const struct string_list *push_options,
963                           int dry_run)
964 {
965         if (add_submodule_odb(path))
966                 return 1;
967
968         if (for_each_remote_ref_submodule(path, has_remote, NULL) > 0) {
969                 struct child_process cp = CHILD_PROCESS_INIT;
970                 argv_array_push(&cp.args, "push");
971                 if (dry_run)
972                         argv_array_push(&cp.args, "--dry-run");
973
974                 if (push_options && push_options->nr) {
975                         const struct string_list_item *item;
976                         for_each_string_list_item(item, push_options)
977                                 argv_array_pushf(&cp.args, "--push-option=%s",
978                                                  item->string);
979                 }
980
981                 if (remote->origin != REMOTE_UNCONFIGURED) {
982                         int i;
983                         argv_array_push(&cp.args, remote->name);
984                         for (i = 0; i < refspec_nr; i++)
985                                 argv_array_push(&cp.args, refspec[i]);
986                 }
987
988                 prepare_submodule_repo_env(&cp.env_array);
989                 cp.git_cmd = 1;
990                 cp.no_stdin = 1;
991                 cp.dir = path;
992                 if (run_command(&cp))
993                         return 0;
994                 close(cp.out);
995         }
996
997         return 1;
998 }
999
1000 /*
1001  * Perform a check in the submodule to see if the remote and refspec work.
1002  * Die if the submodule can't be pushed.
1003  */
1004 static void submodule_push_check(const char *path, const struct remote *remote,
1005                                  const char **refspec, int refspec_nr)
1006 {
1007         struct child_process cp = CHILD_PROCESS_INIT;
1008         int i;
1009
1010         argv_array_push(&cp.args, "submodule--helper");
1011         argv_array_push(&cp.args, "push-check");
1012         argv_array_push(&cp.args, remote->name);
1013
1014         for (i = 0; i < refspec_nr; i++)
1015                 argv_array_push(&cp.args, refspec[i]);
1016
1017         prepare_submodule_repo_env(&cp.env_array);
1018         cp.git_cmd = 1;
1019         cp.no_stdin = 1;
1020         cp.no_stdout = 1;
1021         cp.dir = path;
1022
1023         /*
1024          * Simply indicate if 'submodule--helper push-check' failed.
1025          * More detailed error information will be provided by the
1026          * child process.
1027          */
1028         if (run_command(&cp))
1029                 die("process for submodule '%s' failed", path);
1030 }
1031
1032 int push_unpushed_submodules(struct oid_array *commits,
1033                              const struct remote *remote,
1034                              const char **refspec, int refspec_nr,
1035                              const struct string_list *push_options,
1036                              int dry_run)
1037 {
1038         int i, ret = 1;
1039         struct string_list needs_pushing = STRING_LIST_INIT_DUP;
1040
1041         if (!find_unpushed_submodules(commits, remote->name, &needs_pushing))
1042                 return 1;
1043
1044         /*
1045          * Verify that the remote and refspec can be propagated to all
1046          * submodules.  This check can be skipped if the remote and refspec
1047          * won't be propagated due to the remote being unconfigured (e.g. a URL
1048          * instead of a remote name).
1049          */
1050         if (remote->origin != REMOTE_UNCONFIGURED)
1051                 for (i = 0; i < needs_pushing.nr; i++)
1052                         submodule_push_check(needs_pushing.items[i].string,
1053                                              remote, refspec, refspec_nr);
1054
1055         /* Actually push the submodules */
1056         for (i = 0; i < needs_pushing.nr; i++) {
1057                 const char *path = needs_pushing.items[i].string;
1058                 fprintf(stderr, "Pushing submodule '%s'\n", path);
1059                 if (!push_submodule(path, remote, refspec, refspec_nr,
1060                                     push_options, dry_run)) {
1061                         fprintf(stderr, "Unable to push submodule '%s'\n", path);
1062                         ret = 0;
1063                 }
1064         }
1065
1066         string_list_clear(&needs_pushing, 0);
1067
1068         return ret;
1069 }
1070
1071 static int append_oid_to_array(const char *ref, const struct object_id *oid,
1072                                int flags, void *data)
1073 {
1074         struct oid_array *array = data;
1075         oid_array_append(array, oid);
1076         return 0;
1077 }
1078
1079 void check_for_new_submodule_commits(struct object_id *oid)
1080 {
1081         if (!initialized_fetch_ref_tips) {
1082                 for_each_ref(append_oid_to_array, &ref_tips_before_fetch);
1083                 initialized_fetch_ref_tips = 1;
1084         }
1085
1086         oid_array_append(&ref_tips_after_fetch, oid);
1087 }
1088
1089 static void calculate_changed_submodule_paths(void)
1090 {
1091         struct argv_array argv = ARGV_ARRAY_INIT;
1092         struct string_list changed_submodules = STRING_LIST_INIT_DUP;
1093         const struct string_list_item *item;
1094
1095         /* No need to check if there are no submodules configured */
1096         if (!submodule_from_path(NULL, NULL))
1097                 return;
1098
1099         argv_array_push(&argv, "--"); /* argv[0] program name */
1100         oid_array_for_each_unique(&ref_tips_after_fetch,
1101                                    append_oid_to_argv, &argv);
1102         argv_array_push(&argv, "--not");
1103         oid_array_for_each_unique(&ref_tips_before_fetch,
1104                                    append_oid_to_argv, &argv);
1105
1106         /*
1107          * Collect all submodules (whether checked out or not) for which new
1108          * commits have been recorded upstream in "changed_submodule_paths".
1109          */
1110         collect_changed_submodules(&changed_submodules, &argv);
1111
1112         for_each_string_list_item(item, &changed_submodules) {
1113                 struct oid_array *commits = item->util;
1114                 const char *path = item->string;
1115
1116                 if (!submodule_has_commits(path, commits))
1117                         string_list_append(&changed_submodule_paths, path);
1118         }
1119
1120         free_submodules_oids(&changed_submodules);
1121         argv_array_clear(&argv);
1122         oid_array_clear(&ref_tips_before_fetch);
1123         oid_array_clear(&ref_tips_after_fetch);
1124         initialized_fetch_ref_tips = 0;
1125 }
1126
1127 int submodule_touches_in_range(struct object_id *excl_oid,
1128                                struct object_id *incl_oid)
1129 {
1130         struct string_list subs = STRING_LIST_INIT_DUP;
1131         struct argv_array args = ARGV_ARRAY_INIT;
1132         int ret;
1133
1134         gitmodules_config();
1135         /* No need to check if there are no submodules configured */
1136         if (!submodule_from_path(NULL, NULL))
1137                 return 0;
1138
1139         argv_array_push(&args, "--"); /* args[0] program name */
1140         argv_array_push(&args, oid_to_hex(incl_oid));
1141         argv_array_push(&args, "--not");
1142         argv_array_push(&args, oid_to_hex(excl_oid));
1143
1144         collect_changed_submodules(&subs, &args);
1145         ret = subs.nr;
1146
1147         argv_array_clear(&args);
1148
1149         free_submodules_oids(&subs);
1150         return ret;
1151 }
1152
1153 struct submodule_parallel_fetch {
1154         int count;
1155         struct argv_array args;
1156         const char *work_tree;
1157         const char *prefix;
1158         int command_line_option;
1159         int default_option;
1160         int quiet;
1161         int result;
1162 };
1163 #define SPF_INIT {0, ARGV_ARRAY_INIT, NULL, NULL, 0, 0, 0, 0}
1164
1165 static int get_next_submodule(struct child_process *cp,
1166                               struct strbuf *err, void *data, void **task_cb)
1167 {
1168         int ret = 0;
1169         struct submodule_parallel_fetch *spf = data;
1170
1171         for (; spf->count < active_nr; spf->count++) {
1172                 struct strbuf submodule_path = STRBUF_INIT;
1173                 struct strbuf submodule_git_dir = STRBUF_INIT;
1174                 struct strbuf submodule_prefix = STRBUF_INIT;
1175                 const struct cache_entry *ce = active_cache[spf->count];
1176                 const char *git_dir, *default_argv;
1177                 const struct submodule *submodule;
1178
1179                 if (!S_ISGITLINK(ce->ce_mode))
1180                         continue;
1181
1182                 submodule = submodule_from_path(null_sha1, ce->name);
1183                 if (!submodule)
1184                         submodule = submodule_from_name(null_sha1, ce->name);
1185
1186                 default_argv = "yes";
1187                 if (spf->command_line_option == RECURSE_SUBMODULES_DEFAULT) {
1188                         if (submodule &&
1189                             submodule->fetch_recurse !=
1190                                                 RECURSE_SUBMODULES_NONE) {
1191                                 if (submodule->fetch_recurse ==
1192                                                 RECURSE_SUBMODULES_OFF)
1193                                         continue;
1194                                 if (submodule->fetch_recurse ==
1195                                                 RECURSE_SUBMODULES_ON_DEMAND) {
1196                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1197                                                 continue;
1198                                         default_argv = "on-demand";
1199                                 }
1200                         } else {
1201                                 if ((spf->default_option == RECURSE_SUBMODULES_OFF) ||
1202                                     gitmodules_is_unmerged)
1203                                         continue;
1204                                 if (spf->default_option == RECURSE_SUBMODULES_ON_DEMAND) {
1205                                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1206                                                 continue;
1207                                         default_argv = "on-demand";
1208                                 }
1209                         }
1210                 } else if (spf->command_line_option == RECURSE_SUBMODULES_ON_DEMAND) {
1211                         if (!unsorted_string_list_lookup(&changed_submodule_paths, ce->name))
1212                                 continue;
1213                         default_argv = "on-demand";
1214                 }
1215
1216                 strbuf_addf(&submodule_path, "%s/%s", spf->work_tree, ce->name);
1217                 strbuf_addf(&submodule_git_dir, "%s/.git", submodule_path.buf);
1218                 strbuf_addf(&submodule_prefix, "%s%s/", spf->prefix, ce->name);
1219                 git_dir = read_gitfile(submodule_git_dir.buf);
1220                 if (!git_dir)
1221                         git_dir = submodule_git_dir.buf;
1222                 if (is_directory(git_dir)) {
1223                         child_process_init(cp);
1224                         cp->dir = strbuf_detach(&submodule_path, NULL);
1225                         prepare_submodule_repo_env(&cp->env_array);
1226                         cp->git_cmd = 1;
1227                         if (!spf->quiet)
1228                                 strbuf_addf(err, "Fetching submodule %s%s\n",
1229                                             spf->prefix, ce->name);
1230                         argv_array_init(&cp->args);
1231                         argv_array_pushv(&cp->args, spf->args.argv);
1232                         argv_array_push(&cp->args, default_argv);
1233                         argv_array_push(&cp->args, "--submodule-prefix");
1234                         argv_array_push(&cp->args, submodule_prefix.buf);
1235                         ret = 1;
1236                 }
1237                 strbuf_release(&submodule_path);
1238                 strbuf_release(&submodule_git_dir);
1239                 strbuf_release(&submodule_prefix);
1240                 if (ret) {
1241                         spf->count++;
1242                         return 1;
1243                 }
1244         }
1245         return 0;
1246 }
1247
1248 static int fetch_start_failure(struct strbuf *err,
1249                                void *cb, void *task_cb)
1250 {
1251         struct submodule_parallel_fetch *spf = cb;
1252
1253         spf->result = 1;
1254
1255         return 0;
1256 }
1257
1258 static int fetch_finish(int retvalue, struct strbuf *err,
1259                         void *cb, void *task_cb)
1260 {
1261         struct submodule_parallel_fetch *spf = cb;
1262
1263         if (retvalue)
1264                 spf->result = 1;
1265
1266         return 0;
1267 }
1268
1269 int fetch_populated_submodules(const struct argv_array *options,
1270                                const char *prefix, int command_line_option,
1271                                int default_option,
1272                                int quiet, int max_parallel_jobs)
1273 {
1274         int i;
1275         struct submodule_parallel_fetch spf = SPF_INIT;
1276
1277         spf.work_tree = get_git_work_tree();
1278         spf.command_line_option = command_line_option;
1279         spf.default_option = default_option;
1280         spf.quiet = quiet;
1281         spf.prefix = prefix;
1282
1283         if (!spf.work_tree)
1284                 goto out;
1285
1286         if (read_cache() < 0)
1287                 die("index file corrupt");
1288
1289         argv_array_push(&spf.args, "fetch");
1290         for (i = 0; i < options->argc; i++)
1291                 argv_array_push(&spf.args, options->argv[i]);
1292         argv_array_push(&spf.args, "--recurse-submodules-default");
1293         /* default value, "--submodule-prefix" and its value are added later */
1294
1295         calculate_changed_submodule_paths();
1296         run_processes_parallel(max_parallel_jobs,
1297                                get_next_submodule,
1298                                fetch_start_failure,
1299                                fetch_finish,
1300                                &spf);
1301
1302         argv_array_clear(&spf.args);
1303 out:
1304         string_list_clear(&changed_submodule_paths, 1);
1305         return spf.result;
1306 }
1307
1308 unsigned is_submodule_modified(const char *path, int ignore_untracked)
1309 {
1310         struct child_process cp = CHILD_PROCESS_INIT;
1311         struct strbuf buf = STRBUF_INIT;
1312         FILE *fp;
1313         unsigned dirty_submodule = 0;
1314         const char *git_dir;
1315         int ignore_cp_exit_code = 0;
1316
1317         strbuf_addf(&buf, "%s/.git", path);
1318         git_dir = read_gitfile(buf.buf);
1319         if (!git_dir)
1320                 git_dir = buf.buf;
1321         if (!is_git_directory(git_dir)) {
1322                 if (is_directory(git_dir))
1323                         die(_("'%s' not recognized as a git repository"), git_dir);
1324                 strbuf_release(&buf);
1325                 /* The submodule is not checked out, so it is not modified */
1326                 return 0;
1327         }
1328         strbuf_reset(&buf);
1329
1330         argv_array_pushl(&cp.args, "status", "--porcelain=2", NULL);
1331         if (ignore_untracked)
1332                 argv_array_push(&cp.args, "-uno");
1333
1334         prepare_submodule_repo_env(&cp.env_array);
1335         cp.git_cmd = 1;
1336         cp.no_stdin = 1;
1337         cp.out = -1;
1338         cp.dir = path;
1339         if (start_command(&cp))
1340                 die("Could not run 'git status --porcelain=2' in submodule %s", path);
1341
1342         fp = xfdopen(cp.out, "r");
1343         while (strbuf_getwholeline(&buf, fp, '\n') != EOF) {
1344                 /* regular untracked files */
1345                 if (buf.buf[0] == '?')
1346                         dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1347
1348                 if (buf.buf[0] == 'u' ||
1349                     buf.buf[0] == '1' ||
1350                     buf.buf[0] == '2') {
1351                         /* T = line type, XY = status, SSSS = submodule state */
1352                         if (buf.len < strlen("T XY SSSS"))
1353                                 die("BUG: invalid status --porcelain=2 line %s",
1354                                     buf.buf);
1355
1356                         if (buf.buf[5] == 'S' && buf.buf[8] == 'U')
1357                                 /* nested untracked file */
1358                                 dirty_submodule |= DIRTY_SUBMODULE_UNTRACKED;
1359
1360                         if (buf.buf[0] == 'u' ||
1361                             buf.buf[0] == '2' ||
1362                             memcmp(buf.buf + 5, "S..U", 4))
1363                                 /* other change */
1364                                 dirty_submodule |= DIRTY_SUBMODULE_MODIFIED;
1365                 }
1366
1367                 if ((dirty_submodule & DIRTY_SUBMODULE_MODIFIED) &&
1368                     ((dirty_submodule & DIRTY_SUBMODULE_UNTRACKED) ||
1369                      ignore_untracked)) {
1370                         /*
1371                          * We're not interested in any further information from
1372                          * the child any more, neither output nor its exit code.
1373                          */
1374                         ignore_cp_exit_code = 1;
1375                         break;
1376                 }
1377         }
1378         fclose(fp);
1379
1380         if (finish_command(&cp) && !ignore_cp_exit_code)
1381                 die("'git status --porcelain=2' failed in submodule %s", path);
1382
1383         strbuf_release(&buf);
1384         return dirty_submodule;
1385 }
1386
1387 int submodule_uses_gitfile(const char *path)
1388 {
1389         struct child_process cp = CHILD_PROCESS_INIT;
1390         const char *argv[] = {
1391                 "submodule",
1392                 "foreach",
1393                 "--quiet",
1394                 "--recursive",
1395                 "test -f .git",
1396                 NULL,
1397         };
1398         struct strbuf buf = STRBUF_INIT;
1399         const char *git_dir;
1400
1401         strbuf_addf(&buf, "%s/.git", path);
1402         git_dir = read_gitfile(buf.buf);
1403         if (!git_dir) {
1404                 strbuf_release(&buf);
1405                 return 0;
1406         }
1407         strbuf_release(&buf);
1408
1409         /* Now test that all nested submodules use a gitfile too */
1410         cp.argv = argv;
1411         prepare_submodule_repo_env(&cp.env_array);
1412         cp.git_cmd = 1;
1413         cp.no_stdin = 1;
1414         cp.no_stderr = 1;
1415         cp.no_stdout = 1;
1416         cp.dir = path;
1417         if (run_command(&cp))
1418                 return 0;
1419
1420         return 1;
1421 }
1422
1423 /*
1424  * Check if it is a bad idea to remove a submodule, i.e. if we'd lose data
1425  * when doing so.
1426  *
1427  * Return 1 if we'd lose data, return 0 if the removal is fine,
1428  * and negative values for errors.
1429  */
1430 int bad_to_remove_submodule(const char *path, unsigned flags)
1431 {
1432         ssize_t len;
1433         struct child_process cp = CHILD_PROCESS_INIT;
1434         struct strbuf buf = STRBUF_INIT;
1435         int ret = 0;
1436
1437         if (!file_exists(path) || is_empty_dir(path))
1438                 return 0;
1439
1440         if (!submodule_uses_gitfile(path))
1441                 return 1;
1442
1443         argv_array_pushl(&cp.args, "status", "--porcelain",
1444                                    "--ignore-submodules=none", NULL);
1445
1446         if (flags & SUBMODULE_REMOVAL_IGNORE_UNTRACKED)
1447                 argv_array_push(&cp.args, "-uno");
1448         else
1449                 argv_array_push(&cp.args, "-uall");
1450
1451         if (!(flags & SUBMODULE_REMOVAL_IGNORE_IGNORED_UNTRACKED))
1452                 argv_array_push(&cp.args, "--ignored");
1453
1454         prepare_submodule_repo_env(&cp.env_array);
1455         cp.git_cmd = 1;
1456         cp.no_stdin = 1;
1457         cp.out = -1;
1458         cp.dir = path;
1459         if (start_command(&cp)) {
1460                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1461                         die(_("could not start 'git status' in submodule '%s'"),
1462                                 path);
1463                 ret = -1;
1464                 goto out;
1465         }
1466
1467         len = strbuf_read(&buf, cp.out, 1024);
1468         if (len > 2)
1469                 ret = 1;
1470         close(cp.out);
1471
1472         if (finish_command(&cp)) {
1473                 if (flags & SUBMODULE_REMOVAL_DIE_ON_ERROR)
1474                         die(_("could not run 'git status' in submodule '%s'"),
1475                                 path);
1476                 ret = -1;
1477         }
1478 out:
1479         strbuf_release(&buf);
1480         return ret;
1481 }
1482
1483 static const char *get_super_prefix_or_empty(void)
1484 {
1485         const char *s = get_super_prefix();
1486         if (!s)
1487                 s = "";
1488         return s;
1489 }
1490
1491 static int submodule_has_dirty_index(const struct submodule *sub)
1492 {
1493         struct child_process cp = CHILD_PROCESS_INIT;
1494
1495         prepare_submodule_repo_env(&cp.env_array);
1496
1497         cp.git_cmd = 1;
1498         argv_array_pushl(&cp.args, "diff-index", "--quiet",
1499                                    "--cached", "HEAD", NULL);
1500         cp.no_stdin = 1;
1501         cp.no_stdout = 1;
1502         cp.dir = sub->path;
1503         if (start_command(&cp))
1504                 die("could not recurse into submodule '%s'", sub->path);
1505
1506         return finish_command(&cp);
1507 }
1508
1509 static void submodule_reset_index(const char *path)
1510 {
1511         struct child_process cp = CHILD_PROCESS_INIT;
1512         prepare_submodule_repo_env(&cp.env_array);
1513
1514         cp.git_cmd = 1;
1515         cp.no_stdin = 1;
1516         cp.dir = path;
1517
1518         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1519                                    get_super_prefix_or_empty(), path);
1520         argv_array_pushl(&cp.args, "read-tree", "-u", "--reset", NULL);
1521
1522         argv_array_push(&cp.args, EMPTY_TREE_SHA1_HEX);
1523
1524         if (run_command(&cp))
1525                 die("could not reset submodule index");
1526 }
1527
1528 /**
1529  * Moves a submodule at a given path from a given head to another new head.
1530  * For edge cases (a submodule coming into existence or removing a submodule)
1531  * pass NULL for old or new respectively.
1532  */
1533 int submodule_move_head(const char *path,
1534                          const char *old,
1535                          const char *new,
1536                          unsigned flags)
1537 {
1538         int ret = 0;
1539         struct child_process cp = CHILD_PROCESS_INIT;
1540         const struct submodule *sub;
1541         int *error_code_ptr, error_code;
1542
1543         if (!is_submodule_active(the_repository, path))
1544                 return 0;
1545
1546         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1547                 /*
1548                  * Pass non NULL pointer to is_submodule_populated_gently
1549                  * to prevent die()-ing. We'll use connect_work_tree_and_git_dir
1550                  * to fixup the submodule in the force case later.
1551                  */
1552                 error_code_ptr = &error_code;
1553         else
1554                 error_code_ptr = NULL;
1555
1556         if (old && !is_submodule_populated_gently(path, error_code_ptr))
1557                 return 0;
1558
1559         sub = submodule_from_path(null_sha1, path);
1560
1561         if (!sub)
1562                 die("BUG: could not get submodule information for '%s'", path);
1563
1564         if (old && !(flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1565                 /* Check if the submodule has a dirty index. */
1566                 if (submodule_has_dirty_index(sub))
1567                         return error(_("submodule '%s' has dirty index"), path);
1568         }
1569
1570         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1571                 if (old) {
1572                         if (!submodule_uses_gitfile(path))
1573                                 absorb_git_dir_into_superproject("", path,
1574                                         ABSORB_GITDIR_RECURSE_SUBMODULES);
1575                 } else {
1576                         char *gitdir = xstrfmt("%s/modules/%s",
1577                                     get_git_common_dir(), sub->name);
1578                         connect_work_tree_and_git_dir(path, gitdir);
1579                         free(gitdir);
1580
1581                         /* make sure the index is clean as well */
1582                         submodule_reset_index(path);
1583                 }
1584
1585                 if (old && (flags & SUBMODULE_MOVE_HEAD_FORCE)) {
1586                         char *gitdir = xstrfmt("%s/modules/%s",
1587                                     get_git_common_dir(), sub->name);
1588                         connect_work_tree_and_git_dir(path, gitdir);
1589                         free(gitdir);
1590                 }
1591         }
1592
1593         prepare_submodule_repo_env(&cp.env_array);
1594
1595         cp.git_cmd = 1;
1596         cp.no_stdin = 1;
1597         cp.dir = path;
1598
1599         argv_array_pushf(&cp.args, "--super-prefix=%s%s/",
1600                         get_super_prefix_or_empty(), path);
1601         argv_array_pushl(&cp.args, "read-tree", "--recurse-submodules", NULL);
1602
1603         if (flags & SUBMODULE_MOVE_HEAD_DRY_RUN)
1604                 argv_array_push(&cp.args, "-n");
1605         else
1606                 argv_array_push(&cp.args, "-u");
1607
1608         if (flags & SUBMODULE_MOVE_HEAD_FORCE)
1609                 argv_array_push(&cp.args, "--reset");
1610         else
1611                 argv_array_push(&cp.args, "-m");
1612
1613         argv_array_push(&cp.args, old ? old : EMPTY_TREE_SHA1_HEX);
1614         argv_array_push(&cp.args, new ? new : EMPTY_TREE_SHA1_HEX);
1615
1616         if (run_command(&cp)) {
1617                 ret = -1;
1618                 goto out;
1619         }
1620
1621         if (!(flags & SUBMODULE_MOVE_HEAD_DRY_RUN)) {
1622                 if (new) {
1623                         child_process_init(&cp);
1624                         /* also set the HEAD accordingly */
1625                         cp.git_cmd = 1;
1626                         cp.no_stdin = 1;
1627                         cp.dir = path;
1628
1629                         prepare_submodule_repo_env(&cp.env_array);
1630                         argv_array_pushl(&cp.args, "update-ref", "HEAD", new, NULL);
1631
1632                         if (run_command(&cp)) {
1633                                 ret = -1;
1634                                 goto out;
1635                         }
1636                 } else {
1637                         struct strbuf sb = STRBUF_INIT;
1638
1639                         strbuf_addf(&sb, "%s/.git", path);
1640                         unlink_or_warn(sb.buf);
1641                         strbuf_release(&sb);
1642
1643                         if (is_empty_dir(path))
1644                                 rmdir_or_warn(path);
1645                 }
1646         }
1647 out:
1648         return ret;
1649 }
1650
1651 static int find_first_merges(struct object_array *result, const char *path,
1652                 struct commit *a, struct commit *b)
1653 {
1654         int i, j;
1655         struct object_array merges = OBJECT_ARRAY_INIT;
1656         struct commit *commit;
1657         int contains_another;
1658
1659         char merged_revision[42];
1660         const char *rev_args[] = { "rev-list", "--merges", "--ancestry-path",
1661                                    "--all", merged_revision, NULL };
1662         struct rev_info revs;
1663         struct setup_revision_opt rev_opts;
1664
1665         memset(result, 0, sizeof(struct object_array));
1666         memset(&rev_opts, 0, sizeof(rev_opts));
1667
1668         /* get all revisions that merge commit a */
1669         xsnprintf(merged_revision, sizeof(merged_revision), "^%s",
1670                         oid_to_hex(&a->object.oid));
1671         init_revisions(&revs, NULL);
1672         rev_opts.submodule = path;
1673         setup_revisions(ARRAY_SIZE(rev_args)-1, rev_args, &revs, &rev_opts);
1674
1675         /* save all revisions from the above list that contain b */
1676         if (prepare_revision_walk(&revs))
1677                 die("revision walk setup failed");
1678         while ((commit = get_revision(&revs)) != NULL) {
1679                 struct object *o = &(commit->object);
1680                 if (in_merge_bases(b, commit))
1681                         add_object_array(o, NULL, &merges);
1682         }
1683         reset_revision_walk();
1684
1685         /* Now we've got all merges that contain a and b. Prune all
1686          * merges that contain another found merge and save them in
1687          * result.
1688          */
1689         for (i = 0; i < merges.nr; i++) {
1690                 struct commit *m1 = (struct commit *) merges.objects[i].item;
1691
1692                 contains_another = 0;
1693                 for (j = 0; j < merges.nr; j++) {
1694                         struct commit *m2 = (struct commit *) merges.objects[j].item;
1695                         if (i != j && in_merge_bases(m2, m1)) {
1696                                 contains_another = 1;
1697                                 break;
1698                         }
1699                 }
1700
1701                 if (!contains_another)
1702                         add_object_array(merges.objects[i].item, NULL, result);
1703         }
1704
1705         free(merges.objects);
1706         return result->nr;
1707 }
1708
1709 static void print_commit(struct commit *commit)
1710 {
1711         struct strbuf sb = STRBUF_INIT;
1712         struct pretty_print_context ctx = {0};
1713         ctx.date_mode.type = DATE_NORMAL;
1714         format_commit_message(commit, " %h: %m %s", &sb, &ctx);
1715         fprintf(stderr, "%s\n", sb.buf);
1716         strbuf_release(&sb);
1717 }
1718
1719 #define MERGE_WARNING(path, msg) \
1720         warning("Failed to merge submodule %s (%s)", path, msg);
1721
1722 int merge_submodule(struct object_id *result, const char *path,
1723                     const struct object_id *base, const struct object_id *a,
1724                     const struct object_id *b, int search)
1725 {
1726         struct commit *commit_base, *commit_a, *commit_b;
1727         int parent_count;
1728         struct object_array merges;
1729
1730         int i;
1731
1732         /* store a in result in case we fail */
1733         oidcpy(result, a);
1734
1735         /* we can not handle deletion conflicts */
1736         if (is_null_oid(base))
1737                 return 0;
1738         if (is_null_oid(a))
1739                 return 0;
1740         if (is_null_oid(b))
1741                 return 0;
1742
1743         if (add_submodule_odb(path)) {
1744                 MERGE_WARNING(path, "not checked out");
1745                 return 0;
1746         }
1747
1748         if (!(commit_base = lookup_commit_reference(base)) ||
1749             !(commit_a = lookup_commit_reference(a)) ||
1750             !(commit_b = lookup_commit_reference(b))) {
1751                 MERGE_WARNING(path, "commits not present");
1752                 return 0;
1753         }
1754
1755         /* check whether both changes are forward */
1756         if (!in_merge_bases(commit_base, commit_a) ||
1757             !in_merge_bases(commit_base, commit_b)) {
1758                 MERGE_WARNING(path, "commits don't follow merge-base");
1759                 return 0;
1760         }
1761
1762         /* Case #1: a is contained in b or vice versa */
1763         if (in_merge_bases(commit_a, commit_b)) {
1764                 oidcpy(result, b);
1765                 return 1;
1766         }
1767         if (in_merge_bases(commit_b, commit_a)) {
1768                 oidcpy(result, a);
1769                 return 1;
1770         }
1771
1772         /*
1773          * Case #2: There are one or more merges that contain a and b in
1774          * the submodule. If there is only one, then present it as a
1775          * suggestion to the user, but leave it marked unmerged so the
1776          * user needs to confirm the resolution.
1777          */
1778
1779         /* Skip the search if makes no sense to the calling context.  */
1780         if (!search)
1781                 return 0;
1782
1783         /* find commit which merges them */
1784         parent_count = find_first_merges(&merges, path, commit_a, commit_b);
1785         switch (parent_count) {
1786         case 0:
1787                 MERGE_WARNING(path, "merge following commits not found");
1788                 break;
1789
1790         case 1:
1791                 MERGE_WARNING(path, "not fast-forward");
1792                 fprintf(stderr, "Found a possible merge resolution "
1793                                 "for the submodule:\n");
1794                 print_commit((struct commit *) merges.objects[0].item);
1795                 fprintf(stderr,
1796                         "If this is correct simply add it to the index "
1797                         "for example\n"
1798                         "by using:\n\n"
1799                         "  git update-index --cacheinfo 160000 %s \"%s\"\n\n"
1800                         "which will accept this suggestion.\n",
1801                         oid_to_hex(&merges.objects[0].item->oid), path);
1802                 break;
1803
1804         default:
1805                 MERGE_WARNING(path, "multiple merges found");
1806                 for (i = 0; i < merges.nr; i++)
1807                         print_commit((struct commit *) merges.objects[i].item);
1808         }
1809
1810         free(merges.objects);
1811         return 0;
1812 }
1813
1814 /*
1815  * Embeds a single submodules git directory into the superprojects git dir,
1816  * non recursively.
1817  */
1818 static void relocate_single_git_dir_into_superproject(const char *prefix,
1819                                                       const char *path)
1820 {
1821         char *old_git_dir = NULL, *real_old_git_dir = NULL, *real_new_git_dir = NULL;
1822         const char *new_git_dir;
1823         const struct submodule *sub;
1824
1825         if (submodule_uses_worktrees(path))
1826                 die(_("relocate_gitdir for submodule '%s' with "
1827                       "more than one worktree not supported"), path);
1828
1829         old_git_dir = xstrfmt("%s/.git", path);
1830         if (read_gitfile(old_git_dir))
1831                 /* If it is an actual gitfile, it doesn't need migration. */
1832                 return;
1833
1834         real_old_git_dir = real_pathdup(old_git_dir, 1);
1835
1836         sub = submodule_from_path(null_sha1, path);
1837         if (!sub)
1838                 die(_("could not lookup name for submodule '%s'"), path);
1839
1840         new_git_dir = git_path("modules/%s", sub->name);
1841         if (safe_create_leading_directories_const(new_git_dir) < 0)
1842                 die(_("could not create directory '%s'"), new_git_dir);
1843         real_new_git_dir = real_pathdup(new_git_dir, 1);
1844
1845         fprintf(stderr, _("Migrating git directory of '%s%s' from\n'%s' to\n'%s'\n"),
1846                 get_super_prefix_or_empty(), path,
1847                 real_old_git_dir, real_new_git_dir);
1848
1849         relocate_gitdir(path, real_old_git_dir, real_new_git_dir);
1850
1851         free(old_git_dir);
1852         free(real_old_git_dir);
1853         free(real_new_git_dir);
1854 }
1855
1856 /*
1857  * Migrate the git directory of the submodule given by path from
1858  * having its git directory within the working tree to the git dir nested
1859  * in its superprojects git dir under modules/.
1860  */
1861 void absorb_git_dir_into_superproject(const char *prefix,
1862                                       const char *path,
1863                                       unsigned flags)
1864 {
1865         int err_code;
1866         const char *sub_git_dir;
1867         struct strbuf gitdir = STRBUF_INIT;
1868         strbuf_addf(&gitdir, "%s/.git", path);
1869         sub_git_dir = resolve_gitdir_gently(gitdir.buf, &err_code);
1870
1871         /* Not populated? */
1872         if (!sub_git_dir) {
1873                 const struct submodule *sub;
1874
1875                 if (err_code == READ_GITFILE_ERR_STAT_FAILED) {
1876                         /* unpopulated as expected */
1877                         strbuf_release(&gitdir);
1878                         return;
1879                 }
1880
1881                 if (err_code != READ_GITFILE_ERR_NOT_A_REPO)
1882                         /* We don't know what broke here. */
1883                         read_gitfile_error_die(err_code, path, NULL);
1884
1885                 /*
1886                 * Maybe populated, but no git directory was found?
1887                 * This can happen if the superproject is a submodule
1888                 * itself and was just absorbed. The absorption of the
1889                 * superproject did not rewrite the git file links yet,
1890                 * fix it now.
1891                 */
1892                 sub = submodule_from_path(null_sha1, path);
1893                 if (!sub)
1894                         die(_("could not lookup name for submodule '%s'"), path);
1895                 connect_work_tree_and_git_dir(path,
1896                         git_path("modules/%s", sub->name));
1897         } else {
1898                 /* Is it already absorbed into the superprojects git dir? */
1899                 char *real_sub_git_dir = real_pathdup(sub_git_dir, 1);
1900                 char *real_common_git_dir = real_pathdup(get_git_common_dir(), 1);
1901
1902                 if (!starts_with(real_sub_git_dir, real_common_git_dir))
1903                         relocate_single_git_dir_into_superproject(prefix, path);
1904
1905                 free(real_sub_git_dir);
1906                 free(real_common_git_dir);
1907         }
1908         strbuf_release(&gitdir);
1909
1910         if (flags & ABSORB_GITDIR_RECURSE_SUBMODULES) {
1911                 struct child_process cp = CHILD_PROCESS_INIT;
1912                 struct strbuf sb = STRBUF_INIT;
1913
1914                 if (flags & ~ABSORB_GITDIR_RECURSE_SUBMODULES)
1915                         die("BUG: we don't know how to pass the flags down?");
1916
1917                 strbuf_addstr(&sb, get_super_prefix_or_empty());
1918                 strbuf_addstr(&sb, path);
1919                 strbuf_addch(&sb, '/');
1920
1921                 cp.dir = path;
1922                 cp.git_cmd = 1;
1923                 cp.no_stdin = 1;
1924                 argv_array_pushl(&cp.args, "--super-prefix", sb.buf,
1925                                            "submodule--helper",
1926                                            "absorb-git-dirs", NULL);
1927                 prepare_submodule_repo_env(&cp.env_array);
1928                 if (run_command(&cp))
1929                         die(_("could not recurse into submodule '%s'"), path);
1930
1931                 strbuf_release(&sb);
1932         }
1933 }
1934
1935 const char *get_superproject_working_tree(void)
1936 {
1937         struct child_process cp = CHILD_PROCESS_INIT;
1938         struct strbuf sb = STRBUF_INIT;
1939         const char *one_up = real_path_if_valid("../");
1940         const char *cwd = xgetcwd();
1941         const char *ret = NULL;
1942         const char *subpath;
1943         int code;
1944         ssize_t len;
1945
1946         if (!is_inside_work_tree())
1947                 /*
1948                  * FIXME:
1949                  * We might have a superproject, but it is harder
1950                  * to determine.
1951                  */
1952                 return NULL;
1953
1954         if (!one_up)
1955                 return NULL;
1956
1957         subpath = relative_path(cwd, one_up, &sb);
1958
1959         prepare_submodule_repo_env(&cp.env_array);
1960         argv_array_pop(&cp.env_array);
1961
1962         argv_array_pushl(&cp.args, "--literal-pathspecs", "-C", "..",
1963                         "ls-files", "-z", "--stage", "--full-name", "--",
1964                         subpath, NULL);
1965         strbuf_reset(&sb);
1966
1967         cp.no_stdin = 1;
1968         cp.no_stderr = 1;
1969         cp.out = -1;
1970         cp.git_cmd = 1;
1971
1972         if (start_command(&cp))
1973                 die(_("could not start ls-files in .."));
1974
1975         len = strbuf_read(&sb, cp.out, PATH_MAX);
1976         close(cp.out);
1977
1978         if (starts_with(sb.buf, "160000")) {
1979                 int super_sub_len;
1980                 int cwd_len = strlen(cwd);
1981                 char *super_sub, *super_wt;
1982
1983                 /*
1984                  * There is a superproject having this repo as a submodule.
1985                  * The format is <mode> SP <hash> SP <stage> TAB <full name> \0,
1986                  * We're only interested in the name after the tab.
1987                  */
1988                 super_sub = strchr(sb.buf, '\t') + 1;
1989                 super_sub_len = sb.buf + sb.len - super_sub - 1;
1990
1991                 if (super_sub_len > cwd_len ||
1992                     strcmp(&cwd[cwd_len - super_sub_len], super_sub))
1993                         die (_("BUG: returned path string doesn't match cwd?"));
1994
1995                 super_wt = xstrdup(cwd);
1996                 super_wt[cwd_len - super_sub_len] = '\0';
1997
1998                 ret = real_path(super_wt);
1999                 free(super_wt);
2000         }
2001         strbuf_release(&sb);
2002
2003         code = finish_command(&cp);
2004
2005         if (code == 128)
2006                 /* '../' is not a git repository */
2007                 return NULL;
2008         if (code == 0 && len == 0)
2009                 /* There is an unrelated git repository at '../' */
2010                 return NULL;
2011         if (code)
2012                 die(_("ls-tree returned unexpected return code %d"), code);
2013
2014         return ret;
2015 }
2016
2017 int submodule_to_gitdir(struct strbuf *buf, const char *submodule)
2018 {
2019         const struct submodule *sub;
2020         const char *git_dir;
2021         int ret = 0;
2022
2023         strbuf_reset(buf);
2024         strbuf_addstr(buf, submodule);
2025         strbuf_complete(buf, '/');
2026         strbuf_addstr(buf, ".git");
2027
2028         git_dir = read_gitfile(buf->buf);
2029         if (git_dir) {
2030                 strbuf_reset(buf);
2031                 strbuf_addstr(buf, git_dir);
2032         }
2033         if (!is_git_directory(buf->buf)) {
2034                 gitmodules_config();
2035                 sub = submodule_from_path(null_sha1, submodule);
2036                 if (!sub) {
2037                         ret = -1;
2038                         goto cleanup;
2039                 }
2040                 strbuf_reset(buf);
2041                 strbuf_git_path(buf, "%s/%s", "modules", sub->name);
2042         }
2043
2044 cleanup:
2045         return ret;
2046 }