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