git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2 13/23] worktree: introduce "add" command

From
Eric Sunshine <sunshine@sunshineco.com>
Date
Jul 4, 2015, 00:17 UTC
Message-ID
<1435969052-540-14-git-send-email-sunshine@sunshineco.com>
In-Reply-To
<1435969052-540-1-git-send-email-sunshine@sunshineco.com>

The plan is to relocate "git checkout --to" functionality to "git worktree add". As a first step, introduce a bare-bones git-worktree "add" command along with documentation. At this stage, "git worktree add" merely invokes "git checkout --to" behind the scenes, but an upcoming patch will move the actual functionality (checkout.c:prepare_linked_checkout() and its helpers) to worktree.c.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
---
 Documentation/git-worktree.txt | 21 +++++++++++----------
 builtin/worktree.c             | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 028bbd9..59191f9 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -9,13 +9,13 @@ git-worktree - Manage multiple worktrees
 SYNOPSIS
 --------
 [verse]
+'git worktree add' <path> <branch>
 'git worktree prune' [-n] [-v] [--expire <expire>]
 
 DESCRIPTION
 -----------
 
-Manage multiple worktrees attached to the same repository. These are
-created by the command `git checkout --to`.
+Manage multiple worktrees attached to the same repository.
 
 A git repository can support multiple working trees, allowing you to check
 out more than one branch at a time.  With `git checkout --to` a new working
@@ -45,6 +45,13 @@ pruning should be suppressed. See section "DETAILS" for more information.
 
 COMMANDS
 --------
+add <path> <branch>::
+
+Check out `<branch>` into a separate working directory, `<path>`, creating
+`<path>` if necessary. The new working directory is linked to the current
+repository, sharing everything except working directory specific files
+such as HEAD, index, etc. If `<path>` already exists, it must be empty.
+
 prune::
 
 Prune working tree information in $GIT_DIR/worktrees.
@@ -118,7 +125,7 @@ refactoring session.
 
 ------------
 $ git branch emergency-fix master
-$ git checkout --to ../temp emergency-fix
+$ git worktree add ../temp emergency-fix
 $ pushd ../temp
 # ... hack hack hack ...
 $ git commit -a -m 'emergency fix for boss'
@@ -133,20 +140,14 @@ Multiple checkout support for submodules is incomplete. It is NOT
 recommended to make multiple checkouts of a superproject.
 
 git-worktree could provide more automation for tasks currently
-performed manually or via other commands, such as:
+performed manually, such as:
 
-- `add` to create a new linked worktree
 - `remove` to remove a linked worktree and its administrative files (and
   warn if the worktree is dirty)
 - `mv` to move or rename a worktree and update its administrative files
 - `lock` to prevent automatic pruning of administrative files (for instance,
   for a worktree on a portable device)
 
-SEE ALSO
---------
-
-linkgit:git-checkout[1]
-
 GIT
 ---
 Part of the linkgit:git[1] suite
diff --git a/builtin/worktree.c b/builtin/worktree.c
index 2a729c6..b82861e 100644
--- a/builtin/worktree.c
+++ b/builtin/worktree.c
@@ -2,8 +2,11 @@
 #include "builtin.h"
 #include "dir.h"
 #include "parse-options.h"
+#include "argv-array.h"
+#include "run-command.h"
 
 static const char * const worktree_usage[] = {
+	N_("git worktree add <path> <branch>"),
 	N_("git worktree prune [<options>]"),
 	NULL
 };
@@ -119,6 +122,33 @@ static int prune(int ac, const char **av, const char *prefix)
 	return 0;
 }
 
