packfile.h: drop extern from function declarations
[git] / Documentation / git-worktree.txt
1 git-worktree(1)
2 ===============
3
4 NAME
5 ----
6 git-worktree - Manage multiple working trees
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git worktree add' [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
13 'git worktree list' [--porcelain]
14 'git worktree lock' [--reason <string>] <worktree>
15 'git worktree move' <worktree> <new-path>
16 'git worktree prune' [-n] [-v] [--expire <expire>]
17 'git worktree remove' [-f] <worktree>
18 'git worktree unlock' <worktree>
19
20 DESCRIPTION
21 -----------
22
23 Manage multiple working trees attached to the same repository.
24
25 A git repository can support multiple working trees, allowing you to check
26 out more than one branch at a time.  With `git worktree add` a new working
27 tree is associated with the repository.  This new working tree is called a
28 "linked working tree" as opposed to the "main working tree" prepared by "git
29 init" or "git clone".  A repository has one main working tree (if it's not a
30 bare repository) and zero or more linked working trees. When you are done
31 with a linked working tree, remove it with `git worktree remove`.
32
33 If a working tree is deleted without using `git worktree remove`, then
34 its associated administrative files, which reside in the repository
35 (see "DETAILS" below), will eventually be removed automatically (see
36 `gc.worktreePruneExpire` in linkgit:git-config[1]), or you can run
37 `git worktree prune` in the main or any linked working tree to
38 clean up any stale administrative files.
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 issuing the `git worktree lock` command, optionally
43 specifying `--reason` to explain why the working tree is locked.
44
45 COMMANDS
46 --------
47 add <path> [<commit-ish>]::
48
49 Create `<path>` and checkout `<commit-ish>` into it. The new working directory
50 is linked to the current repository, sharing everything except working
51 directory specific files such as HEAD, index, etc. `-` may also be
52 specified as `<commit-ish>`; it is synonymous with `@{-1}`.
53 +
54 If <commit-ish> is a branch name (call it `<branch>`) and is not found,
55 and neither `-b` nor `-B` nor `--detach` are used, but there does
56 exist a tracking branch in exactly one remote (call it `<remote>`)
57 with a matching name, treat as equivalent to:
58 +
59 ------------
60 $ git worktree add --track -b <branch> <path> <remote>/<branch>
61 ------------
62 +
63 If the branch exists in multiple remotes and one of them is named by
64 the `checkout.defaultRemote` configuration variable, we'll use that
65 one for the purposes of disambiguation, even if the `<branch>` isn't
66 unique across all remotes. Set it to
67 e.g. `checkout.defaultRemote=origin` to always checkout remote
68 branches from there if `<branch>` is ambiguous but exists on the
69 'origin' remote. See also `checkout.defaultRemote` in
70 linkgit:git-config[1].
71 +
72 If `<commit-ish>` is omitted and neither `-b` nor `-B` nor `--detach` used,
73 then, as a convenience, the new worktree is associated with a branch
74 (call it `<branch>`) named after `$(basename <path>)`.  If `<branch>`
75 doesn't exist, a new branch based on HEAD is automatically created as
76 if `-b <branch>` was given.  If `<branch>` does exist, it will be
77 checked out in the new worktree, if it's not checked out anywhere
78 else, otherwise the command will refuse to create the worktree (unless
79 `--force` is used).
80
81 list::
82
83 List details of each worktree.  The main worktree is listed first, followed by
84 each of the linked worktrees.  The output details include if the worktree is
85 bare, the revision currently checked out, and the branch currently checked out
86 (or 'detached HEAD' if none).
87
88 lock::
89
90 If a working tree is on a portable device or network share which
91 is not always mounted, lock it to prevent its administrative
92 files from being pruned automatically. This also prevents it from
93 being moved or deleted. Optionally, specify a reason for the lock
94 with `--reason`.
95
96 move::
97
98 Move a working tree to a new location. Note that the main working tree
99 or linked working trees containing submodules cannot be moved.
100
101 prune::
102
103 Prune working tree information in $GIT_DIR/worktrees.
104
105 remove::
106
107 Remove a working tree. Only clean working trees (no untracked files
108 and no modification in tracked files) can be removed. Unclean working
109 trees or ones with submodules can be removed with `--force`. The main
110 working tree cannot be removed.
111
112 unlock::
113
114 Unlock a working tree, allowing it to be pruned, moved or deleted.
115
116 OPTIONS
117 -------
118
119 -f::
120 --force::
121         By default, `add` refuses to create a new working tree when
122         `<commit-ish>` is a branch name and is already checked out by
123         another working tree, or if `<path>` is already assigned to some
124         working tree but is missing (for instance, if `<path>` was deleted
125         manually). This option overrides these safeguards. To add a missing but
126         locked working tree path, specify `--force` twice.
127 +
128 `move` refuses to move a locked working tree unless `--force` is specified
129 twice.
130 +
131 `remove` refuses to remove an unclean working tree unless `--force` is used.
132 To remove a locked working tree, specify `--force` twice.
133
134 -b <new-branch>::
135 -B <new-branch>::
136         With `add`, create a new branch named `<new-branch>` starting at
137         `<commit-ish>`, and check out `<new-branch>` into the new working tree.
138         If `<commit-ish>` is omitted, it defaults to HEAD.
139         By default, `-b` refuses to create a new branch if it already
140         exists. `-B` overrides this safeguard, resetting `<new-branch>` to
141         `<commit-ish>`.
142
143 --detach::
144         With `add`, detach HEAD in the new working tree. See "DETACHED HEAD"
145         in linkgit:git-checkout[1].
146
147 --[no-]checkout::
148         By default, `add` checks out `<commit-ish>`, however, `--no-checkout` can
149         be used to suppress checkout in order to make customizations,
150         such as configuring sparse-checkout. See "Sparse checkout"
151         in linkgit:git-read-tree[1].
152
153 --[no-]guess-remote::
154         With `worktree add <path>`, without `<commit-ish>`, instead
155         of creating a new branch from HEAD, if there exists a tracking
156         branch in exactly one remote matching the basename of `<path>`,
157         base the new branch on the remote-tracking branch, and mark
158         the remote-tracking branch as "upstream" from the new branch.
159 +
160 This can also be set up as the default behaviour by using the
161 `worktree.guessRemote` config option.
162
163 --[no-]track::
164         When creating a new branch, if `<commit-ish>` is a branch,
165         mark it as "upstream" from the new branch.  This is the
166         default if `<commit-ish>` is a remote-tracking branch.  See
167         "--track" in linkgit:git-branch[1] for details.
168
169 --lock::
170         Keep the working tree locked after creation. This is the
171         equivalent of `git worktree lock` after `git worktree add`,
172         but without race condition.
173
174 -n::
175 --dry-run::
176         With `prune`, do not remove anything; just report what it would
177         remove.
178
179 --porcelain::
180         With `list`, output in an easy-to-parse format for scripts.
181         This format will remain stable across Git versions and regardless of user
182         configuration.  See below for details.
183
184 -q::
185 --quiet::
186         With 'add', suppress feedback messages.
187
188 -v::
189 --verbose::
190         With `prune`, report all removals.
191
192 --expire <time>::
193         With `prune`, only expire unused working trees older than <time>.
194
195 --reason <string>::
196         With `lock`, an explanation why the working tree is locked.
197
198 <worktree>::
199         Working trees can be identified by path, either relative or
200         absolute.
201 +
202 If the last path components in the working tree's path is unique among
203 working trees, it can be used to identify worktrees. For example if
204 you only have two working trees, at "/abc/def/ghi" and "/abc/def/ggg",
205 then "ghi" or "def/ghi" is enough to point to the former working tree.
206
207 REFS
208 ----
209 In multiple working trees, some refs may be shared between all working
210 trees, some refs are local. One example is HEAD is different for all
211 working trees. This section is about the sharing rules and how to access
212 refs of one working tree from another.
213
214 In general, all pseudo refs are per working tree and all refs starting
215 with "refs/" are shared. Pseudo refs are ones like HEAD which are
216 directly under GIT_DIR instead of inside GIT_DIR/refs. There are one
217 exception to this: refs inside refs/bisect and refs/worktree is not
218 shared.
219
220 Refs that are per working tree can still be accessed from another
221 working tree via two special paths, main-worktree and worktrees. The
222 former gives access to per-worktree refs of the main working tree,
223 while the latter to all linked working trees.
224
225 For example, main-worktree/HEAD or main-worktree/refs/bisect/good
226 resolve to the same value as the main working tree's HEAD and
227 refs/bisect/good respectively. Similarly, worktrees/foo/HEAD or
228 worktrees/bar/refs/bisect/bad are the same as
229 GIT_COMMON_DIR/worktrees/foo/HEAD and
230 GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad.
231
232 To access refs, it's best not to look inside GIT_DIR directly. Instead
233 use commands such as linkgit:git-rev-parse[1] or linkgit:git-update-ref[1]
234 which will handle refs correctly.
235
236 CONFIGURATION FILE
237 ------------------
238 By default, the repository "config" file is shared across all working
239 trees. If the config variables `core.bare` or `core.worktree` are
240 already present in the config file, they will be applied to the main
241 working trees only.
242
243 In order to have configuration specific to working trees, you can turn
244 on "worktreeConfig" extension, e.g.:
245
246 ------------
247 $ git config extensions.worktreeConfig true
248 ------------
249
250 In this mode, specific configuration stays in the path pointed by `git
251 rev-parse --git-path config.worktree`. You can add or update
252 configuration in this file with `git config --worktree`. Older Git
253 versions will refuse to access repositories with this extension.
254
255 Note that in this file, the exception for `core.bare` and `core.worktree`
256 is gone. If you have them in $GIT_DIR/config before, you must move
257 them to the `config.worktree` of the main working tree. You may also
258 take this opportunity to review and move other configuration that you
259 do not want to share to all working trees:
260
261  - `core.worktree` and `core.bare` should never be shared
262
263  - `core.sparseCheckout` is recommended per working tree, unless you
264    are sure you always use sparse checkout for all working trees.
265
266 DETAILS
267 -------
268 Each linked working tree has a private sub-directory in the repository's
269 $GIT_DIR/worktrees directory.  The private sub-directory's name is usually
270 the base name of the linked working tree's path, possibly appended with a
271 number to make it unique.  For example, when `$GIT_DIR=/path/main/.git` the
272 command `git worktree add /path/other/test-next next` creates the linked
273 working tree in `/path/other/test-next` and also creates a
274 `$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
275 if `test-next` is already taken).
276
277 Within a linked working tree, $GIT_DIR is set to point to this private
278 directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
279 $GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
280 (e.g. `/path/main/.git`). These settings are made in a `.git` file located at
281 the top directory of the linked working tree.
282
283 Path resolution via `git rev-parse --git-path` uses either
284 $GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
285 linked working tree `git rev-parse --git-path HEAD` returns
286 `/path/main/.git/worktrees/test-next/HEAD` (not
287 `/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
288 rev-parse --git-path refs/heads/master` uses
289 $GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
290 since refs are shared across all working trees, except refs/bisect and
291 refs/worktree.
292
293 See linkgit:gitrepository-layout[5] for more information. The rule of
294 thumb is do not make any assumption about whether a path belongs to
295 $GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
296 inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
297
298 If you manually move a linked working tree, you need to update the 'gitdir' file
299 in the entry's directory. For example, if a linked working tree is moved
300 to `/newpath/test-next` and its `.git` file points to
301 `/path/main/.git/worktrees/test-next`, then update
302 `/path/main/.git/worktrees/test-next/gitdir` to reference `/newpath/test-next`
303 instead.
304
305 To prevent a $GIT_DIR/worktrees entry from being pruned (which
306 can be useful in some situations, such as when the
307 entry's working tree is stored on a portable device), use the
308 `git worktree lock` command, which adds a file named
309 'locked' to the entry's directory. The file contains the reason in
310 plain text. For example, if a linked working tree's `.git` file points
311 to `/path/main/.git/worktrees/test-next` then a file named
312 `/path/main/.git/worktrees/test-next/locked` will prevent the
313 `test-next` entry from being pruned.  See
314 linkgit:gitrepository-layout[5] for details.
315
316 When extensions.worktreeConfig is enabled, the config file
317 `.git/worktrees/<id>/config.worktree` is read after `.git/config` is.
318
319 LIST OUTPUT FORMAT
320 ------------------
321 The worktree list command has two output formats.  The default format shows the
322 details on a single line with columns.  For example:
323
324 ------------
325 $ git worktree list
326 /path/to/bare-source            (bare)
327 /path/to/linked-worktree        abcd1234 [master]
328 /path/to/other-linked-worktree  1234abc  (detached HEAD)
329 ------------
330
331 Porcelain Format
332 ~~~~~~~~~~~~~~~~
333 The porcelain format has a line per attribute.  Attributes are listed with a
334 label and value separated by a single space.  Boolean attributes (like 'bare'
335 and 'detached') are listed as a label only, and are only present if and only
336 if the value is true.  The first attribute of a worktree is always `worktree`,
337 an empty line indicates the end of the record.  For example:
338
339 ------------
340 $ git worktree list --porcelain
341 worktree /path/to/bare-source
342 bare
343
344 worktree /path/to/linked-worktree
345 HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
346 branch refs/heads/master
347
348 worktree /path/to/other-linked-worktree
349 HEAD 1234abc1234abc1234abc1234abc1234abc1234a
350 detached
351
352 ------------
353
354 EXAMPLES
355 --------
356 You are in the middle of a refactoring session and your boss comes in and
357 demands that you fix something immediately. You might typically use
358 linkgit:git-stash[1] to store your changes away temporarily, however, your
359 working tree is in such a state of disarray (with new, moved, and removed
360 files, and other bits and pieces strewn around) that you don't want to risk
361 disturbing any of it. Instead, you create a temporary linked working tree to
362 make the emergency fix, remove it when done, and then resume your earlier
363 refactoring session.
364
365 ------------
366 $ git worktree add -b emergency-fix ../temp master
367 $ pushd ../temp
368 # ... hack hack hack ...
369 $ git commit -a -m 'emergency fix for boss'
370 $ popd
371 $ git worktree remove ../temp
372 ------------
373
374 BUGS
375 ----
376 Multiple checkout in general is still experimental, and the support
377 for submodules is incomplete. It is NOT recommended to make multiple
378 checkouts of a superproject.
379
380 GIT
381 ---
382 Part of the linkgit:git[1] suite