Blame


1 8797b228 2019-08-04 stsp <!DOCTYPE html>
2 8797b228 2019-08-04 stsp <html>
3 63657f42 2022-09-07 stsp <head>
4 63657f42 2022-09-07 stsp <meta charset="utf-8"/>
5 63657f42 2022-09-07 stsp <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 63657f42 2022-09-07 stsp <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
7 63657f42 2022-09-07 stsp <title>GOT(1)</title>
8 63657f42 2022-09-07 stsp </head>
9 8797b228 2019-08-04 stsp <!-- This is an automatically generated file. Do not edit.
10 8797b228 2019-08-04 stsp Copyright (c) 2017 Martin Pieuchot
11 8b679b4b 2020-02-17 stsp Copyright (c) 2018, 2019, 2020 Stefan Sperling
12 8797b228 2019-08-04 stsp
13 8797b228 2019-08-04 stsp Permission to use, copy, modify, and distribute this software for any
14 8797b228 2019-08-04 stsp purpose with or without fee is hereby granted, provided that the above
15 8797b228 2019-08-04 stsp copyright notice and this permission notice appear in all copies.
16 8797b228 2019-08-04 stsp
17 8797b228 2019-08-04 stsp THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
18 8797b228 2019-08-04 stsp WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
19 8797b228 2019-08-04 stsp MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
20 8797b228 2019-08-04 stsp ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
21 8797b228 2019-08-04 stsp WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
22 8797b228 2019-08-04 stsp ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
23 8797b228 2019-08-04 stsp OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
24 8797b228 2019-08-04 stsp -->
25 8797b228 2019-08-04 stsp <body>
26 63657f42 2022-09-07 stsp <div class="head" role="doc-pageheader" aria-label="Manual header
27 63657f42 2022-09-07 stsp line"><span class="head-ltitle">GOT(1)</span> <span class="head-vol">General
28 63657f42 2022-09-07 stsp Commands Manual</span> <span class="head-rtitle">GOT(1)</span></div>
29 63657f42 2022-09-07 stsp <main class="manual-text">
30 8797b228 2019-08-04 stsp <section class="Sh">
31 63657f42 2022-09-07 stsp <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
32 63657f42 2022-09-07 stsp <p class="Pp"><code class="Nm">got</code> &#x2014;
33 63657f42 2022-09-07 stsp <span class="Nd" role="doc-subtitle">Game of Trees</span></p>
34 8797b228 2019-08-04 stsp </section>
35 8797b228 2019-08-04 stsp <section class="Sh">
36 63657f42 2022-09-07 stsp <h2 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h2>
37 8797b228 2019-08-04 stsp <table class="Nm">
38 8797b228 2019-08-04 stsp <tr>
39 8797b228 2019-08-04 stsp <td><code class="Nm">got</code></td>
40 742bb3a1 2022-10-24 stsp <td>[<code class="Fl">-hV</code>] <var class="Ar">command</var>
41 8797b228 2019-08-04 stsp [<var class="Ar">arg ...</var>]</td>
42 8797b228 2019-08-04 stsp </tr>
43 8797b228 2019-08-04 stsp </table>
44 8797b228 2019-08-04 stsp </section>
45 8797b228 2019-08-04 stsp <section class="Sh">
46 63657f42 2022-09-07 stsp <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
47 d8e62599 2019-10-21 stsp <p class="Pp"><code class="Nm">got</code> is a version control system which
48 d8e62599 2019-10-21 stsp stores the history of tracked files in a Git repository, as used by the Git
49 d8e62599 2019-10-21 stsp version control system. This repository format is described in
50 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repository, section
51 376d4d52 2022-07-04 stsp 5">git-repository(5)</a>.</p>
52 8797b228 2019-08-04 stsp <p class="Pp"><code class="Nm">got</code> is a &#x201C;distributed&#x201D;
53 8797b228 2019-08-04 stsp version control system because every copy of a repository is writeable.
54 8797b228 2019-08-04 stsp Modifications made to files can be synchronized between repositories at any
55 8797b228 2019-08-04 stsp time.</p>
56 2dbbbc3a 2020-07-23 stsp <p class="Pp" id="work">Files managed by <code class="Nm">got</code> must be
57 2dbbbc3a 2020-07-23 stsp checked out from the repository for modification. Checked out files are
58 2dbbbc3a 2020-07-23 stsp stored in a <a class="permalink" href="#work"><i class="Em">work
59 2dbbbc3a 2020-07-23 stsp tree</i></a> which can be placed at an arbitrary directory in the filesystem
60 2dbbbc3a 2020-07-23 stsp hierarchy. The on-disk format of this work tree is described in
61 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a>.</p>
62 56f3f26e 2024-06-03 stsp <p class="Pp">The <code class="Nm">got</code> utility provides global and
63 56f3f26e 2024-06-03 stsp command-specific options. Global options must precede the command name, and
64 56f3f26e 2024-06-03 stsp are as follows:</p>
65 8797b228 2019-08-04 stsp <dl class="Bl-tag">
66 2dbbbc3a 2020-07-23 stsp <dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a></dt>
67 ae520cae 2019-08-05 stsp <dd>Display usage information and exit immediately.</dd>
68 56dd4d48 2021-04-05 stsp <dt id="V"><a class="permalink" href="#V"><code class="Fl">-V</code></a>,
69 8b679b4b 2020-02-17 stsp <code class="Fl">--version</code></dt>
70 8797b228 2019-08-04 stsp <dd>Display program version and exit immediately.</dd>
71 8797b228 2019-08-04 stsp </dl>
72 56f3f26e 2024-06-03 stsp <p class="Pp">The <code class="Nm">got</code> utility only provides commands
73 56f3f26e 2024-06-03 stsp needed to perform version control tasks. Commands needed for repository
74 56f3f26e 2024-06-03 stsp maintenance tasks are provided by <a class="Xr" aria-label="gotadmin,
75 56f3f26e 2024-06-03 stsp section 1">gotadmin(1)</a>. Git repository server functionality is provided
76 56f3f26e 2024-06-03 stsp by <a class="Xr" aria-label="gotd, section 8">gotd(8)</a>. A repository
77 56f3f26e 2024-06-03 stsp interface for web browsers is provided by <a class="Xr" aria-label="gotwebd,
78 56f3f26e 2024-06-03 stsp section 8">gotwebd(8)</a>. An interactive repository interface for the
79 56f3f26e 2024-06-03 stsp terminal is provided by <a class="Xr" aria-label="tog, section
80 56f3f26e 2024-06-03 stsp 1">tog(1)</a>.</p>
81 8797b228 2019-08-04 stsp <p class="Pp">The commands for <code class="Nm">got</code> are as follows:</p>
82 8797b228 2019-08-04 stsp <dl class="Bl-tag">
83 56f3f26e 2024-06-03 stsp <dt id="init"><a class="permalink" href="#init"><code class="Cm">init</code></a>
84 56f3f26e 2024-06-03 stsp [<code class="Fl">-b</code> <var class="Ar">branch</var>]
85 56f3f26e 2024-06-03 stsp <var class="Ar">repository-path</var></dt>
86 56f3f26e 2024-06-03 stsp <dd>Create a new empty repository at the specified
87 56f3f26e 2024-06-03 stsp <var class="Ar">repository-path</var>.
88 56f3f26e 2024-06-03 stsp <p class="Pp">After <code class="Cm">got init</code>, the new repository
89 56f3f26e 2024-06-03 stsp must be populated before <code class="Cm">got checkout</code> can be
90 56f3f26e 2024-06-03 stsp used. The <code class="Cm">got import</code> command can be used to
91 56f3f26e 2024-06-03 stsp populate the new repository with data from a local directory.
92 56f3f26e 2024-06-03 stsp Alternatively, on a server running <a class="Xr" aria-label="gotd,
93 56f3f26e 2024-06-03 stsp section 8">gotd(8)</a>, the new repository can be made available to
94 56f3f26e 2024-06-03 stsp <a class="Xr" aria-label="got, section 1">got(1)</a> or
95 56f3f26e 2024-06-03 stsp <a class="Xr" aria-label="git, section 1">git(1)</a> clients by adding
96 56f3f26e 2024-06-03 stsp the repository to <a class="Xr" aria-label="gotd.conf, section
97 56f3f26e 2024-06-03 stsp 5">gotd.conf(5)</a> and restarting <a class="Xr" aria-label="gotd,
98 56f3f26e 2024-06-03 stsp section 8">gotd(8)</a>. Clients may then clone the new repository from
99 56f3f26e 2024-06-03 stsp the server, populate the cloned repository, and then populate the new
100 56f3f26e 2024-06-03 stsp repository on the server via <code class="Cm">got send</code> or
101 56f3f26e 2024-06-03 stsp <code class="Cm">git push</code>.</p>
102 56f3f26e 2024-06-03 stsp <p class="Pp">The options for <code class="Cm">got init</code> are as
103 56f3f26e 2024-06-03 stsp follows:</p>
104 56f3f26e 2024-06-03 stsp <dl class="Bl-tag">
105 56f3f26e 2024-06-03 stsp <dt id="b"><a class="permalink" href="#b"><code class="Fl">-b</code></a>
106 56f3f26e 2024-06-03 stsp <var class="Ar">branch</var></dt>
107 56f3f26e 2024-06-03 stsp <dd>Make the repository's HEAD reference point to the specified
108 56f3f26e 2024-06-03 stsp <var class="Ar">branch</var> instead of the default branch
109 56f3f26e 2024-06-03 stsp &#x201C;main&#x201D;.</dd>
110 56f3f26e 2024-06-03 stsp </dl>
111 56f3f26e 2024-06-03 stsp <p class="Pp">The <code class="Cm">got init</code> command is equivalent to
112 56f3f26e 2024-06-03 stsp <code class="Cm">gotadmin init</code>.</p>
113 56f3f26e 2024-06-03 stsp </dd>
114 63b69821 2021-10-16 stsp <dt id="im"><a class="permalink" href="#import"><code class="Cm" id="import">import</code></a>
115 8797b228 2019-08-04 stsp [<code class="Fl">-b</code> <var class="Ar">branch</var>]
116 63657f42 2022-09-07 stsp [<code class="Fl">-I</code> <var class="Ar">pattern</var>]
117 8797b228 2019-08-04 stsp [<code class="Fl">-m</code> <var class="Ar">message</var>]
118 8797b228 2019-08-04 stsp [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
119 8797b228 2019-08-04 stsp <var class="Ar">directory</var></dt>
120 63b69821 2021-10-16 stsp <dd>
121 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
122 46043f6f 2021-11-23 stsp <code class="Cm">im</code>)</code></div>
123 46043f6f 2021-11-23 stsp Create an initial commit in a repository from the file hierarchy within the
124 46043f6f 2021-11-23 stsp specified <var class="Ar">directory</var>. The created commit will not
125 8797b228 2019-08-04 stsp have any parent commits, i.e. it will be a root commit. Also create a new
126 8797b228 2019-08-04 stsp reference which provides a branch name for the newly created commit. Show
127 8797b228 2019-08-04 stsp the path of each imported file to indicate progress.
128 8797b228 2019-08-04 stsp <p class="Pp">The <code class="Cm">got import</code> command requires the
129 c2a52be5 2019-09-08 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
130 376d4d52 2022-07-04 stsp unless an author has been configured in
131 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
132 376d4d52 2022-07-04 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
133 376d4d52 2022-07-04 stsp configuration settings can be obtained from the repository's
134 376d4d52 2022-07-04 stsp <span class="Pa">.git/config</span> file or from Git's global
135 376d4d52 2022-07-04 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
136 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got import</code> are as
137 8797b228 2019-08-04 stsp follows:</p>
138 8797b228 2019-08-04 stsp <dl class="Bl-tag">
139 56f3f26e 2024-06-03 stsp <dt id="b~2"><a class="permalink" href="#b~2"><code class="Fl">-b</code></a>
140 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
141 3cde8558 2022-09-23 stsp <dd>Create the specified <var class="Ar">branch</var>. If this option is
142 3cde8558 2022-09-23 stsp not specified, a branch corresponding to the repository's HEAD
143 3cde8558 2022-09-23 stsp reference will be used. Use of this option is required if the branch
144 3cde8558 2022-09-23 stsp resolved via the repository's HEAD reference already exists.</dd>
145 63657f42 2022-09-07 stsp <dt id="I"><a class="permalink" href="#I"><code class="Fl">-I</code></a>
146 63657f42 2022-09-07 stsp <var class="Ar">pattern</var></dt>
147 63657f42 2022-09-07 stsp <dd>Ignore files or directories with a name which matches the specified
148 63657f42 2022-09-07 stsp <var class="Ar">pattern</var>. This option may be specified multiple
149 63657f42 2022-09-07 stsp times to build a list of ignore patterns. The
150 63657f42 2022-09-07 stsp <var class="Ar">pattern</var> follows the globbing rules documented in
151 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="glob, section 7">glob(7)</a>. Ignore
152 f6a6fa94 2023-02-22 stsp patterns which end with a slash, &#x201C;/&#x201D;, will only match
153 f6a6fa94 2023-02-22 stsp directories.</dd>
154 2dbbbc3a 2020-07-23 stsp <dt id="m"><a class="permalink" href="#m"><code class="Fl">-m</code></a>
155 8797b228 2019-08-04 stsp <var class="Ar">message</var></dt>
156 8797b228 2019-08-04 stsp <dd>Use the specified log message when creating the new commit. Without
157 8797b228 2019-08-04 stsp the <code class="Fl">-m</code> option, <code class="Cm">got
158 8797b228 2019-08-04 stsp import</code> opens a temporary file in an editor where a log message
159 461d9094 2023-07-19 stsp can be written. Quitting the editor without saving the file will abort
160 461d9094 2023-07-19 stsp the import operation.</dd>
161 2dbbbc3a 2020-07-23 stsp <dt id="r"><a class="permalink" href="#r"><code class="Fl">-r</code></a>
162 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
163 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
164 8797b228 2019-08-04 stsp repository is located at or above the current working directory.</dd>
165 8797b228 2019-08-04 stsp </dl>
166 8797b228 2019-08-04 stsp </dd>
167 63b69821 2021-10-16 stsp <dt id="cl"><a class="permalink" href="#clone"><code class="Cm" id="clone">clone</code></a>
168 63657f42 2022-09-07 stsp [<code class="Fl">-almqv</code>] [<code class="Fl">-b</code>
169 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-R</code>
170 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var>] <var class="Ar">repository-URL</var>
171 b213cbf7 2020-03-23 stsp [<var class="Ar">directory</var>]</dt>
172 63b69821 2021-10-16 stsp <dd>
173 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
174 46043f6f 2021-11-23 stsp <code class="Cm">cl</code>)</code></div>
175 46043f6f 2021-11-23 stsp Clone a Git repository at the specified <var class="Ar">repository-URL</var>
176 46043f6f 2021-11-23 stsp into the specified <var class="Ar">directory</var>. If no
177 b078d5c4 2022-03-23 stsp <var class="Ar">directory</var> is specified, the directory name will be
178 46043f6f 2021-11-23 stsp derived from the name of the cloned repository. <code class="Cm">got
179 46043f6f 2021-11-23 stsp clone</code> will refuse to run if the <var class="Ar">directory</var>
180 46043f6f 2021-11-23 stsp already exists.
181 b213cbf7 2020-03-23 stsp <p class="Pp">The <var class="Ar">repository-URL</var> specifies a protocol
182 b213cbf7 2020-03-23 stsp scheme, a server hostname, an optional port number separated from the
183 b213cbf7 2020-03-23 stsp hostname by a colon, and a path to the repository on the server:
184 b213cbf7 2020-03-23 stsp <a class="Lk" href="scheme://hostname:port/path/to/repository">scheme://hostname:port/path/to/repository</a></p>
185 b213cbf7 2020-03-23 stsp <p class="Pp">The following protocol schemes are supported:</p>
186 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
187 b213cbf7 2020-03-23 stsp <dt>git</dt>
188 376d4d52 2022-07-04 stsp <dd>The Git protocol as implemented by the
189 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-daemon, section 1">git-daemon(1)</a>
190 b213cbf7 2020-03-23 stsp server. Use of this protocol is discouraged since it supports neither
191 b213cbf7 2020-03-23 stsp authentication nor encryption.</dd>
192 bd0bf387 2024-04-23 stsp <dt>ssh</dt>
193 b213cbf7 2020-03-23 stsp <dd>The Git protocol wrapped in an authenticated and encrypted
194 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> tunnel. With this
195 376d4d52 2022-07-04 stsp protocol the hostname may contain an embedded username for
196 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> to use:
197 b213cbf7 2020-03-23 stsp <a class="Mt" href="mailto:user@hostname">user@hostname</a></dd>
198 bd0bf387 2024-04-23 stsp <dt>http</dt>
199 bd0bf387 2024-04-23 stsp <dd>The &#x201C;smart&#x201D; Git HTTP protocol. Not compatible with
200 bd0bf387 2024-04-23 stsp servers using the &#x201C;dumb&#x201D; Git HTTP protocol.
201 bd0bf387 2024-04-23 stsp <p class="Pp">The &#x201C;smart&#x201D; Git HTTP protocol is supported
202 bd0bf387 2024-04-23 stsp by <code class="Cm">got clone</code> and <code class="Cm">got
203 bd0bf387 2024-04-23 stsp fetch</code>, but not by <code class="Cm">got send</code>. Sending
204 dfc34448 2024-05-06 stsp from a repository cloned over HTTP will require use of a
205 dfc34448 2024-05-06 stsp <code class="Ic">send</code> block in
206 bd0bf387 2024-04-23 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> to
207 bd0bf387 2024-04-23 stsp ensure that the &#x201C;ssh://&#x201D; protocol will be used by
208 bd0bf387 2024-04-23 stsp <code class="Cm">got send</code>.</p>
209 bd0bf387 2024-04-23 stsp <p class="Pp">Use of this protocol is discouraged since it supports
210 bd0bf387 2024-04-23 stsp neither authentication nor encryption.</p>
211 bd0bf387 2024-04-23 stsp </dd>
212 bd0bf387 2024-04-23 stsp <dt>https</dt>
213 bd0bf387 2024-04-23 stsp <dd>The &#x201C;smart&#x201D; Git HTTP protocol wrapped in SSL/TLS.</dd>
214 b213cbf7 2020-03-23 stsp </dl>
215 b213cbf7 2020-03-23 stsp <p class="Pp">Objects in the cloned repository are stored in a pack file
216 b213cbf7 2020-03-23 stsp which is downloaded from the server. This pack file will then be indexed
217 b213cbf7 2020-03-23 stsp to facilitate access to the objects stored within. If any objects in the
218 b213cbf7 2020-03-23 stsp pack file are stored in deltified form, all deltas will be fully
219 b213cbf7 2020-03-23 stsp resolved in order to compute the ID of such objects. This can take some
220 b213cbf7 2020-03-23 stsp time. More details about the pack file format are documented in
221 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repository, section
222 376d4d52 2022-07-04 stsp 5">git-repository(5)</a>.</p>
223 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got clone</code> creates a remote repository
224 376d4d52 2022-07-04 stsp entry in the <a class="Xr" aria-label="got.conf, section
225 376d4d52 2022-07-04 stsp 5">got.conf(5)</a> and <span class="Pa">config</span> files of the
226 376d4d52 2022-07-04 stsp cloned repository to store the <var class="Ar">repository-url</var> and
227 376d4d52 2022-07-04 stsp any <var class="Ar">branch</var> or <var class="Ar">reference</var>
228 039953c9 2021-03-22 stsp arguments for future use by <code class="Cm">got fetch</code> or
229 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>.</p>
230 b213cbf7 2020-03-23 stsp <p class="Pp">The options for <code class="Cm">got clone</code> are as
231 b213cbf7 2020-03-23 stsp follows:</p>
232 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
233 2dbbbc3a 2020-07-23 stsp <dt id="a"><a class="permalink" href="#a"><code class="Fl">-a</code></a></dt>
234 b213cbf7 2020-03-23 stsp <dd>Fetch all branches from the remote repository's
235 039953c9 2021-03-22 stsp &#x201C;refs/heads/&#x201D; reference namespace and set
236 376d4d52 2022-07-04 stsp <code class="Cm">fetch_all_branches</code> in the cloned repository's
237 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> file
238 376d4d52 2022-07-04 stsp for future use by <code class="Cm">got fetch</code>. If this option is
239 376d4d52 2022-07-04 stsp not specified, a branch resolved via the remote repository's HEAD
240 376d4d52 2022-07-04 stsp reference will be fetched. Cannot be used together with the
241 376d4d52 2022-07-04 stsp <code class="Fl">-b</code> option.</dd>
242 56f3f26e 2024-06-03 stsp <dt id="b~3"><a class="permalink" href="#b~3"><code class="Fl">-b</code></a>
243 b213cbf7 2020-03-23 stsp <var class="Ar">branch</var></dt>
244 b213cbf7 2020-03-23 stsp <dd>Fetch the specified <var class="Ar">branch</var> from the remote
245 b213cbf7 2020-03-23 stsp repository's &#x201C;refs/heads/&#x201D; reference namespace. This
246 b213cbf7 2020-03-23 stsp option may be specified multiple times to build a list of branches to
247 b213cbf7 2020-03-23 stsp fetch. If the branch corresponding to the remote repository's HEAD
248 b213cbf7 2020-03-23 stsp reference is not in this list, the cloned repository's HEAD reference
249 b213cbf7 2020-03-23 stsp will be set to the first branch which was fetched. If this option is
250 b213cbf7 2020-03-23 stsp not specified, a branch resolved via the remote repository's HEAD
251 b213cbf7 2020-03-23 stsp reference will be fetched. Cannot be used together with the
252 b213cbf7 2020-03-23 stsp <code class="Fl">-a</code> option.</dd>
253 2dbbbc3a 2020-07-23 stsp <dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt>
254 b213cbf7 2020-03-23 stsp <dd>List branches and tags available for fetching from the remote
255 b213cbf7 2020-03-23 stsp repository and exit immediately. Cannot be used together with any of
256 039953c9 2021-03-22 stsp the other options except <code class="Fl">-q</code> and
257 039953c9 2021-03-22 stsp <code class="Fl">-v</code>.</dd>
258 2dbbbc3a 2020-07-23 stsp <dt id="m~2"><a class="permalink" href="#m~2"><code class="Fl">-m</code></a></dt>
259 b213cbf7 2020-03-23 stsp <dd>Create the cloned repository as a mirror of the original repository.
260 b213cbf7 2020-03-23 stsp This is useful if the cloned repository will not be used to store
261 a462773e 2020-04-19 stsp locally created commits.
262 376d4d52 2022-07-04 stsp <p class="Pp">The repository's <a class="Xr" aria-label="got.conf,
263 376d4d52 2022-07-04 stsp section 5">got.conf(5)</a> and <span class="Pa">config</span> files
264 376d4d52 2022-07-04 stsp will be set up with the &#x201C;mirror&#x201D; option enabled, such
265 376d4d52 2022-07-04 stsp that <code class="Cm">got fetch</code> or
266 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>
267 a462773e 2020-04-19 stsp will write incoming changes directly to branches in the
268 b213cbf7 2020-03-23 stsp &#x201C;refs/heads/&#x201D; reference namespace, rather than to
269 b213cbf7 2020-03-23 stsp branches in the &#x201C;refs/remotes/&#x201D; namespace. This avoids
270 b213cbf7 2020-03-23 stsp the usual requirement of having to run <code class="Cm">got
271 461d9094 2023-07-19 stsp rebase</code> or <code class="Cm">got merge</code> after
272 461d9094 2023-07-19 stsp <code class="Cm">got fetch</code> in order to make incoming changes
273 461d9094 2023-07-19 stsp appear on branches in the &#x201C;refs/heads/&#x201D; namespace. But
274 461d9094 2023-07-19 stsp maintaining custom changes in the cloned repository becomes
275 461d9094 2023-07-19 stsp difficult since such changes will be at risk of being discarded
276 461d9094 2023-07-19 stsp whenever incoming changes are fetched.</p>
277 b213cbf7 2020-03-23 stsp </dd>
278 2dbbbc3a 2020-07-23 stsp <dt id="q"><a class="permalink" href="#q"><code class="Fl">-q</code></a></dt>
279 b213cbf7 2020-03-23 stsp <dd>Suppress progress reporting output. The same option will be passed to
280 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
281 376d4d52 2022-07-04 stsp applicable.</dd>
282 2dbbbc3a 2020-07-23 stsp <dt id="R"><a class="permalink" href="#R"><code class="Fl">-R</code></a>
283 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
284 b213cbf7 2020-03-23 stsp <dd>In addition to the branches and tags that will be fetched, fetch an
285 b213cbf7 2020-03-23 stsp arbitrary <var class="Ar">reference</var> from the remote repository's
286 b213cbf7 2020-03-23 stsp &#x201C;refs/&#x201D; namespace. This option may be specified multiple
287 b213cbf7 2020-03-23 stsp times to build a list of additional references to fetch. The specified
288 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var> may either be a path to a specific
289 b213cbf7 2020-03-23 stsp reference, or a reference namespace which will cause all references in
290 b213cbf7 2020-03-23 stsp this namespace to be fetched.
291 b213cbf7 2020-03-23 stsp <p class="Pp">Each reference will be mapped into the cloned repository's
292 b213cbf7 2020-03-23 stsp &#x201C;refs/remotes/&#x201D; namespace, unless the
293 b213cbf7 2020-03-23 stsp <code class="Fl">-m</code> option is used to mirror references
294 b213cbf7 2020-03-23 stsp directly into the cloned repository's &#x201C;refs/&#x201D;
295 b213cbf7 2020-03-23 stsp namespace.</p>
296 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got clone</code> will refuse to fetch
297 b213cbf7 2020-03-23 stsp references from the remote repository's
298 b213cbf7 2020-03-23 stsp &#x201C;refs/remotes/&#x201D; or &#x201C;refs/got/&#x201D;
299 b213cbf7 2020-03-23 stsp namespace.</p>
300 b213cbf7 2020-03-23 stsp </dd>
301 63657f42 2022-09-07 stsp <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
302 63657f42 2022-09-07 stsp <dd>Verbose mode. Causes <code class="Cm">got clone</code> to print
303 63657f42 2022-09-07 stsp debugging messages to standard error output. This option will be
304 63657f42 2022-09-07 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
305 63657f42 2022-09-07 stsp applicable. Multiple -v options increase the verbosity. The maximum is
306 63657f42 2022-09-07 stsp 3.</dd>
307 b213cbf7 2020-03-23 stsp </dl>
308 b213cbf7 2020-03-23 stsp </dd>
309 63b69821 2021-10-16 stsp <dt id="fe"><a class="permalink" href="#fetch"><code class="Cm" id="fetch">fetch</code></a>
310 63657f42 2022-09-07 stsp [<code class="Fl">-adlqtvX</code>] [<code class="Fl">-b</code>
311 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-R</code>
312 63657f42 2022-09-07 stsp <var class="Ar">reference</var>] [<code class="Fl">-r</code>
313 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>]
314 63657f42 2022-09-07 stsp [<var class="Ar">remote-repository</var>]</dt>
315 63b69821 2021-10-16 stsp <dd>
316 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
317 46043f6f 2021-11-23 stsp <code class="Cm">fe</code>)</code></div>
318 46043f6f 2021-11-23 stsp Fetch new changes from a remote repository. If no
319 b213cbf7 2020-03-23 stsp <var class="Ar">remote-repository</var> is specified,
320 b213cbf7 2020-03-23 stsp &#x201C;origin&#x201D; will be used. The remote repository's URL is
321 376d4d52 2022-07-04 stsp obtained from the corresponding entry in
322 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
323 376d4d52 2022-07-04 stsp <span class="Pa">config</span> file of the local repository, as created by
324 376d4d52 2022-07-04 stsp <code class="Cm">got clone</code>.
325 f6a6fa94 2023-02-22 stsp <p class="Pp">By default, any branches configured in
326 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> for the
327 f6a6fa94 2023-02-22 stsp <var class="Ar">remote-repository</var> will be fetched. If
328 f6a6fa94 2023-02-22 stsp <code class="Cm">got fetch</code> is invoked in a work tree then this
329 f6a6fa94 2023-02-22 stsp work tree's current branch will be fetched, too, provided it is present
330 f6a6fa94 2023-02-22 stsp on the server. If no branches to fetch can be found in
331 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or via a
332 f6a6fa94 2023-02-22 stsp work tree, or said branches are not found on the server, a branch
333 f6a6fa94 2023-02-22 stsp resolved via the remote repository's HEAD reference will be fetched.
334 f6a6fa94 2023-02-22 stsp Likewise, if a HEAD reference for the
335 f6a6fa94 2023-02-22 stsp <var class="Ar">remote-repository</var> exists but its target no longer
336 f6a6fa94 2023-02-22 stsp matches the remote HEAD, then the new target branch will be fetched.
337 f6a6fa94 2023-02-22 stsp This default behaviour can be overridden with the
338 f6a6fa94 2023-02-22 stsp <code class="Fl">-a</code> and <code class="Fl">-b</code> options.</p>
339 b213cbf7 2020-03-23 stsp <p class="Pp">New changes will be stored in a separate pack file downloaded
340 b213cbf7 2020-03-23 stsp from the server. Optionally, separate pack files stored in the
341 376d4d52 2022-07-04 stsp repository can be combined with <a class="Xr" aria-label="git-repack,
342 376d4d52 2022-07-04 stsp section 1">git-repack(1)</a>.</p>
343 b213cbf7 2020-03-23 stsp <p class="Pp">By default, branch references in the
344 b213cbf7 2020-03-23 stsp &#x201C;refs/remotes/&#x201D; reference namespace will be updated to
345 b213cbf7 2020-03-23 stsp point at the newly fetched commits. The <code class="Cm">got
346 461d9094 2023-07-19 stsp rebase</code> or <code class="Cm">got merge</code> command can then be
347 461d9094 2023-07-19 stsp used to make new changes visible on branches in the
348 461d9094 2023-07-19 stsp &#x201C;refs/heads/&#x201D; namespace, merging incoming changes with the
349 461d9094 2023-07-19 stsp changes on those branches as necessary.</p>
350 b213cbf7 2020-03-23 stsp <p class="Pp">If the repository was created as a mirror with
351 b078d5c4 2022-03-23 stsp <code class="Cm">got clone -m</code>, then all branches in the
352 b213cbf7 2020-03-23 stsp &#x201C;refs/heads/&#x201D; namespace will be updated directly to match
353 b213cbf7 2020-03-23 stsp the corresponding branches in the remote repository. If those branches
354 b213cbf7 2020-03-23 stsp contained local commits, these commits will no longer be reachable via a
355 b213cbf7 2020-03-23 stsp reference and will therefore be at risk of being discarded by Git's
356 16cd1323 2021-07-26 stsp garbage collector or <code class="Cm">gotadmin cleanup</code>.
357 16cd1323 2021-07-26 stsp Maintaining custom changes in a mirror repository is therefore
358 16cd1323 2021-07-26 stsp discouraged.</p>
359 b213cbf7 2020-03-23 stsp <p class="Pp">In any case, references in the &#x201C;refs/tags/&#x201D;
360 b213cbf7 2020-03-23 stsp namespace will always be fetched and mapped directly to local references
361 b213cbf7 2020-03-23 stsp in the same namespace.</p>
362 b213cbf7 2020-03-23 stsp <p class="Pp">The options for <code class="Cm">got fetch</code> are as
363 b213cbf7 2020-03-23 stsp follows:</p>
364 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
365 2dbbbc3a 2020-07-23 stsp <dt id="a~2"><a class="permalink" href="#a~2"><code class="Fl">-a</code></a></dt>
366 b213cbf7 2020-03-23 stsp <dd>Fetch all branches from the remote repository's
367 039953c9 2021-03-22 stsp &#x201C;refs/heads/&#x201D; reference namespace. This option can be
368 039953c9 2021-03-22 stsp enabled by default for specific repositories in
369 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>. Cannot
370 f6a6fa94 2023-02-22 stsp be used together with the <code class="Fl">-b</code> option.</dd>
371 56f3f26e 2024-06-03 stsp <dt id="b~4"><a class="permalink" href="#b~4"><code class="Fl">-b</code></a>
372 b213cbf7 2020-03-23 stsp <var class="Ar">branch</var></dt>
373 b213cbf7 2020-03-23 stsp <dd>Fetch the specified <var class="Ar">branch</var> from the remote
374 b213cbf7 2020-03-23 stsp repository's &#x201C;refs/heads/&#x201D; reference namespace. This
375 b213cbf7 2020-03-23 stsp option may be specified multiple times to build a list of branches to
376 f6a6fa94 2023-02-22 stsp fetch. Cannot be used together with the <code class="Fl">-a</code>
377 f6a6fa94 2023-02-22 stsp option.</dd>
378 2dbbbc3a 2020-07-23 stsp <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt>
379 b213cbf7 2020-03-23 stsp <dd>Delete branches and tags from the local repository which are no longer
380 b213cbf7 2020-03-23 stsp present in the remote repository. Only references are deleted. Any
381 b213cbf7 2020-03-23 stsp commit, tree, tag, and blob objects belonging to deleted branches or
382 b213cbf7 2020-03-23 stsp tags remain in the repository and may be removed separately with Git's
383 16cd1323 2021-07-26 stsp garbage collector or <code class="Cm">gotadmin cleanup</code>.</dd>
384 2dbbbc3a 2020-07-23 stsp <dt id="l~2"><a class="permalink" href="#l~2"><code class="Fl">-l</code></a></dt>
385 b213cbf7 2020-03-23 stsp <dd>List branches and tags available for fetching from the remote
386 b213cbf7 2020-03-23 stsp repository and exit immediately. Cannot be used together with any of
387 039953c9 2021-03-22 stsp the other options except <code class="Fl">-v</code>,
388 039953c9 2021-03-22 stsp <code class="Fl">-q</code>, and <code class="Fl">-r</code>.</dd>
389 2dbbbc3a 2020-07-23 stsp <dt id="q~2"><a class="permalink" href="#q~2"><code class="Fl">-q</code></a></dt>
390 b213cbf7 2020-03-23 stsp <dd>Suppress progress reporting output. The same option will be passed to
391 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
392 376d4d52 2022-07-04 stsp applicable.</dd>
393 2dbbbc3a 2020-07-23 stsp <dt id="R~2"><a class="permalink" href="#R~2"><code class="Fl">-R</code></a>
394 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
395 b213cbf7 2020-03-23 stsp <dd>In addition to the branches and tags that will be fetched, fetch an
396 b213cbf7 2020-03-23 stsp arbitrary <var class="Ar">reference</var> from the remote repository's
397 b213cbf7 2020-03-23 stsp &#x201C;refs/&#x201D; namespace. This option may be specified multiple
398 b213cbf7 2020-03-23 stsp times to build a list of additional references to fetch. The specified
399 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var> may either be a path to a specific
400 b213cbf7 2020-03-23 stsp reference, or a reference namespace which will cause all references in
401 b213cbf7 2020-03-23 stsp this namespace to be fetched.
402 b213cbf7 2020-03-23 stsp <p class="Pp">Each reference will be mapped into the local repository's
403 b213cbf7 2020-03-23 stsp &#x201C;refs/remotes/&#x201D; namespace, unless the local repository
404 b213cbf7 2020-03-23 stsp was created as a mirror with <code class="Cm">got clone -m</code> in
405 b213cbf7 2020-03-23 stsp which case references will be mapped directly into the local
406 b213cbf7 2020-03-23 stsp repository's &#x201C;refs/&#x201D; namespace.</p>
407 a462773e 2020-04-19 stsp <p class="Pp">Once a reference has been fetched, a branch based on it
408 a462773e 2020-04-19 stsp can be created with <code class="Cm">got branch</code> if
409 b213cbf7 2020-03-23 stsp needed.</p>
410 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got fetch</code> will refuse to fetch
411 b213cbf7 2020-03-23 stsp references from the remote repository's
412 b213cbf7 2020-03-23 stsp &#x201C;refs/remotes/&#x201D; or &#x201C;refs/got/&#x201D;
413 b213cbf7 2020-03-23 stsp namespace.</p>
414 16cd1323 2021-07-26 stsp </dd>
415 63657f42 2022-09-07 stsp <dt id="r~2"><a class="permalink" href="#r~2"><code class="Fl">-r</code></a>
416 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
417 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
418 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
419 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
420 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
421 63657f42 2022-09-07 stsp <dt id="t"><a class="permalink" href="#t"><code class="Fl">-t</code></a></dt>
422 63657f42 2022-09-07 stsp <dd>Allow existing references in the &#x201C;refs/tags&#x201D; namespace
423 63657f42 2022-09-07 stsp to be updated if they have changed on the server. If not specified,
424 63657f42 2022-09-07 stsp only new tag references will be created.</dd>
425 63657f42 2022-09-07 stsp <dt id="v~2"><a class="permalink" href="#v~2"><code class="Fl">-v</code></a></dt>
426 63657f42 2022-09-07 stsp <dd>Verbose mode. Causes <code class="Cm">got fetch</code> to print
427 63657f42 2022-09-07 stsp debugging messages to standard error output. The same option will be
428 63657f42 2022-09-07 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
429 63657f42 2022-09-07 stsp applicable. Multiple -v options increase the verbosity. The maximum is
430 63657f42 2022-09-07 stsp 3.</dd>
431 16cd1323 2021-07-26 stsp <dt id="X"><a class="permalink" href="#X"><code class="Fl">-X</code></a></dt>
432 16cd1323 2021-07-26 stsp <dd>Delete all references which correspond to a particular
433 16cd1323 2021-07-26 stsp <var class="Ar">remote-repository</var> instead of fetching new
434 16cd1323 2021-07-26 stsp changes. This can be useful when a remote repository is being removed
435 376d4d52 2022-07-04 stsp from <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>.
436 16cd1323 2021-07-26 stsp <p class="Pp">With <code class="Fl">-X</code>, the
437 16cd1323 2021-07-26 stsp <var class="Ar">remote-repository</var> argument is mandatory and no
438 16cd1323 2021-07-26 stsp other options except <code class="Fl">-r</code>,
439 16cd1323 2021-07-26 stsp <code class="Fl">-v</code>, and <code class="Fl">-q</code> are
440 16cd1323 2021-07-26 stsp allowed.</p>
441 16cd1323 2021-07-26 stsp <p class="Pp">Only references are deleted. Any commit, tree, tag, and
442 16cd1323 2021-07-26 stsp blob objects fetched from a remote repository will generally be
443 16cd1323 2021-07-26 stsp stored in pack files and may be removed separately with
444 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repack, section 1">git-repack(1)</a>
445 376d4d52 2022-07-04 stsp and Git's garbage collector.</p>
446 b213cbf7 2020-03-23 stsp </dd>
447 b213cbf7 2020-03-23 stsp </dl>
448 b213cbf7 2020-03-23 stsp </dd>
449 63b69821 2021-10-16 stsp <dt id="co"><a class="permalink" href="#checkout"><code class="Cm" id="checkout">checkout</code></a>
450 63657f42 2022-09-07 stsp [<code class="Fl">-Eq</code>] [<code class="Fl">-b</code>
451 8b679b4b 2020-02-17 stsp <var class="Ar">branch</var>] [<code class="Fl">-c</code>
452 8b679b4b 2020-02-17 stsp <var class="Ar">commit</var>] [<code class="Fl">-p</code>
453 63657f42 2022-09-07 stsp <var class="Ar">path-prefix</var>] <var class="Ar">repository-path</var>
454 8797b228 2019-08-04 stsp [<var class="Ar">work-tree-path</var>]</dt>
455 63b69821 2021-10-16 stsp <dd>
456 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
457 46043f6f 2021-11-23 stsp <code class="Cm">co</code>)</code></div>
458 46043f6f 2021-11-23 stsp Copy files from a repository into a new work tree. Show the status of each
459 8b679b4b 2020-02-17 stsp affected file, using the following status codes:
460 8b679b4b 2020-02-17 stsp <table class="Bl-column">
461 8b679b4b 2020-02-17 stsp <tr>
462 8b679b4b 2020-02-17 stsp <td>A</td>
463 8b679b4b 2020-02-17 stsp <td>new file was added</td>
464 8b679b4b 2020-02-17 stsp </tr>
465 8b679b4b 2020-02-17 stsp <tr>
466 8b679b4b 2020-02-17 stsp <td>E</td>
467 8b679b4b 2020-02-17 stsp <td>file already exists in work tree's meta-data</td>
468 8b679b4b 2020-02-17 stsp </tr>
469 8b679b4b 2020-02-17 stsp </table>
470 8b679b4b 2020-02-17 stsp <p class="Pp">If the <var class="Ar">work tree path</var> is not specified,
471 8b679b4b 2020-02-17 stsp either use the last component of <var class="Ar">repository path</var>,
472 8b679b4b 2020-02-17 stsp or if a <var class="Ar">path prefix</var> was specified use the last
473 8b679b4b 2020-02-17 stsp component of <var class="Ar">path prefix</var>.</p>
474 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got checkout</code> are as
475 8797b228 2019-08-04 stsp follows:</p>
476 8797b228 2019-08-04 stsp <dl class="Bl-tag">
477 56f3f26e 2024-06-03 stsp <dt id="b~5"><a class="permalink" href="#b~5"><code class="Fl">-b</code></a>
478 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
479 8797b228 2019-08-04 stsp <dd>Check out files from a commit on the specified
480 8797b228 2019-08-04 stsp <var class="Ar">branch</var>. If this option is not specified, a
481 8797b228 2019-08-04 stsp branch resolved via the repository's HEAD reference will be used.</dd>
482 2dbbbc3a 2020-07-23 stsp <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
483 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
484 8797b228 2019-08-04 stsp <dd>Check out files from the specified <var class="Ar">commit</var> on the
485 461d9094 2023-07-19 stsp selected branch. If this option is not specified, the most recent
486 461d9094 2023-07-19 stsp commit on the selected branch will be used.
487 461d9094 2023-07-19 stsp <p class="Pp">The expected <var class="Ar">commit</var> argument is a
488 461d9094 2023-07-19 stsp commit ID SHA1 hash, or a reference name or a keyword which will be
489 461d9094 2023-07-19 stsp resolved to a commit ID. An abbreviated hash argument will be
490 461d9094 2023-07-19 stsp expanded to a full SHA1 hash automatically, provided the
491 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
492 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the repository's HEAD reference, or, if
493 461d9094 2023-07-19 stsp the <code class="Fl">-b</code> option is used, the head of the
494 461d9094 2023-07-19 stsp checked-out <var class="Ar">branch</var>. Keywords and reference
495 461d9094 2023-07-19 stsp names may be appended with &quot;:+&quot; or &quot;:-&quot;
496 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
497 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
498 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
499 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">foo:-3</b> will denote the
500 461d9094 2023-07-19 stsp 3rd generation ancestor of the commit resolved by the
501 461d9094 2023-07-19 stsp &quot;foo&quot; reference. If an integer does not follow the
502 461d9094 2023-07-19 stsp &quot;:+&quot; or &quot;:-&quot; modifier, a &quot;1&quot; is
503 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
504 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
505 ae803b74 2020-03-06 stsp <p class="Pp">If the specified <var class="Ar">commit</var> is not
506 ae803b74 2020-03-06 stsp contained in the selected branch, a different branch which contains
507 ae803b74 2020-03-06 stsp this commit must be specified with the <code class="Fl">-b</code>
508 b078d5c4 2022-03-23 stsp option. If no such branch is known, a new branch must be created for
509 ae803b74 2020-03-06 stsp this commit with <code class="Cm">got branch</code> before
510 ae803b74 2020-03-06 stsp <code class="Cm">got checkout</code> can be used. Checking out work
511 ae803b74 2020-03-06 stsp trees with an unknown branch is intentionally not supported.</p>
512 ae803b74 2020-03-06 stsp </dd>
513 63657f42 2022-09-07 stsp <dt id="E"><a class="permalink" href="#E"><code class="Fl">-E</code></a></dt>
514 63657f42 2022-09-07 stsp <dd>Proceed with the checkout operation even if the directory at
515 63657f42 2022-09-07 stsp <var class="Ar">work-tree-path</var> is not empty. Existing files will
516 63657f42 2022-09-07 stsp be left intact.</dd>
517 2dbbbc3a 2020-07-23 stsp <dt id="p"><a class="permalink" href="#p"><code class="Fl">-p</code></a>
518 8797b228 2019-08-04 stsp <var class="Ar">path-prefix</var></dt>
519 8797b228 2019-08-04 stsp <dd>Restrict the work tree to a subset of the repository's tree hierarchy.
520 8797b228 2019-08-04 stsp Only files beneath the specified <var class="Ar">path-prefix</var>
521 8797b228 2019-08-04 stsp will be checked out.</dd>
522 4448c231 2021-09-15 stsp <dt id="q~3"><a class="permalink" href="#q~3"><code class="Fl">-q</code></a></dt>
523 4448c231 2021-09-15 stsp <dd>Silence progress output.</dd>
524 8797b228 2019-08-04 stsp </dl>
525 8797b228 2019-08-04 stsp </dd>
526 63b69821 2021-10-16 stsp <dt id="up"><a class="permalink" href="#update"><code class="Cm" id="update">update</code></a>
527 63657f42 2022-09-07 stsp [<code class="Fl">-q</code>] [<code class="Fl">-b</code>
528 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-c</code>
529 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<var class="Ar">path ...</var>]</dt>
530 63b69821 2021-10-16 stsp <dd>
531 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
532 46043f6f 2021-11-23 stsp <code class="Cm">up</code>)</code></div>
533 46043f6f 2021-11-23 stsp Update an existing work tree to a different <var class="Ar">commit</var>.
534 9e67ab87 2020-04-14 stsp Change existing files in the work tree as necessary to match file contents
535 9e67ab87 2020-04-14 stsp of this commit. Preserve any local changes in the work tree and merge them
536 9e67ab87 2020-04-14 stsp with the incoming changes.
537 a462773e 2020-04-19 stsp <p class="Pp">Files which already contain merge conflicts will not be
538 a462773e 2020-04-19 stsp updated to avoid further complications. Such files will be updated when
539 a462773e 2020-04-19 stsp <code class="Cm">got update</code> is run again after merge conflicts
540 b078d5c4 2022-03-23 stsp have been resolved. If the conflicting changes are no longer needed,
541 a462773e 2020-04-19 stsp affected files can be reverted with <code class="Cm">got revert</code>
542 a462773e 2020-04-19 stsp before running <code class="Cm">got update</code> again.</p>
543 9e67ab87 2020-04-14 stsp <p class="Pp">Show the status of each affected file, using the following
544 9e67ab87 2020-04-14 stsp status codes:</p>
545 8797b228 2019-08-04 stsp <table class="Bl-column">
546 8797b228 2019-08-04 stsp <tr>
547 8797b228 2019-08-04 stsp <td>U</td>
548 8797b228 2019-08-04 stsp <td>file was updated and contained no local changes</td>
549 8797b228 2019-08-04 stsp </tr>
550 8797b228 2019-08-04 stsp <tr>
551 8797b228 2019-08-04 stsp <td>G</td>
552 8797b228 2019-08-04 stsp <td>file was updated and local changes were merged cleanly</td>
553 8797b228 2019-08-04 stsp </tr>
554 8797b228 2019-08-04 stsp <tr>
555 8797b228 2019-08-04 stsp <td>C</td>
556 8797b228 2019-08-04 stsp <td>file was updated and conflicts occurred during merge</td>
557 8797b228 2019-08-04 stsp </tr>
558 8797b228 2019-08-04 stsp <tr>
559 8797b228 2019-08-04 stsp <td>D</td>
560 8797b228 2019-08-04 stsp <td>file was deleted</td>
561 86b2b9f3 2023-03-12 stsp </tr>
562 86b2b9f3 2023-03-12 stsp <tr>
563 86b2b9f3 2023-03-12 stsp <td>d</td>
564 86b2b9f3 2023-03-12 stsp <td>file's deletion was prevented by local modifications</td>
565 8797b228 2019-08-04 stsp </tr>
566 8797b228 2019-08-04 stsp <tr>
567 8797b228 2019-08-04 stsp <td>A</td>
568 8797b228 2019-08-04 stsp <td>new file was added</td>
569 8797b228 2019-08-04 stsp </tr>
570 8797b228 2019-08-04 stsp <tr>
571 8797b228 2019-08-04 stsp <td>~</td>
572 8797b228 2019-08-04 stsp <td>versioned file is obstructed by a non-regular file</td>
573 8797b228 2019-08-04 stsp </tr>
574 8797b228 2019-08-04 stsp <tr>
575 8797b228 2019-08-04 stsp <td>!</td>
576 8797b228 2019-08-04 stsp <td>a missing versioned file was restored</td>
577 a462773e 2020-04-19 stsp </tr>
578 a462773e 2020-04-19 stsp <tr>
579 a462773e 2020-04-19 stsp <td>#</td>
580 a462773e 2020-04-19 stsp <td>file was not updated because it contains merge conflicts</td>
581 8797b228 2019-08-04 stsp </tr>
582 1554b334 2020-08-02 stsp <tr>
583 1554b334 2020-08-02 stsp <td>?</td>
584 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
585 1554b334 2020-08-02 stsp </tr>
586 8797b228 2019-08-04 stsp </table>
587 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, update the
588 8797b228 2019-08-04 stsp entire work tree. Otherwise, restrict the update operation to files at
589 8797b228 2019-08-04 stsp or within the specified paths. Each path is required to exist in the
590 8797b228 2019-08-04 stsp update operation's target commit. Files in the work tree outside
591 8797b228 2019-08-04 stsp specified paths will remain unchanged and will retain their previously
592 8797b228 2019-08-04 stsp recorded base commit. Some <code class="Nm">got</code> commands may
593 8797b228 2019-08-04 stsp refuse to run while the work tree contains files from multiple base
594 8797b228 2019-08-04 stsp commits. The base commit of such a work tree can be made consistent by
595 8797b228 2019-08-04 stsp running <code class="Cm">got update</code> across the entire work tree.
596 8797b228 2019-08-04 stsp Specifying a <var class="Ar">path</var> is incompatible with the
597 8797b228 2019-08-04 stsp <code class="Fl">-b</code> option.</p>
598 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got update</code> cannot update paths with
599 8797b228 2019-08-04 stsp staged changes. If changes have been staged with <code class="Cm">got
600 91b3da3f 2019-08-18 stsp stage</code>, these changes must first be committed with
601 8797b228 2019-08-04 stsp <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
602 8797b228 2019-08-04 stsp unstage</code>.</p>
603 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got update</code> are as
604 8797b228 2019-08-04 stsp follows:</p>
605 8797b228 2019-08-04 stsp <dl class="Bl-tag">
606 56f3f26e 2024-06-03 stsp <dt id="b~6"><a class="permalink" href="#b~6"><code class="Fl">-b</code></a>
607 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
608 8797b228 2019-08-04 stsp <dd>Switch the work tree's branch reference to the specified
609 8797b228 2019-08-04 stsp <var class="Ar">branch</var> before updating the work tree. This
610 9e67ab87 2020-04-14 stsp option requires that all paths in the work tree are updated.
611 9e67ab87 2020-04-14 stsp <p class="Pp">As usual, any local changes in the work tree will be
612 9e67ab87 2020-04-14 stsp preserved. This can be useful when switching to a newly created
613 9e67ab87 2020-04-14 stsp branch in order to commit existing local changes to this branch.</p>
614 9e67ab87 2020-04-14 stsp <p class="Pp">Any local changes must be dealt with separately in order
615 9e67ab87 2020-04-14 stsp to obtain a work tree with pristine file contents corresponding
616 9e67ab87 2020-04-14 stsp exactly to the specified <var class="Ar">branch</var>. Such changes
617 9e67ab87 2020-04-14 stsp could first be committed to a different branch with
618 9e67ab87 2020-04-14 stsp <code class="Cm">got commit</code>, or could be discarded with
619 9e67ab87 2020-04-14 stsp <code class="Cm">got revert</code>.</p>
620 9e67ab87 2020-04-14 stsp </dd>
621 2dbbbc3a 2020-07-23 stsp <dt id="c~2"><a class="permalink" href="#c~2"><code class="Fl">-c</code></a>
622 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
623 461d9094 2023-07-19 stsp <dd>Update the work tree to the specified <var class="Ar">commit</var>. If
624 461d9094 2023-07-19 stsp this option is not specified, the most recent commit on the work
625 461d9094 2023-07-19 stsp tree's branch will be used.
626 461d9094 2023-07-19 stsp <p class="Pp">The expected <var class="Ar">commit</var> argument is a
627 461d9094 2023-07-19 stsp commit ID SHA1 hash, or a reference name or a keyword which will be
628 461d9094 2023-07-19 stsp resolved to a commit ID. An abbreviated hash argument will be
629 461d9094 2023-07-19 stsp expanded to a full SHA1 hash automatically, provided the
630 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
631 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the work tree's base commit and branch
632 461d9094 2023-07-19 stsp head, respectively. Keywords and reference names may be appended
633 461d9094 2023-07-19 stsp with &quot;:+&quot; or &quot;:-&quot; modifiers and an optional
634 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent, respectively,
635 461d9094 2023-07-19 stsp by first parent traversal; for example, <b class="Sy">:head:-2</b>
636 461d9094 2023-07-19 stsp denotes the work tree branch head's 2nd generation ancestor, and
637 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
638 461d9094 2023-07-19 stsp the work tree's base commit. Similarly, <b class="Sy">foo:-3</b>
639 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
640 461d9094 2023-07-19 stsp the &quot;foo&quot; reference. If an integer does not follow the
641 461d9094 2023-07-19 stsp &quot;:+&quot; or &quot;:-&quot; modifier, a &quot;1&quot; is
642 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
643 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
644 461d9094 2023-07-19 stsp </dd>
645 4448c231 2021-09-15 stsp <dt id="q~4"><a class="permalink" href="#q~4"><code class="Fl">-q</code></a></dt>
646 4448c231 2021-09-15 stsp <dd>Silence progress output.</dd>
647 8797b228 2019-08-04 stsp </dl>
648 8797b228 2019-08-04 stsp </dd>
649 63b69821 2021-10-16 stsp <dt id="st"><a class="permalink" href="#status"><code class="Cm" id="status">status</code></a>
650 63657f42 2022-09-07 stsp [<code class="Fl">-I</code>] [<code class="Fl">-S</code>
651 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var>] [<code class="Fl">-s</code>
652 cb0c453b 2021-09-15 stsp <var class="Ar">status-codes</var>] [<var class="Ar">path ...</var>]</dt>
653 63b69821 2021-10-16 stsp <dd>
654 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
655 46043f6f 2021-11-23 stsp <code class="Cm">st</code>)</code></div>
656 46043f6f 2021-11-23 stsp Show the current modification status of files in a work tree, using the
657 8797b228 2019-08-04 stsp following status codes:
658 8797b228 2019-08-04 stsp <table class="Bl-column">
659 8797b228 2019-08-04 stsp <tr>
660 8797b228 2019-08-04 stsp <td>M</td>
661 8797b228 2019-08-04 stsp <td>modified file</td>
662 8797b228 2019-08-04 stsp </tr>
663 8797b228 2019-08-04 stsp <tr>
664 8797b228 2019-08-04 stsp <td>A</td>
665 8797b228 2019-08-04 stsp <td>file scheduled for addition in next commit</td>
666 8797b228 2019-08-04 stsp </tr>
667 8797b228 2019-08-04 stsp <tr>
668 8797b228 2019-08-04 stsp <td>D</td>
669 8797b228 2019-08-04 stsp <td>file scheduled for deletion in next commit</td>
670 8797b228 2019-08-04 stsp </tr>
671 8797b228 2019-08-04 stsp <tr>
672 8797b228 2019-08-04 stsp <td>C</td>
673 8797b228 2019-08-04 stsp <td>modified or added file which contains merge conflicts</td>
674 8797b228 2019-08-04 stsp </tr>
675 8797b228 2019-08-04 stsp <tr>
676 8797b228 2019-08-04 stsp <td>!</td>
677 8797b228 2019-08-04 stsp <td>versioned file was expected on disk but is missing</td>
678 8797b228 2019-08-04 stsp </tr>
679 8797b228 2019-08-04 stsp <tr>
680 8797b228 2019-08-04 stsp <td>~</td>
681 8797b228 2019-08-04 stsp <td>versioned file is obstructed by a non-regular file</td>
682 8797b228 2019-08-04 stsp </tr>
683 8797b228 2019-08-04 stsp <tr>
684 8797b228 2019-08-04 stsp <td>?</td>
685 8797b228 2019-08-04 stsp <td>unversioned item not tracked by <code class="Nm">got</code></td>
686 ba0a4168 2019-08-26 stsp </tr>
687 ba0a4168 2019-08-26 stsp <tr>
688 d8e62599 2019-10-21 stsp <td>m</td>
689 d8e62599 2019-10-21 stsp <td>modified file modes (executable bit only)</td>
690 d8e62599 2019-10-21 stsp </tr>
691 d8e62599 2019-10-21 stsp <tr>
692 ba0a4168 2019-08-26 stsp <td>N</td>
693 ba0a4168 2019-08-26 stsp <td>non-existent <var class="Ar">path</var> specified on the command
694 ba0a4168 2019-08-26 stsp line</td>
695 8797b228 2019-08-04 stsp </tr>
696 8797b228 2019-08-04 stsp </table>
697 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, show
698 8797b228 2019-08-04 stsp modifications in the entire work tree. Otherwise, show modifications at
699 8797b228 2019-08-04 stsp or within the specified paths.</p>
700 8797b228 2019-08-04 stsp <p class="Pp">If changes have been staged with <code class="Cm">got
701 8797b228 2019-08-04 stsp stage</code>, staged changes are shown in the second output column,
702 8797b228 2019-08-04 stsp using the following status codes:</p>
703 8797b228 2019-08-04 stsp <table class="Bl-column">
704 8797b228 2019-08-04 stsp <tr>
705 8797b228 2019-08-04 stsp <td>M</td>
706 8797b228 2019-08-04 stsp <td>file modification is staged</td>
707 8797b228 2019-08-04 stsp </tr>
708 8797b228 2019-08-04 stsp <tr>
709 8797b228 2019-08-04 stsp <td>A</td>
710 8797b228 2019-08-04 stsp <td>file addition is staged</td>
711 8797b228 2019-08-04 stsp </tr>
712 8797b228 2019-08-04 stsp <tr>
713 8797b228 2019-08-04 stsp <td>D</td>
714 8797b228 2019-08-04 stsp <td>file deletion is staged</td>
715 8797b228 2019-08-04 stsp </tr>
716 8797b228 2019-08-04 stsp </table>
717 fc62dacd 2019-08-08 stsp <p class="Pp">Changes created on top of staged changes are indicated in the
718 fc62dacd 2019-08-08 stsp first column:</p>
719 8797b228 2019-08-04 stsp <table class="Bl-column">
720 8797b228 2019-08-04 stsp <tr>
721 8797b228 2019-08-04 stsp <td>MM</td>
722 fc62dacd 2019-08-08 stsp <td>file was modified after earlier changes have been staged</td>
723 8797b228 2019-08-04 stsp </tr>
724 8797b228 2019-08-04 stsp <tr>
725 8797b228 2019-08-04 stsp <td>MA</td>
726 fc62dacd 2019-08-08 stsp <td>file was modified after having been staged for addition</td>
727 8797b228 2019-08-04 stsp </tr>
728 8797b228 2019-08-04 stsp </table>
729 bd0bf387 2024-04-23 stsp <p class="Pp">If the work tree contains the results of an interrupted
730 bd0bf387 2024-04-23 stsp <code class="Cm">got rebase</code>, <code class="Cm">got
731 bd0bf387 2024-04-23 stsp histedit</code>, or <code class="Cm">got merge</code> operation then
732 bd0bf387 2024-04-23 stsp display a message which shows the branches involved.</p>
733 feee6923 2020-09-17 stsp <p class="Pp">The options for <code class="Cm">got status</code> are as
734 feee6923 2020-09-17 stsp follows:</p>
735 feee6923 2020-09-17 stsp <dl class="Bl-tag">
736 a954aa0a 2021-06-22 stsp <dt id="I~2"><a class="permalink" href="#I~2"><code class="Fl">-I</code></a></dt>
737 a954aa0a 2021-06-22 stsp <dd>Show unversioned files even if they match an ignore pattern.</dd>
738 4448c231 2021-09-15 stsp <dt id="S"><a class="permalink" href="#S"><code class="Fl">-S</code></a>
739 4448c231 2021-09-15 stsp <var class="Ar">status-codes</var></dt>
740 4448c231 2021-09-15 stsp <dd>Suppress the output of files with a modification status matching any
741 4448c231 2021-09-15 stsp of the single-character status codes contained in the
742 4448c231 2021-09-15 stsp <var class="Ar">status-codes</var> argument. Any combination of codes
743 4448c231 2021-09-15 stsp from the above list of possible status codes may be specified. For
744 4448c231 2021-09-15 stsp staged files, status codes displayed in either column will be matched.
745 4448c231 2021-09-15 stsp Cannot be used together with the <code class="Fl">-s</code>
746 4448c231 2021-09-15 stsp option.</dd>
747 63657f42 2022-09-07 stsp <dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>
748 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var></dt>
749 63657f42 2022-09-07 stsp <dd>Only show files with a modification status matching any of the
750 63657f42 2022-09-07 stsp single-character status codes contained in the
751 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var> argument. Any combination of codes
752 63657f42 2022-09-07 stsp from the above list of possible status codes may be specified. For
753 63657f42 2022-09-07 stsp staged files, status codes displayed in either column will be matched.
754 63657f42 2022-09-07 stsp Cannot be used together with the <code class="Fl">-S</code>
755 63657f42 2022-09-07 stsp option.</dd>
756 feee6923 2020-09-17 stsp </dl>
757 376d4d52 2022-07-04 stsp <p class="Pp">For compatibility with <a class="Xr" aria-label="cvs, section
758 376d4d52 2022-07-04 stsp 1">cvs(1)</a> and <a class="Xr" aria-label="git, section 1">git(1)</a>,
759 376d4d52 2022-07-04 stsp <code class="Cm">got status</code> reads <a class="Xr" aria-label="glob,
760 376d4d52 2022-07-04 stsp section 7">glob(7)</a> patterns from <span class="Pa">.cvsignore</span>
761 376d4d52 2022-07-04 stsp and <span class="Pa">.gitignore</span> files in each traversed directory
762 f6a6fa94 2023-02-22 stsp and will not display unversioned files which match these patterns.
763 f6a6fa94 2023-02-22 stsp Ignore patterns which end with a slash, &#x201C;/&#x201D;, will only
764 f6a6fa94 2023-02-22 stsp match directories. As an extension to <a class="Xr" aria-label="glob,
765 f6a6fa94 2023-02-22 stsp section 7">glob(7)</a> matching rules, <code class="Cm">got
766 f6a6fa94 2023-02-22 stsp status</code> supports consecutive asterisks, &#x201C;**&#x201D;, which
767 f6a6fa94 2023-02-22 stsp will match an arbitrary amount of directories. Unlike
768 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="cvs, section 1">cvs(1)</a>,
769 f6a6fa94 2023-02-22 stsp <code class="Cm">got status</code> only supports a single ignore pattern
770 f6a6fa94 2023-02-22 stsp per line. Unlike <a class="Xr" aria-label="git, section 1">git(1)</a>,
771 f6a6fa94 2023-02-22 stsp <code class="Cm">got status</code> does not support negated ignore
772 f6a6fa94 2023-02-22 stsp patterns prefixed with &#x201C;!&#x201D;, and gives no special
773 f6a6fa94 2023-02-22 stsp significance to the location of path component separators,
774 376d4d52 2022-07-04 stsp &#x201C;/&#x201D;, in a pattern.</p>
775 8797b228 2019-08-04 stsp </dd>
776 2dbbbc3a 2020-07-23 stsp <dt id="log"><a class="permalink" href="#log"><code class="Cm">log</code></a>
777 bd0bf387 2024-04-23 stsp [<code class="Fl">-bdPpRst</code>] [<code class="Fl">-C</code>
778 63657f42 2022-09-07 stsp <var class="Ar">number</var>] [<code class="Fl">-c</code>
779 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-l</code>
780 63657f42 2022-09-07 stsp <var class="Ar">N</var>] [<code class="Fl">-r</code>
781 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-S</code>
782 63657f42 2022-09-07 stsp <var class="Ar">search-pattern</var>] [<code class="Fl">-x</code>
783 a701a2ae 2022-06-17 stsp <var class="Ar">commit</var>] [<var class="Ar">path</var>]</dt>
784 8797b228 2019-08-04 stsp <dd>Display history of a repository. If a <var class="Ar">path</var> is
785 7c3b4ab8 2020-02-25 stsp specified, show only commits which modified this path. If invoked in a
786 7c3b4ab8 2020-02-25 stsp work tree, the <var class="Ar">path</var> is interpreted relative to the
787 7c3b4ab8 2020-02-25 stsp current working directory, and the work tree's path prefix is implicitly
788 7c3b4ab8 2020-02-25 stsp prepended. Otherwise, the path is interpreted relative to the repository
789 7c3b4ab8 2020-02-25 stsp root.
790 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got log</code> are as
791 8797b228 2019-08-04 stsp follows:</p>
792 8797b228 2019-08-04 stsp <dl class="Bl-tag">
793 56f3f26e 2024-06-03 stsp <dt id="b~7"><a class="permalink" href="#b~7"><code class="Fl">-b</code></a></dt>
794 8b679b4b 2020-02-17 stsp <dd>Display individual commits which were merged into the current branch
795 8b679b4b 2020-02-17 stsp from other branches. By default, <code class="Cm">got log</code> shows
796 8b679b4b 2020-02-17 stsp the linear history of the current branch only.</dd>
797 63657f42 2022-09-07 stsp <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a>
798 63657f42 2022-09-07 stsp <var class="Ar">number</var></dt>
799 63657f42 2022-09-07 stsp <dd>Set the number of context lines shown in diffs with
800 63657f42 2022-09-07 stsp <code class="Fl">-p</code>. By default, 3 lines of context are
801 63657f42 2022-09-07 stsp shown.</dd>
802 2dbbbc3a 2020-07-23 stsp <dt id="c~3"><a class="permalink" href="#c~3"><code class="Fl">-c</code></a>
803 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
804 8797b228 2019-08-04 stsp <dd>Start traversing history at the specified
805 461d9094 2023-07-19 stsp <var class="Ar">commit</var>. If this option is not specified, default
806 461d9094 2023-07-19 stsp to the work tree's current branch if invoked in a work tree, or to the
807 461d9094 2023-07-19 stsp repository's HEAD reference.
808 461d9094 2023-07-19 stsp <p class="Pp" id="bar:+3">The expected <var class="Ar">commit</var>
809 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
810 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
811 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
812 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
813 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the work tree's base commit and branch
814 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
815 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
816 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
817 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and references may be
818 461d9094 2023-07-19 stsp appended with &quot;:+&quot; or &quot;:-&quot; modifiers and an
819 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent,
820 461d9094 2023-07-19 stsp respectively, by first parent traversal; for example,
821 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
822 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
823 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
824 461d9094 2023-07-19 stsp <a class="permalink" href="#bar:+3"><b class="Sy">bar:+3</b></a>
825 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
826 461d9094 2023-07-19 stsp the &quot;bar&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
827 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
828 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
829 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
830 461d9094 2023-07-19 stsp </dd>
831 47f19dd5 2023-01-17 stsp <dt id="d~2"><a class="permalink" href="#d~2"><code class="Fl">-d</code></a></dt>
832 47f19dd5 2023-01-17 stsp <dd>Display diffstat of changes introduced in each commit. Cannot be used
833 a8f7f066 2023-08-29 stsp with the <code class="Fl">-s</code> option. Implies the
834 a8f7f066 2023-08-29 stsp <code class="Fl">-P</code> option (diffstat displays a list of changed
835 a8f7f066 2023-08-29 stsp paths).</dd>
836 2dbbbc3a 2020-07-23 stsp <dt id="l~3"><a class="permalink" href="#l~3"><code class="Fl">-l</code></a>
837 8797b228 2019-08-04 stsp <var class="Ar">N</var></dt>
838 91b3da3f 2019-08-18 stsp <dd>Limit history traversal to a given number of commits. If this option
839 91b3da3f 2019-08-18 stsp is not specified, a default limit value of zero is used, which is
840 91b3da3f 2019-08-18 stsp treated as an unbounded limit. The
841 91b3da3f 2019-08-18 stsp <code class="Ev">GOT_LOG_DEFAULT_LIMIT</code> environment variable may
842 91b3da3f 2019-08-18 stsp be set to change this default value.</dd>
843 2dbbbc3a 2020-07-23 stsp <dt id="P"><a class="permalink" href="#P"><code class="Fl">-P</code></a></dt>
844 ec51d4a3 2020-05-05 stsp <dd>Display the list of file paths changed in each commit, using the
845 ec51d4a3 2020-05-05 stsp following status codes:
846 ec51d4a3 2020-05-05 stsp <table class="Bl-column">
847 ec51d4a3 2020-05-05 stsp <tr>
848 ec51d4a3 2020-05-05 stsp <td>M</td>
849 ec51d4a3 2020-05-05 stsp <td>modified file</td>
850 ec51d4a3 2020-05-05 stsp </tr>
851 ec51d4a3 2020-05-05 stsp <tr>
852 ec51d4a3 2020-05-05 stsp <td>D</td>
853 ec51d4a3 2020-05-05 stsp <td>file was deleted</td>
854 ec51d4a3 2020-05-05 stsp </tr>
855 ec51d4a3 2020-05-05 stsp <tr>
856 ec51d4a3 2020-05-05 stsp <td>A</td>
857 ec51d4a3 2020-05-05 stsp <td>new file was added</td>
858 ec51d4a3 2020-05-05 stsp </tr>
859 ec51d4a3 2020-05-05 stsp <tr>
860 ec51d4a3 2020-05-05 stsp <td>m</td>
861 ec51d4a3 2020-05-05 stsp <td>modified file modes (executable bit only)</td>
862 ec51d4a3 2020-05-05 stsp </tr>
863 ec51d4a3 2020-05-05 stsp </table>
864 a701a2ae 2022-06-17 stsp <p class="Pp">Cannot be used with the <code class="Fl">-s</code>
865 a701a2ae 2022-06-17 stsp option.</p>
866 ec51d4a3 2020-05-05 stsp </dd>
867 63657f42 2022-09-07 stsp <dt id="p~2"><a class="permalink" href="#p~2"><code class="Fl">-p</code></a></dt>
868 63657f42 2022-09-07 stsp <dd>Display the patch of modifications made in each commit. If a
869 63657f42 2022-09-07 stsp <var class="Ar">path</var> is specified, only show the patch of
870 63657f42 2022-09-07 stsp modifications at or within this path. Cannot be used with the
871 63657f42 2022-09-07 stsp <code class="Fl">-s</code> option.</dd>
872 63657f42 2022-09-07 stsp <dt id="R~3"><a class="permalink" href="#R~3"><code class="Fl">-R</code></a></dt>
873 63657f42 2022-09-07 stsp <dd>Determine a set of commits to display as usual, but display these
874 63657f42 2022-09-07 stsp commits in reverse order.</dd>
875 63657f42 2022-09-07 stsp <dt id="r~3"><a class="permalink" href="#r~3"><code class="Fl">-r</code></a>
876 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
877 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
878 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
879 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
880 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
881 a701a2ae 2022-06-17 stsp <dt id="S~2"><a class="permalink" href="#S~2"><code class="Fl">-S</code></a>
882 8b679b4b 2020-02-17 stsp <var class="Ar">search-pattern</var></dt>
883 a701a2ae 2022-06-17 stsp <dd>If specified, show only commits with a log message, author name,
884 a701a2ae 2022-06-17 stsp committer name, or ID SHA1 hash matched by the extended regular
885 a701a2ae 2022-06-17 stsp expression <var class="Ar">search-pattern</var>. Lines in committed
886 a701a2ae 2022-06-17 stsp patches will be matched if <code class="Fl">-p</code> is specified.
887 a701a2ae 2022-06-17 stsp File paths changed by a commit will be matched if
888 a701a2ae 2022-06-17 stsp <code class="Fl">-P</code> is specified. Regular expression syntax is
889 376d4d52 2022-07-04 stsp documented in <a class="Xr" aria-label="re_format, section
890 376d4d52 2022-07-04 stsp 7">re_format(7)</a>.</dd>
891 63657f42 2022-09-07 stsp <dt id="s~2"><a class="permalink" href="#s~2"><code class="Fl">-s</code></a></dt>
892 63657f42 2022-09-07 stsp <dd>Display a short one-line summary of each commit, instead of the
893 63657f42 2022-09-07 stsp default history format. Cannot be used together with the
894 63657f42 2022-09-07 stsp <code class="Fl">-p</code> or <code class="Fl">-P</code> option.</dd>
895 bd0bf387 2024-04-23 stsp <dt id="t~2"><a class="permalink" href="#t~2"><code class="Fl">-t</code></a></dt>
896 bd0bf387 2024-04-23 stsp <dd>Display commits in topological order. This option has no effect
897 bd0bf387 2024-04-23 stsp without the <code class="Fl">-b</code> option because a linear history
898 bd0bf387 2024-04-23 stsp is sorted in topological order by definition. Topological sorting is
899 bd0bf387 2024-04-23 stsp disabled by default because the present implementation requires that
900 bd0bf387 2024-04-23 stsp commit history is fully traversed before any output can be shown.</dd>
901 2dbbbc3a 2020-07-23 stsp <dt id="x"><a class="permalink" href="#x"><code class="Fl">-x</code></a>
902 a462773e 2020-04-19 stsp <var class="Ar">commit</var></dt>
903 039953c9 2021-03-22 stsp <dd>Stop traversing commit history immediately after the specified
904 a8f7f066 2023-08-29 stsp <var class="Ar">commit</var> has been traversed. Like
905 a8f7f066 2023-08-29 stsp <code class="Fl">-c</code>, the expected <var class="Ar">commit</var>
906 a8f7f066 2023-08-29 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
907 a8f7f066 2023-08-29 stsp which will be resolved to a commit ID. This option has no effect if
908 a8f7f066 2023-08-29 stsp the specified <var class="Ar">commit</var> is never traversed.</dd>
909 8797b228 2019-08-04 stsp </dl>
910 8797b228 2019-08-04 stsp </dd>
911 63b69821 2021-10-16 stsp <dt id="di"><a class="permalink" href="#diff"><code class="Cm" id="diff">diff</code></a>
912 47f19dd5 2023-01-17 stsp [<code class="Fl">-adPsw</code>] [<code class="Fl">-C</code>
913 63657f42 2022-09-07 stsp <var class="Ar">number</var>] [<code class="Fl">-c</code>
914 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-r</code>
915 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">object1</var>
916 63657f42 2022-09-07 stsp <var class="Ar">object2</var> | <var class="Ar">path ...</var>]</dt>
917 63b69821 2021-10-16 stsp <dd>
918 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
919 46043f6f 2021-11-23 stsp <code class="Cm">di</code>)</code></div>
920 46043f6f 2021-11-23 stsp When invoked within a work tree without any arguments, display all local
921 63b69821 2021-10-16 stsp changes in the work tree. If one or more <var class="Ar">path</var>
922 63b69821 2021-10-16 stsp arguments are specified, only show changes within the specified paths.
923 8797b228 2019-08-04 stsp <p class="Pp">If two arguments are provided, treat each argument as a
924 7fe2a942 2019-08-11 stsp reference, a tag name, or an object ID SHA1 hash, and display
925 7fe2a942 2019-08-11 stsp differences between the corresponding objects. Both objects must be of
926 7fe2a942 2019-08-11 stsp the same type (blobs, trees, or commits). An abbreviated hash argument
927 7fe2a942 2019-08-11 stsp will be expanded to a full SHA1 hash automatically, provided the
928 63b69821 2021-10-16 stsp abbreviation is unique. If none of these interpretations produce a valid
929 63b69821 2021-10-16 stsp result or if the <code class="Fl">-P</code> option is used, and if
930 63b69821 2021-10-16 stsp <code class="Cm">got diff</code> is running in a work tree, attempt to
931 63b69821 2021-10-16 stsp interpret the two arguments as paths.</p>
932 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got diff</code> are as
933 8797b228 2019-08-04 stsp follows:</p>
934 8797b228 2019-08-04 stsp <dl class="Bl-tag">
935 1b792db0 2020-12-13 stsp <dt id="a~3"><a class="permalink" href="#a~3"><code class="Fl">-a</code></a></dt>
936 1b792db0 2020-12-13 stsp <dd>Treat file contents as ASCII text even if binary data is
937 1b792db0 2020-12-13 stsp detected.</dd>
938 63657f42 2022-09-07 stsp <dt id="C~2"><a class="permalink" href="#C~2"><code class="Fl">-C</code></a>
939 63657f42 2022-09-07 stsp <var class="Ar">number</var></dt>
940 63657f42 2022-09-07 stsp <dd>Set the number of context lines shown in the diff. By default, 3 lines
941 63657f42 2022-09-07 stsp of context are shown.</dd>
942 63b69821 2021-10-16 stsp <dt id="c~4"><a class="permalink" href="#c~4"><code class="Fl">-c</code></a>
943 63b69821 2021-10-16 stsp <var class="Ar">commit</var></dt>
944 63657f42 2022-09-07 stsp <dd>Show differences between commits in the repository. This option may be
945 63657f42 2022-09-07 stsp used up to two times. When used only once, show differences between
946 63b69821 2021-10-16 stsp the specified <var class="Ar">commit</var> and its first parent
947 63b69821 2021-10-16 stsp commit. When used twice, show differences between the two specified
948 63b69821 2021-10-16 stsp commits.
949 63b69821 2021-10-16 stsp <p class="Pp">If the <code class="Fl">-c</code> option is used, all
950 63b69821 2021-10-16 stsp non-option arguments will be interpreted as paths. If one or more
951 63b69821 2021-10-16 stsp such <var class="Ar">path</var> arguments are provided, only show
952 63b69821 2021-10-16 stsp differences for the specified paths.</p>
953 461d9094 2023-07-19 stsp <p class="Pp" id="baz:+8">The expected <var class="Ar">commit</var>
954 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
955 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
956 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
957 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
958 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the work tree's base commit and branch
959 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
960 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
961 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
962 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and references may be
963 461d9094 2023-07-19 stsp appended with &quot;:+&quot; or &quot;:-&quot; modifiers and an
964 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent,
965 461d9094 2023-07-19 stsp respectively, by first parent traversal; for example,
966 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
967 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
968 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
969 461d9094 2023-07-19 stsp <a class="permalink" href="#baz:+8"><b class="Sy">baz:+8</b></a>
970 461d9094 2023-07-19 stsp will denote the 8th generation descendant of the commit resolved by
971 461d9094 2023-07-19 stsp the &quot;baz&quot; reference. If an integer does not follow the
972 461d9094 2023-07-19 stsp &quot;:+&quot; or &quot;:-&quot; modifier, a &quot;1&quot; is
973 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
974 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
975 63b69821 2021-10-16 stsp <p class="Pp">Cannot be used together with the
976 63b69821 2021-10-16 stsp <code class="Fl">-P</code> option.</p>
977 63b69821 2021-10-16 stsp </dd>
978 47f19dd5 2023-01-17 stsp <dt id="d~3"><a class="permalink" href="#d~3"><code class="Fl">-d</code></a></dt>
979 47f19dd5 2023-01-17 stsp <dd>Display diffstat of changes before the actual diff by annotating each
980 47f19dd5 2023-01-17 stsp file path or blob hash being diffed with the total number of lines
981 47f19dd5 2023-01-17 stsp added and removed. A summary line will display the total number of
982 47f19dd5 2023-01-17 stsp changes across all files.</dd>
983 63657f42 2022-09-07 stsp <dt id="P~2"><a class="permalink" href="#P~2"><code class="Fl">-P</code></a></dt>
984 63657f42 2022-09-07 stsp <dd>Interpret all arguments as paths only. This option can be used to
985 63657f42 2022-09-07 stsp resolve ambiguity in cases where paths look like tag names, reference
986 63657f42 2022-09-07 stsp names, or object IDs. This option is only valid when
987 63657f42 2022-09-07 stsp <code class="Cm">got diff</code> is invoked in a work tree.</dd>
988 2dbbbc3a 2020-07-23 stsp <dt id="r~4"><a class="permalink" href="#r~4"><code class="Fl">-r</code></a>
989 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
990 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
991 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
992 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
993 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
994 feee6923 2020-09-17 stsp <dt id="s~3"><a class="permalink" href="#s~3"><code class="Fl">-s</code></a></dt>
995 8797b228 2019-08-04 stsp <dd>Show changes staged with <code class="Cm">got stage</code> instead of
996 a462773e 2020-04-19 stsp showing local changes in the work tree. This option is only valid when
997 8797b228 2019-08-04 stsp <code class="Cm">got diff</code> is invoked in a work tree.</dd>
998 2dbbbc3a 2020-07-23 stsp <dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a></dt>
999 d8e62599 2019-10-21 stsp <dd>Ignore whitespace-only changes.</dd>
1000 8797b228 2019-08-04 stsp </dl>
1001 8797b228 2019-08-04 stsp </dd>
1002 63b69821 2021-10-16 stsp <dt id="bl"><a class="permalink" href="#blame"><code class="Cm" id="blame">blame</code></a>
1003 8797b228 2019-08-04 stsp [<code class="Fl">-c</code> <var class="Ar">commit</var>]
1004 8797b228 2019-08-04 stsp [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
1005 8797b228 2019-08-04 stsp <var class="Ar">path</var></dt>
1006 63b69821 2021-10-16 stsp <dd>
1007 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1008 46043f6f 2021-11-23 stsp <code class="Cm">bl</code>)</code></div>
1009 46043f6f 2021-11-23 stsp Display line-by-line history of a file at the specified path.
1010 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got blame</code> are as
1011 8797b228 2019-08-04 stsp follows:</p>
1012 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1013 63b69821 2021-10-16 stsp <dt id="c~5"><a class="permalink" href="#c~5"><code class="Fl">-c</code></a>
1014 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
1015 8797b228 2019-08-04 stsp <dd>Start traversing history at the specified
1016 8797b228 2019-08-04 stsp <var class="Ar">commit</var>. The expected argument is a commit ID
1017 461d9094 2023-07-19 stsp SHA1 hash, or a reference name or a keyword which will be resolved to
1018 461d9094 2023-07-19 stsp a commit ID. An abbreviated hash argument will be expanded to a full
1019 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
1020 461d9094 2023-07-19 stsp keywords &quot;:base&quot; and &quot;:head&quot; resolve to the work
1021 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
1022 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to the
1023 461d9094 2023-07-19 stsp tip of the work tree's current branch if invoked in a work tree,
1024 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference. Keywords
1025 461d9094 2023-07-19 stsp and references may be appended with &quot;:+&quot; or &quot;:-&quot;
1026 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
1027 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
1028 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1029 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1030 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
1031 461d9094 2023-07-19 stsp <a class="permalink" href="#xyz:-5"><b class="Sy" id="xyz:-5">xyz:-5</b></a>
1032 461d9094 2023-07-19 stsp will denote the 5th generation ancestor of the commit resolved by the
1033 461d9094 2023-07-19 stsp &quot;xyz&quot; reference. A &quot;:+&quot; or &quot;:-&quot; modifier
1034 461d9094 2023-07-19 stsp without a trailing integer has an implicit &quot;1&quot; appended
1035 461d9094 2023-07-19 stsp (e.g., <b class="Sy">:base:+</b> is equivalent to
1036 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
1037 2dbbbc3a 2020-07-23 stsp <dt id="r~5"><a class="permalink" href="#r~5"><code class="Fl">-r</code></a>
1038 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
1039 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
1040 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
1041 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
1042 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
1043 8797b228 2019-08-04 stsp </dl>
1044 8797b228 2019-08-04 stsp </dd>
1045 63b69821 2021-10-16 stsp <dt id="tr"><a class="permalink" href="#tree"><code class="Cm" id="tree">tree</code></a>
1046 63657f42 2022-09-07 stsp [<code class="Fl">-iR</code>] [<code class="Fl">-c</code>
1047 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-r</code>
1048 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">path</var>]</dt>
1049 63b69821 2021-10-16 stsp <dd>
1050 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1051 46043f6f 2021-11-23 stsp <code class="Cm">tr</code>)</code></div>
1052 46043f6f 2021-11-23 stsp Display a listing of files and directories at the specified directory path
1053 8797b228 2019-08-04 stsp in the repository. Entries shown in this listing may carry one of the
1054 8797b228 2019-08-04 stsp following trailing annotations:
1055 8797b228 2019-08-04 stsp <table class="Bl-column">
1056 e8022e04 2019-08-13 stsp <tr>
1057 e8022e04 2019-08-13 stsp <td>@</td>
1058 e8022e04 2019-08-13 stsp <td>entry is a symbolic link</td>
1059 e8022e04 2019-08-13 stsp </tr>
1060 8797b228 2019-08-04 stsp <tr>
1061 8797b228 2019-08-04 stsp <td>/</td>
1062 8797b228 2019-08-04 stsp <td>entry is a directory</td>
1063 8797b228 2019-08-04 stsp </tr>
1064 8797b228 2019-08-04 stsp <tr>
1065 8797b228 2019-08-04 stsp <td>*</td>
1066 8797b228 2019-08-04 stsp <td>entry is an executable file</td>
1067 8797b228 2019-08-04 stsp </tr>
1068 ba0a4168 2019-08-26 stsp <tr>
1069 ba0a4168 2019-08-26 stsp <td>$</td>
1070 ba0a4168 2019-08-26 stsp <td>entry is a Git submodule</td>
1071 ba0a4168 2019-08-26 stsp </tr>
1072 8797b228 2019-08-04 stsp </table>
1073 2dbbbc3a 2020-07-23 stsp <p class="Pp">Symbolic link entries are also annotated with the target path
1074 2dbbbc3a 2020-07-23 stsp of the link.</p>
1075 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, list the
1076 8797b228 2019-08-04 stsp repository path corresponding to the current directory of the work tree,
1077 8797b228 2019-08-04 stsp or the root directory of the repository if there is no work tree.</p>
1078 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got tree</code> are as
1079 8797b228 2019-08-04 stsp follows:</p>
1080 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1081 63b69821 2021-10-16 stsp <dt id="c~6"><a class="permalink" href="#c~6"><code class="Fl">-c</code></a>
1082 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
1083 8797b228 2019-08-04 stsp <dd>List files and directories as they appear in the specified
1084 461d9094 2023-07-19 stsp <var class="Ar">commit</var>.
1085 461d9094 2023-07-19 stsp <p class="Pp" id="spam:-3">The expected argument is a commit ID SHA1
1086 461d9094 2023-07-19 stsp hash, or a reference name or a keyword which will be resolved to a
1087 461d9094 2023-07-19 stsp commit ID. An abbreviated hash argument will be expanded to a full
1088 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
1089 461d9094 2023-07-19 stsp keywords &quot;:base&quot; and &quot;:head&quot; resolve to the work
1090 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
1091 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to
1092 461d9094 2023-07-19 stsp the tip of the work tree's current branch if invoked in a work tree,
1093 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference.
1094 461d9094 2023-07-19 stsp Keywords and references may be appended with &quot;:+&quot; or
1095 461d9094 2023-07-19 stsp &quot;:-&quot; modifiers and an optional integer N to denote the Nth
1096 461d9094 2023-07-19 stsp descendant or antecedent by first parent traversal, respectively;
1097 461d9094 2023-07-19 stsp for example, <b class="Sy">:head:-2</b> denotes the work tree branch
1098 461d9094 2023-07-19 stsp head's 2nd generation ancestor, and <b class="Sy">:base:+4</b>
1099 461d9094 2023-07-19 stsp denotes the 4th generation descendant of the work tree's base
1100 461d9094 2023-07-19 stsp commit. Similarly,
1101 461d9094 2023-07-19 stsp <a class="permalink" href="#spam:-3"><b class="Sy">spam:-3</b></a>
1102 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
1103 461d9094 2023-07-19 stsp the &quot;spam&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
1104 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
1105 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1106 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1107 461d9094 2023-07-19 stsp </dd>
1108 63657f42 2022-09-07 stsp <dt id="i"><a class="permalink" href="#i"><code class="Fl">-i</code></a></dt>
1109 63657f42 2022-09-07 stsp <dd>Show object IDs of files (blob objects) and directories (tree
1110 63657f42 2022-09-07 stsp objects).</dd>
1111 63657f42 2022-09-07 stsp <dt id="R~4"><a class="permalink" href="#R~4"><code class="Fl">-R</code></a></dt>
1112 63657f42 2022-09-07 stsp <dd>Recurse into sub-directories in the repository.</dd>
1113 2dbbbc3a 2020-07-23 stsp <dt id="r~6"><a class="permalink" href="#r~6"><code class="Fl">-r</code></a>
1114 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
1115 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
1116 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
1117 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
1118 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
1119 8797b228 2019-08-04 stsp </dl>
1120 8797b228 2019-08-04 stsp </dd>
1121 2dbbbc3a 2020-07-23 stsp <dt id="ref"><a class="permalink" href="#ref"><code class="Cm">ref</code></a>
1122 63657f42 2022-09-07 stsp [<code class="Fl">-dlt</code>] [<code class="Fl">-c</code>
1123 63657f42 2022-09-07 stsp <var class="Ar">object</var>] [<code class="Fl">-r</code>
1124 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1125 63657f42 2022-09-07 stsp <var class="Ar">reference</var>] [<var class="Ar">name</var>]</dt>
1126 8797b228 2019-08-04 stsp <dd>Manage references in a repository.
1127 b213cbf7 2020-03-23 stsp <p class="Pp">References may be listed, created, deleted, and changed. When
1128 b213cbf7 2020-03-23 stsp creating, deleting, or changing a reference the specified
1129 b213cbf7 2020-03-23 stsp <var class="Ar">name</var> must be an absolute reference name, i.e. it
1130 b213cbf7 2020-03-23 stsp must begin with &#x201C;refs/&#x201D;.</p>
1131 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got ref</code> are as
1132 8797b228 2019-08-04 stsp follows:</p>
1133 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1134 63b69821 2021-10-16 stsp <dt id="c~7"><a class="permalink" href="#c~7"><code class="Fl">-c</code></a>
1135 b213cbf7 2020-03-23 stsp <var class="Ar">object</var></dt>
1136 b213cbf7 2020-03-23 stsp <dd>Create a reference or change an existing reference. The reference with
1137 b213cbf7 2020-03-23 stsp the specified <var class="Ar">name</var> will point at the specified
1138 461d9094 2023-07-19 stsp <var class="Ar">object</var>.
1139 461d9094 2023-07-19 stsp <p class="Pp" id="tagged:-3">The expected <var class="Ar">object</var>
1140 461d9094 2023-07-19 stsp argument is an ID SHA1 hash or an existing reference or tag name or
1141 461d9094 2023-07-19 stsp a keyword which will be resolved to the ID of a corresponding
1142 461d9094 2023-07-19 stsp commit, tree, tag, or blob object. An abbreviated hash argument will
1143 461d9094 2023-07-19 stsp be expanded to a full SHA1 hash automatically, provided the
1144 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
1145 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the work tree's base commit and branch
1146 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
1147 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
1148 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
1149 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and reference names may
1150 461d9094 2023-07-19 stsp be appended with &quot;:+&quot; or &quot;:-&quot; modifiers and an
1151 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent by
1152 461d9094 2023-07-19 stsp first parent traversal, respectively; for example,
1153 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1154 461d9094 2023-07-19 stsp generation ancestor, and
1155 461d9094 2023-07-19 stsp <a class="permalink" href="#tagged:-3"><b class="Sy">tagged:-3</b></a>
1156 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
1157 461d9094 2023-07-19 stsp the &quot;tagged&quot; reference. If an integer does not follow the
1158 461d9094 2023-07-19 stsp &quot;:+&quot; or &quot;:-&quot; modifier, a &quot;1&quot; is
1159 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
1160 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
1161 461d9094 2023-07-19 stsp <p class="Pp">Cannot be used together with any other options except
1162 461d9094 2023-07-19 stsp <code class="Fl">-r</code>.</p>
1163 461d9094 2023-07-19 stsp </dd>
1164 47f19dd5 2023-01-17 stsp <dt id="d~4"><a class="permalink" href="#d~4"><code class="Fl">-d</code></a></dt>
1165 63657f42 2022-09-07 stsp <dd>Delete the reference with the specified <var class="Ar">name</var>
1166 63657f42 2022-09-07 stsp from the repository. Any commit, tree, tag, and blob objects belonging
1167 63657f42 2022-09-07 stsp to deleted references remain in the repository and may be removed
1168 63657f42 2022-09-07 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
1169 63657f42 2022-09-07 stsp cleanup</code>. Cannot be used together with any other options except
1170 63657f42 2022-09-07 stsp <code class="Fl">-r</code>.</dd>
1171 63657f42 2022-09-07 stsp <dt id="l~4"><a class="permalink" href="#l~4"><code class="Fl">-l</code></a></dt>
1172 63657f42 2022-09-07 stsp <dd>List references in the repository. If no <var class="Ar">name</var> is
1173 63657f42 2022-09-07 stsp specified, list all existing references in the repository. If
1174 63657f42 2022-09-07 stsp <var class="Ar">name</var> is a reference namespace, list all
1175 63657f42 2022-09-07 stsp references in this namespace. Otherwise, show only the reference with
1176 63657f42 2022-09-07 stsp the given <var class="Ar">name</var>. Cannot be used together with any
1177 63657f42 2022-09-07 stsp other options except <code class="Fl">-r</code> and
1178 63657f42 2022-09-07 stsp <code class="Fl">-t</code>.</dd>
1179 63657f42 2022-09-07 stsp <dt id="r~7"><a class="permalink" href="#r~7"><code class="Fl">-r</code></a>
1180 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
1181 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
1182 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
1183 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
1184 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
1185 feee6923 2020-09-17 stsp <dt id="s~4"><a class="permalink" href="#s~4"><code class="Fl">-s</code></a>
1186 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
1187 b213cbf7 2020-03-23 stsp <dd>Create a symbolic reference, or change an existing symbolic reference.
1188 b213cbf7 2020-03-23 stsp The symbolic reference with the specified <var class="Ar">name</var>
1189 b213cbf7 2020-03-23 stsp will point at the specified <var class="Ar">reference</var> which must
1190 b213cbf7 2020-03-23 stsp already exist in the repository. Care should be taken not to create
1191 b213cbf7 2020-03-23 stsp loops between references when this option is used. Cannot be used
1192 b213cbf7 2020-03-23 stsp together with any other options except
1193 b213cbf7 2020-03-23 stsp <code class="Fl">-r</code>.</dd>
1194 bd0bf387 2024-04-23 stsp <dt id="t~3"><a class="permalink" href="#t~3"><code class="Fl">-t</code></a></dt>
1195 63657f42 2022-09-07 stsp <dd>Sort listed references by modification time (most recently modified
1196 63657f42 2022-09-07 stsp first) instead of sorting by lexicographical order. Use of this option
1197 63657f42 2022-09-07 stsp requires the <code class="Fl">-l</code> option to be used as
1198 63657f42 2022-09-07 stsp well.</dd>
1199 8797b228 2019-08-04 stsp </dl>
1200 8797b228 2019-08-04 stsp </dd>
1201 63b69821 2021-10-16 stsp <dt id="br"><a class="permalink" href="#branch"><code class="Cm" id="branch">branch</code></a>
1202 63657f42 2022-09-07 stsp [<code class="Fl">-lnt</code>] [<code class="Fl">-c</code>
1203 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-d</code>
1204 63657f42 2022-09-07 stsp <var class="Ar">name</var>] [<code class="Fl">-r</code>
1205 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">name</var>]</dt>
1206 63b69821 2021-10-16 stsp <dd>
1207 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1208 46043f6f 2021-11-23 stsp <code class="Cm">br</code>)</code></div>
1209 46043f6f 2021-11-23 stsp Create, list, or delete branches.
1210 039953c9 2021-03-22 stsp <p class="Pp">Local branches are managed via references which live in the
1211 8797b228 2019-08-04 stsp &#x201C;refs/heads/&#x201D; reference namespace. The
1212 def5be4a 2021-08-31 stsp <code class="Cm">got branch</code> command creates references in this
1213 def5be4a 2021-08-31 stsp namespace only.</p>
1214 b078d5c4 2022-03-23 stsp <p class="Pp">When deleting branches, the specified
1215 def5be4a 2021-08-31 stsp <var class="Ar">name</var> is searched in the &#x201C;refs/heads&#x201D;
1216 b078d5c4 2022-03-23 stsp reference namespace first. If no corresponding branch is found, the
1217 def5be4a 2021-08-31 stsp &#x201C;refs/remotes&#x201D; namespace will be searched next.</p>
1218 2b499410 2019-10-06 stsp <p class="Pp">If invoked in a work tree without any arguments, print the
1219 7c3b4ab8 2020-02-25 stsp name of the work tree's current branch.</p>
1220 7c3b4ab8 2020-02-25 stsp <p class="Pp">If a <var class="Ar">name</var> argument is passed, attempt to
1221 7c3b4ab8 2020-02-25 stsp create a branch reference with the given name. By default the new branch
1222 7c3b4ab8 2020-02-25 stsp reference will point at the latest commit on the work tree's current
1223 7c3b4ab8 2020-02-25 stsp branch if invoked in a work tree, and otherwise to a commit resolved via
1224 7c3b4ab8 2020-02-25 stsp the repository's HEAD reference.</p>
1225 7c3b4ab8 2020-02-25 stsp <p class="Pp">If invoked in a work tree, once the branch was created
1226 7c3b4ab8 2020-02-25 stsp successfully switch the work tree's head reference to the newly created
1227 7c3b4ab8 2020-02-25 stsp branch and update files across the entire work tree, just like
1228 7c3b4ab8 2020-02-25 stsp <code class="Cm">got update -b</code> <var class="Ar">name</var> would
1229 7c3b4ab8 2020-02-25 stsp do. Show the status of each affected file, using the following status
1230 7c3b4ab8 2020-02-25 stsp codes:</p>
1231 7c3b4ab8 2020-02-25 stsp <table class="Bl-column">
1232 7c3b4ab8 2020-02-25 stsp <tr>
1233 7c3b4ab8 2020-02-25 stsp <td>U</td>
1234 7c3b4ab8 2020-02-25 stsp <td>file was updated and contained no local changes</td>
1235 7c3b4ab8 2020-02-25 stsp </tr>
1236 7c3b4ab8 2020-02-25 stsp <tr>
1237 7c3b4ab8 2020-02-25 stsp <td>G</td>
1238 7c3b4ab8 2020-02-25 stsp <td>file was updated and local changes were merged cleanly</td>
1239 7c3b4ab8 2020-02-25 stsp </tr>
1240 7c3b4ab8 2020-02-25 stsp <tr>
1241 7c3b4ab8 2020-02-25 stsp <td>C</td>
1242 7c3b4ab8 2020-02-25 stsp <td>file was updated and conflicts occurred during merge</td>
1243 7c3b4ab8 2020-02-25 stsp </tr>
1244 7c3b4ab8 2020-02-25 stsp <tr>
1245 7c3b4ab8 2020-02-25 stsp <td>D</td>
1246 7c3b4ab8 2020-02-25 stsp <td>file was deleted</td>
1247 7c3b4ab8 2020-02-25 stsp </tr>
1248 7c3b4ab8 2020-02-25 stsp <tr>
1249 7c3b4ab8 2020-02-25 stsp <td>A</td>
1250 7c3b4ab8 2020-02-25 stsp <td>new file was added</td>
1251 7c3b4ab8 2020-02-25 stsp </tr>
1252 7c3b4ab8 2020-02-25 stsp <tr>
1253 7c3b4ab8 2020-02-25 stsp <td>~</td>
1254 7c3b4ab8 2020-02-25 stsp <td>versioned file is obstructed by a non-regular file</td>
1255 7c3b4ab8 2020-02-25 stsp </tr>
1256 7c3b4ab8 2020-02-25 stsp <tr>
1257 7c3b4ab8 2020-02-25 stsp <td>!</td>
1258 7c3b4ab8 2020-02-25 stsp <td>a missing versioned file was restored</td>
1259 7c3b4ab8 2020-02-25 stsp </tr>
1260 7c3b4ab8 2020-02-25 stsp </table>
1261 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got branch</code> are as
1262 8797b228 2019-08-04 stsp follows:</p>
1263 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1264 63b69821 2021-10-16 stsp <dt id="c~8"><a class="permalink" href="#c~8"><code class="Fl">-c</code></a>
1265 cc85973b 2019-11-27 stsp <var class="Ar">commit</var></dt>
1266 cc85973b 2019-11-27 stsp <dd>Make a newly created branch reference point at the specified
1267 461d9094 2023-07-19 stsp <var class="Ar">commit</var>. The expected argument is a commit ID
1268 461d9094 2023-07-19 stsp SHA1 hash, or a reference name or keyword which will be resolved to a
1269 461d9094 2023-07-19 stsp commit ID. An abbreviated hash argument will be expanded to a full
1270 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
1271 461d9094 2023-07-19 stsp keywords &quot;:base&quot; and &quot;:head&quot; resolve to the work
1272 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
1273 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to the
1274 461d9094 2023-07-19 stsp tip of the work tree's current branch if invoked in a work tree,
1275 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference. Keywords
1276 461d9094 2023-07-19 stsp and references may be appended with &quot;:+&quot; or &quot;:-&quot;
1277 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
1278 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
1279 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1280 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1281 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
1282 461d9094 2023-07-19 stsp <a class="permalink" href="#foobar:+3"><b class="Sy" id="foobar:+3">foobar:+3</b></a>
1283 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
1284 461d9094 2023-07-19 stsp the &quot;foobar&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
1285 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
1286 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1287 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
1288 47f19dd5 2023-01-17 stsp <dt id="d~5"><a class="permalink" href="#d~5"><code class="Fl">-d</code></a>
1289 63657f42 2022-09-07 stsp <var class="Ar">name</var></dt>
1290 63657f42 2022-09-07 stsp <dd>Delete the branch with the specified <var class="Ar">name</var> from
1291 63657f42 2022-09-07 stsp the &#x201C;refs/heads&#x201D; or &#x201C;refs/remotes&#x201D;
1292 63657f42 2022-09-07 stsp reference namespace.
1293 63657f42 2022-09-07 stsp <p class="Pp">Only the branch reference is deleted. Any commit, tree,
1294 63657f42 2022-09-07 stsp and blob objects belonging to the branch remain in the repository
1295 63657f42 2022-09-07 stsp and may be removed separately with Git's garbage collector or
1296 63657f42 2022-09-07 stsp <code class="Cm">gotadmin cleanup</code>.</p>
1297 63657f42 2022-09-07 stsp </dd>
1298 2dbbbc3a 2020-07-23 stsp <dt id="l~5"><a class="permalink" href="#l~5"><code class="Fl">-l</code></a></dt>
1299 039953c9 2021-03-22 stsp <dd>List all existing branches in the repository, including copies of
1300 039953c9 2021-03-22 stsp remote repositories' branches in the &#x201C;refs/remotes/&#x201D;
1301 039953c9 2021-03-22 stsp reference namespace.
1302 039953c9 2021-03-22 stsp <p class="Pp">If invoked in a work tree, the work tree's current branch
1303 461d9094 2023-07-19 stsp is shown with one of the following annotations:</p>
1304 8797b228 2019-08-04 stsp <table class="Bl-column">
1305 8797b228 2019-08-04 stsp <tr>
1306 8797b228 2019-08-04 stsp <td>*</td>
1307 a8f7f066 2023-08-29 stsp <td>work tree's base commit and the base commit of all tracked files
1308 a8f7f066 2023-08-29 stsp matches the branch tip</td>
1309 8797b228 2019-08-04 stsp </tr>
1310 8797b228 2019-08-04 stsp <tr>
1311 8797b228 2019-08-04 stsp <td>~</td>
1312 a8f7f066 2023-08-29 stsp <td>work tree comprises mixed commits or its base commit is
1313 a8f7f066 2023-08-29 stsp out-of-date</td>
1314 8797b228 2019-08-04 stsp </tr>
1315 8797b228 2019-08-04 stsp </table>
1316 8797b228 2019-08-04 stsp </dd>
1317 63657f42 2022-09-07 stsp <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
1318 63657f42 2022-09-07 stsp <dd>Do not switch and update the work tree after creating a new
1319 63657f42 2022-09-07 stsp branch.</dd>
1320 63657f42 2022-09-07 stsp <dt id="r~8"><a class="permalink" href="#r~8"><code class="Fl">-r</code></a>
1321 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
1322 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
1323 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
1324 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
1325 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
1326 bd0bf387 2024-04-23 stsp <dt id="t~4"><a class="permalink" href="#t~4"><code class="Fl">-t</code></a></dt>
1327 46043f6f 2021-11-23 stsp <dd>Sort listed branches by modification time (most recently modified
1328 46043f6f 2021-11-23 stsp first) instead of sorting by lexicographical order. Branches in the
1329 46043f6f 2021-11-23 stsp &#x201C;refs/heads/&#x201D; reference namespace are listed before
1330 46043f6f 2021-11-23 stsp branches in &#x201C;refs/remotes/&#x201D; regardless. Use of this
1331 46043f6f 2021-11-23 stsp option requires the <code class="Fl">-l</code> option to be used as
1332 46043f6f 2021-11-23 stsp well.</dd>
1333 8797b228 2019-08-04 stsp </dl>
1334 8797b228 2019-08-04 stsp </dd>
1335 2dbbbc3a 2020-07-23 stsp <dt id="tag"><a class="permalink" href="#tag"><code class="Cm">tag</code></a>
1336 63657f42 2022-09-07 stsp [<code class="Fl">-lVv</code>] [<code class="Fl">-c</code>
1337 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-m</code>
1338 63657f42 2022-09-07 stsp <var class="Ar">message</var>] [<code class="Fl">-r</code>
1339 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1340 63657f42 2022-09-07 stsp <var class="Ar">signer-id</var>] <var class="Ar">name</var></dt>
1341 f447d26b 2019-08-23 stsp <dd>Manage tags in a repository.
1342 f447d26b 2019-08-23 stsp <p class="Pp">Tags are managed via references which live in the
1343 f447d26b 2019-08-23 stsp &#x201C;refs/tags/&#x201D; reference namespace. The <code class="Cm">got
1344 f447d26b 2019-08-23 stsp tag</code> command operates on references in this namespace only.
1345 f447d26b 2019-08-23 stsp References in this namespace point at tag objects which contain a
1346 f447d26b 2019-08-23 stsp pointer to another object, a tag message, as well as author and
1347 f447d26b 2019-08-23 stsp timestamp information.</p>
1348 7c3b4ab8 2020-02-25 stsp <p class="Pp">Attempt to create a tag with the given
1349 7c3b4ab8 2020-02-25 stsp <var class="Ar">name</var>, and make this tag point at the given
1350 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var>. If no commit is specified, default to the
1351 7c3b4ab8 2020-02-25 stsp latest commit on the work tree's current branch if invoked in a work
1352 7c3b4ab8 2020-02-25 stsp tree, and to a commit resolved via the repository's HEAD reference
1353 7c3b4ab8 2020-02-25 stsp otherwise.</p>
1354 f447d26b 2019-08-23 stsp <p class="Pp">The options for <code class="Cm">got tag</code> are as
1355 f447d26b 2019-08-23 stsp follows:</p>
1356 f447d26b 2019-08-23 stsp <dl class="Bl-tag">
1357 63b69821 2021-10-16 stsp <dt id="c~9"><a class="permalink" href="#c~9"><code class="Fl">-c</code></a>
1358 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var></dt>
1359 7c3b4ab8 2020-02-25 stsp <dd>Make the newly created tag reference point at the specified
1360 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var>. The expected
1361 461d9094 2023-07-19 stsp <var class="Ar">commit</var> argument is a commit ID SHA1 hash, or a
1362 461d9094 2023-07-19 stsp reference or keyword which will be resolved to a commit ID. An
1363 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
1364 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
1365 461d9094 2023-07-19 stsp &quot;:base&quot; and &quot;:head&quot; resolve to the work tree's
1366 461d9094 2023-07-19 stsp base commit and branch head, respectively. The former is only valid if
1367 461d9094 2023-07-19 stsp invoked in a work tree, while the latter will resolve to the tip of
1368 461d9094 2023-07-19 stsp the work tree's current branch if invoked in a work tree, otherwise it
1369 461d9094 2023-07-19 stsp will resolve to the repository's HEAD reference. Keywords and
1370 461d9094 2023-07-19 stsp references may be appended with &quot;:+&quot; or &quot;:-&quot;
1371 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
1372 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
1373 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1374 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1375 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
1376 461d9094 2023-07-19 stsp <a class="permalink" href="#eggs:-3"><b class="Sy" id="eggs:-3">eggs:-3</b></a>
1377 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by the
1378 461d9094 2023-07-19 stsp &quot;eggs&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
1379 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
1380 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1381 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
1382 63657f42 2022-09-07 stsp <dt id="l~6"><a class="permalink" href="#l~6"><code class="Fl">-l</code></a></dt>
1383 63657f42 2022-09-07 stsp <dd>List all existing tags in the repository instead of creating a new
1384 63657f42 2022-09-07 stsp tag. If a <var class="Ar">name</var> argument is passed, show only the
1385 63657f42 2022-09-07 stsp tag with the given <var class="Ar">name</var>.</dd>
1386 2dbbbc3a 2020-07-23 stsp <dt id="m~3"><a class="permalink" href="#m~3"><code class="Fl">-m</code></a>
1387 f447d26b 2019-08-23 stsp <var class="Ar">message</var></dt>
1388 7c3b4ab8 2020-02-25 stsp <dd>Use the specified tag message when creating the new tag. Without the
1389 cc85973b 2019-11-27 stsp <code class="Fl">-m</code> option, <code class="Cm">got tag</code>
1390 f447d26b 2019-08-23 stsp opens a temporary file in an editor where a tag message can be
1391 461d9094 2023-07-19 stsp written. Quitting the editor without saving the file will abort the
1392 461d9094 2023-07-19 stsp tag operation.</dd>
1393 2dbbbc3a 2020-07-23 stsp <dt id="r~9"><a class="permalink" href="#r~9"><code class="Fl">-r</code></a>
1394 f447d26b 2019-08-23 stsp <var class="Ar">repository-path</var></dt>
1395 f447d26b 2019-08-23 stsp <dd>Use the repository at the specified path. If not specified, assume the
1396 f447d26b 2019-08-23 stsp repository is located at or above the current working directory. If
1397 f447d26b 2019-08-23 stsp this directory is a <code class="Nm">got</code> work tree, use the
1398 f447d26b 2019-08-23 stsp repository path associated with this work tree.</dd>
1399 376d4d52 2022-07-04 stsp <dt id="s~5"><a class="permalink" href="#s~5"><code class="Fl">-s</code></a>
1400 376d4d52 2022-07-04 stsp <var class="Ar">signer-id</var></dt>
1401 376d4d52 2022-07-04 stsp <dd>While creating a new tag, sign this tag with the identity given in
1402 376d4d52 2022-07-04 stsp <var class="Ar">signer-id</var>.
1403 376d4d52 2022-07-04 stsp <p class="Pp">For SSH-based signatures, <var class="Ar">signer-id</var>
1404 376d4d52 2022-07-04 stsp is the path to a file which may refer to either a private SSH key,
1405 376d4d52 2022-07-04 stsp or a public SSH key with the private half available via
1406 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh-agent, section 1">ssh-agent(1)</a>.
1407 376d4d52 2022-07-04 stsp <code class="Cm">got tag</code> will sign the tag object by invoking
1408 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh-keygen, section 1">ssh-keygen(1)</a>
1409 63657f42 2022-09-07 stsp with the <code class="Fl">-Y</code> <code class="Cm">sign</code>
1410 376d4d52 2022-07-04 stsp command, using the signature namespace &#x201C;git&#x201D; for
1411 376d4d52 2022-07-04 stsp compatibility with <a class="Xr" aria-label="git, section
1412 376d4d52 2022-07-04 stsp 1">git(1)</a>.</p>
1413 376d4d52 2022-07-04 stsp </dd>
1414 376d4d52 2022-07-04 stsp <dt id="V~2"><a class="permalink" href="#V~2"><code class="Fl">-V</code></a></dt>
1415 376d4d52 2022-07-04 stsp <dd>Verify tag object signatures. If a <var class="Ar">name</var> is
1416 376d4d52 2022-07-04 stsp specified, show and verify the tag object with the provided name.
1417 376d4d52 2022-07-04 stsp Otherwise, list all tag objects and verify signatures where present.
1418 376d4d52 2022-07-04 stsp <p class="Pp"><code class="Cm">got tag</code> verifies SSH-based
1419 376d4d52 2022-07-04 stsp signatures by invoking <a class="Xr" aria-label="ssh-keygen, section
1420 376d4d52 2022-07-04 stsp 1">ssh-keygen(1)</a> with the options <code class="Fl">-Y</code>
1421 63657f42 2022-09-07 stsp <code class="Cm">verify</code> <code class="Fl">-f</code>
1422 376d4d52 2022-07-04 stsp <var class="Ar">allowed_signers</var>. A path to the
1423 376d4d52 2022-07-04 stsp <var class="Ar">allowed_signers</var> file must be set in
1424 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>,
1425 376d4d52 2022-07-04 stsp otherwise verification is impossible.</p>
1426 376d4d52 2022-07-04 stsp </dd>
1427 63657f42 2022-09-07 stsp <dt id="v~3"><a class="permalink" href="#v~3"><code class="Fl">-v</code></a></dt>
1428 63657f42 2022-09-07 stsp <dd>Verbose mode. During SSH signature creation and verification this
1429 63657f42 2022-09-07 stsp option will be passed to <a class="Xr" aria-label="ssh-keygen, section
1430 63657f42 2022-09-07 stsp 1">ssh-keygen(1)</a>. Multiple -v options increase the verbosity. The
1431 63657f42 2022-09-07 stsp maximum is 3.</dd>
1432 f447d26b 2019-08-23 stsp </dl>
1433 f447d26b 2019-08-23 stsp <p class="Pp">By design, the <code class="Cm">got tag</code> command will
1434 f447d26b 2019-08-23 stsp not delete tags or change existing tags. If a tag must be deleted, the
1435 f447d26b 2019-08-23 stsp <code class="Cm">got ref</code> command may be used to delete a tag's
1436 f447d26b 2019-08-23 stsp reference. This should only be done if the tag has not already been
1437 f447d26b 2019-08-23 stsp copied to another repository.</p>
1438 f447d26b 2019-08-23 stsp </dd>
1439 2dbbbc3a 2020-07-23 stsp <dt id="add"><a class="permalink" href="#add"><code class="Cm">add</code></a>
1440 63657f42 2022-09-07 stsp [<code class="Fl">-IR</code>] <var class="Ar">path ...</var></dt>
1441 8797b228 2019-08-04 stsp <dd>Schedule unversioned files in a work tree for addition to the repository
1442 16cd1323 2021-07-26 stsp in the next commit. By default, files which match a <code class="Cm">got
1443 16cd1323 2021-07-26 stsp status</code> ignore pattern will not be added.
1444 41ae98c9 2023-06-23 stsp <p class="Pp">If a <var class="Ar">path</var> mentioned in the command line
1445 41ae98c9 2023-06-23 stsp is not an unversioned file then <code class="Cm">got add</code> may
1446 41ae98c9 2023-06-23 stsp raise an error. To avoid unnecessary errors from paths picked up by file
1447 41ae98c9 2023-06-23 stsp globbing patterns in the shell, paths in the argument list will be
1448 41ae98c9 2023-06-23 stsp silently ignored if they are not reported by <code class="Cm">got
1449 41ae98c9 2023-06-23 stsp status</code> at all, or if they are reported with one of the following
1450 41ae98c9 2023-06-23 stsp status codes and do not have changes staged via <code class="Cm">got
1451 41ae98c9 2023-06-23 stsp stage</code>:</p>
1452 41ae98c9 2023-06-23 stsp <table class="Bl-column">
1453 41ae98c9 2023-06-23 stsp <tr>
1454 41ae98c9 2023-06-23 stsp <td>M</td>
1455 41ae98c9 2023-06-23 stsp <td>modified file</td>
1456 41ae98c9 2023-06-23 stsp </tr>
1457 41ae98c9 2023-06-23 stsp <tr>
1458 41ae98c9 2023-06-23 stsp <td>A</td>
1459 41ae98c9 2023-06-23 stsp <td>file scheduled for addition in next commit</td>
1460 41ae98c9 2023-06-23 stsp </tr>
1461 41ae98c9 2023-06-23 stsp <tr>
1462 41ae98c9 2023-06-23 stsp <td>C</td>
1463 41ae98c9 2023-06-23 stsp <td>modified or added file which contains merge conflicts</td>
1464 41ae98c9 2023-06-23 stsp </tr>
1465 41ae98c9 2023-06-23 stsp <tr>
1466 41ae98c9 2023-06-23 stsp <td>m</td>
1467 41ae98c9 2023-06-23 stsp <td>modified file modes (executable bit only)</td>
1468 41ae98c9 2023-06-23 stsp </tr>
1469 41ae98c9 2023-06-23 stsp </table>
1470 cc85973b 2019-11-27 stsp <p class="Pp">The options for <code class="Cm">got add</code> are as
1471 cc85973b 2019-11-27 stsp follows:</p>
1472 cc85973b 2019-11-27 stsp <dl class="Bl-tag">
1473 63657f42 2022-09-07 stsp <dt id="I~3"><a class="permalink" href="#I~3"><code class="Fl">-I</code></a></dt>
1474 63657f42 2022-09-07 stsp <dd>Add files even if they match a <code class="Cm">got status</code>
1475 63657f42 2022-09-07 stsp ignore pattern.</dd>
1476 2dbbbc3a 2020-07-23 stsp <dt id="R~5"><a class="permalink" href="#R~5"><code class="Fl">-R</code></a></dt>
1477 cc85973b 2019-11-27 stsp <dd>Permit recursion into directories. If this option is not specified,
1478 cc85973b 2019-11-27 stsp <code class="Cm">got add</code> will refuse to run if a specified
1479 cc85973b 2019-11-27 stsp <var class="Ar">path</var> is a directory.</dd>
1480 cc85973b 2019-11-27 stsp </dl>
1481 cc85973b 2019-11-27 stsp </dd>
1482 63b69821 2021-10-16 stsp <dt id="rm"><a class="permalink" href="#remove"><code class="Cm" id="remove">remove</code></a>
1483 63657f42 2022-09-07 stsp [<code class="Fl">-fkR</code>] [<code class="Fl">-s</code>
1484 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var>] <var class="Ar">path ...</var></dt>
1485 63b69821 2021-10-16 stsp <dd>
1486 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1487 46043f6f 2021-11-23 stsp <code class="Cm">rm</code>)</code></div>
1488 46043f6f 2021-11-23 stsp Remove versioned files from a work tree and schedule them for deletion from
1489 46043f6f 2021-11-23 stsp the repository in the next commit.
1490 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got remove</code> are as
1491 8797b228 2019-08-04 stsp follows:</p>
1492 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1493 2dbbbc3a 2020-07-23 stsp <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a></dt>
1494 b078d5c4 2022-03-23 stsp <dd>Perform the operation even if a file contains local modifications, and
1495 b078d5c4 2022-03-23 stsp do not raise an error if a specified <var class="Ar">path</var> does
1496 b078d5c4 2022-03-23 stsp not exist on disk.</dd>
1497 2dbbbc3a 2020-07-23 stsp <dt id="k"><a class="permalink" href="#k"><code class="Fl">-k</code></a></dt>
1498 8b679b4b 2020-02-17 stsp <dd>Keep affected files on disk.</dd>
1499 2dbbbc3a 2020-07-23 stsp <dt id="R~6"><a class="permalink" href="#R~6"><code class="Fl">-R</code></a></dt>
1500 8b679b4b 2020-02-17 stsp <dd>Permit recursion into directories. If this option is not specified,
1501 8b679b4b 2020-02-17 stsp <code class="Cm">got remove</code> will refuse to run if a specified
1502 8b679b4b 2020-02-17 stsp <var class="Ar">path</var> is a directory.</dd>
1503 376d4d52 2022-07-04 stsp <dt id="s~6"><a class="permalink" href="#s~6"><code class="Fl">-s</code></a>
1504 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var></dt>
1505 feee6923 2020-09-17 stsp <dd>Only delete files with a modification status matching one of the
1506 feee6923 2020-09-17 stsp single-character status codes contained in the
1507 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var> argument. The following status
1508 feee6923 2020-09-17 stsp codes may be specified:
1509 feee6923 2020-09-17 stsp <table class="Bl-column">
1510 feee6923 2020-09-17 stsp <tr>
1511 feee6923 2020-09-17 stsp <td>M</td>
1512 feee6923 2020-09-17 stsp <td>modified file (this implies the <code class="Fl">-f</code>
1513 feee6923 2020-09-17 stsp option)</td>
1514 feee6923 2020-09-17 stsp </tr>
1515 feee6923 2020-09-17 stsp <tr>
1516 feee6923 2020-09-17 stsp <td>!</td>
1517 feee6923 2020-09-17 stsp <td>versioned file expected on disk but missing</td>
1518 feee6923 2020-09-17 stsp </tr>
1519 feee6923 2020-09-17 stsp </table>
1520 feee6923 2020-09-17 stsp </dd>
1521 b078d5c4 2022-03-23 stsp </dl>
1522 b078d5c4 2022-03-23 stsp </dd>
1523 b078d5c4 2022-03-23 stsp <dt id="pa"><a class="permalink" href="#patch"><code class="Cm" id="patch">patch</code></a>
1524 63657f42 2022-09-07 stsp [<code class="Fl">-nR</code>] [<code class="Fl">-c</code>
1525 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-p</code>
1526 63657f42 2022-09-07 stsp <var class="Ar">strip-count</var>] [<var class="Ar">patchfile</var>]</dt>
1527 b078d5c4 2022-03-23 stsp <dd>
1528 b078d5c4 2022-03-23 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1529 b078d5c4 2022-03-23 stsp <code class="Cm">pa</code>)</code></div>
1530 b078d5c4 2022-03-23 stsp Apply changes from <var class="Ar">patchfile</var> to files in a work tree.
1531 b078d5c4 2022-03-23 stsp Files added or removed by a patch will be scheduled for addition or
1532 b078d5c4 2022-03-23 stsp removal in the work tree.
1533 b078d5c4 2022-03-23 stsp <p class="Pp">The patch must be in the unified diff format as produced by
1534 376d4d52 2022-07-04 stsp <code class="Cm">got diff</code>, <a class="Xr" aria-label="git-diff,
1535 376d4d52 2022-07-04 stsp section 1">git-diff(1)</a>, or by <a class="Xr" aria-label="diff,
1536 376d4d52 2022-07-04 stsp section 1">diff(1)</a> and <a class="Xr" aria-label="cvs, section
1537 376d4d52 2022-07-04 stsp 1">cvs(1)</a> diff when invoked with their <code class="Fl">-u</code>
1538 376d4d52 2022-07-04 stsp options. If no <var class="Ar">patchfile</var> argument is provided,
1539 376d4d52 2022-07-04 stsp read unified diff data from standard input instead.</p>
1540 b078d5c4 2022-03-23 stsp <p class="Pp">If the <var class="Ar">patchfile</var> contains multiple
1541 b078d5c4 2022-03-23 stsp patches, then attempt to apply each of them in sequence.</p>
1542 b078d5c4 2022-03-23 stsp <p class="Pp">Show the status of each affected file, using the following
1543 b078d5c4 2022-03-23 stsp status codes:</p>
1544 b078d5c4 2022-03-23 stsp <table class="Bl-column">
1545 b078d5c4 2022-03-23 stsp <tr>
1546 b078d5c4 2022-03-23 stsp <td>M</td>
1547 b078d5c4 2022-03-23 stsp <td>file was modified</td>
1548 b078d5c4 2022-03-23 stsp </tr>
1549 b078d5c4 2022-03-23 stsp <tr>
1550 376d4d52 2022-07-04 stsp <td>G</td>
1551 376d4d52 2022-07-04 stsp <td>file was merged using a merge-base found in the repository</td>
1552 376d4d52 2022-07-04 stsp </tr>
1553 376d4d52 2022-07-04 stsp <tr>
1554 376d4d52 2022-07-04 stsp <td>C</td>
1555 376d4d52 2022-07-04 stsp <td>file was merged and conflicts occurred during merge</td>
1556 376d4d52 2022-07-04 stsp </tr>
1557 376d4d52 2022-07-04 stsp <tr>
1558 b078d5c4 2022-03-23 stsp <td>D</td>
1559 b078d5c4 2022-03-23 stsp <td>file was deleted</td>
1560 b078d5c4 2022-03-23 stsp </tr>
1561 b078d5c4 2022-03-23 stsp <tr>
1562 b078d5c4 2022-03-23 stsp <td>A</td>
1563 b078d5c4 2022-03-23 stsp <td>file was added</td>
1564 b078d5c4 2022-03-23 stsp </tr>
1565 b078d5c4 2022-03-23 stsp <tr>
1566 b078d5c4 2022-03-23 stsp <td>#</td>
1567 b078d5c4 2022-03-23 stsp <td>failed to patch the file</td>
1568 b078d5c4 2022-03-23 stsp </tr>
1569 b078d5c4 2022-03-23 stsp </table>
1570 b078d5c4 2022-03-23 stsp <p class="Pp">If a change does not match at its exact line number, attempt
1571 b078d5c4 2022-03-23 stsp to apply it somewhere else in the file if a good spot can be found.
1572 b078d5c4 2022-03-23 stsp Otherwise, the patch will fail to apply.</p>
1573 b078d5c4 2022-03-23 stsp <p class="Pp"><code class="Nm">got</code> <code class="Cm">patch</code> will
1574 b078d5c4 2022-03-23 stsp refuse to apply a patch if certain preconditions are not met. Files to
1575 b078d5c4 2022-03-23 stsp be deleted must already be under version control, and must not have been
1576 b078d5c4 2022-03-23 stsp scheduled for deletion already. Files to be added must not yet be under
1577 b078d5c4 2022-03-23 stsp version control and must not already be present on disk. Files to be
1578 b078d5c4 2022-03-23 stsp modified must already be under version control and may not contain
1579 b078d5c4 2022-03-23 stsp conflict markers.</p>
1580 b078d5c4 2022-03-23 stsp <p class="Pp">If an error occurs, the <code class="Cm">patch</code>
1581 b078d5c4 2022-03-23 stsp operation will be aborted. Any changes made to the work tree up to this
1582 b078d5c4 2022-03-23 stsp point will be left behind. Such changes can be viewed with
1583 b078d5c4 2022-03-23 stsp <code class="Cm">got diff</code> and can be reverted with
1584 b078d5c4 2022-03-23 stsp <code class="Cm">got revert</code> if needed.</p>
1585 b078d5c4 2022-03-23 stsp <p class="Pp">The options for <code class="Cm">got patch</code> are as
1586 b078d5c4 2022-03-23 stsp follows:</p>
1587 b078d5c4 2022-03-23 stsp <dl class="Bl-tag">
1588 63657f42 2022-09-07 stsp <dt id="c~10"><a class="permalink" href="#c~10"><code class="Fl">-c</code></a>
1589 63657f42 2022-09-07 stsp <var class="Ar">commit</var></dt>
1590 63657f42 2022-09-07 stsp <dd>Attempt to locate files within the specified
1591 63657f42 2022-09-07 stsp <var class="Ar">commit</var> for use as a merge-base for 3-way merges.
1592 63657f42 2022-09-07 stsp <p class="Pp">If the <code class="Fl">-c</code> option is not used then
1593 63657f42 2022-09-07 stsp <code class="Cm">got patch</code> will attempt to locate merge-bases
1594 63657f42 2022-09-07 stsp via object IDs found in <var class="Ar">patchfile</var> meta-data,
1595 63657f42 2022-09-07 stsp such as produced by <code class="Cm">got diff</code> or
1596 63657f42 2022-09-07 stsp <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a>. Use
1597 63657f42 2022-09-07 stsp of the <code class="Fl">-c</code> option is only recommended in the
1598 63657f42 2022-09-07 stsp absence of such meta-data.</p>
1599 461d9094 2023-07-19 stsp <p class="Pp">Ideally, the specified <var class="Ar">commit</var> should
1600 461d9094 2023-07-19 stsp contain versions of files which the changes contained in the
1601 461d9094 2023-07-19 stsp <var class="Ar">patchfile</var> were based on. Files will be located
1602 461d9094 2023-07-19 stsp by path, relative to the repository root. If the
1603 461d9094 2023-07-19 stsp <code class="Fl">-p</code> option is used then leading path
1604 461d9094 2023-07-19 stsp components will be stripped before paths are looked up in the
1605 461d9094 2023-07-19 stsp repository.</p>
1606 63657f42 2022-09-07 stsp <p class="Pp">In case no merge-base is available for a file, changes
1607 63657f42 2022-09-07 stsp will be applied without doing a 3-way merge. Changes which do not
1608 63657f42 2022-09-07 stsp apply cleanly may then be rejected entirely, rather than producing
1609 63657f42 2022-09-07 stsp merge conflicts in the patched target file.</p>
1610 461d9094 2023-07-19 stsp <p class="Pp" id="flan:+3">The expected <var class="Ar">commit</var>
1611 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
1612 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
1613 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
1614 461d9094 2023-07-19 stsp abbreviation is unique. The keywords &quot;:base&quot; and
1615 461d9094 2023-07-19 stsp &quot;:head&quot; resolve to the work tree's base commit and branch
1616 461d9094 2023-07-19 stsp head, respectively. Keywords and references may be appended with
1617 461d9094 2023-07-19 stsp &quot;:+&quot; or &quot;:-&quot; modifiers and an optional integer N
1618 461d9094 2023-07-19 stsp to denote the Nth descendant or antecedent by first parent
1619 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b>
1620 461d9094 2023-07-19 stsp denotes the work tree branch head's 2nd generation ancestor, and
1621 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
1622 461d9094 2023-07-19 stsp the work tree's base commit. Similarly,
1623 461d9094 2023-07-19 stsp <a class="permalink" href="#flan:+3"><b class="Sy">flan:+3</b></a>
1624 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
1625 461d9094 2023-07-19 stsp the &quot;flan&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
1626 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
1627 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1628 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1629 63657f42 2022-09-07 stsp </dd>
1630 b078d5c4 2022-03-23 stsp <dt id="n~2"><a class="permalink" href="#n~2"><code class="Fl">-n</code></a></dt>
1631 b078d5c4 2022-03-23 stsp <dd>Do not make any modifications to the work tree. This can be used to
1632 b078d5c4 2022-03-23 stsp check whether a patch would apply without issues. If the
1633 b078d5c4 2022-03-23 stsp <var class="Ar">patchfile</var> contains diffs that affect the same
1634 b078d5c4 2022-03-23 stsp file multiple times, the results displayed may be incorrect.</dd>
1635 15ba8349 2022-04-24 stsp <dt id="p~3"><a class="permalink" href="#p~3"><code class="Fl">-p</code></a>
1636 15ba8349 2022-04-24 stsp <var class="Ar">strip-count</var></dt>
1637 15ba8349 2022-04-24 stsp <dd>Specify the number of leading path components to strip from paths
1638 15ba8349 2022-04-24 stsp parsed from <var class="Ar">patchfile</var>. If the
1639 15ba8349 2022-04-24 stsp <code class="Fl">-p</code> option is not used, &#x2018;a/&#x2019; and
1640 15ba8349 2022-04-24 stsp &#x2018;b/&#x2019; path prefixes generated by
1641 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a> will be
1642 376d4d52 2022-07-04 stsp recognized and stripped automatically.</dd>
1643 15ba8349 2022-04-24 stsp <dt id="R~7"><a class="permalink" href="#R~7"><code class="Fl">-R</code></a></dt>
1644 15ba8349 2022-04-24 stsp <dd>Reverse the patch before applying it.</dd>
1645 8797b228 2019-08-04 stsp </dl>
1646 8797b228 2019-08-04 stsp </dd>
1647 63b69821 2021-10-16 stsp <dt id="rv"><a class="permalink" href="#revert"><code class="Cm" id="revert">revert</code></a>
1648 63657f42 2022-09-07 stsp [<code class="Fl">-pR</code>] [<code class="Fl">-F</code>
1649 63657f42 2022-09-07 stsp <var class="Ar">response-script</var>] <var class="Ar">path ...</var></dt>
1650 63b69821 2021-10-16 stsp <dd>
1651 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1652 46043f6f 2021-11-23 stsp <code class="Cm">rv</code>)</code></div>
1653 46043f6f 2021-11-23 stsp Revert any local changes in files at the specified paths in a work tree.
1654 a462773e 2020-04-19 stsp File contents will be overwritten with those contained in the work tree's
1655 a462773e 2020-04-19 stsp base commit. There is no way to bring discarded changes back after
1656 8797b228 2019-08-04 stsp <code class="Cm">got revert</code>!
1657 b078d5c4 2022-03-23 stsp <p class="Pp">If a file was added with <code class="Cm">got add</code>, it
1658 8797b228 2019-08-04 stsp will become an unversioned file again. If a file was deleted with
1659 b078d5c4 2022-03-23 stsp <code class="Cm">got remove</code>, it will be restored.</p>
1660 7da3b7f6 2019-08-08 stsp <p class="Pp">The options for <code class="Cm">got revert</code> are as
1661 7da3b7f6 2019-08-08 stsp follows:</p>
1662 7da3b7f6 2019-08-08 stsp <dl class="Bl-tag">
1663 63657f42 2022-09-07 stsp <dt id="F"><a class="permalink" href="#F"><code class="Fl">-F</code></a>
1664 63657f42 2022-09-07 stsp <var class="Ar">response-script</var></dt>
1665 63657f42 2022-09-07 stsp <dd>With the <code class="Fl">-p</code> option, read &#x201C;y&#x201D;,
1666 63657f42 2022-09-07 stsp &#x201C;n&#x201D;, and &#x201C;q&#x201D; responses line-by-line from
1667 63657f42 2022-09-07 stsp the specified <var class="Ar">response-script</var> file instead of
1668 63657f42 2022-09-07 stsp prompting interactively.</dd>
1669 15ba8349 2022-04-24 stsp <dt id="p~4"><a class="permalink" href="#p~4"><code class="Fl">-p</code></a></dt>
1670 7da3b7f6 2019-08-08 stsp <dd>Instead of reverting all changes in files, interactively select or
1671 7da3b7f6 2019-08-08 stsp reject changes to revert based on &#x201C;y&#x201D; (revert change),
1672 7da3b7f6 2019-08-08 stsp &#x201C;n&#x201D; (keep change), and &#x201C;q&#x201D; (quit reverting
1673 7da3b7f6 2019-08-08 stsp this file) responses. If a file is in modified status, individual
1674 7da3b7f6 2019-08-08 stsp patches derived from the modified file content can be reverted. Files
1675 7da3b7f6 2019-08-08 stsp in added or deleted status may only be reverted in their
1676 7da3b7f6 2019-08-08 stsp entirety.</dd>
1677 15ba8349 2022-04-24 stsp <dt id="R~8"><a class="permalink" href="#R~8"><code class="Fl">-R</code></a></dt>
1678 7da3b7f6 2019-08-08 stsp <dd>Permit recursion into directories. If this option is not specified,
1679 7da3b7f6 2019-08-08 stsp <code class="Cm">got revert</code> will refuse to run if a specified
1680 7da3b7f6 2019-08-08 stsp <var class="Ar">path</var> is a directory.</dd>
1681 7da3b7f6 2019-08-08 stsp </dl>
1682 8797b228 2019-08-04 stsp </dd>
1683 63b69821 2021-10-16 stsp <dt id="ci"><a class="permalink" href="#commit"><code class="Cm" id="commit">commit</code></a>
1684 f6a6fa94 2023-02-22 stsp [<code class="Fl">-CNnS</code>] [<code class="Fl">-A</code>
1685 63657f42 2022-09-07 stsp <var class="Ar">author</var>] [<code class="Fl">-F</code>
1686 63657f42 2022-09-07 stsp <var class="Ar">path</var>] [<code class="Fl">-m</code>
1687 63657f42 2022-09-07 stsp <var class="Ar">message</var>] [<var class="Ar">path ...</var>]</dt>
1688 63b69821 2021-10-16 stsp <dd>
1689 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1690 46043f6f 2021-11-23 stsp <code class="Cm">ci</code>)</code></div>
1691 46043f6f 2021-11-23 stsp Create a new commit in the repository from changes in a work tree and use
1692 8797b228 2019-08-04 stsp this commit as the new base commit for the work tree. If no
1693 8797b228 2019-08-04 stsp <var class="Ar">path</var> is specified, commit all changes in the work
1694 8797b228 2019-08-04 stsp tree. Otherwise, commit changes at or within the specified paths.
1695 8797b228 2019-08-04 stsp <p class="Pp">If changes have been explicitly staged for commit with
1696 4967d3c2 2019-08-12 stsp <code class="Cm">got stage</code>, only commit staged changes and reject
1697 8797b228 2019-08-04 stsp any specified paths which have not been staged.</p>
1698 039953c9 2021-03-22 stsp <p class="Pp"><code class="Cm">got commit</code> opens a temporary file in
1699 039953c9 2021-03-22 stsp an editor where a log message can be written unless the
1700 039953c9 2021-03-22 stsp <code class="Fl">-m</code> option is used or the
1701 039953c9 2021-03-22 stsp <code class="Fl">-F</code> and <code class="Fl">-N</code> options are
1702 461d9094 2023-07-19 stsp used together. Quitting the editor without saving the file will abort
1703 461d9094 2023-07-19 stsp the commit operation.</p>
1704 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
1705 8797b228 2019-08-04 stsp status codes:</p>
1706 8797b228 2019-08-04 stsp <table class="Bl-column">
1707 8797b228 2019-08-04 stsp <tr>
1708 8797b228 2019-08-04 stsp <td>M</td>
1709 8797b228 2019-08-04 stsp <td>modified file</td>
1710 8797b228 2019-08-04 stsp </tr>
1711 8797b228 2019-08-04 stsp <tr>
1712 8797b228 2019-08-04 stsp <td>D</td>
1713 8797b228 2019-08-04 stsp <td>file was deleted</td>
1714 8797b228 2019-08-04 stsp </tr>
1715 8797b228 2019-08-04 stsp <tr>
1716 8797b228 2019-08-04 stsp <td>A</td>
1717 8797b228 2019-08-04 stsp <td>new file was added</td>
1718 d8e62599 2019-10-21 stsp </tr>
1719 d8e62599 2019-10-21 stsp <tr>
1720 d8e62599 2019-10-21 stsp <td>m</td>
1721 d8e62599 2019-10-21 stsp <td>modified file modes (executable bit only)</td>
1722 8797b228 2019-08-04 stsp </tr>
1723 8797b228 2019-08-04 stsp </table>
1724 ae520cae 2019-08-05 stsp <p class="Pp">Files which are not part of the new commit will retain their
1725 ae520cae 2019-08-05 stsp previously recorded base commit. Some <code class="Nm">got</code>
1726 ae520cae 2019-08-05 stsp commands may refuse to run while the work tree contains files from
1727 ae520cae 2019-08-05 stsp multiple base commits. The base commit of such a work tree can be made
1728 ae520cae 2019-08-05 stsp consistent by running <code class="Cm">got update</code> across the
1729 ae520cae 2019-08-05 stsp entire work tree.</p>
1730 8797b228 2019-08-04 stsp <p class="Pp">The <code class="Cm">got commit</code> command requires the
1731 c2a52be5 2019-09-08 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
1732 376d4d52 2022-07-04 stsp unless an author has been configured in
1733 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1734 376d4d52 2022-07-04 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
1735 376d4d52 2022-07-04 stsp configuration settings can be obtained from the repository's
1736 376d4d52 2022-07-04 stsp <span class="Pa">.git/config</span> file or from Git's global
1737 376d4d52 2022-07-04 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
1738 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got commit</code> are as
1739 8797b228 2019-08-04 stsp follows:</p>
1740 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1741 63657f42 2022-09-07 stsp <dt id="A"><a class="permalink" href="#A"><code class="Fl">-A</code></a>
1742 63657f42 2022-09-07 stsp <var class="Ar">author</var></dt>
1743 63657f42 2022-09-07 stsp <dd>Set author information in the newly created commit to
1744 63657f42 2022-09-07 stsp <var class="Ar">author</var>. This is useful when committing changes
1745 f6a6fa94 2023-02-22 stsp on behalf of someone else. The <var class="Ar">author</var> argument
1746 f6a6fa94 2023-02-22 stsp must use the same format as the <code class="Ev">GOT_AUTHOR</code>
1747 f6a6fa94 2023-02-22 stsp environment variable.
1748 63657f42 2022-09-07 stsp <p class="Pp">In addition to storing author information, the newly
1749 63657f42 2022-09-07 stsp created commit object will retain &#x201C;committer&#x201D;
1750 63657f42 2022-09-07 stsp information which is obtained, as usual, from the
1751 63657f42 2022-09-07 stsp <code class="Ev">GOT_AUTHOR</code> environment variable, or
1752 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>, or
1753 63657f42 2022-09-07 stsp Git configuration settings.</p>
1754 63657f42 2022-09-07 stsp </dd>
1755 f6a6fa94 2023-02-22 stsp <dt id="C~3"><a class="permalink" href="#C~3"><code class="Fl">-C</code></a></dt>
1756 f6a6fa94 2023-02-22 stsp <dd>Allow committing files in conflicted status.
1757 f6a6fa94 2023-02-22 stsp <p class="Pp">Committing files with conflict markers should generally be
1758 f6a6fa94 2023-02-22 stsp avoided. Cases where conflict markers must be stored in the
1759 f6a6fa94 2023-02-22 stsp repository for some legitimate reason should be very rare. There are
1760 f6a6fa94 2023-02-22 stsp usually ways to avoid storing conflict markers verbatim by applying
1761 f6a6fa94 2023-02-22 stsp appropriate programming tricks.</p>
1762 f6a6fa94 2023-02-22 stsp </dd>
1763 039953c9 2021-03-22 stsp <dt id="F~2"><a class="permalink" href="#F~2"><code class="Fl">-F</code></a>
1764 039953c9 2021-03-22 stsp <var class="Ar">path</var></dt>
1765 039953c9 2021-03-22 stsp <dd>Use the prepared log message stored in the file found at
1766 039953c9 2021-03-22 stsp <var class="Ar">path</var> when creating the new commit.
1767 039953c9 2021-03-22 stsp <code class="Cm">got commit</code> opens a temporary file in an editor
1768 039953c9 2021-03-22 stsp where the prepared log message can be reviewed and edited further if
1769 039953c9 2021-03-22 stsp needed. Cannot be used together with the <code class="Fl">-m</code>
1770 039953c9 2021-03-22 stsp option.</dd>
1771 2dbbbc3a 2020-07-23 stsp <dt id="m~4"><a class="permalink" href="#m~4"><code class="Fl">-m</code></a>
1772 8797b228 2019-08-04 stsp <var class="Ar">message</var></dt>
1773 039953c9 2021-03-22 stsp <dd>Use the specified log message when creating the new commit. Cannot be
1774 039953c9 2021-03-22 stsp used together with the <code class="Fl">-F</code> option.</dd>
1775 039953c9 2021-03-22 stsp <dt id="N"><a class="permalink" href="#N"><code class="Fl">-N</code></a></dt>
1776 039953c9 2021-03-22 stsp <dd>This option prevents <code class="Cm">got commit</code> from opening
1777 039953c9 2021-03-22 stsp the commit message in an editor. It has no effect unless it is used
1778 039953c9 2021-03-22 stsp together with the <code class="Fl">-F</code> option and is intended
1779 039953c9 2021-03-22 stsp for non-interactive use such as scripting.</dd>
1780 fd9580e1 2022-11-03 stsp <dt id="n~3"><a class="permalink" href="#n~3"><code class="Fl">-n</code></a></dt>
1781 fd9580e1 2022-11-03 stsp <dd>This option prevents <code class="Cm">got commit</code> from
1782 fd9580e1 2022-11-03 stsp generating a diff of the to-be-committed changes in a temporary file
1783 fd9580e1 2022-11-03 stsp which can be viewed while editing a commit message.</dd>
1784 a701a2ae 2022-06-17 stsp <dt id="S~3"><a class="permalink" href="#S~3"><code class="Fl">-S</code></a></dt>
1785 1554b334 2020-08-02 stsp <dd>Allow the addition of symbolic links which point outside of the path
1786 1554b334 2020-08-02 stsp space that is under version control. By default, <code class="Cm">got
1787 1554b334 2020-08-02 stsp commit</code> will reject such symbolic links due to safety concerns.
1788 1554b334 2020-08-02 stsp As a precaution, <code class="Nm">got</code> may decide to represent
1789 1554b334 2020-08-02 stsp such a symbolic link as a regular file which contains the link's
1790 1554b334 2020-08-02 stsp target path, rather than creating an actual symbolic link which points
1791 1554b334 2020-08-02 stsp outside of the work tree. Use of this option is discouraged because
1792 1554b334 2020-08-02 stsp external mechanisms such as &#x201C;make obj&#x201D; are better suited
1793 1554b334 2020-08-02 stsp for managing symbolic links to paths not under version control.</dd>
1794 8797b228 2019-08-04 stsp </dl>
1795 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got commit</code> will refuse to run if
1796 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree's current branch is
1797 8797b228 2019-08-04 stsp not in the &#x201C;refs/heads/&#x201D; reference namespace, new commits
1798 8797b228 2019-08-04 stsp may not be created on this branch. Local changes may only be committed
1799 8797b228 2019-08-04 stsp if they are based on file content found in the most recent commit on the
1800 8797b228 2019-08-04 stsp work tree's branch. If a path is found to be out of date,
1801 8797b228 2019-08-04 stsp <code class="Cm">got update</code> must be used first in order to merge
1802 8797b228 2019-08-04 stsp local changes with changes made in the repository.</p>
1803 8797b228 2019-08-04 stsp </dd>
1804 63b69821 2021-10-16 stsp <dt id="se"><a class="permalink" href="#send"><code class="Cm" id="send">send</code></a>
1805 63657f42 2022-09-07 stsp [<code class="Fl">-afqTv</code>] [<code class="Fl">-b</code>
1806 def5be4a 2021-08-31 stsp <var class="Ar">branch</var>] [<code class="Fl">-d</code>
1807 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-r</code>
1808 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-t</code>
1809 63657f42 2022-09-07 stsp <var class="Ar">tag</var>] [<var class="Ar">remote-repository</var>]</dt>
1810 63b69821 2021-10-16 stsp <dd>
1811 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1812 46043f6f 2021-11-23 stsp <code class="Cm">se</code>)</code></div>
1813 46043f6f 2021-11-23 stsp Send new changes to a remote repository. If no
1814 def5be4a 2021-08-31 stsp <var class="Ar">remote-repository</var> is specified,
1815 def5be4a 2021-08-31 stsp &#x201C;origin&#x201D; will be used. The remote repository's URL is
1816 376d4d52 2022-07-04 stsp obtained from the corresponding entry in
1817 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1818 376d4d52 2022-07-04 stsp <span class="Pa">config</span> file of the local repository, as created by
1819 376d4d52 2022-07-04 stsp <code class="Cm">got clone</code>.
1820 def5be4a 2021-08-31 stsp <p class="Pp">All objects corresponding to new changes will be written to a
1821 def5be4a 2021-08-31 stsp temporary pack file which is then uploaded to the server. Upon success,
1822 def5be4a 2021-08-31 stsp references in the &#x201C;refs/remotes/&#x201D; reference namespace of
1823 def5be4a 2021-08-31 stsp the local repository will be updated to point at the commits which have
1824 def5be4a 2021-08-31 stsp been sent.</p>
1825 def5be4a 2021-08-31 stsp <p class="Pp">By default, changes will only be sent if they are based on
1826 def5be4a 2021-08-31 stsp up-to-date copies of relevant branches in the remote repository. If any
1827 def5be4a 2021-08-31 stsp changes to be sent are based on out-of-date copies or would otherwise
1828 def5be4a 2021-08-31 stsp break linear history of existing branches, new changes must be fetched
1829 def5be4a 2021-08-31 stsp from the server with <code class="Cm">got fetch</code> and local
1830 def5be4a 2021-08-31 stsp branches must be rebased with <code class="Cm">got rebase</code> before
1831 def5be4a 2021-08-31 stsp <code class="Cm">got send</code> can succeed. The
1832 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option can be used to make exceptions to
1833 def5be4a 2021-08-31 stsp these requirements.</p>
1834 def5be4a 2021-08-31 stsp <p class="Pp">The options for <code class="Cm">got send</code> are as
1835 def5be4a 2021-08-31 stsp follows:</p>
1836 def5be4a 2021-08-31 stsp <dl class="Bl-tag">
1837 def5be4a 2021-08-31 stsp <dt id="a~4"><a class="permalink" href="#a~4"><code class="Fl">-a</code></a></dt>
1838 def5be4a 2021-08-31 stsp <dd>Send all branches from the local repository's
1839 def5be4a 2021-08-31 stsp &#x201C;refs/heads/&#x201D; reference namespace. The
1840 def5be4a 2021-08-31 stsp <code class="Fl">-a</code> option is equivalent to listing all
1841 def5be4a 2021-08-31 stsp branches with multiple <code class="Fl">-b</code> options. Cannot be
1842 def5be4a 2021-08-31 stsp used together with the <code class="Fl">-b</code> option.</dd>
1843 56f3f26e 2024-06-03 stsp <dt id="b~8"><a class="permalink" href="#b~8"><code class="Fl">-b</code></a>
1844 def5be4a 2021-08-31 stsp <var class="Ar">branch</var></dt>
1845 def5be4a 2021-08-31 stsp <dd>Send the specified <var class="Ar">branch</var> from the local
1846 def5be4a 2021-08-31 stsp repository's &#x201C;refs/heads/&#x201D; reference namespace. This
1847 def5be4a 2021-08-31 stsp option may be specified multiple times to build a list of branches to
1848 def5be4a 2021-08-31 stsp send. If this option is not specified, default to the work tree's
1849 def5be4a 2021-08-31 stsp current branch if invoked in a work tree, or to the repository's HEAD
1850 def5be4a 2021-08-31 stsp reference. Cannot be used together with the <code class="Fl">-a</code>
1851 def5be4a 2021-08-31 stsp option.</dd>
1852 47f19dd5 2023-01-17 stsp <dt id="d~6"><a class="permalink" href="#d~6"><code class="Fl">-d</code></a>
1853 def5be4a 2021-08-31 stsp <var class="Ar">branch</var></dt>
1854 def5be4a 2021-08-31 stsp <dd>Delete the specified <var class="Ar">branch</var> from the remote
1855 def5be4a 2021-08-31 stsp repository's &#x201C;refs/heads/&#x201D; reference namespace. This
1856 def5be4a 2021-08-31 stsp option may be specified multiple times to build a list of branches to
1857 def5be4a 2021-08-31 stsp delete.
1858 def5be4a 2021-08-31 stsp <p class="Pp">Only references are deleted. Any commit, tree, tag, and
1859 def5be4a 2021-08-31 stsp blob objects belonging to deleted branches may become subject to
1860 def5be4a 2021-08-31 stsp deletion by Git's garbage collector running on the server.</p>
1861 def5be4a 2021-08-31 stsp <p class="Pp">Requesting deletion of branches results in an error if the
1862 def5be4a 2021-08-31 stsp server does not support this feature or disallows the deletion of
1863 def5be4a 2021-08-31 stsp branches based on its configuration.</p>
1864 def5be4a 2021-08-31 stsp </dd>
1865 def5be4a 2021-08-31 stsp <dt id="f~2"><a class="permalink" href="#f~2"><code class="Fl">-f</code></a></dt>
1866 def5be4a 2021-08-31 stsp <dd>Attempt to force the server to overwrite existing branches or tags in
1867 461d9094 2023-07-19 stsp the remote repository, even when <code class="Cm">got fetch</code>
1868 461d9094 2023-07-19 stsp followed by <code class="Cm">got rebase</code> or <code class="Cm">got
1869 461d9094 2023-07-19 stsp merge</code> would usually be required before changes can be sent. The
1870 461d9094 2023-07-19 stsp server may reject forced requests regardless, depending on its
1871 461d9094 2023-07-19 stsp configuration.
1872 def5be4a 2021-08-31 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
1873 def5be4a 2021-08-31 stsp overwritten branches or tags may become subject to deletion by Git's
1874 def5be4a 2021-08-31 stsp garbage collector running on the server.</p>
1875 def5be4a 2021-08-31 stsp <p class="Pp">The &#x201C;refs/tags&#x201D; reference namespace is
1876 def5be4a 2021-08-31 stsp globally shared between all repositories. Use of the
1877 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option to overwrite tags is discouraged
1878 def5be4a 2021-08-31 stsp because it can lead to inconsistencies between the tags present in
1879 def5be4a 2021-08-31 stsp different repositories. In general, creating a new tag with a
1880 def5be4a 2021-08-31 stsp different name is recommended instead of overwriting an existing
1881 def5be4a 2021-08-31 stsp tag.</p>
1882 def5be4a 2021-08-31 stsp <p class="Pp">Use of the <code class="Fl">-f</code> option is
1883 def5be4a 2021-08-31 stsp particularly discouraged if changes being sent are based on an
1884 def5be4a 2021-08-31 stsp out-of-date copy of a branch in the remote repository. Instead of
1885 def5be4a 2021-08-31 stsp using the <code class="Fl">-f</code> option, new changes should be
1886 def5be4a 2021-08-31 stsp fetched with <code class="Cm">got fetch</code> and local branches
1887 461d9094 2023-07-19 stsp should be rebased with <code class="Cm">got rebase</code> or merged
1888 461d9094 2023-07-19 stsp with <code class="Cm">got merge</code>, followed by another attempt
1889 461d9094 2023-07-19 stsp to send the changes.</p>
1890 def5be4a 2021-08-31 stsp <p class="Pp">The <code class="Fl">-f</code> option should only be
1891 def5be4a 2021-08-31 stsp needed in situations where the remote repository's copy of a branch
1892 def5be4a 2021-08-31 stsp or tag is known to be out-of-date and is considered disposable. The
1893 def5be4a 2021-08-31 stsp risks of creating inconsistencies between different repositories
1894 def5be4a 2021-08-31 stsp should also be taken into account.</p>
1895 def5be4a 2021-08-31 stsp </dd>
1896 63657f42 2022-09-07 stsp <dt id="q~5"><a class="permalink" href="#q~5"><code class="Fl">-q</code></a></dt>
1897 63657f42 2022-09-07 stsp <dd>Suppress progress reporting output. The same option will be passed to
1898 63657f42 2022-09-07 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1899 63657f42 2022-09-07 stsp applicable.</dd>
1900 def5be4a 2021-08-31 stsp <dt id="r~10"><a class="permalink" href="#r~10"><code class="Fl">-r</code></a>
1901 def5be4a 2021-08-31 stsp <var class="Ar">repository-path</var></dt>
1902 def5be4a 2021-08-31 stsp <dd>Use the repository at the specified path. If not specified, assume the
1903 def5be4a 2021-08-31 stsp repository is located at or above the current working directory. If
1904 def5be4a 2021-08-31 stsp this directory is a <code class="Nm">got</code> work tree, use the
1905 def5be4a 2021-08-31 stsp repository path associated with this work tree.</dd>
1906 63657f42 2022-09-07 stsp <dt id="T"><a class="permalink" href="#T"><code class="Fl">-T</code></a></dt>
1907 63657f42 2022-09-07 stsp <dd>Attempt to send all tags from the local repository's
1908 63657f42 2022-09-07 stsp &#x201C;refs/tags/&#x201D; reference namespace. The
1909 63657f42 2022-09-07 stsp <code class="Fl">-T</code> option is equivalent to listing all tags
1910 63657f42 2022-09-07 stsp with multiple <code class="Fl">-t</code> options. Cannot be used
1911 63657f42 2022-09-07 stsp together with the <code class="Fl">-t</code> option.</dd>
1912 bd0bf387 2024-04-23 stsp <dt id="t~5"><a class="permalink" href="#t~5"><code class="Fl">-t</code></a>
1913 def5be4a 2021-08-31 stsp <var class="Ar">tag</var></dt>
1914 def5be4a 2021-08-31 stsp <dd>Send the specified <var class="Ar">tag</var> from the local
1915 def5be4a 2021-08-31 stsp repository's &#x201C;refs/tags/&#x201D; reference namespace, in
1916 def5be4a 2021-08-31 stsp addition to any branches that are being sent. The
1917 def5be4a 2021-08-31 stsp <code class="Fl">-t</code> option may be specified multiple times to
1918 def5be4a 2021-08-31 stsp build a list of tags to send. No tags will be sent if the
1919 def5be4a 2021-08-31 stsp <code class="Fl">-t</code> option is not used.
1920 def5be4a 2021-08-31 stsp <p class="Pp">Raise an error if the specified <var class="Ar">tag</var>
1921 def5be4a 2021-08-31 stsp already exists in the remote repository, unless the
1922 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option is used to overwrite the server's
1923 def5be4a 2021-08-31 stsp copy of the tag. In general, creating a new tag with a different
1924 def5be4a 2021-08-31 stsp name is recommended instead of overwriting an existing tag.</p>
1925 def5be4a 2021-08-31 stsp <p class="Pp">Cannot be used together with the
1926 def5be4a 2021-08-31 stsp <code class="Fl">-T</code> option.</p>
1927 def5be4a 2021-08-31 stsp </dd>
1928 376d4d52 2022-07-04 stsp <dt id="v~4"><a class="permalink" href="#v~4"><code class="Fl">-v</code></a></dt>
1929 def5be4a 2021-08-31 stsp <dd>Verbose mode. Causes <code class="Cm">got send</code> to print
1930 def5be4a 2021-08-31 stsp debugging messages to standard error output. The same option will be
1931 376d4d52 2022-07-04 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1932 376d4d52 2022-07-04 stsp applicable. Multiple -v options increase the verbosity. The maximum is
1933 376d4d52 2022-07-04 stsp 3.</dd>
1934 def5be4a 2021-08-31 stsp </dl>
1935 def5be4a 2021-08-31 stsp </dd>
1936 63b69821 2021-10-16 stsp <dt id="cy"><a class="permalink" href="#cherrypick"><code class="Cm" id="cherrypick">cherrypick</code></a>
1937 7985a487 2023-01-30 stsp [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
1938 63b69821 2021-10-16 stsp <dd>
1939 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1940 46043f6f 2021-11-23 stsp <code class="Cm">cy</code>)</code></div>
1941 46043f6f 2021-11-23 stsp Merge changes from a single <var class="Ar">commit</var> into the work tree.
1942 46043f6f 2021-11-23 stsp The specified <var class="Ar">commit</var> should be on a different branch
1943 461d9094 2023-07-19 stsp than the work tree's base commit.
1944 461d9094 2023-07-19 stsp <p class="Pp" id="barbaz:+3">The expected argument is a commit ID SHA1 hash,
1945 461d9094 2023-07-19 stsp or a reference name or keyword which will be resolved to a commit ID. An
1946 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
1947 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
1948 461d9094 2023-07-19 stsp &quot;:base&quot; and &quot;:head&quot; resolve to the work tree's base
1949 461d9094 2023-07-19 stsp commit and branch head, respectively. Keywords and references may be
1950 461d9094 2023-07-19 stsp appended with &quot;:+&quot; or &quot;:-&quot; modifiers and an optional
1951 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent by first parent
1952 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
1953 461d9094 2023-07-19 stsp the work tree branch head's 2nd generation ancestor, and
1954 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
1955 461d9094 2023-07-19 stsp work tree's base commit. Similarly,
1956 461d9094 2023-07-19 stsp <a class="permalink" href="#barbaz:+3"><b class="Sy">barbaz:+3</b></a>
1957 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by the
1958 461d9094 2023-07-19 stsp &quot;barbaz&quot; reference. A &quot;:+&quot; or &quot;:-&quot;
1959 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit &quot;1&quot;
1960 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1961 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1962 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
1963 8797b228 2019-08-04 stsp status codes:</p>
1964 8797b228 2019-08-04 stsp <table class="Bl-column">
1965 8797b228 2019-08-04 stsp <tr>
1966 8797b228 2019-08-04 stsp <td>G</td>
1967 8797b228 2019-08-04 stsp <td>file was merged</td>
1968 8797b228 2019-08-04 stsp </tr>
1969 8797b228 2019-08-04 stsp <tr>
1970 8797b228 2019-08-04 stsp <td>C</td>
1971 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
1972 8797b228 2019-08-04 stsp </tr>
1973 8797b228 2019-08-04 stsp <tr>
1974 8797b228 2019-08-04 stsp <td>!</td>
1975 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
1976 8797b228 2019-08-04 stsp </tr>
1977 8797b228 2019-08-04 stsp <tr>
1978 8797b228 2019-08-04 stsp <td>D</td>
1979 8797b228 2019-08-04 stsp <td>file was deleted</td>
1980 8797b228 2019-08-04 stsp </tr>
1981 8797b228 2019-08-04 stsp <tr>
1982 8797b228 2019-08-04 stsp <td>d</td>
1983 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
1984 8797b228 2019-08-04 stsp </tr>
1985 8797b228 2019-08-04 stsp <tr>
1986 8797b228 2019-08-04 stsp <td>A</td>
1987 8797b228 2019-08-04 stsp <td>new file was added</td>
1988 8797b228 2019-08-04 stsp </tr>
1989 8797b228 2019-08-04 stsp <tr>
1990 8797b228 2019-08-04 stsp <td>~</td>
1991 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
1992 8797b228 2019-08-04 stsp </tr>
1993 1554b334 2020-08-02 stsp <tr>
1994 1554b334 2020-08-02 stsp <td>?</td>
1995 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
1996 1554b334 2020-08-02 stsp </tr>
1997 8797b228 2019-08-04 stsp </table>
1998 8797b228 2019-08-04 stsp <p class="Pp">The merged changes will appear as local changes in the work
1999 8797b228 2019-08-04 stsp tree, which may be viewed with <code class="Cm">got diff</code>, amended
2000 91b3da3f 2019-08-18 stsp manually or with further <code class="Cm">got cherrypick</code>
2001 7985a487 2023-01-30 stsp commands, committed with <code class="Cm">got commit</code>.</p>
2002 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree where no
2003 7985a487 2023-01-30 stsp <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
2004 7985a487 2023-01-30 stsp <code class="Cm">merge</code> operation is taking place,
2005 7985a487 2023-01-30 stsp <code class="Cm">got cherrypick</code> creates a record of commits which
2006 7985a487 2023-01-30 stsp have been merged into the work tree. When a file changed by
2007 7985a487 2023-01-30 stsp <code class="Cm">got cherrypick</code> is committed with
2008 7985a487 2023-01-30 stsp <code class="Cm">got commit</code>, the log messages of relevant merged
2009 f6a6fa94 2023-02-22 stsp commits will then appear in the editor, where the messages should be
2010 f6a6fa94 2023-02-22 stsp further adjusted to convey the reasons for cherrypicking the changes.
2011 f6a6fa94 2023-02-22 stsp Upon exiting the editor, if the time stamp of the log message file is
2012 f6a6fa94 2023-02-22 stsp unchanged or the log message is empty, <code class="Cm">got
2013 f6a6fa94 2023-02-22 stsp commit</code> will fail with an unmodified or empty log message
2014 f6a6fa94 2023-02-22 stsp error.</p>
2015 f6a6fa94 2023-02-22 stsp <p class="Pp">If all the changes in all files touched by a given commit are
2016 f6a6fa94 2023-02-22 stsp discarded, e.g. with <code class="Cm">got revert</code>, this commit's
2017 f6a6fa94 2023-02-22 stsp log message record will also disappear.</p>
2018 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got cherrypick</code> will refuse to run if
2019 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree contains multiple
2020 b078d5c4 2022-03-23 stsp base commits, it must first be updated to a single base commit with
2021 1e80276a 2021-09-03 stsp <code class="Cm">got update</code>. If any relevant files already
2022 1e80276a 2021-09-03 stsp contain merge conflicts, these conflicts must be resolved first.</p>
2023 7985a487 2023-01-30 stsp <p class="Pp">The options for <code class="Nm">got</code>
2024 7985a487 2023-01-30 stsp <code class="Cm">cherrypick</code> are as follows:</p>
2025 7985a487 2023-01-30 stsp <dl class="Bl-tag">
2026 7985a487 2023-01-30 stsp <dt id="l~7"><a class="permalink" href="#l~7"><code class="Fl">-l</code></a></dt>
2027 7985a487 2023-01-30 stsp <dd>Display a list of commit log messages recorded by cherrypick
2028 7985a487 2023-01-30 stsp operations, represented by references in the
2029 7985a487 2023-01-30 stsp &#x201C;refs/got/worktree&#x201D; reference namespace. If a
2030 7985a487 2023-01-30 stsp <var class="Ar">commit</var> is specified, only show the log message
2031 7985a487 2023-01-30 stsp of the specified commit.
2032 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2033 7985a487 2023-01-30 stsp cherrypick operations in the current work tree will be displayed.
2034 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be displayed irrespective of
2035 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2036 7985a487 2023-01-30 stsp with <code class="Fl">-X</code>.</p>
2037 7985a487 2023-01-30 stsp </dd>
2038 7985a487 2023-01-30 stsp <dt id="X~2"><a class="permalink" href="#X~2"><code class="Fl">-X</code></a></dt>
2039 7985a487 2023-01-30 stsp <dd>Delete log messages created by previous cherrypick operations,
2040 7985a487 2023-01-30 stsp represented by references in the &#x201C;refs/got/worktree&#x201D;
2041 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2042 7985a487 2023-01-30 stsp only delete the log message of the specified commit.
2043 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2044 7985a487 2023-01-30 stsp cherrypick operations in the current work tree will be deleted.
2045 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be deleted irrespective of
2046 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2047 7985a487 2023-01-30 stsp with <code class="Fl">-l</code>.</p>
2048 7985a487 2023-01-30 stsp </dd>
2049 7985a487 2023-01-30 stsp </dl>
2050 7985a487 2023-01-30 stsp <p class="Pp"></p>
2051 8797b228 2019-08-04 stsp </dd>
2052 63b69821 2021-10-16 stsp <dt id="bo"><a class="permalink" href="#backout"><code class="Cm" id="backout">backout</code></a>
2053 7985a487 2023-01-30 stsp [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
2054 63b69821 2021-10-16 stsp <dd>
2055 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2056 46043f6f 2021-11-23 stsp <code class="Cm">bo</code>)</code></div>
2057 46043f6f 2021-11-23 stsp Reverse-merge changes from a single <var class="Ar">commit</var> into the
2058 1e80276a 2021-09-03 stsp work tree. The specified <var class="Ar">commit</var> should be on the
2059 461d9094 2023-07-19 stsp same branch as the work tree's base commit.
2060 461d9094 2023-07-19 stsp <p class="Pp" id="wip:+5">The expected argument is a commit ID SHA1 hash, or
2061 461d9094 2023-07-19 stsp a reference name or keyword which will be resolved to a commit ID. An
2062 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
2063 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
2064 461d9094 2023-07-19 stsp &quot;:base&quot; and &quot;:head&quot; resolve to the work tree's base
2065 461d9094 2023-07-19 stsp commit and branch head, respectively. Keywords and references may be
2066 461d9094 2023-07-19 stsp appended with &quot;:+&quot; or &quot;:-&quot; modifiers and an optional
2067 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent by first parent
2068 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
2069 461d9094 2023-07-19 stsp the work tree branch head's 2nd generation ancestor, and
2070 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
2071 461d9094 2023-07-19 stsp work tree's base commit. Similarly,
2072 461d9094 2023-07-19 stsp <a class="permalink" href="#wip:+5"><b class="Sy">wip:+5</b></a> will
2073 461d9094 2023-07-19 stsp denote the 5th generation descendant of the commit resolved by the
2074 461d9094 2023-07-19 stsp &quot;wip&quot; reference. A &quot;:+&quot; or &quot;:-&quot; modifier
2075 461d9094 2023-07-19 stsp without a trailing integer has an implicit &quot;1&quot; appended (e.g.,
2076 461d9094 2023-07-19 stsp <b class="Sy">:base:+</b> is equivalent to
2077 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
2078 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
2079 8797b228 2019-08-04 stsp status codes:</p>
2080 8797b228 2019-08-04 stsp <table class="Bl-column">
2081 8797b228 2019-08-04 stsp <tr>
2082 8797b228 2019-08-04 stsp <td>G</td>
2083 8797b228 2019-08-04 stsp <td>file was merged</td>
2084 8797b228 2019-08-04 stsp </tr>
2085 8797b228 2019-08-04 stsp <tr>
2086 8797b228 2019-08-04 stsp <td>C</td>
2087 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2088 8797b228 2019-08-04 stsp </tr>
2089 8797b228 2019-08-04 stsp <tr>
2090 8797b228 2019-08-04 stsp <td>!</td>
2091 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2092 8797b228 2019-08-04 stsp </tr>
2093 8797b228 2019-08-04 stsp <tr>
2094 8797b228 2019-08-04 stsp <td>D</td>
2095 8797b228 2019-08-04 stsp <td>file was deleted</td>
2096 8797b228 2019-08-04 stsp </tr>
2097 8797b228 2019-08-04 stsp <tr>
2098 8797b228 2019-08-04 stsp <td>d</td>
2099 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2100 8797b228 2019-08-04 stsp </tr>
2101 8797b228 2019-08-04 stsp <tr>
2102 8797b228 2019-08-04 stsp <td>A</td>
2103 8797b228 2019-08-04 stsp <td>new file was added</td>
2104 8797b228 2019-08-04 stsp </tr>
2105 8797b228 2019-08-04 stsp <tr>
2106 8797b228 2019-08-04 stsp <td>~</td>
2107 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2108 8797b228 2019-08-04 stsp </tr>
2109 1554b334 2020-08-02 stsp <tr>
2110 1554b334 2020-08-02 stsp <td>?</td>
2111 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2112 1554b334 2020-08-02 stsp </tr>
2113 8797b228 2019-08-04 stsp </table>
2114 8797b228 2019-08-04 stsp <p class="Pp">The reverse-merged changes will appear as local changes in the
2115 8797b228 2019-08-04 stsp work tree, which may be viewed with <code class="Cm">got diff</code>,
2116 8797b228 2019-08-04 stsp amended manually or with further <code class="Cm">got backout</code>
2117 7985a487 2023-01-30 stsp commands, committed with <code class="Cm">got commit</code>.</p>
2118 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree where no
2119 7985a487 2023-01-30 stsp <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
2120 7985a487 2023-01-30 stsp <code class="Cm">merge</code> operation is taking place,
2121 7985a487 2023-01-30 stsp <code class="Cm">got backout</code> creates a record of commits which
2122 7985a487 2023-01-30 stsp have been reverse-merged into the work tree. When a file changed by
2123 7985a487 2023-01-30 stsp <code class="Cm">got backout</code> is committed with
2124 7985a487 2023-01-30 stsp <code class="Cm">got commit</code>, the log messages of relevant
2125 7985a487 2023-01-30 stsp reverse-merged commits will then appear in the editor, where the
2126 f6a6fa94 2023-02-22 stsp messages should be further adjusted to convey the reasons for backing
2127 f6a6fa94 2023-02-22 stsp out the changes. Upon exiting the editor, if the time stamp of the log
2128 f6a6fa94 2023-02-22 stsp message file is unchanged or the log message is empty,
2129 f6a6fa94 2023-02-22 stsp <code class="Cm">got commit</code> will fail with an unmodified or empty
2130 f6a6fa94 2023-02-22 stsp log message error.</p>
2131 f6a6fa94 2023-02-22 stsp <p class="Pp">If all the changes in all files touched by a given commit are
2132 f6a6fa94 2023-02-22 stsp discarded, e.g. with <code class="Cm">got revert</code>, this commit's
2133 f6a6fa94 2023-02-22 stsp log message record will also disappear.</p>
2134 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got backout</code> will refuse to run if
2135 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree contains multiple
2136 b078d5c4 2022-03-23 stsp base commits, it must first be updated to a single base commit with
2137 1e80276a 2021-09-03 stsp <code class="Cm">got update</code>. If any relevant files already
2138 1e80276a 2021-09-03 stsp contain merge conflicts, these conflicts must be resolved first.</p>
2139 7985a487 2023-01-30 stsp <p class="Pp">The options for <code class="Nm">got</code>
2140 7985a487 2023-01-30 stsp <code class="Cm">backout</code> are as follows:</p>
2141 7985a487 2023-01-30 stsp <dl class="Bl-tag">
2142 7985a487 2023-01-30 stsp <dt id="l~8"><a class="permalink" href="#l~8"><code class="Fl">-l</code></a></dt>
2143 7985a487 2023-01-30 stsp <dd>Display a list of commit log messages recorded by backout operations,
2144 7985a487 2023-01-30 stsp represented by references in the &#x201C;refs/got/worktree&#x201D;
2145 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2146 7985a487 2023-01-30 stsp only show the log message of the specified commit.
2147 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2148 7985a487 2023-01-30 stsp backout operations in the current work tree will be displayed.
2149 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be displayed irrespective of
2150 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2151 7985a487 2023-01-30 stsp with <code class="Fl">-X</code>.</p>
2152 7985a487 2023-01-30 stsp </dd>
2153 7985a487 2023-01-30 stsp <dt id="X~3"><a class="permalink" href="#X~3"><code class="Fl">-X</code></a></dt>
2154 7985a487 2023-01-30 stsp <dd>Delete log messages created by previous backout operations,
2155 7985a487 2023-01-30 stsp represented by references in the &#x201C;refs/got/worktree&#x201D;
2156 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2157 7985a487 2023-01-30 stsp only delete the log message of the specified commit.
2158 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2159 7985a487 2023-01-30 stsp backout operations in the current work tree will be deleted.
2160 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be deleted irrespective of
2161 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2162 7985a487 2023-01-30 stsp with <code class="Fl">-l</code>.</p>
2163 7985a487 2023-01-30 stsp </dd>
2164 7985a487 2023-01-30 stsp </dl>
2165 7985a487 2023-01-30 stsp <p class="Pp"></p>
2166 8797b228 2019-08-04 stsp </dd>
2167 63b69821 2021-10-16 stsp <dt id="rb"><a class="permalink" href="#rebase"><code class="Cm" id="rebase">rebase</code></a>
2168 f6a6fa94 2023-02-22 stsp [<code class="Fl">-aCclX</code>] [<var class="Ar">branch</var>]</dt>
2169 63b69821 2021-10-16 stsp <dd>
2170 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2171 46043f6f 2021-11-23 stsp <code class="Cm">rb</code>)</code></div>
2172 46043f6f 2021-11-23 stsp Rebase commits on the specified <var class="Ar">branch</var> onto the tip of
2173 46043f6f 2021-11-23 stsp the current branch of the work tree. The <var class="Ar">branch</var> must
2174 46043f6f 2021-11-23 stsp share common ancestry with the work tree's current branch. Rebasing begins
2175 46043f6f 2021-11-23 stsp with the first descendant commit of the youngest common ancestor commit
2176 46043f6f 2021-11-23 stsp shared by the specified <var class="Ar">branch</var> and the work tree's
2177 46043f6f 2021-11-23 stsp current branch, and stops once the tip commit of the specified
2178 8797b228 2019-08-04 stsp <var class="Ar">branch</var> has been rebased.
2179 7c3b4ab8 2020-02-25 stsp <p class="Pp">When <code class="Cm">got rebase</code> is used as intended,
2180 a43c0256 2020-02-25 stsp the specified <var class="Ar">branch</var> represents a local commit
2181 a43c0256 2020-02-25 stsp history and may already contain changes that are not yet visible in any
2182 a43c0256 2020-02-25 stsp other repositories. The work tree's current branch, which must be set
2183 a43c0256 2020-02-25 stsp with <code class="Cm">got update -b</code> before starting the
2184 a43c0256 2020-02-25 stsp <code class="Cm">rebase</code> operation, represents a branch from a
2185 a43c0256 2020-02-25 stsp remote repository which shares a common history with the specified
2186 a43c0256 2020-02-25 stsp <var class="Ar">branch</var> but has progressed, and perhaps diverged,
2187 a43c0256 2020-02-25 stsp due to commits added to the remote repository.</p>
2188 8797b228 2019-08-04 stsp <p class="Pp">Rebased commits are accumulated on a temporary branch which
2189 8797b228 2019-08-04 stsp the work tree will remain switched to throughout the entire rebase
2190 8797b228 2019-08-04 stsp operation. Commits on this branch represent the same changes with the
2191 8797b228 2019-08-04 stsp same log messages as their counterparts on the original
2192 8797b228 2019-08-04 stsp <var class="Ar">branch</var>, but with different commit IDs. Once
2193 8797b228 2019-08-04 stsp rebasing has completed successfully, the temporary branch becomes the
2194 8797b228 2019-08-04 stsp new version of the specified <var class="Ar">branch</var> and the work
2195 63657f42 2022-09-07 stsp tree is automatically switched to it. If author information is available
2196 63657f42 2022-09-07 stsp via the <code class="Ev">GOT_AUTHOR</code> environment variable,
2197 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2198 63657f42 2022-09-07 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2199 63657f42 2022-09-07 stsp configuration settings, this author information will be used to identify
2200 63657f42 2022-09-07 stsp the &#x201C;committer&#x201D; of rebased commits.</p>
2201 039953c9 2021-03-22 stsp <p class="Pp">Old commits in their pre-rebase state are automatically backed
2202 039953c9 2021-03-22 stsp up in the &#x201C;refs/got/backup/rebase&#x201D; reference namespace. As
2203 039953c9 2021-03-22 stsp long as these references are not removed older versions of rebased
2204 039953c9 2021-03-22 stsp commits will remain in the repository and can be viewed with the
2205 039953c9 2021-03-22 stsp <code class="Cm">got rebase -l</code> command. Removal of these
2206 039953c9 2021-03-22 stsp references makes objects which become unreachable via any reference
2207 16cd1323 2021-07-26 stsp subject to removal by Git's garbage collector or
2208 16cd1323 2021-07-26 stsp <code class="Cm">gotadmin cleanup</code>.</p>
2209 8797b228 2019-08-04 stsp <p class="Pp">While rebasing commits, show the status of each affected file,
2210 8797b228 2019-08-04 stsp using the following status codes:</p>
2211 8797b228 2019-08-04 stsp <table class="Bl-column">
2212 8797b228 2019-08-04 stsp <tr>
2213 8797b228 2019-08-04 stsp <td>G</td>
2214 8797b228 2019-08-04 stsp <td>file was merged</td>
2215 8797b228 2019-08-04 stsp </tr>
2216 8797b228 2019-08-04 stsp <tr>
2217 8797b228 2019-08-04 stsp <td>C</td>
2218 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2219 8797b228 2019-08-04 stsp </tr>
2220 8797b228 2019-08-04 stsp <tr>
2221 8797b228 2019-08-04 stsp <td>!</td>
2222 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2223 8797b228 2019-08-04 stsp </tr>
2224 8797b228 2019-08-04 stsp <tr>
2225 8797b228 2019-08-04 stsp <td>D</td>
2226 8797b228 2019-08-04 stsp <td>file was deleted</td>
2227 8797b228 2019-08-04 stsp </tr>
2228 8797b228 2019-08-04 stsp <tr>
2229 8797b228 2019-08-04 stsp <td>d</td>
2230 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2231 8797b228 2019-08-04 stsp </tr>
2232 8797b228 2019-08-04 stsp <tr>
2233 8797b228 2019-08-04 stsp <td>A</td>
2234 8797b228 2019-08-04 stsp <td>new file was added</td>
2235 8797b228 2019-08-04 stsp </tr>
2236 8797b228 2019-08-04 stsp <tr>
2237 8797b228 2019-08-04 stsp <td>~</td>
2238 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2239 8797b228 2019-08-04 stsp </tr>
2240 1554b334 2020-08-02 stsp <tr>
2241 1554b334 2020-08-02 stsp <td>?</td>
2242 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2243 1554b334 2020-08-02 stsp </tr>
2244 8797b228 2019-08-04 stsp </table>
2245 b078d5c4 2022-03-23 stsp <p class="Pp">If merge conflicts occur, the rebase operation is interrupted
2246 417cb057 2021-10-03 stsp and may be continued once conflicts have been resolved. If any files
2247 417cb057 2021-10-03 stsp with destined changes are found to be missing or unversioned, or if
2248 417cb057 2021-10-03 stsp files could not be deleted due to differences in deleted content, the
2249 417cb057 2021-10-03 stsp rebase operation will be interrupted to prevent potentially incomplete
2250 417cb057 2021-10-03 stsp changes from being committed to the repository without user
2251 417cb057 2021-10-03 stsp intervention. The work tree may be modified as desired and the rebase
2252 417cb057 2021-10-03 stsp operation can be continued once the changes present in the work tree are
2253 417cb057 2021-10-03 stsp considered complete. Alternatively, the rebase operation may be aborted
2254 417cb057 2021-10-03 stsp which will leave <var class="Ar">branch</var> unmodified and the work
2255 417cb057 2021-10-03 stsp tree switched back to its original branch.</p>
2256 8797b228 2019-08-04 stsp <p class="Pp">If a merge conflict is resolved in a way which renders the
2257 8797b228 2019-08-04 stsp merged change into a no-op change, the corresponding commit will be
2258 8797b228 2019-08-04 stsp elided when the rebase operation continues.</p>
2259 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got rebase</code> will refuse to run if
2260 63657f42 2022-09-07 stsp certain preconditions are not met. If the <var class="Ar">branch</var>
2261 63657f42 2022-09-07 stsp is not in the &#x201C;refs/heads/&#x201D; reference namespace, the
2262 63657f42 2022-09-07 stsp branch may not be rebased. If the work tree is not yet fully updated to
2263 63657f42 2022-09-07 stsp the tip commit of its branch, then the work tree must first be updated
2264 63657f42 2022-09-07 stsp with <code class="Cm">got update</code>. If changes have been staged
2265 63657f42 2022-09-07 stsp with <code class="Cm">got stage</code>, these changes must first be
2266 63657f42 2022-09-07 stsp committed with <code class="Cm">got commit</code> or unstaged with
2267 8797b228 2019-08-04 stsp <code class="Cm">got unstage</code>. If the work tree contains local
2268 8797b228 2019-08-04 stsp changes, these changes must first be committed with <code class="Cm">got
2269 8797b228 2019-08-04 stsp commit</code> or reverted with <code class="Cm">got revert</code>. If
2270 8797b228 2019-08-04 stsp the <var class="Ar">branch</var> contains changes to files outside of
2271 8797b228 2019-08-04 stsp the work tree's path prefix, the work tree cannot be used to rebase this
2272 8797b228 2019-08-04 stsp branch.</p>
2273 47f19dd5 2023-01-17 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2274 47f19dd5 2023-01-17 stsp integrate</code>, <code class="Cm">got merge</code>,
2275 47f19dd5 2023-01-17 stsp <code class="Cm">got commit</code>, and <code class="Cm">got
2276 47f19dd5 2023-01-17 stsp histedit</code> commands will refuse to run while a rebase operation is
2277 47f19dd5 2023-01-17 stsp in progress. Other commands which manipulate the work tree may be used
2278 47f19dd5 2023-01-17 stsp for conflict resolution purposes.</p>
2279 46043f6f 2021-11-23 stsp <p class="Pp">If the specified <var class="Ar">branch</var> is already based
2280 b078d5c4 2022-03-23 stsp on the work tree's current branch, then no commits need to be rebased
2281 b078d5c4 2022-03-23 stsp and <code class="Cm">got rebase</code> will simply switch the work tree
2282 b078d5c4 2022-03-23 stsp to the specified <var class="Ar">branch</var> and update files in the
2283 b078d5c4 2022-03-23 stsp work tree accordingly.</p>
2284 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got rebase</code> are as
2285 8797b228 2019-08-04 stsp follows:</p>
2286 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2287 def5be4a 2021-08-31 stsp <dt id="a~5"><a class="permalink" href="#a~5"><code class="Fl">-a</code></a></dt>
2288 8797b228 2019-08-04 stsp <dd>Abort an interrupted rebase operation. If this option is used, no
2289 9b0c768d 2019-08-08 stsp other command-line arguments are allowed.</dd>
2290 f6a6fa94 2023-02-22 stsp <dt id="C~4"><a class="permalink" href="#C~4"><code class="Fl">-C</code></a></dt>
2291 f6a6fa94 2023-02-22 stsp <dd>Allow a rebase operation to continue with files in conflicted status.
2292 f6a6fa94 2023-02-22 stsp This option should generally be avoided, and can only be used with the
2293 f6a6fa94 2023-02-22 stsp <code class="Fl">-c</code> option.</dd>
2294 63657f42 2022-09-07 stsp <dt id="c~11"><a class="permalink" href="#c~11"><code class="Fl">-c</code></a></dt>
2295 8797b228 2019-08-04 stsp <dd>Continue an interrupted rebase operation. If this option is used, no
2296 461d9094 2023-07-19 stsp other command-line arguments are allowed except
2297 461d9094 2023-07-19 stsp <code class="Fl">-C</code>.</dd>
2298 7985a487 2023-01-30 stsp <dt id="l~9"><a class="permalink" href="#l~9"><code class="Fl">-l</code></a></dt>
2299 039953c9 2021-03-22 stsp <dd>Show a list of past rebase operations, represented by references in
2300 039953c9 2021-03-22 stsp the &#x201C;refs/got/backup/rebase&#x201D; reference namespace.
2301 039953c9 2021-03-22 stsp <p class="Pp">Display the author, date, and log message of each backed
2302 039953c9 2021-03-22 stsp up commit, the object ID of the corresponding post-rebase commit,
2303 039953c9 2021-03-22 stsp and the object ID of their common ancestor commit. Given these
2304 039953c9 2021-03-22 stsp object IDs, the <code class="Cm">got log</code> command with the
2305 039953c9 2021-03-22 stsp <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2306 039953c9 2021-03-22 stsp can be used to examine the history of either version of the branch,
2307 039953c9 2021-03-22 stsp and the <code class="Cm">got branch</code> command with the
2308 039953c9 2021-03-22 stsp <code class="Fl">-c</code> option can be used to create a new branch
2309 039953c9 2021-03-22 stsp from a pre-rebase state if desired.</p>
2310 039953c9 2021-03-22 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2311 039953c9 2021-03-22 stsp commits which at some point in time represented this branch.
2312 039953c9 2021-03-22 stsp Otherwise, list all backed up commits for any branches.</p>
2313 039953c9 2021-03-22 stsp <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2314 039953c9 2021-03-22 stsp does not require a work tree. None of the other options can be used
2315 039953c9 2021-03-22 stsp together with <code class="Fl">-l</code>.</p>
2316 039953c9 2021-03-22 stsp </dd>
2317 7985a487 2023-01-30 stsp <dt id="X~4"><a class="permalink" href="#X~4"><code class="Fl">-X</code></a></dt>
2318 16cd1323 2021-07-26 stsp <dd>Delete backups created by past rebase operations, represented by
2319 16cd1323 2021-07-26 stsp references in the &#x201C;refs/got/backup/rebase&#x201D; reference
2320 16cd1323 2021-07-26 stsp namespace.
2321 16cd1323 2021-07-26 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2322 16cd1323 2021-07-26 stsp delete backups which at some point in time represented this branch.
2323 16cd1323 2021-07-26 stsp Otherwise, delete all references found within
2324 16cd1323 2021-07-26 stsp &#x201C;refs/got/backup/rebase&#x201D;.</p>
2325 16cd1323 2021-07-26 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2326 16cd1323 2021-07-26 stsp deleted backups remain in the repository and may be removed
2327 16cd1323 2021-07-26 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
2328 16cd1323 2021-07-26 stsp cleanup</code>.</p>
2329 16cd1323 2021-07-26 stsp <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2330 16cd1323 2021-07-26 stsp does not require a work tree. None of the other options can be used
2331 16cd1323 2021-07-26 stsp together with <code class="Fl">-X</code>.</p>
2332 16cd1323 2021-07-26 stsp </dd>
2333 8797b228 2019-08-04 stsp </dl>
2334 8797b228 2019-08-04 stsp </dd>
2335 63b69821 2021-10-16 stsp <dt id="he"><a class="permalink" href="#histedit"><code class="Cm" id="histedit">histedit</code></a>
2336 f6a6fa94 2023-02-22 stsp [<code class="Fl">-aCcdeflmX</code>] [<code class="Fl">-F</code>
2337 63657f42 2022-09-07 stsp <var class="Ar">histedit-script</var>] [<var class="Ar">branch</var>]</dt>
2338 63b69821 2021-10-16 stsp <dd>
2339 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2340 46043f6f 2021-11-23 stsp <code class="Cm">he</code>)</code></div>
2341 46043f6f 2021-11-23 stsp Edit commit history between the work tree's current base commit and the tip
2342 46043f6f 2021-11-23 stsp commit of the work tree's current branch.
2343 63657f42 2022-09-07 stsp <p class="Pp">The <code class="Cm">got histedit</code> command requires the
2344 63657f42 2022-09-07 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
2345 63657f42 2022-09-07 stsp unless an author has been configured in
2346 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2347 63657f42 2022-09-07 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2348 63657f42 2022-09-07 stsp configuration settings can be obtained from the repository's
2349 63657f42 2022-09-07 stsp <span class="Pa">.git/config</span> file or from Git's global
2350 63657f42 2022-09-07 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
2351 b078d5c4 2022-03-23 stsp <p class="Pp">Before starting a <code class="Cm">histedit</code> operation,
2352 7c3b4ab8 2020-02-25 stsp the work tree's current branch must be set with <code class="Cm">got
2353 7c3b4ab8 2020-02-25 stsp update -b</code> to the branch which should be edited, unless this
2354 7c3b4ab8 2020-02-25 stsp branch is already the current branch of the work tree. The tip of this
2355 7c3b4ab8 2020-02-25 stsp branch represents the upper bound (inclusive) of commits touched by the
2356 7c3b4ab8 2020-02-25 stsp <code class="Cm">histedit</code> operation.</p>
2357 7c3b4ab8 2020-02-25 stsp <p class="Pp">Furthermore, the work tree's base commit must be set with
2358 7c3b4ab8 2020-02-25 stsp <code class="Cm">got update -c</code> to a point in this branch's commit
2359 7c3b4ab8 2020-02-25 stsp history where editing should begin. This commit represents the lower
2360 7c3b4ab8 2020-02-25 stsp bound (non-inclusive) of commits touched by the
2361 7c3b4ab8 2020-02-25 stsp <code class="Cm">histedit</code> operation.</p>
2362 8797b228 2019-08-04 stsp <p class="Pp">Editing of commit history is controlled via a
2363 7c3b4ab8 2020-02-25 stsp <var class="Ar">histedit script</var> which can be written in an editor
2364 7c3b4ab8 2020-02-25 stsp based on a template, passed on the command line, or generated with the
2365 297acb86 2023-03-07 stsp <code class="Fl">-d</code>, <code class="Fl">-e</code>,
2366 461d9094 2023-07-19 stsp <code class="Fl">-f</code>, or <code class="Fl">-m</code> options.
2367 461d9094 2023-07-19 stsp Quitting the editor without saving the file will abort the histedit
2368 461d9094 2023-07-19 stsp operation.</p>
2369 7c3b4ab8 2020-02-25 stsp <p class="Pp">The format of the histedit script is line-based. Each line in
2370 7c3b4ab8 2020-02-25 stsp the script begins with a command name, followed by whitespace and an
2371 7c3b4ab8 2020-02-25 stsp argument. For most commands, the expected argument is a commit ID SHA1
2372 7c3b4ab8 2020-02-25 stsp hash. Any remaining text on the line is ignored. Lines which begin with
2373 7c3b4ab8 2020-02-25 stsp the &#x2018;#&#x2019; character are ignored entirely.</p>
2374 51683866 2022-07-14 stsp <p class="Pp">The available histedit script commands are as follows:</p>
2375 8797b228 2019-08-04 stsp <table class="Bl-column">
2376 51683866 2022-07-14 stsp <tr id="pick">
2377 51683866 2022-07-14 stsp <td><a class="permalink" href="#pick"><code class="Cm">pick</code></a>
2378 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2379 8797b228 2019-08-04 stsp <td>Use the specified commit as it is.</td>
2380 8797b228 2019-08-04 stsp </tr>
2381 51683866 2022-07-14 stsp <tr id="edit">
2382 51683866 2022-07-14 stsp <td><a class="permalink" href="#edit"><code class="Cm">edit</code></a>
2383 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2384 297acb86 2023-03-07 stsp <td>Apply the changes from the specified commit, but then interrupt the
2385 297acb86 2023-03-07 stsp histedit operation for amending, without creating a commit. While the
2386 297acb86 2023-03-07 stsp histedit operation is interrupted arbitrary files may be edited, and
2387 297acb86 2023-03-07 stsp commands which manipulate the work tree can be used freely. The
2388 297acb86 2023-03-07 stsp <code class="Cm">got add</code> and <code class="Cm">got remove</code>
2389 297acb86 2023-03-07 stsp commands can be used to add new files or remove existing ones. The
2390 297acb86 2023-03-07 stsp <code class="Cm">got revert -p</code> command can be used to eliminate
2391 297acb86 2023-03-07 stsp arbitrary changes from files in the work tree. The
2392 297acb86 2023-03-07 stsp <code class="Cm">got stage -p</code> command may be used to prepare a
2393 297acb86 2023-03-07 stsp subset of changes for inclusion in the next commit. Finally, the
2394 297acb86 2023-03-07 stsp <code class="Cm">got commit</code> command can be used to insert
2395 297acb86 2023-03-07 stsp arbitrary commits into the edited history. Regular editing of history
2396 297acb86 2023-03-07 stsp must eventually be resumed by running <code class="Cm">got histedit
2397 297acb86 2023-03-07 stsp -c</code>.</td>
2398 8797b228 2019-08-04 stsp </tr>
2399 51683866 2022-07-14 stsp <tr id="fold">
2400 51683866 2022-07-14 stsp <td><a class="permalink" href="#fold"><code class="Cm">fold</code></a>
2401 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2402 8797b228 2019-08-04 stsp <td>Combine the specified commit with the next commit listed further
2403 8797b228 2019-08-04 stsp below that will be used.</td>
2404 8797b228 2019-08-04 stsp </tr>
2405 51683866 2022-07-14 stsp <tr id="drop">
2406 51683866 2022-07-14 stsp <td><a class="permalink" href="#drop"><code class="Cm">drop</code></a>
2407 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2408 8797b228 2019-08-04 stsp <td>Remove this commit from the edited history.</td>
2409 8797b228 2019-08-04 stsp </tr>
2410 51683866 2022-07-14 stsp <tr id="mesg">
2411 51683866 2022-07-14 stsp <td><a class="permalink" href="#mesg"><code class="Cm">mesg</code></a>
2412 c8cf51c9 2023-11-29 stsp <var class="Ar">commit</var></td>
2413 c8cf51c9 2023-11-29 stsp <td>Open an editor to create a new log message for this commit.</td>
2414 8797b228 2019-08-04 stsp </tr>
2415 8797b228 2019-08-04 stsp </table>
2416 8797b228 2019-08-04 stsp <p class="Pp">Every commit in the history being edited must be mentioned in
2417 8797b228 2019-08-04 stsp the script. Lines may be re-ordered to change the order of commits in
2418 ae803b74 2020-03-06 stsp the edited history. No commit may be listed more than once.</p>
2419 8797b228 2019-08-04 stsp <p class="Pp">Edited commits are accumulated on a temporary branch which the
2420 8797b228 2019-08-04 stsp work tree will remain switched to throughout the entire histedit
2421 8797b228 2019-08-04 stsp operation. Once history editing has completed successfully, the
2422 8797b228 2019-08-04 stsp temporary branch becomes the new version of the work tree's branch and
2423 8797b228 2019-08-04 stsp the work tree is automatically switched to it.</p>
2424 039953c9 2021-03-22 stsp <p class="Pp">Old commits in their pre-histedit state are automatically
2425 039953c9 2021-03-22 stsp backed up in the &#x201C;refs/got/backup/histedit&#x201D; reference
2426 039953c9 2021-03-22 stsp namespace. As long as these references are not removed older versions of
2427 039953c9 2021-03-22 stsp edited commits will remain in the repository and can be viewed with the
2428 039953c9 2021-03-22 stsp <code class="Cm">got histedit -l</code> command. Removal of these
2429 039953c9 2021-03-22 stsp references makes objects which become unreachable via any reference
2430 16cd1323 2021-07-26 stsp subject to removal by Git's garbage collector or
2431 16cd1323 2021-07-26 stsp <code class="Cm">gotadmin cleanup</code>.</p>
2432 8797b228 2019-08-04 stsp <p class="Pp">While merging commits, show the status of each affected file,
2433 8797b228 2019-08-04 stsp using the following status codes:</p>
2434 8797b228 2019-08-04 stsp <table class="Bl-column">
2435 8797b228 2019-08-04 stsp <tr>
2436 8797b228 2019-08-04 stsp <td>G</td>
2437 8797b228 2019-08-04 stsp <td>file was merged</td>
2438 8797b228 2019-08-04 stsp </tr>
2439 8797b228 2019-08-04 stsp <tr>
2440 8797b228 2019-08-04 stsp <td>C</td>
2441 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2442 8797b228 2019-08-04 stsp </tr>
2443 8797b228 2019-08-04 stsp <tr>
2444 8797b228 2019-08-04 stsp <td>!</td>
2445 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2446 8797b228 2019-08-04 stsp </tr>
2447 8797b228 2019-08-04 stsp <tr>
2448 8797b228 2019-08-04 stsp <td>D</td>
2449 8797b228 2019-08-04 stsp <td>file was deleted</td>
2450 8797b228 2019-08-04 stsp </tr>
2451 8797b228 2019-08-04 stsp <tr>
2452 8797b228 2019-08-04 stsp <td>d</td>
2453 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2454 8797b228 2019-08-04 stsp </tr>
2455 8797b228 2019-08-04 stsp <tr>
2456 8797b228 2019-08-04 stsp <td>A</td>
2457 8797b228 2019-08-04 stsp <td>new file was added</td>
2458 8797b228 2019-08-04 stsp </tr>
2459 8797b228 2019-08-04 stsp <tr>
2460 8797b228 2019-08-04 stsp <td>~</td>
2461 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2462 8797b228 2019-08-04 stsp </tr>
2463 1554b334 2020-08-02 stsp <tr>
2464 1554b334 2020-08-02 stsp <td>?</td>
2465 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2466 1554b334 2020-08-02 stsp </tr>
2467 8797b228 2019-08-04 stsp </table>
2468 b078d5c4 2022-03-23 stsp <p class="Pp">If merge conflicts occur, the histedit operation is
2469 b078d5c4 2022-03-23 stsp interrupted and may be continued once conflicts have been resolved. If
2470 b078d5c4 2022-03-23 stsp any files with destined changes are found to be missing or unversioned,
2471 b078d5c4 2022-03-23 stsp or if files could not be deleted due to differences in deleted content,
2472 b078d5c4 2022-03-23 stsp the histedit operation will be interrupted to prevent potentially
2473 b078d5c4 2022-03-23 stsp incomplete changes from being committed to the repository without user
2474 417cb057 2021-10-03 stsp intervention. The work tree may be modified as desired and the histedit
2475 417cb057 2021-10-03 stsp operation can be continued once the changes present in the work tree are
2476 417cb057 2021-10-03 stsp considered complete. Alternatively, the histedit operation may be
2477 417cb057 2021-10-03 stsp aborted which will leave the work tree switched back to its original
2478 417cb057 2021-10-03 stsp branch.</p>
2479 8797b228 2019-08-04 stsp <p class="Pp">If a merge conflict is resolved in a way which renders the
2480 8797b228 2019-08-04 stsp merged change into a no-op change, the corresponding commit will be
2481 8797b228 2019-08-04 stsp elided when the histedit operation continues.</p>
2482 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got histedit</code> will refuse to run if
2483 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree's current branch is
2484 8797b228 2019-08-04 stsp not in the &#x201C;refs/heads/&#x201D; reference namespace, the history
2485 8797b228 2019-08-04 stsp of the branch may not be edited. If the work tree contains multiple base
2486 b078d5c4 2022-03-23 stsp commits, it must first be updated to a single base commit with
2487 8797b228 2019-08-04 stsp <code class="Cm">got update</code>. If changes have been staged with
2488 91b3da3f 2019-08-18 stsp <code class="Cm">got stage</code>, these changes must first be committed
2489 8797b228 2019-08-04 stsp with <code class="Cm">got commit</code> or unstaged with
2490 8797b228 2019-08-04 stsp <code class="Cm">got unstage</code>. If the work tree contains local
2491 8797b228 2019-08-04 stsp changes, these changes must first be committed with <code class="Cm">got
2492 8797b228 2019-08-04 stsp commit</code> or reverted with <code class="Cm">got revert</code>. If
2493 8797b228 2019-08-04 stsp the edited history contains changes to files outside of the work tree's
2494 8797b228 2019-08-04 stsp path prefix, the work tree cannot be used to edit the history of this
2495 8797b228 2019-08-04 stsp branch.</p>
2496 7c3b4ab8 2020-02-25 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2497 47f19dd5 2023-01-17 stsp rebase</code>, <code class="Cm">got merge</code>, and
2498 47f19dd5 2023-01-17 stsp <code class="Cm">got integrate</code> commands will refuse to run while
2499 47f19dd5 2023-01-17 stsp a histedit operation is in progress. Other commands which manipulate the
2500 47f19dd5 2023-01-17 stsp work tree may be used, and the <code class="Cm">got commit</code>
2501 47f19dd5 2023-01-17 stsp command may be used to commit arbitrary changes to the temporary branch
2502 47f19dd5 2023-01-17 stsp while the histedit operation is interrupted.</p>
2503 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got histedit</code> are as
2504 8797b228 2019-08-04 stsp follows:</p>
2505 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2506 def5be4a 2021-08-31 stsp <dt id="a~6"><a class="permalink" href="#a~6"><code class="Fl">-a</code></a></dt>
2507 8797b228 2019-08-04 stsp <dd>Abort an interrupted histedit operation. If this option is used, no
2508 9b0c768d 2019-08-08 stsp other command-line arguments are allowed.</dd>
2509 f6a6fa94 2023-02-22 stsp <dt id="C~5"><a class="permalink" href="#C~5"><code class="Fl">-C</code></a></dt>
2510 f6a6fa94 2023-02-22 stsp <dd>Allow a histedit operation to continue with files in conflicted
2511 f6a6fa94 2023-02-22 stsp status. This option should generally be avoided, and can only be used
2512 f6a6fa94 2023-02-22 stsp with the <code class="Fl">-c</code> option.</dd>
2513 63657f42 2022-09-07 stsp <dt id="c~12"><a class="permalink" href="#c~12"><code class="Fl">-c</code></a></dt>
2514 8797b228 2019-08-04 stsp <dd>Continue an interrupted histedit operation. If this option is used, no
2515 461d9094 2023-07-19 stsp other command-line arguments are allowed except
2516 461d9094 2023-07-19 stsp <code class="Fl">-C</code>.</dd>
2517 f6a6fa94 2023-02-22 stsp <dt id="d~7"><a class="permalink" href="#d~7"><code class="Fl">-d</code></a></dt>
2518 f6a6fa94 2023-02-22 stsp <dd>Drop all commits. This option is a quick equivalent to a histedit
2519 f6a6fa94 2023-02-22 stsp script which drops all commits. The <code class="Fl">-d</code> option
2520 f6a6fa94 2023-02-22 stsp can only be used when starting a new histedit operation. If this
2521 f6a6fa94 2023-02-22 stsp option is used, no other command-line arguments are allowed.</dd>
2522 417cb057 2021-10-03 stsp <dt id="e"><a class="permalink" href="#e"><code class="Fl">-e</code></a></dt>
2523 417cb057 2021-10-03 stsp <dd>Interrupt the histedit operation for editing after merging each
2524 417cb057 2021-10-03 stsp commit. This option is a quick equivalent to a histedit script which
2525 417cb057 2021-10-03 stsp uses the <code class="Cm">edit</code> command for all commits. The
2526 417cb057 2021-10-03 stsp <code class="Fl">-e</code> option can only be used when starting a new
2527 417cb057 2021-10-03 stsp histedit operation. If this option is used, no other command-line
2528 417cb057 2021-10-03 stsp arguments are allowed.</dd>
2529 039953c9 2021-03-22 stsp <dt id="F~3"><a class="permalink" href="#F~3"><code class="Fl">-F</code></a>
2530 7c3b4ab8 2020-02-25 stsp <var class="Ar">histedit-script</var></dt>
2531 7c3b4ab8 2020-02-25 stsp <dd>Use the specified <var class="Ar">histedit-script</var> instead of
2532 7c3b4ab8 2020-02-25 stsp opening a temporary file in an editor where a histedit script can be
2533 7c3b4ab8 2020-02-25 stsp written.</dd>
2534 63657f42 2022-09-07 stsp <dt id="f~3"><a class="permalink" href="#f~3"><code class="Fl">-f</code></a></dt>
2535 63657f42 2022-09-07 stsp <dd>Fold all commits into a single commit. This option is a quick
2536 63657f42 2022-09-07 stsp equivalent to a histedit script which folds all commits, combining
2537 63657f42 2022-09-07 stsp them all into one commit. The <code class="Fl">-f</code> option can
2538 7c3b4ab8 2020-02-25 stsp only be used when starting a new histedit operation. If this option is
2539 7c3b4ab8 2020-02-25 stsp used, no other command-line arguments are allowed.</dd>
2540 7985a487 2023-01-30 stsp <dt id="l~10"><a class="permalink" href="#l~10"><code class="Fl">-l</code></a></dt>
2541 039953c9 2021-03-22 stsp <dd>Show a list of past histedit operations, represented by references in
2542 039953c9 2021-03-22 stsp the &#x201C;refs/got/backup/histedit&#x201D; reference namespace.
2543 039953c9 2021-03-22 stsp <p class="Pp">Display the author, date, and log message of each backed
2544 039953c9 2021-03-22 stsp up commit, the object ID of the corresponding post-histedit commit,
2545 039953c9 2021-03-22 stsp and the object ID of their common ancestor commit. Given these
2546 039953c9 2021-03-22 stsp object IDs, the <code class="Cm">got log</code> command with the
2547 039953c9 2021-03-22 stsp <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2548 039953c9 2021-03-22 stsp can be used to examine the history of either version of the branch,
2549 039953c9 2021-03-22 stsp and the <code class="Cm">got branch</code> command with the
2550 039953c9 2021-03-22 stsp <code class="Fl">-c</code> option can be used to create a new branch
2551 039953c9 2021-03-22 stsp from a pre-histedit state if desired.</p>
2552 039953c9 2021-03-22 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2553 039953c9 2021-03-22 stsp commits which at some point in time represented this branch.
2554 039953c9 2021-03-22 stsp Otherwise, list all backed up commits for any branches.</p>
2555 039953c9 2021-03-22 stsp <p class="Pp">If this option is used, <code class="Cm">got
2556 039953c9 2021-03-22 stsp histedit</code> does not require a work tree. None of the other
2557 039953c9 2021-03-22 stsp options can be used together with <code class="Fl">-l</code>.</p>
2558 16cd1323 2021-07-26 stsp </dd>
2559 63657f42 2022-09-07 stsp <dt id="m~5"><a class="permalink" href="#m~5"><code class="Fl">-m</code></a></dt>
2560 63657f42 2022-09-07 stsp <dd>Edit log messages only. This option is a quick equivalent to a
2561 63657f42 2022-09-07 stsp histedit script which edits only log messages but otherwise leaves
2562 63657f42 2022-09-07 stsp every picked commit as-is. The <code class="Fl">-m</code> option can
2563 63657f42 2022-09-07 stsp only be used when starting a new histedit operation. If this option is
2564 63657f42 2022-09-07 stsp used, no other command-line arguments are allowed.</dd>
2565 7985a487 2023-01-30 stsp <dt id="X~5"><a class="permalink" href="#X~5"><code class="Fl">-X</code></a></dt>
2566 16cd1323 2021-07-26 stsp <dd>Delete backups created by past histedit operations, represented by
2567 16cd1323 2021-07-26 stsp references in the &#x201C;refs/got/backup/histedit&#x201D; reference
2568 16cd1323 2021-07-26 stsp namespace.
2569 16cd1323 2021-07-26 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2570 16cd1323 2021-07-26 stsp delete backups which at some point in time represented this branch.
2571 16cd1323 2021-07-26 stsp Otherwise, delete all references found within
2572 16cd1323 2021-07-26 stsp &#x201C;refs/got/backup/histedit&#x201D;.</p>
2573 16cd1323 2021-07-26 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2574 16cd1323 2021-07-26 stsp deleted backups remain in the repository and may be removed
2575 16cd1323 2021-07-26 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
2576 16cd1323 2021-07-26 stsp cleanup</code>.</p>
2577 16cd1323 2021-07-26 stsp <p class="Pp">If this option is used, <code class="Cm">got
2578 16cd1323 2021-07-26 stsp histedit</code> does not require a work tree. None of the other
2579 16cd1323 2021-07-26 stsp options can be used together with <code class="Fl">-X</code>.</p>
2580 039953c9 2021-03-22 stsp </dd>
2581 8797b228 2019-08-04 stsp </dl>
2582 8797b228 2019-08-04 stsp </dd>
2583 63b69821 2021-10-16 stsp <dt id="ig"><a class="permalink" href="#integrate"><code class="Cm" id="integrate">integrate</code></a>
2584 d8e62599 2019-10-21 stsp <var class="Ar">branch</var></dt>
2585 63b69821 2021-10-16 stsp <dd>
2586 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2587 46043f6f 2021-11-23 stsp <code class="Cm">ig</code>)</code></div>
2588 46043f6f 2021-11-23 stsp Integrate the specified <var class="Ar">branch</var> into the work tree's
2589 d8e62599 2019-10-21 stsp current branch. Files in the work tree are updated to match the contents
2590 d8e62599 2019-10-21 stsp on the integrated <var class="Ar">branch</var>, and the reference of the
2591 d8e62599 2019-10-21 stsp work tree's branch is changed to point at the head commit of the
2592 d8e62599 2019-10-21 stsp integrated <var class="Ar">branch</var>.
2593 d8e62599 2019-10-21 stsp <p class="Pp">Both branches can be considered equivalent after integration
2594 d8e62599 2019-10-21 stsp since they will be pointing at the same commit. Both branches remain
2595 d8e62599 2019-10-21 stsp available for future work, if desired. In case the integrated
2596 d8e62599 2019-10-21 stsp <var class="Ar">branch</var> is no longer needed it may be deleted with
2597 d8e62599 2019-10-21 stsp <code class="Cm">got branch -d</code>.</p>
2598 d8e62599 2019-10-21 stsp <p class="Pp">Show the status of each affected file, using the following
2599 d8e62599 2019-10-21 stsp status codes:</p>
2600 d8e62599 2019-10-21 stsp <table class="Bl-column">
2601 d8e62599 2019-10-21 stsp <tr>
2602 d8e62599 2019-10-21 stsp <td>U</td>
2603 d8e62599 2019-10-21 stsp <td>file was updated</td>
2604 d8e62599 2019-10-21 stsp </tr>
2605 d8e62599 2019-10-21 stsp <tr>
2606 d8e62599 2019-10-21 stsp <td>D</td>
2607 d8e62599 2019-10-21 stsp <td>file was deleted</td>
2608 d8e62599 2019-10-21 stsp </tr>
2609 d8e62599 2019-10-21 stsp <tr>
2610 d8e62599 2019-10-21 stsp <td>A</td>
2611 d8e62599 2019-10-21 stsp <td>new file was added</td>
2612 d8e62599 2019-10-21 stsp </tr>
2613 d8e62599 2019-10-21 stsp <tr>
2614 d8e62599 2019-10-21 stsp <td>~</td>
2615 d8e62599 2019-10-21 stsp <td>versioned file is obstructed by a non-regular file</td>
2616 d8e62599 2019-10-21 stsp </tr>
2617 d8e62599 2019-10-21 stsp <tr>
2618 d8e62599 2019-10-21 stsp <td>!</td>
2619 d8e62599 2019-10-21 stsp <td>a missing versioned file was restored</td>
2620 d8e62599 2019-10-21 stsp </tr>
2621 d8e62599 2019-10-21 stsp </table>
2622 d8e62599 2019-10-21 stsp <p class="Pp"><code class="Cm">got integrate</code> will refuse to run if
2623 d8e62599 2019-10-21 stsp certain preconditions are not met. Most importantly, the
2624 d8e62599 2019-10-21 stsp <var class="Ar">branch</var> must have been rebased onto the work tree's
2625 d8e62599 2019-10-21 stsp current branch with <code class="Cm">got rebase</code> before it can be
2626 d8e62599 2019-10-21 stsp integrated, in order to linearize commit history and resolve merge
2627 b078d5c4 2022-03-23 stsp conflicts. If the work tree contains multiple base commits, it must
2628 b078d5c4 2022-03-23 stsp first be updated to a single base commit with <code class="Cm">got
2629 d8e62599 2019-10-21 stsp update</code>. If changes have been staged with <code class="Cm">got
2630 d8e62599 2019-10-21 stsp stage</code>, these changes must first be committed with
2631 d8e62599 2019-10-21 stsp <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
2632 d8e62599 2019-10-21 stsp unstage</code>. If the work tree contains local changes, these changes
2633 d8e62599 2019-10-21 stsp must first be committed with <code class="Cm">got commit</code> or
2634 d8e62599 2019-10-21 stsp reverted with <code class="Cm">got revert</code>.</p>
2635 d8e62599 2019-10-21 stsp </dd>
2636 63b69821 2021-10-16 stsp <dt id="mg"><a class="permalink" href="#merge"><code class="Cm" id="merge">merge</code></a>
2637 461d9094 2023-07-19 stsp [<code class="Fl">-aCcMn</code>] [<var class="Ar">branch</var>]</dt>
2638 63b69821 2021-10-16 stsp <dd>
2639 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2640 46043f6f 2021-11-23 stsp <code class="Cm">mg</code>)</code></div>
2641 41ae98c9 2023-06-23 stsp Merge the specified <var class="Ar">branch</var> into the current branch of
2642 c8cf51c9 2023-11-29 stsp the work tree. If the branches have diverged, merge changes into the work
2643 c8cf51c9 2023-11-29 stsp tree and create a merge commit. Otherwise, if the specified
2644 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> is already based on the work tree's current
2645 c8cf51c9 2023-11-29 stsp branch, make the work tree's current branch equivalent to the specified
2646 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> and update files in the work tree
2647 c8cf51c9 2023-11-29 stsp accordingly.
2648 417cb057 2021-10-03 stsp <p class="Pp">Merge commits are commits based on multiple parent commits.
2649 c8cf51c9 2023-11-29 stsp The tip commit of the work tree's current branch will be used as the
2650 c8cf51c9 2023-11-29 stsp first parent. The tip commit of the specified
2651 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> will be used as the second parent. The work
2652 c8cf51c9 2023-11-29 stsp tree's current branch must be in the &#x201C;refs/heads/&#x201D;
2653 c8cf51c9 2023-11-29 stsp reference namespace and can be set with <code class="Cm">got update
2654 c8cf51c9 2023-11-29 stsp -b</code> before starting the <code class="Cm">merge</code>
2655 c8cf51c9 2023-11-29 stsp operation.</p>
2656 417cb057 2021-10-03 stsp <p class="Pp">No ancestral relationship between the two branches is
2657 417cb057 2021-10-03 stsp required. If the two branches have already been merged previously, only
2658 417cb057 2021-10-03 stsp new changes will be merged.</p>
2659 417cb057 2021-10-03 stsp <p class="Pp">It is not possible to create merge commits with more than two
2660 417cb057 2021-10-03 stsp parents. If more than one branch needs to be merged, then multiple merge
2661 417cb057 2021-10-03 stsp commits with two parents each can be created in sequence.</p>
2662 c8cf51c9 2023-11-29 stsp <p class="Pp">If a linear project history is desired, then use of
2663 c8cf51c9 2023-11-29 stsp <code class="Cm">got rebase</code> should generally be preferred over
2664 c8cf51c9 2023-11-29 stsp <code class="Cm">got merge</code>. However, even strictly linear
2665 c8cf51c9 2023-11-29 stsp projects may require occasional merge commits, for example in order to
2666 c8cf51c9 2023-11-29 stsp merge in new versions of third-party code stored on