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