Autogenerated manpages for v2.34.1-428-gdcc0c
[git-manpages.git] / man1 / git-worktree.1
blobc063cac27d2aaf1230e57494f046f12d561fef4b
1 '\" t
2 .\"     Title: git-worktree
3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\"      Date: 01/03/2022
6 .\"    Manual: Git Manual
7 .\"    Source: Git 2.34.1.428.gdcc0cd074f
8 .\"  Language: English
9 .\"
10 .TH "GIT\-WORKTREE" "1" "01/03/2022" "Git 2\&.34\&.1\&.428\&.gdcc0cd" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-worktree \- Manage multiple working trees
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit worktree add\fR [\-f] [\-\-detach] [\-\-checkout] [\-\-lock [\-\-reason <string>]] [\-b <new\-branch>] <path> [<commit\-ish>]
36 \fIgit worktree list\fR [\-v | \-\-porcelain]
37 \fIgit worktree lock\fR [\-\-reason <string>] <worktree>
38 \fIgit worktree move\fR <worktree> <new\-path>
39 \fIgit worktree prune\fR [\-n] [\-v] [\-\-expire <expire>]
40 \fIgit worktree remove\fR [\-f] <worktree>
41 \fIgit worktree repair\fR [<path>\&...]
42 \fIgit worktree unlock\fR <worktree>
43 .fi
44 .sp
45 .SH "DESCRIPTION"
46 .sp
47 Manage multiple working trees attached to the same repository\&.
48 .sp
49 A git repository can support multiple working trees, allowing you to check out more than one branch at a time\&. With \fBgit worktree add\fR a new working tree is associated with the repository\&. This new working tree is called a "linked working tree" as opposed to the "main working tree" prepared by \fBgit-init\fR(1) or \fBgit-clone\fR(1)\&. A repository has one main working tree (if it\(cqs not a bare repository) and zero or more linked working trees\&. When you are done with a linked working tree, remove it with \fBgit worktree remove\fR\&.
50 .sp
51 In its simplest form, \fBgit worktree add <path>\fR automatically creates a new branch whose name is the final component of \fB<path>\fR, which is convenient if you plan to work on a new topic\&. For instance, \fBgit worktree add \&.\&./hotfix\fR creates new branch \fBhotfix\fR and checks it out at path \fB\&.\&./hotfix\fR\&. To instead work on an existing branch in a new working tree, use \fBgit worktree add <path> <branch>\fR\&. On the other hand, if you just plan to make some experimental changes or do testing without disturbing existing development, it is often convenient to create a \fIthrowaway\fR working tree not associated with any branch\&. For instance, \fBgit worktree add \-d <path>\fR creates a new working tree with a detached \fBHEAD\fR at the same commit as the current branch\&.
52 .sp
53 If a working tree is deleted without using \fBgit worktree remove\fR, then its associated administrative files, which reside in the repository (see "DETAILS" below), will eventually be removed automatically (see \fBgc\&.worktreePruneExpire\fR in \fBgit-config\fR(1)), or you can run \fBgit worktree prune\fR in the main or any linked working tree to clean up any stale administrative files\&.
54 .sp
55 If a linked working tree is stored on a portable device or network share which is not always mounted, you can prevent its administrative files from being pruned by issuing the \fBgit worktree lock\fR command, optionally specifying \fB\-\-reason\fR to explain why the working tree is locked\&.
56 .SH "COMMANDS"
57 .PP
58 add <path> [<commit\-ish>]
59 .RS 4
60 Create
61 \fB<path>\fR
62 and checkout
63 \fB<commit\-ish>\fR
64 into it\&. The new working directory is linked to the current repository, sharing everything except working directory specific files such as
65 \fBHEAD\fR,
66 \fBindex\fR, etc\&. As a convenience,
67 \fB<commit\-ish>\fR
68 may be a bare "\fB\-\fR", which is synonymous with
69 \fB@{\-1}\fR\&.
70 .sp
72 \fB<commit\-ish>\fR
73 is a branch name (call it
74 \fB<branch>\fR) and is not found, and neither
75 \fB\-b\fR
76 nor
77 \fB\-B\fR
78 nor
79 \fB\-\-detach\fR
80 are used, but there does exist a tracking branch in exactly one remote (call it
81 \fB<remote>\fR) with a matching name, treat as equivalent to:
82 .sp
83 .if n \{\
84 .RS 4
85 .\}
86 .nf
87 $ git worktree add \-\-track \-b <branch> <path> <remote>/<branch>
88 .fi
89 .if n \{\
90 .RE
91 .\}
92 .sp
93 If the branch exists in multiple remotes and one of them is named by the
94 \fBcheckout\&.defaultRemote\fR
95 configuration variable, we\(cqll use that one for the purposes of disambiguation, even if the
96 \fB<branch>\fR
97 isn\(cqt unique across all remotes\&. Set it to e\&.g\&.
98 \fBcheckout\&.defaultRemote=origin\fR
99 to always checkout remote branches from there if
100 \fB<branch>\fR
101 is ambiguous but exists on the
102 \fBorigin\fR
103 remote\&. See also
104 \fBcheckout\&.defaultRemote\fR
106 \fBgit-config\fR(1)\&.
109 \fB<commit\-ish>\fR
110 is omitted and neither
111 \fB\-b\fR
113 \fB\-B\fR
115 \fB\-\-detach\fR
116 used, then, as a convenience, the new working tree is associated with a branch (call it
117 \fB<branch>\fR) named after
118 \fB$(basename <path>)\fR\&. If
119 \fB<branch>\fR
120 doesn\(cqt exist, a new branch based on
121 \fBHEAD\fR
122 is automatically created as if
123 \fB\-b <branch>\fR
124 was given\&. If
125 \fB<branch>\fR
126 does exist, it will be checked out in the new working tree, if it\(cqs not checked out anywhere else, otherwise the command will refuse to create the working tree (unless
127 \fB\-\-force\fR
128 is used)\&.
131 list
132 .RS 4
133 List details of each working tree\&. The main working tree is listed first, followed by each of the linked working trees\&. The output details include whether the working tree is bare, the revision currently checked out, the branch currently checked out (or "detached HEAD" if none), "locked" if the worktree is locked, "prunable" if the worktree can be pruned by
134 \fBprune\fR
135 command\&.
138 lock
139 .RS 4
140 If a working tree is on a portable device or network share which is not always mounted, lock it to prevent its administrative files from being pruned automatically\&. This also prevents it from being moved or deleted\&. Optionally, specify a reason for the lock with
141 \fB\-\-reason\fR\&.
144 move
145 .RS 4
146 Move a working tree to a new location\&. Note that the main working tree or linked working trees containing submodules cannot be moved with this command\&. (The
147 \fBgit worktree repair\fR
148 command, however, can reestablish the connection with linked working trees if you move the main working tree manually\&.)
151 prune
152 .RS 4
153 Prune working tree information in
154 \fB$GIT_DIR/worktrees\fR\&.
157 remove
158 .RS 4
159 Remove a working tree\&. Only clean working trees (no untracked files and no modification in tracked files) can be removed\&. Unclean working trees or ones with submodules can be removed with
160 \fB\-\-force\fR\&. The main working tree cannot be removed\&.
163 repair [<path>\&...]
164 .RS 4
165 Repair working tree administrative files, if possible, if they have become corrupted or outdated due to external factors\&.
167 For instance, if the main working tree (or bare repository) is moved, linked working trees will be unable to locate it\&. Running
168 \fBrepair\fR
169 in the main working tree will reestablish the connection from linked working trees back to the main working tree\&.
171 Similarly, if a linked working tree is moved without using
172 \fBgit worktree move\fR, the main working tree (or bare repository) will be unable to locate it\&. Running
173 \fBrepair\fR
174 within the recently\-moved working tree will reestablish the connection\&. If multiple linked working trees are moved, running
175 \fBrepair\fR
176 from any working tree with each tree\(cqs new
177 \fB<path>\fR
178 as an argument, will reestablish the connection to all the specified paths\&.
180 If both the main working tree and linked working trees have been moved manually, then running
181 \fBrepair\fR
182 in the main working tree and specifying the new
183 \fB<path>\fR
184 of each linked working tree will reestablish all connections in both directions\&.
187 unlock
188 .RS 4
189 Unlock a working tree, allowing it to be pruned, moved or deleted\&.
191 .SH "OPTIONS"
193 \-f, \-\-force
194 .RS 4
195 By default,
196 \fBadd\fR
197 refuses to create a new working tree when
198 \fB<commit\-ish>\fR
199 is a branch name and is already checked out by another working tree, or if
200 \fB<path>\fR
201 is already assigned to some working tree but is missing (for instance, if
202 \fB<path>\fR
203 was deleted manually)\&. This option overrides these safeguards\&. To add a missing but locked working tree path, specify
204 \fB\-\-force\fR
205 twice\&.
207 \fBmove\fR
208 refuses to move a locked working tree unless
209 \fB\-\-force\fR
210 is specified twice\&. If the destination is already assigned to some other working tree but is missing (for instance, if
211 \fB<new\-path>\fR
212 was deleted manually), then
213 \fB\-\-force\fR
214 allows the move to proceed; use
215 \fB\-\-force\fR
216 twice if the destination is locked\&.
218 \fBremove\fR
219 refuses to remove an unclean working tree unless
220 \fB\-\-force\fR
221 is used\&. To remove a locked working tree, specify
222 \fB\-\-force\fR
223 twice\&.
226 \-b <new\-branch>, \-B <new\-branch>
227 .RS 4
228 With
229 \fBadd\fR, create a new branch named
230 \fB<new\-branch>\fR
231 starting at
232 \fB<commit\-ish>\fR, and check out
233 \fB<new\-branch>\fR
234 into the new working tree\&. If
235 \fB<commit\-ish>\fR
236 is omitted, it defaults to
237 \fBHEAD\fR\&. By default,
238 \fB\-b\fR
239 refuses to create a new branch if it already exists\&.
240 \fB\-B\fR
241 overrides this safeguard, resetting
242 \fB<new\-branch>\fR
244 \fB<commit\-ish>\fR\&.
247 \-d, \-\-detach
248 .RS 4
249 With
250 \fBadd\fR, detach
251 \fBHEAD\fR
252 in the new working tree\&. See "DETACHED HEAD" in
253 \fBgit-checkout\fR(1)\&.
256 \-\-[no\-]checkout
257 .RS 4
258 By default,
259 \fBadd\fR
260 checks out
261 \fB<commit\-ish>\fR, however,
262 \fB\-\-no\-checkout\fR
263 can be used to suppress checkout in order to make customizations, such as configuring sparse\-checkout\&. See "Sparse checkout" in
264 \fBgit-read-tree\fR(1)\&.
267 \-\-[no\-]guess\-remote
268 .RS 4
269 With
270 \fBworktree add <path>\fR, without
271 \fB<commit\-ish>\fR, instead of creating a new branch from
272 \fBHEAD\fR, if there exists a tracking branch in exactly one remote matching the basename of
273 \fB<path>\fR, base the new branch on the remote\-tracking branch, and mark the remote\-tracking branch as "upstream" from the new branch\&.
275 This can also be set up as the default behaviour by using the
276 \fBworktree\&.guessRemote\fR
277 config option\&.
280 \-\-[no\-]track
281 .RS 4
282 When creating a new branch, if
283 \fB<commit\-ish>\fR
284 is a branch, mark it as "upstream" from the new branch\&. This is the default if
285 \fB<commit\-ish>\fR
286 is a remote\-tracking branch\&. See
287 \fB\-\-track\fR
289 \fBgit-branch\fR(1)
290 for details\&.
293 \-\-lock
294 .RS 4
295 Keep the working tree locked after creation\&. This is the equivalent of
296 \fBgit worktree lock\fR
297 after
298 \fBgit worktree add\fR, but without a race condition\&.
301 \-n, \-\-dry\-run
302 .RS 4
303 With
304 \fBprune\fR, do not remove anything; just report what it would remove\&.
307 \-\-porcelain
308 .RS 4
309 With
310 \fBlist\fR, output in an easy\-to\-parse format for scripts\&. This format will remain stable across Git versions and regardless of user configuration\&. See below for details\&.
313 \-q, \-\-quiet
314 .RS 4
315 With
316 \fBadd\fR, suppress feedback messages\&.
319 \-v, \-\-verbose
320 .RS 4
321 With
322 \fBprune\fR, report all removals\&.
324 With
325 \fBlist\fR, output additional information about worktrees (see below)\&.
328 \-\-expire <time>
329 .RS 4
330 With
331 \fBprune\fR, only expire unused working trees older than
332 \fB<time>\fR\&.
334 With
335 \fBlist\fR, annotate missing working trees as prunable if they are older than
336 \fB<time>\fR\&.
339 \-\-reason <string>
340 .RS 4
341 With
342 \fBlock\fR
343 or with
344 \fBadd \-\-lock\fR, an explanation why the working tree is locked\&.
347 <worktree>
348 .RS 4
349 Working trees can be identified by path, either relative or absolute\&.
351 If the last path components in the working tree\(cqs path is unique among working trees, it can be used to identify a working tree\&. For example if you only have two working trees, at
352 \fB/abc/def/ghi\fR
354 \fB/abc/def/ggg\fR, then
355 \fBghi\fR
357 \fBdef/ghi\fR
358 is enough to point to the former working tree\&.
360 .SH "REFS"
362 In multiple working trees, some refs may be shared between all working trees and some refs are local\&. One example is \fBHEAD\fR which is different for each working tree\&. This section is about the sharing rules and how to access refs of one working tree from another\&.
364 In general, all pseudo refs are per working tree and all refs starting with \fBrefs/\fR are shared\&. Pseudo refs are ones like \fBHEAD\fR which are directly under \fB$GIT_DIR\fR instead of inside \fB$GIT_DIR/refs\fR\&. There are exceptions, however: refs inside \fBrefs/bisect\fR and \fBrefs/worktree\fR are not shared\&.
366 Refs that are per working tree can still be accessed from another working tree via two special paths, \fBmain\-worktree\fR and \fBworktrees\fR\&. The former gives access to per\-working tree refs of the main working tree, while the latter to all linked working trees\&.
368 For example, \fBmain\-worktree/HEAD\fR or \fBmain\-worktree/refs/bisect/good\fR resolve to the same value as the main working tree\(cqs \fBHEAD\fR and \fBrefs/bisect/good\fR respectively\&. Similarly, \fBworktrees/foo/HEAD\fR or \fBworktrees/bar/refs/bisect/bad\fR are the same as \fB$GIT_COMMON_DIR/worktrees/foo/HEAD\fR and \fB$GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad\fR\&.
370 To access refs, it\(cqs best not to look inside \fB$GIT_DIR\fR directly\&. Instead use commands such as \fBgit-rev-parse\fR(1) or \fBgit-update-ref\fR(1) which will handle refs correctly\&.
371 .SH "CONFIGURATION FILE"
373 By default, the repository \fBconfig\fR file is shared across all working trees\&. If the config variables \fBcore\&.bare\fR or \fBcore\&.worktree\fR are already present in the config file, they will be applied to the main working trees only\&.
375 In order to have configuration specific to working trees, you can turn on the \fBworktreeConfig\fR extension, e\&.g\&.:
377 .if n \{\
378 .RS 4
381 $ git config extensions\&.worktreeConfig true
383 .if n \{\
388 In this mode, specific configuration stays in the path pointed by \fBgit rev\-parse \-\-git\-path config\&.worktree\fR\&. You can add or update configuration in this file with \fBgit config \-\-worktree\fR\&. Older Git versions will refuse to access repositories with this extension\&.
390 Note that in this file, the exception for \fBcore\&.bare\fR and \fBcore\&.worktree\fR is gone\&. If they exist in \fB$GIT_DIR/config\fR, you must move them to the \fBconfig\&.worktree\fR of the main working tree\&. You may also take this opportunity to review and move other configuration that you do not want to share to all working trees:
392 .RS 4
393 .ie n \{\
394 \h'-04'\(bu\h'+03'\c
396 .el \{\
397 .sp -1
398 .IP \(bu 2.3
400 \fBcore\&.worktree\fR
402 \fBcore\&.bare\fR
403 should never be shared
406 .RS 4
407 .ie n \{\
408 \h'-04'\(bu\h'+03'\c
410 .el \{\
411 .sp -1
412 .IP \(bu 2.3
414 \fBcore\&.sparseCheckout\fR
415 is recommended per working tree, unless you are sure you always use sparse checkout for all working trees\&.
417 .SH "DETAILS"
419 Each linked working tree has a private sub\-directory in the repository\(cqs \fB$GIT_DIR/worktrees\fR directory\&. The private sub\-directory\(cqs name is usually the base name of the linked working tree\(cqs path, possibly appended with a number to make it unique\&. For example, when \fB$GIT_DIR=/path/main/\&.git\fR the command \fBgit worktree add /path/other/test\-next next\fR creates the linked working tree in \fB/path/other/test\-next\fR and also creates a \fB$GIT_DIR/worktrees/test\-next\fR directory (or \fB$GIT_DIR/worktrees/test\-next1\fR if \fBtest\-next\fR is already taken)\&.
421 Within a linked working tree, \fB$GIT_DIR\fR is set to point to this private directory (e\&.g\&. \fB/path/main/\&.git/worktrees/test\-next\fR in the example) and \fB$GIT_COMMON_DIR\fR is set to point back to the main working tree\(cqs \fB$GIT_DIR\fR (e\&.g\&. \fB/path/main/\&.git\fR)\&. These settings are made in a \fB\&.git\fR file located at the top directory of the linked working tree\&.
423 Path resolution via \fBgit rev\-parse \-\-git\-path\fR uses either \fB$GIT_DIR\fR or \fB$GIT_COMMON_DIR\fR depending on the path\&. For example, in the linked working tree \fBgit rev\-parse \-\-git\-path HEAD\fR returns \fB/path/main/\&.git/worktrees/test\-next/HEAD\fR (not \fB/path/other/test\-next/\&.git/HEAD\fR or \fB/path/main/\&.git/HEAD\fR) while \fBgit rev\-parse \-\-git\-path refs/heads/master\fR uses \fB$GIT_COMMON_DIR\fR and returns \fB/path/main/\&.git/refs/heads/master\fR, since refs are shared across all working trees, except \fBrefs/bisect\fR and \fBrefs/worktree\fR\&.
425 See \fBgitrepository-layout\fR(5) for more information\&. The rule of thumb is do not make any assumption about whether a path belongs to \fB$GIT_DIR\fR or \fB$GIT_COMMON_DIR\fR when you need to directly access something inside \fB$GIT_DIR\fR\&. Use \fBgit rev\-parse \-\-git\-path\fR to get the final path\&.
427 If you manually move a linked working tree, you need to update the \fBgitdir\fR file in the entry\(cqs directory\&. For example, if a linked working tree is moved to \fB/newpath/test\-next\fR and its \fB\&.git\fR file points to \fB/path/main/\&.git/worktrees/test\-next\fR, then update \fB/path/main/\&.git/worktrees/test\-next/gitdir\fR to reference \fB/newpath/test\-next\fR instead\&. Better yet, run \fBgit worktree repair\fR to reestablish the connection automatically\&.
429 To prevent a \fB$GIT_DIR/worktrees\fR entry from being pruned (which can be useful in some situations, such as when the entry\(cqs working tree is stored on a portable device), use the \fBgit worktree lock\fR command, which adds a file named \fBlocked\fR to the entry\(cqs directory\&. The file contains the reason in plain text\&. For example, if a linked working tree\(cqs \fB\&.git\fR file points to \fB/path/main/\&.git/worktrees/test\-next\fR then a file named \fB/path/main/\&.git/worktrees/test\-next/locked\fR will prevent the \fBtest\-next\fR entry from being pruned\&. See \fBgitrepository-layout\fR(5) for details\&.
431 When \fBextensions\&.worktreeConfig\fR is enabled, the config file \fB\&.git/worktrees/<id>/config\&.worktree\fR is read after \fB\&.git/config\fR is\&.
432 .SH "LIST OUTPUT FORMAT"
434 The \fBworktree list\fR command has two output formats\&. The default format shows the details on a single line with columns\&. For example:
436 .if n \{\
437 .RS 4
440 $ git worktree list
441 /path/to/bare\-source            (bare)
442 /path/to/linked\-worktree        abcd1234 [master]
443 /path/to/other\-linked\-worktree  1234abc  (detached HEAD)
445 .if n \{\
450 The command also shows annotations for each working tree, according to its state\&. These annotations are:
452 .RS 4
453 .ie n \{\
454 \h'-04'\(bu\h'+03'\c
456 .el \{\
457 .sp -1
458 .IP \(bu 2.3
460 \fBlocked\fR, if the working tree is locked\&.
463 .RS 4
464 .ie n \{\
465 \h'-04'\(bu\h'+03'\c
467 .el \{\
468 .sp -1
469 .IP \(bu 2.3
471 \fBprunable\fR, if the working tree can be pruned via
472 \fBgit worktree prune\fR\&.
475 .if n \{\
476 .RS 4
479 $ git worktree list
480 /path/to/linked\-worktree    abcd1234 [master]
481 /path/to/locked\-worktree    acbd5678 (brancha) locked
482 /path/to/prunable\-worktree  5678abc  (detached HEAD) prunable
484 .if n \{\
489 For these annotations, a reason might also be available and this can be seen using the verbose mode\&. The annotation is then moved to the next line indented followed by the additional information\&.
491 .if n \{\
492 .RS 4
495 $ git worktree list \-\-verbose
496 /path/to/linked\-worktree              abcd1234 [master]
497 /path/to/locked\-worktree\-no\-reason    abcd5678 (detached HEAD) locked
498 /path/to/locked\-worktree\-with\-reason  1234abcd (brancha)
499         locked: working tree path is mounted on a portable device
500 /path/to/prunable\-worktree            5678abc1 (detached HEAD)
501         prunable: gitdir file points to non\-existent location
503 .if n \{\
508 Note that the annotation is moved to the next line if the additional information is available, otherwise it stays on the same line as the working tree itself\&.
509 .SS "Porcelain Format"
511 The porcelain format has a line per attribute\&. Attributes are listed with a label and value separated by a single space\&. Boolean attributes (like \fBbare\fR and \fBdetached\fR) are listed as a label only, and are present only if the value is true\&. Some attributes (like \fBlocked\fR) can be listed as a label only or with a value depending upon whether a reason is available\&. The first attribute of a working tree is always \fBworktree\fR, an empty line indicates the end of the record\&. For example:
513 .if n \{\
514 .RS 4
517 $ git worktree list \-\-porcelain
518 worktree /path/to/bare\-source
519 bare
521 worktree /path/to/linked\-worktree
522 HEAD abcd1234abcd1234abcd1234abcd1234abcd1234
523 branch refs/heads/master
525 worktree /path/to/other\-linked\-worktree
526 HEAD 1234abc1234abc1234abc1234abc1234abc1234a
527 detached
529 worktree /path/to/linked\-worktree\-locked\-no\-reason
530 HEAD 5678abc5678abc5678abc5678abc5678abc5678c
531 branch refs/heads/locked\-no\-reason
532 locked
534 worktree /path/to/linked\-worktree\-locked\-with\-reason
535 HEAD 3456def3456def3456def3456def3456def3456b
536 branch refs/heads/locked\-with\-reason
537 locked reason why is locked
539 worktree /path/to/linked\-worktree\-prunable
540 HEAD 1233def1234def1234def1234def1234def1234b
541 detached
542 prunable gitdir file points to non\-existent location
544 .if n \{\
549 If the lock reason contains "unusual" characters such as newline, they are escaped and the entire reason is quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&. For Example:
551 .if n \{\
552 .RS 4
555 $ git worktree list \-\-porcelain
556 \&.\&.\&.
557 locked "reason\enwhy is locked"
558 \&.\&.\&.
560 .if n \{\
564 .SH "EXAMPLES"
566 You are in the middle of a refactoring session and your boss comes in and demands that you fix something immediately\&. You might typically use \fBgit-stash\fR(1) to store your changes away temporarily, however, your working tree is in such a state of disarray (with new, moved, and removed files, and other bits and pieces strewn around) that you don\(cqt want to risk disturbing any of it\&. Instead, you create a temporary linked working tree to make the emergency fix, remove it when done, and then resume your earlier refactoring session\&.
568 .if n \{\
569 .RS 4
572 $ git worktree add \-b emergency\-fix \&.\&./temp master
573 $ pushd \&.\&./temp
574 # \&.\&.\&. hack hack hack \&.\&.\&.
575 $ git commit \-a \-m \(aqemergency fix for boss\(aq
576 $ popd
577 $ git worktree remove \&.\&./temp
579 .if n \{\
583 .SH "BUGS"
585 Multiple checkout in general is still experimental, and the support for submodules is incomplete\&. It is NOT recommended to make multiple checkouts of a superproject\&.
586 .SH "GIT"
588 Part of the \fBgit\fR(1) suite