]>
Commit | Line | Data |
---|---|---|
df0b6cfb | 1 | #include "cache.h" |
4e853331 | 2 | #include "checkout.h" |
b2141fc1 | 3 | #include "config.h" |
df0b6cfb NTND |
4 | #include "builtin.h" |
5 | #include "dir.h" | |
6 | #include "parse-options.h" | |
fc56361f | 7 | #include "argv-array.h" |
f7c9dac1 ES |
8 | #include "branch.h" |
9 | #include "refs.h" | |
fc56361f | 10 | #include "run-command.h" |
b979d950 | 11 | #include "sigchain.h" |
00a6d4d1 | 12 | #include "submodule.h" |
799767cc | 13 | #include "refs.h" |
bb9c03b8 MR |
14 | #include "utf8.h" |
15 | #include "worktree.h" | |
df0b6cfb NTND |
16 | |
17 | static const char * const worktree_usage[] = { | |
b780e440 | 18 | N_("git worktree add [<options>] <path> [<commit-ish>]"), |
bb9c03b8 | 19 | N_("git worktree list [<options>]"), |
58142c09 | 20 | N_("git worktree lock [<options>] <path>"), |
9f792bb4 | 21 | N_("git worktree move <worktree> <new-path>"), |
7b722d90 | 22 | N_("git worktree prune [<options>]"), |
cc73385c | 23 | N_("git worktree remove [<options>] <worktree>"), |
6d308627 | 24 | N_("git worktree unlock <path>"), |
df0b6cfb NTND |
25 | NULL |
26 | }; | |
27 | ||
5dd6e234 ES |
28 | struct add_opts { |
29 | int force; | |
30 | int detach; | |
371979c2 | 31 | int quiet; |
ef2a0ac9 | 32 | int checkout; |
507e6e9e | 33 | int keep_locked; |
5dd6e234 ES |
34 | }; |
35 | ||
df0b6cfb NTND |
36 | static int show_only; |
37 | static int verbose; | |
e92445a7 | 38 | static int guess_remote; |
dddbad72 | 39 | static timestamp_t expire; |
df0b6cfb | 40 | |
e92445a7 TG |
41 | static int git_worktree_config(const char *var, const char *value, void *cb) |
42 | { | |
43 | if (!strcmp(var, "worktree.guessremote")) { | |
44 | guess_remote = git_config_bool(var, value); | |
45 | return 0; | |
46 | } | |
47 | ||
48 | return git_default_config(var, value, cb); | |
49 | } | |
50 | ||
602aaed0 | 51 | static int delete_git_dir(const char *id) |
e5353bef ES |
52 | { |
53 | struct strbuf sb = STRBUF_INIT; | |
602aaed0 | 54 | int ret; |
e5353bef | 55 | |
602aaed0 ES |
56 | strbuf_addstr(&sb, git_common_path("worktrees/%s", id)); |
57 | ret = remove_dir_recursively(&sb, 0); | |
58 | if (ret < 0 && errno == ENOTDIR) | |
59 | ret = unlink(sb.buf); | |
60 | if (ret) | |
e5353bef | 61 | error_errno(_("failed to delete '%s'"), sb.buf); |
e5353bef ES |
62 | strbuf_release(&sb); |
63 | return ret; | |
64 | } | |
65 | ||
3a540433 ES |
66 | static void delete_worktrees_dir_if_empty(void) |
67 | { | |
68 | rmdir(git_path("worktrees")); /* ignore failed removal */ | |
69 | } | |
70 | ||
df0b6cfb NTND |
71 | static int prune_worktree(const char *id, struct strbuf *reason) |
72 | { | |
73 | struct stat st; | |
74 | char *path; | |
228740b6 JK |
75 | int fd; |
76 | size_t len; | |
8a1a8d2a | 77 | ssize_t read_result; |
df0b6cfb NTND |
78 | |
79 | if (!is_directory(git_path("worktrees/%s", id))) { | |
80 | strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id); | |
81 | return 1; | |
82 | } | |
83 | if (file_exists(git_path("worktrees/%s/locked", id))) | |
84 | return 0; | |
85 | if (stat(git_path("worktrees/%s/gitdir", id), &st)) { | |
86 | strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id); | |
87 | return 1; | |
88 | } | |
89 | fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY); | |
90 | if (fd < 0) { | |
91 | strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"), | |
92 | id, strerror(errno)); | |
93 | return 1; | |
94 | } | |
228740b6 | 95 | len = xsize_t(st.st_size); |
3733e694 | 96 | path = xmallocz(len); |
8a1a8d2a JK |
97 | |
98 | read_result = read_in_full(fd, path, len); | |
99 | if (read_result < 0) { | |
100 | strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"), | |
101 | id, strerror(errno)); | |
102 | close(fd); | |
103 | free(path); | |
104 | return 1; | |
105 | } | |
df0b6cfb | 106 | close(fd); |
8a1a8d2a JK |
107 | |
108 | if (read_result != len) { | |
109 | strbuf_addf(reason, | |
110 | _("Removing worktrees/%s: short read (expected %"PRIuMAX" bytes, read %"PRIuMAX")"), | |
111 | id, (uintmax_t)len, (uintmax_t)read_result); | |
112 | free(path); | |
113 | return 1; | |
114 | } | |
df0b6cfb NTND |
115 | while (len && (path[len - 1] == '\n' || path[len - 1] == '\r')) |
116 | len--; | |
117 | if (!len) { | |
118 | strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id); | |
119 | free(path); | |
120 | return 1; | |
121 | } | |
122 | path[len] = '\0'; | |
123 | if (!file_exists(path)) { | |
df0b6cfb | 124 | free(path); |
327864aa NTND |
125 | if (stat(git_path("worktrees/%s/index", id), &st) || |
126 | st.st_mtime <= expire) { | |
df0b6cfb NTND |
127 | strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id); |
128 | return 1; | |
129 | } else { | |
130 | return 0; | |
131 | } | |
132 | } | |
133 | free(path); | |
134 | return 0; | |
135 | } | |
136 | ||
137 | static void prune_worktrees(void) | |
138 | { | |
139 | struct strbuf reason = STRBUF_INIT; | |
df0b6cfb NTND |
140 | DIR *dir = opendir(git_path("worktrees")); |
141 | struct dirent *d; | |
df0b6cfb NTND |
142 | if (!dir) |
143 | return; | |
144 | while ((d = readdir(dir)) != NULL) { | |
afb9e30b | 145 | if (is_dot_or_dotdot(d->d_name)) |
df0b6cfb NTND |
146 | continue; |
147 | strbuf_reset(&reason); | |
148 | if (!prune_worktree(d->d_name, &reason)) | |
149 | continue; | |
150 | if (show_only || verbose) | |
151 | printf("%s\n", reason.buf); | |
152 | if (show_only) | |
153 | continue; | |
602aaed0 | 154 | delete_git_dir(d->d_name); |
df0b6cfb NTND |
155 | } |
156 | closedir(dir); | |
157 | if (!show_only) | |
3a540433 | 158 | delete_worktrees_dir_if_empty(); |
df0b6cfb | 159 | strbuf_release(&reason); |
df0b6cfb NTND |
160 | } |
161 | ||
162 | static int prune(int ac, const char **av, const char *prefix) | |
163 | { | |
164 | struct option options[] = { | |
165 | OPT__DRY_RUN(&show_only, N_("do not remove, show only")), | |
2488dcab | 166 | OPT__VERBOSE(&verbose, N_("report pruned working trees")), |
df0b6cfb | 167 | OPT_EXPIRY_DATE(0, "expire", &expire, |
2488dcab | 168 | N_("expire working trees older than <time>")), |
df0b6cfb NTND |
169 | OPT_END() |
170 | }; | |
171 | ||
dddbad72 | 172 | expire = TIME_MAX; |
df0b6cfb NTND |
173 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); |
174 | if (ac) | |
175 | usage_with_options(worktree_usage, options); | |
176 | prune_worktrees(); | |
177 | return 0; | |
178 | } | |
179 | ||
b979d950 ES |
180 | static char *junk_work_tree; |
181 | static char *junk_git_dir; | |
182 | static int is_junk; | |
183 | static pid_t junk_pid; | |
184 | ||
185 | static void remove_junk(void) | |
186 | { | |
187 | struct strbuf sb = STRBUF_INIT; | |
188 | if (!is_junk || getpid() != junk_pid) | |
189 | return; | |
190 | if (junk_git_dir) { | |
191 | strbuf_addstr(&sb, junk_git_dir); | |
192 | remove_dir_recursively(&sb, 0); | |
193 | strbuf_reset(&sb); | |
194 | } | |
195 | if (junk_work_tree) { | |
196 | strbuf_addstr(&sb, junk_work_tree); | |
197 | remove_dir_recursively(&sb, 0); | |
198 | } | |
199 | strbuf_release(&sb); | |
200 | } | |
201 | ||
202 | static void remove_junk_on_signal(int signo) | |
203 | { | |
204 | remove_junk(); | |
205 | sigchain_pop(signo); | |
206 | raise(signo); | |
207 | } | |
208 | ||
f5682b2a ES |
209 | static const char *worktree_basename(const char *path, int *olen) |
210 | { | |
211 | const char *name; | |
212 | int len; | |
213 | ||
214 | len = strlen(path); | |
215 | while (len && is_dir_sep(path[len - 1])) | |
216 | len--; | |
217 | ||
218 | for (name = path + len - 1; name > path; name--) | |
219 | if (is_dir_sep(*name)) { | |
220 | name++; | |
221 | break; | |
222 | } | |
223 | ||
224 | *olen = len; | |
225 | return name; | |
226 | } | |
227 | ||
45059e64 ES |
228 | static void validate_worktree_add(const char *path, const struct add_opts *opts) |
229 | { | |
cb56f55c ES |
230 | struct worktree **worktrees; |
231 | struct worktree *wt; | |
232 | int locked; | |
233 | ||
45059e64 ES |
234 | if (file_exists(path) && !is_empty_dir(path)) |
235 | die(_("'%s' already exists"), path); | |
cb56f55c ES |
236 | |
237 | worktrees = get_worktrees(0); | |
238 | /* | |
239 | * find_worktree()'s suffix matching may undesirably find the main | |
240 | * rather than a linked worktree (for instance, when the basenames | |
241 | * of the main worktree and the one being created are the same). | |
242 | * We're only interested in linked worktrees, so skip the main | |
243 | * worktree with +1. | |
244 | */ | |
245 | wt = find_worktree(worktrees + 1, NULL, path); | |
246 | if (!wt) | |
247 | goto done; | |
248 | ||
d236f12b | 249 | locked = !!worktree_lock_reason(wt); |
e19831c9 ES |
250 | if ((!locked && opts->force) || (locked && opts->force > 1)) { |
251 | if (delete_git_dir(wt->id)) | |
252 | die(_("unable to re-add worktree '%s'"), path); | |
253 | goto done; | |
254 | } | |
255 | ||
cb56f55c | 256 | if (locked) |
e19831c9 | 257 | die(_("'%s' is a missing but locked worktree;\nuse 'add -f -f' to override, or 'unlock' and 'prune' or 'remove' to clear"), path); |
cb56f55c | 258 | else |
e19831c9 | 259 | die(_("'%s' is a missing but already registered worktree;\nuse 'add -f' to override, or 'prune' or 'remove' to clear"), path); |
cb56f55c ES |
260 | |
261 | done: | |
262 | free_worktrees(worktrees); | |
45059e64 ES |
263 | } |
264 | ||
80a0548f | 265 | static int add_worktree(const char *path, const char *refname, |
5dd6e234 | 266 | const struct add_opts *opts) |
b979d950 ES |
267 | { |
268 | struct strbuf sb_git = STRBUF_INIT, sb_repo = STRBUF_INIT; | |
269 | struct strbuf sb = STRBUF_INIT; | |
270 | const char *name; | |
271 | struct stat st; | |
542aa25d | 272 | struct child_process cp = CHILD_PROCESS_INIT; |
ae2a3827 | 273 | struct argv_array child_env = ARGV_ARRAY_INIT; |
b979d950 | 274 | int counter = 0, len, ret; |
f7c9dac1 ES |
275 | struct strbuf symref = STRBUF_INIT; |
276 | struct commit *commit = NULL; | |
ade546be | 277 | int is_branch = 0; |
b979d950 | 278 | |
45059e64 | 279 | validate_worktree_add(path, opts); |
b979d950 | 280 | |
f7c9dac1 | 281 | /* is 'refname' a branch or commit? */ |
0ebf4a2a | 282 | if (!opts->detach && !strbuf_check_branch_ref(&symref, refname) && |
ade546be ES |
283 | ref_exists(symref.buf)) { |
284 | is_branch = 1; | |
f7c9dac1 | 285 | if (!opts->force) |
8d9fdd70 | 286 | die_if_checked_out(symref.buf, 0); |
f7c9dac1 | 287 | } |
ade546be ES |
288 | commit = lookup_commit_reference_by_name(refname); |
289 | if (!commit) | |
290 | die(_("invalid reference: %s"), refname); | |
f7c9dac1 | 291 | |
f5682b2a | 292 | name = worktree_basename(path, &len); |
8c2ca3a6 | 293 | git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name), name); |
b979d950 ES |
294 | len = sb_repo.len; |
295 | if (safe_create_leading_directories_const(sb_repo.buf)) | |
296 | die_errno(_("could not create leading directories of '%s'"), | |
297 | sb_repo.buf); | |
298 | while (!stat(sb_repo.buf, &st)) { | |
299 | counter++; | |
300 | strbuf_setlen(&sb_repo, len); | |
301 | strbuf_addf(&sb_repo, "%d", counter); | |
302 | } | |
303 | name = strrchr(sb_repo.buf, '/') + 1; | |
304 | ||
305 | junk_pid = getpid(); | |
306 | atexit(remove_junk); | |
307 | sigchain_push_common(remove_junk_on_signal); | |
308 | ||
309 | if (mkdir(sb_repo.buf, 0777)) | |
310 | die_errno(_("could not create directory of '%s'"), sb_repo.buf); | |
311 | junk_git_dir = xstrdup(sb_repo.buf); | |
312 | is_junk = 1; | |
313 | ||
314 | /* | |
315 | * lock the incomplete repo so prune won't delete it, unlock | |
316 | * after the preparation is over. | |
317 | */ | |
318 | strbuf_addf(&sb, "%s/locked", sb_repo.buf); | |
507e6e9e NTND |
319 | if (!opts->keep_locked) |
320 | write_file(sb.buf, "initializing"); | |
321 | else | |
322 | write_file(sb.buf, "added with --lock"); | |
b979d950 ES |
323 | |
324 | strbuf_addf(&sb_git, "%s/.git", path); | |
325 | if (safe_create_leading_directories_const(sb_git.buf)) | |
326 | die_errno(_("could not create leading directories of '%s'"), | |
327 | sb_git.buf); | |
328 | junk_work_tree = xstrdup(path); | |
329 | ||
330 | strbuf_reset(&sb); | |
331 | strbuf_addf(&sb, "%s/gitdir", sb_repo.buf); | |
1f76a10b JH |
332 | write_file(sb.buf, "%s", real_path(sb_git.buf)); |
333 | write_file(sb_git.buf, "gitdir: %s/worktrees/%s", | |
b979d950 ES |
334 | real_path(get_git_common_dir()), name); |
335 | /* | |
336 | * This is to keep resolve_ref() happy. We need a valid HEAD | |
ed197a6a ES |
337 | * or is_git_directory() will reject the directory. Any value which |
338 | * looks like an object ID will do since it will be immediately | |
339 | * replaced by the symbolic-ref or update-ref invocation in the new | |
340 | * worktree. | |
b979d950 | 341 | */ |
b979d950 ES |
342 | strbuf_reset(&sb); |
343 | strbuf_addf(&sb, "%s/HEAD", sb_repo.buf); | |
dabd35f4 | 344 | write_file(sb.buf, "%s", sha1_to_hex(null_sha1)); |
b979d950 ES |
345 | strbuf_reset(&sb); |
346 | strbuf_addf(&sb, "%s/commondir", sb_repo.buf); | |
1f76a10b | 347 | write_file(sb.buf, "../.."); |
b979d950 | 348 | |
ae2a3827 ES |
349 | argv_array_pushf(&child_env, "%s=%s", GIT_DIR_ENVIRONMENT, sb_git.buf); |
350 | argv_array_pushf(&child_env, "%s=%s", GIT_WORK_TREE_ENVIRONMENT, path); | |
b979d950 | 351 | cp.git_cmd = 1; |
7f44e3d1 | 352 | |
ade546be | 353 | if (!is_branch) |
7f44e3d1 | 354 | argv_array_pushl(&cp.args, "update-ref", "HEAD", |
f2fd0760 | 355 | oid_to_hex(&commit->object.oid), NULL); |
371979c2 | 356 | else { |
7f44e3d1 ES |
357 | argv_array_pushl(&cp.args, "symbolic-ref", "HEAD", |
358 | symref.buf, NULL); | |
371979c2 EP |
359 | if (opts->quiet) |
360 | argv_array_push(&cp.args, "--quiet"); | |
361 | } | |
362 | ||
7f44e3d1 ES |
363 | cp.env = child_env.argv; |
364 | ret = run_command(&cp); | |
365 | if (ret) | |
366 | goto done; | |
367 | ||
ef2a0ac9 RZ |
368 | if (opts->checkout) { |
369 | cp.argv = NULL; | |
370 | argv_array_clear(&cp.args); | |
371 | argv_array_pushl(&cp.args, "reset", "--hard", NULL); | |
371979c2 EP |
372 | if (opts->quiet) |
373 | argv_array_push(&cp.args, "--quiet"); | |
ef2a0ac9 RZ |
374 | cp.env = child_env.argv; |
375 | ret = run_command(&cp); | |
376 | if (ret) | |
377 | goto done; | |
b979d950 | 378 | } |
ef2a0ac9 RZ |
379 | |
380 | is_junk = 0; | |
88ce3ef6 ÆAB |
381 | FREE_AND_NULL(junk_work_tree); |
382 | FREE_AND_NULL(junk_git_dir); | |
ef2a0ac9 | 383 | |
7f44e3d1 | 384 | done: |
507e6e9e NTND |
385 | if (ret || !opts->keep_locked) { |
386 | strbuf_reset(&sb); | |
387 | strbuf_addf(&sb, "%s/locked", sb_repo.buf); | |
388 | unlink_or_warn(sb.buf); | |
389 | } | |
ade546be ES |
390 | |
391 | /* | |
392 | * Hook failure does not warrant worktree deletion, so run hook after | |
393 | * is_junk is cleared, but do return appropriate code when hook fails. | |
394 | */ | |
a4bf1e3c ES |
395 | if (!ret && opts->checkout) { |
396 | const char *hook = find_hook("post-checkout"); | |
397 | if (hook) { | |
398 | const char *env[] = { "GIT_DIR", "GIT_WORK_TREE", NULL }; | |
399 | cp.git_cmd = 0; | |
400 | cp.no_stdin = 1; | |
401 | cp.stdout_to_stderr = 1; | |
402 | cp.dir = path; | |
403 | cp.env = env; | |
404 | cp.argv = NULL; | |
405 | argv_array_pushl(&cp.args, absolute_path(hook), | |
406 | oid_to_hex(&null_oid), | |
407 | oid_to_hex(&commit->object.oid), | |
408 | "1", NULL); | |
409 | ret = run_command(&cp); | |
410 | } | |
411 | } | |
ade546be | 412 | |
ae2a3827 | 413 | argv_array_clear(&child_env); |
b979d950 | 414 | strbuf_release(&sb); |
f7c9dac1 | 415 | strbuf_release(&symref); |
b979d950 ES |
416 | strbuf_release(&sb_repo); |
417 | strbuf_release(&sb_git); | |
418 | return ret; | |
419 | } | |
420 | ||
2c27002a TG |
421 | static void print_preparing_worktree_line(int detach, |
422 | const char *branch, | |
423 | const char *new_branch, | |
424 | int force_new_branch) | |
425 | { | |
426 | if (force_new_branch) { | |
427 | struct commit *commit = lookup_commit_reference_by_name(new_branch); | |
428 | if (!commit) | |
429 | printf_ln(_("Preparing worktree (new branch '%s')"), new_branch); | |
430 | else | |
431 | printf_ln(_("Preparing worktree (resetting branch '%s'; was at %s)"), | |
432 | new_branch, | |
10174da9 | 433 | find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV)); |
2c27002a TG |
434 | } else if (new_branch) { |
435 | printf_ln(_("Preparing worktree (new branch '%s')"), new_branch); | |
436 | } else { | |
437 | struct strbuf s = STRBUF_INIT; | |
438 | if (!detach && !strbuf_check_branch_ref(&s, branch) && | |
439 | ref_exists(s.buf)) | |
440 | printf_ln(_("Preparing worktree (checking out '%s')"), | |
441 | branch); | |
442 | else { | |
443 | struct commit *commit = lookup_commit_reference_by_name(branch); | |
444 | if (!commit) | |
445 | die(_("invalid reference: %s"), branch); | |
446 | printf_ln(_("Preparing worktree (detached HEAD %s)"), | |
10174da9 | 447 | find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV)); |
2c27002a TG |
448 | } |
449 | strbuf_release(&s); | |
450 | } | |
451 | } | |
452 | ||
6427f871 TG |
453 | static const char *dwim_branch(const char *path, const char **new_branch) |
454 | { | |
455 | int n; | |
456 | const char *s = worktree_basename(path, &n); | |
f60a7b76 TG |
457 | const char *branchname = xstrndup(s, n); |
458 | struct strbuf ref = STRBUF_INIT; | |
459 | ||
460 | UNLEAK(branchname); | |
461 | if (!strbuf_check_branch_ref(&ref, branchname) && | |
462 | ref_exists(ref.buf)) { | |
463 | strbuf_release(&ref); | |
464 | return branchname; | |
465 | } | |
466 | ||
467 | *new_branch = branchname; | |
6427f871 TG |
468 | if (guess_remote) { |
469 | struct object_id oid; | |
470 | const char *remote = | |
3c87aa94 | 471 | unique_tracking_name(*new_branch, &oid, NULL); |
6427f871 TG |
472 | return remote; |
473 | } | |
474 | return NULL; | |
475 | } | |
476 | ||
fc56361f ES |
477 | static int add(int ac, const char **av, const char *prefix) |
478 | { | |
5dd6e234 ES |
479 | struct add_opts opts; |
480 | const char *new_branch_force = NULL; | |
e4da43b1 JK |
481 | char *path; |
482 | const char *branch; | |
d861d34a | 483 | const char *new_branch = NULL; |
e284e892 | 484 | const char *opt_track = NULL; |
fc56361f | 485 | struct option options[] = { |
1224781d NTND |
486 | OPT__FORCE(&opts.force, |
487 | N_("checkout <branch> even if already checked out in other worktree"), | |
fc3d4e0c | 488 | PARSE_OPT_NOCOMPLETE), |
d861d34a | 489 | OPT_STRING('b', NULL, &new_branch, N_("branch"), |
cbdf60fa ES |
490 | N_("create a new branch")), |
491 | OPT_STRING('B', NULL, &new_branch_force, N_("branch"), | |
492 | N_("create or reset a branch")), | |
5dd6e234 | 493 | OPT_BOOL(0, "detach", &opts.detach, N_("detach HEAD at named commit")), |
ef2a0ac9 | 494 | OPT_BOOL(0, "checkout", &opts.checkout, N_("populate the new working tree")), |
507e6e9e | 495 | OPT_BOOL(0, "lock", &opts.keep_locked, N_("keep the new working tree locked")), |
371979c2 | 496 | OPT__QUIET(&opts.quiet, N_("suppress progress reporting")), |
e284e892 TG |
497 | OPT_PASSTHRU(0, "track", &opt_track, NULL, |
498 | N_("set up tracking mode (see git-branch(1))"), | |
499 | PARSE_OPT_NOARG | PARSE_OPT_OPTARG), | |
71d6682d TG |
500 | OPT_BOOL(0, "guess-remote", &guess_remote, |
501 | N_("try to match the new branch name with a remote-tracking branch")), | |
fc56361f ES |
502 | OPT_END() |
503 | }; | |
504 | ||
5dd6e234 | 505 | memset(&opts, 0, sizeof(opts)); |
ef2a0ac9 | 506 | opts.checkout = 1; |
fc56361f | 507 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); |
d861d34a | 508 | if (!!opts.detach + !!new_branch + !!new_branch_force > 1) |
ab0b2c53 | 509 | die(_("-b, -B, and --detach are mutually exclusive")); |
0f4af3b9 ES |
510 | if (ac < 1 || ac > 2) |
511 | usage_with_options(worktree_usage, options); | |
fc56361f | 512 | |
116fb64e | 513 | path = prefix_filename(prefix, av[0]); |
0f4af3b9 | 514 | branch = ac < 2 ? "HEAD" : av[1]; |
fc56361f | 515 | |
1a450e2f JDG |
516 | if (!strcmp(branch, "-")) |
517 | branch = "@{-1}"; | |
518 | ||
d861d34a | 519 | if (new_branch_force) { |
beb6f24b NTND |
520 | struct strbuf symref = STRBUF_INIT; |
521 | ||
d861d34a | 522 | new_branch = new_branch_force; |
eef005dc | 523 | |
beb6f24b | 524 | if (!opts.force && |
d861d34a | 525 | !strbuf_check_branch_ref(&symref, new_branch) && |
beb6f24b | 526 | ref_exists(symref.buf)) |
8d9fdd70 | 527 | die_if_checked_out(symref.buf, 0); |
beb6f24b NTND |
528 | strbuf_release(&symref); |
529 | } | |
530 | ||
d861d34a | 531 | if (ac < 2 && !new_branch && !opts.detach) { |
6427f871 TG |
532 | const char *s = dwim_branch(path, &new_branch); |
533 | if (s) | |
534 | branch = s; | |
1eb07d82 ES |
535 | } |
536 | ||
d861d34a | 537 | if (ac == 2 && !new_branch && !opts.detach) { |
4e853331 TG |
538 | struct object_id oid; |
539 | struct commit *commit; | |
540 | const char *remote; | |
541 | ||
542 | commit = lookup_commit_reference_by_name(branch); | |
543 | if (!commit) { | |
3c87aa94 | 544 | remote = unique_tracking_name(branch, &oid, NULL); |
4e853331 | 545 | if (remote) { |
d861d34a | 546 | new_branch = branch; |
4e853331 TG |
547 | branch = remote; |
548 | } | |
549 | } | |
550 | } | |
371979c2 EP |
551 | if (!opts.quiet) |
552 | print_preparing_worktree_line(opts.detach, branch, new_branch, !!new_branch_force); | |
2c27002a | 553 | |
d861d34a | 554 | if (new_branch) { |
542aa25d | 555 | struct child_process cp = CHILD_PROCESS_INIT; |
c2842439 ES |
556 | cp.git_cmd = 1; |
557 | argv_array_push(&cp.args, "branch"); | |
d861d34a | 558 | if (new_branch_force) |
c2842439 | 559 | argv_array_push(&cp.args, "--force"); |
371979c2 EP |
560 | if (opts.quiet) |
561 | argv_array_push(&cp.args, "--quiet"); | |
d861d34a | 562 | argv_array_push(&cp.args, new_branch); |
c2842439 | 563 | argv_array_push(&cp.args, branch); |
e284e892 TG |
564 | if (opt_track) |
565 | argv_array_push(&cp.args, opt_track); | |
c2842439 ES |
566 | if (run_command(&cp)) |
567 | return -1; | |
d861d34a | 568 | branch = new_branch; |
e284e892 TG |
569 | } else if (opt_track) { |
570 | die(_("--[no-]track can only be used if a new branch is created")); | |
1eb07d82 ES |
571 | } |
572 | ||
0e5bba53 JK |
573 | UNLEAK(path); |
574 | UNLEAK(opts); | |
80a0548f | 575 | return add_worktree(path, branch, &opts); |
fc56361f ES |
576 | } |
577 | ||
bb9c03b8 MR |
578 | static void show_worktree_porcelain(struct worktree *wt) |
579 | { | |
580 | printf("worktree %s\n", wt->path); | |
581 | if (wt->is_bare) | |
582 | printf("bare\n"); | |
583 | else { | |
0f05154c | 584 | printf("HEAD %s\n", oid_to_hex(&wt->head_oid)); |
bb9c03b8 MR |
585 | if (wt->is_detached) |
586 | printf("detached\n"); | |
a234563a | 587 | else if (wt->head_ref) |
bb9c03b8 MR |
588 | printf("branch %s\n", wt->head_ref); |
589 | } | |
590 | printf("\n"); | |
591 | } | |
592 | ||
593 | static void show_worktree(struct worktree *wt, int path_maxlen, int abbrev_len) | |
594 | { | |
595 | struct strbuf sb = STRBUF_INIT; | |
596 | int cur_path_len = strlen(wt->path); | |
597 | int path_adj = cur_path_len - utf8_strwidth(wt->path); | |
598 | ||
599 | strbuf_addf(&sb, "%-*s ", 1 + path_maxlen + path_adj, wt->path); | |
600 | if (wt->is_bare) | |
601 | strbuf_addstr(&sb, "(bare)"); | |
602 | else { | |
603 | strbuf_addf(&sb, "%-*s ", abbrev_len, | |
aab9583f | 604 | find_unique_abbrev(&wt->head_oid, DEFAULT_ABBREV)); |
96f09e2a | 605 | if (wt->is_detached) |
bb9c03b8 | 606 | strbuf_addstr(&sb, "(detached HEAD)"); |
2e11f58f JS |
607 | else if (wt->head_ref) { |
608 | char *ref = shorten_unambiguous_ref(wt->head_ref, 0); | |
609 | strbuf_addf(&sb, "[%s]", ref); | |
610 | free(ref); | |
611 | } else | |
a234563a | 612 | strbuf_addstr(&sb, "(error)"); |
bb9c03b8 MR |
613 | } |
614 | printf("%s\n", sb.buf); | |
615 | ||
616 | strbuf_release(&sb); | |
617 | } | |
618 | ||
619 | static void measure_widths(struct worktree **wt, int *abbrev, int *maxlen) | |
620 | { | |
621 | int i; | |
622 | ||
623 | for (i = 0; wt[i]; i++) { | |
624 | int sha1_len; | |
625 | int path_len = strlen(wt[i]->path); | |
626 | ||
627 | if (path_len > *maxlen) | |
628 | *maxlen = path_len; | |
aab9583f | 629 | sha1_len = strlen(find_unique_abbrev(&wt[i]->head_oid, *abbrev)); |
bb9c03b8 MR |
630 | if (sha1_len > *abbrev) |
631 | *abbrev = sha1_len; | |
632 | } | |
633 | } | |
634 | ||
635 | static int list(int ac, const char **av, const char *prefix) | |
636 | { | |
637 | int porcelain = 0; | |
638 | ||
639 | struct option options[] = { | |
640 | OPT_BOOL(0, "porcelain", &porcelain, N_("machine-readable output")), | |
641 | OPT_END() | |
642 | }; | |
643 | ||
644 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); | |
645 | if (ac) | |
646 | usage_with_options(worktree_usage, options); | |
647 | else { | |
4df1d4d4 | 648 | struct worktree **worktrees = get_worktrees(GWT_SORT_LINKED); |
bb9c03b8 MR |
649 | int path_maxlen = 0, abbrev = DEFAULT_ABBREV, i; |
650 | ||
651 | if (!porcelain) | |
652 | measure_widths(worktrees, &abbrev, &path_maxlen); | |
653 | ||
654 | for (i = 0; worktrees[i]; i++) { | |
655 | if (porcelain) | |
656 | show_worktree_porcelain(worktrees[i]); | |
657 | else | |
658 | show_worktree(worktrees[i], path_maxlen, abbrev); | |
659 | } | |
660 | free_worktrees(worktrees); | |
661 | } | |
662 | return 0; | |
663 | } | |
664 | ||
58142c09 NTND |
665 | static int lock_worktree(int ac, const char **av, const char *prefix) |
666 | { | |
667 | const char *reason = "", *old_reason; | |
668 | struct option options[] = { | |
669 | OPT_STRING(0, "reason", &reason, N_("string"), | |
670 | N_("reason for locking")), | |
671 | OPT_END() | |
672 | }; | |
673 | struct worktree **worktrees, *wt; | |
674 | ||
675 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); | |
676 | if (ac != 1) | |
677 | usage_with_options(worktree_usage, options); | |
678 | ||
4fff1ef7 | 679 | worktrees = get_worktrees(0); |
58142c09 NTND |
680 | wt = find_worktree(worktrees, prefix, av[0]); |
681 | if (!wt) | |
682 | die(_("'%s' is not a working tree"), av[0]); | |
683 | if (is_main_worktree(wt)) | |
684 | die(_("The main working tree cannot be locked or unlocked")); | |
685 | ||
d236f12b | 686 | old_reason = worktree_lock_reason(wt); |
58142c09 NTND |
687 | if (old_reason) { |
688 | if (*old_reason) | |
689 | die(_("'%s' is already locked, reason: %s"), | |
690 | av[0], old_reason); | |
691 | die(_("'%s' is already locked"), av[0]); | |
692 | } | |
693 | ||
694 | write_file(git_common_path("worktrees/%s/locked", wt->id), | |
695 | "%s", reason); | |
696 | free_worktrees(worktrees); | |
697 | return 0; | |
698 | } | |
699 | ||
6d308627 NTND |
700 | static int unlock_worktree(int ac, const char **av, const char *prefix) |
701 | { | |
702 | struct option options[] = { | |
703 | OPT_END() | |
704 | }; | |
705 | struct worktree **worktrees, *wt; | |
706 | int ret; | |
707 | ||
708 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); | |
709 | if (ac != 1) | |
710 | usage_with_options(worktree_usage, options); | |
711 | ||
4fff1ef7 | 712 | worktrees = get_worktrees(0); |
6d308627 NTND |
713 | wt = find_worktree(worktrees, prefix, av[0]); |
714 | if (!wt) | |
715 | die(_("'%s' is not a working tree"), av[0]); | |
716 | if (is_main_worktree(wt)) | |
717 | die(_("The main working tree cannot be locked or unlocked")); | |
d236f12b | 718 | if (!worktree_lock_reason(wt)) |
6d308627 NTND |
719 | die(_("'%s' is not locked"), av[0]); |
720 | ret = unlink_or_warn(git_common_path("worktrees/%s/locked", wt->id)); | |
721 | free_worktrees(worktrees); | |
722 | return ret; | |
723 | } | |
724 | ||
78d986b2 NTND |
725 | static void validate_no_submodules(const struct worktree *wt) |
726 | { | |
727 | struct index_state istate = { NULL }; | |
00a6d4d1 | 728 | struct strbuf path = STRBUF_INIT; |
78d986b2 NTND |
729 | int i, found_submodules = 0; |
730 | ||
00a6d4d1 NTND |
731 | if (is_directory(worktree_git_path(wt, "modules"))) { |
732 | /* | |
733 | * There could be false positives, e.g. the "modules" | |
734 | * directory exists but is empty. But it's a rare case and | |
735 | * this simpler check is probably good enough for now. | |
736 | */ | |
737 | found_submodules = 1; | |
738 | } else if (read_index_from(&istate, worktree_git_path(wt, "index"), | |
739 | get_worktree_git_dir(wt)) > 0) { | |
78d986b2 NTND |
740 | for (i = 0; i < istate.cache_nr; i++) { |
741 | struct cache_entry *ce = istate.cache[i]; | |
00a6d4d1 | 742 | int err; |
78d986b2 | 743 | |
00a6d4d1 NTND |
744 | if (!S_ISGITLINK(ce->ce_mode)) |
745 | continue; | |
746 | ||
747 | strbuf_reset(&path); | |
748 | strbuf_addf(&path, "%s/%s", wt->path, ce->name); | |
749 | if (!is_submodule_populated_gently(path.buf, &err)) | |
750 | continue; | |
751 | ||
752 | found_submodules = 1; | |
753 | break; | |
78d986b2 NTND |
754 | } |
755 | } | |
756 | discard_index(&istate); | |
00a6d4d1 | 757 | strbuf_release(&path); |
78d986b2 NTND |
758 | |
759 | if (found_submodules) | |
cc73385c | 760 | die(_("working trees containing submodules cannot be moved or removed")); |
78d986b2 NTND |
761 | } |
762 | ||
9f792bb4 NTND |
763 | static int move_worktree(int ac, const char **av, const char *prefix) |
764 | { | |
68a6b3a1 | 765 | int force = 0; |
9f792bb4 | 766 | struct option options[] = { |
68a6b3a1 ES |
767 | OPT__FORCE(&force, |
768 | N_("force move even if worktree is dirty or locked"), | |
769 | PARSE_OPT_NOCOMPLETE), | |
9f792bb4 NTND |
770 | OPT_END() |
771 | }; | |
772 | struct worktree **worktrees, *wt; | |
773 | struct strbuf dst = STRBUF_INIT; | |
774 | struct strbuf errmsg = STRBUF_INIT; | |
68a6b3a1 | 775 | const char *reason = NULL; |
9f792bb4 NTND |
776 | char *path; |
777 | ||
778 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); | |
779 | if (ac != 2) | |
780 | usage_with_options(worktree_usage, options); | |
781 | ||
782 | path = prefix_filename(prefix, av[1]); | |
783 | strbuf_addstr(&dst, path); | |
784 | free(path); | |
785 | ||
786 | worktrees = get_worktrees(0); | |
787 | wt = find_worktree(worktrees, prefix, av[0]); | |
788 | if (!wt) | |
789 | die(_("'%s' is not a working tree"), av[0]); | |
790 | if (is_main_worktree(wt)) | |
791 | die(_("'%s' is a main working tree"), av[0]); | |
c64a8d20 NTND |
792 | if (is_directory(dst.buf)) { |
793 | const char *sep = find_last_dir_sep(wt->path); | |
794 | ||
795 | if (!sep) | |
796 | die(_("could not figure out destination name from '%s'"), | |
797 | wt->path); | |
798 | strbuf_trim_trailing_dir_sep(&dst); | |
799 | strbuf_addstr(&dst, sep); | |
800 | } | |
9f792bb4 | 801 | if (file_exists(dst.buf)) |
c64a8d20 | 802 | die(_("target '%s' already exists"), dst.buf); |
9f792bb4 | 803 | |
78d986b2 NTND |
804 | validate_no_submodules(wt); |
805 | ||
68a6b3a1 | 806 | if (force < 2) |
d236f12b | 807 | reason = worktree_lock_reason(wt); |
9f792bb4 NTND |
808 | if (reason) { |
809 | if (*reason) | |
68a6b3a1 | 810 | die(_("cannot move a locked working tree, lock reason: %s\nuse 'move -f -f' to override or unlock first"), |
9f792bb4 | 811 | reason); |
68a6b3a1 | 812 | die(_("cannot move a locked working tree;\nuse 'move -f -f' to override or unlock first")); |
9f792bb4 | 813 | } |
ee6763af | 814 | if (validate_worktree(wt, &errmsg, 0)) |
9f792bb4 NTND |
815 | die(_("validation failed, cannot move working tree: %s"), |
816 | errmsg.buf); | |
817 | strbuf_release(&errmsg); | |
818 | ||
819 | if (rename(wt->path, dst.buf) == -1) | |
820 | die_errno(_("failed to move '%s' to '%s'"), wt->path, dst.buf); | |
821 | ||
822 | update_worktree_location(wt, dst.buf); | |
823 | ||
824 | strbuf_release(&dst); | |
825 | free_worktrees(worktrees); | |
826 | return 0; | |
827 | } | |
828 | ||
cc73385c NTND |
829 | /* |
830 | * Note, "git status --porcelain" is used to determine if it's safe to | |
831 | * delete a whole worktree. "git status" does not ignore user | |
832 | * configuration, so if a normal "git status" shows "clean" for the | |
833 | * user, then it's ok to remove it. | |
834 | * | |
835 | * This assumption may be a bad one. We may want to ignore | |
836 | * (potentially bad) user settings and only delete a worktree when | |
837 | * it's absolutely safe to do so from _our_ point of view because we | |
838 | * know better. | |
839 | */ | |
840 | static void check_clean_worktree(struct worktree *wt, | |
841 | const char *original_path) | |
842 | { | |
843 | struct argv_array child_env = ARGV_ARRAY_INIT; | |
844 | struct child_process cp; | |
845 | char buf[1]; | |
846 | int ret; | |
847 | ||
848 | /* | |
849 | * Until we sort this out, all submodules are "dirty" and | |
850 | * will abort this function. | |
851 | */ | |
852 | validate_no_submodules(wt); | |
853 | ||
854 | argv_array_pushf(&child_env, "%s=%s/.git", | |
855 | GIT_DIR_ENVIRONMENT, wt->path); | |
856 | argv_array_pushf(&child_env, "%s=%s", | |
857 | GIT_WORK_TREE_ENVIRONMENT, wt->path); | |
858 | memset(&cp, 0, sizeof(cp)); | |
859 | argv_array_pushl(&cp.args, "status", | |
860 | "--porcelain", "--ignore-submodules=none", | |
861 | NULL); | |
862 | cp.env = child_env.argv; | |
863 | cp.git_cmd = 1; | |
864 | cp.dir = wt->path; | |
865 | cp.out = -1; | |
866 | ret = start_command(&cp); | |
867 | if (ret) | |
868 | die_errno(_("failed to run 'git status' on '%s'"), | |
869 | original_path); | |
870 | ret = xread(cp.out, buf, sizeof(buf)); | |
871 | if (ret) | |
872 | die(_("'%s' is dirty, use --force to delete it"), | |
873 | original_path); | |
874 | close(cp.out); | |
875 | ret = finish_command(&cp); | |
876 | if (ret) | |
877 | die_errno(_("failed to run 'git status' on '%s', code %d"), | |
878 | original_path, ret); | |
879 | } | |
880 | ||
881 | static int delete_git_work_tree(struct worktree *wt) | |
882 | { | |
883 | struct strbuf sb = STRBUF_INIT; | |
884 | int ret = 0; | |
885 | ||
886 | strbuf_addstr(&sb, wt->path); | |
887 | if (remove_dir_recursively(&sb, 0)) { | |
888 | error_errno(_("failed to delete '%s'"), sb.buf); | |
889 | ret = -1; | |
890 | } | |
891 | strbuf_release(&sb); | |
892 | return ret; | |
893 | } | |
894 | ||
cc73385c NTND |
895 | static int remove_worktree(int ac, const char **av, const char *prefix) |
896 | { | |
897 | int force = 0; | |
898 | struct option options[] = { | |
d228eea5 | 899 | OPT__FORCE(&force, |
f4143101 | 900 | N_("force removal even if worktree is dirty or locked"), |
d228eea5 | 901 | PARSE_OPT_NOCOMPLETE), |
cc73385c NTND |
902 | OPT_END() |
903 | }; | |
904 | struct worktree **worktrees, *wt; | |
905 | struct strbuf errmsg = STRBUF_INIT; | |
f4143101 | 906 | const char *reason = NULL; |
cc73385c NTND |
907 | int ret = 0; |
908 | ||
909 | ac = parse_options(ac, av, prefix, options, worktree_usage, 0); | |
910 | if (ac != 1) | |
911 | usage_with_options(worktree_usage, options); | |
912 | ||
913 | worktrees = get_worktrees(0); | |
914 | wt = find_worktree(worktrees, prefix, av[0]); | |
915 | if (!wt) | |
916 | die(_("'%s' is not a working tree"), av[0]); | |
917 | if (is_main_worktree(wt)) | |
918 | die(_("'%s' is a main working tree"), av[0]); | |
f4143101 | 919 | if (force < 2) |
d236f12b | 920 | reason = worktree_lock_reason(wt); |
cc73385c NTND |
921 | if (reason) { |
922 | if (*reason) | |
f4143101 | 923 | die(_("cannot remove a locked working tree, lock reason: %s\nuse 'remove -f -f' to override or unlock first"), |
cc73385c | 924 | reason); |
f4143101 | 925 | die(_("cannot remove a locked working tree;\nuse 'remove -f -f' to override or unlock first")); |
cc73385c | 926 | } |
ee6763af | 927 | if (validate_worktree(wt, &errmsg, WT_VALIDATE_WORKTREE_MISSING_OK)) |
cc73385c NTND |
928 | die(_("validation failed, cannot remove working tree: %s"), |
929 | errmsg.buf); | |
930 | strbuf_release(&errmsg); | |
931 | ||
ee6763af NTND |
932 | if (file_exists(wt->path)) { |
933 | if (!force) | |
934 | check_clean_worktree(wt, av[0]); | |
cc73385c | 935 | |
ee6763af NTND |
936 | ret |= delete_git_work_tree(wt); |
937 | } | |
cc73385c NTND |
938 | /* |
939 | * continue on even if ret is non-zero, there's no going back | |
940 | * from here. | |
941 | */ | |
602aaed0 | 942 | ret |= delete_git_dir(wt->id); |
3a540433 | 943 | delete_worktrees_dir_if_empty(); |
cc73385c NTND |
944 | |
945 | free_worktrees(worktrees); | |
946 | return ret; | |
947 | } | |
948 | ||
df0b6cfb NTND |
949 | int cmd_worktree(int ac, const char **av, const char *prefix) |
950 | { | |
951 | struct option options[] = { | |
952 | OPT_END() | |
953 | }; | |
954 | ||
e92445a7 | 955 | git_config(git_worktree_config, NULL); |
d49028e6 | 956 | |
df0b6cfb NTND |
957 | if (ac < 2) |
958 | usage_with_options(worktree_usage, options); | |
0409e0b6 NTND |
959 | if (!prefix) |
960 | prefix = ""; | |
fc56361f ES |
961 | if (!strcmp(av[1], "add")) |
962 | return add(ac - 1, av + 1, prefix); | |
df0b6cfb NTND |
963 | if (!strcmp(av[1], "prune")) |
964 | return prune(ac - 1, av + 1, prefix); | |
bb9c03b8 MR |
965 | if (!strcmp(av[1], "list")) |
966 | return list(ac - 1, av + 1, prefix); | |
58142c09 NTND |
967 | if (!strcmp(av[1], "lock")) |
968 | return lock_worktree(ac - 1, av + 1, prefix); | |
6d308627 NTND |
969 | if (!strcmp(av[1], "unlock")) |
970 | return unlock_worktree(ac - 1, av + 1, prefix); | |
9f792bb4 NTND |
971 | if (!strcmp(av[1], "move")) |
972 | return move_worktree(ac - 1, av + 1, prefix); | |
cc73385c NTND |
973 | if (!strcmp(av[1], "remove")) |
974 | return remove_worktree(ac - 1, av + 1, prefix); | |
df0b6cfb NTND |
975 | usage_with_options(worktree_usage, options); |
976 | } |