2 * Recursive Merge algorithm stolen from git-merge-recursive.py by
4 * The thieves were Alex Riesen and Johannes Schindelin, in June/July 2006
7 #include "cache-tree.h"
10 #include "tree-walk.h"
13 #include "run-command.h"
15 #include "unpack-trees.h"
16 #include "path-list.h"
17 #include "xdiff-interface.h"
18 #include "interpolate.h"
21 static int subtree_merge
;
23 static struct tree
*shift_tree_object(struct tree
*one
, struct tree
*two
)
25 unsigned char shifted
[20];
28 * NEEDSWORK: this limits the recursion depth to hardcoded
29 * value '2' to avoid excessive overhead.
31 shift_tree(one
->object
.sha1
, two
->object
.sha1
, shifted
, 2);
32 if (!hashcmp(two
->object
.sha1
, shifted
))
34 return lookup_tree(shifted
);
38 * A virtual commit has
39 * - (const char *)commit->util set to the name, and
40 * - *(int *)commit->object.sha1 set to the virtual id.
43 static unsigned commit_list_count(const struct commit_list
*l
)
46 for (; l
; l
= l
->next
)
51 static struct commit
*make_virtual_commit(struct tree
*tree
, const char *comment
)
53 struct commit
*commit
= xcalloc(1, sizeof(struct commit
));
54 static unsigned virtual_id
= 1;
56 commit
->util
= (void*)comment
;
57 *(int*)commit
->object
.sha1
= virtual_id
++;
59 commit
->object
.parsed
= 1;
64 * Since we use get_tree_entry(), which does not put the read object into
65 * the object pool, we cannot rely on a == b.
67 static int sha_eq(const unsigned char *a
, const unsigned char *b
)
71 return a
&& b
&& hashcmp(a
, b
) == 0;
75 * Since we want to write the index eventually, we cannot reuse the index
76 * for these (temporary) data.
83 unsigned char sha
[20];
88 static struct path_list current_file_set
= {NULL
, 0, 0, 1};
89 static struct path_list current_directory_set
= {NULL
, 0, 0, 1};
91 static int call_depth
= 0;
92 static int verbosity
= 2;
93 static int rename_limit
= -1;
94 static int buffer_output
= 1;
95 static struct strbuf obuf
= STRBUF_INIT
;
97 static int show(int v
)
99 return (!call_depth
&& verbosity
>= v
) || verbosity
>= 5;
102 static void flush_output(void)
105 fputs(obuf
.buf
, stdout
);
110 static void output(int v
, const char *fmt
, ...)
118 strbuf_grow(&obuf
, call_depth
* 2 + 2);
119 memset(obuf
.buf
+ obuf
.len
, ' ', call_depth
* 2);
120 strbuf_setlen(&obuf
, obuf
.len
+ call_depth
* 2);
123 len
= vsnprintf(obuf
.buf
+ obuf
.len
, strbuf_avail(&obuf
), fmt
, ap
);
128 if (len
>= strbuf_avail(&obuf
)) {
129 strbuf_grow(&obuf
, len
+ 2);
131 len
= vsnprintf(obuf
.buf
+ obuf
.len
, strbuf_avail(&obuf
), fmt
, ap
);
133 if (len
>= strbuf_avail(&obuf
)) {
134 die("this should not happen, your snprintf is broken");
137 strbuf_setlen(&obuf
, obuf
.len
+ len
);
138 strbuf_add(&obuf
, "\n", 1);
143 static void output_commit_title(struct commit
*commit
)
147 for (i
= call_depth
; i
--;)
150 printf("virtual %s\n", (char *)commit
->util
);
152 printf("%s ", find_unique_abbrev(commit
->object
.sha1
, DEFAULT_ABBREV
));
153 if (parse_commit(commit
) != 0)
154 printf("(bad commit)\n");
158 for (s
= commit
->buffer
; *s
; s
++)
159 if (*s
== '\n' && s
[1] == '\n') {
163 for (len
= 0; s
[len
] && '\n' != s
[len
]; len
++)
165 printf("%.*s\n", len
, s
);
170 static int add_cacheinfo(unsigned int mode
, const unsigned char *sha1
,
171 const char *path
, int stage
, int refresh
, int options
)
173 struct cache_entry
*ce
;
174 ce
= make_cache_entry(mode
, sha1
? sha1
: null_sha1
, path
, stage
, refresh
);
176 return error("addinfo_cache failed for path '%s'", path
);
177 return add_cache_entry(ce
, options
);
181 * This is a global variable which is used in a number of places but
182 * only written to in the 'merge' function.
184 * index_only == 1 => Don't leave any non-stage 0 entries in the cache and
185 * don't update the working directory.
186 * 0 => Leave unmerged entries in the cache and update
187 * the working directory.
189 static int index_only
= 0;
191 static void init_tree_desc_from_tree(struct tree_desc
*desc
, struct tree
*tree
)
194 init_tree_desc(desc
, tree
->buffer
, tree
->size
);
197 static int git_merge_trees(int index_only
,
203 struct tree_desc t
[3];
204 struct unpack_trees_options opts
;
206 memset(&opts
, 0, sizeof(opts
));
213 opts
.fn
= threeway_merge
;
215 init_tree_desc_from_tree(t
+0, common
);
216 init_tree_desc_from_tree(t
+1, head
);
217 init_tree_desc_from_tree(t
+2, merge
);
219 rc
= unpack_trees(3, t
, &opts
);
220 cache_tree_free(&active_cache_tree
);
224 static int unmerged_index(void)
227 for (i
= 0; i
< active_nr
; i
++) {
228 struct cache_entry
*ce
= active_cache
[i
];
235 static struct tree
*git_write_tree(void)
237 struct tree
*result
= NULL
;
239 if (unmerged_index()) {
241 output(0, "There are unmerged index entries:");
242 for (i
= 0; i
< active_nr
; i
++) {
243 struct cache_entry
*ce
= active_cache
[i
];
245 output(0, "%d %.*s", ce_stage(ce
), ce_namelen(ce
), ce
->name
);
250 if (!active_cache_tree
)
251 active_cache_tree
= cache_tree();
253 if (!cache_tree_fully_valid(active_cache_tree
) &&
254 cache_tree_update(active_cache_tree
,
255 active_cache
, active_nr
, 0, 0) < 0)
256 die("error building trees");
258 result
= lookup_tree(active_cache_tree
->sha1
);
263 static int save_files_dirs(const unsigned char *sha1
,
264 const char *base
, int baselen
, const char *path
,
265 unsigned int mode
, int stage
)
267 int len
= strlen(path
);
268 char *newpath
= xmalloc(baselen
+ len
+ 1);
269 memcpy(newpath
, base
, baselen
);
270 memcpy(newpath
+ baselen
, path
, len
);
271 newpath
[baselen
+ len
] = '\0';
274 path_list_insert(newpath
, ¤t_directory_set
);
276 path_list_insert(newpath
, ¤t_file_set
);
279 return READ_TREE_RECURSIVE
;
282 static int get_files_dirs(struct tree
*tree
)
285 if (read_tree_recursive(tree
, "", 0, 0, NULL
, save_files_dirs
) != 0)
287 n
= current_file_set
.nr
+ current_directory_set
.nr
;
292 * Returns an index_entry instance which doesn't have to correspond to
293 * a real cache entry in Git's index.
295 static struct stage_data
*insert_stage_data(const char *path
,
296 struct tree
*o
, struct tree
*a
, struct tree
*b
,
297 struct path_list
*entries
)
299 struct path_list_item
*item
;
300 struct stage_data
*e
= xcalloc(1, sizeof(struct stage_data
));
301 get_tree_entry(o
->object
.sha1
, path
,
302 e
->stages
[1].sha
, &e
->stages
[1].mode
);
303 get_tree_entry(a
->object
.sha1
, path
,
304 e
->stages
[2].sha
, &e
->stages
[2].mode
);
305 get_tree_entry(b
->object
.sha1
, path
,
306 e
->stages
[3].sha
, &e
->stages
[3].mode
);
307 item
= path_list_insert(path
, entries
);
313 * Create a dictionary mapping file names to stage_data objects. The
314 * dictionary contains one entry for every path with a non-zero stage entry.
316 static struct path_list
*get_unmerged(void)
318 struct path_list
*unmerged
= xcalloc(1, sizeof(struct path_list
));
321 unmerged
->strdup_paths
= 1;
323 for (i
= 0; i
< active_nr
; i
++) {
324 struct path_list_item
*item
;
325 struct stage_data
*e
;
326 struct cache_entry
*ce
= active_cache
[i
];
330 item
= path_list_lookup(ce
->name
, unmerged
);
332 item
= path_list_insert(ce
->name
, unmerged
);
333 item
->util
= xcalloc(1, sizeof(struct stage_data
));
336 e
->stages
[ce_stage(ce
)].mode
= ntohl(ce
->ce_mode
);
337 hashcpy(e
->stages
[ce_stage(ce
)].sha
, ce
->sha1
);
345 struct diff_filepair
*pair
;
346 struct stage_data
*src_entry
;
347 struct stage_data
*dst_entry
;
348 unsigned processed
:1;
352 * Get information of all renames which occurred between 'o_tree' and
353 * 'tree'. We need the three trees in the merge ('o_tree', 'a_tree' and
354 * 'b_tree') to be able to associate the correct cache entries with
355 * the rename information. 'tree' is always equal to either a_tree or b_tree.
357 static struct path_list
*get_renames(struct tree
*tree
,
361 struct path_list
*entries
)
364 struct path_list
*renames
;
365 struct diff_options opts
;
367 renames
= xcalloc(1, sizeof(struct path_list
));
369 DIFF_OPT_SET(&opts
, RECURSIVE
);
370 opts
.detect_rename
= DIFF_DETECT_RENAME
;
371 opts
.rename_limit
= rename_limit
;
372 opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
373 if (diff_setup_done(&opts
) < 0)
374 die("diff setup failed");
375 diff_tree_sha1(o_tree
->object
.sha1
, tree
->object
.sha1
, "", &opts
);
377 for (i
= 0; i
< diff_queued_diff
.nr
; ++i
) {
378 struct path_list_item
*item
;
380 struct diff_filepair
*pair
= diff_queued_diff
.queue
[i
];
381 if (pair
->status
!= 'R') {
382 diff_free_filepair(pair
);
385 re
= xmalloc(sizeof(*re
));
388 item
= path_list_lookup(re
->pair
->one
->path
, entries
);
390 re
->src_entry
= insert_stage_data(re
->pair
->one
->path
,
391 o_tree
, a_tree
, b_tree
, entries
);
393 re
->src_entry
= item
->util
;
395 item
= path_list_lookup(re
->pair
->two
->path
, entries
);
397 re
->dst_entry
= insert_stage_data(re
->pair
->two
->path
,
398 o_tree
, a_tree
, b_tree
, entries
);
400 re
->dst_entry
= item
->util
;
401 item
= path_list_insert(pair
->one
->path
, renames
);
404 opts
.output_format
= DIFF_FORMAT_NO_OUTPUT
;
405 diff_queued_diff
.nr
= 0;
410 static int update_stages(const char *path
, struct diff_filespec
*o
,
411 struct diff_filespec
*a
, struct diff_filespec
*b
,
414 int options
= ADD_CACHE_OK_TO_ADD
| ADD_CACHE_OK_TO_REPLACE
;
416 if (remove_file_from_cache(path
))
419 if (add_cacheinfo(o
->mode
, o
->sha1
, path
, 1, 0, options
))
422 if (add_cacheinfo(a
->mode
, a
->sha1
, path
, 2, 0, options
))
425 if (add_cacheinfo(b
->mode
, b
->sha1
, path
, 3, 0, options
))
430 static int remove_path(const char *name
)
438 dirs
= xstrdup(name
);
439 while ((slash
= strrchr(name
, '/'))) {
441 if (rmdir(name
) != 0)
448 static int remove_file(int clean
, const char *path
, int no_wd
)
450 int update_cache
= index_only
|| clean
;
451 int update_working_directory
= !index_only
&& !no_wd
;
454 if (remove_file_from_cache(path
))
457 if (update_working_directory
) {
459 if (errno
!= ENOENT
|| errno
!= EISDIR
)
466 static char *unique_path(const char *path
, const char *branch
)
468 char *newpath
= xmalloc(strlen(path
) + 1 + strlen(branch
) + 8 + 1);
471 char *p
= newpath
+ strlen(path
);
472 strcpy(newpath
, path
);
478 while (path_list_has_path(¤t_file_set
, newpath
) ||
479 path_list_has_path(¤t_directory_set
, newpath
) ||
480 lstat(newpath
, &st
) == 0)
481 sprintf(p
, "_%d", suffix
++);
483 path_list_insert(newpath
, ¤t_file_set
);
487 static int mkdir_p(const char *path
, unsigned long mode
)
489 /* path points to cache entries, so xstrdup before messing with it */
490 char *buf
= xstrdup(path
);
491 int result
= safe_create_leading_directories(buf
);
496 static void flush_buffer(int fd
, const char *buf
, unsigned long size
)
499 long ret
= write_in_full(fd
, buf
, size
);
504 die("merge-recursive: %s", strerror(errno
));
506 die("merge-recursive: disk full?");
513 static int make_room_for_path(const char *path
)
516 const char *msg
= "failed to create path '%s'%s";
518 status
= mkdir_p(path
, 0777);
521 /* something else exists */
522 error(msg
, path
, ": perhaps a D/F conflict?");
528 /* Successful unlink is good.. */
531 /* .. and so is no existing file */
534 /* .. but not some other error (who really cares what?) */
535 return error(msg
, path
, ": perhaps a D/F conflict?");
538 static void update_file_flags(const unsigned char *sha
,
548 enum object_type type
;
552 if (S_ISGITLINK(mode
))
553 die("cannot read object %s '%s': It is a submodule!",
554 sha1_to_hex(sha
), path
);
556 buf
= read_sha1_file(sha
, &type
, &size
);
558 die("cannot read object %s '%s'", sha1_to_hex(sha
), path
);
559 if (type
!= OBJ_BLOB
)
560 die("blob expected for %s '%s'", sha1_to_hex(sha
), path
);
562 if (make_room_for_path(path
) < 0) {
566 if (S_ISREG(mode
) || (!has_symlinks
&& S_ISLNK(mode
))) {
572 fd
= open(path
, O_WRONLY
| O_TRUNC
| O_CREAT
, mode
);
574 die("failed to open %s: %s", path
, strerror(errno
));
575 flush_buffer(fd
, buf
, size
);
577 } else if (S_ISLNK(mode
)) {
578 char *lnk
= xmemdupz(buf
, size
);
584 die("do not know what to do with %06o %s '%s'",
585 mode
, sha1_to_hex(sha
), path
);
589 add_cacheinfo(mode
, sha
, path
, 0, update_wd
, ADD_CACHE_OK_TO_ADD
);
592 static void update_file(int clean
,
593 const unsigned char *sha
,
597 update_file_flags(sha
, mode
, path
, index_only
|| clean
, !index_only
);
600 /* Low level file merging, update and removal */
602 struct merge_file_info
604 unsigned char sha
[20];
610 static void fill_mm(const unsigned char *sha1
, mmfile_t
*mm
)
613 enum object_type type
;
615 if (!hashcmp(sha1
, null_sha1
)) {
616 mm
->ptr
= xstrdup("");
621 mm
->ptr
= read_sha1_file(sha1
, &type
, &size
);
622 if (!mm
->ptr
|| type
!= OBJ_BLOB
)
623 die("unable to read blob object %s", sha1_to_hex(sha1
));
628 * Customizable low-level merge drivers support.
631 struct ll_merge_driver
;
632 typedef int (*ll_merge_fn
)(const struct ll_merge_driver
*,
635 mmfile_t
*src1
, const char *name1
,
636 mmfile_t
*src2
, const char *name2
,
639 struct ll_merge_driver
{
641 const char *description
;
643 const char *recursive
;
644 struct ll_merge_driver
*next
;
649 * Built-in low-levels
651 static int ll_binary_merge(const struct ll_merge_driver
*drv_unused
,
652 const char *path_unused
,
654 mmfile_t
*src1
, const char *name1
,
655 mmfile_t
*src2
, const char *name2
,
659 * The tentative merge result is "ours" for the final round,
660 * or common ancestor for an internal merge. Still return
661 * "conflicted merge" status.
663 mmfile_t
*stolen
= index_only
? orig
: src1
;
665 result
->ptr
= stolen
->ptr
;
666 result
->size
= stolen
->size
;
671 static int ll_xdl_merge(const struct ll_merge_driver
*drv_unused
,
672 const char *path_unused
,
674 mmfile_t
*src1
, const char *name1
,
675 mmfile_t
*src2
, const char *name2
,
680 if (buffer_is_binary(orig
->ptr
, orig
->size
) ||
681 buffer_is_binary(src1
->ptr
, src1
->size
) ||
682 buffer_is_binary(src2
->ptr
, src2
->size
)) {
683 warning("Cannot merge binary files: %s vs. %s\n",
685 return ll_binary_merge(drv_unused
, path_unused
,
691 memset(&xpp
, 0, sizeof(xpp
));
692 return xdl_merge(orig
,
695 &xpp
, XDL_MERGE_ZEALOUS
,
699 static int ll_union_merge(const struct ll_merge_driver
*drv_unused
,
700 const char *path_unused
,
702 mmfile_t
*src1
, const char *name1
,
703 mmfile_t
*src2
, const char *name2
,
708 const int marker_size
= 7;
710 int status
= ll_xdl_merge(drv_unused
, path_unused
,
711 orig
, src1
, NULL
, src2
, NULL
, result
);
715 src
= dst
= result
->ptr
;
718 if ((marker_size
< size
) &&
719 (*src
== '<' || *src
== '=' || *src
== '>')) {
722 for (i
= 0; i
< marker_size
; i
++)
725 if (src
[marker_size
] != '\n')
727 src
+= marker_size
+ 1;
728 size
-= marker_size
+ 1;
736 } while (ch
!= '\n' && size
);
738 result
->size
= dst
- result
->ptr
;
742 #define LL_BINARY_MERGE 0
743 #define LL_TEXT_MERGE 1
744 #define LL_UNION_MERGE 2
745 static struct ll_merge_driver ll_merge_drv
[] = {
746 { "binary", "built-in binary merge", ll_binary_merge
},
747 { "text", "built-in 3-way text merge", ll_xdl_merge
},
748 { "union", "built-in union merge", ll_union_merge
},
751 static void create_temp(mmfile_t
*src
, char *path
)
755 strcpy(path
, ".merge_file_XXXXXX");
757 if (write_in_full(fd
, src
->ptr
, src
->size
) != src
->size
)
758 die("unable to write temp-file");
763 * User defined low-level merge driver support.
765 static int ll_ext_merge(const struct ll_merge_driver
*fn
,
768 mmfile_t
*src1
, const char *name1
,
769 mmfile_t
*src2
, const char *name2
,
774 struct interp table
[] = {
779 struct child_process child
;
780 const char *args
[20];
784 if (fn
->cmdline
== NULL
)
785 die("custom merge driver %s lacks command line.", fn
->name
);
789 create_temp(orig
, temp
[0]);
790 create_temp(src1
, temp
[1]);
791 create_temp(src2
, temp
[2]);
793 interp_set_entry(table
, 0, temp
[0]);
794 interp_set_entry(table
, 1, temp
[1]);
795 interp_set_entry(table
, 2, temp
[2]);
797 output(1, "merging %s using %s", path
,
798 fn
->description
? fn
->description
: fn
->name
);
800 interpolate(cmdbuf
, sizeof(cmdbuf
), fn
->cmdline
, table
, 3);
802 memset(&child
, 0, sizeof(child
));
809 status
= run_command(&child
);
810 if (status
< -ERR_RUN_COMMAND_FORK
)
811 ; /* failure in run-command */
814 fd
= open(temp
[1], O_RDONLY
);
819 result
->size
= st
.st_size
;
820 result
->ptr
= xmalloc(result
->size
+ 1);
821 if (read_in_full(fd
, result
->ptr
, result
->size
) != result
->size
) {
829 for (i
= 0; i
< 3; i
++)
835 * merge.default and merge.driver configuration items
837 static struct ll_merge_driver
*ll_user_merge
, **ll_user_merge_tail
;
838 static const char *default_ll_merge
;
840 static int read_merge_config(const char *var
, const char *value
)
842 struct ll_merge_driver
*fn
;
843 const char *ep
, *name
;
846 if (!strcmp(var
, "merge.default")) {
848 default_ll_merge
= strdup(value
);
853 * We are not interested in anything but "merge.<name>.variable";
854 * especially, we do not want to look at variables such as
855 * "merge.summary", "merge.tool", and "merge.verbosity".
857 if (prefixcmp(var
, "merge.") || (ep
= strrchr(var
, '.')) == var
+ 5)
861 * Find existing one as we might be processing merge.<name>.var2
862 * after seeing merge.<name>.var1.
866 for (fn
= ll_user_merge
; fn
; fn
= fn
->next
)
867 if (!strncmp(fn
->name
, name
, namelen
) && !fn
->name
[namelen
])
870 fn
= xcalloc(1, sizeof(struct ll_merge_driver
));
871 fn
->name
= xmemdupz(name
, namelen
);
872 fn
->fn
= ll_ext_merge
;
873 *ll_user_merge_tail
= fn
;
874 ll_user_merge_tail
= &(fn
->next
);
879 if (!strcmp("name", ep
)) {
881 return error("%s: lacks value", var
);
882 fn
->description
= strdup(value
);
886 if (!strcmp("driver", ep
)) {
888 return error("%s: lacks value", var
);
890 * merge.<name>.driver specifies the command line:
894 * The command-line will be interpolated with the following
895 * tokens and is given to the shell:
897 * %O - temporary file name for the merge base.
898 * %A - temporary file name for our version.
899 * %B - temporary file name for the other branches' version.
901 * The external merge driver should write the results in the
902 * file named by %A, and signal that it has done with zero exit
905 fn
->cmdline
= strdup(value
);
909 if (!strcmp("recursive", ep
)) {
911 return error("%s: lacks value", var
);
912 fn
->recursive
= strdup(value
);
919 static void initialize_ll_merge(void)
921 if (ll_user_merge_tail
)
923 ll_user_merge_tail
= &ll_user_merge
;
924 git_config(read_merge_config
);
927 static const struct ll_merge_driver
*find_ll_merge_driver(const char *merge_attr
)
929 struct ll_merge_driver
*fn
;
933 initialize_ll_merge();
935 if (ATTR_TRUE(merge_attr
))
936 return &ll_merge_drv
[LL_TEXT_MERGE
];
937 else if (ATTR_FALSE(merge_attr
))
938 return &ll_merge_drv
[LL_BINARY_MERGE
];
939 else if (ATTR_UNSET(merge_attr
)) {
940 if (!default_ll_merge
)
941 return &ll_merge_drv
[LL_TEXT_MERGE
];
943 name
= default_ll_merge
;
948 for (fn
= ll_user_merge
; fn
; fn
= fn
->next
)
949 if (!strcmp(fn
->name
, name
))
952 for (i
= 0; i
< ARRAY_SIZE(ll_merge_drv
); i
++)
953 if (!strcmp(ll_merge_drv
[i
].name
, name
))
954 return &ll_merge_drv
[i
];
956 /* default to the 3-way */
957 return &ll_merge_drv
[LL_TEXT_MERGE
];
960 static const char *git_path_check_merge(const char *path
)
962 static struct git_attr_check attr_merge_check
;
964 if (!attr_merge_check
.attr
)
965 attr_merge_check
.attr
= git_attr("merge", 5);
967 if (git_checkattr(path
, 1, &attr_merge_check
))
969 return attr_merge_check
.value
;
972 static int ll_merge(mmbuffer_t
*result_buf
,
973 struct diff_filespec
*o
,
974 struct diff_filespec
*a
,
975 struct diff_filespec
*b
,
979 mmfile_t orig
, src1
, src2
;
982 const char *ll_driver_name
;
983 const struct ll_merge_driver
*driver
;
985 name1
= xstrdup(mkpath("%s:%s", branch1
, a
->path
));
986 name2
= xstrdup(mkpath("%s:%s", branch2
, b
->path
));
988 fill_mm(o
->sha1
, &orig
);
989 fill_mm(a
->sha1
, &src1
);
990 fill_mm(b
->sha1
, &src2
);
992 ll_driver_name
= git_path_check_merge(a
->path
);
993 driver
= find_ll_merge_driver(ll_driver_name
);
995 if (index_only
&& driver
->recursive
)
996 driver
= find_ll_merge_driver(driver
->recursive
);
997 merge_status
= driver
->fn(driver
, a
->path
,
998 &orig
, &src1
, name1
, &src2
, name2
,
1006 return merge_status
;
1009 static struct merge_file_info
merge_file(struct diff_filespec
*o
,
1010 struct diff_filespec
*a
, struct diff_filespec
*b
,
1011 const char *branch1
, const char *branch2
)
1013 struct merge_file_info result
;
1017 if ((S_IFMT
& a
->mode
) != (S_IFMT
& b
->mode
)) {
1019 if (S_ISREG(a
->mode
)) {
1020 result
.mode
= a
->mode
;
1021 hashcpy(result
.sha
, a
->sha1
);
1023 result
.mode
= b
->mode
;
1024 hashcpy(result
.sha
, b
->sha1
);
1027 if (!sha_eq(a
->sha1
, o
->sha1
) && !sha_eq(b
->sha1
, o
->sha1
))
1030 result
.mode
= a
->mode
== o
->mode
? b
->mode
: a
->mode
;
1032 if (sha_eq(a
->sha1
, o
->sha1
))
1033 hashcpy(result
.sha
, b
->sha1
);
1034 else if (sha_eq(b
->sha1
, o
->sha1
))
1035 hashcpy(result
.sha
, a
->sha1
);
1036 else if (S_ISREG(a
->mode
)) {
1037 mmbuffer_t result_buf
;
1040 merge_status
= ll_merge(&result_buf
, o
, a
, b
,
1043 if ((merge_status
< 0) || !result_buf
.ptr
)
1044 die("Failed to execute internal merge");
1046 if (write_sha1_file(result_buf
.ptr
, result_buf
.size
,
1047 blob_type
, result
.sha
))
1048 die("Unable to add %s to database",
1051 free(result_buf
.ptr
);
1052 result
.clean
= (merge_status
== 0);
1053 } else if (S_ISGITLINK(a
->mode
)) {
1055 hashcpy(result
.sha
, a
->sha1
);
1056 } else if (S_ISLNK(a
->mode
)) {
1057 hashcpy(result
.sha
, a
->sha1
);
1059 if (!sha_eq(a
->sha1
, b
->sha1
))
1062 die("unsupported object type in the tree");
1069 static void conflict_rename_rename(struct rename
*ren1
,
1070 const char *branch1
,
1071 struct rename
*ren2
,
1072 const char *branch2
)
1076 const char *ren1_dst
= ren1
->pair
->two
->path
;
1077 const char *ren2_dst
= ren2
->pair
->two
->path
;
1078 const char *dst_name1
= ren1_dst
;
1079 const char *dst_name2
= ren2_dst
;
1080 if (path_list_has_path(¤t_directory_set
, ren1_dst
)) {
1081 dst_name1
= del
[delp
++] = unique_path(ren1_dst
, branch1
);
1082 output(1, "%s is a directory in %s added as %s instead",
1083 ren1_dst
, branch2
, dst_name1
);
1084 remove_file(0, ren1_dst
, 0);
1086 if (path_list_has_path(¤t_directory_set
, ren2_dst
)) {
1087 dst_name2
= del
[delp
++] = unique_path(ren2_dst
, branch2
);
1088 output(1, "%s is a directory in %s added as %s instead",
1089 ren2_dst
, branch1
, dst_name2
);
1090 remove_file(0, ren2_dst
, 0);
1093 remove_file_from_cache(dst_name1
);
1094 remove_file_from_cache(dst_name2
);
1096 * Uncomment to leave the conflicting names in the resulting tree
1098 * update_file(0, ren1->pair->two->sha1, ren1->pair->two->mode, dst_name1);
1099 * update_file(0, ren2->pair->two->sha1, ren2->pair->two->mode, dst_name2);
1102 update_stages(dst_name1
, NULL
, ren1
->pair
->two
, NULL
, 1);
1103 update_stages(dst_name2
, NULL
, NULL
, ren2
->pair
->two
, 1);
1109 static void conflict_rename_dir(struct rename
*ren1
,
1110 const char *branch1
)
1112 char *new_path
= unique_path(ren1
->pair
->two
->path
, branch1
);
1113 output(1, "Renamed %s to %s instead", ren1
->pair
->one
->path
, new_path
);
1114 remove_file(0, ren1
->pair
->two
->path
, 0);
1115 update_file(0, ren1
->pair
->two
->sha1
, ren1
->pair
->two
->mode
, new_path
);
1119 static void conflict_rename_rename_2(struct rename
*ren1
,
1120 const char *branch1
,
1121 struct rename
*ren2
,
1122 const char *branch2
)
1124 char *new_path1
= unique_path(ren1
->pair
->two
->path
, branch1
);
1125 char *new_path2
= unique_path(ren2
->pair
->two
->path
, branch2
);
1126 output(1, "Renamed %s to %s and %s to %s instead",
1127 ren1
->pair
->one
->path
, new_path1
,
1128 ren2
->pair
->one
->path
, new_path2
);
1129 remove_file(0, ren1
->pair
->two
->path
, 0);
1130 update_file(0, ren1
->pair
->two
->sha1
, ren1
->pair
->two
->mode
, new_path1
);
1131 update_file(0, ren2
->pair
->two
->sha1
, ren2
->pair
->two
->mode
, new_path2
);
1136 static int process_renames(struct path_list
*a_renames
,
1137 struct path_list
*b_renames
,
1138 const char *a_branch
,
1139 const char *b_branch
)
1141 int clean_merge
= 1, i
, j
;
1142 struct path_list a_by_dst
= {NULL
, 0, 0, 0}, b_by_dst
= {NULL
, 0, 0, 0};
1143 const struct rename
*sre
;
1145 for (i
= 0; i
< a_renames
->nr
; i
++) {
1146 sre
= a_renames
->items
[i
].util
;
1147 path_list_insert(sre
->pair
->two
->path
, &a_by_dst
)->util
1150 for (i
= 0; i
< b_renames
->nr
; i
++) {
1151 sre
= b_renames
->items
[i
].util
;
1152 path_list_insert(sre
->pair
->two
->path
, &b_by_dst
)->util
1156 for (i
= 0, j
= 0; i
< a_renames
->nr
|| j
< b_renames
->nr
;) {
1159 struct path_list
*renames1
, *renames2
, *renames2Dst
;
1160 struct rename
*ren1
= NULL
, *ren2
= NULL
;
1161 const char *branch1
, *branch2
;
1162 const char *ren1_src
, *ren1_dst
;
1164 if (i
>= a_renames
->nr
) {
1166 ren2
= b_renames
->items
[j
++].util
;
1167 } else if (j
>= b_renames
->nr
) {
1169 ren1
= a_renames
->items
[i
++].util
;
1171 compare
= strcmp(a_renames
->items
[i
].path
,
1172 b_renames
->items
[j
].path
);
1174 ren1
= a_renames
->items
[i
++].util
;
1176 ren2
= b_renames
->items
[j
++].util
;
1179 /* TODO: refactor, so that 1/2 are not needed */
1181 renames1
= a_renames
;
1182 renames2
= b_renames
;
1183 renames2Dst
= &b_by_dst
;
1188 renames1
= b_renames
;
1189 renames2
= a_renames
;
1190 renames2Dst
= &a_by_dst
;
1197 src
= ren1
->pair
->one
->path
;
1199 ren1
->dst_entry
->processed
= 1;
1200 ren1
->src_entry
->processed
= 1;
1202 if (ren1
->processed
)
1204 ren1
->processed
= 1;
1206 ren1_src
= ren1
->pair
->one
->path
;
1207 ren1_dst
= ren1
->pair
->two
->path
;
1210 const char *ren2_src
= ren2
->pair
->one
->path
;
1211 const char *ren2_dst
= ren2
->pair
->two
->path
;
1212 /* Renamed in 1 and renamed in 2 */
1213 if (strcmp(ren1_src
, ren2_src
) != 0)
1214 die("ren1.src != ren2.src");
1215 ren2
->dst_entry
->processed
= 1;
1216 ren2
->processed
= 1;
1217 if (strcmp(ren1_dst
, ren2_dst
) != 0) {
1219 output(1, "CONFLICT (rename/rename): "
1220 "Rename \"%s\"->\"%s\" in branch \"%s\" "
1221 "rename \"%s\"->\"%s\" in \"%s\"%s",
1222 src
, ren1_dst
, branch1
,
1223 src
, ren2_dst
, branch2
,
1224 index_only
? " (left unresolved)": "");
1226 remove_file_from_cache(src
);
1227 update_file(0, ren1
->pair
->one
->sha1
,
1228 ren1
->pair
->one
->mode
, src
);
1230 conflict_rename_rename(ren1
, branch1
, ren2
, branch2
);
1232 struct merge_file_info mfi
;
1233 remove_file(1, ren1_src
, 1);
1234 mfi
= merge_file(ren1
->pair
->one
,
1239 if (mfi
.merge
|| !mfi
.clean
)
1240 output(1, "Renamed %s->%s", src
, ren1_dst
);
1243 output(2, "Auto-merged %s", ren1_dst
);
1246 output(1, "CONFLICT (content): merge conflict in %s",
1251 update_stages(ren1_dst
,
1257 update_file(mfi
.clean
, mfi
.sha
, mfi
.mode
, ren1_dst
);
1260 /* Renamed in 1, maybe changed in 2 */
1261 struct path_list_item
*item
;
1262 /* we only use sha1 and mode of these */
1263 struct diff_filespec src_other
, dst_other
;
1264 int try_merge
, stage
= a_renames
== renames1
? 3: 2;
1266 remove_file(1, ren1_src
, index_only
|| stage
== 3);
1268 hashcpy(src_other
.sha1
, ren1
->src_entry
->stages
[stage
].sha
);
1269 src_other
.mode
= ren1
->src_entry
->stages
[stage
].mode
;
1270 hashcpy(dst_other
.sha1
, ren1
->dst_entry
->stages
[stage
].sha
);
1271 dst_other
.mode
= ren1
->dst_entry
->stages
[stage
].mode
;
1275 if (path_list_has_path(¤t_directory_set
, ren1_dst
)) {
1277 output(1, "CONFLICT (rename/directory): Renamed %s->%s in %s "
1278 " directory %s added in %s",
1279 ren1_src
, ren1_dst
, branch1
,
1281 conflict_rename_dir(ren1
, branch1
);
1282 } else if (sha_eq(src_other
.sha1
, null_sha1
)) {
1284 output(1, "CONFLICT (rename/delete): Renamed %s->%s in %s "
1285 "and deleted in %s",
1286 ren1_src
, ren1_dst
, branch1
,
1288 update_file(0, ren1
->pair
->two
->sha1
, ren1
->pair
->two
->mode
, ren1_dst
);
1289 } else if (!sha_eq(dst_other
.sha1
, null_sha1
)) {
1290 const char *new_path
;
1293 output(1, "CONFLICT (rename/add): Renamed %s->%s in %s. "
1295 ren1_src
, ren1_dst
, branch1
,
1297 new_path
= unique_path(ren1_dst
, branch2
);
1298 output(1, "Added as %s instead", new_path
);
1299 update_file(0, dst_other
.sha1
, dst_other
.mode
, new_path
);
1300 } else if ((item
= path_list_lookup(ren1_dst
, renames2Dst
))) {
1303 ren2
->processed
= 1;
1304 output(1, "CONFLICT (rename/rename): Renamed %s->%s in %s. "
1305 "Renamed %s->%s in %s",
1306 ren1_src
, ren1_dst
, branch1
,
1307 ren2
->pair
->one
->path
, ren2
->pair
->two
->path
, branch2
);
1308 conflict_rename_rename_2(ren1
, branch1
, ren2
, branch2
);
1313 struct diff_filespec
*o
, *a
, *b
;
1314 struct merge_file_info mfi
;
1315 src_other
.path
= (char *)ren1_src
;
1317 o
= ren1
->pair
->one
;
1318 if (a_renames
== renames1
) {
1319 a
= ren1
->pair
->two
;
1322 b
= ren1
->pair
->two
;
1325 mfi
= merge_file(o
, a
, b
,
1326 a_branch
, b_branch
);
1329 sha_eq(mfi
.sha
, ren1
->pair
->two
->sha1
) &&
1330 mfi
.mode
== ren1
->pair
->two
->mode
)
1332 * This messaged is part of
1333 * t6022 test. If you change
1334 * it update the test too.
1336 output(3, "Skipped %s (merged same as existing)", ren1_dst
);
1338 if (mfi
.merge
|| !mfi
.clean
)
1339 output(1, "Renamed %s => %s", ren1_src
, ren1_dst
);
1341 output(2, "Auto-merged %s", ren1_dst
);
1343 output(1, "CONFLICT (rename/modify): Merge conflict in %s",
1348 update_stages(ren1_dst
,
1351 update_file(mfi
.clean
, mfi
.sha
, mfi
.mode
, ren1_dst
);
1356 path_list_clear(&a_by_dst
, 0);
1357 path_list_clear(&b_by_dst
, 0);
1362 static unsigned char *stage_sha(const unsigned char *sha
, unsigned mode
)
1364 return (is_null_sha1(sha
) || mode
== 0) ? NULL
: (unsigned char *)sha
;
1367 /* Per entry merge function */
1368 static int process_entry(const char *path
, struct stage_data
*entry
,
1369 const char *branch1
,
1370 const char *branch2
)
1373 printf("processing entry, clean cache: %s\n", index_only ? "yes": "no");
1374 print_index_entry("\tpath: ", entry);
1376 int clean_merge
= 1;
1377 unsigned o_mode
= entry
->stages
[1].mode
;
1378 unsigned a_mode
= entry
->stages
[2].mode
;
1379 unsigned b_mode
= entry
->stages
[3].mode
;
1380 unsigned char *o_sha
= stage_sha(entry
->stages
[1].sha
, o_mode
);
1381 unsigned char *a_sha
= stage_sha(entry
->stages
[2].sha
, a_mode
);
1382 unsigned char *b_sha
= stage_sha(entry
->stages
[3].sha
, b_mode
);
1384 if (o_sha
&& (!a_sha
|| !b_sha
)) {
1385 /* Case A: Deleted in one */
1386 if ((!a_sha
&& !b_sha
) ||
1387 (sha_eq(a_sha
, o_sha
) && !b_sha
) ||
1388 (!a_sha
&& sha_eq(b_sha
, o_sha
))) {
1389 /* Deleted in both or deleted in one and
1390 * unchanged in the other */
1392 output(2, "Removed %s", path
);
1393 /* do not touch working file if it did not exist */
1394 remove_file(1, path
, !a_sha
);
1396 /* Deleted in one and changed in the other */
1399 output(1, "CONFLICT (delete/modify): %s deleted in %s "
1400 "and modified in %s. Version %s of %s left in tree.",
1402 branch2
, branch2
, path
);
1403 update_file(0, b_sha
, b_mode
, path
);
1405 output(1, "CONFLICT (delete/modify): %s deleted in %s "
1406 "and modified in %s. Version %s of %s left in tree.",
1408 branch1
, branch1
, path
);
1409 update_file(0, a_sha
, a_mode
, path
);
1413 } else if ((!o_sha
&& a_sha
&& !b_sha
) ||
1414 (!o_sha
&& !a_sha
&& b_sha
)) {
1415 /* Case B: Added in one. */
1416 const char *add_branch
;
1417 const char *other_branch
;
1419 const unsigned char *sha
;
1423 add_branch
= branch1
;
1424 other_branch
= branch2
;
1427 conf
= "file/directory";
1429 add_branch
= branch2
;
1430 other_branch
= branch1
;
1433 conf
= "directory/file";
1435 if (path_list_has_path(¤t_directory_set
, path
)) {
1436 const char *new_path
= unique_path(path
, add_branch
);
1438 output(1, "CONFLICT (%s): There is a directory with name %s in %s. "
1440 conf
, path
, other_branch
, path
, new_path
);
1441 remove_file(0, path
, 0);
1442 update_file(0, sha
, mode
, new_path
);
1444 output(2, "Added %s", path
);
1445 update_file(1, sha
, mode
, path
);
1447 } else if (a_sha
&& b_sha
) {
1448 /* Case C: Added in both (check for same permissions) and */
1449 /* case D: Modified in both, but differently. */
1450 const char *reason
= "content";
1451 struct merge_file_info mfi
;
1452 struct diff_filespec o
, a
, b
;
1456 o_sha
= (unsigned char *)null_sha1
;
1458 output(2, "Auto-merged %s", path
);
1459 o
.path
= a
.path
= b
.path
= (char *)path
;
1460 hashcpy(o
.sha1
, o_sha
);
1462 hashcpy(a
.sha1
, a_sha
);
1464 hashcpy(b
.sha1
, b_sha
);
1467 mfi
= merge_file(&o
, &a
, &b
,
1470 clean_merge
= mfi
.clean
;
1472 update_file(1, mfi
.sha
, mfi
.mode
, path
);
1473 else if (S_ISGITLINK(mfi
.mode
))
1474 output(1, "CONFLICT (submodule): Merge conflict in %s "
1475 "- needs %s", path
, sha1_to_hex(b
.sha1
));
1477 output(1, "CONFLICT (%s): Merge conflict in %s",
1481 update_file(0, mfi
.sha
, mfi
.mode
, path
);
1483 update_file_flags(mfi
.sha
, mfi
.mode
, path
,
1484 0 /* update_cache */, 1 /* update_working_directory */);
1486 } else if (!o_sha
&& !a_sha
&& !b_sha
) {
1488 * this entry was deleted altogether. a_mode == 0 means
1489 * we had that path and want to actively remove it.
1491 remove_file(1, path
, !a_mode
);
1493 die("Fatal merge failure, shouldn't happen.");
1498 static int merge_trees(struct tree
*head
,
1500 struct tree
*common
,
1501 const char *branch1
,
1502 const char *branch2
,
1503 struct tree
**result
)
1507 if (subtree_merge
) {
1508 merge
= shift_tree_object(head
, merge
);
1509 common
= shift_tree_object(head
, common
);
1512 if (sha_eq(common
->object
.sha1
, merge
->object
.sha1
)) {
1513 output(0, "Already uptodate!");
1518 code
= git_merge_trees(index_only
, common
, head
, merge
);
1521 die("merging of trees %s and %s failed",
1522 sha1_to_hex(head
->object
.sha1
),
1523 sha1_to_hex(merge
->object
.sha1
));
1525 if (unmerged_index()) {
1526 struct path_list
*entries
, *re_head
, *re_merge
;
1528 path_list_clear(¤t_file_set
, 1);
1529 path_list_clear(¤t_directory_set
, 1);
1530 get_files_dirs(head
);
1531 get_files_dirs(merge
);
1533 entries
= get_unmerged();
1534 re_head
= get_renames(head
, common
, head
, merge
, entries
);
1535 re_merge
= get_renames(merge
, common
, head
, merge
, entries
);
1536 clean
= process_renames(re_head
, re_merge
,
1538 for (i
= 0; i
< entries
->nr
; i
++) {
1539 const char *path
= entries
->items
[i
].path
;
1540 struct stage_data
*e
= entries
->items
[i
].util
;
1542 && !process_entry(path
, e
, branch1
, branch2
))
1546 path_list_clear(re_merge
, 0);
1547 path_list_clear(re_head
, 0);
1548 path_list_clear(entries
, 1);
1555 *result
= git_write_tree();
1560 static struct commit_list
*reverse_commit_list(struct commit_list
*list
)
1562 struct commit_list
*next
= NULL
, *current
, *backup
;
1563 for (current
= list
; current
; current
= backup
) {
1564 backup
= current
->next
;
1565 current
->next
= next
;
1572 * Merge the commits h1 and h2, return the resulting virtual
1573 * commit object and a flag indicating the cleanness of the merge.
1575 static int merge(struct commit
*h1
,
1577 const char *branch1
,
1578 const char *branch2
,
1579 struct commit_list
*ca
,
1580 struct commit
**result
)
1582 struct commit_list
*iter
;
1583 struct commit
*merged_common_ancestors
;
1584 struct tree
*mrtree
= mrtree
;
1588 output(4, "Merging:");
1589 output_commit_title(h1
);
1590 output_commit_title(h2
);
1594 ca
= get_merge_bases(h1
, h2
, 1);
1595 ca
= reverse_commit_list(ca
);
1599 output(5, "found %u common ancestor(s):", commit_list_count(ca
));
1600 for (iter
= ca
; iter
; iter
= iter
->next
)
1601 output_commit_title(iter
->item
);
1604 merged_common_ancestors
= pop_commit(&ca
);
1605 if (merged_common_ancestors
== NULL
) {
1606 /* if there is no common ancestor, make an empty tree */
1607 struct tree
*tree
= xcalloc(1, sizeof(struct tree
));
1609 tree
->object
.parsed
= 1;
1610 tree
->object
.type
= OBJ_TREE
;
1611 pretend_sha1_file(NULL
, 0, OBJ_TREE
, tree
->object
.sha1
);
1612 merged_common_ancestors
= make_virtual_commit(tree
, "ancestor");
1615 for (iter
= ca
; iter
; iter
= iter
->next
) {
1618 * When the merge fails, the result contains files
1619 * with conflict markers. The cleanness flag is
1620 * ignored, it was never actually used, as result of
1621 * merge_trees has always overwritten it: the committed
1622 * "conflicts" were already resolved.
1625 merge(merged_common_ancestors
, iter
->item
,
1626 "Temporary merge branch 1",
1627 "Temporary merge branch 2",
1629 &merged_common_ancestors
);
1632 if (!merged_common_ancestors
)
1633 die("merge returned no commit");
1643 clean
= merge_trees(h1
->tree
, h2
->tree
, merged_common_ancestors
->tree
,
1644 branch1
, branch2
, &mrtree
);
1647 *result
= make_virtual_commit(mrtree
, "merged tree");
1648 commit_list_insert(h1
, &(*result
)->parents
);
1649 commit_list_insert(h2
, &(*result
)->parents
->next
);
1655 static const char *better_branch_name(const char *branch
)
1657 static char githead_env
[8 + 40 + 1];
1660 if (strlen(branch
) != 40)
1662 sprintf(githead_env
, "GITHEAD_%s", branch
);
1663 name
= getenv(githead_env
);
1664 return name
? name
: branch
;
1667 static struct commit
*get_ref(const char *ref
)
1669 unsigned char sha1
[20];
1670 struct object
*object
;
1672 if (get_sha1(ref
, sha1
))
1673 die("Could not resolve ref '%s'", ref
);
1674 object
= deref_tag(parse_object(sha1
), ref
, strlen(ref
));
1675 if (object
->type
== OBJ_TREE
)
1676 return make_virtual_commit((struct tree
*)object
,
1677 better_branch_name(ref
));
1678 if (object
->type
!= OBJ_COMMIT
)
1680 if (parse_commit((struct commit
*)object
))
1681 die("Could not parse commit '%s'", sha1_to_hex(object
->sha1
));
1682 return (struct commit
*)object
;
1685 static int merge_config(const char *var
, const char *value
)
1687 if (!strcasecmp(var
, "merge.verbosity")) {
1688 verbosity
= git_config_int(var
, value
);
1691 if (!strcasecmp(var
, "diff.renamelimit")) {
1692 rename_limit
= git_config_int(var
, value
);
1695 return git_default_config(var
, value
);
1698 int main(int argc
, char *argv
[])
1700 static const char *bases
[20];
1701 static unsigned bases_count
= 0;
1703 const char *branch1
, *branch2
;
1704 struct commit
*result
, *h1
, *h2
;
1705 struct commit_list
*ca
= NULL
;
1706 struct lock_file
*lock
= xcalloc(1, sizeof(struct lock_file
));
1710 int namelen
= strlen(argv
[0]);
1712 !strcmp(argv
[0] + namelen
- 8, "-subtree"))
1716 git_config(merge_config
);
1717 if (getenv("GIT_MERGE_VERBOSITY"))
1718 verbosity
= strtol(getenv("GIT_MERGE_VERBOSITY"), NULL
, 10);
1721 die("Usage: %s <base>... -- <head> <remote> ...\n", argv
[0]);
1723 for (i
= 1; i
< argc
; ++i
) {
1724 if (!strcmp(argv
[i
], "--"))
1726 if (bases_count
< sizeof(bases
)/sizeof(*bases
))
1727 bases
[bases_count
++] = argv
[i
];
1729 if (argc
- i
!= 3) /* "--" "<head>" "<remote>" */
1730 die("Not handling anything other than two heads merge.");
1734 branch1
= argv
[++i
];
1735 branch2
= argv
[++i
];
1737 h1
= get_ref(branch1
);
1738 h2
= get_ref(branch2
);
1740 branch1
= better_branch_name(branch1
);
1741 branch2
= better_branch_name(branch2
);
1744 printf("Merging %s with %s\n", branch1
, branch2
);
1746 index_fd
= hold_locked_index(lock
, 1);
1748 for (i
= 0; i
< bases_count
; i
++) {
1749 struct commit
*ancestor
= get_ref(bases
[i
]);
1750 ca
= commit_list_insert(ancestor
, &ca
);
1752 clean
= merge(h1
, h2
, branch1
, branch2
, ca
, &result
);
1754 if (active_cache_changed
&&
1755 (write_cache(index_fd
, active_cache
, active_nr
) ||
1756 close(index_fd
) || commit_locked_index(lock
)))
1757 die ("unable to write %s", get_index_file());
1759 return clean
? 0: 1;