4 <meta charset="utf-8"/>
5 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
9 <!-- This is an automatically generated file. Do not edit.
10 Copyright (c) 2017 Martin Pieuchot
11 Copyright (c) 2018, 2019, 2020 Stefan Sperling
13 Permission to use, copy, modify, and distribute this software for any
14 purpose with or without fee is hereby granted, provided that the above
15 copyright notice and this permission notice appear in all copies.
17 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
18 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
19 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
20 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
21 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
22 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
23 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
26 <div class="head" role="doc-pageheader" aria-label="Manual header
27 line"><span class="head-ltitle">GOT(1)</span> <span class="head-vol">General
28 Commands Manual</span> <span class="head-rtitle">GOT(1)</span></div>
29 <main class="manual-text">
31 <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
32 <p class="Pp"><code class="Nm">got</code> —
33 <span class="Nd" role="doc-subtitle">Game of Trees</span></p>
36 <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
39 <td><code class="Nm">got</code></td>
40 <td>[<code class="Fl">-hV</code>] <var class="Ar">command</var>
41 [<var class="Ar">arg ...</var>]</td>
46 <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
47 <p class="Pp"><code class="Nm">got</code> is a version control system which
48 stores the history of tracked files in a Git repository, as used by the Git
49 version control system. This repository format is described in
50 <a class="Xr" aria-label="git-repository, section
51 5">git-repository(5)</a>.</p>
52 <p class="Pp"><code class="Nm">got</code> is a “distributed”
53 version control system because every copy of a repository is writeable.
54 Modifications made to files can be synchronized between repositories at any
56 <p class="Pp" id="work">Files managed by <code class="Nm">got</code> must be
57 checked out from the repository for modification. Checked out files are
58 stored in a <a class="permalink" href="#work"><i class="Em">work
59 tree</i></a> which can be placed at an arbitrary directory in the filesystem
60 hierarchy. The on-disk format of this work tree is described in
61 <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a>.</p>
62 <p class="Pp"><code class="Nm">got</code> provides global and command-specific
63 options. Global options must precede the command name, and are as
66 <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a></dt>
67 <dd>Display usage information and exit immediately.</dd>
68 <dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a>,
69 <code class="Fl">--version</code></dt>
70 <dd>Display program version and exit immediately.</dd>
72 <p class="Pp">The commands for <code class="Nm">got</code> are as follows:</p>
74 <dt id="im"><a class="permalink" href="#import"><code class="Cm" id="import">import</code></a>
75 [<code class="Fl">-b</code> <var class="Ar">branch</var>]
76 [<code class="Fl">-I</code> <var class="Ar">pattern</var>]
77 [<code class="Fl">-m</code> <var class="Ar">message</var>]
78 [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
79 <var class="Ar">directory</var></dt>
81 <div class="Bd Bd-indent"><code class="Li">(alias:
82 <code class="Cm">im</code>)</code></div>
83 Create an initial commit in a repository from the file hierarchy within the
84 specified <var class="Ar">directory</var>. The created commit will not
85 have any parent commits, i.e. it will be a root commit. Also create a new
86 reference which provides a branch name for the newly created commit. Show
87 the path of each imported file to indicate progress.
88 <p class="Pp">The <code class="Cm">got import</code> command requires the
89 <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
90 unless an author has been configured in
91 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
92 <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
93 configuration settings can be obtained from the repository's
94 <span class="Pa">.git/config</span> file or from Git's global
95 <span class="Pa">~/.gitconfig</span> configuration file.</p>
96 <p class="Pp">The options for <code class="Cm">got import</code> are as
99 <dt id="b"><a class="permalink" href="#b"><code class="Fl">-b</code></a>
100 <var class="Ar">branch</var></dt>
101 <dd>Create the specified <var class="Ar">branch</var>. If this option is
102 not specified, a branch corresponding to the repository's HEAD
103 reference will be used. Use of this option is required if the branch
104 resolved via the repository's HEAD reference already exists.</dd>
105 <dt id="I"><a class="permalink" href="#I"><code class="Fl">-I</code></a>
106 <var class="Ar">pattern</var></dt>
107 <dd>Ignore files or directories with a name which matches the specified
108 <var class="Ar">pattern</var>. This option may be specified multiple
109 times to build a list of ignore patterns. The
110 <var class="Ar">pattern</var> follows the globbing rules documented in
111 <a class="Xr" aria-label="glob, section 7">glob(7)</a>. Ignore
112 patterns which end with a slash, “/”, will only match
114 <dt id="m"><a class="permalink" href="#m"><code class="Fl">-m</code></a>
115 <var class="Ar">message</var></dt>
116 <dd>Use the specified log message when creating the new commit. Without
117 the <code class="Fl">-m</code> option, <code class="Cm">got
118 import</code> opens a temporary file in an editor where a log message
119 can be written. Quitting the editor without saving the file will abort
120 the import operation.</dd>
121 <dt id="r"><a class="permalink" href="#r"><code class="Fl">-r</code></a>
122 <var class="Ar">repository-path</var></dt>
123 <dd>Use the repository at the specified path. If not specified, assume the
124 repository is located at or above the current working directory.</dd>
127 <dt id="cl"><a class="permalink" href="#clone"><code class="Cm" id="clone">clone</code></a>
128 [<code class="Fl">-almqv</code>] [<code class="Fl">-b</code>
129 <var class="Ar">branch</var>] [<code class="Fl">-R</code>
130 <var class="Ar">reference</var>] <var class="Ar">repository-URL</var>
131 [<var class="Ar">directory</var>]</dt>
133 <div class="Bd Bd-indent"><code class="Li">(alias:
134 <code class="Cm">cl</code>)</code></div>
135 Clone a Git repository at the specified <var class="Ar">repository-URL</var>
136 into the specified <var class="Ar">directory</var>. If no
137 <var class="Ar">directory</var> is specified, the directory name will be
138 derived from the name of the cloned repository. <code class="Cm">got
139 clone</code> will refuse to run if the <var class="Ar">directory</var>
141 <p class="Pp">The <var class="Ar">repository-URL</var> specifies a protocol
142 scheme, a server hostname, an optional port number separated from the
143 hostname by a colon, and a path to the repository on the server:
144 <a class="Lk" href="scheme://hostname:port/path/to/repository">scheme://hostname:port/path/to/repository</a></p>
145 <p class="Pp">The following protocol schemes are supported:</p>
148 <dd>The Git protocol as implemented by the
149 <a class="Xr" aria-label="git-daemon, section 1">git-daemon(1)</a>
150 server. Use of this protocol is discouraged since it supports neither
151 authentication nor encryption.</dd>
153 <dd>The Git protocol wrapped in an authenticated and encrypted
154 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> tunnel. With this
155 protocol the hostname may contain an embedded username for
156 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> to use:
157 <a class="Mt" href="mailto:user@hostname">user@hostname</a></dd>
159 <dd>Short alias for git+ssh.</dd>
161 <p class="Pp">Objects in the cloned repository are stored in a pack file
162 which is downloaded from the server. This pack file will then be indexed
163 to facilitate access to the objects stored within. If any objects in the
164 pack file are stored in deltified form, all deltas will be fully
165 resolved in order to compute the ID of such objects. This can take some
166 time. More details about the pack file format are documented in
167 <a class="Xr" aria-label="git-repository, section
168 5">git-repository(5)</a>.</p>
169 <p class="Pp"><code class="Cm">got clone</code> creates a remote repository
170 entry in the <a class="Xr" aria-label="got.conf, section
171 5">got.conf(5)</a> and <span class="Pa">config</span> files of the
172 cloned repository to store the <var class="Ar">repository-url</var> and
173 any <var class="Ar">branch</var> or <var class="Ar">reference</var>
174 arguments for future use by <code class="Cm">got fetch</code> or
175 <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>.</p>
176 <p class="Pp">The options for <code class="Cm">got clone</code> are as
179 <dt id="a"><a class="permalink" href="#a"><code class="Fl">-a</code></a></dt>
180 <dd>Fetch all branches from the remote repository's
181 “refs/heads/” reference namespace and set
182 <code class="Cm">fetch_all_branches</code> in the cloned repository's
183 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> file
184 for future use by <code class="Cm">got fetch</code>. If this option is
185 not specified, a branch resolved via the remote repository's HEAD
186 reference will be fetched. Cannot be used together with the
187 <code class="Fl">-b</code> option.</dd>
188 <dt id="b~2"><a class="permalink" href="#b~2"><code class="Fl">-b</code></a>
189 <var class="Ar">branch</var></dt>
190 <dd>Fetch the specified <var class="Ar">branch</var> from the remote
191 repository's “refs/heads/” reference namespace. This
192 option may be specified multiple times to build a list of branches to
193 fetch. If the branch corresponding to the remote repository's HEAD
194 reference is not in this list, the cloned repository's HEAD reference
195 will be set to the first branch which was fetched. If this option is
196 not specified, a branch resolved via the remote repository's HEAD
197 reference will be fetched. Cannot be used together with the
198 <code class="Fl">-a</code> option.</dd>
199 <dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt>
200 <dd>List branches and tags available for fetching from the remote
201 repository and exit immediately. Cannot be used together with any of
202 the other options except <code class="Fl">-q</code> and
203 <code class="Fl">-v</code>.</dd>
204 <dt id="m~2"><a class="permalink" href="#m~2"><code class="Fl">-m</code></a></dt>
205 <dd>Create the cloned repository as a mirror of the original repository.
206 This is useful if the cloned repository will not be used to store
207 locally created commits.
208 <p class="Pp">The repository's <a class="Xr" aria-label="got.conf,
209 section 5">got.conf(5)</a> and <span class="Pa">config</span> files
210 will be set up with the “mirror” option enabled, such
211 that <code class="Cm">got fetch</code> or
212 <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>
213 will write incoming changes directly to branches in the
214 “refs/heads/” reference namespace, rather than to
215 branches in the “refs/remotes/” namespace. This avoids
216 the usual requirement of having to run <code class="Cm">got
217 rebase</code> or <code class="Cm">got merge</code> after
218 <code class="Cm">got fetch</code> in order to make incoming changes
219 appear on branches in the “refs/heads/” namespace. But
220 maintaining custom changes in the cloned repository becomes
221 difficult since such changes will be at risk of being discarded
222 whenever incoming changes are fetched.</p>
224 <dt id="q"><a class="permalink" href="#q"><code class="Fl">-q</code></a></dt>
225 <dd>Suppress progress reporting output. The same option will be passed to
226 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
228 <dt id="R"><a class="permalink" href="#R"><code class="Fl">-R</code></a>
229 <var class="Ar">reference</var></dt>
230 <dd>In addition to the branches and tags that will be fetched, fetch an
231 arbitrary <var class="Ar">reference</var> from the remote repository's
232 “refs/” namespace. This option may be specified multiple
233 times to build a list of additional references to fetch. The specified
234 <var class="Ar">reference</var> may either be a path to a specific
235 reference, or a reference namespace which will cause all references in
236 this namespace to be fetched.
237 <p class="Pp">Each reference will be mapped into the cloned repository's
238 “refs/remotes/” namespace, unless the
239 <code class="Fl">-m</code> option is used to mirror references
240 directly into the cloned repository's “refs/”
242 <p class="Pp"><code class="Cm">got clone</code> will refuse to fetch
243 references from the remote repository's
244 “refs/remotes/” or “refs/got/”
247 <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
248 <dd>Verbose mode. Causes <code class="Cm">got clone</code> to print
249 debugging messages to standard error output. This option will be
250 passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
251 applicable. Multiple -v options increase the verbosity. The maximum is
255 <dt id="fe"><a class="permalink" href="#fetch"><code class="Cm" id="fetch">fetch</code></a>
256 [<code class="Fl">-adlqtvX</code>] [<code class="Fl">-b</code>
257 <var class="Ar">branch</var>] [<code class="Fl">-R</code>
258 <var class="Ar">reference</var>] [<code class="Fl">-r</code>
259 <var class="Ar">repository-path</var>]
260 [<var class="Ar">remote-repository</var>]</dt>
262 <div class="Bd Bd-indent"><code class="Li">(alias:
263 <code class="Cm">fe</code>)</code></div>
264 Fetch new changes from a remote repository. If no
265 <var class="Ar">remote-repository</var> is specified,
266 “origin” will be used. The remote repository's URL is
267 obtained from the corresponding entry in
268 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
269 <span class="Pa">config</span> file of the local repository, as created by
270 <code class="Cm">got clone</code>.
271 <p class="Pp">By default, any branches configured in
272 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> for the
273 <var class="Ar">remote-repository</var> will be fetched. If
274 <code class="Cm">got fetch</code> is invoked in a work tree then this
275 work tree's current branch will be fetched, too, provided it is present
276 on the server. If no branches to fetch can be found in
277 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or via a
278 work tree, or said branches are not found on the server, a branch
279 resolved via the remote repository's HEAD reference will be fetched.
280 Likewise, if a HEAD reference for the
281 <var class="Ar">remote-repository</var> exists but its target no longer
282 matches the remote HEAD, then the new target branch will be fetched.
283 This default behaviour can be overridden with the
284 <code class="Fl">-a</code> and <code class="Fl">-b</code> options.</p>
285 <p class="Pp">New changes will be stored in a separate pack file downloaded
286 from the server. Optionally, separate pack files stored in the
287 repository can be combined with <a class="Xr" aria-label="git-repack,
288 section 1">git-repack(1)</a>.</p>
289 <p class="Pp">By default, branch references in the
290 “refs/remotes/” reference namespace will be updated to
291 point at the newly fetched commits. The <code class="Cm">got
292 rebase</code> or <code class="Cm">got merge</code> command can then be
293 used to make new changes visible on branches in the
294 “refs/heads/” namespace, merging incoming changes with the
295 changes on those branches as necessary.</p>
296 <p class="Pp">If the repository was created as a mirror with
297 <code class="Cm">got clone -m</code>, then all branches in the
298 “refs/heads/” namespace will be updated directly to match
299 the corresponding branches in the remote repository. If those branches
300 contained local commits, these commits will no longer be reachable via a
301 reference and will therefore be at risk of being discarded by Git's
302 garbage collector or <code class="Cm">gotadmin cleanup</code>.
303 Maintaining custom changes in a mirror repository is therefore
305 <p class="Pp">In any case, references in the “refs/tags/”
306 namespace will always be fetched and mapped directly to local references
307 in the same namespace.</p>
308 <p class="Pp">The options for <code class="Cm">got fetch</code> are as
311 <dt id="a~2"><a class="permalink" href="#a~2"><code class="Fl">-a</code></a></dt>
312 <dd>Fetch all branches from the remote repository's
313 “refs/heads/” reference namespace. This option can be
314 enabled by default for specific repositories in
315 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>. Cannot
316 be used together with the <code class="Fl">-b</code> option.</dd>
317 <dt id="b~3"><a class="permalink" href="#b~3"><code class="Fl">-b</code></a>
318 <var class="Ar">branch</var></dt>
319 <dd>Fetch the specified <var class="Ar">branch</var> from the remote
320 repository's “refs/heads/” reference namespace. This
321 option may be specified multiple times to build a list of branches to
322 fetch. Cannot be used together with the <code class="Fl">-a</code>
324 <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt>
325 <dd>Delete branches and tags from the local repository which are no longer
326 present in the remote repository. Only references are deleted. Any
327 commit, tree, tag, and blob objects belonging to deleted branches or
328 tags remain in the repository and may be removed separately with Git's
329 garbage collector or <code class="Cm">gotadmin cleanup</code>.</dd>
330 <dt id="l~2"><a class="permalink" href="#l~2"><code class="Fl">-l</code></a></dt>
331 <dd>List branches and tags available for fetching from the remote
332 repository and exit immediately. Cannot be used together with any of
333 the other options except <code class="Fl">-v</code>,
334 <code class="Fl">-q</code>, and <code class="Fl">-r</code>.</dd>
335 <dt id="q~2"><a class="permalink" href="#q~2"><code class="Fl">-q</code></a></dt>
336 <dd>Suppress progress reporting output. The same option will be passed to
337 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
339 <dt id="R~2"><a class="permalink" href="#R~2"><code class="Fl">-R</code></a>
340 <var class="Ar">reference</var></dt>
341 <dd>In addition to the branches and tags that will be fetched, fetch an
342 arbitrary <var class="Ar">reference</var> from the remote repository's
343 “refs/” namespace. This option may be specified multiple
344 times to build a list of additional references to fetch. The specified
345 <var class="Ar">reference</var> may either be a path to a specific
346 reference, or a reference namespace which will cause all references in
347 this namespace to be fetched.
348 <p class="Pp">Each reference will be mapped into the local repository's
349 “refs/remotes/” namespace, unless the local repository
350 was created as a mirror with <code class="Cm">got clone -m</code> in
351 which case references will be mapped directly into the local
352 repository's “refs/” namespace.</p>
353 <p class="Pp">Once a reference has been fetched, a branch based on it
354 can be created with <code class="Cm">got branch</code> if
356 <p class="Pp"><code class="Cm">got fetch</code> will refuse to fetch
357 references from the remote repository's
358 “refs/remotes/” or “refs/got/”
361 <dt id="r~2"><a class="permalink" href="#r~2"><code class="Fl">-r</code></a>
362 <var class="Ar">repository-path</var></dt>
363 <dd>Use the repository at the specified path. If not specified, assume the
364 repository is located at or above the current working directory. If
365 this directory is a <code class="Nm">got</code> work tree, use the
366 repository path associated with this work tree.</dd>
367 <dt id="t"><a class="permalink" href="#t"><code class="Fl">-t</code></a></dt>
368 <dd>Allow existing references in the “refs/tags” namespace
369 to be updated if they have changed on the server. If not specified,
370 only new tag references will be created.</dd>
371 <dt id="v~2"><a class="permalink" href="#v~2"><code class="Fl">-v</code></a></dt>
372 <dd>Verbose mode. Causes <code class="Cm">got fetch</code> to print
373 debugging messages to standard error output. The same option will be
374 passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
375 applicable. Multiple -v options increase the verbosity. The maximum is
377 <dt id="X"><a class="permalink" href="#X"><code class="Fl">-X</code></a></dt>
378 <dd>Delete all references which correspond to a particular
379 <var class="Ar">remote-repository</var> instead of fetching new
380 changes. This can be useful when a remote repository is being removed
381 from <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>.
382 <p class="Pp">With <code class="Fl">-X</code>, the
383 <var class="Ar">remote-repository</var> argument is mandatory and no
384 other options except <code class="Fl">-r</code>,
385 <code class="Fl">-v</code>, and <code class="Fl">-q</code> are
387 <p class="Pp">Only references are deleted. Any commit, tree, tag, and
388 blob objects fetched from a remote repository will generally be
389 stored in pack files and may be removed separately with
390 <a class="Xr" aria-label="git-repack, section 1">git-repack(1)</a>
391 and Git's garbage collector.</p>
395 <dt id="co"><a class="permalink" href="#checkout"><code class="Cm" id="checkout">checkout</code></a>
396 [<code class="Fl">-Eq</code>] [<code class="Fl">-b</code>
397 <var class="Ar">branch</var>] [<code class="Fl">-c</code>
398 <var class="Ar">commit</var>] [<code class="Fl">-p</code>
399 <var class="Ar">path-prefix</var>] <var class="Ar">repository-path</var>
400 [<var class="Ar">work-tree-path</var>]</dt>
402 <div class="Bd Bd-indent"><code class="Li">(alias:
403 <code class="Cm">co</code>)</code></div>
404 Copy files from a repository into a new work tree. Show the status of each
405 affected file, using the following status codes:
406 <table class="Bl-column">
409 <td>new file was added</td>
413 <td>file already exists in work tree's meta-data</td>
416 <p class="Pp">If the <var class="Ar">work tree path</var> is not specified,
417 either use the last component of <var class="Ar">repository path</var>,
418 or if a <var class="Ar">path prefix</var> was specified use the last
419 component of <var class="Ar">path prefix</var>.</p>
420 <p class="Pp">The options for <code class="Cm">got checkout</code> are as
423 <dt id="b~4"><a class="permalink" href="#b~4"><code class="Fl">-b</code></a>
424 <var class="Ar">branch</var></dt>
425 <dd>Check out files from a commit on the specified
426 <var class="Ar">branch</var>. If this option is not specified, a
427 branch resolved via the repository's HEAD reference will be used.</dd>
428 <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
429 <var class="Ar">commit</var></dt>
430 <dd>Check out files from the specified <var class="Ar">commit</var> on the
431 selected branch. If this option is not specified, the most recent
432 commit on the selected branch will be used.
433 <p class="Pp">The expected <var class="Ar">commit</var> argument is a
434 commit ID SHA1 hash, or a reference name or a keyword which will be
435 resolved to a commit ID. An abbreviated hash argument will be
436 expanded to a full SHA1 hash automatically, provided the
437 abbreviation is unique. The keywords ":base" and
438 ":head" resolve to the repository's HEAD reference, or, if
439 the <code class="Fl">-b</code> option is used, the head of the
440 checked-out <var class="Ar">branch</var>. Keywords and reference
441 names may be appended with ":+" or ":-"
442 modifiers and an optional integer N to denote the Nth descendant or
443 antecedent by first parent traversal, respectively; for example,
444 <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
445 generation ancestor, and <b class="Sy">foo:-3</b> will denote the
446 3rd generation ancestor of the commit resolved by the
447 "foo" reference. If an integer does not follow the
448 ":+" or ":-" modifier, a "1" is
449 implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
450 to <b class="Sy">:head:-1</b>).</p>
451 <p class="Pp">If the specified <var class="Ar">commit</var> is not
452 contained in the selected branch, a different branch which contains
453 this commit must be specified with the <code class="Fl">-b</code>
454 option. If no such branch is known, a new branch must be created for
455 this commit with <code class="Cm">got branch</code> before
456 <code class="Cm">got checkout</code> can be used. Checking out work
457 trees with an unknown branch is intentionally not supported.</p>
459 <dt id="E"><a class="permalink" href="#E"><code class="Fl">-E</code></a></dt>
460 <dd>Proceed with the checkout operation even if the directory at
461 <var class="Ar">work-tree-path</var> is not empty. Existing files will
463 <dt id="p"><a class="permalink" href="#p"><code class="Fl">-p</code></a>
464 <var class="Ar">path-prefix</var></dt>
465 <dd>Restrict the work tree to a subset of the repository's tree hierarchy.
466 Only files beneath the specified <var class="Ar">path-prefix</var>
467 will be checked out.</dd>
468 <dt id="q~3"><a class="permalink" href="#q~3"><code class="Fl">-q</code></a></dt>
469 <dd>Silence progress output.</dd>
472 <dt id="up"><a class="permalink" href="#update"><code class="Cm" id="update">update</code></a>
473 [<code class="Fl">-q</code>] [<code class="Fl">-b</code>
474 <var class="Ar">branch</var>] [<code class="Fl">-c</code>
475 <var class="Ar">commit</var>] [<var class="Ar">path ...</var>]</dt>
477 <div class="Bd Bd-indent"><code class="Li">(alias:
478 <code class="Cm">up</code>)</code></div>
479 Update an existing work tree to a different <var class="Ar">commit</var>.
480 Change existing files in the work tree as necessary to match file contents
481 of this commit. Preserve any local changes in the work tree and merge them
482 with the incoming changes.
483 <p class="Pp">Files which already contain merge conflicts will not be
484 updated to avoid further complications. Such files will be updated when
485 <code class="Cm">got update</code> is run again after merge conflicts
486 have been resolved. If the conflicting changes are no longer needed,
487 affected files can be reverted with <code class="Cm">got revert</code>
488 before running <code class="Cm">got update</code> again.</p>
489 <p class="Pp">Show the status of each affected file, using the following
491 <table class="Bl-column">
494 <td>file was updated and contained no local changes</td>
498 <td>file was updated and local changes were merged cleanly</td>
502 <td>file was updated and conflicts occurred during merge</td>
506 <td>file was deleted</td>
510 <td>file's deletion was prevented by local modifications</td>
514 <td>new file was added</td>
518 <td>versioned file is obstructed by a non-regular file</td>
522 <td>a missing versioned file was restored</td>
526 <td>file was not updated because it contains merge conflicts</td>
530 <td>changes destined for an unversioned file were not merged</td>
533 <p class="Pp">If no <var class="Ar">path</var> is specified, update the
534 entire work tree. Otherwise, restrict the update operation to files at
535 or within the specified paths. Each path is required to exist in the
536 update operation's target commit. Files in the work tree outside
537 specified paths will remain unchanged and will retain their previously
538 recorded base commit. Some <code class="Nm">got</code> commands may
539 refuse to run while the work tree contains files from multiple base
540 commits. The base commit of such a work tree can be made consistent by
541 running <code class="Cm">got update</code> across the entire work tree.
542 Specifying a <var class="Ar">path</var> is incompatible with the
543 <code class="Fl">-b</code> option.</p>
544 <p class="Pp"><code class="Cm">got update</code> cannot update paths with
545 staged changes. If changes have been staged with <code class="Cm">got
546 stage</code>, these changes must first be committed with
547 <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
549 <p class="Pp">The options for <code class="Cm">got update</code> are as
552 <dt id="b~5"><a class="permalink" href="#b~5"><code class="Fl">-b</code></a>
553 <var class="Ar">branch</var></dt>
554 <dd>Switch the work tree's branch reference to the specified
555 <var class="Ar">branch</var> before updating the work tree. This
556 option requires that all paths in the work tree are updated.
557 <p class="Pp">As usual, any local changes in the work tree will be
558 preserved. This can be useful when switching to a newly created
559 branch in order to commit existing local changes to this branch.</p>
560 <p class="Pp">Any local changes must be dealt with separately in order
561 to obtain a work tree with pristine file contents corresponding
562 exactly to the specified <var class="Ar">branch</var>. Such changes
563 could first be committed to a different branch with
564 <code class="Cm">got commit</code>, or could be discarded with
565 <code class="Cm">got revert</code>.</p>
567 <dt id="c~2"><a class="permalink" href="#c~2"><code class="Fl">-c</code></a>
568 <var class="Ar">commit</var></dt>
569 <dd>Update the work tree to the specified <var class="Ar">commit</var>. If
570 this option is not specified, the most recent commit on the work
571 tree's branch will be used.
572 <p class="Pp">The expected <var class="Ar">commit</var> argument is a
573 commit ID SHA1 hash, or a reference name or a keyword which will be
574 resolved to a commit ID. An abbreviated hash argument will be
575 expanded to a full SHA1 hash automatically, provided the
576 abbreviation is unique. The keywords ":base" and
577 ":head" resolve to the work tree's base commit and branch
578 head, respectively. Keywords and reference names may be appended
579 with ":+" or ":-" modifiers and an optional
580 integer N to denote the Nth descendant or antecedent, respectively,
581 by first parent traversal; for example, <b class="Sy">:head:-2</b>
582 denotes the work tree branch head's 2nd generation ancestor, and
583 <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
584 the work tree's base commit. Similarly, <b class="Sy">foo:-3</b>
585 will denote the 3rd generation ancestor of the commit resolved by
586 the "foo" reference. If an integer does not follow the
587 ":+" or ":-" modifier, a "1" is
588 implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
589 to <b class="Sy">:head:-1</b>).</p>
591 <dt id="q~4"><a class="permalink" href="#q~4"><code class="Fl">-q</code></a></dt>
592 <dd>Silence progress output.</dd>
595 <dt id="st"><a class="permalink" href="#status"><code class="Cm" id="status">status</code></a>
596 [<code class="Fl">-I</code>] [<code class="Fl">-S</code>
597 <var class="Ar">status-codes</var>] [<code class="Fl">-s</code>
598 <var class="Ar">status-codes</var>] [<var class="Ar">path ...</var>]</dt>
600 <div class="Bd Bd-indent"><code class="Li">(alias:
601 <code class="Cm">st</code>)</code></div>
602 Show the current modification status of files in a work tree, using the
603 following status codes:
604 <table class="Bl-column">
607 <td>modified file</td>
611 <td>file scheduled for addition in next commit</td>
615 <td>file scheduled for deletion in next commit</td>
619 <td>modified or added file which contains merge conflicts</td>
623 <td>versioned file was expected on disk but is missing</td>
627 <td>versioned file is obstructed by a non-regular file</td>
631 <td>unversioned item not tracked by <code class="Nm">got</code></td>
635 <td>modified file modes (executable bit only)</td>
639 <td>non-existent <var class="Ar">path</var> specified on the command
643 <p class="Pp">If no <var class="Ar">path</var> is specified, show
644 modifications in the entire work tree. Otherwise, show modifications at
645 or within the specified paths.</p>
646 <p class="Pp">If changes have been staged with <code class="Cm">got
647 stage</code>, staged changes are shown in the second output column,
648 using the following status codes:</p>
649 <table class="Bl-column">
652 <td>file modification is staged</td>
656 <td>file addition is staged</td>
660 <td>file deletion is staged</td>
663 <p class="Pp">Changes created on top of staged changes are indicated in the
665 <table class="Bl-column">
668 <td>file was modified after earlier changes have been staged</td>
672 <td>file was modified after having been staged for addition</td>
675 <p class="Pp">The options for <code class="Cm">got status</code> are as
678 <dt id="I~2"><a class="permalink" href="#I~2"><code class="Fl">-I</code></a></dt>
679 <dd>Show unversioned files even if they match an ignore pattern.</dd>
680 <dt id="S"><a class="permalink" href="#S"><code class="Fl">-S</code></a>
681 <var class="Ar">status-codes</var></dt>
682 <dd>Suppress the output of files with a modification status matching any
683 of the single-character status codes contained in the
684 <var class="Ar">status-codes</var> argument. Any combination of codes
685 from the above list of possible status codes may be specified. For
686 staged files, status codes displayed in either column will be matched.
687 Cannot be used together with the <code class="Fl">-s</code>
689 <dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>
690 <var class="Ar">status-codes</var></dt>
691 <dd>Only show files with a modification status matching any of the
692 single-character status codes contained in the
693 <var class="Ar">status-codes</var> argument. Any combination of codes
694 from the above list of possible status codes may be specified. For
695 staged files, status codes displayed in either column will be matched.
696 Cannot be used together with the <code class="Fl">-S</code>
699 <p class="Pp">For compatibility with <a class="Xr" aria-label="cvs, section
700 1">cvs(1)</a> and <a class="Xr" aria-label="git, section 1">git(1)</a>,
701 <code class="Cm">got status</code> reads <a class="Xr" aria-label="glob,
702 section 7">glob(7)</a> patterns from <span class="Pa">.cvsignore</span>
703 and <span class="Pa">.gitignore</span> files in each traversed directory
704 and will not display unversioned files which match these patterns.
705 Ignore patterns which end with a slash, “/”, will only
706 match directories. As an extension to <a class="Xr" aria-label="glob,
707 section 7">glob(7)</a> matching rules, <code class="Cm">got
708 status</code> supports consecutive asterisks, “**”, which
709 will match an arbitrary amount of directories. Unlike
710 <a class="Xr" aria-label="cvs, section 1">cvs(1)</a>,
711 <code class="Cm">got status</code> only supports a single ignore pattern
712 per line. Unlike <a class="Xr" aria-label="git, section 1">git(1)</a>,
713 <code class="Cm">got status</code> does not support negated ignore
714 patterns prefixed with “!”, and gives no special
715 significance to the location of path component separators,
716 “/”, in a pattern.</p>
718 <dt id="log"><a class="permalink" href="#log"><code class="Cm">log</code></a>
719 [<code class="Fl">-bdPpRs</code>] [<code class="Fl">-C</code>
720 <var class="Ar">number</var>] [<code class="Fl">-c</code>
721 <var class="Ar">commit</var>] [<code class="Fl">-l</code>
722 <var class="Ar">N</var>] [<code class="Fl">-r</code>
723 <var class="Ar">repository-path</var>] [<code class="Fl">-S</code>
724 <var class="Ar">search-pattern</var>] [<code class="Fl">-x</code>
725 <var class="Ar">commit</var>] [<var class="Ar">path</var>]</dt>
726 <dd>Display history of a repository. If a <var class="Ar">path</var> is
727 specified, show only commits which modified this path. If invoked in a
728 work tree, the <var class="Ar">path</var> is interpreted relative to the
729 current working directory, and the work tree's path prefix is implicitly
730 prepended. Otherwise, the path is interpreted relative to the repository
732 <p class="Pp">The options for <code class="Cm">got log</code> are as
735 <dt id="b~6"><a class="permalink" href="#b~6"><code class="Fl">-b</code></a></dt>
736 <dd>Display individual commits which were merged into the current branch
737 from other branches. By default, <code class="Cm">got log</code> shows
738 the linear history of the current branch only.</dd>
739 <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a>
740 <var class="Ar">number</var></dt>
741 <dd>Set the number of context lines shown in diffs with
742 <code class="Fl">-p</code>. By default, 3 lines of context are
744 <dt id="c~3"><a class="permalink" href="#c~3"><code class="Fl">-c</code></a>
745 <var class="Ar">commit</var></dt>
746 <dd>Start traversing history at the specified
747 <var class="Ar">commit</var>. If this option is not specified, default
748 to the work tree's current branch if invoked in a work tree, or to the
749 repository's HEAD reference.
750 <p class="Pp" id="bar:+3">The expected <var class="Ar">commit</var>
751 argument is a commit ID SHA1 hash, or a reference name or a keyword
752 which will be resolved to a commit ID. An abbreviated hash argument
753 will be expanded to a full SHA1 hash automatically, provided the
754 abbreviation is unique. The keywords ":base" and
755 ":head" resolve to the work tree's base commit and branch
756 head, respectively. The former is only valid if invoked in a work
757 tree, while the latter will resolve to the tip of the work tree's
758 current branch if invoked in a work tree, otherwise it will resolve
759 to the repository's HEAD reference. Keywords and references may be
760 appended with ":+" or ":-" modifiers and an
761 optional integer N to denote the Nth descendant or antecedent,
762 respectively, by first parent traversal; for example,
763 <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
764 generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
765 generation descendant of the work tree's base commit. Similarly,
766 <a class="permalink" href="#bar:+3"><b class="Sy">bar:+3</b></a>
767 will denote the 3rd generation descendant of the commit resolved by
768 the "bar" reference. A ":+" or ":-"
769 modifier without a trailing integer has an implicit "1"
770 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
771 <b class="Sy">:base:+1</b>).</p>
773 <dt id="d~2"><a class="permalink" href="#d~2"><code class="Fl">-d</code></a></dt>
774 <dd>Display diffstat of changes introduced in each commit. Cannot be used
775 with the <code class="Fl">-s</code> option. Implies the
776 <code class="Fl">-P</code> option (diffstat displays a list of changed
778 <dt id="l~3"><a class="permalink" href="#l~3"><code class="Fl">-l</code></a>
779 <var class="Ar">N</var></dt>
780 <dd>Limit history traversal to a given number of commits. If this option
781 is not specified, a default limit value of zero is used, which is
782 treated as an unbounded limit. The
783 <code class="Ev">GOT_LOG_DEFAULT_LIMIT</code> environment variable may
784 be set to change this default value.</dd>
785 <dt id="P"><a class="permalink" href="#P"><code class="Fl">-P</code></a></dt>
786 <dd>Display the list of file paths changed in each commit, using the
787 following status codes:
788 <table class="Bl-column">
791 <td>modified file</td>
795 <td>file was deleted</td>
799 <td>new file was added</td>
803 <td>modified file modes (executable bit only)</td>
806 <p class="Pp">Cannot be used with the <code class="Fl">-s</code>
809 <dt id="p~2"><a class="permalink" href="#p~2"><code class="Fl">-p</code></a></dt>
810 <dd>Display the patch of modifications made in each commit. If a
811 <var class="Ar">path</var> is specified, only show the patch of
812 modifications at or within this path. Cannot be used with the
813 <code class="Fl">-s</code> option.</dd>
814 <dt id="R~3"><a class="permalink" href="#R~3"><code class="Fl">-R</code></a></dt>
815 <dd>Determine a set of commits to display as usual, but display these
816 commits in reverse order.</dd>
817 <dt id="r~3"><a class="permalink" href="#r~3"><code class="Fl">-r</code></a>
818 <var class="Ar">repository-path</var></dt>
819 <dd>Use the repository at the specified path. If not specified, assume the
820 repository is located at or above the current working directory. If
821 this directory is a <code class="Nm">got</code> work tree, use the
822 repository path associated with this work tree.</dd>
823 <dt id="S~2"><a class="permalink" href="#S~2"><code class="Fl">-S</code></a>
824 <var class="Ar">search-pattern</var></dt>
825 <dd>If specified, show only commits with a log message, author name,
826 committer name, or ID SHA1 hash matched by the extended regular
827 expression <var class="Ar">search-pattern</var>. Lines in committed
828 patches will be matched if <code class="Fl">-p</code> is specified.
829 File paths changed by a commit will be matched if
830 <code class="Fl">-P</code> is specified. Regular expression syntax is
831 documented in <a class="Xr" aria-label="re_format, section
832 7">re_format(7)</a>.</dd>
833 <dt id="s~2"><a class="permalink" href="#s~2"><code class="Fl">-s</code></a></dt>
834 <dd>Display a short one-line summary of each commit, instead of the
835 default history format. Cannot be used together with the
836 <code class="Fl">-p</code> or <code class="Fl">-P</code> option.</dd>
837 <dt id="x"><a class="permalink" href="#x"><code class="Fl">-x</code></a>
838 <var class="Ar">commit</var></dt>
839 <dd>Stop traversing commit history immediately after the specified
840 <var class="Ar">commit</var> has been traversed. Like
841 <code class="Fl">-c</code>, the expected <var class="Ar">commit</var>
842 argument is a commit ID SHA1 hash, or a reference name or a keyword
843 which will be resolved to a commit ID. This option has no effect if
844 the specified <var class="Ar">commit</var> is never traversed.</dd>
847 <dt id="di"><a class="permalink" href="#diff"><code class="Cm" id="diff">diff</code></a>
848 [<code class="Fl">-adPsw</code>] [<code class="Fl">-C</code>
849 <var class="Ar">number</var>] [<code class="Fl">-c</code>
850 <var class="Ar">commit</var>] [<code class="Fl">-r</code>
851 <var class="Ar">repository-path</var>] [<var class="Ar">object1</var>
852 <var class="Ar">object2</var> | <var class="Ar">path ...</var>]</dt>
854 <div class="Bd Bd-indent"><code class="Li">(alias:
855 <code class="Cm">di</code>)</code></div>
856 When invoked within a work tree without any arguments, display all local
857 changes in the work tree. If one or more <var class="Ar">path</var>
858 arguments are specified, only show changes within the specified paths.
859 <p class="Pp">If two arguments are provided, treat each argument as a
860 reference, a tag name, or an object ID SHA1 hash, and display
861 differences between the corresponding objects. Both objects must be of
862 the same type (blobs, trees, or commits). An abbreviated hash argument
863 will be expanded to a full SHA1 hash automatically, provided the
864 abbreviation is unique. If none of these interpretations produce a valid
865 result or if the <code class="Fl">-P</code> option is used, and if
866 <code class="Cm">got diff</code> is running in a work tree, attempt to
867 interpret the two arguments as paths.</p>
868 <p class="Pp">The options for <code class="Cm">got diff</code> are as
871 <dt id="a~3"><a class="permalink" href="#a~3"><code class="Fl">-a</code></a></dt>
872 <dd>Treat file contents as ASCII text even if binary data is
874 <dt id="C~2"><a class="permalink" href="#C~2"><code class="Fl">-C</code></a>
875 <var class="Ar">number</var></dt>
876 <dd>Set the number of context lines shown in the diff. By default, 3 lines
877 of context are shown.</dd>
878 <dt id="c~4"><a class="permalink" href="#c~4"><code class="Fl">-c</code></a>
879 <var class="Ar">commit</var></dt>
880 <dd>Show differences between commits in the repository. This option may be
881 used up to two times. When used only once, show differences between
882 the specified <var class="Ar">commit</var> and its first parent
883 commit. When used twice, show differences between the two specified
885 <p class="Pp">If the <code class="Fl">-c</code> option is used, all
886 non-option arguments will be interpreted as paths. If one or more
887 such <var class="Ar">path</var> arguments are provided, only show
888 differences for the specified paths.</p>
889 <p class="Pp" id="baz:+8">The expected <var class="Ar">commit</var>
890 argument is a commit ID SHA1 hash, or a reference name or a keyword
891 which will be resolved to a commit ID. An abbreviated hash argument
892 will be expanded to a full SHA1 hash automatically, provided the
893 abbreviation is unique. The keywords ":base" and
894 ":head" resolve to the work tree's base commit and branch
895 head, respectively. The former is only valid if invoked in a work
896 tree, while the latter will resolve to the tip of the work tree's
897 current branch if invoked in a work tree, otherwise it will resolve
898 to the repository's HEAD reference. Keywords and references may be
899 appended with ":+" or ":-" modifiers and an
900 optional integer N to denote the Nth descendant or antecedent,
901 respectively, by first parent traversal; for example,
902 <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
903 generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
904 generation descendant of the work tree's base commit. Similarly,
905 <a class="permalink" href="#baz:+8"><b class="Sy">baz:+8</b></a>
906 will denote the 8th generation descendant of the commit resolved by
907 the "baz" reference. If an integer does not follow the
908 ":+" or ":-" modifier, a "1" is
909 implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
910 to <b class="Sy">:head:-1</b>).</p>
911 <p class="Pp">Cannot be used together with the
912 <code class="Fl">-P</code> option.</p>
914 <dt id="d~3"><a class="permalink" href="#d~3"><code class="Fl">-d</code></a></dt>
915 <dd>Display diffstat of changes before the actual diff by annotating each
916 file path or blob hash being diffed with the total number of lines
917 added and removed. A summary line will display the total number of
918 changes across all files.</dd>
919 <dt id="P~2"><a class="permalink" href="#P~2"><code class="Fl">-P</code></a></dt>
920 <dd>Interpret all arguments as paths only. This option can be used to
921 resolve ambiguity in cases where paths look like tag names, reference
922 names, or object IDs. This option is only valid when
923 <code class="Cm">got diff</code> is invoked in a work tree.</dd>
924 <dt id="r~4"><a class="permalink" href="#r~4"><code class="Fl">-r</code></a>
925 <var class="Ar">repository-path</var></dt>
926 <dd>Use the repository at the specified path. If not specified, assume the
927 repository is located at or above the current working directory. If
928 this directory is a <code class="Nm">got</code> work tree, use the
929 repository path associated with this work tree.</dd>
930 <dt id="s~3"><a class="permalink" href="#s~3"><code class="Fl">-s</code></a></dt>
931 <dd>Show changes staged with <code class="Cm">got stage</code> instead of
932 showing local changes in the work tree. This option is only valid when
933 <code class="Cm">got diff</code> is invoked in a work tree.</dd>
934 <dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a></dt>
935 <dd>Ignore whitespace-only changes.</dd>
938 <dt id="bl"><a class="permalink" href="#blame"><code class="Cm" id="blame">blame</code></a>
939 [<code class="Fl">-c</code> <var class="Ar">commit</var>]
940 [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
941 <var class="Ar">path</var></dt>
943 <div class="Bd Bd-indent"><code class="Li">(alias:
944 <code class="Cm">bl</code>)</code></div>
945 Display line-by-line history of a file at the specified path.
946 <p class="Pp">The options for <code class="Cm">got blame</code> are as
949 <dt id="c~5"><a class="permalink" href="#c~5"><code class="Fl">-c</code></a>
950 <var class="Ar">commit</var></dt>
951 <dd>Start traversing history at the specified
952 <var class="Ar">commit</var>. The expected argument is a commit ID
953 SHA1 hash, or a reference name or a keyword which will be resolved to
954 a commit ID. An abbreviated hash argument will be expanded to a full
955 SHA1 hash automatically, provided the abbreviation is unique. The
956 keywords ":base" and ":head" resolve to the work
957 tree's base commit and branch head, respectively. The former is only
958 valid if invoked in a work tree, while the latter will resolve to the
959 tip of the work tree's current branch if invoked in a work tree,
960 otherwise it will resolve to the repository's HEAD reference. Keywords
961 and references may be appended with ":+" or ":-"
962 modifiers and an optional integer N to denote the Nth descendant or
963 antecedent by first parent traversal, respectively; for example,
964 <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
965 generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
966 generation descendant of the work tree's base commit. Similarly,
967 <a class="permalink" href="#xyz:-5"><b class="Sy" id="xyz:-5">xyz:-5</b></a>
968 will denote the 5th generation ancestor of the commit resolved by the
969 "xyz" reference. A ":+" or ":-" modifier
970 without a trailing integer has an implicit "1" appended
971 (e.g., <b class="Sy">:base:+</b> is equivalent to
972 <b class="Sy">:base:+1</b>).</dd>
973 <dt id="r~5"><a class="permalink" href="#r~5"><code class="Fl">-r</code></a>
974 <var class="Ar">repository-path</var></dt>
975 <dd>Use the repository at the specified path. If not specified, assume the
976 repository is located at or above the current working directory. If
977 this directory is a <code class="Nm">got</code> work tree, use the
978 repository path associated with this work tree.</dd>
981 <dt id="tr"><a class="permalink" href="#tree"><code class="Cm" id="tree">tree</code></a>
982 [<code class="Fl">-iR</code>] [<code class="Fl">-c</code>
983 <var class="Ar">commit</var>] [<code class="Fl">-r</code>
984 <var class="Ar">repository-path</var>] [<var class="Ar">path</var>]</dt>
986 <div class="Bd Bd-indent"><code class="Li">(alias:
987 <code class="Cm">tr</code>)</code></div>
988 Display a listing of files and directories at the specified directory path
989 in the repository. Entries shown in this listing may carry one of the
990 following trailing annotations:
991 <table class="Bl-column">
994 <td>entry is a symbolic link</td>
998 <td>entry is a directory</td>
1002 <td>entry is an executable file</td>
1006 <td>entry is a Git submodule</td>
1009 <p class="Pp">Symbolic link entries are also annotated with the target path
1011 <p class="Pp">If no <var class="Ar">path</var> is specified, list the
1012 repository path corresponding to the current directory of the work tree,
1013 or the root directory of the repository if there is no work tree.</p>
1014 <p class="Pp">The options for <code class="Cm">got tree</code> are as
1017 <dt id="c~6"><a class="permalink" href="#c~6"><code class="Fl">-c</code></a>
1018 <var class="Ar">commit</var></dt>
1019 <dd>List files and directories as they appear in the specified
1020 <var class="Ar">commit</var>.
1021 <p class="Pp" id="spam:-3">The expected argument is a commit ID SHA1
1022 hash, or a reference name or a keyword which will be resolved to a
1023 commit ID. An abbreviated hash argument will be expanded to a full
1024 SHA1 hash automatically, provided the abbreviation is unique. The
1025 keywords ":base" and ":head" resolve to the work
1026 tree's base commit and branch head, respectively. The former is only
1027 valid if invoked in a work tree, while the latter will resolve to
1028 the tip of the work tree's current branch if invoked in a work tree,
1029 otherwise it will resolve to the repository's HEAD reference.
1030 Keywords and references may be appended with ":+" or
1031 ":-" modifiers and an optional integer N to denote the Nth
1032 descendant or antecedent by first parent traversal, respectively;
1033 for example, <b class="Sy">:head:-2</b> denotes the work tree branch
1034 head's 2nd generation ancestor, and <b class="Sy">:base:+4</b>
1035 denotes the 4th generation descendant of the work tree's base
1037 <a class="permalink" href="#spam:-3"><b class="Sy">spam:-3</b></a>
1038 will denote the 3rd generation ancestor of the commit resolved by
1039 the "spam" reference. A ":+" or ":-"
1040 modifier without a trailing integer has an implicit "1"
1041 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1042 <b class="Sy">:base:+1</b>).</p>
1044 <dt id="i"><a class="permalink" href="#i"><code class="Fl">-i</code></a></dt>
1045 <dd>Show object IDs of files (blob objects) and directories (tree
1047 <dt id="R~4"><a class="permalink" href="#R~4"><code class="Fl">-R</code></a></dt>
1048 <dd>Recurse into sub-directories in the repository.</dd>
1049 <dt id="r~6"><a class="permalink" href="#r~6"><code class="Fl">-r</code></a>
1050 <var class="Ar">repository-path</var></dt>
1051 <dd>Use the repository at the specified path. If not specified, assume the
1052 repository is located at or above the current working directory. If
1053 this directory is a <code class="Nm">got</code> work tree, use the
1054 repository path associated with this work tree.</dd>
1057 <dt id="ref"><a class="permalink" href="#ref"><code class="Cm">ref</code></a>
1058 [<code class="Fl">-dlt</code>] [<code class="Fl">-c</code>
1059 <var class="Ar">object</var>] [<code class="Fl">-r</code>
1060 <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1061 <var class="Ar">reference</var>] [<var class="Ar">name</var>]</dt>
1062 <dd>Manage references in a repository.
1063 <p class="Pp">References may be listed, created, deleted, and changed. When
1064 creating, deleting, or changing a reference the specified
1065 <var class="Ar">name</var> must be an absolute reference name, i.e. it
1066 must begin with “refs/”.</p>
1067 <p class="Pp">The options for <code class="Cm">got ref</code> are as
1070 <dt id="c~7"><a class="permalink" href="#c~7"><code class="Fl">-c</code></a>
1071 <var class="Ar">object</var></dt>
1072 <dd>Create a reference or change an existing reference. The reference with
1073 the specified <var class="Ar">name</var> will point at the specified
1074 <var class="Ar">object</var>.
1075 <p class="Pp" id="tagged:-3">The expected <var class="Ar">object</var>
1076 argument is an ID SHA1 hash or an existing reference or tag name or
1077 a keyword which will be resolved to the ID of a corresponding
1078 commit, tree, tag, or blob object. An abbreviated hash argument will
1079 be expanded to a full SHA1 hash automatically, provided the
1080 abbreviation is unique. The keywords ":base" and
1081 ":head" resolve to the work tree's base commit and branch
1082 head, respectively. The former is only valid if invoked in a work
1083 tree, while the latter will resolve to the tip of the work tree's
1084 current branch if invoked in a work tree, otherwise it will resolve
1085 to the repository's HEAD reference. Keywords and reference names may
1086 be appended with ":+" or ":-" modifiers and an
1087 optional integer N to denote the Nth descendant or antecedent by
1088 first parent traversal, respectively; for example,
1089 <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1090 generation ancestor, and
1091 <a class="permalink" href="#tagged:-3"><b class="Sy">tagged:-3</b></a>
1092 will denote the 3rd generation ancestor of the commit resolved by
1093 the "tagged" reference. If an integer does not follow the
1094 ":+" or ":-" modifier, a "1" is
1095 implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
1096 to <b class="Sy">:head:-1</b>).</p>
1097 <p class="Pp">Cannot be used together with any other options except
1098 <code class="Fl">-r</code>.</p>
1100 <dt id="d~4"><a class="permalink" href="#d~4"><code class="Fl">-d</code></a></dt>
1101 <dd>Delete the reference with the specified <var class="Ar">name</var>
1102 from the repository. Any commit, tree, tag, and blob objects belonging
1103 to deleted references remain in the repository and may be removed
1104 separately with Git's garbage collector or <code class="Cm">gotadmin
1105 cleanup</code>. Cannot be used together with any other options except
1106 <code class="Fl">-r</code>.</dd>
1107 <dt id="l~4"><a class="permalink" href="#l~4"><code class="Fl">-l</code></a></dt>
1108 <dd>List references in the repository. If no <var class="Ar">name</var> is
1109 specified, list all existing references in the repository. If
1110 <var class="Ar">name</var> is a reference namespace, list all
1111 references in this namespace. Otherwise, show only the reference with
1112 the given <var class="Ar">name</var>. Cannot be used together with any
1113 other options except <code class="Fl">-r</code> and
1114 <code class="Fl">-t</code>.</dd>
1115 <dt id="r~7"><a class="permalink" href="#r~7"><code class="Fl">-r</code></a>
1116 <var class="Ar">repository-path</var></dt>
1117 <dd>Use the repository at the specified path. If not specified, assume the
1118 repository is located at or above the current working directory. If
1119 this directory is a <code class="Nm">got</code> work tree, use the
1120 repository path associated with this work tree.</dd>
1121 <dt id="s~4"><a class="permalink" href="#s~4"><code class="Fl">-s</code></a>
1122 <var class="Ar">reference</var></dt>
1123 <dd>Create a symbolic reference, or change an existing symbolic reference.
1124 The symbolic reference with the specified <var class="Ar">name</var>
1125 will point at the specified <var class="Ar">reference</var> which must
1126 already exist in the repository. Care should be taken not to create
1127 loops between references when this option is used. Cannot be used
1128 together with any other options except
1129 <code class="Fl">-r</code>.</dd>
1130 <dt id="t~2"><a class="permalink" href="#t~2"><code class="Fl">-t</code></a></dt>
1131 <dd>Sort listed references by modification time (most recently modified
1132 first) instead of sorting by lexicographical order. Use of this option
1133 requires the <code class="Fl">-l</code> option to be used as
1137 <dt id="br"><a class="permalink" href="#branch"><code class="Cm" id="branch">branch</code></a>
1138 [<code class="Fl">-lnt</code>] [<code class="Fl">-c</code>
1139 <var class="Ar">commit</var>] [<code class="Fl">-d</code>
1140 <var class="Ar">name</var>] [<code class="Fl">-r</code>
1141 <var class="Ar">repository-path</var>] [<var class="Ar">name</var>]</dt>
1143 <div class="Bd Bd-indent"><code class="Li">(alias:
1144 <code class="Cm">br</code>)</code></div>
1145 Create, list, or delete branches.
1146 <p class="Pp">Local branches are managed via references which live in the
1147 “refs/heads/” reference namespace. The
1148 <code class="Cm">got branch</code> command creates references in this
1150 <p class="Pp">When deleting branches, the specified
1151 <var class="Ar">name</var> is searched in the “refs/heads”
1152 reference namespace first. If no corresponding branch is found, the
1153 “refs/remotes” namespace will be searched next.</p>
1154 <p class="Pp">If invoked in a work tree without any arguments, print the
1155 name of the work tree's current branch.</p>
1156 <p class="Pp">If a <var class="Ar">name</var> argument is passed, attempt to
1157 create a branch reference with the given name. By default the new branch
1158 reference will point at the latest commit on the work tree's current
1159 branch if invoked in a work tree, and otherwise to a commit resolved via
1160 the repository's HEAD reference.</p>
1161 <p class="Pp">If invoked in a work tree, once the branch was created
1162 successfully switch the work tree's head reference to the newly created
1163 branch and update files across the entire work tree, just like
1164 <code class="Cm">got update -b</code> <var class="Ar">name</var> would
1165 do. Show the status of each affected file, using the following status
1167 <table class="Bl-column">
1170 <td>file was updated and contained no local changes</td>
1174 <td>file was updated and local changes were merged cleanly</td>
1178 <td>file was updated and conflicts occurred during merge</td>
1182 <td>file was deleted</td>
1186 <td>new file was added</td>
1190 <td>versioned file is obstructed by a non-regular file</td>
1194 <td>a missing versioned file was restored</td>
1197 <p class="Pp">The options for <code class="Cm">got branch</code> are as
1200 <dt id="c~8"><a class="permalink" href="#c~8"><code class="Fl">-c</code></a>
1201 <var class="Ar">commit</var></dt>
1202 <dd>Make a newly created branch reference point at the specified
1203 <var class="Ar">commit</var>. The expected argument is a commit ID
1204 SHA1 hash, or a reference name or keyword which will be resolved to a
1205 commit ID. An abbreviated hash argument will be expanded to a full
1206 SHA1 hash automatically, provided the abbreviation is unique. The
1207 keywords ":base" and ":head" resolve to the work
1208 tree's base commit and branch head, respectively. The former is only
1209 valid if invoked in a work tree, while the latter will resolve to the
1210 tip of the work tree's current branch if invoked in a work tree,
1211 otherwise it will resolve to the repository's HEAD reference. Keywords
1212 and references may be appended with ":+" or ":-"
1213 modifiers and an optional integer N to denote the Nth descendant or
1214 antecedent by first parent traversal, respectively; for example,
1215 <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1216 generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1217 generation descendant of the work tree's base commit. Similarly,
1218 <a class="permalink" href="#foobar:+3"><b class="Sy" id="foobar:+3">foobar:+3</b></a>
1219 will denote the 3rd generation descendant of the commit resolved by
1220 the "foobar" reference. A ":+" or ":-"
1221 modifier without a trailing integer has an implicit "1"
1222 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1223 <b class="Sy">:base:+1</b>).</dd>
1224 <dt id="d~5"><a class="permalink" href="#d~5"><code class="Fl">-d</code></a>
1225 <var class="Ar">name</var></dt>
1226 <dd>Delete the branch with the specified <var class="Ar">name</var> from
1227 the “refs/heads” or “refs/remotes”
1228 reference namespace.
1229 <p class="Pp">Only the branch reference is deleted. Any commit, tree,
1230 and blob objects belonging to the branch remain in the repository
1231 and may be removed separately with Git's garbage collector or
1232 <code class="Cm">gotadmin cleanup</code>.</p>
1234 <dt id="l~5"><a class="permalink" href="#l~5"><code class="Fl">-l</code></a></dt>
1235 <dd>List all existing branches in the repository, including copies of
1236 remote repositories' branches in the “refs/remotes/”
1237 reference namespace.
1238 <p class="Pp">If invoked in a work tree, the work tree's current branch
1239 is shown with one of the following annotations:</p>
1240 <table class="Bl-column">
1243 <td>work tree's base commit and the base commit of all tracked files
1244 matches the branch tip</td>
1248 <td>work tree comprises mixed commits or its base commit is
1253 <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
1254 <dd>Do not switch and update the work tree after creating a new
1256 <dt id="r~8"><a class="permalink" href="#r~8"><code class="Fl">-r</code></a>
1257 <var class="Ar">repository-path</var></dt>
1258 <dd>Use the repository at the specified path. If not specified, assume the
1259 repository is located at or above the current working directory. If
1260 this directory is a <code class="Nm">got</code> work tree, use the
1261 repository path associated with this work tree.</dd>
1262 <dt id="t~3"><a class="permalink" href="#t~3"><code class="Fl">-t</code></a></dt>
1263 <dd>Sort listed branches by modification time (most recently modified
1264 first) instead of sorting by lexicographical order. Branches in the
1265 “refs/heads/” reference namespace are listed before
1266 branches in “refs/remotes/” regardless. Use of this
1267 option requires the <code class="Fl">-l</code> option to be used as
1271 <dt id="tag"><a class="permalink" href="#tag"><code class="Cm">tag</code></a>
1272 [<code class="Fl">-lVv</code>] [<code class="Fl">-c</code>
1273 <var class="Ar">commit</var>] [<code class="Fl">-m</code>
1274 <var class="Ar">message</var>] [<code class="Fl">-r</code>
1275 <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1276 <var class="Ar">signer-id</var>] <var class="Ar">name</var></dt>
1277 <dd>Manage tags in a repository.
1278 <p class="Pp">Tags are managed via references which live in the
1279 “refs/tags/” reference namespace. The <code class="Cm">got
1280 tag</code> command operates on references in this namespace only.
1281 References in this namespace point at tag objects which contain a
1282 pointer to another object, a tag message, as well as author and
1283 timestamp information.</p>
1284 <p class="Pp">Attempt to create a tag with the given
1285 <var class="Ar">name</var>, and make this tag point at the given
1286 <var class="Ar">commit</var>. If no commit is specified, default to the
1287 latest commit on the work tree's current branch if invoked in a work
1288 tree, and to a commit resolved via the repository's HEAD reference
1290 <p class="Pp">The options for <code class="Cm">got tag</code> are as
1293 <dt id="c~9"><a class="permalink" href="#c~9"><code class="Fl">-c</code></a>
1294 <var class="Ar">commit</var></dt>
1295 <dd>Make the newly created tag reference point at the specified
1296 <var class="Ar">commit</var>. The expected
1297 <var class="Ar">commit</var> argument is a commit ID SHA1 hash, or a
1298 reference or keyword which will be resolved to a commit ID. An
1299 abbreviated hash argument will be expanded to a full SHA1 hash
1300 automatically, provided the abbreviation is unique. The keywords
1301 ":base" and ":head" resolve to the work tree's
1302 base commit and branch head, respectively. The former is only valid if
1303 invoked in a work tree, while the latter will resolve to the tip of
1304 the work tree's current branch if invoked in a work tree, otherwise it
1305 will resolve to the repository's HEAD reference. Keywords and
1306 references may be appended with ":+" or ":-"
1307 modifiers and an optional integer N to denote the Nth descendant or
1308 antecedent by first parent traversal, respectively; for example,
1309 <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1310 generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1311 generation descendant of the work tree's base commit. Similarly,
1312 <a class="permalink" href="#eggs:-3"><b class="Sy" id="eggs:-3">eggs:-3</b></a>
1313 will denote the 3rd generation ancestor of the commit resolved by the
1314 "eggs" reference. A ":+" or ":-"
1315 modifier without a trailing integer has an implicit "1"
1316 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1317 <b class="Sy">:base:+1</b>).</dd>
1318 <dt id="l~6"><a class="permalink" href="#l~6"><code class="Fl">-l</code></a></dt>
1319 <dd>List all existing tags in the repository instead of creating a new
1320 tag. If a <var class="Ar">name</var> argument is passed, show only the
1321 tag with the given <var class="Ar">name</var>.</dd>
1322 <dt id="m~3"><a class="permalink" href="#m~3"><code class="Fl">-m</code></a>
1323 <var class="Ar">message</var></dt>
1324 <dd>Use the specified tag message when creating the new tag. Without the
1325 <code class="Fl">-m</code> option, <code class="Cm">got tag</code>
1326 opens a temporary file in an editor where a tag message can be
1327 written. Quitting the editor without saving the file will abort the
1329 <dt id="r~9"><a class="permalink" href="#r~9"><code class="Fl">-r</code></a>
1330 <var class="Ar">repository-path</var></dt>
1331 <dd>Use the repository at the specified path. If not specified, assume the
1332 repository is located at or above the current working directory. If
1333 this directory is a <code class="Nm">got</code> work tree, use the
1334 repository path associated with this work tree.</dd>
1335 <dt id="s~5"><a class="permalink" href="#s~5"><code class="Fl">-s</code></a>
1336 <var class="Ar">signer-id</var></dt>
1337 <dd>While creating a new tag, sign this tag with the identity given in
1338 <var class="Ar">signer-id</var>.
1339 <p class="Pp">For SSH-based signatures, <var class="Ar">signer-id</var>
1340 is the path to a file which may refer to either a private SSH key,
1341 or a public SSH key with the private half available via
1342 <a class="Xr" aria-label="ssh-agent, section 1">ssh-agent(1)</a>.
1343 <code class="Cm">got tag</code> will sign the tag object by invoking
1344 <a class="Xr" aria-label="ssh-keygen, section 1">ssh-keygen(1)</a>
1345 with the <code class="Fl">-Y</code> <code class="Cm">sign</code>
1346 command, using the signature namespace “git” for
1347 compatibility with <a class="Xr" aria-label="git, section
1350 <dt id="V~2"><a class="permalink" href="#V~2"><code class="Fl">-V</code></a></dt>
1351 <dd>Verify tag object signatures. If a <var class="Ar">name</var> is
1352 specified, show and verify the tag object with the provided name.
1353 Otherwise, list all tag objects and verify signatures where present.
1354 <p class="Pp"><code class="Cm">got tag</code> verifies SSH-based
1355 signatures by invoking <a class="Xr" aria-label="ssh-keygen, section
1356 1">ssh-keygen(1)</a> with the options <code class="Fl">-Y</code>
1357 <code class="Cm">verify</code> <code class="Fl">-f</code>
1358 <var class="Ar">allowed_signers</var>. A path to the
1359 <var class="Ar">allowed_signers</var> file must be set in
1360 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>,
1361 otherwise verification is impossible.</p>
1363 <dt id="v~3"><a class="permalink" href="#v~3"><code class="Fl">-v</code></a></dt>
1364 <dd>Verbose mode. During SSH signature creation and verification this
1365 option will be passed to <a class="Xr" aria-label="ssh-keygen, section
1366 1">ssh-keygen(1)</a>. Multiple -v options increase the verbosity. The
1369 <p class="Pp">By design, the <code class="Cm">got tag</code> command will
1370 not delete tags or change existing tags. If a tag must be deleted, the
1371 <code class="Cm">got ref</code> command may be used to delete a tag's
1372 reference. This should only be done if the tag has not already been
1373 copied to another repository.</p>
1375 <dt id="add"><a class="permalink" href="#add"><code class="Cm">add</code></a>
1376 [<code class="Fl">-IR</code>] <var class="Ar">path ...</var></dt>
1377 <dd>Schedule unversioned files in a work tree for addition to the repository
1378 in the next commit. By default, files which match a <code class="Cm">got
1379 status</code> ignore pattern will not be added.
1380 <p class="Pp">If a <var class="Ar">path</var> mentioned in the command line
1381 is not an unversioned file then <code class="Cm">got add</code> may
1382 raise an error. To avoid unnecessary errors from paths picked up by file
1383 globbing patterns in the shell, paths in the argument list will be
1384 silently ignored if they are not reported by <code class="Cm">got
1385 status</code> at all, or if they are reported with one of the following
1386 status codes and do not have changes staged via <code class="Cm">got
1388 <table class="Bl-column">
1391 <td>modified file</td>
1395 <td>file scheduled for addition in next commit</td>
1399 <td>modified or added file which contains merge conflicts</td>
1403 <td>modified file modes (executable bit only)</td>
1406 <p class="Pp">The options for <code class="Cm">got add</code> are as
1409 <dt id="I~3"><a class="permalink" href="#I~3"><code class="Fl">-I</code></a></dt>
1410 <dd>Add files even if they match a <code class="Cm">got status</code>
1411 ignore pattern.</dd>
1412 <dt id="R~5"><a class="permalink" href="#R~5"><code class="Fl">-R</code></a></dt>
1413 <dd>Permit recursion into directories. If this option is not specified,
1414 <code class="Cm">got add</code> will refuse to run if a specified
1415 <var class="Ar">path</var> is a directory.</dd>
1418 <dt id="rm"><a class="permalink" href="#remove"><code class="Cm" id="remove">remove</code></a>
1419 [<code class="Fl">-fkR</code>] [<code class="Fl">-s</code>
1420 <var class="Ar">status-codes</var>] <var class="Ar">path ...</var></dt>
1422 <div class="Bd Bd-indent"><code class="Li">(alias:
1423 <code class="Cm">rm</code>)</code></div>
1424 Remove versioned files from a work tree and schedule them for deletion from
1425 the repository in the next commit.
1426 <p class="Pp">The options for <code class="Cm">got remove</code> are as
1429 <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a></dt>
1430 <dd>Perform the operation even if a file contains local modifications, and
1431 do not raise an error if a specified <var class="Ar">path</var> does
1432 not exist on disk.</dd>
1433 <dt id="k"><a class="permalink" href="#k"><code class="Fl">-k</code></a></dt>
1434 <dd>Keep affected files on disk.</dd>
1435 <dt id="R~6"><a class="permalink" href="#R~6"><code class="Fl">-R</code></a></dt>
1436 <dd>Permit recursion into directories. If this option is not specified,
1437 <code class="Cm">got remove</code> will refuse to run if a specified
1438 <var class="Ar">path</var> is a directory.</dd>
1439 <dt id="s~6"><a class="permalink" href="#s~6"><code class="Fl">-s</code></a>
1440 <var class="Ar">status-codes</var></dt>
1441 <dd>Only delete files with a modification status matching one of the
1442 single-character status codes contained in the
1443 <var class="Ar">status-codes</var> argument. The following status
1444 codes may be specified:
1445 <table class="Bl-column">
1448 <td>modified file (this implies the <code class="Fl">-f</code>
1453 <td>versioned file expected on disk but missing</td>
1459 <dt id="pa"><a class="permalink" href="#patch"><code class="Cm" id="patch">patch</code></a>
1460 [<code class="Fl">-nR</code>] [<code class="Fl">-c</code>
1461 <var class="Ar">commit</var>] [<code class="Fl">-p</code>
1462 <var class="Ar">strip-count</var>] [<var class="Ar">patchfile</var>]</dt>
1464 <div class="Bd Bd-indent"><code class="Li">(alias:
1465 <code class="Cm">pa</code>)</code></div>
1466 Apply changes from <var class="Ar">patchfile</var> to files in a work tree.
1467 Files added or removed by a patch will be scheduled for addition or
1468 removal in the work tree.
1469 <p class="Pp">The patch must be in the unified diff format as produced by
1470 <code class="Cm">got diff</code>, <a class="Xr" aria-label="git-diff,
1471 section 1">git-diff(1)</a>, or by <a class="Xr" aria-label="diff,
1472 section 1">diff(1)</a> and <a class="Xr" aria-label="cvs, section
1473 1">cvs(1)</a> diff when invoked with their <code class="Fl">-u</code>
1474 options. If no <var class="Ar">patchfile</var> argument is provided,
1475 read unified diff data from standard input instead.</p>
1476 <p class="Pp">If the <var class="Ar">patchfile</var> contains multiple
1477 patches, then attempt to apply each of them in sequence.</p>
1478 <p class="Pp">Show the status of each affected file, using the following
1480 <table class="Bl-column">
1483 <td>file was modified</td>
1487 <td>file was merged using a merge-base found in the repository</td>
1491 <td>file was merged and conflicts occurred during merge</td>
1495 <td>file was deleted</td>
1499 <td>file was added</td>
1503 <td>failed to patch the file</td>
1506 <p class="Pp">If a change does not match at its exact line number, attempt
1507 to apply it somewhere else in the file if a good spot can be found.
1508 Otherwise, the patch will fail to apply.</p>
1509 <p class="Pp"><code class="Nm">got</code> <code class="Cm">patch</code> will
1510 refuse to apply a patch if certain preconditions are not met. Files to
1511 be deleted must already be under version control, and must not have been
1512 scheduled for deletion already. Files to be added must not yet be under
1513 version control and must not already be present on disk. Files to be
1514 modified must already be under version control and may not contain
1515 conflict markers.</p>
1516 <p class="Pp">If an error occurs, the <code class="Cm">patch</code>
1517 operation will be aborted. Any changes made to the work tree up to this
1518 point will be left behind. Such changes can be viewed with
1519 <code class="Cm">got diff</code> and can be reverted with
1520 <code class="Cm">got revert</code> if needed.</p>
1521 <p class="Pp">The options for <code class="Cm">got patch</code> are as
1524 <dt id="c~10"><a class="permalink" href="#c~10"><code class="Fl">-c</code></a>
1525 <var class="Ar">commit</var></dt>
1526 <dd>Attempt to locate files within the specified
1527 <var class="Ar">commit</var> for use as a merge-base for 3-way merges.
1528 <p class="Pp">If the <code class="Fl">-c</code> option is not used then
1529 <code class="Cm">got patch</code> will attempt to locate merge-bases
1530 via object IDs found in <var class="Ar">patchfile</var> meta-data,
1531 such as produced by <code class="Cm">got diff</code> or
1532 <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a>. Use
1533 of the <code class="Fl">-c</code> option is only recommended in the
1534 absence of such meta-data.</p>
1535 <p class="Pp">Ideally, the specified <var class="Ar">commit</var> should
1536 contain versions of files which the changes contained in the
1537 <var class="Ar">patchfile</var> were based on. Files will be located
1538 by path, relative to the repository root. If the
1539 <code class="Fl">-p</code> option is used then leading path
1540 components will be stripped before paths are looked up in the
1542 <p class="Pp">In case no merge-base is available for a file, changes
1543 will be applied without doing a 3-way merge. Changes which do not
1544 apply cleanly may then be rejected entirely, rather than producing
1545 merge conflicts in the patched target file.</p>
1546 <p class="Pp" id="flan:+3">The expected <var class="Ar">commit</var>
1547 argument is a commit ID SHA1 hash, or a reference name or a keyword
1548 which will be resolved to a commit ID. An abbreviated hash argument
1549 will be expanded to a full SHA1 hash automatically, provided the
1550 abbreviation is unique. The keywords ":base" and
1551 ":head" resolve to the work tree's base commit and branch
1552 head, respectively. Keywords and references may be appended with
1553 ":+" or ":-" modifiers and an optional integer N
1554 to denote the Nth descendant or antecedent by first parent
1555 traversal, respectively; for example, <b class="Sy">:head:-2</b>
1556 denotes the work tree branch head's 2nd generation ancestor, and
1557 <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
1558 the work tree's base commit. Similarly,
1559 <a class="permalink" href="#flan:+3"><b class="Sy">flan:+3</b></a>
1560 will denote the 3rd generation descendant of the commit resolved by
1561 the "flan" reference. A ":+" or ":-"
1562 modifier without a trailing integer has an implicit "1"
1563 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1564 <b class="Sy">:base:+1</b>).</p>
1566 <dt id="n~2"><a class="permalink" href="#n~2"><code class="Fl">-n</code></a></dt>
1567 <dd>Do not make any modifications to the work tree. This can be used to
1568 check whether a patch would apply without issues. If the
1569 <var class="Ar">patchfile</var> contains diffs that affect the same
1570 file multiple times, the results displayed may be incorrect.</dd>
1571 <dt id="p~3"><a class="permalink" href="#p~3"><code class="Fl">-p</code></a>
1572 <var class="Ar">strip-count</var></dt>
1573 <dd>Specify the number of leading path components to strip from paths
1574 parsed from <var class="Ar">patchfile</var>. If the
1575 <code class="Fl">-p</code> option is not used, ‘a/’ and
1576 ‘b/’ path prefixes generated by
1577 <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a> will be
1578 recognized and stripped automatically.</dd>
1579 <dt id="R~7"><a class="permalink" href="#R~7"><code class="Fl">-R</code></a></dt>
1580 <dd>Reverse the patch before applying it.</dd>
1583 <dt id="rv"><a class="permalink" href="#revert"><code class="Cm" id="revert">revert</code></a>
1584 [<code class="Fl">-pR</code>] [<code class="Fl">-F</code>
1585 <var class="Ar">response-script</var>] <var class="Ar">path ...</var></dt>
1587 <div class="Bd Bd-indent"><code class="Li">(alias:
1588 <code class="Cm">rv</code>)</code></div>
1589 Revert any local changes in files at the specified paths in a work tree.
1590 File contents will be overwritten with those contained in the work tree's
1591 base commit. There is no way to bring discarded changes back after
1592 <code class="Cm">got revert</code>!
1593 <p class="Pp">If a file was added with <code class="Cm">got add</code>, it
1594 will become an unversioned file again. If a file was deleted with
1595 <code class="Cm">got remove</code>, it will be restored.</p>
1596 <p class="Pp">The options for <code class="Cm">got revert</code> are as
1599 <dt id="F"><a class="permalink" href="#F"><code class="Fl">-F</code></a>
1600 <var class="Ar">response-script</var></dt>
1601 <dd>With the <code class="Fl">-p</code> option, read “y”,
1602 “n”, and “q” responses line-by-line from
1603 the specified <var class="Ar">response-script</var> file instead of
1604 prompting interactively.</dd>
1605 <dt id="p~4"><a class="permalink" href="#p~4"><code class="Fl">-p</code></a></dt>
1606 <dd>Instead of reverting all changes in files, interactively select or
1607 reject changes to revert based on “y” (revert change),
1608 “n” (keep change), and “q” (quit reverting
1609 this file) responses. If a file is in modified status, individual
1610 patches derived from the modified file content can be reverted. Files
1611 in added or deleted status may only be reverted in their
1613 <dt id="R~8"><a class="permalink" href="#R~8"><code class="Fl">-R</code></a></dt>
1614 <dd>Permit recursion into directories. If this option is not specified,
1615 <code class="Cm">got revert</code> will refuse to run if a specified
1616 <var class="Ar">path</var> is a directory.</dd>
1619 <dt id="ci"><a class="permalink" href="#commit"><code class="Cm" id="commit">commit</code></a>
1620 [<code class="Fl">-CNnS</code>] [<code class="Fl">-A</code>
1621 <var class="Ar">author</var>] [<code class="Fl">-F</code>
1622 <var class="Ar">path</var>] [<code class="Fl">-m</code>
1623 <var class="Ar">message</var>] [<var class="Ar">path ...</var>]</dt>
1625 <div class="Bd Bd-indent"><code class="Li">(alias:
1626 <code class="Cm">ci</code>)</code></div>
1627 Create a new commit in the repository from changes in a work tree and use
1628 this commit as the new base commit for the work tree. If no
1629 <var class="Ar">path</var> is specified, commit all changes in the work
1630 tree. Otherwise, commit changes at or within the specified paths.
1631 <p class="Pp">If changes have been explicitly staged for commit with
1632 <code class="Cm">got stage</code>, only commit staged changes and reject
1633 any specified paths which have not been staged.</p>
1634 <p class="Pp"><code class="Cm">got commit</code> opens a temporary file in
1635 an editor where a log message can be written unless the
1636 <code class="Fl">-m</code> option is used or the
1637 <code class="Fl">-F</code> and <code class="Fl">-N</code> options are
1638 used together. Quitting the editor without saving the file will abort
1639 the commit operation.</p>
1640 <p class="Pp">Show the status of each affected file, using the following
1642 <table class="Bl-column">
1645 <td>modified file</td>
1649 <td>file was deleted</td>
1653 <td>new file was added</td>
1657 <td>modified file modes (executable bit only)</td>
1660 <p class="Pp">Files which are not part of the new commit will retain their
1661 previously recorded base commit. Some <code class="Nm">got</code>
1662 commands may refuse to run while the work tree contains files from
1663 multiple base commits. The base commit of such a work tree can be made
1664 consistent by running <code class="Cm">got update</code> across the
1665 entire work tree.</p>
1666 <p class="Pp">The <code class="Cm">got commit</code> command requires the
1667 <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
1668 unless an author has been configured in
1669 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1670 <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
1671 configuration settings can be obtained from the repository's
1672 <span class="Pa">.git/config</span> file or from Git's global
1673 <span class="Pa">~/.gitconfig</span> configuration file.</p>
1674 <p class="Pp">The options for <code class="Cm">got commit</code> are as
1677 <dt id="A"><a class="permalink" href="#A"><code class="Fl">-A</code></a>
1678 <var class="Ar">author</var></dt>
1679 <dd>Set author information in the newly created commit to
1680 <var class="Ar">author</var>. This is useful when committing changes
1681 on behalf of someone else. The <var class="Ar">author</var> argument
1682 must use the same format as the <code class="Ev">GOT_AUTHOR</code>
1683 environment variable.
1684 <p class="Pp">In addition to storing author information, the newly
1685 created commit object will retain “committer”
1686 information which is obtained, as usual, from the
1687 <code class="Ev">GOT_AUTHOR</code> environment variable, or
1688 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>, or
1689 Git configuration settings.</p>
1691 <dt id="C~3"><a class="permalink" href="#C~3"><code class="Fl">-C</code></a></dt>
1692 <dd>Allow committing files in conflicted status.
1693 <p class="Pp">Committing files with conflict markers should generally be
1694 avoided. Cases where conflict markers must be stored in the
1695 repository for some legitimate reason should be very rare. There are
1696 usually ways to avoid storing conflict markers verbatim by applying
1697 appropriate programming tricks.</p>
1699 <dt id="F~2"><a class="permalink" href="#F~2"><code class="Fl">-F</code></a>
1700 <var class="Ar">path</var></dt>
1701 <dd>Use the prepared log message stored in the file found at
1702 <var class="Ar">path</var> when creating the new commit.
1703 <code class="Cm">got commit</code> opens a temporary file in an editor
1704 where the prepared log message can be reviewed and edited further if
1705 needed. Cannot be used together with the <code class="Fl">-m</code>
1707 <dt id="m~4"><a class="permalink" href="#m~4"><code class="Fl">-m</code></a>
1708 <var class="Ar">message</var></dt>
1709 <dd>Use the specified log message when creating the new commit. Cannot be
1710 used together with the <code class="Fl">-F</code> option.</dd>
1711 <dt id="N"><a class="permalink" href="#N"><code class="Fl">-N</code></a></dt>
1712 <dd>This option prevents <code class="Cm">got commit</code> from opening
1713 the commit message in an editor. It has no effect unless it is used
1714 together with the <code class="Fl">-F</code> option and is intended
1715 for non-interactive use such as scripting.</dd>
1716 <dt id="n~3"><a class="permalink" href="#n~3"><code class="Fl">-n</code></a></dt>
1717 <dd>This option prevents <code class="Cm">got commit</code> from
1718 generating a diff of the to-be-committed changes in a temporary file
1719 which can be viewed while editing a commit message.</dd>
1720 <dt id="S~3"><a class="permalink" href="#S~3"><code class="Fl">-S</code></a></dt>
1721 <dd>Allow the addition of symbolic links which point outside of the path
1722 space that is under version control. By default, <code class="Cm">got
1723 commit</code> will reject such symbolic links due to safety concerns.
1724 As a precaution, <code class="Nm">got</code> may decide to represent
1725 such a symbolic link as a regular file which contains the link's
1726 target path, rather than creating an actual symbolic link which points
1727 outside of the work tree. Use of this option is discouraged because
1728 external mechanisms such as “make obj” are better suited
1729 for managing symbolic links to paths not under version control.</dd>
1731 <p class="Pp"><code class="Cm">got commit</code> will refuse to run if
1732 certain preconditions are not met. If the work tree's current branch is
1733 not in the “refs/heads/” reference namespace, new commits
1734 may not be created on this branch. Local changes may only be committed
1735 if they are based on file content found in the most recent commit on the
1736 work tree's branch. If a path is found to be out of date,
1737 <code class="Cm">got update</code> must be used first in order to merge
1738 local changes with changes made in the repository.</p>
1740 <dt id="se"><a class="permalink" href="#send"><code class="Cm" id="send">send</code></a>
1741 [<code class="Fl">-afqTv</code>] [<code class="Fl">-b</code>
1742 <var class="Ar">branch</var>] [<code class="Fl">-d</code>
1743 <var class="Ar">branch</var>] [<code class="Fl">-r</code>
1744 <var class="Ar">repository-path</var>] [<code class="Fl">-t</code>
1745 <var class="Ar">tag</var>] [<var class="Ar">remote-repository</var>]</dt>
1747 <div class="Bd Bd-indent"><code class="Li">(alias:
1748 <code class="Cm">se</code>)</code></div>
1749 Send new changes to a remote repository. If no
1750 <var class="Ar">remote-repository</var> is specified,
1751 “origin” will be used. The remote repository's URL is
1752 obtained from the corresponding entry in
1753 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1754 <span class="Pa">config</span> file of the local repository, as created by
1755 <code class="Cm">got clone</code>.
1756 <p class="Pp">All objects corresponding to new changes will be written to a
1757 temporary pack file which is then uploaded to the server. Upon success,
1758 references in the “refs/remotes/” reference namespace of
1759 the local repository will be updated to point at the commits which have
1761 <p class="Pp">By default, changes will only be sent if they are based on
1762 up-to-date copies of relevant branches in the remote repository. If any
1763 changes to be sent are based on out-of-date copies or would otherwise
1764 break linear history of existing branches, new changes must be fetched
1765 from the server with <code class="Cm">got fetch</code> and local
1766 branches must be rebased with <code class="Cm">got rebase</code> before
1767 <code class="Cm">got send</code> can succeed. The
1768 <code class="Fl">-f</code> option can be used to make exceptions to
1769 these requirements.</p>
1770 <p class="Pp">The options for <code class="Cm">got send</code> are as
1773 <dt id="a~4"><a class="permalink" href="#a~4"><code class="Fl">-a</code></a></dt>
1774 <dd>Send all branches from the local repository's
1775 “refs/heads/” reference namespace. The
1776 <code class="Fl">-a</code> option is equivalent to listing all
1777 branches with multiple <code class="Fl">-b</code> options. Cannot be
1778 used together with the <code class="Fl">-b</code> option.</dd>
1779 <dt id="b~7"><a class="permalink" href="#b~7"><code class="Fl">-b</code></a>
1780 <var class="Ar">branch</var></dt>
1781 <dd>Send the specified <var class="Ar">branch</var> from the local
1782 repository's “refs/heads/” reference namespace. This
1783 option may be specified multiple times to build a list of branches to
1784 send. If this option is not specified, default to the work tree's
1785 current branch if invoked in a work tree, or to the repository's HEAD
1786 reference. Cannot be used together with the <code class="Fl">-a</code>
1788 <dt id="d~6"><a class="permalink" href="#d~6"><code class="Fl">-d</code></a>
1789 <var class="Ar">branch</var></dt>
1790 <dd>Delete the specified <var class="Ar">branch</var> from the remote
1791 repository's “refs/heads/” reference namespace. This
1792 option may be specified multiple times to build a list of branches to
1794 <p class="Pp">Only references are deleted. Any commit, tree, tag, and
1795 blob objects belonging to deleted branches may become subject to
1796 deletion by Git's garbage collector running on the server.</p>
1797 <p class="Pp">Requesting deletion of branches results in an error if the
1798 server does not support this feature or disallows the deletion of
1799 branches based on its configuration.</p>
1801 <dt id="f~2"><a class="permalink" href="#f~2"><code class="Fl">-f</code></a></dt>
1802 <dd>Attempt to force the server to overwrite existing branches or tags in
1803 the remote repository, even when <code class="Cm">got fetch</code>
1804 followed by <code class="Cm">got rebase</code> or <code class="Cm">got
1805 merge</code> would usually be required before changes can be sent. The
1806 server may reject forced requests regardless, depending on its
1808 <p class="Pp">Any commit, tree, tag, and blob objects belonging to
1809 overwritten branches or tags may become subject to deletion by Git's
1810 garbage collector running on the server.</p>
1811 <p class="Pp">The “refs/tags” reference namespace is
1812 globally shared between all repositories. Use of the
1813 <code class="Fl">-f</code> option to overwrite tags is discouraged
1814 because it can lead to inconsistencies between the tags present in
1815 different repositories. In general, creating a new tag with a
1816 different name is recommended instead of overwriting an existing
1818 <p class="Pp">Use of the <code class="Fl">-f</code> option is
1819 particularly discouraged if changes being sent are based on an
1820 out-of-date copy of a branch in the remote repository. Instead of
1821 using the <code class="Fl">-f</code> option, new changes should be
1822 fetched with <code class="Cm">got fetch</code> and local branches
1823 should be rebased with <code class="Cm">got rebase</code> or merged
1824 with <code class="Cm">got merge</code>, followed by another attempt
1825 to send the changes.</p>
1826 <p class="Pp">The <code class="Fl">-f</code> option should only be
1827 needed in situations where the remote repository's copy of a branch
1828 or tag is known to be out-of-date and is considered disposable. The
1829 risks of creating inconsistencies between different repositories
1830 should also be taken into account.</p>
1832 <dt id="q~5"><a class="permalink" href="#q~5"><code class="Fl">-q</code></a></dt>
1833 <dd>Suppress progress reporting output. The same option will be passed to
1834 <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1836 <dt id="r~10"><a class="permalink" href="#r~10"><code class="Fl">-r</code></a>
1837 <var class="Ar">repository-path</var></dt>
1838 <dd>Use the repository at the specified path. If not specified, assume the
1839 repository is located at or above the current working directory. If
1840 this directory is a <code class="Nm">got</code> work tree, use the
1841 repository path associated with this work tree.</dd>
1842 <dt id="T"><a class="permalink" href="#T"><code class="Fl">-T</code></a></dt>
1843 <dd>Attempt to send all tags from the local repository's
1844 “refs/tags/” reference namespace. The
1845 <code class="Fl">-T</code> option is equivalent to listing all tags
1846 with multiple <code class="Fl">-t</code> options. Cannot be used
1847 together with the <code class="Fl">-t</code> option.</dd>
1848 <dt id="t~4"><a class="permalink" href="#t~4"><code class="Fl">-t</code></a>
1849 <var class="Ar">tag</var></dt>
1850 <dd>Send the specified <var class="Ar">tag</var> from the local
1851 repository's “refs/tags/” reference namespace, in
1852 addition to any branches that are being sent. The
1853 <code class="Fl">-t</code> option may be specified multiple times to
1854 build a list of tags to send. No tags will be sent if the
1855 <code class="Fl">-t</code> option is not used.
1856 <p class="Pp">Raise an error if the specified <var class="Ar">tag</var>
1857 already exists in the remote repository, unless the
1858 <code class="Fl">-f</code> option is used to overwrite the server's
1859 copy of the tag. In general, creating a new tag with a different
1860 name is recommended instead of overwriting an existing tag.</p>
1861 <p class="Pp">Cannot be used together with the
1862 <code class="Fl">-T</code> option.</p>
1864 <dt id="v~4"><a class="permalink" href="#v~4"><code class="Fl">-v</code></a></dt>
1865 <dd>Verbose mode. Causes <code class="Cm">got send</code> to print
1866 debugging messages to standard error output. The same option will be
1867 passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1868 applicable. Multiple -v options increase the verbosity. The maximum is
1872 <dt id="cy"><a class="permalink" href="#cherrypick"><code class="Cm" id="cherrypick">cherrypick</code></a>
1873 [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
1875 <div class="Bd Bd-indent"><code class="Li">(alias:
1876 <code class="Cm">cy</code>)</code></div>
1877 Merge changes from a single <var class="Ar">commit</var> into the work tree.
1878 The specified <var class="Ar">commit</var> should be on a different branch
1879 than the work tree's base commit.
1880 <p class="Pp" id="barbaz:+3">The expected argument is a commit ID SHA1 hash,
1881 or a reference name or keyword which will be resolved to a commit ID. An
1882 abbreviated hash argument will be expanded to a full SHA1 hash
1883 automatically, provided the abbreviation is unique. The keywords
1884 ":base" and ":head" resolve to the work tree's base
1885 commit and branch head, respectively. Keywords and references may be
1886 appended with ":+" or ":-" modifiers and an optional
1887 integer N to denote the Nth descendant or antecedent by first parent
1888 traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
1889 the work tree branch head's 2nd generation ancestor, and
1890 <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
1891 work tree's base commit. Similarly,
1892 <a class="permalink" href="#barbaz:+3"><b class="Sy">barbaz:+3</b></a>
1893 will denote the 3rd generation descendant of the commit resolved by the
1894 "barbaz" reference. A ":+" or ":-"
1895 modifier without a trailing integer has an implicit "1"
1896 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1897 <b class="Sy">:base:+1</b>).</p>
1898 <p class="Pp">Show the status of each affected file, using the following
1900 <table class="Bl-column">
1903 <td>file was merged</td>
1907 <td>file was merged and conflicts occurred during merge</td>
1911 <td>changes destined for a missing file were not merged</td>
1915 <td>file was deleted</td>
1919 <td>file's deletion was prevented by local modifications</td>
1923 <td>new file was added</td>
1927 <td>changes destined for a non-regular file were not merged</td>
1931 <td>changes destined for an unversioned file were not merged</td>
1934 <p class="Pp">The merged changes will appear as local changes in the work
1935 tree, which may be viewed with <code class="Cm">got diff</code>, amended
1936 manually or with further <code class="Cm">got cherrypick</code>
1937 commands, committed with <code class="Cm">got commit</code>.</p>
1938 <p class="Pp">If invoked in a work tree where no
1939 <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
1940 <code class="Cm">merge</code> operation is taking place,
1941 <code class="Cm">got cherrypick</code> creates a record of commits which
1942 have been merged into the work tree. When a file changed by
1943 <code class="Cm">got cherrypick</code> is committed with
1944 <code class="Cm">got commit</code>, the log messages of relevant merged
1945 commits will then appear in the editor, where the messages should be
1946 further adjusted to convey the reasons for cherrypicking the changes.
1947 Upon exiting the editor, if the time stamp of the log message file is
1948 unchanged or the log message is empty, <code class="Cm">got
1949 commit</code> will fail with an unmodified or empty log message
1951 <p class="Pp">If all the changes in all files touched by a given commit are
1952 discarded, e.g. with <code class="Cm">got revert</code>, this commit's
1953 log message record will also disappear.</p>
1954 <p class="Pp"><code class="Cm">got cherrypick</code> will refuse to run if
1955 certain preconditions are not met. If the work tree contains multiple
1956 base commits, it must first be updated to a single base commit with
1957 <code class="Cm">got update</code>. If any relevant files already
1958 contain merge conflicts, these conflicts must be resolved first.</p>
1959 <p class="Pp">The options for <code class="Nm">got</code>
1960 <code class="Cm">cherrypick</code> are as follows:</p>
1962 <dt id="l~7"><a class="permalink" href="#l~7"><code class="Fl">-l</code></a></dt>
1963 <dd>Display a list of commit log messages recorded by cherrypick
1964 operations, represented by references in the
1965 “refs/got/worktree” reference namespace. If a
1966 <var class="Ar">commit</var> is specified, only show the log message
1967 of the specified commit.
1968 <p class="Pp">If invoked in a work tree, only log messages recorded by
1969 cherrypick operations in the current work tree will be displayed.
1970 Otherwise, all commit log messages will be displayed irrespective of
1971 the work tree in which they were created. This option cannot be used
1972 with <code class="Fl">-X</code>.</p>
1974 <dt id="X~2"><a class="permalink" href="#X~2"><code class="Fl">-X</code></a></dt>
1975 <dd>Delete log messages created by previous cherrypick operations,
1976 represented by references in the “refs/got/worktree”
1977 reference namespace. If a <var class="Ar">commit</var> is specified,
1978 only delete the log message of the specified commit.
1979 <p class="Pp">If invoked in a work tree, only log messages recorded by
1980 cherrypick operations in the current work tree will be deleted.
1981 Otherwise, all commit log messages will be deleted irrespective of
1982 the work tree in which they were created. This option cannot be used
1983 with <code class="Fl">-l</code>.</p>
1988 <dt id="bo"><a class="permalink" href="#backout"><code class="Cm" id="backout">backout</code></a>
1989 [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
1991 <div class="Bd Bd-indent"><code class="Li">(alias:
1992 <code class="Cm">bo</code>)</code></div>
1993 Reverse-merge changes from a single <var class="Ar">commit</var> into the
1994 work tree. The specified <var class="Ar">commit</var> should be on the
1995 same branch as the work tree's base commit.
1996 <p class="Pp" id="wip:+5">The expected argument is a commit ID SHA1 hash, or
1997 a reference name or keyword which will be resolved to a commit ID. An
1998 abbreviated hash argument will be expanded to a full SHA1 hash
1999 automatically, provided the abbreviation is unique. The keywords
2000 ":base" and ":head" resolve to the work tree's base
2001 commit and branch head, respectively. Keywords and references may be
2002 appended with ":+" or ":-" modifiers and an optional
2003 integer N to denote the Nth descendant or antecedent by first parent
2004 traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
2005 the work tree branch head's 2nd generation ancestor, and
2006 <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
2007 work tree's base commit. Similarly,
2008 <a class="permalink" href="#wip:+5"><b class="Sy">wip:+5</b></a> will
2009 denote the 5th generation descendant of the commit resolved by the
2010 "wip" reference. A ":+" or ":-" modifier
2011 without a trailing integer has an implicit "1" appended (e.g.,
2012 <b class="Sy">:base:+</b> is equivalent to
2013 <b class="Sy">:base:+1</b>).</p>
2014 <p class="Pp">Show the status of each affected file, using the following
2016 <table class="Bl-column">
2019 <td>file was merged</td>
2023 <td>file was merged and conflicts occurred during merge</td>
2027 <td>changes destined for a missing file were not merged</td>
2031 <td>file was deleted</td>
2035 <td>file's deletion was prevented by local modifications</td>
2039 <td>new file was added</td>
2043 <td>changes destined for a non-regular file were not merged</td>
2047 <td>changes destined for an unversioned file were not merged</td>
2050 <p class="Pp">The reverse-merged changes will appear as local changes in the
2051 work tree, which may be viewed with <code class="Cm">got diff</code>,
2052 amended manually or with further <code class="Cm">got backout</code>
2053 commands, committed with <code class="Cm">got commit</code>.</p>
2054 <p class="Pp">If invoked in a work tree where no
2055 <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
2056 <code class="Cm">merge</code> operation is taking place,
2057 <code class="Cm">got backout</code> creates a record of commits which
2058 have been reverse-merged into the work tree. When a file changed by
2059 <code class="Cm">got backout</code> is committed with
2060 <code class="Cm">got commit</code>, the log messages of relevant
2061 reverse-merged commits will then appear in the editor, where the
2062 messages should be further adjusted to convey the reasons for backing
2063 out the changes. Upon exiting the editor, if the time stamp of the log
2064 message file is unchanged or the log message is empty,
2065 <code class="Cm">got commit</code> will fail with an unmodified or empty
2066 log message error.</p>
2067 <p class="Pp">If all the changes in all files touched by a given commit are
2068 discarded, e.g. with <code class="Cm">got revert</code>, this commit's
2069 log message record will also disappear.</p>
2070 <p class="Pp"><code class="Cm">got backout</code> will refuse to run if
2071 certain preconditions are not met. If the work tree contains multiple
2072 base commits, it must first be updated to a single base commit with
2073 <code class="Cm">got update</code>. If any relevant files already
2074 contain merge conflicts, these conflicts must be resolved first.</p>
2075 <p class="Pp">The options for <code class="Nm">got</code>
2076 <code class="Cm">backout</code> are as follows:</p>
2078 <dt id="l~8"><a class="permalink" href="#l~8"><code class="Fl">-l</code></a></dt>
2079 <dd>Display a list of commit log messages recorded by backout operations,
2080 represented by references in the “refs/got/worktree”
2081 reference namespace. If a <var class="Ar">commit</var> is specified,
2082 only show the log message of the specified commit.
2083 <p class="Pp">If invoked in a work tree, only log messages recorded by
2084 backout operations in the current work tree will be displayed.
2085 Otherwise, all commit log messages will be displayed irrespective of
2086 the work tree in which they were created. This option cannot be used
2087 with <code class="Fl">-X</code>.</p>
2089 <dt id="X~3"><a class="permalink" href="#X~3"><code class="Fl">-X</code></a></dt>
2090 <dd>Delete log messages created by previous backout operations,
2091 represented by references in the “refs/got/worktree”
2092 reference namespace. If a <var class="Ar">commit</var> is specified,
2093 only delete the log message of the specified commit.
2094 <p class="Pp">If invoked in a work tree, only log messages recorded by
2095 backout operations in the current work tree will be deleted.
2096 Otherwise, all commit log messages will be deleted irrespective of
2097 the work tree in which they were created. This option cannot be used
2098 with <code class="Fl">-l</code>.</p>
2103 <dt id="rb"><a class="permalink" href="#rebase"><code class="Cm" id="rebase">rebase</code></a>
2104 [<code class="Fl">-aCclX</code>] [<var class="Ar">branch</var>]</dt>
2106 <div class="Bd Bd-indent"><code class="Li">(alias:
2107 <code class="Cm">rb</code>)</code></div>
2108 Rebase commits on the specified <var class="Ar">branch</var> onto the tip of
2109 the current branch of the work tree. The <var class="Ar">branch</var> must
2110 share common ancestry with the work tree's current branch. Rebasing begins
2111 with the first descendant commit of the youngest common ancestor commit
2112 shared by the specified <var class="Ar">branch</var> and the work tree's
2113 current branch, and stops once the tip commit of the specified
2114 <var class="Ar">branch</var> has been rebased.
2115 <p class="Pp">When <code class="Cm">got rebase</code> is used as intended,
2116 the specified <var class="Ar">branch</var> represents a local commit
2117 history and may already contain changes that are not yet visible in any
2118 other repositories. The work tree's current branch, which must be set
2119 with <code class="Cm">got update -b</code> before starting the
2120 <code class="Cm">rebase</code> operation, represents a branch from a
2121 remote repository which shares a common history with the specified
2122 <var class="Ar">branch</var> but has progressed, and perhaps diverged,
2123 due to commits added to the remote repository.</p>
2124 <p class="Pp">Rebased commits are accumulated on a temporary branch which
2125 the work tree will remain switched to throughout the entire rebase
2126 operation. Commits on this branch represent the same changes with the
2127 same log messages as their counterparts on the original
2128 <var class="Ar">branch</var>, but with different commit IDs. Once
2129 rebasing has completed successfully, the temporary branch becomes the
2130 new version of the specified <var class="Ar">branch</var> and the work
2131 tree is automatically switched to it. If author information is available
2132 via the <code class="Ev">GOT_AUTHOR</code> environment variable,
2133 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2134 <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2135 configuration settings, this author information will be used to identify
2136 the “committer” of rebased commits.</p>
2137 <p class="Pp">Old commits in their pre-rebase state are automatically backed
2138 up in the “refs/got/backup/rebase” reference namespace. As
2139 long as these references are not removed older versions of rebased
2140 commits will remain in the repository and can be viewed with the
2141 <code class="Cm">got rebase -l</code> command. Removal of these
2142 references makes objects which become unreachable via any reference
2143 subject to removal by Git's garbage collector or
2144 <code class="Cm">gotadmin cleanup</code>.</p>
2145 <p class="Pp">While rebasing commits, show the status of each affected file,
2146 using the following status codes:</p>
2147 <table class="Bl-column">
2150 <td>file was merged</td>
2154 <td>file was merged and conflicts occurred during merge</td>
2158 <td>changes destined for a missing file were not merged</td>
2162 <td>file was deleted</td>
2166 <td>file's deletion was prevented by local modifications</td>
2170 <td>new file was added</td>
2174 <td>changes destined for a non-regular file were not merged</td>
2178 <td>changes destined for an unversioned file were not merged</td>
2181 <p class="Pp">If merge conflicts occur, the rebase operation is interrupted
2182 and may be continued once conflicts have been resolved. If any files
2183 with destined changes are found to be missing or unversioned, or if
2184 files could not be deleted due to differences in deleted content, the
2185 rebase operation will be interrupted to prevent potentially incomplete
2186 changes from being committed to the repository without user
2187 intervention. The work tree may be modified as desired and the rebase
2188 operation can be continued once the changes present in the work tree are
2189 considered complete. Alternatively, the rebase operation may be aborted
2190 which will leave <var class="Ar">branch</var> unmodified and the work
2191 tree switched back to its original branch.</p>
2192 <p class="Pp">If a merge conflict is resolved in a way which renders the
2193 merged change into a no-op change, the corresponding commit will be
2194 elided when the rebase operation continues.</p>
2195 <p class="Pp"><code class="Cm">got rebase</code> will refuse to run if
2196 certain preconditions are not met. If the <var class="Ar">branch</var>
2197 is not in the “refs/heads/” reference namespace, the
2198 branch may not be rebased. If the work tree is not yet fully updated to
2199 the tip commit of its branch, then the work tree must first be updated
2200 with <code class="Cm">got update</code>. If changes have been staged
2201 with <code class="Cm">got stage</code>, these changes must first be
2202 committed with <code class="Cm">got commit</code> or unstaged with
2203 <code class="Cm">got unstage</code>. If the work tree contains local
2204 changes, these changes must first be committed with <code class="Cm">got
2205 commit</code> or reverted with <code class="Cm">got revert</code>. If
2206 the <var class="Ar">branch</var> contains changes to files outside of
2207 the work tree's path prefix, the work tree cannot be used to rebase this
2209 <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2210 integrate</code>, <code class="Cm">got merge</code>,
2211 <code class="Cm">got commit</code>, and <code class="Cm">got
2212 histedit</code> commands will refuse to run while a rebase operation is
2213 in progress. Other commands which manipulate the work tree may be used
2214 for conflict resolution purposes.</p>
2215 <p class="Pp">If the specified <var class="Ar">branch</var> is already based
2216 on the work tree's current branch, then no commits need to be rebased
2217 and <code class="Cm">got rebase</code> will simply switch the work tree
2218 to the specified <var class="Ar">branch</var> and update files in the
2219 work tree accordingly.</p>
2220 <p class="Pp">The options for <code class="Cm">got rebase</code> are as
2223 <dt id="a~5"><a class="permalink" href="#a~5"><code class="Fl">-a</code></a></dt>
2224 <dd>Abort an interrupted rebase operation. If this option is used, no
2225 other command-line arguments are allowed.</dd>
2226 <dt id="C~4"><a class="permalink" href="#C~4"><code class="Fl">-C</code></a></dt>
2227 <dd>Allow a rebase operation to continue with files in conflicted status.
2228 This option should generally be avoided, and can only be used with the
2229 <code class="Fl">-c</code> option.</dd>
2230 <dt id="c~11"><a class="permalink" href="#c~11"><code class="Fl">-c</code></a></dt>
2231 <dd>Continue an interrupted rebase operation. If this option is used, no
2232 other command-line arguments are allowed except
2233 <code class="Fl">-C</code>.</dd>
2234 <dt id="l~9"><a class="permalink" href="#l~9"><code class="Fl">-l</code></a></dt>
2235 <dd>Show a list of past rebase operations, represented by references in
2236 the “refs/got/backup/rebase” reference namespace.
2237 <p class="Pp">Display the author, date, and log message of each backed
2238 up commit, the object ID of the corresponding post-rebase commit,
2239 and the object ID of their common ancestor commit. Given these
2240 object IDs, the <code class="Cm">got log</code> command with the
2241 <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2242 can be used to examine the history of either version of the branch,
2243 and the <code class="Cm">got branch</code> command with the
2244 <code class="Fl">-c</code> option can be used to create a new branch
2245 from a pre-rebase state if desired.</p>
2246 <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2247 commits which at some point in time represented this branch.
2248 Otherwise, list all backed up commits for any branches.</p>
2249 <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2250 does not require a work tree. None of the other options can be used
2251 together with <code class="Fl">-l</code>.</p>
2253 <dt id="X~4"><a class="permalink" href="#X~4"><code class="Fl">-X</code></a></dt>
2254 <dd>Delete backups created by past rebase operations, represented by
2255 references in the “refs/got/backup/rebase” reference
2257 <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2258 delete backups which at some point in time represented this branch.
2259 Otherwise, delete all references found within
2260 “refs/got/backup/rebase”.</p>
2261 <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2262 deleted backups remain in the repository and may be removed
2263 separately with Git's garbage collector or <code class="Cm">gotadmin
2265 <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2266 does not require a work tree. None of the other options can be used
2267 together with <code class="Fl">-X</code>.</p>
2271 <dt id="he"><a class="permalink" href="#histedit"><code class="Cm" id="histedit">histedit</code></a>
2272 [<code class="Fl">-aCcdeflmX</code>] [<code class="Fl">-F</code>
2273 <var class="Ar">histedit-script</var>] [<var class="Ar">branch</var>]</dt>
2275 <div class="Bd Bd-indent"><code class="Li">(alias:
2276 <code class="Cm">he</code>)</code></div>
2277 Edit commit history between the work tree's current base commit and the tip
2278 commit of the work tree's current branch.
2279 <p class="Pp">The <code class="Cm">got histedit</code> command requires the
2280 <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
2281 unless an author has been configured in
2282 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2283 <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2284 configuration settings can be obtained from the repository's
2285 <span class="Pa">.git/config</span> file or from Git's global
2286 <span class="Pa">~/.gitconfig</span> configuration file.</p>
2287 <p class="Pp">Before starting a <code class="Cm">histedit</code> operation,
2288 the work tree's current branch must be set with <code class="Cm">got
2289 update -b</code> to the branch which should be edited, unless this
2290 branch is already the current branch of the work tree. The tip of this
2291 branch represents the upper bound (inclusive) of commits touched by the
2292 <code class="Cm">histedit</code> operation.</p>
2293 <p class="Pp">Furthermore, the work tree's base commit must be set with
2294 <code class="Cm">got update -c</code> to a point in this branch's commit
2295 history where editing should begin. This commit represents the lower
2296 bound (non-inclusive) of commits touched by the
2297 <code class="Cm">histedit</code> operation.</p>
2298 <p class="Pp">Editing of commit history is controlled via a
2299 <var class="Ar">histedit script</var> which can be written in an editor
2300 based on a template, passed on the command line, or generated with the
2301 <code class="Fl">-d</code>, <code class="Fl">-e</code>,
2302 <code class="Fl">-f</code>, or <code class="Fl">-m</code> options.
2303 Quitting the editor without saving the file will abort the histedit
2305 <p class="Pp">The format of the histedit script is line-based. Each line in
2306 the script begins with a command name, followed by whitespace and an
2307 argument. For most commands, the expected argument is a commit ID SHA1
2308 hash. Any remaining text on the line is ignored. Lines which begin with
2309 the ‘#’ character are ignored entirely.</p>
2310 <p class="Pp">The available histedit script commands are as follows:</p>
2311 <table class="Bl-column">
2313 <td><a class="permalink" href="#pick"><code class="Cm">pick</code></a>
2314 <var class="Ar">commit</var></td>
2315 <td>Use the specified commit as it is.</td>
2318 <td><a class="permalink" href="#edit"><code class="Cm">edit</code></a>
2319 <var class="Ar">commit</var></td>
2320 <td>Apply the changes from the specified commit, but then interrupt the
2321 histedit operation for amending, without creating a commit. While the
2322 histedit operation is interrupted arbitrary files may be edited, and
2323 commands which manipulate the work tree can be used freely. The
2324 <code class="Cm">got add</code> and <code class="Cm">got remove</code>
2325 commands can be used to add new files or remove existing ones. The
2326 <code class="Cm">got revert -p</code> command can be used to eliminate
2327 arbitrary changes from files in the work tree. The
2328 <code class="Cm">got stage -p</code> command may be used to prepare a
2329 subset of changes for inclusion in the next commit. Finally, the
2330 <code class="Cm">got commit</code> command can be used to insert
2331 arbitrary commits into the edited history. Regular editing of history
2332 must eventually be resumed by running <code class="Cm">got histedit
2336 <td><a class="permalink" href="#fold"><code class="Cm">fold</code></a>
2337 <var class="Ar">commit</var></td>
2338 <td>Combine the specified commit with the next commit listed further
2339 below that will be used.</td>
2342 <td><a class="permalink" href="#drop"><code class="Cm">drop</code></a>
2343 <var class="Ar">commit</var></td>
2344 <td>Remove this commit from the edited history.</td>
2347 <td><a class="permalink" href="#mesg"><code class="Cm">mesg</code></a>
2348 <var class="Ar">commit</var></td>
2349 <td>Open an editor to create a new log message for this commit.</td>
2352 <p class="Pp">Every commit in the history being edited must be mentioned in
2353 the script. Lines may be re-ordered to change the order of commits in
2354 the edited history. No commit may be listed more than once.</p>
2355 <p class="Pp">Edited commits are accumulated on a temporary branch which the
2356 work tree will remain switched to throughout the entire histedit
2357 operation. Once history editing has completed successfully, the
2358 temporary branch becomes the new version of the work tree's branch and
2359 the work tree is automatically switched to it.</p>
2360 <p class="Pp">Old commits in their pre-histedit state are automatically
2361 backed up in the “refs/got/backup/histedit” reference
2362 namespace. As long as these references are not removed older versions of
2363 edited commits will remain in the repository and can be viewed with the
2364 <code class="Cm">got histedit -l</code> command. Removal of these
2365 references makes objects which become unreachable via any reference
2366 subject to removal by Git's garbage collector or
2367 <code class="Cm">gotadmin cleanup</code>.</p>
2368 <p class="Pp">While merging commits, show the status of each affected file,
2369 using the following status codes:</p>
2370 <table class="Bl-column">
2373 <td>file was merged</td>
2377 <td>file was merged and conflicts occurred during merge</td>
2381 <td>changes destined for a missing file were not merged</td>
2385 <td>file was deleted</td>
2389 <td>file's deletion was prevented by local modifications</td>
2393 <td>new file was added</td>
2397 <td>changes destined for a non-regular file were not merged</td>
2401 <td>changes destined for an unversioned file were not merged</td>
2404 <p class="Pp">If merge conflicts occur, the histedit operation is
2405 interrupted and may be continued once conflicts have been resolved. If
2406 any files with destined changes are found to be missing or unversioned,
2407 or if files could not be deleted due to differences in deleted content,
2408 the histedit operation will be interrupted to prevent potentially
2409 incomplete changes from being committed to the repository without user
2410 intervention. The work tree may be modified as desired and the histedit
2411 operation can be continued once the changes present in the work tree are
2412 considered complete. Alternatively, the histedit operation may be
2413 aborted which will leave the work tree switched back to its original
2415 <p class="Pp">If a merge conflict is resolved in a way which renders the
2416 merged change into a no-op change, the corresponding commit will be
2417 elided when the histedit operation continues.</p>
2418 <p class="Pp"><code class="Cm">got histedit</code> will refuse to run if
2419 certain preconditions are not met. If the work tree's current branch is
2420 not in the “refs/heads/” reference namespace, the history
2421 of the branch may not be edited. If the work tree contains multiple base
2422 commits, it must first be updated to a single base commit with
2423 <code class="Cm">got update</code>. If changes have been staged with
2424 <code class="Cm">got stage</code>, these changes must first be committed
2425 with <code class="Cm">got commit</code> or unstaged with
2426 <code class="Cm">got unstage</code>. If the work tree contains local
2427 changes, these changes must first be committed with <code class="Cm">got
2428 commit</code> or reverted with <code class="Cm">got revert</code>. If
2429 the edited history contains changes to files outside of the work tree's
2430 path prefix, the work tree cannot be used to edit the history of this
2432 <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2433 rebase</code>, <code class="Cm">got merge</code>, and
2434 <code class="Cm">got integrate</code> commands will refuse to run while
2435 a histedit operation is in progress. Other commands which manipulate the
2436 work tree may be used, and the <code class="Cm">got commit</code>
2437 command may be used to commit arbitrary changes to the temporary branch
2438 while the histedit operation is interrupted.</p>
2439 <p class="Pp">The options for <code class="Cm">got histedit</code> are as
2442 <dt id="a~6"><a class="permalink" href="#a~6"><code class="Fl">-a</code></a></dt>
2443 <dd>Abort an interrupted histedit operation. If this option is used, no
2444 other command-line arguments are allowed.</dd>
2445 <dt id="C~5"><a class="permalink" href="#C~5"><code class="Fl">-C</code></a></dt>
2446 <dd>Allow a histedit operation to continue with files in conflicted
2447 status. This option should generally be avoided, and can only be used
2448 with the <code class="Fl">-c</code> option.</dd>
2449 <dt id="c~12"><a class="permalink" href="#c~12"><code class="Fl">-c</code></a></dt>
2450 <dd>Continue an interrupted histedit operation. If this option is used, no
2451 other command-line arguments are allowed except
2452 <code class="Fl">-C</code>.</dd>
2453 <dt id="d~7"><a class="permalink" href="#d~7"><code class="Fl">-d</code></a></dt>
2454 <dd>Drop all commits. This option is a quick equivalent to a histedit
2455 script which drops all commits. The <code class="Fl">-d</code> option
2456 can only be used when starting a new histedit operation. If this
2457 option is used, no other command-line arguments are allowed.</dd>
2458 <dt id="e"><a class="permalink" href="#e"><code class="Fl">-e</code></a></dt>
2459 <dd>Interrupt the histedit operation for editing after merging each
2460 commit. This option is a quick equivalent to a histedit script which
2461 uses the <code class="Cm">edit</code> command for all commits. The
2462 <code class="Fl">-e</code> option can only be used when starting a new
2463 histedit operation. If this option is used, no other command-line
2464 arguments are allowed.</dd>
2465 <dt id="F~3"><a class="permalink" href="#F~3"><code class="Fl">-F</code></a>
2466 <var class="Ar">histedit-script</var></dt>
2467 <dd>Use the specified <var class="Ar">histedit-script</var> instead of
2468 opening a temporary file in an editor where a histedit script can be
2470 <dt id="f~3"><a class="permalink" href="#f~3"><code class="Fl">-f</code></a></dt>
2471 <dd>Fold all commits into a single commit. This option is a quick
2472 equivalent to a histedit script which folds all commits, combining
2473 them all into one commit. The <code class="Fl">-f</code> option can
2474 only be used when starting a new histedit operation. If this option is
2475 used, no other command-line arguments are allowed.</dd>
2476 <dt id="l~10"><a class="permalink" href="#l~10"><code class="Fl">-l</code></a></dt>
2477 <dd>Show a list of past histedit operations, represented by references in
2478 the “refs/got/backup/histedit” reference namespace.
2479 <p class="Pp">Display the author, date, and log message of each backed
2480 up commit, the object ID of the corresponding post-histedit commit,
2481 and the object ID of their common ancestor commit. Given these
2482 object IDs, the <code class="Cm">got log</code> command with the
2483 <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2484 can be used to examine the history of either version of the branch,
2485 and the <code class="Cm">got branch</code> command with the
2486 <code class="Fl">-c</code> option can be used to create a new branch
2487 from a pre-histedit state if desired.</p>
2488 <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2489 commits which at some point in time represented this branch.
2490 Otherwise, list all backed up commits for any branches.</p>
2491 <p class="Pp">If this option is used, <code class="Cm">got
2492 histedit</code> does not require a work tree. None of the other
2493 options can be used together with <code class="Fl">-l</code>.</p>
2495 <dt id="m~5"><a class="permalink" href="#m~5"><code class="Fl">-m</code></a></dt>
2496 <dd>Edit log messages only. This option is a quick equivalent to a
2497 histedit script which edits only log messages but otherwise leaves
2498 every picked commit as-is. The <code class="Fl">-m</code> option can
2499 only be used when starting a new histedit operation. If this option is
2500 used, no other command-line arguments are allowed.</dd>
2501 <dt id="X~5"><a class="permalink" href="#X~5"><code class="Fl">-X</code></a></dt>
2502 <dd>Delete backups created by past histedit operations, represented by
2503 references in the “refs/got/backup/histedit” reference
2505 <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2506 delete backups which at some point in time represented this branch.
2507 Otherwise, delete all references found within
2508 “refs/got/backup/histedit”.</p>
2509 <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2510 deleted backups remain in the repository and may be removed
2511 separately with Git's garbage collector or <code class="Cm">gotadmin
2513 <p class="Pp">If this option is used, <code class="Cm">got
2514 histedit</code> does not require a work tree. None of the other
2515 options can be used together with <code class="Fl">-X</code>.</p>
2519 <dt id="ig"><a class="permalink" href="#integrate"><code class="Cm" id="integrate">integrate</code></a>
2520 <var class="Ar">branch</var></dt>
2522 <div class="Bd Bd-indent"><code class="Li">(alias:
2523 <code class="Cm">ig</code>)</code></div>
2524 Integrate the specified <var class="Ar">branch</var> into the work tree's
2525 current branch. Files in the work tree are updated to match the contents
2526 on the integrated <var class="Ar">branch</var>, and the reference of the
2527 work tree's branch is changed to point at the head commit of the
2528 integrated <var class="Ar">branch</var>.
2529 <p class="Pp">Both branches can be considered equivalent after integration
2530 since they will be pointing at the same commit. Both branches remain
2531 available for future work, if desired. In case the integrated
2532 <var class="Ar">branch</var> is no longer needed it may be deleted with
2533 <code class="Cm">got branch -d</code>.</p>
2534 <p class="Pp">Show the status of each affected file, using the following
2536 <table class="Bl-column">
2539 <td>file was updated</td>
2543 <td>file was deleted</td>
2547 <td>new file was added</td>
2551 <td>versioned file is obstructed by a non-regular file</td>
2555 <td>a missing versioned file was restored</td>
2558 <p class="Pp"><code class="Cm">got integrate</code> will refuse to run if
2559 certain preconditions are not met. Most importantly, the
2560 <var class="Ar">branch</var> must have been rebased onto the work tree's
2561 current branch with <code class="Cm">got rebase</code> before it can be
2562 integrated, in order to linearize commit history and resolve merge
2563 conflicts. If the work tree contains multiple base commits, it must
2564 first be updated to a single base commit with <code class="Cm">got
2565 update</code>. If changes have been staged with <code class="Cm">got
2566 stage</code>, these changes must first be committed with
2567 <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
2568 unstage</code>. If the work tree contains local changes, these changes
2569 must first be committed with <code class="Cm">got commit</code> or
2570 reverted with <code class="Cm">got revert</code>.</p>
2572 <dt id="mg"><a class="permalink" href="#merge"><code class="Cm" id="merge">merge</code></a>
2573 [<code class="Fl">-aCcMn</code>] [<var class="Ar">branch</var>]</dt>
2575 <div class="Bd Bd-indent"><code class="Li">(alias:
2576 <code class="Cm">mg</code>)</code></div>
2577 Merge the specified <var class="Ar">branch</var> into the current branch of
2578 the work tree. If the branches have diverged, merge changes into the work
2579 tree and create a merge commit. Otherwise, if the specified
2580 <var class="Ar">branch</var> is already based on the work tree's current
2581 branch, make the work tree's current branch equivalent to the specified
2582 <var class="Ar">branch</var> and update files in the work tree
2584 <p class="Pp">Merge commits are commits based on multiple parent commits.
2585 The tip commit of the work tree's current branch will be used as the
2586 first parent. The tip commit of the specified
2587 <var class="Ar">branch</var> will be used as the second parent. The work
2588 tree's current branch must be in the “refs/heads/”
2589 reference namespace and can be set with <code class="Cm">got update
2590 -b</code> before starting the <code class="Cm">merge</code>
2592 <p class="Pp">No ancestral relationship between the two branches is
2593 required. If the two branches have already been merged previously, only
2594 new changes will be merged.</p>
2595 <p class="Pp">It is not possible to create merge commits with more than two
2596 parents. If more than one branch needs to be merged, then multiple merge
2597 commits with two parents each can be created in sequence.</p>
2598 <p class="Pp">If a linear project history is desired, then use of
2599 <code class="Cm">got rebase</code> should generally be preferred over
2600 <code class="Cm">got merge</code>. However, even strictly linear
2601 projects may require occasional merge commits, for example in order to
2602 merge in new versions of third-party code stored on
2603 “vendor” branches created with <code class="Cm">got
2605 <p class="Pp">While merging changes found on the
2606 <var class="Ar">branch</var> into the work tree, show the status of each
2607 affected file, using the following status codes:</p>
2608 <table class="Bl-column">
2611 <td>file was merged</td>
2615 <td>file was merged and conflicts occurred during merge</td>
2619 <td>changes destined for a missing file were not merged</td>
2623 <td>file was deleted</td>
2627 <td>file's deletion was prevented by local modifications</td>
2631 <td>new file was added</td>
2635 <td>changes destined for a non-regular file were not merged</td>
2639 <td>changes destined for an unversioned file were not merged</td>
2642 <p class="Pp">If merge conflicts occur, the merge operation is interrupted
2643 and conflicts must be resolved before the merge operation can continue.
2644 If any files with destined changes are found to be missing or
2645 unversioned, or if files could not be deleted due to differences in
2646 deleted content, the merge operation will be interrupted to prevent
2647 potentially incomplete changes from being committed to the repository
2648 without user intervention. The work tree may be modified as desired and
2649 the merge can be continued once the changes present in the work tree are
2650 considered complete. Alternatively, the merge operation may be aborted
2651 which will leave the work tree's current branch unmodified.</p>
2652 <p class="Pp"><code class="Cm">got merge</code> will refuse to run if
2653 certain preconditions are not met. If the work tree's current branch is
2654 not in the “refs/heads/” reference namespace then the work
2655 tree must first be switched to a branch in the
2656 “refs/heads/” namespace with <code class="Cm">got update
2657 -b</code>. If the work tree is not yet fully updated to the tip commit
2658 of its branch, then the work tree must first be updated with
2659 <code class="Cm">got update</code>. If the work tree contains multiple
2660 base commits, it must first be updated to a single base commit with
2661 <code class="Cm">got update</code>. If changes have been staged with
2662 <code class="Cm">got stage</code>, these changes must first be committed
2663 with <code class="Cm">got commit</code> or unstaged with
2664 <code class="Cm">got unstage</code>. If the work tree contains local
2665 changes, these changes must first be committed with <code class="Cm">got
2666 commit</code> or reverted with <code class="Cm">got revert</code>. If
2667 the <var class="Ar">branch</var> contains changes to files outside of
2668 the work tree's path prefix, the work tree cannot be used to merge this
2670 <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2671 commit</code>, <code class="Cm">got rebase</code>, <code class="Cm">got
2672 histedit</code>, <code class="Cm">got integrate</code>, and
2673 <code class="Cm">got stage</code> commands will refuse to run while a
2674 merge operation is in progress. Other commands which manipulate the work
2675 tree may be used for conflict resolution purposes.</p>
2676 <p class="Pp">The options for <code class="Cm">got merge</code> are as
2679 <dt id="a~7"><a class="permalink" href="#a~7"><code class="Fl">-a</code></a></dt>
2680 <dd>Abort an interrupted merge operation. If this option is used, no other
2681 command-line arguments are allowed.</dd>
2682 <dt id="C~6"><a class="permalink" href="#C~6"><code class="Fl">-C</code></a></dt>
2683 <dd>Allow a merge operation to continue with files in conflicted status.
2684 This option should generally be avoided, and can only be used with the
2685 <code class="Fl">-c</code> option.</dd>
2686 <dt id="c~13"><a class="permalink" href="#c~13"><code class="Fl">-c</code></a></dt>
2687 <dd>Continue an interrupted merge operation. If this option is used, no
2688 other command-line arguments are allowed except
2689 <code class="Fl">-C</code>.</dd>
2690 <dt id="M"><a class="permalink" href="#M"><code class="Fl">-M</code></a></dt>
2691 <dd>Create a merge commit even if the branches have not diverged.</dd>
2692 <dt id="n~4"><a class="permalink" href="#n~4"><code class="Fl">-n</code></a></dt>
2693 <dd>Merge changes into the work tree as usual but do not create a merge
2694 commit immediately. The merge result can be adjusted as desired before
2695 a merge commit is created with <code class="Cm">got merge -c</code>.
2696 Alternatively, the merge may be aborted with <code class="Cm">got
2697 merge -a</code>.</dd>
2700 <dt id="sg"><a class="permalink" href="#stage"><code class="Cm" id="stage">stage</code></a>
2701 [<code class="Fl">-lpS</code>] [<code class="Fl">-F</code>
2702 <var class="Ar">response-script</var>] [<var class="Ar">path ...</var>]</dt>
2704 <div class="Bd Bd-indent"><code class="Li">(alias:
2705 <code class="Cm">sg</code>)</code></div>
2706 Stage local changes for inclusion in the next commit. If no
2707 <var class="Ar">path</var> is specified, stage all changes in the work
2708 tree. Otherwise, stage changes at or within the specified paths. Paths may
2709 be staged if they are added, modified, or deleted according to
2710 <code class="Cm">got status</code>.
2711 <p class="Pp">Show the status of each affected file, using the following
2713 <table class="Bl-column">
2716 <td>file addition has been staged</td>
2720 <td>file modification has been staged</td>
2724 <td>file deletion has been staged</td>
2727 <p class="Pp">Staged file contents are saved in newly created blob objects
2728 in the repository. These blobs will be referred to by tree objects once
2729 staged changes have been committed.</p>
2730 <p class="Pp">Staged changes affect the behaviour of <code class="Cm">got
2731 commit</code>, <code class="Cm">got status</code>, and
2732 <code class="Cm">got diff</code>. While paths with staged changes exist,
2733 the <code class="Cm">got commit</code> command will refuse to commit any
2734 paths which do not have staged changes. Local changes created on top of
2735 staged changes can only be committed if the path is staged again, or if
2736 the staged changes are committed first. The <code class="Cm">got
2737 status</code> command will show both local changes and staged changes.
2738 The <code class="Cm">got diff</code> command is able to display local
2739 changes relative to staged changes, and to display staged changes
2740 relative to the repository. The <code class="Cm">got revert</code>
2741 command cannot revert staged changes but may be used to revert local
2742 changes created on top of staged changes.</p>
2743 <p class="Pp">The options for <code class="Cm">got stage</code> are as
2746 <dt id="F~4"><a class="permalink" href="#F~4"><code class="Fl">-F</code></a>
2747 <var class="Ar">response-script</var></dt>
2748 <dd>With the <code class="Fl">-p</code> option, read “y”,
2749 “n”, and “q” responses line-by-line from
2750 the specified <var class="Ar">response-script</var> file instead of
2751 prompting interactively.</dd>
2752 <dt id="l~11"><a class="permalink" href="#l~11"><code class="Fl">-l</code></a></dt>
2753 <dd>Instead of staging new changes, list paths which are already staged,
2754 along with the IDs of staged blob objects and stage status codes. If
2755 paths were provided on the command line, show the staged paths among
2756 the specified paths. Otherwise, show all staged paths.</dd>
2757 <dt id="p~5"><a class="permalink" href="#p~5"><code class="Fl">-p</code></a></dt>
2758 <dd>Instead of staging the entire content of a changed file, interactively
2759 select or reject changes for staging based on “y” (stage
2760 change), “n” (reject change), and “q”
2761 (quit staging this file) responses. If a file is in modified status,
2762 individual patches derived from the modified file content can be
2763 staged. Files in added or deleted status may only be staged or
2764 rejected in their entirety.</dd>
2765 <dt id="S~4"><a class="permalink" href="#S~4"><code class="Fl">-S</code></a></dt>
2766 <dd>Allow staging of symbolic links which point outside of the path space
2767 that is under version control. By default, <code class="Cm">got
2768 stage</code> will reject such symbolic links due to safety concerns.
2769 As a precaution, <code class="Nm">got</code> may decide to represent
2770 such a symbolic link as a regular file which contains the link's
2771 target path, rather than creating an actual symbolic link which points
2772 outside of the work tree. Use of this option is discouraged because
2773 external mechanisms such as “make obj” are better suited
2774 for managing symbolic links to paths not under version control.</dd>
2776 <p class="Pp"><code class="Cm">got stage</code> will refuse to run if
2777 certain preconditions are not met. If a file contains merge conflicts,
2778 these conflicts must be resolved first. If a file is found to be out of
2779 date relative to the head commit on the work tree's current branch, the
2780 file must be updated with <code class="Cm">got update</code> before it
2781 can be staged (however, this does not prevent the file from becoming
2782 out-of-date at some point after having been staged).</p>
2783 <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2784 rebase</code>, <code class="Cm">got merge</code>, and
2785 <code class="Cm">got histedit</code> commands will refuse to run while
2786 staged changes exist. If staged changes cannot be committed because a
2787 staged path is out of date, the path must be unstaged with
2788 <code class="Cm">got unstage</code> before it can be updated with
2789 <code class="Cm">got update</code>, and may then be staged again if
2792 <dt id="ug"><a class="permalink" href="#unstage"><code class="Cm" id="unstage">unstage</code></a>
2793 [<code class="Fl">-p</code>] [<code class="Fl">-F</code>
2794 <var class="Ar">response-script</var>] [<var class="Ar">path ...</var>]</dt>
2796 <div class="Bd Bd-indent"><code class="Li">(alias:
2797 <code class="Cm">ug</code>)</code></div>
2798 Merge staged changes back into the work tree and put affected paths back
2799 into non-staged status. If no <var class="Ar">path</var> is specified,
2800 unstage all staged changes across the entire work tree. Otherwise, unstage
2801 changes at or within the specified paths.
2802 <p class="Pp">Show the status of each affected file, using the following
2804 <table class="Bl-column">
2807 <td>file was unstaged</td>
2811 <td>file was unstaged and conflicts occurred during merge</td>
2815 <td>changes destined for a missing file were not merged</td>
2819 <td>file was staged as deleted and still is deleted</td>
2823 <td>file's deletion was prevented by local modifications</td>
2827 <td>changes destined for a non-regular file were not merged</td>
2830 <p class="Pp">The options for <code class="Cm">got unstage</code> are as
2833 <dt id="F~5"><a class="permalink" href="#F~5"><code class="Fl">-F</code></a>
2834 <var class="Ar">response-script</var></dt>
2835 <dd>With the <code class="Fl">-p</code> option, read “y”,
2836 “n”, and “q” responses line-by-line from
2837 the specified <var class="Ar">response-script</var> file instead of
2838 prompting interactively.</dd>
2839 <dt id="p~6"><a class="permalink" href="#p~6"><code class="Fl">-p</code></a></dt>
2840 <dd>Instead of unstaging the entire content of a changed file,
2841 interactively select or reject changes for unstaging based on
2842 “y” (unstage change), “n” (keep change
2843 staged), and “q” (quit unstaging this file) responses.
2844 If a file is staged in modified status, individual patches derived
2845 from the staged file content can be unstaged. Files staged in added or
2846 deleted status may only be unstaged in their entirety.</dd>
2849 <dt id="cat"><a class="permalink" href="#cat"><code class="Cm">cat</code></a>
2850 [<code class="Fl">-P</code>] [<code class="Fl">-c</code>
2851 <var class="Ar">commit</var>] [<code class="Fl">-r</code>
2852 <var class="Ar">repository-path</var>] <var class="Ar">arg ...</var></dt>
2853 <dd>Parse and print contents of objects to standard output in a line-based
2854 text format. Content of commit, tree, and tag objects is printed in a way
2855 similar to the actual content stored in such objects. Blob object contents
2856 are printed as they would appear in files on disk.
2857 <p class="Pp">Attempt to interpret each argument as a reference, a tag name,
2858 or an object ID SHA1 hash. References will be resolved to an object ID.
2859 Tag names will resolved to a tag object. An abbreviated hash argument
2860 will be expanded to a full SHA1 hash automatically, provided the
2861 abbreviation is unique.</p>
2862 <p class="Pp">If none of the above interpretations produce a valid result,
2863 or if the <code class="Fl">-P</code> option is used, attempt to
2864 interpret the argument as a path which will be resolved to the ID of an
2865 object found at this path in the repository.</p>
2866 <p class="Pp">The options for <code class="Cm">got cat</code> are as
2869 <dt id="c~14"><a class="permalink" href="#c~14"><code class="Fl">-c</code></a>
2870 <var class="Ar">commit</var></dt>
2871 <dd>Look up paths in the specified <var class="Ar">commit</var>. If this
2872 option is not used, paths are looked up in the commit resolved via the
2873 repository's HEAD reference.
2874 <p class="Pp" id="quux:-8">The expected argument is a commit ID SHA1
2875 hash, or a reference name or keyword which will be resolved to a
2876 commit ID. An abbreviated hash argument will be expanded to a full
2877 SHA1 hash automatically, provided the abbreviation is unique. The
2878 keywords ":base" and ":head" resolve to the work
2879 tree's base commit and branch head, respectively. The former is only
2880 valid if invoked in a work tree, while the latter will resolve to
2881 the tip of the work tree's current branch if invoked in a work tree,
2882 otherwise it will resolve to the repository's HEAD reference.
2883 Keywords and references may be appended with ":+" or
2884 ":-" modifiers and an optional integer N to denote the Nth
2885 descendant or antecedent by first parent traversal, respectively;
2886 for example, <b class="Sy">:head:-2</b> denotes the work tree branch
2887 head's 2nd generation ancestor, and <b class="Sy">:base:+4</b>
2888 denotes the 4th generation descendant of the work tree's base
2890 <a class="permalink" href="#quux:-8"><b class="Sy">quux:-8</b></a>
2891 will denote the 8th generation ancestor of the commit resolved by
2892 the "quux" reference. A ":+" or ":-"
2893 modifier without a trailing integer has an implicit "1"
2894 appended (e.g., <b class="Sy">:base:+</b> is equivalent to
2895 <b class="Sy">:base:+1</b>).</p>
2897 <dt id="P~3"><a class="permalink" href="#P~3"><code class="Fl">-P</code></a></dt>
2898 <dd>Interpret all arguments as paths only. This option can be used to
2899 resolve ambiguity in cases where paths look like tag names, reference
2900 names, or object IDs.</dd>
2901 <dt id="r~11"><a class="permalink" href="#r~11"><code class="Fl">-r</code></a>
2902 <var class="Ar">repository-path</var></dt>
2903 <dd>Use the repository at the specified path. If not specified, assume the
2904 repository is located at or above the current working directory. If
2905 this directory is a <code class="Nm">got</code> work tree, use the
2906 repository path associated with this work tree.</dd>
2909 <dt id="info"><a class="permalink" href="#info"><code class="Cm">info</code></a>
2910 [<var class="Ar">path ...</var>]</dt>
2911 <dd>Display meta-data stored in a work tree. See
2912 <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a> for
2914 <p class="Pp">The work tree to use is resolved implicitly by walking upwards
2915 from the current working directory.</p>
2916 <p class="Pp">If one or more <var class="Ar">path</var> arguments are
2917 specified, show additional per-file information for tracked files
2918 located at or within these paths. If a <var class="Ar">path</var>
2919 argument corresponds to the work tree's root directory, display
2920 information for all tracked files.</p>
2924 <section class="Sh">
2925 <h2 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h2>
2927 <dt id="GOT_AUTHOR"><a class="permalink" href="#GOT_AUTHOR"><code class="Ev">GOT_AUTHOR</code></a></dt>
2928 <dd>The author's name and email address, such as "<span class="An">Flan
2930 <<a class="Mt" href="mailto:flan_hacker@openbsd.org">flan_hacker@openbsd.org</a>>".
2931 Used by the <code class="Cm">got commit</code>, <code class="Cm">got
2932 import</code>, <code class="Cm">got rebase</code>, <code class="Cm">got
2933 merge</code>, and <code class="Cm">got histedit</code> commands. Because
2934 <a class="Xr" aria-label="git, section 1">git(1)</a> may fail to parse
2935 commits without an email address in author data,
2936 <code class="Nm">got</code> attempts to reject
2937 <code class="Ev">GOT_AUTHOR</code> environment variables with a missing
2939 <p class="Pp"><code class="Ev">GOT_AUTHOR will be overridden by
2940 configuration settings in</code> <a class="Xr" aria-label="got.conf,
2941 section 5">got.conf(5)</a> or by Git's <code class="Dv">user.name</code>
2942 and <code class="Dv">user.email</code> configuration settings in the
2943 repository's <span class="Pa">.git/config</span> file. The
2944 <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2945 configuration settings contained in Git's global
2946 <span class="Pa">~/.gitconfig</span> configuration file will only be
2947 used if neither <a class="Xr" aria-label="got.conf, section
2948 5">got.conf(5)</a> nor the <code class="Ev">GOT_AUTHOR</code>
2949 environment variable provide author information.</p>
2951 <dt id="GOT_IGNORE_GITCONFIG"><a class="permalink" href="#GOT_IGNORE_GITCONFIG"><code class="Ev">GOT_IGNORE_GITCONFIG</code></a></dt>
2952 <dd>If this variable is set then any remote repository definitions or author
2953 information found in Git configuration files will be ignored.</dd>
2954 <dt id="GOT_LOG_DEFAULT_LIMIT"><a class="permalink" href="#GOT_LOG_DEFAULT_LIMIT"><code class="Ev">GOT_LOG_DEFAULT_LIMIT</code></a></dt>
2955 <dd>The default limit on the number of commits traversed by
2956 <code class="Cm">got log</code>. If set to zero, the limit is unbounded.
2957 This variable will be silently ignored if it is set to a non-numeric
2959 <dt id="VISUAL"><a class="permalink" href="#VISUAL"><code class="Ev">VISUAL</code></a>,
2960 <code class="Ev">EDITOR</code></dt>
2961 <dd>The editor spawned by <code class="Cm">got commit</code>,
2962 <code class="Cm">got histedit</code>, <code class="Cm">got import</code>,
2963 or <code class="Cm">got tag</code>. If not set, the
2964 <a class="Xr" aria-label="vi, section 1">vi(1)</a> text editor will be
2968 <section class="Sh">
2969 <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
2970 <dl class="Bl-tag Bl-compact">
2971 <dt><span class="Pa">got.conf</span></dt>
2972 <dd>Repository-wide configuration settings for <code class="Nm">got</code>. If
2973 present, a <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>
2974 configuration file located in the root directory of a Git repository
2975 supersedes any relevant settings in Git's <span class="Pa">config</span>
2979 <dt><span class="Pa">.got/got.conf</span></dt>
2980 <dd>Worktree-specific configuration settings for <code class="Nm">got</code>.
2981 If present, a <a class="Xr" aria-label="got.conf, section
2982 5">got.conf(5)</a> configuration file in the <span class="Pa">.got</span>
2983 meta-data directory of a work tree supersedes any relevant settings in the
2984 repository's <a class="Xr" aria-label="got.conf, section
2985 5">got.conf(5)</a> configuration file and Git's
2986 <span class="Pa">config</span> file.</dd>
2989 <section class="Sh">
2990 <h2 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT
2992 <p class="Pp">The <code class="Nm">got</code> utility exits 0 on success,
2993 and >0 if an error occurs.</p>
2995 <section class="Sh">
2996 <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
2997 <p class="Pp">Enable tab-completion of <code class="Nm">got</code> command names
2998 in <a class="Xr" aria-label="ksh, section 1">ksh(1)</a>:</p>
3000 <div class="Bd Bd-indent"><code class="Li">$ set -A complete_got_1 -- $(got -h
3001 2>&1 | sed -n s/commands://p)</code></div>
3002 <p class="Pp">Clone an existing Git repository for use with
3003 <code class="Nm">got</code>:</p>
3005 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/</code></div>
3006 <div class="Bd Bd-indent"><code class="Li">$ got clone
3007 ssh://git@github.com/openbsd/src.git</code></div>
3008 <p class="Pp">Unfortunately, many of the popular Git hosting sites do not offer
3009 anonymous access via SSH. Such sites will require an account to be created,
3010 and a public SSH key to be uploaded to this account, before repository
3011 access via ssh:// URLs will work.</p>
3012 <p class="Pp">Use of HTTP URLs currently requires <a class="Xr" aria-label="git,
3013 section 1">git(1)</a>:</p>
3015 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/</code></div>
3016 <div class="Bd Bd-indent"><code class="Li">$ git clone --bare
3017 https://github.com/openbsd/src.git</code></div>
3018 <p class="Pp">Alternatively, for quick and dirty local testing of
3019 <code class="Nm">got</code> a new Git repository could be created and
3020 populated with files, e.g. from a temporary CVS checkout located at
3021 <span class="Pa">/tmp/src</span>:</p>
3023 <div class="Bd Bd-indent"><code class="Li">$ gotadmin init
3024 /var/git/src.git</code></div>
3025 <div class="Bd Bd-indent"><code class="Li">$ got import -r /var/git/src.git -I
3026 CVS -I obj /tmp/src</code></div>
3027 <p class="Pp">Check out a work tree from the Git repository to /usr/src:</p>
3029 <div class="Bd Bd-indent"><code class="Li">$ got checkout /var/git/src.git
3030 /usr/src</code></div>
3031 <p class="Pp">View local changes in a work tree directory:</p>
3033 <div class="Bd Bd-indent"><code class="Li">$ got diff | less</code></div>
3034 <p class="Pp">In a work tree, display files in a potentially problematic
3037 <div class="Bd Bd-indent"><code class="Li">$ got status -s 'C!~?'</code></div>
3038 <p class="Pp">Interactively revert selected local changes in a work tree
3041 <div class="Bd Bd-indent"><code class="Li">$ got revert -p
3042 -R .</code></div>
3043 <p class="Pp">In a work tree or a git repository directory, list all branch
3046 <div class="Bd Bd-indent"><code class="Li">$ got branch -l</code></div>
3047 <p class="Pp">As above, but list the most recently modified branches only:</p>
3049 <div class="Bd Bd-indent"><code class="Li">$ got branch -lt | head</code></div>
3050 <p class="Pp">In a work tree or a git repository directory, create a new branch
3051 called “unified-buffer-cache” which is forked off the
3052 “master” branch:</p>
3054 <div class="Bd Bd-indent"><code class="Li">$ got branch -c master
3055 unified-buffer-cache</code></div>
3056 <p class="Pp">Switch an existing work tree to the branch
3057 “unified-buffer-cache”. Local changes in the work tree will be
3058 preserved and merged if necessary:</p>
3060 <div class="Bd Bd-indent"><code class="Li">$ got update -b
3061 unified-buffer-cache</code></div>
3062 <p class="Pp">Create a new commit from local changes in a work tree directory.
3063 This new commit will become the head commit of the work tree's current
3066 <div class="Bd Bd-indent"><code class="Li">$ got commit</code></div>
3067 <p class="Pp">In a work tree or a git repository directory, view changes
3068 committed in the 3 most recent commits to the work tree's branch, or the
3069 branch resolved via the repository's HEAD reference, respectively:</p>
3071 <div class="Bd Bd-indent"><code class="Li">$ got log -p -l 3</code></div>
3072 <p class="Pp">As above, but display changes in the order in which
3073 <a class="Xr" aria-label="patch, section 1">patch(1)</a> could apply them in
3076 <div class="Bd Bd-indent"><code class="Li">$ got log -p -l 3 -R</code></div>
3077 <p class="Pp">In a work tree or a git repository directory, log the history of a
3080 <div class="Bd Bd-indent"><code class="Li">$ got log sys/uvm</code></div>
3081 <p class="Pp">While operating inside a work tree, paths are specified relative
3082 to the current working directory, so this command will log the subdirectory
3083 <span class="Pa">sys/uvm</span>:</p>
3085 <div class="Bd Bd-indent"><code class="Li">$ cd sys/uvm && got
3086 log .</code></div>
3087 <p class="Pp">And this command has the same effect:</p>
3089 <div class="Bd Bd-indent"><code class="Li">$ cd sys/dev/usb && got log
3090 ../../uvm</code></div>
3091 <p class="Pp">And this command displays work tree meta-data about all tracked
3094 <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3095 <div class="Bd Bd-indent"><code class="Li">$ got info . |
3097 <p class="Pp">Add new files and remove obsolete files in a work tree
3100 <div class="Bd Bd-indent"><code class="Li">$ got add
3101 sys/uvm/uvm_ubc.c</code></div>
3102 <div class="Bd Bd-indent"><code class="Li">$ got remove
3103 sys/uvm/uvm_vnode.c</code></div>
3104 <p class="Pp">Create a new commit from local changes in a work tree directory
3105 with a pre-defined log message.</p>
3107 <div class="Bd Bd-indent"><code class="Li">$ got commit -m 'unify the buffer
3109 <p class="Pp">Alternatively, create a new commit from local changes in a work
3110 tree directory with a log message that has been prepared in the file
3111 <span class="Pa">/tmp/msg</span>:</p>
3113 <div class="Bd Bd-indent"><code class="Li">$ got commit -F /tmp/msg</code></div>
3114 <p class="Pp">Update any work tree checked out from the
3115 “unified-buffer-cache” branch to the latest commit on this
3118 <div class="Bd Bd-indent"><code class="Li">$ got update</code></div>
3119 <p class="Pp">Roll file content on the unified-buffer-cache branch back by one
3120 commit, and then fetch the rolled-back change into the work tree as a local
3121 change to be amended and perhaps committed again:</p>
3123 <div class="Bd Bd-indent"><code class="Li">$ got backout
3124 unified-buffer-cache</code></div>
3125 <div class="Bd Bd-indent"><code class="Li">$ got commit -m 'roll back
3126 previous'</code></div>
3127 <div class="Bd Bd-indent"><code class="Li">$ # now back out the previous backout
3129 <div class="Bd Bd-indent"><code class="Li">$ got backout
3130 unified-buffer-cache</code></div>
3131 <p class="Pp">Fetch new changes on the remote repository's
3132 “master” branch, making them visible on the local repository's
3133 “origin/master” branch:</p>
3135 <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3136 <div class="Bd Bd-indent"><code class="Li">$ got fetch</code></div>
3137 <p class="Pp">In a repository created with a HTTP URL and <code class="Cm">git
3138 clone --bare</code> the <a class="Xr" aria-label="git-fetch, section
3139 1">git-fetch(1)</a> command must be used instead:</p>
3141 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/src.git</code></div>
3142 <div class="Bd Bd-indent"><code class="Li">$ git fetch origin
3143 master:refs/remotes/origin/master</code></div>
3144 <p class="Pp">Rebase the local “master” branch to merge the new
3145 changes that are now visible on the “origin/master”
3148 <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3149 <div class="Bd Bd-indent"><code class="Li">$ got update -b
3150 origin/master</code></div>
3151 <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3152 <p class="Pp">Rebase the “unified-buffer-cache” branch on top of
3153 the new head commit of the “master” branch.</p>
3155 <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3156 <div class="Bd Bd-indent"><code class="Li">$ got rebase
3157 unified-buffer-cache</code></div>
3158 <p class="Pp">Create a patch from all changes on the unified-buffer-cache
3159 branch. The patch can be mailed out for review and applied to
3160 <span class="Ux">OpenBSD</span>'s CVS tree:</p>
3162 <div class="Bd Bd-indent"><code class="Li">$ got diff master
3163 unified-buffer-cache > /tmp/ubc.diff</code></div>
3164 <p class="Pp">Edit the entire commit history of the
3165 “unified-buffer-cache” branch:</p>
3167 <div class="Bd Bd-indent"><code class="Li">$ got update -b
3168 unified-buffer-cache</code></div>
3169 <div class="Bd Bd-indent"><code class="Li">$ got update -c master</code></div>
3170 <div class="Bd Bd-indent"><code class="Li">$ got histedit</code></div>
3171 <p class="Pp">Before working against existing branches in a repository cloned
3172 with <code class="Cm">git clone --bare</code> instead of
3173 <code class="Cm">got clone</code>, a Git “refspec” must be
3174 configured to map all references in the remote repository into the
3175 “refs/remotes” namespace of the local repository. This can be
3176 achieved by setting Git's <span class="Pa">remote.origin.fetch</span>
3177 configuration variable to the value
3178 “+refs/heads/*:refs/remotes/origin/*” with the
3179 <code class="Cm">git config</code> command:</p>
3181 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/repo</code></div>
3182 <div class="Bd Bd-indent"><code class="Li">$ git config remote.origin.fetch
3183 '+refs/heads/*:refs/remotes/origin/*'</code></div>
3184 <p class="Pp">Additionally, the “mirror” option must be
3187 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/repo</code></div>
3188 <div class="Bd Bd-indent"><code class="Li">$ git config remote.origin.mirror
3190 <p class="Pp">Alternatively, the following <a class="Xr" aria-label="git-fetch,
3191 section 1">git-fetch(1)</a> configuration item can be added manually to the
3192 Git repository's <span class="Pa">config</span> file:</p>
3194 <div class="Bd Bd-indent"><code class="Li">[remote
3195 "origin"]</code></div>
3196 <div class="Bd Bd-indent"><code class="Li">url = ...</code></div>
3197 <div class="Bd Bd-indent"><code class="Li">fetch =
3198 +refs/heads/*:refs/remotes/origin/*</code></div>
3199 <div class="Bd Bd-indent"><code class="Li">mirror = false</code></div>
3200 <p class="Pp">This configuration leaves the local repository's
3201 “refs/heads” namespace free for use by local branches checked
3202 out with <code class="Cm">got checkout</code> and, if needed, created with
3203 <code class="Cm">got branch</code>. Branches in the
3204 “refs/remotes/origin” namespace can now be updated with
3205 incoming changes from the remote repository with <code class="Cm">got
3206 fetch</code> or <a class="Xr" aria-label="git-fetch, section
3207 1">git-fetch(1)</a> without extra command line arguments. Newly fetched
3208 changes can be examined with <code class="Cm">got log</code>.</p>
3209 <p class="Pp">Display changes on the remote repository's version of the
3210 “master” branch, as of the last time <code class="Cm">got
3211 fetch</code> was run:</p>
3213 <div class="Bd Bd-indent"><code class="Li">$ got log -c origin/master |
3215 <p class="Pp">As shown here, most commands accept abbreviated reference names
3216 such as “origin/master” instead of
3217 “refs/remotes/origin/master”. The latter is only needed in
3218 case of ambiguity.</p>
3219 <p class="Pp"><code class="Cm">got rebase</code> can be used to merge changes
3220 which are visible on the “origin/master” branch into the
3221 “master” branch. This will also merge local changes, if any,
3222 with the incoming changes:</p>
3224 <div class="Bd Bd-indent"><code class="Li">$ got update -b
3225 origin/master</code></div>
3226 <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3227 <p class="Pp">In order to make changes committed to the
3228 “unified-buffer-cache” visible on the “master”
3229 branch, the “unified-buffer-cache” branch can be rebased onto
3230 the “master” branch:</p>
3232 <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3233 <div class="Bd Bd-indent"><code class="Li">$ got rebase
3234 unified-buffer-cache</code></div>
3235 <p class="Pp">Changes on the “unified-buffer-cache” branch can now
3236 be made visible on the “master” branch with
3237 <code class="Cm">got integrate</code>. Because the rebase operation switched
3238 the work tree to the “unified-buffer-cache” branch, the work
3239 tree must be switched back to the “master” branch first:</p>
3241 <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3242 <div class="Bd Bd-indent"><code class="Li">$ got integrate
3243 unified-buffer-cache</code></div>
3244 <p class="Pp">On the “master” branch, log messages for local
3245 changes can now be amended with “OK” by other developers and
3246 any other important new information:</p>
3248 <div class="Bd Bd-indent"><code class="Li">$ got update -c
3249 origin/master</code></div>
3250 <div class="Bd Bd-indent"><code class="Li">$ got histedit -m</code></div>
3251 <p class="Pp">If the remote repository offers write access, local changes on the
3252 “master” branch can be sent to the remote repository with
3253 <code class="Cm">got send</code>. Usually, <code class="Cm">got send</code>
3254 can be run without further arguments. The arguments shown here match
3255 defaults, provided the work tree's current branch is the
3256 “master” branch:</p>
3258 <div class="Bd Bd-indent"><code class="Li">$ got send -b master
3260 <p class="Pp">If the remote repository requires the HTTPS protocol, the
3261 <a class="Xr" aria-label="git-push, section 1">git-push(1)</a> command must
3262 be used instead:</p>
3264 <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/src.git</code></div>
3265 <div class="Bd Bd-indent"><code class="Li">$ git push origin master</code></div>
3266 <p class="Pp">When making contributions to projects which use the “pull
3267 request” workflow, SSH protocol repository access needs to be set up
3268 first. Once an account has been created on a Git hosting site it should be
3269 possible to upload a public SSH key for repository access
3271 <p class="Pp">The “pull request” workflow will usually involve two
3272 remote repositories. In the real-life example below, the
3273 “origin” repository was forked from the
3274 “upstream” repository by using the Git hosting site's web
3275 interface. The <a class="Xr" aria-label="got.conf, section
3276 5">got.conf(5)</a> file in the local repository describes both remote
3278 <div class="Bd Pp Bd-indent Li">
3279 <pre># Jelmers's repository, which accepts pull requests
3280 remote "upstream" {
3281 server git@github.com
3283 repository "/jelmer/dulwich"
3284 branch { "master" }
3287 # Stefan's fork, used as the default remote repository
3288 remote "origin" {
3289 server git@github.com
3291 repository "/stspdotname/dulwich"
3292 branch { "master" }
3295 <p class="Pp">With this configuration, Stefan can create commits on
3296 “refs/heads/master” and send them to the
3297 “origin” repository by running:</p>
3299 <div class="Bd Bd-indent"><code class="Li">$ got send -b master
3301 <p class="Pp">The changes can now be proposed to Jelmer by opening a pull
3302 request via the Git hosting site's web interface. If Jelmer requests further
3303 changes to be made, additional commits can be created on the
3304 “master” branch and be added to the pull request by running
3305 <code class="Cd">got send</code> again.</p>
3306 <p class="Pp">If Jelmer prefers additional commits to be
3307 “squashed” then the following commands can be used to achieve
3310 <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3311 <div class="Bd Bd-indent"><code class="Li">$ got update -c
3312 origin/master</code></div>
3313 <div class="Bd Bd-indent"><code class="Li">$ got histedit -f</code></div>
3314 <div class="Bd Bd-indent"><code class="Li">$ got send -f -b master
3316 <p class="Pp">In addition to reviewing the pull request in the web user
3317 interface, Jelmer can fetch the pull request's branch into his local
3318 repository and create a local branch which contains the proposed
3321 <div class="Bd Bd-indent"><code class="Li">$ got fetch -R refs/pull/1046/head
3323 <div class="Bd Bd-indent"><code class="Li">$ got branch -c
3324 refs/remotes/origin/pull/1046/head pr1046</code></div>
3325 <p class="Pp">Once Jelmer has accepted the pull request, Stefan can fetch the
3326 merged changes, and possibly several other new changes, by running:</p>
3328 <div class="Bd Bd-indent"><code class="Li">$ got fetch upstream</code></div>
3329 <p class="Pp">The merged changes will now be visible under the reference
3330 “refs/remotes/upstream/master”. The local
3331 “master” branch can now be rebased on top of the latest
3332 changes from upstream:</p>
3334 <div class="Bd Bd-indent"><code class="Li">$ got update -b
3335 upstream/master</code></div>
3336 <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3337 <p class="Pp">As an alternative to <code class="Cm">got rebase</code>, branches
3338 can be merged with <code class="Cm">got merge</code>:</p>
3340 <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3341 <div class="Bd Bd-indent"><code class="Li">$ got merge
3342 upstream/master</code></div>
3343 <p class="Pp">The question of whether to rebase or merge branches is
3344 philosophical. When in doubt, refer to the software project's policies set
3345 by project maintainers.</p>
3346 <p class="Pp">As a final step, the forked repository's copy of the master branch
3347 needs to be kept in sync by sending the new changes there:</p>
3349 <div class="Bd Bd-indent"><code class="Li">$ got send -f -b master
3351 <p class="Pp">If multiple pull requests need to be managed in parallel, a
3352 separate branch must be created for each pull request with
3353 <code class="Cm">got branch</code>. Each such branch can then be used as
3354 above, in place of “refs/heads/master”. Changes for any
3355 accepted pull requests will still appear under
3356 “refs/remotes/upstream/master,” regardless of which branch was
3357 used in the forked repository to create a pull request.</p>
3359 <section class="Sh">
3360 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
3362 <p class="Pp"><a class="Xr" aria-label="gotadmin, section 1">gotadmin(1)</a>,
3363 <a class="Xr" aria-label="tog, section 1">tog(1)</a>,
3364 <a class="Xr" aria-label="git-repository, section 5">git-repository(5)</a>,
3365 <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a>,
3366 <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>,
3367 <a class="Xr" aria-label="gotwebd, section 8">gotwebd(8)</a></p>
3369 <section class="Sh">
3370 <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
3371 <p class="Pp"><span class="An">Anthony J. Bentley</span>
3372 <<a class="Mt" href="mailto:bentley@openbsd.org">bentley@openbsd.org</a>>
3374 <span class="An">Christian Weisgerber</span>
3375 <<a class="Mt" href="mailto:naddy@openbsd.org">naddy@openbsd.org</a>>
3377 <span class="An">Hiltjo Posthuma</span>
3378 <<a class="Mt" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>>
3380 <span class="An">Josh Rickmar</span>
3381 <<a class="Mt" href="mailto:jrick@zettaport.com">jrick@zettaport.com</a>>
3383 <span class="An">Joshua Stein</span>
3384 <<a class="Mt" href="mailto:jcs@openbsd.org">jcs@openbsd.org</a>>
3386 <span class="An">Klemens Nanni</span>
3387 <<a class="Mt" href="mailto:kn@openbsd.org">kn@openbsd.org</a>>
3389 <span class="An">Martin Pieuchot</span>
3390 <<a class="Mt" href="mailto:mpi@openbsd.org">mpi@openbsd.org</a>>
3392 <span class="An">Neels Hofmeyr</span>
3393 <<a class="Mt" href="mailto:neels@hofmeyr.de">neels@hofmeyr.de</a>>
3395 <span class="An">Omar Polo</span>
3396 <<a class="Mt" href="mailto:op@openbsd.org">op@openbsd.org</a>>
3398 <span class="An">Ori Bernstein</span>
3399 <<a class="Mt" href="mailto:ori@openbsd.org">ori@openbsd.org</a>>
3401 <span class="An">Sebastien Marie</span>
3402 <<a class="Mt" href="mailto:semarie@openbsd.org">semarie@openbsd.org</a>>
3404 <span class="An">Stefan Sperling</span>
3405 <<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>>
3407 <span class="An">Steven McDonald</span>
3408 <<a class="Mt" href="mailto:steven@steven-mcdonald.id.au">steven@steven-mcdonald.id.au</a>>
3410 <span class="An">Theo Buehler</span>
3411 <<a class="Mt" href="mailto:tb@openbsd.org">tb@openbsd.org</a>>
3413 <span class="An">Thomas Adam</span>
3414 <<a class="Mt" href="mailto:thomas@xteddy.org">thomas@xteddy.org</a>>
3416 <span class="An">Tracey Emery</span>
3417 <<a class="Mt" href="mailto:tracey@traceyemery.net">tracey@traceyemery.net</a>>
3419 <span class="An">Yang Zhong</span>
3420 <<a class="Mt" href="mailto:yzhong@freebsdfoundation.org">yzhong@freebsdfoundation.org</a>></p>
3421 <p class="Pp">Parts of <code class="Nm">got</code>,
3422 <a class="Xr" aria-label="tog, section 1">tog(1)</a>, and
3423 <a class="Xr" aria-label="gotwebd, section 8">gotwebd(8)</a> were derived
3424 from code under copyright by:</p>
3427 <span class="An">Caldera International</span>
3429 <span class="An">Daniel Hartmeier</span>
3431 <span class="An">Esben Norby</span>
3433 <span class="An">Henning Brauer</span>
3435 <span class="An">Håkan Olsson</span>
3437 <span class="An">Ingo Schwarze</span>
3439 <span class="An">Jean-Francois Brousseau</span>
3441 <span class="An">Joris Vink</span>
3443 <span class="An">Jyri J. Virkki</span>
3445 <span class="An">Larry Wall</span>
3447 <span class="An">Markus Friedl</span>
3449 <span class="An">Niall O'Higgins</span>
3451 <span class="An">Niklas Hallqvist</span>
3453 <span class="An">Ray Lai</span>
3455 <span class="An">Ryan McBride</span>
3457 <span class="An">Theo de Raadt</span>
3459 <span class="An">Todd C. Miller</span>
3461 <span class="An">Xavier Santolaria</span></p>
3462 <p class="Pp"><code class="Nm">got</code> contains code contributed to the
3465 <span class="An">Austin Appleby</span>.</p>
3467 <section class="Sh">
3468 <h2 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h2>
3469 <p class="Pp"><code class="Nm">got</code> is a work-in-progress and some
3470 features remain to be implemented.</p>
3471 <p class="Pp">At present, the user has to fall back on
3472 <a class="Xr" aria-label="git, section 1">git(1)</a> to perform some tasks.
3474 <ul class="Bl-bullet">
3475 <li>Reading from remote repositories over HTTP or HTTPS protocols requires
3476 <a class="Xr" aria-label="git-clone, section 1">git-clone(1)</a> and
3477 <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>.</li>
3478 <li>Writing to remote repositories over HTTP or HTTPS protocols requires
3479 <a class="Xr" aria-label="git-push, section 1">git-push(1)</a>.</li>
3480 <li>The creation of merge commits with more than two parent commits requires
3481 <a class="Xr" aria-label="git-merge, section 1">git-merge(1)</a>.</li>
3482 <li>In situations where files or directories were moved around
3483 <code class="Cm">got</code> will not automatically merge changes to new
3484 locations and <a class="Xr" aria-label="git, section 1">git(1)</a> will
3485 usually produce better results.</li>
3489 <div class="foot" role="doc-pagefooter" aria-label="Manual footer
3490 line"><span class="foot-left"></span><span class="foot-date">March 11,
3491 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
