7 #include "run-command.h"
10 #include "string-list.h"
12 static struct string_list config_name_for_path
;
13 static struct string_list config_fetch_recurse_submodules_for_name
;
14 static struct string_list config_ignore_for_name
;
15 static int config_fetch_recurse_submodules
= RECURSE_SUBMODULES_ON_DEMAND
;
16 static struct string_list changed_submodule_paths
;
18 static int add_submodule_odb(const char *path
)
20 struct strbuf objects_directory
= STRBUF_INIT
;
21 struct alternate_object_database
*alt_odb
;
25 strbuf_addf(&objects_directory
, "%s/.git", path
);
26 git_dir
= read_gitfile_gently(objects_directory
.buf
);
28 strbuf_reset(&objects_directory
);
29 strbuf_addstr(&objects_directory
, git_dir
);
31 strbuf_addstr(&objects_directory
, "/objects/");
32 if (!is_directory(objects_directory
.buf
)) {
36 /* avoid adding it twice */
37 for (alt_odb
= alt_odb_list
; alt_odb
; alt_odb
= alt_odb
->next
)
38 if (alt_odb
->name
- alt_odb
->base
== objects_directory
.len
&&
39 !strncmp(alt_odb
->base
, objects_directory
.buf
,
40 objects_directory
.len
))
43 alt_odb
= xmalloc(objects_directory
.len
+ 42 + sizeof(*alt_odb
));
44 alt_odb
->next
= alt_odb_list
;
45 strcpy(alt_odb
->base
, objects_directory
.buf
);
46 alt_odb
->name
= alt_odb
->base
+ objects_directory
.len
;
47 alt_odb
->name
[2] = '/';
48 alt_odb
->name
[40] = '\0';
49 alt_odb
->name
[41] = '\0';
50 alt_odb_list
= alt_odb
;
53 strbuf_release(&objects_directory
);
57 void set_diffopt_flags_from_submodule_config(struct diff_options
*diffopt
,
60 struct string_list_item
*path_option
, *ignore_option
;
61 path_option
= unsorted_string_list_lookup(&config_name_for_path
, path
);
63 ignore_option
= unsorted_string_list_lookup(&config_ignore_for_name
, path_option
->util
);
65 handle_ignore_submodules_arg(diffopt
, ignore_option
->util
);
69 int submodule_config(const char *var
, const char *value
, void *cb
)
71 if (!prefixcmp(var
, "submodule."))
72 return parse_submodule_config_option(var
, value
);
73 else if (!strcmp(var
, "fetch.recursesubmodules")) {
74 config_fetch_recurse_submodules
= parse_fetch_recurse_submodules_arg(var
, value
);
80 void gitmodules_config(void)
82 const char *work_tree
= get_git_work_tree();
84 struct strbuf gitmodules_path
= STRBUF_INIT
;
85 strbuf_addstr(&gitmodules_path
, work_tree
);
86 strbuf_addstr(&gitmodules_path
, "/.gitmodules");
87 git_config_from_file(submodule_config
, gitmodules_path
.buf
, NULL
);
88 strbuf_release(&gitmodules_path
);
92 int parse_submodule_config_option(const char *var
, const char *value
)
95 struct string_list_item
*config
;
96 struct strbuf submodname
= STRBUF_INIT
;
98 var
+= 10; /* Skip "submodule." */
101 if ((len
> 5) && !strcmp(var
+ len
- 5, ".path")) {
102 strbuf_add(&submodname
, var
, len
- 5);
103 config
= unsorted_string_list_lookup(&config_name_for_path
, value
);
107 config
= string_list_append(&config_name_for_path
, xstrdup(value
));
108 config
->util
= strbuf_detach(&submodname
, NULL
);
109 strbuf_release(&submodname
);
110 } else if ((len
> 23) && !strcmp(var
+ len
- 23, ".fetchrecursesubmodules")) {
111 strbuf_add(&submodname
, var
, len
- 23);
112 config
= unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name
, submodname
.buf
);
114 config
= string_list_append(&config_fetch_recurse_submodules_for_name
,
115 strbuf_detach(&submodname
, NULL
));
116 config
->util
= (void *)(intptr_t)parse_fetch_recurse_submodules_arg(var
, value
);
117 strbuf_release(&submodname
);
118 } else if ((len
> 7) && !strcmp(var
+ len
- 7, ".ignore")) {
119 if (strcmp(value
, "untracked") && strcmp(value
, "dirty") &&
120 strcmp(value
, "all") && strcmp(value
, "none")) {
121 warning("Invalid parameter \"%s\" for config option \"submodule.%s.ignore\"", value
, var
);
125 strbuf_add(&submodname
, var
, len
- 7);
126 config
= unsorted_string_list_lookup(&config_ignore_for_name
, submodname
.buf
);
130 config
= string_list_append(&config_ignore_for_name
,
131 strbuf_detach(&submodname
, NULL
));
132 strbuf_release(&submodname
);
133 config
->util
= xstrdup(value
);
139 void handle_ignore_submodules_arg(struct diff_options
*diffopt
,
142 DIFF_OPT_CLR(diffopt
, IGNORE_SUBMODULES
);
143 DIFF_OPT_CLR(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
144 DIFF_OPT_CLR(diffopt
, IGNORE_DIRTY_SUBMODULES
);
146 if (!strcmp(arg
, "all"))
147 DIFF_OPT_SET(diffopt
, IGNORE_SUBMODULES
);
148 else if (!strcmp(arg
, "untracked"))
149 DIFF_OPT_SET(diffopt
, IGNORE_UNTRACKED_IN_SUBMODULES
);
150 else if (!strcmp(arg
, "dirty"))
151 DIFF_OPT_SET(diffopt
, IGNORE_DIRTY_SUBMODULES
);
152 else if (strcmp(arg
, "none"))
153 die("bad --ignore-submodules argument: %s", arg
);
156 static int prepare_submodule_summary(struct rev_info
*rev
, const char *path
,
157 struct commit
*left
, struct commit
*right
,
158 int *fast_forward
, int *fast_backward
)
160 struct commit_list
*merge_bases
, *list
;
162 init_revisions(rev
, NULL
);
163 setup_revisions(0, NULL
, rev
, NULL
);
165 rev
->first_parent_only
= 1;
166 left
->object
.flags
|= SYMMETRIC_LEFT
;
167 add_pending_object(rev
, &left
->object
, path
);
168 add_pending_object(rev
, &right
->object
, path
);
169 merge_bases
= get_merge_bases(left
, right
, 1);
171 if (merge_bases
->item
== left
)
173 else if (merge_bases
->item
== right
)
176 for (list
= merge_bases
; list
; list
= list
->next
) {
177 list
->item
->object
.flags
|= UNINTERESTING
;
178 add_pending_object(rev
, &list
->item
->object
,
179 sha1_to_hex(list
->item
->object
.sha1
));
181 return prepare_revision_walk(rev
);
184 static void print_submodule_summary(struct rev_info
*rev
, FILE *f
,
185 const char *del
, const char *add
, const char *reset
)
187 static const char format
[] = " %m %s";
188 struct strbuf sb
= STRBUF_INIT
;
189 struct commit
*commit
;
191 while ((commit
= get_revision(rev
))) {
192 struct pretty_print_context ctx
= {0};
193 ctx
.date_mode
= rev
->date_mode
;
194 strbuf_setlen(&sb
, 0);
195 if (commit
->object
.flags
& SYMMETRIC_LEFT
) {
197 strbuf_addstr(&sb
, del
);
200 strbuf_addstr(&sb
, add
);
201 format_commit_message(commit
, format
, &sb
, &ctx
);
203 strbuf_addstr(&sb
, reset
);
204 strbuf_addch(&sb
, '\n');
205 fprintf(f
, "%s", sb
.buf
);
210 int parse_fetch_recurse_submodules_arg(const char *opt
, const char *arg
)
212 switch (git_config_maybe_bool(opt
, arg
)) {
214 return RECURSE_SUBMODULES_ON
;
216 return RECURSE_SUBMODULES_OFF
;
218 if (!strcmp(arg
, "on-demand"))
219 return RECURSE_SUBMODULES_ON_DEMAND
;
220 die("bad %s argument: %s", opt
, arg
);
224 void show_submodule_summary(FILE *f
, const char *path
,
225 unsigned char one
[20], unsigned char two
[20],
226 unsigned dirty_submodule
,
227 const char *del
, const char *add
, const char *reset
)
230 struct commit
*left
= left
, *right
= right
;
231 const char *message
= NULL
;
232 struct strbuf sb
= STRBUF_INIT
;
233 int fast_forward
= 0, fast_backward
= 0;
235 if (is_null_sha1(two
))
236 message
= "(submodule deleted)";
237 else if (add_submodule_odb(path
))
238 message
= "(not checked out)";
239 else if (is_null_sha1(one
))
240 message
= "(new submodule)";
241 else if (!(left
= lookup_commit_reference(one
)) ||
242 !(right
= lookup_commit_reference(two
)))
243 message
= "(commits not present)";
246 prepare_submodule_summary(&rev
, path
, left
, right
,
247 &fast_forward
, &fast_backward
))
248 message
= "(revision walker failed)";
250 if (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
)
251 fprintf(f
, "Submodule %s contains untracked content\n", path
);
252 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
253 fprintf(f
, "Submodule %s contains modified content\n", path
);
255 if (!hashcmp(one
, two
)) {
260 strbuf_addf(&sb
, "Submodule %s %s..", path
,
261 find_unique_abbrev(one
, DEFAULT_ABBREV
));
262 if (!fast_backward
&& !fast_forward
)
263 strbuf_addch(&sb
, '.');
264 strbuf_addf(&sb
, "%s", find_unique_abbrev(two
, DEFAULT_ABBREV
));
266 strbuf_addf(&sb
, " %s\n", message
);
268 strbuf_addf(&sb
, "%s:\n", fast_backward
? " (rewind)" : "");
269 fwrite(sb
.buf
, sb
.len
, 1, f
);
272 print_submodule_summary(&rev
, f
, del
, add
, reset
);
273 clear_commit_marks(left
, ~0);
274 clear_commit_marks(right
, ~0);
280 void set_config_fetch_recurse_submodules(int value
)
282 config_fetch_recurse_submodules
= value
;
285 static int is_submodule_commit_present(const char *path
, unsigned char sha1
[20])
288 if (!add_submodule_odb(path
) && lookup_commit_reference(sha1
)) {
289 /* Even if the submodule is checked out and the commit is
290 * present, make sure it is reachable from a ref. */
291 struct child_process cp
;
292 const char *argv
[] = {"rev-list", "-n", "1", NULL
, "--not", "--all", NULL
};
293 struct strbuf buf
= STRBUF_INIT
;
295 argv
[3] = sha1_to_hex(sha1
);
296 memset(&cp
, 0, sizeof(cp
));
298 cp
.env
= local_repo_env
;
303 if (!run_command(&cp
) && !strbuf_read(&buf
, cp
.out
, 1024))
307 strbuf_release(&buf
);
312 static void submodule_collect_changed_cb(struct diff_queue_struct
*q
,
313 struct diff_options
*options
,
317 for (i
= 0; i
< q
->nr
; i
++) {
318 struct diff_filepair
*p
= q
->queue
[i
];
319 if (!S_ISGITLINK(p
->two
->mode
))
322 if (S_ISGITLINK(p
->one
->mode
)) {
323 /* NEEDSWORK: We should honor the name configured in
324 * the .gitmodules file of the commit we are examining
325 * here to be able to correctly follow submodules
326 * being moved around. */
327 struct string_list_item
*path
;
328 path
= unsorted_string_list_lookup(&changed_submodule_paths
, p
->two
->path
);
329 if (!path
&& !is_submodule_commit_present(p
->two
->path
, p
->two
->sha1
))
330 string_list_append(&changed_submodule_paths
, xstrdup(p
->two
->path
));
332 /* Submodule is new or was moved here */
333 /* NEEDSWORK: When the .git directories of submodules
334 * live inside the superprojects .git directory some
335 * day we should fetch new submodules directly into
336 * that location too when config or options request
337 * that so they can be checked out from there. */
343 void check_for_new_submodule_commits(unsigned char new_sha1
[20])
346 struct commit
*commit
;
347 const char *argv
[] = {NULL
, NULL
, "--not", "--all", NULL
};
348 int argc
= ARRAY_SIZE(argv
) - 1;
350 init_revisions(&rev
, NULL
);
351 argv
[1] = xstrdup(sha1_to_hex(new_sha1
));
352 setup_revisions(argc
, argv
, &rev
, NULL
);
353 if (prepare_revision_walk(&rev
))
354 die("revision walk setup failed");
357 * Collect all submodules (whether checked out or not) for which new
358 * commits have been recorded upstream in "changed_submodule_paths".
360 while ((commit
= get_revision(&rev
))) {
361 struct commit_list
*parent
= commit
->parents
;
363 struct diff_options diff_opts
;
364 diff_setup(&diff_opts
);
365 DIFF_OPT_SET(&diff_opts
, RECURSIVE
);
366 diff_opts
.output_format
|= DIFF_FORMAT_CALLBACK
;
367 diff_opts
.format_callback
= submodule_collect_changed_cb
;
368 if (diff_setup_done(&diff_opts
) < 0)
369 die("diff_setup_done failed");
370 diff_tree_sha1(parent
->item
->object
.sha1
, commit
->object
.sha1
, "", &diff_opts
);
371 diffcore_std(&diff_opts
);
372 diff_flush(&diff_opts
);
373 parent
= parent
->next
;
376 free((char *)argv
[1]);
379 int fetch_populated_submodules(int num_options
, const char **options
,
380 const char *prefix
, int command_line_option
,
383 int i
, result
= 0, argc
= 0, default_argc
;
384 struct child_process cp
;
386 struct string_list_item
*name_for_path
;
387 const char *work_tree
= get_git_work_tree();
391 if (!the_index
.initialized
)
392 if (read_cache() < 0)
393 die("index file corrupt");
395 /* 6: "fetch" (options) --recurse-submodules-default default "--submodule-prefix" prefix NULL */
396 argv
= xcalloc(num_options
+ 6, sizeof(const char *));
397 argv
[argc
++] = "fetch";
398 for (i
= 0; i
< num_options
; i
++)
399 argv
[argc
++] = options
[i
];
400 argv
[argc
++] = "--recurse-submodules-default";
401 default_argc
= argc
++;
402 argv
[argc
++] = "--submodule-prefix";
404 memset(&cp
, 0, sizeof(cp
));
406 cp
.env
= local_repo_env
;
410 for (i
= 0; i
< active_nr
; i
++) {
411 struct strbuf submodule_path
= STRBUF_INIT
;
412 struct strbuf submodule_git_dir
= STRBUF_INIT
;
413 struct strbuf submodule_prefix
= STRBUF_INIT
;
414 struct cache_entry
*ce
= active_cache
[i
];
415 const char *git_dir
, *name
, *default_argv
;
417 if (!S_ISGITLINK(ce
->ce_mode
))
421 name_for_path
= unsorted_string_list_lookup(&config_name_for_path
, ce
->name
);
423 name
= name_for_path
->util
;
425 default_argv
= "yes";
426 if (command_line_option
== RECURSE_SUBMODULES_DEFAULT
) {
427 struct string_list_item
*fetch_recurse_submodules_option
;
428 fetch_recurse_submodules_option
= unsorted_string_list_lookup(&config_fetch_recurse_submodules_for_name
, name
);
429 if (fetch_recurse_submodules_option
) {
430 if ((intptr_t)fetch_recurse_submodules_option
->util
== RECURSE_SUBMODULES_OFF
)
432 if ((intptr_t)fetch_recurse_submodules_option
->util
== RECURSE_SUBMODULES_ON_DEMAND
) {
433 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
435 default_argv
= "on-demand";
438 if (config_fetch_recurse_submodules
== RECURSE_SUBMODULES_OFF
)
440 if (config_fetch_recurse_submodules
== RECURSE_SUBMODULES_ON_DEMAND
) {
441 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
443 default_argv
= "on-demand";
446 } else if (command_line_option
== RECURSE_SUBMODULES_ON_DEMAND
) {
447 if (!unsorted_string_list_lookup(&changed_submodule_paths
, ce
->name
))
449 default_argv
= "on-demand";
452 strbuf_addf(&submodule_path
, "%s/%s", work_tree
, ce
->name
);
453 strbuf_addf(&submodule_git_dir
, "%s/.git", submodule_path
.buf
);
454 strbuf_addf(&submodule_prefix
, "%s%s/", prefix
, ce
->name
);
455 git_dir
= read_gitfile_gently(submodule_git_dir
.buf
);
457 git_dir
= submodule_git_dir
.buf
;
458 if (is_directory(git_dir
)) {
460 printf("Fetching submodule %s%s\n", prefix
, ce
->name
);
461 cp
.dir
= submodule_path
.buf
;
462 argv
[default_argc
] = default_argv
;
463 argv
[argc
] = submodule_prefix
.buf
;
464 if (run_command(&cp
))
467 strbuf_release(&submodule_path
);
468 strbuf_release(&submodule_git_dir
);
469 strbuf_release(&submodule_prefix
);
473 string_list_clear(&changed_submodule_paths
, 1);
477 unsigned is_submodule_modified(const char *path
, int ignore_untracked
)
480 struct child_process cp
;
481 const char *argv
[] = {
487 struct strbuf buf
= STRBUF_INIT
;
488 unsigned dirty_submodule
= 0;
489 const char *line
, *next_line
;
492 strbuf_addf(&buf
, "%s/.git", path
);
493 git_dir
= read_gitfile_gently(buf
.buf
);
496 if (!is_directory(git_dir
)) {
497 strbuf_release(&buf
);
498 /* The submodule is not checked out, so it is not modified */
504 if (ignore_untracked
)
507 memset(&cp
, 0, sizeof(cp
));
509 cp
.env
= local_repo_env
;
514 if (start_command(&cp
))
515 die("Could not run git status --porcelain");
517 len
= strbuf_read(&buf
, cp
.out
, 1024);
520 if ((line
[0] == '?') && (line
[1] == '?')) {
521 dirty_submodule
|= DIRTY_SUBMODULE_UNTRACKED
;
522 if (dirty_submodule
& DIRTY_SUBMODULE_MODIFIED
)
525 dirty_submodule
|= DIRTY_SUBMODULE_MODIFIED
;
526 if (ignore_untracked
||
527 (dirty_submodule
& DIRTY_SUBMODULE_UNTRACKED
))
530 next_line
= strchr(line
, '\n');
534 len
-= (next_line
- line
);
539 if (finish_command(&cp
))
540 die("git status --porcelain failed");
542 strbuf_release(&buf
);
543 return dirty_submodule
;
546 static int find_first_merges(struct object_array
*result
, const char *path
,
547 struct commit
*a
, struct commit
*b
)
550 struct object_array merges
;
551 struct commit
*commit
;
552 int contains_another
;
554 char merged_revision
[42];
555 const char *rev_args
[] = { "rev-list", "--merges", "--ancestry-path",
556 "--all", merged_revision
, NULL
};
557 struct rev_info revs
;
558 struct setup_revision_opt rev_opts
;
560 memset(&merges
, 0, sizeof(merges
));
561 memset(result
, 0, sizeof(struct object_array
));
562 memset(&rev_opts
, 0, sizeof(rev_opts
));
564 /* get all revisions that merge commit a */
565 snprintf(merged_revision
, sizeof(merged_revision
), "^%s",
566 sha1_to_hex(a
->object
.sha1
));
567 init_revisions(&revs
, NULL
);
568 rev_opts
.submodule
= path
;
569 setup_revisions(sizeof(rev_args
)/sizeof(char *)-1, rev_args
, &revs
, &rev_opts
);
571 /* save all revisions from the above list that contain b */
572 if (prepare_revision_walk(&revs
))
573 die("revision walk setup failed");
574 while ((commit
= get_revision(&revs
)) != NULL
) {
575 struct object
*o
= &(commit
->object
);
576 if (in_merge_bases(b
, &commit
, 1))
577 add_object_array(o
, NULL
, &merges
);
580 /* Now we've got all merges that contain a and b. Prune all
581 * merges that contain another found merge and save them in
584 for (i
= 0; i
< merges
.nr
; i
++) {
585 struct commit
*m1
= (struct commit
*) merges
.objects
[i
].item
;
587 contains_another
= 0;
588 for (j
= 0; j
< merges
.nr
; j
++) {
589 struct commit
*m2
= (struct commit
*) merges
.objects
[j
].item
;
590 if (i
!= j
&& in_merge_bases(m2
, &m1
, 1)) {
591 contains_another
= 1;
596 if (!contains_another
)
597 add_object_array(merges
.objects
[i
].item
,
598 merges
.objects
[i
].name
, result
);
601 free(merges
.objects
);
605 static void print_commit(struct commit
*commit
)
607 struct strbuf sb
= STRBUF_INIT
;
608 struct pretty_print_context ctx
= {0};
609 ctx
.date_mode
= DATE_NORMAL
;
610 format_commit_message(commit
, " %h: %m %s", &sb
, &ctx
);
611 fprintf(stderr
, "%s\n", sb
.buf
);
615 #define MERGE_WARNING(path, msg) \
616 warning("Failed to merge submodule %s (%s)", path, msg);
618 int merge_submodule(unsigned char result
[20], const char *path
,
619 const unsigned char base
[20], const unsigned char a
[20],
620 const unsigned char b
[20])
622 struct commit
*commit_base
, *commit_a
, *commit_b
;
624 struct object_array merges
;
628 /* store a in result in case we fail */
631 /* we can not handle deletion conflicts */
632 if (is_null_sha1(base
))
639 if (add_submodule_odb(path
)) {
640 MERGE_WARNING(path
, "not checked out");
644 if (!(commit_base
= lookup_commit_reference(base
)) ||
645 !(commit_a
= lookup_commit_reference(a
)) ||
646 !(commit_b
= lookup_commit_reference(b
))) {
647 MERGE_WARNING(path
, "commits not present");
651 /* check whether both changes are forward */
652 if (!in_merge_bases(commit_base
, &commit_a
, 1) ||
653 !in_merge_bases(commit_base
, &commit_b
, 1)) {
654 MERGE_WARNING(path
, "commits don't follow merge-base");
658 /* Case #1: a is contained in b or vice versa */
659 if (in_merge_bases(commit_a
, &commit_b
, 1)) {
663 if (in_merge_bases(commit_b
, &commit_a
, 1)) {
669 * Case #2: There are one or more merges that contain a and b in
670 * the submodule. If there is only one, then present it as a
671 * suggestion to the user, but leave it marked unmerged so the
672 * user needs to confirm the resolution.
675 /* find commit which merges them */
676 parent_count
= find_first_merges(&merges
, path
, commit_a
, commit_b
);
677 switch (parent_count
) {
679 MERGE_WARNING(path
, "merge following commits not found");
683 MERGE_WARNING(path
, "not fast-forward");
684 fprintf(stderr
, "Found a possible merge resolution "
685 "for the submodule:\n");
686 print_commit((struct commit
*) merges
.objects
[0].item
);
688 "If this is correct simply add it to the index "
691 " git update-index --cacheinfo 160000 %s \"%s\"\n\n"
692 "which will accept this suggestion.\n",
693 sha1_to_hex(merges
.objects
[0].item
->sha1
), path
);
697 MERGE_WARNING(path
, "multiple merges found");
698 for (i
= 0; i
< merges
.nr
; i
++)
699 print_commit((struct commit
*) merges
.objects
[i
].item
);
702 free(merges
.objects
);