git.oblomov.eu Git - git/blob - Documentation/git-worktree.txt

   1 git-worktree(1)
   2 ===============
   3
   4 NAME
   5 ----
   6 git-worktree - Manage multiple worktrees
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git worktree add' [-f] <path> <branch>
  13 'git worktree prune' [-n] [-v] [--expire <expire>]
  14
  15 DESCRIPTION
  16 -----------
  17
  18 Manage multiple worktrees attached to the same repository.
  19
  20 A git repository can support multiple working trees, allowing you to check
  21 out more than one branch at a time.  With `git checkout --to` a new working
  22 tree is associated with the repository.  This new working tree is called a
  23 "linked working tree" as opposed to the "main working tree" prepared by "git
  24 init" or "git clone".  A repository has one main working tree (if it's not a
  25 bare repository) and zero or more linked working trees.
  26
  27 When you are done with a linked working tree you can simply delete it.
  28 The working tree's administrative files in the repository (see
  29 "DETAILS" below) will eventually be removed automatically (see
  30 `gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
  31 `git worktree prune` in the main or any linked working tree to
  32 clean up any stale administrative files.
  33
  34 If you move a linked working directory to another file system, or
  35 within a file system that does not support hard links, you need to run
  36 at least one git command inside the linked working directory
  37 (e.g. `git status`) in order to update its administrative files in the
  38 repository so that they do not get automatically pruned.
  39
  40 If a linked working tree is stored on a portable device or network share
  41 which is not always mounted, you can prevent its administrative files from
  42 being pruned by creating a file named 'lock' alongside the other
  43 administrative files, optionally containing a plain text reason that
  44 pruning should be suppressed. See section "DETAILS" for more information.
  45
  46 COMMANDS
  47 --------
  48 add <path> <branch>::
  49
  50 Create `<path>` and checkout `<branch>` into it. The new working directory
  51 is linked to the current repository, sharing everything except working
  52 directory specific files such as HEAD, index, etc.
  53
  54 prune::
  55
  56 Prune working tree information in $GIT_DIR/worktrees.
  57
  58 OPTIONS
  59 -------
  60
  61 -f::
  62 --force::
  63         By default, `add` refuses to create a new worktree when `<branch>`
  64         is already checked out by another worktree. This option overrides
  65         that safeguard.
  66
  67 -n::
  68 --dry-run::
  69         With `prune`, do not remove anything; just report what it would
  70         remove.
  71
  72 -v::
  73 --verbose::
  74         With `prune`, report all removals.
  75
  76 --expire <time>::
  77         With `prune`, only expire unused worktrees older than <time>.
  78
  79 DETAILS
  80 -------
  81 Each linked working tree has a private sub-directory in the repository's
  82 $GIT_DIR/worktrees directory.  The private sub-directory's name is usually
  83 the base name of the linked working tree's path, possibly appended with a
  84 number to make it unique.  For example, when `$GIT_DIR=/path/main/.git` the
  85 command `git checkout --to /path/other/test-next next` creates the linked
  86 working tree in `/path/other/test-next` and also creates a
  87 `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
  88 if `test-next` is already taken).
  89
  90 Within a linked working tree, $GIT_DIR is set to point to this private
  91 directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
  92 $GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
  93 (e.g. `/path/main/.git`). These settings are made in a `.git` file located at
  94 the top directory of the linked working tree.
  95
  96 Path resolution via `git rev-parse --git-path` uses either
  97 $GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
  98 linked working tree `git rev-parse --git-path HEAD` returns
  99 `/path/main/.git/worktrees/test-next/HEAD` (not
 100 `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
 101 rev-parse --git-path refs/heads/master` uses
 102 $GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
 103 since refs are shared across all working trees.
 104
 105 See linkgit:gitrepository-layout[5] for more information. The rule of
 106 thumb is do not make any assumption about whether a path belongs to
 107 $GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
 108 inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
 109
 110 To prevent a $GIT_DIR/worktrees entry from from being pruned (which
 111 can be useful in some situations, such as when the
 112 entry's working tree is stored on a portable device), add a file named
 113 'locked' to the entry's directory. The file contains the reason in
 114 plain text. For example, if a linked working tree's `.git` file points
 115 to `/path/main/.git/worktrees/test-next` then a file named
 116 `/path/main/.git/worktrees/test-next/locked` will prevent the
 117 `test-next` entry from being pruned.  See
 118 linkgit:gitrepository-layout[5] for details.
 119
 120 EXAMPLES
 121 --------
 122 You are in the middle of a refactoring session and your boss comes in and
 123 demands that you fix something immediately. You might typically use
 124 linkgit:git-stash[1] to store your changes away temporarily, however, your
 125 worktree is in such a state of disarray (with new, moved, and removed files,
 126 and other bits and pieces strewn around) that you don't want to risk
 127 disturbing any of it. Instead, you create a temporary linked worktree to
 128 make the emergency fix, remove it when done, and then resume your earlier
 129 refactoring session.
 130
 131 ------------
 132 $ git branch emergency-fix master
 133 $ git worktree add ../temp emergency-fix
 134 $ pushd ../temp
 135 # ... hack hack hack ...
 136 $ git commit -a -m 'emergency fix for boss'
 137 $ popd
 138 $ rm -rf ../temp
 139 $ git worktree prune
 140 ------------
 141
 142 BUGS
 143 ----
 144 Multiple checkout support for submodules is incomplete. It is NOT
 145 recommended to make multiple checkouts of a superproject.
 146
 147 git-worktree could provide more automation for tasks currently
 148 performed manually, such as:
 149
 150 - `remove` to remove a linked worktree and its administrative files (and
 151   warn if the worktree is dirty)
 152 - `mv` to move or rename a worktree and update its administrative files
 153 - `list` to list linked worktrees
 154 - `lock` to prevent automatic pruning of administrative files (for instance,
 155   for a worktree on a portable device)
 156
 157 GIT
 158 ---
 159 Part of the linkgit:git[1] suite