+
+static int add(int ac, const char **av, const char *prefix)
+{
+	struct child_process c;
+	const char *path, *branch;
+	struct argv_array cmd = ARGV_ARRAY_INIT;
+	struct option options[] = {
+		OPT_END()
+	};
+
+	ac = parse_options(ac, av, prefix, options, worktree_usage, 0);
+	if (ac != 2)
+		usage_with_options(worktree_usage, options);
+
+	path = prefix ? prefix_filename(prefix, strlen(prefix), av[0]) : av[0];
+	branch = av[1];
+
+	argv_array_push(&cmd, "checkout");
+	argv_array_pushl(&cmd, "--to", path, NULL);
+	argv_array_push(&cmd, branch);
+
+	memset(&c, 0, sizeof(c));
+	c.git_cmd = 1;
+	c.argv = cmd.argv;
+	return run_command(&c);
+}
+
 int cmd_worktree(int ac, const char **av, const char *prefix)
 {
 	struct option options[] = {
@@ -127,6 +157,8 @@ int cmd_worktree(int ac, const char **av, const char *prefix)
 
 	if (ac < 2)
 		usage_with_options(worktree_usage, options);
+	if (!strcmp(av[1], "add"))
+		return add(ac - 1, av + 1, prefix);
 	if (!strcmp(av[1], "prune"))
 		return prune(ac - 1, av + 1, prefix);
 	usage_with_options(worktree_usage, options);

-- 
2.5.0.rc1.197.g417e668
Previous: Eric SunshineNext: Duy Nguyen
Message 19 of 38 in “replace "checkout --to" with "worktree add"”
  1. 00/23 replace "checkout --to" with "worktree add"Eric Sunshine, Jul 4, 2015
  2. 01/23 Documentation/git-checkout: fix incorrect worktree prune commandEric Sunshine, Jul 4, 2015
  3. 02/23 Documentation/git-worktree: associate options with commandsEric Sunshine, Jul 4, 2015
  4. 03/23 Documentation: move linked worktree description from checkout to worktreeEric Sunshine, Jul 4, 2015
  5. 04/23 Documentation/git-worktree: add BUGS sectionEric Sunshine, Jul 4, 2015
  6. Duy NguyenJul 4, 2015
  7. Eric SunshineJul 4, 2015
  8. 05/23 Documentation/git-worktree: split technical info from general descriptionEric Sunshine, Jul 4, 2015
  9. 06/23 Documentation/git-worktree: add high-level 'lock' overviewEric Sunshine, Jul 4, 2015
  10. 07/23 Documentation/git-worktree: add EXAMPLES sectionEric Sunshine, Jul 4, 2015
  11. Eric SunshineJul 4, 2015
  12. 08/23 checkout: fix bug with --to and relative HEADEric Sunshine, Jul 4, 2015
  13. Duy NguyenJul 4, 2015
  14. Eric SunshineJul 4, 2015
  15. 09/23 checkout: relocate --to's "no branch specified" checkEric Sunshine, Jul 4, 2015
  16. 10/23 checkout: prepare_linked_checkout: drop now-unused 'new' argumentEric Sunshine, Jul 4, 2015
  17. 11/23 checkout: make --to unconditionally verboseEric Sunshine, Jul 4, 2015
  18. 12/23 checkout: drop 'checkout_opts' dependency from prepare_linked_checkoutEric Sunshine, Jul 4, 2015
  19. 13/23 worktree: introduce "add" commandEric Sunshine, Jul 4, 2015
  20. Duy NguyenJul 4, 2015
  21. Eric SunshineJul 4, 2015
  22. Duy NguyenJul 6, 2015
  23. 14/23 worktree: add --force optionEric Sunshine, Jul 4, 2015
  24. 15/23 worktree: add --detach optionEric Sunshine, Jul 4, 2015
  25. 16/23 worktree: add -b/-B optionsEric Sunshine, Jul 4, 2015
  26. Duy NguyenJul 4, 2015
  27. Eric SunshineJul 4, 2015
  28. 17/23 tests: worktree: retrofit "checkout --to" tests for "worktree add"Eric Sunshine, Jul 4, 2015
  29. 18/23 checkout: retire --to optionEric Sunshine, Jul 4, 2015
  30. Duy NguyenJul 4, 2015
  31. Eric SunshineJul 4, 2015
  32. 19/23 checkout: require worktree unconditionallyEric Sunshine, Jul 4, 2015
  33. Eric SunshineJul 4, 2015
  34. 20/23 worktree: extract basename computation to new functionEric Sunshine, Jul 4, 2015
  35. 21/23 worktree: add: make -b/-B default to HEAD when <branch> is omittedEric Sunshine, Jul 4, 2015
  36. Junio C HamanoJul 6, 2015
  37. 22/23 worktree: add: auto-vivify new branch when <branch> is omittedEric Sunshine, Jul 4, 2015
  38. 23/23 checkout: retire --ignore-other-worktrees in favor of --forceEric Sunshine, Jul 4, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.