1 8797b228 2019-08-04 stsp <!DOCTYPE html>
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>
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
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.
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.
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> —
33 63657f42 2022-09-07 stsp <span class="Nd" role="doc-subtitle">Game of Trees</span></p>
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">
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>
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 “distributed”
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
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 8797b228 2019-08-04 stsp <p class="Pp"><code class="Nm">got</code> provides global and command-specific
63 91b3da3f 2019-08-18 stsp options. Global options must precede the command name, and are as
64 8797b228 2019-08-04 stsp 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>
72 8797b228 2019-08-04 stsp <p class="Pp">The commands for <code class="Nm">got</code> are as follows:</p>
73 8797b228 2019-08-04 stsp <dl class="Bl-tag">
74 63b69821 2021-10-16 stsp <dt id="im"><a class="permalink" href="#import"><code class="Cm" id="import">import</code></a>
75 8797b228 2019-08-04 stsp [<code class="Fl">-b</code> <var class="Ar">branch</var>]
76 63657f42 2022-09-07 stsp [<code class="Fl">-I</code> <var class="Ar">pattern</var>]
77 8797b228 2019-08-04 stsp [<code class="Fl">-m</code> <var class="Ar">message</var>]
78 8797b228 2019-08-04 stsp [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
79 8797b228 2019-08-04 stsp <var class="Ar">directory</var></dt>
81 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
82 46043f6f 2021-11-23 stsp <code class="Cm">im</code>)</code></div>
83 46043f6f 2021-11-23 stsp Create an initial commit in a repository from the file hierarchy within the
84 46043f6f 2021-11-23 stsp specified <var class="Ar">directory</var>. The created commit will not
85 8797b228 2019-08-04 stsp have any parent commits, i.e. it will be a root commit. Also create a new
86 8797b228 2019-08-04 stsp reference which provides a branch name for the newly created commit. Show
87 8797b228 2019-08-04 stsp the path of each imported file to indicate progress.
88 8797b228 2019-08-04 stsp <p class="Pp">The <code class="Cm">got import</code> command requires the
89 c2a52be5 2019-09-08 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
90 376d4d52 2022-07-04 stsp unless an author has been configured in
91 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
92 376d4d52 2022-07-04 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
93 376d4d52 2022-07-04 stsp configuration settings can be obtained from the repository's
94 376d4d52 2022-07-04 stsp <span class="Pa">.git/config</span> file or from Git's global
95 376d4d52 2022-07-04 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
96 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got import</code> are as
97 8797b228 2019-08-04 stsp follows:</p>
98 8797b228 2019-08-04 stsp <dl class="Bl-tag">
99 2dbbbc3a 2020-07-23 stsp <dt id="b"><a class="permalink" href="#b"><code class="Fl">-b</code></a>
100 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
101 3cde8558 2022-09-23 stsp <dd>Create the specified <var class="Ar">branch</var>. If this option is
102 3cde8558 2022-09-23 stsp not specified, a branch corresponding to the repository's HEAD
103 3cde8558 2022-09-23 stsp reference will be used. Use of this option is required if the branch
104 3cde8558 2022-09-23 stsp resolved via the repository's HEAD reference already exists.</dd>
105 63657f42 2022-09-07 stsp <dt id="I"><a class="permalink" href="#I"><code class="Fl">-I</code></a>
106 63657f42 2022-09-07 stsp <var class="Ar">pattern</var></dt>
107 63657f42 2022-09-07 stsp <dd>Ignore files or directories with a name which matches the specified
108 63657f42 2022-09-07 stsp <var class="Ar">pattern</var>. This option may be specified multiple
109 63657f42 2022-09-07 stsp times to build a list of ignore patterns. The
110 63657f42 2022-09-07 stsp <var class="Ar">pattern</var> follows the globbing rules documented in
111 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="glob, section 7">glob(7)</a>. Ignore
112 f6a6fa94 2023-02-22 stsp patterns which end with a slash, “/”, will only match
113 f6a6fa94 2023-02-22 stsp directories.</dd>
114 2dbbbc3a 2020-07-23 stsp <dt id="m"><a class="permalink" href="#m"><code class="Fl">-m</code></a>
115 8797b228 2019-08-04 stsp <var class="Ar">message</var></dt>
116 8797b228 2019-08-04 stsp <dd>Use the specified log message when creating the new commit. Without
117 8797b228 2019-08-04 stsp the <code class="Fl">-m</code> option, <code class="Cm">got
118 8797b228 2019-08-04 stsp import</code> opens a temporary file in an editor where a log message
119 461d9094 2023-07-19 stsp can be written. Quitting the editor without saving the file will abort
120 461d9094 2023-07-19 stsp the import operation.</dd>
121 2dbbbc3a 2020-07-23 stsp <dt id="r"><a class="permalink" href="#r"><code class="Fl">-r</code></a>
122 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
123 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
124 8797b228 2019-08-04 stsp repository is located at or above the current working directory.</dd>
127 63b69821 2021-10-16 stsp <dt id="cl"><a class="permalink" href="#clone"><code class="Cm" id="clone">clone</code></a>
128 63657f42 2022-09-07 stsp [<code class="Fl">-almqv</code>] [<code class="Fl">-b</code>
129 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-R</code>
130 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var>] <var class="Ar">repository-URL</var>
131 b213cbf7 2020-03-23 stsp [<var class="Ar">directory</var>]</dt>
133 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
134 46043f6f 2021-11-23 stsp <code class="Cm">cl</code>)</code></div>
135 46043f6f 2021-11-23 stsp Clone a Git repository at the specified <var class="Ar">repository-URL</var>
136 46043f6f 2021-11-23 stsp into the specified <var class="Ar">directory</var>. If no
137 b078d5c4 2022-03-23 stsp <var class="Ar">directory</var> is specified, the directory name will be
138 46043f6f 2021-11-23 stsp derived from the name of the cloned repository. <code class="Cm">got
139 46043f6f 2021-11-23 stsp clone</code> will refuse to run if the <var class="Ar">directory</var>
140 46043f6f 2021-11-23 stsp already exists.
141 b213cbf7 2020-03-23 stsp <p class="Pp">The <var class="Ar">repository-URL</var> specifies a protocol
142 b213cbf7 2020-03-23 stsp scheme, a server hostname, an optional port number separated from the
143 b213cbf7 2020-03-23 stsp hostname by a colon, and a path to the repository on the server:
144 b213cbf7 2020-03-23 stsp <a class="Lk" href="scheme://hostname:port/path/to/repository">scheme://hostname:port/path/to/repository</a></p>
145 b213cbf7 2020-03-23 stsp <p class="Pp">The following protocol schemes are supported:</p>
146 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
147 b213cbf7 2020-03-23 stsp <dt>git</dt>
148 376d4d52 2022-07-04 stsp <dd>The Git protocol as implemented by the
149 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-daemon, section 1">git-daemon(1)</a>
150 b213cbf7 2020-03-23 stsp server. Use of this protocol is discouraged since it supports neither
151 b213cbf7 2020-03-23 stsp authentication nor encryption.</dd>
152 bd0bf387 2024-04-23 stsp <dt>ssh</dt>
153 b213cbf7 2020-03-23 stsp <dd>The Git protocol wrapped in an authenticated and encrypted
154 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> tunnel. With this
155 376d4d52 2022-07-04 stsp protocol the hostname may contain an embedded username for
156 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> to use:
157 b213cbf7 2020-03-23 stsp <a class="Mt" href="mailto:user@hostname">user@hostname</a></dd>
158 bd0bf387 2024-04-23 stsp <dt>http</dt>
159 bd0bf387 2024-04-23 stsp <dd>The “smart” Git HTTP protocol. Not compatible with
160 bd0bf387 2024-04-23 stsp servers using the “dumb” Git HTTP protocol.
161 bd0bf387 2024-04-23 stsp <p class="Pp">The “smart” Git HTTP protocol is supported
162 bd0bf387 2024-04-23 stsp by <code class="Cm">got clone</code> and <code class="Cm">got
163 bd0bf387 2024-04-23 stsp fetch</code>, but not by <code class="Cm">got send</code>. Sending
164 bd0bf387 2024-04-23 stsp from a repository cloned over HTTP will require use of the
165 bd0bf387 2024-04-23 stsp <code class="Ic">send</code> directive in
166 bd0bf387 2024-04-23 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> to
167 bd0bf387 2024-04-23 stsp ensure that the “ssh://” protocol will be used by
168 bd0bf387 2024-04-23 stsp <code class="Cm">got send</code>.</p>
169 bd0bf387 2024-04-23 stsp <p class="Pp">Use of this protocol is discouraged since it supports
170 bd0bf387 2024-04-23 stsp neither authentication nor encryption.</p>
172 bd0bf387 2024-04-23 stsp <dt>https</dt>
173 bd0bf387 2024-04-23 stsp <dd>The “smart” Git HTTP protocol wrapped in SSL/TLS.</dd>
175 b213cbf7 2020-03-23 stsp <p class="Pp">Objects in the cloned repository are stored in a pack file
176 b213cbf7 2020-03-23 stsp which is downloaded from the server. This pack file will then be indexed
177 b213cbf7 2020-03-23 stsp to facilitate access to the objects stored within. If any objects in the
178 b213cbf7 2020-03-23 stsp pack file are stored in deltified form, all deltas will be fully
179 b213cbf7 2020-03-23 stsp resolved in order to compute the ID of such objects. This can take some
180 b213cbf7 2020-03-23 stsp time. More details about the pack file format are documented in
181 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repository, section
182 376d4d52 2022-07-04 stsp 5">git-repository(5)</a>.</p>
183 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got clone</code> creates a remote repository
184 376d4d52 2022-07-04 stsp entry in the <a class="Xr" aria-label="got.conf, section
185 376d4d52 2022-07-04 stsp 5">got.conf(5)</a> and <span class="Pa">config</span> files of the
186 376d4d52 2022-07-04 stsp cloned repository to store the <var class="Ar">repository-url</var> and
187 376d4d52 2022-07-04 stsp any <var class="Ar">branch</var> or <var class="Ar">reference</var>
188 039953c9 2021-03-22 stsp arguments for future use by <code class="Cm">got fetch</code> or
189 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>.</p>
190 b213cbf7 2020-03-23 stsp <p class="Pp">The options for <code class="Cm">got clone</code> are as
191 b213cbf7 2020-03-23 stsp follows:</p>
192 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
193 2dbbbc3a 2020-07-23 stsp <dt id="a"><a class="permalink" href="#a"><code class="Fl">-a</code></a></dt>
194 b213cbf7 2020-03-23 stsp <dd>Fetch all branches from the remote repository's
195 039953c9 2021-03-22 stsp “refs/heads/” reference namespace and set
196 376d4d52 2022-07-04 stsp <code class="Cm">fetch_all_branches</code> in the cloned repository's
197 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> file
198 376d4d52 2022-07-04 stsp for future use by <code class="Cm">got fetch</code>. If this option is
199 376d4d52 2022-07-04 stsp not specified, a branch resolved via the remote repository's HEAD
200 376d4d52 2022-07-04 stsp reference will be fetched. Cannot be used together with the
201 376d4d52 2022-07-04 stsp <code class="Fl">-b</code> option.</dd>
202 2dbbbc3a 2020-07-23 stsp <dt id="b~2"><a class="permalink" href="#b~2"><code class="Fl">-b</code></a>
203 b213cbf7 2020-03-23 stsp <var class="Ar">branch</var></dt>
204 b213cbf7 2020-03-23 stsp <dd>Fetch the specified <var class="Ar">branch</var> from the remote
205 b213cbf7 2020-03-23 stsp repository's “refs/heads/” reference namespace. This
206 b213cbf7 2020-03-23 stsp option may be specified multiple times to build a list of branches to
207 b213cbf7 2020-03-23 stsp fetch. If the branch corresponding to the remote repository's HEAD
208 b213cbf7 2020-03-23 stsp reference is not in this list, the cloned repository's HEAD reference
209 b213cbf7 2020-03-23 stsp will be set to the first branch which was fetched. If this option is
210 b213cbf7 2020-03-23 stsp not specified, a branch resolved via the remote repository's HEAD
211 b213cbf7 2020-03-23 stsp reference will be fetched. Cannot be used together with the
212 b213cbf7 2020-03-23 stsp <code class="Fl">-a</code> option.</dd>
213 2dbbbc3a 2020-07-23 stsp <dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt>
214 b213cbf7 2020-03-23 stsp <dd>List branches and tags available for fetching from the remote
215 b213cbf7 2020-03-23 stsp repository and exit immediately. Cannot be used together with any of
216 039953c9 2021-03-22 stsp the other options except <code class="Fl">-q</code> and
217 039953c9 2021-03-22 stsp <code class="Fl">-v</code>.</dd>
218 2dbbbc3a 2020-07-23 stsp <dt id="m~2"><a class="permalink" href="#m~2"><code class="Fl">-m</code></a></dt>
219 b213cbf7 2020-03-23 stsp <dd>Create the cloned repository as a mirror of the original repository.
220 b213cbf7 2020-03-23 stsp This is useful if the cloned repository will not be used to store
221 a462773e 2020-04-19 stsp locally created commits.
222 376d4d52 2022-07-04 stsp <p class="Pp">The repository's <a class="Xr" aria-label="got.conf,
223 376d4d52 2022-07-04 stsp section 5">got.conf(5)</a> and <span class="Pa">config</span> files
224 376d4d52 2022-07-04 stsp will be set up with the “mirror” option enabled, such
225 376d4d52 2022-07-04 stsp that <code class="Cm">got fetch</code> or
226 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-fetch, section 1">git-fetch(1)</a>
227 a462773e 2020-04-19 stsp will write incoming changes directly to branches in the
228 b213cbf7 2020-03-23 stsp “refs/heads/” reference namespace, rather than to
229 b213cbf7 2020-03-23 stsp branches in the “refs/remotes/” namespace. This avoids
230 b213cbf7 2020-03-23 stsp the usual requirement of having to run <code class="Cm">got
231 461d9094 2023-07-19 stsp rebase</code> or <code class="Cm">got merge</code> after
232 461d9094 2023-07-19 stsp <code class="Cm">got fetch</code> in order to make incoming changes
233 461d9094 2023-07-19 stsp appear on branches in the “refs/heads/” namespace. But
234 461d9094 2023-07-19 stsp maintaining custom changes in the cloned repository becomes
235 461d9094 2023-07-19 stsp difficult since such changes will be at risk of being discarded
236 461d9094 2023-07-19 stsp whenever incoming changes are fetched.</p>
238 2dbbbc3a 2020-07-23 stsp <dt id="q"><a class="permalink" href="#q"><code class="Fl">-q</code></a></dt>
239 b213cbf7 2020-03-23 stsp <dd>Suppress progress reporting output. The same option will be passed to
240 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
241 376d4d52 2022-07-04 stsp applicable.</dd>
242 2dbbbc3a 2020-07-23 stsp <dt id="R"><a class="permalink" href="#R"><code class="Fl">-R</code></a>
243 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
244 b213cbf7 2020-03-23 stsp <dd>In addition to the branches and tags that will be fetched, fetch an
245 b213cbf7 2020-03-23 stsp arbitrary <var class="Ar">reference</var> from the remote repository's
246 b213cbf7 2020-03-23 stsp “refs/” namespace. This option may be specified multiple
247 b213cbf7 2020-03-23 stsp times to build a list of additional references to fetch. The specified
248 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var> may either be a path to a specific
249 b213cbf7 2020-03-23 stsp reference, or a reference namespace which will cause all references in
250 b213cbf7 2020-03-23 stsp this namespace to be fetched.
251 b213cbf7 2020-03-23 stsp <p class="Pp">Each reference will be mapped into the cloned repository's
252 b213cbf7 2020-03-23 stsp “refs/remotes/” namespace, unless the
253 b213cbf7 2020-03-23 stsp <code class="Fl">-m</code> option is used to mirror references
254 b213cbf7 2020-03-23 stsp directly into the cloned repository's “refs/”
255 b213cbf7 2020-03-23 stsp namespace.</p>
256 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got clone</code> will refuse to fetch
257 b213cbf7 2020-03-23 stsp references from the remote repository's
258 b213cbf7 2020-03-23 stsp “refs/remotes/” or “refs/got/”
259 b213cbf7 2020-03-23 stsp namespace.</p>
261 63657f42 2022-09-07 stsp <dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a></dt>
262 63657f42 2022-09-07 stsp <dd>Verbose mode. Causes <code class="Cm">got clone</code> to print
263 63657f42 2022-09-07 stsp debugging messages to standard error output. This option will be
264 63657f42 2022-09-07 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
265 63657f42 2022-09-07 stsp applicable. Multiple -v options increase the verbosity. The maximum is
269 63b69821 2021-10-16 stsp <dt id="fe"><a class="permalink" href="#fetch"><code class="Cm" id="fetch">fetch</code></a>
270 63657f42 2022-09-07 stsp [<code class="Fl">-adlqtvX</code>] [<code class="Fl">-b</code>
271 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-R</code>
272 63657f42 2022-09-07 stsp <var class="Ar">reference</var>] [<code class="Fl">-r</code>
273 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>]
274 63657f42 2022-09-07 stsp [<var class="Ar">remote-repository</var>]</dt>
276 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
277 46043f6f 2021-11-23 stsp <code class="Cm">fe</code>)</code></div>
278 46043f6f 2021-11-23 stsp Fetch new changes from a remote repository. If no
279 b213cbf7 2020-03-23 stsp <var class="Ar">remote-repository</var> is specified,
280 b213cbf7 2020-03-23 stsp “origin” will be used. The remote repository's URL is
281 376d4d52 2022-07-04 stsp obtained from the corresponding entry in
282 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
283 376d4d52 2022-07-04 stsp <span class="Pa">config</span> file of the local repository, as created by
284 376d4d52 2022-07-04 stsp <code class="Cm">got clone</code>.
285 f6a6fa94 2023-02-22 stsp <p class="Pp">By default, any branches configured in
286 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> for the
287 f6a6fa94 2023-02-22 stsp <var class="Ar">remote-repository</var> will be fetched. If
288 f6a6fa94 2023-02-22 stsp <code class="Cm">got fetch</code> is invoked in a work tree then this
289 f6a6fa94 2023-02-22 stsp work tree's current branch will be fetched, too, provided it is present
290 f6a6fa94 2023-02-22 stsp on the server. If no branches to fetch can be found in
291 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or via a
292 f6a6fa94 2023-02-22 stsp work tree, or said branches are not found on the server, a branch
293 f6a6fa94 2023-02-22 stsp resolved via the remote repository's HEAD reference will be fetched.
294 f6a6fa94 2023-02-22 stsp Likewise, if a HEAD reference for the
295 f6a6fa94 2023-02-22 stsp <var class="Ar">remote-repository</var> exists but its target no longer
296 f6a6fa94 2023-02-22 stsp matches the remote HEAD, then the new target branch will be fetched.
297 f6a6fa94 2023-02-22 stsp This default behaviour can be overridden with the
298 f6a6fa94 2023-02-22 stsp <code class="Fl">-a</code> and <code class="Fl">-b</code> options.</p>
299 b213cbf7 2020-03-23 stsp <p class="Pp">New changes will be stored in a separate pack file downloaded
300 b213cbf7 2020-03-23 stsp from the server. Optionally, separate pack files stored in the
301 376d4d52 2022-07-04 stsp repository can be combined with <a class="Xr" aria-label="git-repack,
302 376d4d52 2022-07-04 stsp section 1">git-repack(1)</a>.</p>
303 b213cbf7 2020-03-23 stsp <p class="Pp">By default, branch references in the
304 b213cbf7 2020-03-23 stsp “refs/remotes/” reference namespace will be updated to
305 b213cbf7 2020-03-23 stsp point at the newly fetched commits. The <code class="Cm">got
306 461d9094 2023-07-19 stsp rebase</code> or <code class="Cm">got merge</code> command can then be
307 461d9094 2023-07-19 stsp used to make new changes visible on branches in the
308 461d9094 2023-07-19 stsp “refs/heads/” namespace, merging incoming changes with the
309 461d9094 2023-07-19 stsp changes on those branches as necessary.</p>
310 b213cbf7 2020-03-23 stsp <p class="Pp">If the repository was created as a mirror with
311 b078d5c4 2022-03-23 stsp <code class="Cm">got clone -m</code>, then all branches in the
312 b213cbf7 2020-03-23 stsp “refs/heads/” namespace will be updated directly to match
313 b213cbf7 2020-03-23 stsp the corresponding branches in the remote repository. If those branches
314 b213cbf7 2020-03-23 stsp contained local commits, these commits will no longer be reachable via a
315 b213cbf7 2020-03-23 stsp reference and will therefore be at risk of being discarded by Git's
316 16cd1323 2021-07-26 stsp garbage collector or <code class="Cm">gotadmin cleanup</code>.
317 16cd1323 2021-07-26 stsp Maintaining custom changes in a mirror repository is therefore
318 16cd1323 2021-07-26 stsp discouraged.</p>
319 b213cbf7 2020-03-23 stsp <p class="Pp">In any case, references in the “refs/tags/”
320 b213cbf7 2020-03-23 stsp namespace will always be fetched and mapped directly to local references
321 b213cbf7 2020-03-23 stsp in the same namespace.</p>
322 b213cbf7 2020-03-23 stsp <p class="Pp">The options for <code class="Cm">got fetch</code> are as
323 b213cbf7 2020-03-23 stsp follows:</p>
324 b213cbf7 2020-03-23 stsp <dl class="Bl-tag">
325 2dbbbc3a 2020-07-23 stsp <dt id="a~2"><a class="permalink" href="#a~2"><code class="Fl">-a</code></a></dt>
326 b213cbf7 2020-03-23 stsp <dd>Fetch all branches from the remote repository's
327 039953c9 2021-03-22 stsp “refs/heads/” reference namespace. This option can be
328 039953c9 2021-03-22 stsp enabled by default for specific repositories in
329 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>. Cannot
330 f6a6fa94 2023-02-22 stsp be used together with the <code class="Fl">-b</code> option.</dd>
331 2dbbbc3a 2020-07-23 stsp <dt id="b~3"><a class="permalink" href="#b~3"><code class="Fl">-b</code></a>
332 b213cbf7 2020-03-23 stsp <var class="Ar">branch</var></dt>
333 b213cbf7 2020-03-23 stsp <dd>Fetch the specified <var class="Ar">branch</var> from the remote
334 b213cbf7 2020-03-23 stsp repository's “refs/heads/” reference namespace. This
335 b213cbf7 2020-03-23 stsp option may be specified multiple times to build a list of branches to
336 f6a6fa94 2023-02-22 stsp fetch. Cannot be used together with the <code class="Fl">-a</code>
337 f6a6fa94 2023-02-22 stsp option.</dd>
338 2dbbbc3a 2020-07-23 stsp <dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a></dt>
339 b213cbf7 2020-03-23 stsp <dd>Delete branches and tags from the local repository which are no longer
340 b213cbf7 2020-03-23 stsp present in the remote repository. Only references are deleted. Any
341 b213cbf7 2020-03-23 stsp commit, tree, tag, and blob objects belonging to deleted branches or
342 b213cbf7 2020-03-23 stsp tags remain in the repository and may be removed separately with Git's
343 16cd1323 2021-07-26 stsp garbage collector or <code class="Cm">gotadmin cleanup</code>.</dd>
344 2dbbbc3a 2020-07-23 stsp <dt id="l~2"><a class="permalink" href="#l~2"><code class="Fl">-l</code></a></dt>
345 b213cbf7 2020-03-23 stsp <dd>List branches and tags available for fetching from the remote
346 b213cbf7 2020-03-23 stsp repository and exit immediately. Cannot be used together with any of
347 039953c9 2021-03-22 stsp the other options except <code class="Fl">-v</code>,
348 039953c9 2021-03-22 stsp <code class="Fl">-q</code>, and <code class="Fl">-r</code>.</dd>
349 2dbbbc3a 2020-07-23 stsp <dt id="q~2"><a class="permalink" href="#q~2"><code class="Fl">-q</code></a></dt>
350 b213cbf7 2020-03-23 stsp <dd>Suppress progress reporting output. The same option will be passed to
351 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
352 376d4d52 2022-07-04 stsp applicable.</dd>
353 2dbbbc3a 2020-07-23 stsp <dt id="R~2"><a class="permalink" href="#R~2"><code class="Fl">-R</code></a>
354 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
355 b213cbf7 2020-03-23 stsp <dd>In addition to the branches and tags that will be fetched, fetch an
356 b213cbf7 2020-03-23 stsp arbitrary <var class="Ar">reference</var> from the remote repository's
357 b213cbf7 2020-03-23 stsp “refs/” namespace. This option may be specified multiple
358 b213cbf7 2020-03-23 stsp times to build a list of additional references to fetch. The specified
359 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var> may either be a path to a specific
360 b213cbf7 2020-03-23 stsp reference, or a reference namespace which will cause all references in
361 b213cbf7 2020-03-23 stsp this namespace to be fetched.
362 b213cbf7 2020-03-23 stsp <p class="Pp">Each reference will be mapped into the local repository's
363 b213cbf7 2020-03-23 stsp “refs/remotes/” namespace, unless the local repository
364 b213cbf7 2020-03-23 stsp was created as a mirror with <code class="Cm">got clone -m</code> in
365 b213cbf7 2020-03-23 stsp which case references will be mapped directly into the local
366 b213cbf7 2020-03-23 stsp repository's “refs/” namespace.</p>
367 a462773e 2020-04-19 stsp <p class="Pp">Once a reference has been fetched, a branch based on it
368 a462773e 2020-04-19 stsp can be created with <code class="Cm">got branch</code> if
369 b213cbf7 2020-03-23 stsp needed.</p>
370 b213cbf7 2020-03-23 stsp <p class="Pp"><code class="Cm">got fetch</code> will refuse to fetch
371 b213cbf7 2020-03-23 stsp references from the remote repository's
372 b213cbf7 2020-03-23 stsp “refs/remotes/” or “refs/got/”
373 b213cbf7 2020-03-23 stsp namespace.</p>
375 63657f42 2022-09-07 stsp <dt id="r~2"><a class="permalink" href="#r~2"><code class="Fl">-r</code></a>
376 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
377 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
378 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
379 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
380 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
381 63657f42 2022-09-07 stsp <dt id="t"><a class="permalink" href="#t"><code class="Fl">-t</code></a></dt>
382 63657f42 2022-09-07 stsp <dd>Allow existing references in the “refs/tags” namespace
383 63657f42 2022-09-07 stsp to be updated if they have changed on the server. If not specified,
384 63657f42 2022-09-07 stsp only new tag references will be created.</dd>
385 63657f42 2022-09-07 stsp <dt id="v~2"><a class="permalink" href="#v~2"><code class="Fl">-v</code></a></dt>
386 63657f42 2022-09-07 stsp <dd>Verbose mode. Causes <code class="Cm">got fetch</code> to print
387 63657f42 2022-09-07 stsp debugging messages to standard error output. The same option will be
388 63657f42 2022-09-07 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
389 63657f42 2022-09-07 stsp applicable. Multiple -v options increase the verbosity. The maximum is
391 16cd1323 2021-07-26 stsp <dt id="X"><a class="permalink" href="#X"><code class="Fl">-X</code></a></dt>
392 16cd1323 2021-07-26 stsp <dd>Delete all references which correspond to a particular
393 16cd1323 2021-07-26 stsp <var class="Ar">remote-repository</var> instead of fetching new
394 16cd1323 2021-07-26 stsp changes. This can be useful when a remote repository is being removed
395 376d4d52 2022-07-04 stsp from <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>.
396 16cd1323 2021-07-26 stsp <p class="Pp">With <code class="Fl">-X</code>, the
397 16cd1323 2021-07-26 stsp <var class="Ar">remote-repository</var> argument is mandatory and no
398 16cd1323 2021-07-26 stsp other options except <code class="Fl">-r</code>,
399 16cd1323 2021-07-26 stsp <code class="Fl">-v</code>, and <code class="Fl">-q</code> are
400 16cd1323 2021-07-26 stsp allowed.</p>
401 16cd1323 2021-07-26 stsp <p class="Pp">Only references are deleted. Any commit, tree, tag, and
402 16cd1323 2021-07-26 stsp blob objects fetched from a remote repository will generally be
403 16cd1323 2021-07-26 stsp stored in pack files and may be removed separately with
404 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repack, section 1">git-repack(1)</a>
405 376d4d52 2022-07-04 stsp and Git's garbage collector.</p>
409 63b69821 2021-10-16 stsp <dt id="co"><a class="permalink" href="#checkout"><code class="Cm" id="checkout">checkout</code></a>
410 63657f42 2022-09-07 stsp [<code class="Fl">-Eq</code>] [<code class="Fl">-b</code>
411 8b679b4b 2020-02-17 stsp <var class="Ar">branch</var>] [<code class="Fl">-c</code>
412 8b679b4b 2020-02-17 stsp <var class="Ar">commit</var>] [<code class="Fl">-p</code>
413 63657f42 2022-09-07 stsp <var class="Ar">path-prefix</var>] <var class="Ar">repository-path</var>
414 8797b228 2019-08-04 stsp [<var class="Ar">work-tree-path</var>]</dt>
416 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
417 46043f6f 2021-11-23 stsp <code class="Cm">co</code>)</code></div>
418 46043f6f 2021-11-23 stsp Copy files from a repository into a new work tree. Show the status of each
419 8b679b4b 2020-02-17 stsp affected file, using the following status codes:
420 8b679b4b 2020-02-17 stsp <table class="Bl-column">
423 8b679b4b 2020-02-17 stsp <td>new file was added</td>
427 8b679b4b 2020-02-17 stsp <td>file already exists in work tree's meta-data</td>
430 8b679b4b 2020-02-17 stsp <p class="Pp">If the <var class="Ar">work tree path</var> is not specified,
431 8b679b4b 2020-02-17 stsp either use the last component of <var class="Ar">repository path</var>,
432 8b679b4b 2020-02-17 stsp or if a <var class="Ar">path prefix</var> was specified use the last
433 8b679b4b 2020-02-17 stsp component of <var class="Ar">path prefix</var>.</p>
434 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got checkout</code> are as
435 8797b228 2019-08-04 stsp follows:</p>
436 8797b228 2019-08-04 stsp <dl class="Bl-tag">
437 2dbbbc3a 2020-07-23 stsp <dt id="b~4"><a class="permalink" href="#b~4"><code class="Fl">-b</code></a>
438 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
439 8797b228 2019-08-04 stsp <dd>Check out files from a commit on the specified
440 8797b228 2019-08-04 stsp <var class="Ar">branch</var>. If this option is not specified, a
441 8797b228 2019-08-04 stsp branch resolved via the repository's HEAD reference will be used.</dd>
442 2dbbbc3a 2020-07-23 stsp <dt id="c"><a class="permalink" href="#c"><code class="Fl">-c</code></a>
443 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
444 8797b228 2019-08-04 stsp <dd>Check out files from the specified <var class="Ar">commit</var> on the
445 461d9094 2023-07-19 stsp selected branch. If this option is not specified, the most recent
446 461d9094 2023-07-19 stsp commit on the selected branch will be used.
447 461d9094 2023-07-19 stsp <p class="Pp">The expected <var class="Ar">commit</var> argument is a
448 461d9094 2023-07-19 stsp commit ID SHA1 hash, or a reference name or a keyword which will be
449 461d9094 2023-07-19 stsp resolved to a commit ID. An abbreviated hash argument will be
450 461d9094 2023-07-19 stsp expanded to a full SHA1 hash automatically, provided the
451 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
452 461d9094 2023-07-19 stsp ":head" resolve to the repository's HEAD reference, or, if
453 461d9094 2023-07-19 stsp the <code class="Fl">-b</code> option is used, the head of the
454 461d9094 2023-07-19 stsp checked-out <var class="Ar">branch</var>. Keywords and reference
455 461d9094 2023-07-19 stsp names may be appended with ":+" or ":-"
456 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
457 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
458 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
459 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">foo:-3</b> will denote the
460 461d9094 2023-07-19 stsp 3rd generation ancestor of the commit resolved by the
461 461d9094 2023-07-19 stsp "foo" reference. If an integer does not follow the
462 461d9094 2023-07-19 stsp ":+" or ":-" modifier, a "1" is
463 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
464 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
465 ae803b74 2020-03-06 stsp <p class="Pp">If the specified <var class="Ar">commit</var> is not
466 ae803b74 2020-03-06 stsp contained in the selected branch, a different branch which contains
467 ae803b74 2020-03-06 stsp this commit must be specified with the <code class="Fl">-b</code>
468 b078d5c4 2022-03-23 stsp option. If no such branch is known, a new branch must be created for
469 ae803b74 2020-03-06 stsp this commit with <code class="Cm">got branch</code> before
470 ae803b74 2020-03-06 stsp <code class="Cm">got checkout</code> can be used. Checking out work
471 ae803b74 2020-03-06 stsp trees with an unknown branch is intentionally not supported.</p>
473 63657f42 2022-09-07 stsp <dt id="E"><a class="permalink" href="#E"><code class="Fl">-E</code></a></dt>
474 63657f42 2022-09-07 stsp <dd>Proceed with the checkout operation even if the directory at
475 63657f42 2022-09-07 stsp <var class="Ar">work-tree-path</var> is not empty. Existing files will
476 63657f42 2022-09-07 stsp be left intact.</dd>
477 2dbbbc3a 2020-07-23 stsp <dt id="p"><a class="permalink" href="#p"><code class="Fl">-p</code></a>
478 8797b228 2019-08-04 stsp <var class="Ar">path-prefix</var></dt>
479 8797b228 2019-08-04 stsp <dd>Restrict the work tree to a subset of the repository's tree hierarchy.
480 8797b228 2019-08-04 stsp Only files beneath the specified <var class="Ar">path-prefix</var>
481 8797b228 2019-08-04 stsp will be checked out.</dd>
482 4448c231 2021-09-15 stsp <dt id="q~3"><a class="permalink" href="#q~3"><code class="Fl">-q</code></a></dt>
483 4448c231 2021-09-15 stsp <dd>Silence progress output.</dd>
486 63b69821 2021-10-16 stsp <dt id="up"><a class="permalink" href="#update"><code class="Cm" id="update">update</code></a>
487 63657f42 2022-09-07 stsp [<code class="Fl">-q</code>] [<code class="Fl">-b</code>
488 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-c</code>
489 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<var class="Ar">path ...</var>]</dt>
491 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
492 46043f6f 2021-11-23 stsp <code class="Cm">up</code>)</code></div>
493 46043f6f 2021-11-23 stsp Update an existing work tree to a different <var class="Ar">commit</var>.
494 9e67ab87 2020-04-14 stsp Change existing files in the work tree as necessary to match file contents
495 9e67ab87 2020-04-14 stsp of this commit. Preserve any local changes in the work tree and merge them
496 9e67ab87 2020-04-14 stsp with the incoming changes.
497 a462773e 2020-04-19 stsp <p class="Pp">Files which already contain merge conflicts will not be
498 a462773e 2020-04-19 stsp updated to avoid further complications. Such files will be updated when
499 a462773e 2020-04-19 stsp <code class="Cm">got update</code> is run again after merge conflicts
500 b078d5c4 2022-03-23 stsp have been resolved. If the conflicting changes are no longer needed,
501 a462773e 2020-04-19 stsp affected files can be reverted with <code class="Cm">got revert</code>
502 a462773e 2020-04-19 stsp before running <code class="Cm">got update</code> again.</p>
503 9e67ab87 2020-04-14 stsp <p class="Pp">Show the status of each affected file, using the following
504 9e67ab87 2020-04-14 stsp status codes:</p>
505 8797b228 2019-08-04 stsp <table class="Bl-column">
508 8797b228 2019-08-04 stsp <td>file was updated and contained no local changes</td>
512 8797b228 2019-08-04 stsp <td>file was updated and local changes were merged cleanly</td>
516 8797b228 2019-08-04 stsp <td>file was updated and conflicts occurred during merge</td>
520 8797b228 2019-08-04 stsp <td>file was deleted</td>
524 86b2b9f3 2023-03-12 stsp <td>file's deletion was prevented by local modifications</td>
528 8797b228 2019-08-04 stsp <td>new file was added</td>
532 8797b228 2019-08-04 stsp <td>versioned file is obstructed by a non-regular file</td>
536 8797b228 2019-08-04 stsp <td>a missing versioned file was restored</td>
540 a462773e 2020-04-19 stsp <td>file was not updated because it contains merge conflicts</td>
544 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
547 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, update the
548 8797b228 2019-08-04 stsp entire work tree. Otherwise, restrict the update operation to files at
549 8797b228 2019-08-04 stsp or within the specified paths. Each path is required to exist in the
550 8797b228 2019-08-04 stsp update operation's target commit. Files in the work tree outside
551 8797b228 2019-08-04 stsp specified paths will remain unchanged and will retain their previously
552 8797b228 2019-08-04 stsp recorded base commit. Some <code class="Nm">got</code> commands may
553 8797b228 2019-08-04 stsp refuse to run while the work tree contains files from multiple base
554 8797b228 2019-08-04 stsp commits. The base commit of such a work tree can be made consistent by
555 8797b228 2019-08-04 stsp running <code class="Cm">got update</code> across the entire work tree.
556 8797b228 2019-08-04 stsp Specifying a <var class="Ar">path</var> is incompatible with the
557 8797b228 2019-08-04 stsp <code class="Fl">-b</code> option.</p>
558 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got update</code> cannot update paths with
559 8797b228 2019-08-04 stsp staged changes. If changes have been staged with <code class="Cm">got
560 91b3da3f 2019-08-18 stsp stage</code>, these changes must first be committed with
561 8797b228 2019-08-04 stsp <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
562 8797b228 2019-08-04 stsp unstage</code>.</p>
563 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got update</code> are as
564 8797b228 2019-08-04 stsp follows:</p>
565 8797b228 2019-08-04 stsp <dl class="Bl-tag">
566 2dbbbc3a 2020-07-23 stsp <dt id="b~5"><a class="permalink" href="#b~5"><code class="Fl">-b</code></a>
567 8797b228 2019-08-04 stsp <var class="Ar">branch</var></dt>
568 8797b228 2019-08-04 stsp <dd>Switch the work tree's branch reference to the specified
569 8797b228 2019-08-04 stsp <var class="Ar">branch</var> before updating the work tree. This
570 9e67ab87 2020-04-14 stsp option requires that all paths in the work tree are updated.
571 9e67ab87 2020-04-14 stsp <p class="Pp">As usual, any local changes in the work tree will be
572 9e67ab87 2020-04-14 stsp preserved. This can be useful when switching to a newly created
573 9e67ab87 2020-04-14 stsp branch in order to commit existing local changes to this branch.</p>
574 9e67ab87 2020-04-14 stsp <p class="Pp">Any local changes must be dealt with separately in order
575 9e67ab87 2020-04-14 stsp to obtain a work tree with pristine file contents corresponding
576 9e67ab87 2020-04-14 stsp exactly to the specified <var class="Ar">branch</var>. Such changes
577 9e67ab87 2020-04-14 stsp could first be committed to a different branch with
578 9e67ab87 2020-04-14 stsp <code class="Cm">got commit</code>, or could be discarded with
579 9e67ab87 2020-04-14 stsp <code class="Cm">got revert</code>.</p>
581 2dbbbc3a 2020-07-23 stsp <dt id="c~2"><a class="permalink" href="#c~2"><code class="Fl">-c</code></a>
582 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
583 461d9094 2023-07-19 stsp <dd>Update the work tree to the specified <var class="Ar">commit</var>. If
584 461d9094 2023-07-19 stsp this option is not specified, the most recent commit on the work
585 461d9094 2023-07-19 stsp tree's branch will be used.
586 461d9094 2023-07-19 stsp <p class="Pp">The expected <var class="Ar">commit</var> argument is a
587 461d9094 2023-07-19 stsp commit ID SHA1 hash, or a reference name or a keyword which will be
588 461d9094 2023-07-19 stsp resolved to a commit ID. An abbreviated hash argument will be
589 461d9094 2023-07-19 stsp expanded to a full SHA1 hash automatically, provided the
590 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
591 461d9094 2023-07-19 stsp ":head" resolve to the work tree's base commit and branch
592 461d9094 2023-07-19 stsp head, respectively. Keywords and reference names may be appended
593 461d9094 2023-07-19 stsp with ":+" or ":-" modifiers and an optional
594 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent, respectively,
595 461d9094 2023-07-19 stsp by first parent traversal; for example, <b class="Sy">:head:-2</b>
596 461d9094 2023-07-19 stsp denotes the work tree branch head's 2nd generation ancestor, and
597 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
598 461d9094 2023-07-19 stsp the work tree's base commit. Similarly, <b class="Sy">foo:-3</b>
599 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
600 461d9094 2023-07-19 stsp the "foo" reference. If an integer does not follow the
601 461d9094 2023-07-19 stsp ":+" or ":-" modifier, a "1" is
602 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
603 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
605 4448c231 2021-09-15 stsp <dt id="q~4"><a class="permalink" href="#q~4"><code class="Fl">-q</code></a></dt>
606 4448c231 2021-09-15 stsp <dd>Silence progress output.</dd>
609 63b69821 2021-10-16 stsp <dt id="st"><a class="permalink" href="#status"><code class="Cm" id="status">status</code></a>
610 63657f42 2022-09-07 stsp [<code class="Fl">-I</code>] [<code class="Fl">-S</code>
611 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var>] [<code class="Fl">-s</code>
612 cb0c453b 2021-09-15 stsp <var class="Ar">status-codes</var>] [<var class="Ar">path ...</var>]</dt>
614 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
615 46043f6f 2021-11-23 stsp <code class="Cm">st</code>)</code></div>
616 46043f6f 2021-11-23 stsp Show the current modification status of files in a work tree, using the
617 8797b228 2019-08-04 stsp following status codes:
618 8797b228 2019-08-04 stsp <table class="Bl-column">
621 8797b228 2019-08-04 stsp <td>modified file</td>
625 8797b228 2019-08-04 stsp <td>file scheduled for addition in next commit</td>
629 8797b228 2019-08-04 stsp <td>file scheduled for deletion in next commit</td>
633 8797b228 2019-08-04 stsp <td>modified or added file which contains merge conflicts</td>
637 8797b228 2019-08-04 stsp <td>versioned file was expected on disk but is missing</td>
641 8797b228 2019-08-04 stsp <td>versioned file is obstructed by a non-regular file</td>
645 8797b228 2019-08-04 stsp <td>unversioned item not tracked by <code class="Nm">got</code></td>
649 d8e62599 2019-10-21 stsp <td>modified file modes (executable bit only)</td>
653 ba0a4168 2019-08-26 stsp <td>non-existent <var class="Ar">path</var> specified on the command
657 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, show
658 8797b228 2019-08-04 stsp modifications in the entire work tree. Otherwise, show modifications at
659 8797b228 2019-08-04 stsp or within the specified paths.</p>
660 8797b228 2019-08-04 stsp <p class="Pp">If changes have been staged with <code class="Cm">got
661 8797b228 2019-08-04 stsp stage</code>, staged changes are shown in the second output column,
662 8797b228 2019-08-04 stsp using the following status codes:</p>
663 8797b228 2019-08-04 stsp <table class="Bl-column">
666 8797b228 2019-08-04 stsp <td>file modification is staged</td>
670 8797b228 2019-08-04 stsp <td>file addition is staged</td>
674 8797b228 2019-08-04 stsp <td>file deletion is staged</td>
677 fc62dacd 2019-08-08 stsp <p class="Pp">Changes created on top of staged changes are indicated in the
678 fc62dacd 2019-08-08 stsp first column:</p>
679 8797b228 2019-08-04 stsp <table class="Bl-column">
681 8797b228 2019-08-04 stsp <td>MM</td>
682 fc62dacd 2019-08-08 stsp <td>file was modified after earlier changes have been staged</td>
685 8797b228 2019-08-04 stsp <td>MA</td>
686 fc62dacd 2019-08-08 stsp <td>file was modified after having been staged for addition</td>
689 bd0bf387 2024-04-23 stsp <p class="Pp">If the work tree contains the results of an interrupted
690 bd0bf387 2024-04-23 stsp <code class="Cm">got rebase</code>, <code class="Cm">got
691 bd0bf387 2024-04-23 stsp histedit</code>, or <code class="Cm">got merge</code> operation then
692 bd0bf387 2024-04-23 stsp display a message which shows the branches involved.</p>
693 feee6923 2020-09-17 stsp <p class="Pp">The options for <code class="Cm">got status</code> are as
694 feee6923 2020-09-17 stsp follows:</p>
695 feee6923 2020-09-17 stsp <dl class="Bl-tag">
696 a954aa0a 2021-06-22 stsp <dt id="I~2"><a class="permalink" href="#I~2"><code class="Fl">-I</code></a></dt>
697 a954aa0a 2021-06-22 stsp <dd>Show unversioned files even if they match an ignore pattern.</dd>
698 4448c231 2021-09-15 stsp <dt id="S"><a class="permalink" href="#S"><code class="Fl">-S</code></a>
699 4448c231 2021-09-15 stsp <var class="Ar">status-codes</var></dt>
700 4448c231 2021-09-15 stsp <dd>Suppress the output of files with a modification status matching any
701 4448c231 2021-09-15 stsp of the single-character status codes contained in the
702 4448c231 2021-09-15 stsp <var class="Ar">status-codes</var> argument. Any combination of codes
703 4448c231 2021-09-15 stsp from the above list of possible status codes may be specified. For
704 4448c231 2021-09-15 stsp staged files, status codes displayed in either column will be matched.
705 4448c231 2021-09-15 stsp Cannot be used together with the <code class="Fl">-s</code>
706 4448c231 2021-09-15 stsp option.</dd>
707 63657f42 2022-09-07 stsp <dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>
708 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var></dt>
709 63657f42 2022-09-07 stsp <dd>Only show files with a modification status matching any of the
710 63657f42 2022-09-07 stsp single-character status codes contained in the
711 63657f42 2022-09-07 stsp <var class="Ar">status-codes</var> argument. Any combination of codes
712 63657f42 2022-09-07 stsp from the above list of possible status codes may be specified. For
713 63657f42 2022-09-07 stsp staged files, status codes displayed in either column will be matched.
714 63657f42 2022-09-07 stsp Cannot be used together with the <code class="Fl">-S</code>
715 63657f42 2022-09-07 stsp option.</dd>
717 376d4d52 2022-07-04 stsp <p class="Pp">For compatibility with <a class="Xr" aria-label="cvs, section
718 376d4d52 2022-07-04 stsp 1">cvs(1)</a> and <a class="Xr" aria-label="git, section 1">git(1)</a>,
719 376d4d52 2022-07-04 stsp <code class="Cm">got status</code> reads <a class="Xr" aria-label="glob,
720 376d4d52 2022-07-04 stsp section 7">glob(7)</a> patterns from <span class="Pa">.cvsignore</span>
721 376d4d52 2022-07-04 stsp and <span class="Pa">.gitignore</span> files in each traversed directory
722 f6a6fa94 2023-02-22 stsp and will not display unversioned files which match these patterns.
723 f6a6fa94 2023-02-22 stsp Ignore patterns which end with a slash, “/”, will only
724 f6a6fa94 2023-02-22 stsp match directories. As an extension to <a class="Xr" aria-label="glob,
725 f6a6fa94 2023-02-22 stsp section 7">glob(7)</a> matching rules, <code class="Cm">got
726 f6a6fa94 2023-02-22 stsp status</code> supports consecutive asterisks, “**”, which
727 f6a6fa94 2023-02-22 stsp will match an arbitrary amount of directories. Unlike
728 f6a6fa94 2023-02-22 stsp <a class="Xr" aria-label="cvs, section 1">cvs(1)</a>,
729 f6a6fa94 2023-02-22 stsp <code class="Cm">got status</code> only supports a single ignore pattern
730 f6a6fa94 2023-02-22 stsp per line. Unlike <a class="Xr" aria-label="git, section 1">git(1)</a>,
731 f6a6fa94 2023-02-22 stsp <code class="Cm">got status</code> does not support negated ignore
732 f6a6fa94 2023-02-22 stsp patterns prefixed with “!”, and gives no special
733 f6a6fa94 2023-02-22 stsp significance to the location of path component separators,
734 376d4d52 2022-07-04 stsp “/”, in a pattern.</p>
736 2dbbbc3a 2020-07-23 stsp <dt id="log"><a class="permalink" href="#log"><code class="Cm">log</code></a>
737 bd0bf387 2024-04-23 stsp [<code class="Fl">-bdPpRst</code>] [<code class="Fl">-C</code>
738 63657f42 2022-09-07 stsp <var class="Ar">number</var>] [<code class="Fl">-c</code>
739 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-l</code>
740 63657f42 2022-09-07 stsp <var class="Ar">N</var>] [<code class="Fl">-r</code>
741 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-S</code>
742 63657f42 2022-09-07 stsp <var class="Ar">search-pattern</var>] [<code class="Fl">-x</code>
743 a701a2ae 2022-06-17 stsp <var class="Ar">commit</var>] [<var class="Ar">path</var>]</dt>
744 8797b228 2019-08-04 stsp <dd>Display history of a repository. If a <var class="Ar">path</var> is
745 7c3b4ab8 2020-02-25 stsp specified, show only commits which modified this path. If invoked in a
746 7c3b4ab8 2020-02-25 stsp work tree, the <var class="Ar">path</var> is interpreted relative to the
747 7c3b4ab8 2020-02-25 stsp current working directory, and the work tree's path prefix is implicitly
748 7c3b4ab8 2020-02-25 stsp prepended. Otherwise, the path is interpreted relative to the repository
750 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got log</code> are as
751 8797b228 2019-08-04 stsp follows:</p>
752 8797b228 2019-08-04 stsp <dl class="Bl-tag">
753 2dbbbc3a 2020-07-23 stsp <dt id="b~6"><a class="permalink" href="#b~6"><code class="Fl">-b</code></a></dt>
754 8b679b4b 2020-02-17 stsp <dd>Display individual commits which were merged into the current branch
755 8b679b4b 2020-02-17 stsp from other branches. By default, <code class="Cm">got log</code> shows
756 8b679b4b 2020-02-17 stsp the linear history of the current branch only.</dd>
757 63657f42 2022-09-07 stsp <dt id="C"><a class="permalink" href="#C"><code class="Fl">-C</code></a>
758 63657f42 2022-09-07 stsp <var class="Ar">number</var></dt>
759 63657f42 2022-09-07 stsp <dd>Set the number of context lines shown in diffs with
760 63657f42 2022-09-07 stsp <code class="Fl">-p</code>. By default, 3 lines of context are
761 63657f42 2022-09-07 stsp shown.</dd>
762 2dbbbc3a 2020-07-23 stsp <dt id="c~3"><a class="permalink" href="#c~3"><code class="Fl">-c</code></a>
763 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
764 8797b228 2019-08-04 stsp <dd>Start traversing history at the specified
765 461d9094 2023-07-19 stsp <var class="Ar">commit</var>. If this option is not specified, default
766 461d9094 2023-07-19 stsp to the work tree's current branch if invoked in a work tree, or to the
767 461d9094 2023-07-19 stsp repository's HEAD reference.
768 461d9094 2023-07-19 stsp <p class="Pp" id="bar:+3">The expected <var class="Ar">commit</var>
769 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
770 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
771 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
772 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
773 461d9094 2023-07-19 stsp ":head" resolve to the work tree's base commit and branch
774 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
775 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
776 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
777 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and references may be
778 461d9094 2023-07-19 stsp appended with ":+" or ":-" modifiers and an
779 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent,
780 461d9094 2023-07-19 stsp respectively, by first parent traversal; for example,
781 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
782 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
783 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
784 461d9094 2023-07-19 stsp <a class="permalink" href="#bar:+3"><b class="Sy">bar:+3</b></a>
785 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
786 461d9094 2023-07-19 stsp the "bar" reference. A ":+" or ":-"
787 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
788 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
789 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
791 47f19dd5 2023-01-17 stsp <dt id="d~2"><a class="permalink" href="#d~2"><code class="Fl">-d</code></a></dt>
792 47f19dd5 2023-01-17 stsp <dd>Display diffstat of changes introduced in each commit. Cannot be used
793 a8f7f066 2023-08-29 stsp with the <code class="Fl">-s</code> option. Implies the
794 a8f7f066 2023-08-29 stsp <code class="Fl">-P</code> option (diffstat displays a list of changed
795 a8f7f066 2023-08-29 stsp paths).</dd>
796 2dbbbc3a 2020-07-23 stsp <dt id="l~3"><a class="permalink" href="#l~3"><code class="Fl">-l</code></a>
797 8797b228 2019-08-04 stsp <var class="Ar">N</var></dt>
798 91b3da3f 2019-08-18 stsp <dd>Limit history traversal to a given number of commits. If this option
799 91b3da3f 2019-08-18 stsp is not specified, a default limit value of zero is used, which is
800 91b3da3f 2019-08-18 stsp treated as an unbounded limit. The
801 91b3da3f 2019-08-18 stsp <code class="Ev">GOT_LOG_DEFAULT_LIMIT</code> environment variable may
802 91b3da3f 2019-08-18 stsp be set to change this default value.</dd>
803 2dbbbc3a 2020-07-23 stsp <dt id="P"><a class="permalink" href="#P"><code class="Fl">-P</code></a></dt>
804 ec51d4a3 2020-05-05 stsp <dd>Display the list of file paths changed in each commit, using the
805 ec51d4a3 2020-05-05 stsp following status codes:
806 ec51d4a3 2020-05-05 stsp <table class="Bl-column">
809 ec51d4a3 2020-05-05 stsp <td>modified file</td>
813 ec51d4a3 2020-05-05 stsp <td>file was deleted</td>
817 ec51d4a3 2020-05-05 stsp <td>new file was added</td>
821 ec51d4a3 2020-05-05 stsp <td>modified file modes (executable bit only)</td>
824 a701a2ae 2022-06-17 stsp <p class="Pp">Cannot be used with the <code class="Fl">-s</code>
825 a701a2ae 2022-06-17 stsp option.</p>
827 63657f42 2022-09-07 stsp <dt id="p~2"><a class="permalink" href="#p~2"><code class="Fl">-p</code></a></dt>
828 63657f42 2022-09-07 stsp <dd>Display the patch of modifications made in each commit. If a
829 63657f42 2022-09-07 stsp <var class="Ar">path</var> is specified, only show the patch of
830 63657f42 2022-09-07 stsp modifications at or within this path. Cannot be used with the
831 63657f42 2022-09-07 stsp <code class="Fl">-s</code> option.</dd>
832 63657f42 2022-09-07 stsp <dt id="R~3"><a class="permalink" href="#R~3"><code class="Fl">-R</code></a></dt>
833 63657f42 2022-09-07 stsp <dd>Determine a set of commits to display as usual, but display these
834 63657f42 2022-09-07 stsp commits in reverse order.</dd>
835 63657f42 2022-09-07 stsp <dt id="r~3"><a class="permalink" href="#r~3"><code class="Fl">-r</code></a>
836 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
837 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
838 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
839 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
840 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
841 a701a2ae 2022-06-17 stsp <dt id="S~2"><a class="permalink" href="#S~2"><code class="Fl">-S</code></a>
842 8b679b4b 2020-02-17 stsp <var class="Ar">search-pattern</var></dt>
843 a701a2ae 2022-06-17 stsp <dd>If specified, show only commits with a log message, author name,
844 a701a2ae 2022-06-17 stsp committer name, or ID SHA1 hash matched by the extended regular
845 a701a2ae 2022-06-17 stsp expression <var class="Ar">search-pattern</var>. Lines in committed
846 a701a2ae 2022-06-17 stsp patches will be matched if <code class="Fl">-p</code> is specified.
847 a701a2ae 2022-06-17 stsp File paths changed by a commit will be matched if
848 a701a2ae 2022-06-17 stsp <code class="Fl">-P</code> is specified. Regular expression syntax is
849 376d4d52 2022-07-04 stsp documented in <a class="Xr" aria-label="re_format, section
850 376d4d52 2022-07-04 stsp 7">re_format(7)</a>.</dd>
851 63657f42 2022-09-07 stsp <dt id="s~2"><a class="permalink" href="#s~2"><code class="Fl">-s</code></a></dt>
852 63657f42 2022-09-07 stsp <dd>Display a short one-line summary of each commit, instead of the
853 63657f42 2022-09-07 stsp default history format. Cannot be used together with the
854 63657f42 2022-09-07 stsp <code class="Fl">-p</code> or <code class="Fl">-P</code> option.</dd>
855 bd0bf387 2024-04-23 stsp <dt id="t~2"><a class="permalink" href="#t~2"><code class="Fl">-t</code></a></dt>
856 bd0bf387 2024-04-23 stsp <dd>Display commits in topological order. This option has no effect
857 bd0bf387 2024-04-23 stsp without the <code class="Fl">-b</code> option because a linear history
858 bd0bf387 2024-04-23 stsp is sorted in topological order by definition. Topological sorting is
859 bd0bf387 2024-04-23 stsp disabled by default because the present implementation requires that
860 bd0bf387 2024-04-23 stsp commit history is fully traversed before any output can be shown.</dd>
861 2dbbbc3a 2020-07-23 stsp <dt id="x"><a class="permalink" href="#x"><code class="Fl">-x</code></a>
862 a462773e 2020-04-19 stsp <var class="Ar">commit</var></dt>
863 039953c9 2021-03-22 stsp <dd>Stop traversing commit history immediately after the specified
864 a8f7f066 2023-08-29 stsp <var class="Ar">commit</var> has been traversed. Like
865 a8f7f066 2023-08-29 stsp <code class="Fl">-c</code>, the expected <var class="Ar">commit</var>
866 a8f7f066 2023-08-29 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
867 a8f7f066 2023-08-29 stsp which will be resolved to a commit ID. This option has no effect if
868 a8f7f066 2023-08-29 stsp the specified <var class="Ar">commit</var> is never traversed.</dd>
871 63b69821 2021-10-16 stsp <dt id="di"><a class="permalink" href="#diff"><code class="Cm" id="diff">diff</code></a>
872 47f19dd5 2023-01-17 stsp [<code class="Fl">-adPsw</code>] [<code class="Fl">-C</code>
873 63657f42 2022-09-07 stsp <var class="Ar">number</var>] [<code class="Fl">-c</code>
874 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-r</code>
875 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">object1</var>
876 63657f42 2022-09-07 stsp <var class="Ar">object2</var> | <var class="Ar">path ...</var>]</dt>
878 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
879 46043f6f 2021-11-23 stsp <code class="Cm">di</code>)</code></div>
880 46043f6f 2021-11-23 stsp When invoked within a work tree without any arguments, display all local
881 63b69821 2021-10-16 stsp changes in the work tree. If one or more <var class="Ar">path</var>
882 63b69821 2021-10-16 stsp arguments are specified, only show changes within the specified paths.
883 8797b228 2019-08-04 stsp <p class="Pp">If two arguments are provided, treat each argument as a
884 7fe2a942 2019-08-11 stsp reference, a tag name, or an object ID SHA1 hash, and display
885 7fe2a942 2019-08-11 stsp differences between the corresponding objects. Both objects must be of
886 7fe2a942 2019-08-11 stsp the same type (blobs, trees, or commits). An abbreviated hash argument
887 7fe2a942 2019-08-11 stsp will be expanded to a full SHA1 hash automatically, provided the
888 63b69821 2021-10-16 stsp abbreviation is unique. If none of these interpretations produce a valid
889 63b69821 2021-10-16 stsp result or if the <code class="Fl">-P</code> option is used, and if
890 63b69821 2021-10-16 stsp <code class="Cm">got diff</code> is running in a work tree, attempt to
891 63b69821 2021-10-16 stsp interpret the two arguments as paths.</p>
892 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got diff</code> are as
893 8797b228 2019-08-04 stsp follows:</p>
894 8797b228 2019-08-04 stsp <dl class="Bl-tag">
895 1b792db0 2020-12-13 stsp <dt id="a~3"><a class="permalink" href="#a~3"><code class="Fl">-a</code></a></dt>
896 1b792db0 2020-12-13 stsp <dd>Treat file contents as ASCII text even if binary data is
897 1b792db0 2020-12-13 stsp detected.</dd>
898 63657f42 2022-09-07 stsp <dt id="C~2"><a class="permalink" href="#C~2"><code class="Fl">-C</code></a>
899 63657f42 2022-09-07 stsp <var class="Ar">number</var></dt>
900 63657f42 2022-09-07 stsp <dd>Set the number of context lines shown in the diff. By default, 3 lines
901 63657f42 2022-09-07 stsp of context are shown.</dd>
902 63b69821 2021-10-16 stsp <dt id="c~4"><a class="permalink" href="#c~4"><code class="Fl">-c</code></a>
903 63b69821 2021-10-16 stsp <var class="Ar">commit</var></dt>
904 63657f42 2022-09-07 stsp <dd>Show differences between commits in the repository. This option may be
905 63657f42 2022-09-07 stsp used up to two times. When used only once, show differences between
906 63b69821 2021-10-16 stsp the specified <var class="Ar">commit</var> and its first parent
907 63b69821 2021-10-16 stsp commit. When used twice, show differences between the two specified
909 63b69821 2021-10-16 stsp <p class="Pp">If the <code class="Fl">-c</code> option is used, all
910 63b69821 2021-10-16 stsp non-option arguments will be interpreted as paths. If one or more
911 63b69821 2021-10-16 stsp such <var class="Ar">path</var> arguments are provided, only show
912 63b69821 2021-10-16 stsp differences for the specified paths.</p>
913 461d9094 2023-07-19 stsp <p class="Pp" id="baz:+8">The expected <var class="Ar">commit</var>
914 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
915 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
916 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
917 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
918 461d9094 2023-07-19 stsp ":head" resolve to the work tree's base commit and branch
919 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
920 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
921 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
922 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and references may be
923 461d9094 2023-07-19 stsp appended with ":+" or ":-" modifiers and an
924 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent,
925 461d9094 2023-07-19 stsp respectively, by first parent traversal; for example,
926 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the HEAD reference's 2nd
927 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
928 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
929 461d9094 2023-07-19 stsp <a class="permalink" href="#baz:+8"><b class="Sy">baz:+8</b></a>
930 461d9094 2023-07-19 stsp will denote the 8th generation descendant of the commit resolved by
931 461d9094 2023-07-19 stsp the "baz" reference. If an integer does not follow the
932 461d9094 2023-07-19 stsp ":+" or ":-" modifier, a "1" is
933 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
934 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
935 63b69821 2021-10-16 stsp <p class="Pp">Cannot be used together with the
936 63b69821 2021-10-16 stsp <code class="Fl">-P</code> option.</p>
938 47f19dd5 2023-01-17 stsp <dt id="d~3"><a class="permalink" href="#d~3"><code class="Fl">-d</code></a></dt>
939 47f19dd5 2023-01-17 stsp <dd>Display diffstat of changes before the actual diff by annotating each
940 47f19dd5 2023-01-17 stsp file path or blob hash being diffed with the total number of lines
941 47f19dd5 2023-01-17 stsp added and removed. A summary line will display the total number of
942 47f19dd5 2023-01-17 stsp changes across all files.</dd>
943 63657f42 2022-09-07 stsp <dt id="P~2"><a class="permalink" href="#P~2"><code class="Fl">-P</code></a></dt>
944 63657f42 2022-09-07 stsp <dd>Interpret all arguments as paths only. This option can be used to
945 63657f42 2022-09-07 stsp resolve ambiguity in cases where paths look like tag names, reference
946 63657f42 2022-09-07 stsp names, or object IDs. This option is only valid when
947 63657f42 2022-09-07 stsp <code class="Cm">got diff</code> is invoked in a work tree.</dd>
948 2dbbbc3a 2020-07-23 stsp <dt id="r~4"><a class="permalink" href="#r~4"><code class="Fl">-r</code></a>
949 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
950 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
951 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
952 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
953 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
954 feee6923 2020-09-17 stsp <dt id="s~3"><a class="permalink" href="#s~3"><code class="Fl">-s</code></a></dt>
955 8797b228 2019-08-04 stsp <dd>Show changes staged with <code class="Cm">got stage</code> instead of
956 a462773e 2020-04-19 stsp showing local changes in the work tree. This option is only valid when
957 8797b228 2019-08-04 stsp <code class="Cm">got diff</code> is invoked in a work tree.</dd>
958 2dbbbc3a 2020-07-23 stsp <dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a></dt>
959 d8e62599 2019-10-21 stsp <dd>Ignore whitespace-only changes.</dd>
962 63b69821 2021-10-16 stsp <dt id="bl"><a class="permalink" href="#blame"><code class="Cm" id="blame">blame</code></a>
963 8797b228 2019-08-04 stsp [<code class="Fl">-c</code> <var class="Ar">commit</var>]
964 8797b228 2019-08-04 stsp [<code class="Fl">-r</code> <var class="Ar">repository-path</var>]
965 8797b228 2019-08-04 stsp <var class="Ar">path</var></dt>
967 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
968 46043f6f 2021-11-23 stsp <code class="Cm">bl</code>)</code></div>
969 46043f6f 2021-11-23 stsp Display line-by-line history of a file at the specified path.
970 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got blame</code> are as
971 8797b228 2019-08-04 stsp follows:</p>
972 8797b228 2019-08-04 stsp <dl class="Bl-tag">
973 63b69821 2021-10-16 stsp <dt id="c~5"><a class="permalink" href="#c~5"><code class="Fl">-c</code></a>
974 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
975 8797b228 2019-08-04 stsp <dd>Start traversing history at the specified
976 8797b228 2019-08-04 stsp <var class="Ar">commit</var>. The expected argument is a commit ID
977 461d9094 2023-07-19 stsp SHA1 hash, or a reference name or a keyword which will be resolved to
978 461d9094 2023-07-19 stsp a commit ID. An abbreviated hash argument will be expanded to a full
979 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
980 461d9094 2023-07-19 stsp keywords ":base" and ":head" resolve to the work
981 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
982 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to the
983 461d9094 2023-07-19 stsp tip of the work tree's current branch if invoked in a work tree,
984 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference. Keywords
985 461d9094 2023-07-19 stsp and references may be appended with ":+" or ":-"
986 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
987 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
988 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
989 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
990 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
991 461d9094 2023-07-19 stsp <a class="permalink" href="#xyz:-5"><b class="Sy" id="xyz:-5">xyz:-5</b></a>
992 461d9094 2023-07-19 stsp will denote the 5th generation ancestor of the commit resolved by the
993 461d9094 2023-07-19 stsp "xyz" reference. A ":+" or ":-" modifier
994 461d9094 2023-07-19 stsp without a trailing integer has an implicit "1" appended
995 461d9094 2023-07-19 stsp (e.g., <b class="Sy">:base:+</b> is equivalent to
996 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
997 2dbbbc3a 2020-07-23 stsp <dt id="r~5"><a class="permalink" href="#r~5"><code class="Fl">-r</code></a>
998 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
999 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
1000 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
1001 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
1002 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
1005 63b69821 2021-10-16 stsp <dt id="tr"><a class="permalink" href="#tree"><code class="Cm" id="tree">tree</code></a>
1006 63657f42 2022-09-07 stsp [<code class="Fl">-iR</code>] [<code class="Fl">-c</code>
1007 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-r</code>
1008 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">path</var>]</dt>
1010 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1011 46043f6f 2021-11-23 stsp <code class="Cm">tr</code>)</code></div>
1012 46043f6f 2021-11-23 stsp Display a listing of files and directories at the specified directory path
1013 8797b228 2019-08-04 stsp in the repository. Entries shown in this listing may carry one of the
1014 8797b228 2019-08-04 stsp following trailing annotations:
1015 8797b228 2019-08-04 stsp <table class="Bl-column">
1017 e8022e04 2019-08-13 stsp <td>@</td>
1018 e8022e04 2019-08-13 stsp <td>entry is a symbolic link</td>
1021 8797b228 2019-08-04 stsp <td>/</td>
1022 8797b228 2019-08-04 stsp <td>entry is a directory</td>
1025 8797b228 2019-08-04 stsp <td>*</td>
1026 8797b228 2019-08-04 stsp <td>entry is an executable file</td>
1029 ba0a4168 2019-08-26 stsp <td>$</td>
1030 ba0a4168 2019-08-26 stsp <td>entry is a Git submodule</td>
1033 2dbbbc3a 2020-07-23 stsp <p class="Pp">Symbolic link entries are also annotated with the target path
1034 2dbbbc3a 2020-07-23 stsp of the link.</p>
1035 8797b228 2019-08-04 stsp <p class="Pp">If no <var class="Ar">path</var> is specified, list the
1036 8797b228 2019-08-04 stsp repository path corresponding to the current directory of the work tree,
1037 8797b228 2019-08-04 stsp or the root directory of the repository if there is no work tree.</p>
1038 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got tree</code> are as
1039 8797b228 2019-08-04 stsp follows:</p>
1040 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1041 63b69821 2021-10-16 stsp <dt id="c~6"><a class="permalink" href="#c~6"><code class="Fl">-c</code></a>
1042 8797b228 2019-08-04 stsp <var class="Ar">commit</var></dt>
1043 8797b228 2019-08-04 stsp <dd>List files and directories as they appear in the specified
1044 461d9094 2023-07-19 stsp <var class="Ar">commit</var>.
1045 461d9094 2023-07-19 stsp <p class="Pp" id="spam:-3">The expected argument is a commit ID SHA1
1046 461d9094 2023-07-19 stsp hash, or a reference name or a keyword which will be resolved to a
1047 461d9094 2023-07-19 stsp commit ID. An abbreviated hash argument will be expanded to a full
1048 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
1049 461d9094 2023-07-19 stsp keywords ":base" and ":head" resolve to the work
1050 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
1051 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to
1052 461d9094 2023-07-19 stsp the tip of the work tree's current branch if invoked in a work tree,
1053 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference.
1054 461d9094 2023-07-19 stsp Keywords and references may be appended with ":+" or
1055 461d9094 2023-07-19 stsp ":-" modifiers and an optional integer N to denote the Nth
1056 461d9094 2023-07-19 stsp descendant or antecedent by first parent traversal, respectively;
1057 461d9094 2023-07-19 stsp for example, <b class="Sy">:head:-2</b> denotes the work tree branch
1058 461d9094 2023-07-19 stsp head's 2nd generation ancestor, and <b class="Sy">:base:+4</b>
1059 461d9094 2023-07-19 stsp denotes the 4th generation descendant of the work tree's base
1060 461d9094 2023-07-19 stsp commit. Similarly,
1061 461d9094 2023-07-19 stsp <a class="permalink" href="#spam:-3"><b class="Sy">spam:-3</b></a>
1062 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
1063 461d9094 2023-07-19 stsp the "spam" reference. A ":+" or ":-"
1064 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
1065 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1066 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1068 63657f42 2022-09-07 stsp <dt id="i"><a class="permalink" href="#i"><code class="Fl">-i</code></a></dt>
1069 63657f42 2022-09-07 stsp <dd>Show object IDs of files (blob objects) and directories (tree
1070 63657f42 2022-09-07 stsp objects).</dd>
1071 63657f42 2022-09-07 stsp <dt id="R~4"><a class="permalink" href="#R~4"><code class="Fl">-R</code></a></dt>
1072 63657f42 2022-09-07 stsp <dd>Recurse into sub-directories in the repository.</dd>
1073 2dbbbc3a 2020-07-23 stsp <dt id="r~6"><a class="permalink" href="#r~6"><code class="Fl">-r</code></a>
1074 8797b228 2019-08-04 stsp <var class="Ar">repository-path</var></dt>
1075 8797b228 2019-08-04 stsp <dd>Use the repository at the specified path. If not specified, assume the
1076 8797b228 2019-08-04 stsp repository is located at or above the current working directory. If
1077 8797b228 2019-08-04 stsp this directory is a <code class="Nm">got</code> work tree, use the
1078 8797b228 2019-08-04 stsp repository path associated with this work tree.</dd>
1081 2dbbbc3a 2020-07-23 stsp <dt id="ref"><a class="permalink" href="#ref"><code class="Cm">ref</code></a>
1082 63657f42 2022-09-07 stsp [<code class="Fl">-dlt</code>] [<code class="Fl">-c</code>
1083 63657f42 2022-09-07 stsp <var class="Ar">object</var>] [<code class="Fl">-r</code>
1084 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1085 63657f42 2022-09-07 stsp <var class="Ar">reference</var>] [<var class="Ar">name</var>]</dt>
1086 8797b228 2019-08-04 stsp <dd>Manage references in a repository.
1087 b213cbf7 2020-03-23 stsp <p class="Pp">References may be listed, created, deleted, and changed. When
1088 b213cbf7 2020-03-23 stsp creating, deleting, or changing a reference the specified
1089 b213cbf7 2020-03-23 stsp <var class="Ar">name</var> must be an absolute reference name, i.e. it
1090 b213cbf7 2020-03-23 stsp must begin with “refs/”.</p>
1091 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got ref</code> are as
1092 8797b228 2019-08-04 stsp follows:</p>
1093 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1094 63b69821 2021-10-16 stsp <dt id="c~7"><a class="permalink" href="#c~7"><code class="Fl">-c</code></a>
1095 b213cbf7 2020-03-23 stsp <var class="Ar">object</var></dt>
1096 b213cbf7 2020-03-23 stsp <dd>Create a reference or change an existing reference. The reference with
1097 b213cbf7 2020-03-23 stsp the specified <var class="Ar">name</var> will point at the specified
1098 461d9094 2023-07-19 stsp <var class="Ar">object</var>.
1099 461d9094 2023-07-19 stsp <p class="Pp" id="tagged:-3">The expected <var class="Ar">object</var>
1100 461d9094 2023-07-19 stsp argument is an ID SHA1 hash or an existing reference or tag name or
1101 461d9094 2023-07-19 stsp a keyword which will be resolved to the ID of a corresponding
1102 461d9094 2023-07-19 stsp commit, tree, tag, or blob object. An abbreviated hash argument will
1103 461d9094 2023-07-19 stsp be expanded to a full SHA1 hash automatically, provided the
1104 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
1105 461d9094 2023-07-19 stsp ":head" resolve to the work tree's base commit and branch
1106 461d9094 2023-07-19 stsp head, respectively. The former is only valid if invoked in a work
1107 461d9094 2023-07-19 stsp tree, while the latter will resolve to the tip of the work tree's
1108 461d9094 2023-07-19 stsp current branch if invoked in a work tree, otherwise it will resolve
1109 461d9094 2023-07-19 stsp to the repository's HEAD reference. Keywords and reference names may
1110 461d9094 2023-07-19 stsp be appended with ":+" or ":-" modifiers and an
1111 461d9094 2023-07-19 stsp optional integer N to denote the Nth descendant or antecedent by
1112 461d9094 2023-07-19 stsp first parent traversal, respectively; for example,
1113 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1114 461d9094 2023-07-19 stsp generation ancestor, and
1115 461d9094 2023-07-19 stsp <a class="permalink" href="#tagged:-3"><b class="Sy">tagged:-3</b></a>
1116 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by
1117 461d9094 2023-07-19 stsp the "tagged" reference. If an integer does not follow the
1118 461d9094 2023-07-19 stsp ":+" or ":-" modifier, a "1" is
1119 461d9094 2023-07-19 stsp implicitly appended (e.g., <b class="Sy">:head:-</b> is equivalent
1120 461d9094 2023-07-19 stsp to <b class="Sy">:head:-1</b>).</p>
1121 461d9094 2023-07-19 stsp <p class="Pp">Cannot be used together with any other options except
1122 461d9094 2023-07-19 stsp <code class="Fl">-r</code>.</p>
1124 47f19dd5 2023-01-17 stsp <dt id="d~4"><a class="permalink" href="#d~4"><code class="Fl">-d</code></a></dt>
1125 63657f42 2022-09-07 stsp <dd>Delete the reference with the specified <var class="Ar">name</var>
1126 63657f42 2022-09-07 stsp from the repository. Any commit, tree, tag, and blob objects belonging
1127 63657f42 2022-09-07 stsp to deleted references remain in the repository and may be removed
1128 63657f42 2022-09-07 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
1129 63657f42 2022-09-07 stsp cleanup</code>. Cannot be used together with any other options except
1130 63657f42 2022-09-07 stsp <code class="Fl">-r</code>.</dd>
1131 63657f42 2022-09-07 stsp <dt id="l~4"><a class="permalink" href="#l~4"><code class="Fl">-l</code></a></dt>
1132 63657f42 2022-09-07 stsp <dd>List references in the repository. If no <var class="Ar">name</var> is
1133 63657f42 2022-09-07 stsp specified, list all existing references in the repository. If
1134 63657f42 2022-09-07 stsp <var class="Ar">name</var> is a reference namespace, list all
1135 63657f42 2022-09-07 stsp references in this namespace. Otherwise, show only the reference with
1136 63657f42 2022-09-07 stsp the given <var class="Ar">name</var>. Cannot be used together with any
1137 63657f42 2022-09-07 stsp other options except <code class="Fl">-r</code> and
1138 63657f42 2022-09-07 stsp <code class="Fl">-t</code>.</dd>
1139 63657f42 2022-09-07 stsp <dt id="r~7"><a class="permalink" href="#r~7"><code class="Fl">-r</code></a>
1140 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
1141 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
1142 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
1143 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
1144 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
1145 feee6923 2020-09-17 stsp <dt id="s~4"><a class="permalink" href="#s~4"><code class="Fl">-s</code></a>
1146 b213cbf7 2020-03-23 stsp <var class="Ar">reference</var></dt>
1147 b213cbf7 2020-03-23 stsp <dd>Create a symbolic reference, or change an existing symbolic reference.
1148 b213cbf7 2020-03-23 stsp The symbolic reference with the specified <var class="Ar">name</var>
1149 b213cbf7 2020-03-23 stsp will point at the specified <var class="Ar">reference</var> which must
1150 b213cbf7 2020-03-23 stsp already exist in the repository. Care should be taken not to create
1151 b213cbf7 2020-03-23 stsp loops between references when this option is used. Cannot be used
1152 b213cbf7 2020-03-23 stsp together with any other options except
1153 b213cbf7 2020-03-23 stsp <code class="Fl">-r</code>.</dd>
1154 bd0bf387 2024-04-23 stsp <dt id="t~3"><a class="permalink" href="#t~3"><code class="Fl">-t</code></a></dt>
1155 63657f42 2022-09-07 stsp <dd>Sort listed references by modification time (most recently modified
1156 63657f42 2022-09-07 stsp first) instead of sorting by lexicographical order. Use of this option
1157 63657f42 2022-09-07 stsp requires the <code class="Fl">-l</code> option to be used as
1158 63657f42 2022-09-07 stsp well.</dd>
1161 63b69821 2021-10-16 stsp <dt id="br"><a class="permalink" href="#branch"><code class="Cm" id="branch">branch</code></a>
1162 63657f42 2022-09-07 stsp [<code class="Fl">-lnt</code>] [<code class="Fl">-c</code>
1163 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-d</code>
1164 63657f42 2022-09-07 stsp <var class="Ar">name</var>] [<code class="Fl">-r</code>
1165 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<var class="Ar">name</var>]</dt>
1167 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1168 46043f6f 2021-11-23 stsp <code class="Cm">br</code>)</code></div>
1169 46043f6f 2021-11-23 stsp Create, list, or delete branches.
1170 039953c9 2021-03-22 stsp <p class="Pp">Local branches are managed via references which live in the
1171 8797b228 2019-08-04 stsp “refs/heads/” reference namespace. The
1172 def5be4a 2021-08-31 stsp <code class="Cm">got branch</code> command creates references in this
1173 def5be4a 2021-08-31 stsp namespace only.</p>
1174 b078d5c4 2022-03-23 stsp <p class="Pp">When deleting branches, the specified
1175 def5be4a 2021-08-31 stsp <var class="Ar">name</var> is searched in the “refs/heads”
1176 b078d5c4 2022-03-23 stsp reference namespace first. If no corresponding branch is found, the
1177 def5be4a 2021-08-31 stsp “refs/remotes” namespace will be searched next.</p>
1178 2b499410 2019-10-06 stsp <p class="Pp">If invoked in a work tree without any arguments, print the
1179 7c3b4ab8 2020-02-25 stsp name of the work tree's current branch.</p>
1180 7c3b4ab8 2020-02-25 stsp <p class="Pp">If a <var class="Ar">name</var> argument is passed, attempt to
1181 7c3b4ab8 2020-02-25 stsp create a branch reference with the given name. By default the new branch
1182 7c3b4ab8 2020-02-25 stsp reference will point at the latest commit on the work tree's current
1183 7c3b4ab8 2020-02-25 stsp branch if invoked in a work tree, and otherwise to a commit resolved via
1184 7c3b4ab8 2020-02-25 stsp the repository's HEAD reference.</p>
1185 7c3b4ab8 2020-02-25 stsp <p class="Pp">If invoked in a work tree, once the branch was created
1186 7c3b4ab8 2020-02-25 stsp successfully switch the work tree's head reference to the newly created
1187 7c3b4ab8 2020-02-25 stsp branch and update files across the entire work tree, just like
1188 7c3b4ab8 2020-02-25 stsp <code class="Cm">got update -b</code> <var class="Ar">name</var> would
1189 7c3b4ab8 2020-02-25 stsp do. Show the status of each affected file, using the following status
1190 7c3b4ab8 2020-02-25 stsp codes:</p>
1191 7c3b4ab8 2020-02-25 stsp <table class="Bl-column">
1193 7c3b4ab8 2020-02-25 stsp <td>U</td>
1194 7c3b4ab8 2020-02-25 stsp <td>file was updated and contained no local changes</td>
1197 7c3b4ab8 2020-02-25 stsp <td>G</td>
1198 7c3b4ab8 2020-02-25 stsp <td>file was updated and local changes were merged cleanly</td>
1201 7c3b4ab8 2020-02-25 stsp <td>C</td>
1202 7c3b4ab8 2020-02-25 stsp <td>file was updated and conflicts occurred during merge</td>
1205 7c3b4ab8 2020-02-25 stsp <td>D</td>
1206 7c3b4ab8 2020-02-25 stsp <td>file was deleted</td>
1209 7c3b4ab8 2020-02-25 stsp <td>A</td>
1210 7c3b4ab8 2020-02-25 stsp <td>new file was added</td>
1213 7c3b4ab8 2020-02-25 stsp <td>~</td>
1214 7c3b4ab8 2020-02-25 stsp <td>versioned file is obstructed by a non-regular file</td>
1217 7c3b4ab8 2020-02-25 stsp <td>!</td>
1218 7c3b4ab8 2020-02-25 stsp <td>a missing versioned file was restored</td>
1221 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got branch</code> are as
1222 8797b228 2019-08-04 stsp follows:</p>
1223 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1224 63b69821 2021-10-16 stsp <dt id="c~8"><a class="permalink" href="#c~8"><code class="Fl">-c</code></a>
1225 cc85973b 2019-11-27 stsp <var class="Ar">commit</var></dt>
1226 cc85973b 2019-11-27 stsp <dd>Make a newly created branch reference point at the specified
1227 461d9094 2023-07-19 stsp <var class="Ar">commit</var>. The expected argument is a commit ID
1228 461d9094 2023-07-19 stsp SHA1 hash, or a reference name or keyword which will be resolved to a
1229 461d9094 2023-07-19 stsp commit ID. An abbreviated hash argument will be expanded to a full
1230 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
1231 461d9094 2023-07-19 stsp keywords ":base" and ":head" resolve to the work
1232 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
1233 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to the
1234 461d9094 2023-07-19 stsp tip of the work tree's current branch if invoked in a work tree,
1235 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference. Keywords
1236 461d9094 2023-07-19 stsp and references may be appended with ":+" or ":-"
1237 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
1238 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
1239 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1240 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1241 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
1242 461d9094 2023-07-19 stsp <a class="permalink" href="#foobar:+3"><b class="Sy" id="foobar:+3">foobar:+3</b></a>
1243 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
1244 461d9094 2023-07-19 stsp the "foobar" reference. A ":+" or ":-"
1245 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
1246 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1247 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
1248 47f19dd5 2023-01-17 stsp <dt id="d~5"><a class="permalink" href="#d~5"><code class="Fl">-d</code></a>
1249 63657f42 2022-09-07 stsp <var class="Ar">name</var></dt>
1250 63657f42 2022-09-07 stsp <dd>Delete the branch with the specified <var class="Ar">name</var> from
1251 63657f42 2022-09-07 stsp the “refs/heads” or “refs/remotes”
1252 63657f42 2022-09-07 stsp reference namespace.
1253 63657f42 2022-09-07 stsp <p class="Pp">Only the branch reference is deleted. Any commit, tree,
1254 63657f42 2022-09-07 stsp and blob objects belonging to the branch remain in the repository
1255 63657f42 2022-09-07 stsp and may be removed separately with Git's garbage collector or
1256 63657f42 2022-09-07 stsp <code class="Cm">gotadmin cleanup</code>.</p>
1258 2dbbbc3a 2020-07-23 stsp <dt id="l~5"><a class="permalink" href="#l~5"><code class="Fl">-l</code></a></dt>
1259 039953c9 2021-03-22 stsp <dd>List all existing branches in the repository, including copies of
1260 039953c9 2021-03-22 stsp remote repositories' branches in the “refs/remotes/”
1261 039953c9 2021-03-22 stsp reference namespace.
1262 039953c9 2021-03-22 stsp <p class="Pp">If invoked in a work tree, the work tree's current branch
1263 461d9094 2023-07-19 stsp is shown with one of the following annotations:</p>
1264 8797b228 2019-08-04 stsp <table class="Bl-column">
1266 8797b228 2019-08-04 stsp <td>*</td>
1267 a8f7f066 2023-08-29 stsp <td>work tree's base commit and the base commit of all tracked files
1268 a8f7f066 2023-08-29 stsp matches the branch tip</td>
1271 8797b228 2019-08-04 stsp <td>~</td>
1272 a8f7f066 2023-08-29 stsp <td>work tree comprises mixed commits or its base commit is
1273 a8f7f066 2023-08-29 stsp out-of-date</td>
1277 63657f42 2022-09-07 stsp <dt id="n"><a class="permalink" href="#n"><code class="Fl">-n</code></a></dt>
1278 63657f42 2022-09-07 stsp <dd>Do not switch and update the work tree after creating a new
1279 63657f42 2022-09-07 stsp branch.</dd>
1280 63657f42 2022-09-07 stsp <dt id="r~8"><a class="permalink" href="#r~8"><code class="Fl">-r</code></a>
1281 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var></dt>
1282 63657f42 2022-09-07 stsp <dd>Use the repository at the specified path. If not specified, assume the
1283 63657f42 2022-09-07 stsp repository is located at or above the current working directory. If
1284 63657f42 2022-09-07 stsp this directory is a <code class="Nm">got</code> work tree, use the
1285 63657f42 2022-09-07 stsp repository path associated with this work tree.</dd>
1286 bd0bf387 2024-04-23 stsp <dt id="t~4"><a class="permalink" href="#t~4"><code class="Fl">-t</code></a></dt>
1287 46043f6f 2021-11-23 stsp <dd>Sort listed branches by modification time (most recently modified
1288 46043f6f 2021-11-23 stsp first) instead of sorting by lexicographical order. Branches in the
1289 46043f6f 2021-11-23 stsp “refs/heads/” reference namespace are listed before
1290 46043f6f 2021-11-23 stsp branches in “refs/remotes/” regardless. Use of this
1291 46043f6f 2021-11-23 stsp option requires the <code class="Fl">-l</code> option to be used as
1292 46043f6f 2021-11-23 stsp well.</dd>
1295 2dbbbc3a 2020-07-23 stsp <dt id="tag"><a class="permalink" href="#tag"><code class="Cm">tag</code></a>
1296 63657f42 2022-09-07 stsp [<code class="Fl">-lVv</code>] [<code class="Fl">-c</code>
1297 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-m</code>
1298 63657f42 2022-09-07 stsp <var class="Ar">message</var>] [<code class="Fl">-r</code>
1299 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-s</code>
1300 63657f42 2022-09-07 stsp <var class="Ar">signer-id</var>] <var class="Ar">name</var></dt>
1301 f447d26b 2019-08-23 stsp <dd>Manage tags in a repository.
1302 f447d26b 2019-08-23 stsp <p class="Pp">Tags are managed via references which live in the
1303 f447d26b 2019-08-23 stsp “refs/tags/” reference namespace. The <code class="Cm">got
1304 f447d26b 2019-08-23 stsp tag</code> command operates on references in this namespace only.
1305 f447d26b 2019-08-23 stsp References in this namespace point at tag objects which contain a
1306 f447d26b 2019-08-23 stsp pointer to another object, a tag message, as well as author and
1307 f447d26b 2019-08-23 stsp timestamp information.</p>
1308 7c3b4ab8 2020-02-25 stsp <p class="Pp">Attempt to create a tag with the given
1309 7c3b4ab8 2020-02-25 stsp <var class="Ar">name</var>, and make this tag point at the given
1310 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var>. If no commit is specified, default to the
1311 7c3b4ab8 2020-02-25 stsp latest commit on the work tree's current branch if invoked in a work
1312 7c3b4ab8 2020-02-25 stsp tree, and to a commit resolved via the repository's HEAD reference
1313 7c3b4ab8 2020-02-25 stsp otherwise.</p>
1314 f447d26b 2019-08-23 stsp <p class="Pp">The options for <code class="Cm">got tag</code> are as
1315 f447d26b 2019-08-23 stsp follows:</p>
1316 f447d26b 2019-08-23 stsp <dl class="Bl-tag">
1317 63b69821 2021-10-16 stsp <dt id="c~9"><a class="permalink" href="#c~9"><code class="Fl">-c</code></a>
1318 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var></dt>
1319 7c3b4ab8 2020-02-25 stsp <dd>Make the newly created tag reference point at the specified
1320 7c3b4ab8 2020-02-25 stsp <var class="Ar">commit</var>. The expected
1321 461d9094 2023-07-19 stsp <var class="Ar">commit</var> argument is a commit ID SHA1 hash, or a
1322 461d9094 2023-07-19 stsp reference or keyword which will be resolved to a commit ID. An
1323 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
1324 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
1325 461d9094 2023-07-19 stsp ":base" and ":head" resolve to the work tree's
1326 461d9094 2023-07-19 stsp base commit and branch head, respectively. The former is only valid if
1327 461d9094 2023-07-19 stsp invoked in a work tree, while the latter will resolve to the tip of
1328 461d9094 2023-07-19 stsp the work tree's current branch if invoked in a work tree, otherwise it
1329 461d9094 2023-07-19 stsp will resolve to the repository's HEAD reference. Keywords and
1330 461d9094 2023-07-19 stsp references may be appended with ":+" or ":-"
1331 461d9094 2023-07-19 stsp modifiers and an optional integer N to denote the Nth descendant or
1332 461d9094 2023-07-19 stsp antecedent by first parent traversal, respectively; for example,
1333 461d9094 2023-07-19 stsp <b class="Sy">:head:-2</b> denotes the work tree branch head's 2nd
1334 461d9094 2023-07-19 stsp generation ancestor, and <b class="Sy">:base:+4</b> denotes the 4th
1335 461d9094 2023-07-19 stsp generation descendant of the work tree's base commit. Similarly,
1336 461d9094 2023-07-19 stsp <a class="permalink" href="#eggs:-3"><b class="Sy" id="eggs:-3">eggs:-3</b></a>
1337 461d9094 2023-07-19 stsp will denote the 3rd generation ancestor of the commit resolved by the
1338 461d9094 2023-07-19 stsp "eggs" reference. A ":+" or ":-"
1339 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
1340 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1341 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</dd>
1342 63657f42 2022-09-07 stsp <dt id="l~6"><a class="permalink" href="#l~6"><code class="Fl">-l</code></a></dt>
1343 63657f42 2022-09-07 stsp <dd>List all existing tags in the repository instead of creating a new
1344 63657f42 2022-09-07 stsp tag. If a <var class="Ar">name</var> argument is passed, show only the
1345 63657f42 2022-09-07 stsp tag with the given <var class="Ar">name</var>.</dd>
1346 2dbbbc3a 2020-07-23 stsp <dt id="m~3"><a class="permalink" href="#m~3"><code class="Fl">-m</code></a>
1347 f447d26b 2019-08-23 stsp <var class="Ar">message</var></dt>
1348 7c3b4ab8 2020-02-25 stsp <dd>Use the specified tag message when creating the new tag. Without the
1349 cc85973b 2019-11-27 stsp <code class="Fl">-m</code> option, <code class="Cm">got tag</code>
1350 f447d26b 2019-08-23 stsp opens a temporary file in an editor where a tag message can be
1351 461d9094 2023-07-19 stsp written. Quitting the editor without saving the file will abort the
1352 461d9094 2023-07-19 stsp tag operation.</dd>
1353 2dbbbc3a 2020-07-23 stsp <dt id="r~9"><a class="permalink" href="#r~9"><code class="Fl">-r</code></a>
1354 f447d26b 2019-08-23 stsp <var class="Ar">repository-path</var></dt>
1355 f447d26b 2019-08-23 stsp <dd>Use the repository at the specified path. If not specified, assume the
1356 f447d26b 2019-08-23 stsp repository is located at or above the current working directory. If
1357 f447d26b 2019-08-23 stsp this directory is a <code class="Nm">got</code> work tree, use the
1358 f447d26b 2019-08-23 stsp repository path associated with this work tree.</dd>
1359 376d4d52 2022-07-04 stsp <dt id="s~5"><a class="permalink" href="#s~5"><code class="Fl">-s</code></a>
1360 376d4d52 2022-07-04 stsp <var class="Ar">signer-id</var></dt>
1361 376d4d52 2022-07-04 stsp <dd>While creating a new tag, sign this tag with the identity given in
1362 376d4d52 2022-07-04 stsp <var class="Ar">signer-id</var>.
1363 376d4d52 2022-07-04 stsp <p class="Pp">For SSH-based signatures, <var class="Ar">signer-id</var>
1364 376d4d52 2022-07-04 stsp is the path to a file which may refer to either a private SSH key,
1365 376d4d52 2022-07-04 stsp or a public SSH key with the private half available via
1366 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh-agent, section 1">ssh-agent(1)</a>.
1367 376d4d52 2022-07-04 stsp <code class="Cm">got tag</code> will sign the tag object by invoking
1368 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="ssh-keygen, section 1">ssh-keygen(1)</a>
1369 63657f42 2022-09-07 stsp with the <code class="Fl">-Y</code> <code class="Cm">sign</code>
1370 376d4d52 2022-07-04 stsp command, using the signature namespace “git” for
1371 376d4d52 2022-07-04 stsp compatibility with <a class="Xr" aria-label="git, section
1372 376d4d52 2022-07-04 stsp 1">git(1)</a>.</p>
1374 376d4d52 2022-07-04 stsp <dt id="V~2"><a class="permalink" href="#V~2"><code class="Fl">-V</code></a></dt>
1375 376d4d52 2022-07-04 stsp <dd>Verify tag object signatures. If a <var class="Ar">name</var> is
1376 376d4d52 2022-07-04 stsp specified, show and verify the tag object with the provided name.
1377 376d4d52 2022-07-04 stsp Otherwise, list all tag objects and verify signatures where present.
1378 376d4d52 2022-07-04 stsp <p class="Pp"><code class="Cm">got tag</code> verifies SSH-based
1379 376d4d52 2022-07-04 stsp signatures by invoking <a class="Xr" aria-label="ssh-keygen, section
1380 376d4d52 2022-07-04 stsp 1">ssh-keygen(1)</a> with the options <code class="Fl">-Y</code>
1381 63657f42 2022-09-07 stsp <code class="Cm">verify</code> <code class="Fl">-f</code>
1382 376d4d52 2022-07-04 stsp <var class="Ar">allowed_signers</var>. A path to the
1383 376d4d52 2022-07-04 stsp <var class="Ar">allowed_signers</var> file must be set in
1384 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>,
1385 376d4d52 2022-07-04 stsp otherwise verification is impossible.</p>
1387 63657f42 2022-09-07 stsp <dt id="v~3"><a class="permalink" href="#v~3"><code class="Fl">-v</code></a></dt>
1388 63657f42 2022-09-07 stsp <dd>Verbose mode. During SSH signature creation and verification this
1389 63657f42 2022-09-07 stsp option will be passed to <a class="Xr" aria-label="ssh-keygen, section
1390 63657f42 2022-09-07 stsp 1">ssh-keygen(1)</a>. Multiple -v options increase the verbosity. The
1391 63657f42 2022-09-07 stsp maximum is 3.</dd>
1393 f447d26b 2019-08-23 stsp <p class="Pp">By design, the <code class="Cm">got tag</code> command will
1394 f447d26b 2019-08-23 stsp not delete tags or change existing tags. If a tag must be deleted, the
1395 f447d26b 2019-08-23 stsp <code class="Cm">got ref</code> command may be used to delete a tag's
1396 f447d26b 2019-08-23 stsp reference. This should only be done if the tag has not already been
1397 f447d26b 2019-08-23 stsp copied to another repository.</p>
1399 2dbbbc3a 2020-07-23 stsp <dt id="add"><a class="permalink" href="#add"><code class="Cm">add</code></a>
1400 63657f42 2022-09-07 stsp [<code class="Fl">-IR</code>] <var class="Ar">path ...</var></dt>
1401 8797b228 2019-08-04 stsp <dd>Schedule unversioned files in a work tree for addition to the repository
1402 16cd1323 2021-07-26 stsp in the next commit. By default, files which match a <code class="Cm">got
1403 16cd1323 2021-07-26 stsp status</code> ignore pattern will not be added.
1404 41ae98c9 2023-06-23 stsp <p class="Pp">If a <var class="Ar">path</var> mentioned in the command line
1405 41ae98c9 2023-06-23 stsp is not an unversioned file then <code class="Cm">got add</code> may
1406 41ae98c9 2023-06-23 stsp raise an error. To avoid unnecessary errors from paths picked up by file
1407 41ae98c9 2023-06-23 stsp globbing patterns in the shell, paths in the argument list will be
1408 41ae98c9 2023-06-23 stsp silently ignored if they are not reported by <code class="Cm">got
1409 41ae98c9 2023-06-23 stsp status</code> at all, or if they are reported with one of the following
1410 41ae98c9 2023-06-23 stsp status codes and do not have changes staged via <code class="Cm">got
1411 41ae98c9 2023-06-23 stsp stage</code>:</p>
1412 41ae98c9 2023-06-23 stsp <table class="Bl-column">
1414 41ae98c9 2023-06-23 stsp <td>M</td>
1415 41ae98c9 2023-06-23 stsp <td>modified file</td>
1418 41ae98c9 2023-06-23 stsp <td>A</td>
1419 41ae98c9 2023-06-23 stsp <td>file scheduled for addition in next commit</td>
1422 41ae98c9 2023-06-23 stsp <td>C</td>
1423 41ae98c9 2023-06-23 stsp <td>modified or added file which contains merge conflicts</td>
1426 41ae98c9 2023-06-23 stsp <td>m</td>
1427 41ae98c9 2023-06-23 stsp <td>modified file modes (executable bit only)</td>
1430 cc85973b 2019-11-27 stsp <p class="Pp">The options for <code class="Cm">got add</code> are as
1431 cc85973b 2019-11-27 stsp follows:</p>
1432 cc85973b 2019-11-27 stsp <dl class="Bl-tag">
1433 63657f42 2022-09-07 stsp <dt id="I~3"><a class="permalink" href="#I~3"><code class="Fl">-I</code></a></dt>
1434 63657f42 2022-09-07 stsp <dd>Add files even if they match a <code class="Cm">got status</code>
1435 63657f42 2022-09-07 stsp ignore pattern.</dd>
1436 2dbbbc3a 2020-07-23 stsp <dt id="R~5"><a class="permalink" href="#R~5"><code class="Fl">-R</code></a></dt>
1437 cc85973b 2019-11-27 stsp <dd>Permit recursion into directories. If this option is not specified,
1438 cc85973b 2019-11-27 stsp <code class="Cm">got add</code> will refuse to run if a specified
1439 cc85973b 2019-11-27 stsp <var class="Ar">path</var> is a directory.</dd>
1442 63b69821 2021-10-16 stsp <dt id="rm"><a class="permalink" href="#remove"><code class="Cm" id="remove">remove</code></a>
1443 63657f42 2022-09-07 stsp [<code class="Fl">-fkR</code>] [<code class="Fl">-s</code>
1444 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var>] <var class="Ar">path ...</var></dt>
1446 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1447 46043f6f 2021-11-23 stsp <code class="Cm">rm</code>)</code></div>
1448 46043f6f 2021-11-23 stsp Remove versioned files from a work tree and schedule them for deletion from
1449 46043f6f 2021-11-23 stsp the repository in the next commit.
1450 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got remove</code> are as
1451 8797b228 2019-08-04 stsp follows:</p>
1452 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1453 2dbbbc3a 2020-07-23 stsp <dt id="f"><a class="permalink" href="#f"><code class="Fl">-f</code></a></dt>
1454 b078d5c4 2022-03-23 stsp <dd>Perform the operation even if a file contains local modifications, and
1455 b078d5c4 2022-03-23 stsp do not raise an error if a specified <var class="Ar">path</var> does
1456 b078d5c4 2022-03-23 stsp not exist on disk.</dd>
1457 2dbbbc3a 2020-07-23 stsp <dt id="k"><a class="permalink" href="#k"><code class="Fl">-k</code></a></dt>
1458 8b679b4b 2020-02-17 stsp <dd>Keep affected files on disk.</dd>
1459 2dbbbc3a 2020-07-23 stsp <dt id="R~6"><a class="permalink" href="#R~6"><code class="Fl">-R</code></a></dt>
1460 8b679b4b 2020-02-17 stsp <dd>Permit recursion into directories. If this option is not specified,
1461 8b679b4b 2020-02-17 stsp <code class="Cm">got remove</code> will refuse to run if a specified
1462 8b679b4b 2020-02-17 stsp <var class="Ar">path</var> is a directory.</dd>
1463 376d4d52 2022-07-04 stsp <dt id="s~6"><a class="permalink" href="#s~6"><code class="Fl">-s</code></a>
1464 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var></dt>
1465 feee6923 2020-09-17 stsp <dd>Only delete files with a modification status matching one of the
1466 feee6923 2020-09-17 stsp single-character status codes contained in the
1467 feee6923 2020-09-17 stsp <var class="Ar">status-codes</var> argument. The following status
1468 feee6923 2020-09-17 stsp codes may be specified:
1469 feee6923 2020-09-17 stsp <table class="Bl-column">
1471 feee6923 2020-09-17 stsp <td>M</td>
1472 feee6923 2020-09-17 stsp <td>modified file (this implies the <code class="Fl">-f</code>
1473 feee6923 2020-09-17 stsp option)</td>
1476 feee6923 2020-09-17 stsp <td>!</td>
1477 feee6923 2020-09-17 stsp <td>versioned file expected on disk but missing</td>
1483 b078d5c4 2022-03-23 stsp <dt id="pa"><a class="permalink" href="#patch"><code class="Cm" id="patch">patch</code></a>
1484 63657f42 2022-09-07 stsp [<code class="Fl">-nR</code>] [<code class="Fl">-c</code>
1485 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-p</code>
1486 63657f42 2022-09-07 stsp <var class="Ar">strip-count</var>] [<var class="Ar">patchfile</var>]</dt>
1488 b078d5c4 2022-03-23 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1489 b078d5c4 2022-03-23 stsp <code class="Cm">pa</code>)</code></div>
1490 b078d5c4 2022-03-23 stsp Apply changes from <var class="Ar">patchfile</var> to files in a work tree.
1491 b078d5c4 2022-03-23 stsp Files added or removed by a patch will be scheduled for addition or
1492 b078d5c4 2022-03-23 stsp removal in the work tree.
1493 b078d5c4 2022-03-23 stsp <p class="Pp">The patch must be in the unified diff format as produced by
1494 376d4d52 2022-07-04 stsp <code class="Cm">got diff</code>, <a class="Xr" aria-label="git-diff,
1495 376d4d52 2022-07-04 stsp section 1">git-diff(1)</a>, or by <a class="Xr" aria-label="diff,
1496 376d4d52 2022-07-04 stsp section 1">diff(1)</a> and <a class="Xr" aria-label="cvs, section
1497 376d4d52 2022-07-04 stsp 1">cvs(1)</a> diff when invoked with their <code class="Fl">-u</code>
1498 376d4d52 2022-07-04 stsp options. If no <var class="Ar">patchfile</var> argument is provided,
1499 376d4d52 2022-07-04 stsp read unified diff data from standard input instead.</p>
1500 b078d5c4 2022-03-23 stsp <p class="Pp">If the <var class="Ar">patchfile</var> contains multiple
1501 b078d5c4 2022-03-23 stsp patches, then attempt to apply each of them in sequence.</p>
1502 b078d5c4 2022-03-23 stsp <p class="Pp">Show the status of each affected file, using the following
1503 b078d5c4 2022-03-23 stsp status codes:</p>
1504 b078d5c4 2022-03-23 stsp <table class="Bl-column">
1506 b078d5c4 2022-03-23 stsp <td>M</td>
1507 b078d5c4 2022-03-23 stsp <td>file was modified</td>
1510 376d4d52 2022-07-04 stsp <td>G</td>
1511 376d4d52 2022-07-04 stsp <td>file was merged using a merge-base found in the repository</td>
1514 376d4d52 2022-07-04 stsp <td>C</td>
1515 376d4d52 2022-07-04 stsp <td>file was merged and conflicts occurred during merge</td>
1518 b078d5c4 2022-03-23 stsp <td>D</td>
1519 b078d5c4 2022-03-23 stsp <td>file was deleted</td>
1522 b078d5c4 2022-03-23 stsp <td>A</td>
1523 b078d5c4 2022-03-23 stsp <td>file was added</td>
1526 b078d5c4 2022-03-23 stsp <td>#</td>
1527 b078d5c4 2022-03-23 stsp <td>failed to patch the file</td>
1530 b078d5c4 2022-03-23 stsp <p class="Pp">If a change does not match at its exact line number, attempt
1531 b078d5c4 2022-03-23 stsp to apply it somewhere else in the file if a good spot can be found.
1532 b078d5c4 2022-03-23 stsp Otherwise, the patch will fail to apply.</p>
1533 b078d5c4 2022-03-23 stsp <p class="Pp"><code class="Nm">got</code> <code class="Cm">patch</code> will
1534 b078d5c4 2022-03-23 stsp refuse to apply a patch if certain preconditions are not met. Files to
1535 b078d5c4 2022-03-23 stsp be deleted must already be under version control, and must not have been
1536 b078d5c4 2022-03-23 stsp scheduled for deletion already. Files to be added must not yet be under
1537 b078d5c4 2022-03-23 stsp version control and must not already be present on disk. Files to be
1538 b078d5c4 2022-03-23 stsp modified must already be under version control and may not contain
1539 b078d5c4 2022-03-23 stsp conflict markers.</p>
1540 b078d5c4 2022-03-23 stsp <p class="Pp">If an error occurs, the <code class="Cm">patch</code>
1541 b078d5c4 2022-03-23 stsp operation will be aborted. Any changes made to the work tree up to this
1542 b078d5c4 2022-03-23 stsp point will be left behind. Such changes can be viewed with
1543 b078d5c4 2022-03-23 stsp <code class="Cm">got diff</code> and can be reverted with
1544 b078d5c4 2022-03-23 stsp <code class="Cm">got revert</code> if needed.</p>
1545 b078d5c4 2022-03-23 stsp <p class="Pp">The options for <code class="Cm">got patch</code> are as
1546 b078d5c4 2022-03-23 stsp follows:</p>
1547 b078d5c4 2022-03-23 stsp <dl class="Bl-tag">
1548 63657f42 2022-09-07 stsp <dt id="c~10"><a class="permalink" href="#c~10"><code class="Fl">-c</code></a>
1549 63657f42 2022-09-07 stsp <var class="Ar">commit</var></dt>
1550 63657f42 2022-09-07 stsp <dd>Attempt to locate files within the specified
1551 63657f42 2022-09-07 stsp <var class="Ar">commit</var> for use as a merge-base for 3-way merges.
1552 63657f42 2022-09-07 stsp <p class="Pp">If the <code class="Fl">-c</code> option is not used then
1553 63657f42 2022-09-07 stsp <code class="Cm">got patch</code> will attempt to locate merge-bases
1554 63657f42 2022-09-07 stsp via object IDs found in <var class="Ar">patchfile</var> meta-data,
1555 63657f42 2022-09-07 stsp such as produced by <code class="Cm">got diff</code> or
1556 63657f42 2022-09-07 stsp <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a>. Use
1557 63657f42 2022-09-07 stsp of the <code class="Fl">-c</code> option is only recommended in the
1558 63657f42 2022-09-07 stsp absence of such meta-data.</p>
1559 461d9094 2023-07-19 stsp <p class="Pp">Ideally, the specified <var class="Ar">commit</var> should
1560 461d9094 2023-07-19 stsp contain versions of files which the changes contained in the
1561 461d9094 2023-07-19 stsp <var class="Ar">patchfile</var> were based on. Files will be located
1562 461d9094 2023-07-19 stsp by path, relative to the repository root. If the
1563 461d9094 2023-07-19 stsp <code class="Fl">-p</code> option is used then leading path
1564 461d9094 2023-07-19 stsp components will be stripped before paths are looked up in the
1565 461d9094 2023-07-19 stsp repository.</p>
1566 63657f42 2022-09-07 stsp <p class="Pp">In case no merge-base is available for a file, changes
1567 63657f42 2022-09-07 stsp will be applied without doing a 3-way merge. Changes which do not
1568 63657f42 2022-09-07 stsp apply cleanly may then be rejected entirely, rather than producing
1569 63657f42 2022-09-07 stsp merge conflicts in the patched target file.</p>
1570 461d9094 2023-07-19 stsp <p class="Pp" id="flan:+3">The expected <var class="Ar">commit</var>
1571 461d9094 2023-07-19 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
1572 461d9094 2023-07-19 stsp which will be resolved to a commit ID. An abbreviated hash argument
1573 461d9094 2023-07-19 stsp will be expanded to a full SHA1 hash automatically, provided the
1574 461d9094 2023-07-19 stsp abbreviation is unique. The keywords ":base" and
1575 461d9094 2023-07-19 stsp ":head" resolve to the work tree's base commit and branch
1576 461d9094 2023-07-19 stsp head, respectively. Keywords and references may be appended with
1577 461d9094 2023-07-19 stsp ":+" or ":-" modifiers and an optional integer N
1578 461d9094 2023-07-19 stsp to denote the Nth descendant or antecedent by first parent
1579 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b>
1580 461d9094 2023-07-19 stsp denotes the work tree branch head's 2nd generation ancestor, and
1581 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of
1582 461d9094 2023-07-19 stsp the work tree's base commit. Similarly,
1583 461d9094 2023-07-19 stsp <a class="permalink" href="#flan:+3"><b class="Sy">flan:+3</b></a>
1584 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by
1585 461d9094 2023-07-19 stsp the "flan" reference. A ":+" or ":-"
1586 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
1587 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1588 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1590 b078d5c4 2022-03-23 stsp <dt id="n~2"><a class="permalink" href="#n~2"><code class="Fl">-n</code></a></dt>
1591 b078d5c4 2022-03-23 stsp <dd>Do not make any modifications to the work tree. This can be used to
1592 b078d5c4 2022-03-23 stsp check whether a patch would apply without issues. If the
1593 b078d5c4 2022-03-23 stsp <var class="Ar">patchfile</var> contains diffs that affect the same
1594 b078d5c4 2022-03-23 stsp file multiple times, the results displayed may be incorrect.</dd>
1595 15ba8349 2022-04-24 stsp <dt id="p~3"><a class="permalink" href="#p~3"><code class="Fl">-p</code></a>
1596 15ba8349 2022-04-24 stsp <var class="Ar">strip-count</var></dt>
1597 15ba8349 2022-04-24 stsp <dd>Specify the number of leading path components to strip from paths
1598 15ba8349 2022-04-24 stsp parsed from <var class="Ar">patchfile</var>. If the
1599 15ba8349 2022-04-24 stsp <code class="Fl">-p</code> option is not used, ‘a/’ and
1600 15ba8349 2022-04-24 stsp ‘b/’ path prefixes generated by
1601 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-diff, section 1">git-diff(1)</a> will be
1602 376d4d52 2022-07-04 stsp recognized and stripped automatically.</dd>
1603 15ba8349 2022-04-24 stsp <dt id="R~7"><a class="permalink" href="#R~7"><code class="Fl">-R</code></a></dt>
1604 15ba8349 2022-04-24 stsp <dd>Reverse the patch before applying it.</dd>
1607 63b69821 2021-10-16 stsp <dt id="rv"><a class="permalink" href="#revert"><code class="Cm" id="revert">revert</code></a>
1608 63657f42 2022-09-07 stsp [<code class="Fl">-pR</code>] [<code class="Fl">-F</code>
1609 63657f42 2022-09-07 stsp <var class="Ar">response-script</var>] <var class="Ar">path ...</var></dt>
1611 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1612 46043f6f 2021-11-23 stsp <code class="Cm">rv</code>)</code></div>
1613 46043f6f 2021-11-23 stsp Revert any local changes in files at the specified paths in a work tree.
1614 a462773e 2020-04-19 stsp File contents will be overwritten with those contained in the work tree's
1615 a462773e 2020-04-19 stsp base commit. There is no way to bring discarded changes back after
1616 8797b228 2019-08-04 stsp <code class="Cm">got revert</code>!
1617 b078d5c4 2022-03-23 stsp <p class="Pp">If a file was added with <code class="Cm">got add</code>, it
1618 8797b228 2019-08-04 stsp will become an unversioned file again. If a file was deleted with
1619 b078d5c4 2022-03-23 stsp <code class="Cm">got remove</code>, it will be restored.</p>
1620 7da3b7f6 2019-08-08 stsp <p class="Pp">The options for <code class="Cm">got revert</code> are as
1621 7da3b7f6 2019-08-08 stsp follows:</p>
1622 7da3b7f6 2019-08-08 stsp <dl class="Bl-tag">
1623 63657f42 2022-09-07 stsp <dt id="F"><a class="permalink" href="#F"><code class="Fl">-F</code></a>
1624 63657f42 2022-09-07 stsp <var class="Ar">response-script</var></dt>
1625 63657f42 2022-09-07 stsp <dd>With the <code class="Fl">-p</code> option, read “y”,
1626 63657f42 2022-09-07 stsp “n”, and “q” responses line-by-line from
1627 63657f42 2022-09-07 stsp the specified <var class="Ar">response-script</var> file instead of
1628 63657f42 2022-09-07 stsp prompting interactively.</dd>
1629 15ba8349 2022-04-24 stsp <dt id="p~4"><a class="permalink" href="#p~4"><code class="Fl">-p</code></a></dt>
1630 7da3b7f6 2019-08-08 stsp <dd>Instead of reverting all changes in files, interactively select or
1631 7da3b7f6 2019-08-08 stsp reject changes to revert based on “y” (revert change),
1632 7da3b7f6 2019-08-08 stsp “n” (keep change), and “q” (quit reverting
1633 7da3b7f6 2019-08-08 stsp this file) responses. If a file is in modified status, individual
1634 7da3b7f6 2019-08-08 stsp patches derived from the modified file content can be reverted. Files
1635 7da3b7f6 2019-08-08 stsp in added or deleted status may only be reverted in their
1636 7da3b7f6 2019-08-08 stsp entirety.</dd>
1637 15ba8349 2022-04-24 stsp <dt id="R~8"><a class="permalink" href="#R~8"><code class="Fl">-R</code></a></dt>
1638 7da3b7f6 2019-08-08 stsp <dd>Permit recursion into directories. If this option is not specified,
1639 7da3b7f6 2019-08-08 stsp <code class="Cm">got revert</code> will refuse to run if a specified
1640 7da3b7f6 2019-08-08 stsp <var class="Ar">path</var> is a directory.</dd>
1643 63b69821 2021-10-16 stsp <dt id="ci"><a class="permalink" href="#commit"><code class="Cm" id="commit">commit</code></a>
1644 f6a6fa94 2023-02-22 stsp [<code class="Fl">-CNnS</code>] [<code class="Fl">-A</code>
1645 63657f42 2022-09-07 stsp <var class="Ar">author</var>] [<code class="Fl">-F</code>
1646 63657f42 2022-09-07 stsp <var class="Ar">path</var>] [<code class="Fl">-m</code>
1647 63657f42 2022-09-07 stsp <var class="Ar">message</var>] [<var class="Ar">path ...</var>]</dt>
1649 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1650 46043f6f 2021-11-23 stsp <code class="Cm">ci</code>)</code></div>
1651 46043f6f 2021-11-23 stsp Create a new commit in the repository from changes in a work tree and use
1652 8797b228 2019-08-04 stsp this commit as the new base commit for the work tree. If no
1653 8797b228 2019-08-04 stsp <var class="Ar">path</var> is specified, commit all changes in the work
1654 8797b228 2019-08-04 stsp tree. Otherwise, commit changes at or within the specified paths.
1655 8797b228 2019-08-04 stsp <p class="Pp">If changes have been explicitly staged for commit with
1656 4967d3c2 2019-08-12 stsp <code class="Cm">got stage</code>, only commit staged changes and reject
1657 8797b228 2019-08-04 stsp any specified paths which have not been staged.</p>
1658 039953c9 2021-03-22 stsp <p class="Pp"><code class="Cm">got commit</code> opens a temporary file in
1659 039953c9 2021-03-22 stsp an editor where a log message can be written unless the
1660 039953c9 2021-03-22 stsp <code class="Fl">-m</code> option is used or the
1661 039953c9 2021-03-22 stsp <code class="Fl">-F</code> and <code class="Fl">-N</code> options are
1662 461d9094 2023-07-19 stsp used together. Quitting the editor without saving the file will abort
1663 461d9094 2023-07-19 stsp the commit operation.</p>
1664 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
1665 8797b228 2019-08-04 stsp status codes:</p>
1666 8797b228 2019-08-04 stsp <table class="Bl-column">
1668 8797b228 2019-08-04 stsp <td>M</td>
1669 8797b228 2019-08-04 stsp <td>modified file</td>
1672 8797b228 2019-08-04 stsp <td>D</td>
1673 8797b228 2019-08-04 stsp <td>file was deleted</td>
1676 8797b228 2019-08-04 stsp <td>A</td>
1677 8797b228 2019-08-04 stsp <td>new file was added</td>
1680 d8e62599 2019-10-21 stsp <td>m</td>
1681 d8e62599 2019-10-21 stsp <td>modified file modes (executable bit only)</td>
1684 ae520cae 2019-08-05 stsp <p class="Pp">Files which are not part of the new commit will retain their
1685 ae520cae 2019-08-05 stsp previously recorded base commit. Some <code class="Nm">got</code>
1686 ae520cae 2019-08-05 stsp commands may refuse to run while the work tree contains files from
1687 ae520cae 2019-08-05 stsp multiple base commits. The base commit of such a work tree can be made
1688 ae520cae 2019-08-05 stsp consistent by running <code class="Cm">got update</code> across the
1689 ae520cae 2019-08-05 stsp entire work tree.</p>
1690 8797b228 2019-08-04 stsp <p class="Pp">The <code class="Cm">got commit</code> command requires the
1691 c2a52be5 2019-09-08 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
1692 376d4d52 2022-07-04 stsp unless an author has been configured in
1693 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1694 376d4d52 2022-07-04 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
1695 376d4d52 2022-07-04 stsp configuration settings can be obtained from the repository's
1696 376d4d52 2022-07-04 stsp <span class="Pa">.git/config</span> file or from Git's global
1697 376d4d52 2022-07-04 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
1698 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got commit</code> are as
1699 8797b228 2019-08-04 stsp follows:</p>
1700 8797b228 2019-08-04 stsp <dl class="Bl-tag">
1701 63657f42 2022-09-07 stsp <dt id="A"><a class="permalink" href="#A"><code class="Fl">-A</code></a>
1702 63657f42 2022-09-07 stsp <var class="Ar">author</var></dt>
1703 63657f42 2022-09-07 stsp <dd>Set author information in the newly created commit to
1704 63657f42 2022-09-07 stsp <var class="Ar">author</var>. This is useful when committing changes
1705 f6a6fa94 2023-02-22 stsp on behalf of someone else. The <var class="Ar">author</var> argument
1706 f6a6fa94 2023-02-22 stsp must use the same format as the <code class="Ev">GOT_AUTHOR</code>
1707 f6a6fa94 2023-02-22 stsp environment variable.
1708 63657f42 2022-09-07 stsp <p class="Pp">In addition to storing author information, the newly
1709 63657f42 2022-09-07 stsp created commit object will retain “committer”
1710 63657f42 2022-09-07 stsp information which is obtained, as usual, from the
1711 63657f42 2022-09-07 stsp <code class="Ev">GOT_AUTHOR</code> environment variable, or
1712 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>, or
1713 63657f42 2022-09-07 stsp Git configuration settings.</p>
1715 f6a6fa94 2023-02-22 stsp <dt id="C~3"><a class="permalink" href="#C~3"><code class="Fl">-C</code></a></dt>
1716 f6a6fa94 2023-02-22 stsp <dd>Allow committing files in conflicted status.
1717 f6a6fa94 2023-02-22 stsp <p class="Pp">Committing files with conflict markers should generally be
1718 f6a6fa94 2023-02-22 stsp avoided. Cases where conflict markers must be stored in the
1719 f6a6fa94 2023-02-22 stsp repository for some legitimate reason should be very rare. There are
1720 f6a6fa94 2023-02-22 stsp usually ways to avoid storing conflict markers verbatim by applying
1721 f6a6fa94 2023-02-22 stsp appropriate programming tricks.</p>
1723 039953c9 2021-03-22 stsp <dt id="F~2"><a class="permalink" href="#F~2"><code class="Fl">-F</code></a>
1724 039953c9 2021-03-22 stsp <var class="Ar">path</var></dt>
1725 039953c9 2021-03-22 stsp <dd>Use the prepared log message stored in the file found at
1726 039953c9 2021-03-22 stsp <var class="Ar">path</var> when creating the new commit.
1727 039953c9 2021-03-22 stsp <code class="Cm">got commit</code> opens a temporary file in an editor
1728 039953c9 2021-03-22 stsp where the prepared log message can be reviewed and edited further if
1729 039953c9 2021-03-22 stsp needed. Cannot be used together with the <code class="Fl">-m</code>
1730 039953c9 2021-03-22 stsp option.</dd>
1731 2dbbbc3a 2020-07-23 stsp <dt id="m~4"><a class="permalink" href="#m~4"><code class="Fl">-m</code></a>
1732 8797b228 2019-08-04 stsp <var class="Ar">message</var></dt>
1733 039953c9 2021-03-22 stsp <dd>Use the specified log message when creating the new commit. Cannot be
1734 039953c9 2021-03-22 stsp used together with the <code class="Fl">-F</code> option.</dd>
1735 039953c9 2021-03-22 stsp <dt id="N"><a class="permalink" href="#N"><code class="Fl">-N</code></a></dt>
1736 039953c9 2021-03-22 stsp <dd>This option prevents <code class="Cm">got commit</code> from opening
1737 039953c9 2021-03-22 stsp the commit message in an editor. It has no effect unless it is used
1738 039953c9 2021-03-22 stsp together with the <code class="Fl">-F</code> option and is intended
1739 039953c9 2021-03-22 stsp for non-interactive use such as scripting.</dd>
1740 fd9580e1 2022-11-03 stsp <dt id="n~3"><a class="permalink" href="#n~3"><code class="Fl">-n</code></a></dt>
1741 fd9580e1 2022-11-03 stsp <dd>This option prevents <code class="Cm">got commit</code> from
1742 fd9580e1 2022-11-03 stsp generating a diff of the to-be-committed changes in a temporary file
1743 fd9580e1 2022-11-03 stsp which can be viewed while editing a commit message.</dd>
1744 a701a2ae 2022-06-17 stsp <dt id="S~3"><a class="permalink" href="#S~3"><code class="Fl">-S</code></a></dt>
1745 1554b334 2020-08-02 stsp <dd>Allow the addition of symbolic links which point outside of the path
1746 1554b334 2020-08-02 stsp space that is under version control. By default, <code class="Cm">got
1747 1554b334 2020-08-02 stsp commit</code> will reject such symbolic links due to safety concerns.
1748 1554b334 2020-08-02 stsp As a precaution, <code class="Nm">got</code> may decide to represent
1749 1554b334 2020-08-02 stsp such a symbolic link as a regular file which contains the link's
1750 1554b334 2020-08-02 stsp target path, rather than creating an actual symbolic link which points
1751 1554b334 2020-08-02 stsp outside of the work tree. Use of this option is discouraged because
1752 1554b334 2020-08-02 stsp external mechanisms such as “make obj” are better suited
1753 1554b334 2020-08-02 stsp for managing symbolic links to paths not under version control.</dd>
1755 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got commit</code> will refuse to run if
1756 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree's current branch is
1757 8797b228 2019-08-04 stsp not in the “refs/heads/” reference namespace, new commits
1758 8797b228 2019-08-04 stsp may not be created on this branch. Local changes may only be committed
1759 8797b228 2019-08-04 stsp if they are based on file content found in the most recent commit on the
1760 8797b228 2019-08-04 stsp work tree's branch. If a path is found to be out of date,
1761 8797b228 2019-08-04 stsp <code class="Cm">got update</code> must be used first in order to merge
1762 8797b228 2019-08-04 stsp local changes with changes made in the repository.</p>
1764 63b69821 2021-10-16 stsp <dt id="se"><a class="permalink" href="#send"><code class="Cm" id="send">send</code></a>
1765 63657f42 2022-09-07 stsp [<code class="Fl">-afqTv</code>] [<code class="Fl">-b</code>
1766 def5be4a 2021-08-31 stsp <var class="Ar">branch</var>] [<code class="Fl">-d</code>
1767 63657f42 2022-09-07 stsp <var class="Ar">branch</var>] [<code class="Fl">-r</code>
1768 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] [<code class="Fl">-t</code>
1769 63657f42 2022-09-07 stsp <var class="Ar">tag</var>] [<var class="Ar">remote-repository</var>]</dt>
1771 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1772 46043f6f 2021-11-23 stsp <code class="Cm">se</code>)</code></div>
1773 46043f6f 2021-11-23 stsp Send new changes to a remote repository. If no
1774 def5be4a 2021-08-31 stsp <var class="Ar">remote-repository</var> is specified,
1775 def5be4a 2021-08-31 stsp “origin” will be used. The remote repository's URL is
1776 376d4d52 2022-07-04 stsp obtained from the corresponding entry in
1777 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
1778 376d4d52 2022-07-04 stsp <span class="Pa">config</span> file of the local repository, as created by
1779 376d4d52 2022-07-04 stsp <code class="Cm">got clone</code>.
1780 def5be4a 2021-08-31 stsp <p class="Pp">All objects corresponding to new changes will be written to a
1781 def5be4a 2021-08-31 stsp temporary pack file which is then uploaded to the server. Upon success,
1782 def5be4a 2021-08-31 stsp references in the “refs/remotes/” reference namespace of
1783 def5be4a 2021-08-31 stsp the local repository will be updated to point at the commits which have
1784 def5be4a 2021-08-31 stsp been sent.</p>
1785 def5be4a 2021-08-31 stsp <p class="Pp">By default, changes will only be sent if they are based on
1786 def5be4a 2021-08-31 stsp up-to-date copies of relevant branches in the remote repository. If any
1787 def5be4a 2021-08-31 stsp changes to be sent are based on out-of-date copies or would otherwise
1788 def5be4a 2021-08-31 stsp break linear history of existing branches, new changes must be fetched
1789 def5be4a 2021-08-31 stsp from the server with <code class="Cm">got fetch</code> and local
1790 def5be4a 2021-08-31 stsp branches must be rebased with <code class="Cm">got rebase</code> before
1791 def5be4a 2021-08-31 stsp <code class="Cm">got send</code> can succeed. The
1792 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option can be used to make exceptions to
1793 def5be4a 2021-08-31 stsp these requirements.</p>
1794 def5be4a 2021-08-31 stsp <p class="Pp">The options for <code class="Cm">got send</code> are as
1795 def5be4a 2021-08-31 stsp follows:</p>
1796 def5be4a 2021-08-31 stsp <dl class="Bl-tag">
1797 def5be4a 2021-08-31 stsp <dt id="a~4"><a class="permalink" href="#a~4"><code class="Fl">-a</code></a></dt>
1798 def5be4a 2021-08-31 stsp <dd>Send all branches from the local repository's
1799 def5be4a 2021-08-31 stsp “refs/heads/” reference namespace. The
1800 def5be4a 2021-08-31 stsp <code class="Fl">-a</code> option is equivalent to listing all
1801 def5be4a 2021-08-31 stsp branches with multiple <code class="Fl">-b</code> options. Cannot be
1802 def5be4a 2021-08-31 stsp used together with the <code class="Fl">-b</code> option.</dd>
1803 def5be4a 2021-08-31 stsp <dt id="b~7"><a class="permalink" href="#b~7"><code class="Fl">-b</code></a>
1804 def5be4a 2021-08-31 stsp <var class="Ar">branch</var></dt>
1805 def5be4a 2021-08-31 stsp <dd>Send the specified <var class="Ar">branch</var> from the local
1806 def5be4a 2021-08-31 stsp repository's “refs/heads/” reference namespace. This
1807 def5be4a 2021-08-31 stsp option may be specified multiple times to build a list of branches to
1808 def5be4a 2021-08-31 stsp send. If this option is not specified, default to the work tree's
1809 def5be4a 2021-08-31 stsp current branch if invoked in a work tree, or to the repository's HEAD
1810 def5be4a 2021-08-31 stsp reference. Cannot be used together with the <code class="Fl">-a</code>
1811 def5be4a 2021-08-31 stsp option.</dd>
1812 47f19dd5 2023-01-17 stsp <dt id="d~6"><a class="permalink" href="#d~6"><code class="Fl">-d</code></a>
1813 def5be4a 2021-08-31 stsp <var class="Ar">branch</var></dt>
1814 def5be4a 2021-08-31 stsp <dd>Delete the specified <var class="Ar">branch</var> from the remote
1815 def5be4a 2021-08-31 stsp repository's “refs/heads/” reference namespace. This
1816 def5be4a 2021-08-31 stsp option may be specified multiple times to build a list of branches to
1818 def5be4a 2021-08-31 stsp <p class="Pp">Only references are deleted. Any commit, tree, tag, and
1819 def5be4a 2021-08-31 stsp blob objects belonging to deleted branches may become subject to
1820 def5be4a 2021-08-31 stsp deletion by Git's garbage collector running on the server.</p>
1821 def5be4a 2021-08-31 stsp <p class="Pp">Requesting deletion of branches results in an error if the
1822 def5be4a 2021-08-31 stsp server does not support this feature or disallows the deletion of
1823 def5be4a 2021-08-31 stsp branches based on its configuration.</p>
1825 def5be4a 2021-08-31 stsp <dt id="f~2"><a class="permalink" href="#f~2"><code class="Fl">-f</code></a></dt>
1826 def5be4a 2021-08-31 stsp <dd>Attempt to force the server to overwrite existing branches or tags in
1827 461d9094 2023-07-19 stsp the remote repository, even when <code class="Cm">got fetch</code>
1828 461d9094 2023-07-19 stsp followed by <code class="Cm">got rebase</code> or <code class="Cm">got
1829 461d9094 2023-07-19 stsp merge</code> would usually be required before changes can be sent. The
1830 461d9094 2023-07-19 stsp server may reject forced requests regardless, depending on its
1831 461d9094 2023-07-19 stsp configuration.
1832 def5be4a 2021-08-31 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
1833 def5be4a 2021-08-31 stsp overwritten branches or tags may become subject to deletion by Git's
1834 def5be4a 2021-08-31 stsp garbage collector running on the server.</p>
1835 def5be4a 2021-08-31 stsp <p class="Pp">The “refs/tags” reference namespace is
1836 def5be4a 2021-08-31 stsp globally shared between all repositories. Use of the
1837 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option to overwrite tags is discouraged
1838 def5be4a 2021-08-31 stsp because it can lead to inconsistencies between the tags present in
1839 def5be4a 2021-08-31 stsp different repositories. In general, creating a new tag with a
1840 def5be4a 2021-08-31 stsp different name is recommended instead of overwriting an existing
1842 def5be4a 2021-08-31 stsp <p class="Pp">Use of the <code class="Fl">-f</code> option is
1843 def5be4a 2021-08-31 stsp particularly discouraged if changes being sent are based on an
1844 def5be4a 2021-08-31 stsp out-of-date copy of a branch in the remote repository. Instead of
1845 def5be4a 2021-08-31 stsp using the <code class="Fl">-f</code> option, new changes should be
1846 def5be4a 2021-08-31 stsp fetched with <code class="Cm">got fetch</code> and local branches
1847 461d9094 2023-07-19 stsp should be rebased with <code class="Cm">got rebase</code> or merged
1848 461d9094 2023-07-19 stsp with <code class="Cm">got merge</code>, followed by another attempt
1849 461d9094 2023-07-19 stsp to send the changes.</p>
1850 def5be4a 2021-08-31 stsp <p class="Pp">The <code class="Fl">-f</code> option should only be
1851 def5be4a 2021-08-31 stsp needed in situations where the remote repository's copy of a branch
1852 def5be4a 2021-08-31 stsp or tag is known to be out-of-date and is considered disposable. The
1853 def5be4a 2021-08-31 stsp risks of creating inconsistencies between different repositories
1854 def5be4a 2021-08-31 stsp should also be taken into account.</p>
1856 63657f42 2022-09-07 stsp <dt id="q~5"><a class="permalink" href="#q~5"><code class="Fl">-q</code></a></dt>
1857 63657f42 2022-09-07 stsp <dd>Suppress progress reporting output. The same option will be passed to
1858 63657f42 2022-09-07 stsp <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1859 63657f42 2022-09-07 stsp applicable.</dd>
1860 def5be4a 2021-08-31 stsp <dt id="r~10"><a class="permalink" href="#r~10"><code class="Fl">-r</code></a>
1861 def5be4a 2021-08-31 stsp <var class="Ar">repository-path</var></dt>
1862 def5be4a 2021-08-31 stsp <dd>Use the repository at the specified path. If not specified, assume the
1863 def5be4a 2021-08-31 stsp repository is located at or above the current working directory. If
1864 def5be4a 2021-08-31 stsp this directory is a <code class="Nm">got</code> work tree, use the
1865 def5be4a 2021-08-31 stsp repository path associated with this work tree.</dd>
1866 63657f42 2022-09-07 stsp <dt id="T"><a class="permalink" href="#T"><code class="Fl">-T</code></a></dt>
1867 63657f42 2022-09-07 stsp <dd>Attempt to send all tags from the local repository's
1868 63657f42 2022-09-07 stsp “refs/tags/” reference namespace. The
1869 63657f42 2022-09-07 stsp <code class="Fl">-T</code> option is equivalent to listing all tags
1870 63657f42 2022-09-07 stsp with multiple <code class="Fl">-t</code> options. Cannot be used
1871 63657f42 2022-09-07 stsp together with the <code class="Fl">-t</code> option.</dd>
1872 bd0bf387 2024-04-23 stsp <dt id="t~5"><a class="permalink" href="#t~5"><code class="Fl">-t</code></a>
1873 def5be4a 2021-08-31 stsp <var class="Ar">tag</var></dt>
1874 def5be4a 2021-08-31 stsp <dd>Send the specified <var class="Ar">tag</var> from the local
1875 def5be4a 2021-08-31 stsp repository's “refs/tags/” reference namespace, in
1876 def5be4a 2021-08-31 stsp addition to any branches that are being sent. The
1877 def5be4a 2021-08-31 stsp <code class="Fl">-t</code> option may be specified multiple times to
1878 def5be4a 2021-08-31 stsp build a list of tags to send. No tags will be sent if the
1879 def5be4a 2021-08-31 stsp <code class="Fl">-t</code> option is not used.
1880 def5be4a 2021-08-31 stsp <p class="Pp">Raise an error if the specified <var class="Ar">tag</var>
1881 def5be4a 2021-08-31 stsp already exists in the remote repository, unless the
1882 def5be4a 2021-08-31 stsp <code class="Fl">-f</code> option is used to overwrite the server's
1883 def5be4a 2021-08-31 stsp copy of the tag. In general, creating a new tag with a different
1884 def5be4a 2021-08-31 stsp name is recommended instead of overwriting an existing tag.</p>
1885 def5be4a 2021-08-31 stsp <p class="Pp">Cannot be used together with the
1886 def5be4a 2021-08-31 stsp <code class="Fl">-T</code> option.</p>
1888 376d4d52 2022-07-04 stsp <dt id="v~4"><a class="permalink" href="#v~4"><code class="Fl">-v</code></a></dt>
1889 def5be4a 2021-08-31 stsp <dd>Verbose mode. Causes <code class="Cm">got send</code> to print
1890 def5be4a 2021-08-31 stsp debugging messages to standard error output. The same option will be
1891 376d4d52 2022-07-04 stsp passed to <a class="Xr" aria-label="ssh, section 1">ssh(1)</a> if
1892 376d4d52 2022-07-04 stsp applicable. Multiple -v options increase the verbosity. The maximum is
1896 63b69821 2021-10-16 stsp <dt id="cy"><a class="permalink" href="#cherrypick"><code class="Cm" id="cherrypick">cherrypick</code></a>
1897 7985a487 2023-01-30 stsp [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
1899 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
1900 46043f6f 2021-11-23 stsp <code class="Cm">cy</code>)</code></div>
1901 46043f6f 2021-11-23 stsp Merge changes from a single <var class="Ar">commit</var> into the work tree.
1902 46043f6f 2021-11-23 stsp The specified <var class="Ar">commit</var> should be on a different branch
1903 461d9094 2023-07-19 stsp than the work tree's base commit.
1904 461d9094 2023-07-19 stsp <p class="Pp" id="barbaz:+3">The expected argument is a commit ID SHA1 hash,
1905 461d9094 2023-07-19 stsp or a reference name or keyword which will be resolved to a commit ID. An
1906 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
1907 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
1908 461d9094 2023-07-19 stsp ":base" and ":head" resolve to the work tree's base
1909 461d9094 2023-07-19 stsp commit and branch head, respectively. Keywords and references may be
1910 461d9094 2023-07-19 stsp appended with ":+" or ":-" modifiers and an optional
1911 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent by first parent
1912 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
1913 461d9094 2023-07-19 stsp the work tree branch head's 2nd generation ancestor, and
1914 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
1915 461d9094 2023-07-19 stsp work tree's base commit. Similarly,
1916 461d9094 2023-07-19 stsp <a class="permalink" href="#barbaz:+3"><b class="Sy">barbaz:+3</b></a>
1917 461d9094 2023-07-19 stsp will denote the 3rd generation descendant of the commit resolved by the
1918 461d9094 2023-07-19 stsp "barbaz" reference. A ":+" or ":-"
1919 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
1920 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
1921 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
1922 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
1923 8797b228 2019-08-04 stsp status codes:</p>
1924 8797b228 2019-08-04 stsp <table class="Bl-column">
1926 8797b228 2019-08-04 stsp <td>G</td>
1927 8797b228 2019-08-04 stsp <td>file was merged</td>
1930 8797b228 2019-08-04 stsp <td>C</td>
1931 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
1934 8797b228 2019-08-04 stsp <td>!</td>
1935 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
1938 8797b228 2019-08-04 stsp <td>D</td>
1939 8797b228 2019-08-04 stsp <td>file was deleted</td>
1942 8797b228 2019-08-04 stsp <td>d</td>
1943 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
1946 8797b228 2019-08-04 stsp <td>A</td>
1947 8797b228 2019-08-04 stsp <td>new file was added</td>
1950 8797b228 2019-08-04 stsp <td>~</td>
1951 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
1954 1554b334 2020-08-02 stsp <td>?</td>
1955 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
1958 8797b228 2019-08-04 stsp <p class="Pp">The merged changes will appear as local changes in the work
1959 8797b228 2019-08-04 stsp tree, which may be viewed with <code class="Cm">got diff</code>, amended
1960 91b3da3f 2019-08-18 stsp manually or with further <code class="Cm">got cherrypick</code>
1961 7985a487 2023-01-30 stsp commands, committed with <code class="Cm">got commit</code>.</p>
1962 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree where no
1963 7985a487 2023-01-30 stsp <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
1964 7985a487 2023-01-30 stsp <code class="Cm">merge</code> operation is taking place,
1965 7985a487 2023-01-30 stsp <code class="Cm">got cherrypick</code> creates a record of commits which
1966 7985a487 2023-01-30 stsp have been merged into the work tree. When a file changed by
1967 7985a487 2023-01-30 stsp <code class="Cm">got cherrypick</code> is committed with
1968 7985a487 2023-01-30 stsp <code class="Cm">got commit</code>, the log messages of relevant merged
1969 f6a6fa94 2023-02-22 stsp commits will then appear in the editor, where the messages should be
1970 f6a6fa94 2023-02-22 stsp further adjusted to convey the reasons for cherrypicking the changes.
1971 f6a6fa94 2023-02-22 stsp Upon exiting the editor, if the time stamp of the log message file is
1972 f6a6fa94 2023-02-22 stsp unchanged or the log message is empty, <code class="Cm">got
1973 f6a6fa94 2023-02-22 stsp commit</code> will fail with an unmodified or empty log message
1974 f6a6fa94 2023-02-22 stsp error.</p>
1975 f6a6fa94 2023-02-22 stsp <p class="Pp">If all the changes in all files touched by a given commit are
1976 f6a6fa94 2023-02-22 stsp discarded, e.g. with <code class="Cm">got revert</code>, this commit's
1977 f6a6fa94 2023-02-22 stsp log message record will also disappear.</p>
1978 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got cherrypick</code> will refuse to run if
1979 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree contains multiple
1980 b078d5c4 2022-03-23 stsp base commits, it must first be updated to a single base commit with
1981 1e80276a 2021-09-03 stsp <code class="Cm">got update</code>. If any relevant files already
1982 1e80276a 2021-09-03 stsp contain merge conflicts, these conflicts must be resolved first.</p>
1983 7985a487 2023-01-30 stsp <p class="Pp">The options for <code class="Nm">got</code>
1984 7985a487 2023-01-30 stsp <code class="Cm">cherrypick</code> are as follows:</p>
1985 7985a487 2023-01-30 stsp <dl class="Bl-tag">
1986 7985a487 2023-01-30 stsp <dt id="l~7"><a class="permalink" href="#l~7"><code class="Fl">-l</code></a></dt>
1987 7985a487 2023-01-30 stsp <dd>Display a list of commit log messages recorded by cherrypick
1988 7985a487 2023-01-30 stsp operations, represented by references in the
1989 7985a487 2023-01-30 stsp “refs/got/worktree” reference namespace. If a
1990 7985a487 2023-01-30 stsp <var class="Ar">commit</var> is specified, only show the log message
1991 7985a487 2023-01-30 stsp of the specified commit.
1992 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
1993 7985a487 2023-01-30 stsp cherrypick operations in the current work tree will be displayed.
1994 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be displayed irrespective of
1995 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
1996 7985a487 2023-01-30 stsp with <code class="Fl">-X</code>.</p>
1998 7985a487 2023-01-30 stsp <dt id="X~2"><a class="permalink" href="#X~2"><code class="Fl">-X</code></a></dt>
1999 7985a487 2023-01-30 stsp <dd>Delete log messages created by previous cherrypick operations,
2000 7985a487 2023-01-30 stsp represented by references in the “refs/got/worktree”
2001 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2002 7985a487 2023-01-30 stsp only delete the log message of the specified commit.
2003 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2004 7985a487 2023-01-30 stsp cherrypick operations in the current work tree will be deleted.
2005 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be deleted irrespective of
2006 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2007 7985a487 2023-01-30 stsp with <code class="Fl">-l</code>.</p>
2010 7985a487 2023-01-30 stsp <p class="Pp"></p>
2012 63b69821 2021-10-16 stsp <dt id="bo"><a class="permalink" href="#backout"><code class="Cm" id="backout">backout</code></a>
2013 7985a487 2023-01-30 stsp [<code class="Fl">-lX</code>] [<var class="Ar">commit</var>]</dt>
2015 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2016 46043f6f 2021-11-23 stsp <code class="Cm">bo</code>)</code></div>
2017 46043f6f 2021-11-23 stsp Reverse-merge changes from a single <var class="Ar">commit</var> into the
2018 1e80276a 2021-09-03 stsp work tree. The specified <var class="Ar">commit</var> should be on the
2019 461d9094 2023-07-19 stsp same branch as the work tree's base commit.
2020 461d9094 2023-07-19 stsp <p class="Pp" id="wip:+5">The expected argument is a commit ID SHA1 hash, or
2021 461d9094 2023-07-19 stsp a reference name or keyword which will be resolved to a commit ID. An
2022 461d9094 2023-07-19 stsp abbreviated hash argument will be expanded to a full SHA1 hash
2023 461d9094 2023-07-19 stsp automatically, provided the abbreviation is unique. The keywords
2024 461d9094 2023-07-19 stsp ":base" and ":head" resolve to the work tree's base
2025 461d9094 2023-07-19 stsp commit and branch head, respectively. Keywords and references may be
2026 461d9094 2023-07-19 stsp appended with ":+" or ":-" modifiers and an optional
2027 461d9094 2023-07-19 stsp integer N to denote the Nth descendant or antecedent by first parent
2028 461d9094 2023-07-19 stsp traversal, respectively; for example, <b class="Sy">:head:-2</b> denotes
2029 461d9094 2023-07-19 stsp the work tree branch head's 2nd generation ancestor, and
2030 461d9094 2023-07-19 stsp <b class="Sy">:base:+4</b> denotes the 4th generation descendant of the
2031 461d9094 2023-07-19 stsp work tree's base commit. Similarly,
2032 461d9094 2023-07-19 stsp <a class="permalink" href="#wip:+5"><b class="Sy">wip:+5</b></a> will
2033 461d9094 2023-07-19 stsp denote the 5th generation descendant of the commit resolved by the
2034 461d9094 2023-07-19 stsp "wip" reference. A ":+" or ":-" modifier
2035 461d9094 2023-07-19 stsp without a trailing integer has an implicit "1" appended (e.g.,
2036 461d9094 2023-07-19 stsp <b class="Sy">:base:+</b> is equivalent to
2037 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
2038 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
2039 8797b228 2019-08-04 stsp status codes:</p>
2040 8797b228 2019-08-04 stsp <table class="Bl-column">
2042 8797b228 2019-08-04 stsp <td>G</td>
2043 8797b228 2019-08-04 stsp <td>file was merged</td>
2046 8797b228 2019-08-04 stsp <td>C</td>
2047 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2050 8797b228 2019-08-04 stsp <td>!</td>
2051 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2054 8797b228 2019-08-04 stsp <td>D</td>
2055 8797b228 2019-08-04 stsp <td>file was deleted</td>
2058 8797b228 2019-08-04 stsp <td>d</td>
2059 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2062 8797b228 2019-08-04 stsp <td>A</td>
2063 8797b228 2019-08-04 stsp <td>new file was added</td>
2066 8797b228 2019-08-04 stsp <td>~</td>
2067 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2070 1554b334 2020-08-02 stsp <td>?</td>
2071 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2074 8797b228 2019-08-04 stsp <p class="Pp">The reverse-merged changes will appear as local changes in the
2075 8797b228 2019-08-04 stsp work tree, which may be viewed with <code class="Cm">got diff</code>,
2076 8797b228 2019-08-04 stsp amended manually or with further <code class="Cm">got backout</code>
2077 7985a487 2023-01-30 stsp commands, committed with <code class="Cm">got commit</code>.</p>
2078 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree where no
2079 7985a487 2023-01-30 stsp <code class="Cm">rebase</code>, <code class="Cm">histedit</code>, or
2080 7985a487 2023-01-30 stsp <code class="Cm">merge</code> operation is taking place,
2081 7985a487 2023-01-30 stsp <code class="Cm">got backout</code> creates a record of commits which
2082 7985a487 2023-01-30 stsp have been reverse-merged into the work tree. When a file changed by
2083 7985a487 2023-01-30 stsp <code class="Cm">got backout</code> is committed with
2084 7985a487 2023-01-30 stsp <code class="Cm">got commit</code>, the log messages of relevant
2085 7985a487 2023-01-30 stsp reverse-merged commits will then appear in the editor, where the
2086 f6a6fa94 2023-02-22 stsp messages should be further adjusted to convey the reasons for backing
2087 f6a6fa94 2023-02-22 stsp out the changes. Upon exiting the editor, if the time stamp of the log
2088 f6a6fa94 2023-02-22 stsp message file is unchanged or the log message is empty,
2089 f6a6fa94 2023-02-22 stsp <code class="Cm">got commit</code> will fail with an unmodified or empty
2090 f6a6fa94 2023-02-22 stsp log message error.</p>
2091 f6a6fa94 2023-02-22 stsp <p class="Pp">If all the changes in all files touched by a given commit are
2092 f6a6fa94 2023-02-22 stsp discarded, e.g. with <code class="Cm">got revert</code>, this commit's
2093 f6a6fa94 2023-02-22 stsp log message record will also disappear.</p>
2094 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got backout</code> will refuse to run if
2095 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree contains multiple
2096 b078d5c4 2022-03-23 stsp base commits, it must first be updated to a single base commit with
2097 1e80276a 2021-09-03 stsp <code class="Cm">got update</code>. If any relevant files already
2098 1e80276a 2021-09-03 stsp contain merge conflicts, these conflicts must be resolved first.</p>
2099 7985a487 2023-01-30 stsp <p class="Pp">The options for <code class="Nm">got</code>
2100 7985a487 2023-01-30 stsp <code class="Cm">backout</code> are as follows:</p>
2101 7985a487 2023-01-30 stsp <dl class="Bl-tag">
2102 7985a487 2023-01-30 stsp <dt id="l~8"><a class="permalink" href="#l~8"><code class="Fl">-l</code></a></dt>
2103 7985a487 2023-01-30 stsp <dd>Display a list of commit log messages recorded by backout operations,
2104 7985a487 2023-01-30 stsp represented by references in the “refs/got/worktree”
2105 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2106 7985a487 2023-01-30 stsp only show the log message of the specified commit.
2107 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2108 7985a487 2023-01-30 stsp backout operations in the current work tree will be displayed.
2109 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be displayed irrespective of
2110 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2111 7985a487 2023-01-30 stsp with <code class="Fl">-X</code>.</p>
2113 7985a487 2023-01-30 stsp <dt id="X~3"><a class="permalink" href="#X~3"><code class="Fl">-X</code></a></dt>
2114 7985a487 2023-01-30 stsp <dd>Delete log messages created by previous backout operations,
2115 7985a487 2023-01-30 stsp represented by references in the “refs/got/worktree”
2116 7985a487 2023-01-30 stsp reference namespace. If a <var class="Ar">commit</var> is specified,
2117 7985a487 2023-01-30 stsp only delete the log message of the specified commit.
2118 7985a487 2023-01-30 stsp <p class="Pp">If invoked in a work tree, only log messages recorded by
2119 7985a487 2023-01-30 stsp backout operations in the current work tree will be deleted.
2120 7985a487 2023-01-30 stsp Otherwise, all commit log messages will be deleted irrespective of
2121 7985a487 2023-01-30 stsp the work tree in which they were created. This option cannot be used
2122 7985a487 2023-01-30 stsp with <code class="Fl">-l</code>.</p>
2125 7985a487 2023-01-30 stsp <p class="Pp"></p>
2127 63b69821 2021-10-16 stsp <dt id="rb"><a class="permalink" href="#rebase"><code class="Cm" id="rebase">rebase</code></a>
2128 f6a6fa94 2023-02-22 stsp [<code class="Fl">-aCclX</code>] [<var class="Ar">branch</var>]</dt>
2130 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2131 46043f6f 2021-11-23 stsp <code class="Cm">rb</code>)</code></div>
2132 46043f6f 2021-11-23 stsp Rebase commits on the specified <var class="Ar">branch</var> onto the tip of
2133 46043f6f 2021-11-23 stsp the current branch of the work tree. The <var class="Ar">branch</var> must
2134 46043f6f 2021-11-23 stsp share common ancestry with the work tree's current branch. Rebasing begins
2135 46043f6f 2021-11-23 stsp with the first descendant commit of the youngest common ancestor commit
2136 46043f6f 2021-11-23 stsp shared by the specified <var class="Ar">branch</var> and the work tree's
2137 46043f6f 2021-11-23 stsp current branch, and stops once the tip commit of the specified
2138 8797b228 2019-08-04 stsp <var class="Ar">branch</var> has been rebased.
2139 7c3b4ab8 2020-02-25 stsp <p class="Pp">When <code class="Cm">got rebase</code> is used as intended,
2140 a43c0256 2020-02-25 stsp the specified <var class="Ar">branch</var> represents a local commit
2141 a43c0256 2020-02-25 stsp history and may already contain changes that are not yet visible in any
2142 a43c0256 2020-02-25 stsp other repositories. The work tree's current branch, which must be set
2143 a43c0256 2020-02-25 stsp with <code class="Cm">got update -b</code> before starting the
2144 a43c0256 2020-02-25 stsp <code class="Cm">rebase</code> operation, represents a branch from a
2145 a43c0256 2020-02-25 stsp remote repository which shares a common history with the specified
2146 a43c0256 2020-02-25 stsp <var class="Ar">branch</var> but has progressed, and perhaps diverged,
2147 a43c0256 2020-02-25 stsp due to commits added to the remote repository.</p>
2148 8797b228 2019-08-04 stsp <p class="Pp">Rebased commits are accumulated on a temporary branch which
2149 8797b228 2019-08-04 stsp the work tree will remain switched to throughout the entire rebase
2150 8797b228 2019-08-04 stsp operation. Commits on this branch represent the same changes with the
2151 8797b228 2019-08-04 stsp same log messages as their counterparts on the original
2152 8797b228 2019-08-04 stsp <var class="Ar">branch</var>, but with different commit IDs. Once
2153 8797b228 2019-08-04 stsp rebasing has completed successfully, the temporary branch becomes the
2154 8797b228 2019-08-04 stsp new version of the specified <var class="Ar">branch</var> and the work
2155 63657f42 2022-09-07 stsp tree is automatically switched to it. If author information is available
2156 63657f42 2022-09-07 stsp via the <code class="Ev">GOT_AUTHOR</code> environment variable,
2157 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2158 63657f42 2022-09-07 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2159 63657f42 2022-09-07 stsp configuration settings, this author information will be used to identify
2160 63657f42 2022-09-07 stsp the “committer” of rebased commits.</p>
2161 039953c9 2021-03-22 stsp <p class="Pp">Old commits in their pre-rebase state are automatically backed
2162 039953c9 2021-03-22 stsp up in the “refs/got/backup/rebase” reference namespace. As
2163 039953c9 2021-03-22 stsp long as these references are not removed older versions of rebased
2164 039953c9 2021-03-22 stsp commits will remain in the repository and can be viewed with the
2165 039953c9 2021-03-22 stsp <code class="Cm">got rebase -l</code> command. Removal of these
2166 039953c9 2021-03-22 stsp references makes objects which become unreachable via any reference
2167 16cd1323 2021-07-26 stsp subject to removal by Git's garbage collector or
2168 16cd1323 2021-07-26 stsp <code class="Cm">gotadmin cleanup</code>.</p>
2169 8797b228 2019-08-04 stsp <p class="Pp">While rebasing commits, show the status of each affected file,
2170 8797b228 2019-08-04 stsp using the following status codes:</p>
2171 8797b228 2019-08-04 stsp <table class="Bl-column">
2173 8797b228 2019-08-04 stsp <td>G</td>
2174 8797b228 2019-08-04 stsp <td>file was merged</td>
2177 8797b228 2019-08-04 stsp <td>C</td>
2178 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2181 8797b228 2019-08-04 stsp <td>!</td>
2182 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2185 8797b228 2019-08-04 stsp <td>D</td>
2186 8797b228 2019-08-04 stsp <td>file was deleted</td>
2189 8797b228 2019-08-04 stsp <td>d</td>
2190 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2193 8797b228 2019-08-04 stsp <td>A</td>
2194 8797b228 2019-08-04 stsp <td>new file was added</td>
2197 8797b228 2019-08-04 stsp <td>~</td>
2198 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2201 1554b334 2020-08-02 stsp <td>?</td>
2202 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2205 b078d5c4 2022-03-23 stsp <p class="Pp">If merge conflicts occur, the rebase operation is interrupted
2206 417cb057 2021-10-03 stsp and may be continued once conflicts have been resolved. If any files
2207 417cb057 2021-10-03 stsp with destined changes are found to be missing or unversioned, or if
2208 417cb057 2021-10-03 stsp files could not be deleted due to differences in deleted content, the
2209 417cb057 2021-10-03 stsp rebase operation will be interrupted to prevent potentially incomplete
2210 417cb057 2021-10-03 stsp changes from being committed to the repository without user
2211 417cb057 2021-10-03 stsp intervention. The work tree may be modified as desired and the rebase
2212 417cb057 2021-10-03 stsp operation can be continued once the changes present in the work tree are
2213 417cb057 2021-10-03 stsp considered complete. Alternatively, the rebase operation may be aborted
2214 417cb057 2021-10-03 stsp which will leave <var class="Ar">branch</var> unmodified and the work
2215 417cb057 2021-10-03 stsp tree switched back to its original branch.</p>
2216 8797b228 2019-08-04 stsp <p class="Pp">If a merge conflict is resolved in a way which renders the
2217 8797b228 2019-08-04 stsp merged change into a no-op change, the corresponding commit will be
2218 8797b228 2019-08-04 stsp elided when the rebase operation continues.</p>
2219 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got rebase</code> will refuse to run if
2220 63657f42 2022-09-07 stsp certain preconditions are not met. If the <var class="Ar">branch</var>
2221 63657f42 2022-09-07 stsp is not in the “refs/heads/” reference namespace, the
2222 63657f42 2022-09-07 stsp branch may not be rebased. If the work tree is not yet fully updated to
2223 63657f42 2022-09-07 stsp the tip commit of its branch, then the work tree must first be updated
2224 63657f42 2022-09-07 stsp with <code class="Cm">got update</code>. If changes have been staged
2225 63657f42 2022-09-07 stsp with <code class="Cm">got stage</code>, these changes must first be
2226 63657f42 2022-09-07 stsp committed with <code class="Cm">got commit</code> or unstaged with
2227 8797b228 2019-08-04 stsp <code class="Cm">got unstage</code>. If the work tree contains local
2228 8797b228 2019-08-04 stsp changes, these changes must first be committed with <code class="Cm">got
2229 8797b228 2019-08-04 stsp commit</code> or reverted with <code class="Cm">got revert</code>. If
2230 8797b228 2019-08-04 stsp the <var class="Ar">branch</var> contains changes to files outside of
2231 8797b228 2019-08-04 stsp the work tree's path prefix, the work tree cannot be used to rebase this
2232 8797b228 2019-08-04 stsp branch.</p>
2233 47f19dd5 2023-01-17 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2234 47f19dd5 2023-01-17 stsp integrate</code>, <code class="Cm">got merge</code>,
2235 47f19dd5 2023-01-17 stsp <code class="Cm">got commit</code>, and <code class="Cm">got
2236 47f19dd5 2023-01-17 stsp histedit</code> commands will refuse to run while a rebase operation is
2237 47f19dd5 2023-01-17 stsp in progress. Other commands which manipulate the work tree may be used
2238 47f19dd5 2023-01-17 stsp for conflict resolution purposes.</p>
2239 46043f6f 2021-11-23 stsp <p class="Pp">If the specified <var class="Ar">branch</var> is already based
2240 b078d5c4 2022-03-23 stsp on the work tree's current branch, then no commits need to be rebased
2241 b078d5c4 2022-03-23 stsp and <code class="Cm">got rebase</code> will simply switch the work tree
2242 b078d5c4 2022-03-23 stsp to the specified <var class="Ar">branch</var> and update files in the
2243 b078d5c4 2022-03-23 stsp work tree accordingly.</p>
2244 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got rebase</code> are as
2245 8797b228 2019-08-04 stsp follows:</p>
2246 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2247 def5be4a 2021-08-31 stsp <dt id="a~5"><a class="permalink" href="#a~5"><code class="Fl">-a</code></a></dt>
2248 8797b228 2019-08-04 stsp <dd>Abort an interrupted rebase operation. If this option is used, no
2249 9b0c768d 2019-08-08 stsp other command-line arguments are allowed.</dd>
2250 f6a6fa94 2023-02-22 stsp <dt id="C~4"><a class="permalink" href="#C~4"><code class="Fl">-C</code></a></dt>
2251 f6a6fa94 2023-02-22 stsp <dd>Allow a rebase operation to continue with files in conflicted status.
2252 f6a6fa94 2023-02-22 stsp This option should generally be avoided, and can only be used with the
2253 f6a6fa94 2023-02-22 stsp <code class="Fl">-c</code> option.</dd>
2254 63657f42 2022-09-07 stsp <dt id="c~11"><a class="permalink" href="#c~11"><code class="Fl">-c</code></a></dt>
2255 8797b228 2019-08-04 stsp <dd>Continue an interrupted rebase operation. If this option is used, no
2256 461d9094 2023-07-19 stsp other command-line arguments are allowed except
2257 461d9094 2023-07-19 stsp <code class="Fl">-C</code>.</dd>
2258 7985a487 2023-01-30 stsp <dt id="l~9"><a class="permalink" href="#l~9"><code class="Fl">-l</code></a></dt>
2259 039953c9 2021-03-22 stsp <dd>Show a list of past rebase operations, represented by references in
2260 039953c9 2021-03-22 stsp the “refs/got/backup/rebase” reference namespace.
2261 039953c9 2021-03-22 stsp <p class="Pp">Display the author, date, and log message of each backed
2262 039953c9 2021-03-22 stsp up commit, the object ID of the corresponding post-rebase commit,
2263 039953c9 2021-03-22 stsp and the object ID of their common ancestor commit. Given these
2264 039953c9 2021-03-22 stsp object IDs, the <code class="Cm">got log</code> command with the
2265 039953c9 2021-03-22 stsp <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2266 039953c9 2021-03-22 stsp can be used to examine the history of either version of the branch,
2267 039953c9 2021-03-22 stsp and the <code class="Cm">got branch</code> command with the
2268 039953c9 2021-03-22 stsp <code class="Fl">-c</code> option can be used to create a new branch
2269 039953c9 2021-03-22 stsp from a pre-rebase state if desired.</p>
2270 039953c9 2021-03-22 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2271 039953c9 2021-03-22 stsp commits which at some point in time represented this branch.
2272 039953c9 2021-03-22 stsp Otherwise, list all backed up commits for any branches.</p>
2273 039953c9 2021-03-22 stsp <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2274 039953c9 2021-03-22 stsp does not require a work tree. None of the other options can be used
2275 039953c9 2021-03-22 stsp together with <code class="Fl">-l</code>.</p>
2277 7985a487 2023-01-30 stsp <dt id="X~4"><a class="permalink" href="#X~4"><code class="Fl">-X</code></a></dt>
2278 16cd1323 2021-07-26 stsp <dd>Delete backups created by past rebase operations, represented by
2279 16cd1323 2021-07-26 stsp references in the “refs/got/backup/rebase” reference
2280 16cd1323 2021-07-26 stsp namespace.
2281 16cd1323 2021-07-26 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2282 16cd1323 2021-07-26 stsp delete backups which at some point in time represented this branch.
2283 16cd1323 2021-07-26 stsp Otherwise, delete all references found within
2284 16cd1323 2021-07-26 stsp “refs/got/backup/rebase”.</p>
2285 16cd1323 2021-07-26 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2286 16cd1323 2021-07-26 stsp deleted backups remain in the repository and may be removed
2287 16cd1323 2021-07-26 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
2288 16cd1323 2021-07-26 stsp cleanup</code>.</p>
2289 16cd1323 2021-07-26 stsp <p class="Pp">If this option is used, <code class="Cm">got rebase</code>
2290 16cd1323 2021-07-26 stsp does not require a work tree. None of the other options can be used
2291 16cd1323 2021-07-26 stsp together with <code class="Fl">-X</code>.</p>
2295 63b69821 2021-10-16 stsp <dt id="he"><a class="permalink" href="#histedit"><code class="Cm" id="histedit">histedit</code></a>
2296 f6a6fa94 2023-02-22 stsp [<code class="Fl">-aCcdeflmX</code>] [<code class="Fl">-F</code>
2297 63657f42 2022-09-07 stsp <var class="Ar">histedit-script</var>] [<var class="Ar">branch</var>]</dt>
2299 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2300 46043f6f 2021-11-23 stsp <code class="Cm">he</code>)</code></div>
2301 46043f6f 2021-11-23 stsp Edit commit history between the work tree's current base commit and the tip
2302 46043f6f 2021-11-23 stsp commit of the work tree's current branch.
2303 63657f42 2022-09-07 stsp <p class="Pp">The <code class="Cm">got histedit</code> command requires the
2304 63657f42 2022-09-07 stsp <code class="Ev">GOT_AUTHOR</code> environment variable to be set,
2305 63657f42 2022-09-07 stsp unless an author has been configured in
2306 63657f42 2022-09-07 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a> or Git's
2307 63657f42 2022-09-07 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2308 63657f42 2022-09-07 stsp configuration settings can be obtained from the repository's
2309 63657f42 2022-09-07 stsp <span class="Pa">.git/config</span> file or from Git's global
2310 63657f42 2022-09-07 stsp <span class="Pa">~/.gitconfig</span> configuration file.</p>
2311 b078d5c4 2022-03-23 stsp <p class="Pp">Before starting a <code class="Cm">histedit</code> operation,
2312 7c3b4ab8 2020-02-25 stsp the work tree's current branch must be set with <code class="Cm">got
2313 7c3b4ab8 2020-02-25 stsp update -b</code> to the branch which should be edited, unless this
2314 7c3b4ab8 2020-02-25 stsp branch is already the current branch of the work tree. The tip of this
2315 7c3b4ab8 2020-02-25 stsp branch represents the upper bound (inclusive) of commits touched by the
2316 7c3b4ab8 2020-02-25 stsp <code class="Cm">histedit</code> operation.</p>
2317 7c3b4ab8 2020-02-25 stsp <p class="Pp">Furthermore, the work tree's base commit must be set with
2318 7c3b4ab8 2020-02-25 stsp <code class="Cm">got update -c</code> to a point in this branch's commit
2319 7c3b4ab8 2020-02-25 stsp history where editing should begin. This commit represents the lower
2320 7c3b4ab8 2020-02-25 stsp bound (non-inclusive) of commits touched by the
2321 7c3b4ab8 2020-02-25 stsp <code class="Cm">histedit</code> operation.</p>
2322 8797b228 2019-08-04 stsp <p class="Pp">Editing of commit history is controlled via a
2323 7c3b4ab8 2020-02-25 stsp <var class="Ar">histedit script</var> which can be written in an editor
2324 7c3b4ab8 2020-02-25 stsp based on a template, passed on the command line, or generated with the
2325 297acb86 2023-03-07 stsp <code class="Fl">-d</code>, <code class="Fl">-e</code>,
2326 461d9094 2023-07-19 stsp <code class="Fl">-f</code>, or <code class="Fl">-m</code> options.
2327 461d9094 2023-07-19 stsp Quitting the editor without saving the file will abort the histedit
2328 461d9094 2023-07-19 stsp operation.</p>
2329 7c3b4ab8 2020-02-25 stsp <p class="Pp">The format of the histedit script is line-based. Each line in
2330 7c3b4ab8 2020-02-25 stsp the script begins with a command name, followed by whitespace and an
2331 7c3b4ab8 2020-02-25 stsp argument. For most commands, the expected argument is a commit ID SHA1
2332 7c3b4ab8 2020-02-25 stsp hash. Any remaining text on the line is ignored. Lines which begin with
2333 7c3b4ab8 2020-02-25 stsp the ‘#’ character are ignored entirely.</p>
2334 51683866 2022-07-14 stsp <p class="Pp">The available histedit script commands are as follows:</p>
2335 8797b228 2019-08-04 stsp <table class="Bl-column">
2336 51683866 2022-07-14 stsp <tr id="pick">
2337 51683866 2022-07-14 stsp <td><a class="permalink" href="#pick"><code class="Cm">pick</code></a>
2338 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2339 8797b228 2019-08-04 stsp <td>Use the specified commit as it is.</td>
2341 51683866 2022-07-14 stsp <tr id="edit">
2342 51683866 2022-07-14 stsp <td><a class="permalink" href="#edit"><code class="Cm">edit</code></a>
2343 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2344 297acb86 2023-03-07 stsp <td>Apply the changes from the specified commit, but then interrupt the
2345 297acb86 2023-03-07 stsp histedit operation for amending, without creating a commit. While the
2346 297acb86 2023-03-07 stsp histedit operation is interrupted arbitrary files may be edited, and
2347 297acb86 2023-03-07 stsp commands which manipulate the work tree can be used freely. The
2348 297acb86 2023-03-07 stsp <code class="Cm">got add</code> and <code class="Cm">got remove</code>
2349 297acb86 2023-03-07 stsp commands can be used to add new files or remove existing ones. The
2350 297acb86 2023-03-07 stsp <code class="Cm">got revert -p</code> command can be used to eliminate
2351 297acb86 2023-03-07 stsp arbitrary changes from files in the work tree. The
2352 297acb86 2023-03-07 stsp <code class="Cm">got stage -p</code> command may be used to prepare a
2353 297acb86 2023-03-07 stsp subset of changes for inclusion in the next commit. Finally, the
2354 297acb86 2023-03-07 stsp <code class="Cm">got commit</code> command can be used to insert
2355 297acb86 2023-03-07 stsp arbitrary commits into the edited history. Regular editing of history
2356 297acb86 2023-03-07 stsp must eventually be resumed by running <code class="Cm">got histedit
2357 297acb86 2023-03-07 stsp -c</code>.</td>
2359 51683866 2022-07-14 stsp <tr id="fold">
2360 51683866 2022-07-14 stsp <td><a class="permalink" href="#fold"><code class="Cm">fold</code></a>
2361 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2362 8797b228 2019-08-04 stsp <td>Combine the specified commit with the next commit listed further
2363 8797b228 2019-08-04 stsp below that will be used.</td>
2365 51683866 2022-07-14 stsp <tr id="drop">
2366 51683866 2022-07-14 stsp <td><a class="permalink" href="#drop"><code class="Cm">drop</code></a>
2367 51683866 2022-07-14 stsp <var class="Ar">commit</var></td>
2368 8797b228 2019-08-04 stsp <td>Remove this commit from the edited history.</td>
2370 51683866 2022-07-14 stsp <tr id="mesg">
2371 51683866 2022-07-14 stsp <td><a class="permalink" href="#mesg"><code class="Cm">mesg</code></a>
2372 c8cf51c9 2023-11-29 stsp <var class="Ar">commit</var></td>
2373 c8cf51c9 2023-11-29 stsp <td>Open an editor to create a new log message for this commit.</td>
2376 8797b228 2019-08-04 stsp <p class="Pp">Every commit in the history being edited must be mentioned in
2377 8797b228 2019-08-04 stsp the script. Lines may be re-ordered to change the order of commits in
2378 ae803b74 2020-03-06 stsp the edited history. No commit may be listed more than once.</p>
2379 8797b228 2019-08-04 stsp <p class="Pp">Edited commits are accumulated on a temporary branch which the
2380 8797b228 2019-08-04 stsp work tree will remain switched to throughout the entire histedit
2381 8797b228 2019-08-04 stsp operation. Once history editing has completed successfully, the
2382 8797b228 2019-08-04 stsp temporary branch becomes the new version of the work tree's branch and
2383 8797b228 2019-08-04 stsp the work tree is automatically switched to it.</p>
2384 039953c9 2021-03-22 stsp <p class="Pp">Old commits in their pre-histedit state are automatically
2385 039953c9 2021-03-22 stsp backed up in the “refs/got/backup/histedit” reference
2386 039953c9 2021-03-22 stsp namespace. As long as these references are not removed older versions of
2387 039953c9 2021-03-22 stsp edited commits will remain in the repository and can be viewed with the
2388 039953c9 2021-03-22 stsp <code class="Cm">got histedit -l</code> command. Removal of these
2389 039953c9 2021-03-22 stsp references makes objects which become unreachable via any reference
2390 16cd1323 2021-07-26 stsp subject to removal by Git's garbage collector or
2391 16cd1323 2021-07-26 stsp <code class="Cm">gotadmin cleanup</code>.</p>
2392 8797b228 2019-08-04 stsp <p class="Pp">While merging commits, show the status of each affected file,
2393 8797b228 2019-08-04 stsp using the following status codes:</p>
2394 8797b228 2019-08-04 stsp <table class="Bl-column">
2396 8797b228 2019-08-04 stsp <td>G</td>
2397 8797b228 2019-08-04 stsp <td>file was merged</td>
2400 8797b228 2019-08-04 stsp <td>C</td>
2401 8797b228 2019-08-04 stsp <td>file was merged and conflicts occurred during merge</td>
2404 8797b228 2019-08-04 stsp <td>!</td>
2405 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2408 8797b228 2019-08-04 stsp <td>D</td>
2409 8797b228 2019-08-04 stsp <td>file was deleted</td>
2412 8797b228 2019-08-04 stsp <td>d</td>
2413 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2416 8797b228 2019-08-04 stsp <td>A</td>
2417 8797b228 2019-08-04 stsp <td>new file was added</td>
2420 8797b228 2019-08-04 stsp <td>~</td>
2421 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2424 1554b334 2020-08-02 stsp <td>?</td>
2425 1554b334 2020-08-02 stsp <td>changes destined for an unversioned file were not merged</td>
2428 b078d5c4 2022-03-23 stsp <p class="Pp">If merge conflicts occur, the histedit operation is
2429 b078d5c4 2022-03-23 stsp interrupted and may be continued once conflicts have been resolved. If
2430 b078d5c4 2022-03-23 stsp any files with destined changes are found to be missing or unversioned,
2431 b078d5c4 2022-03-23 stsp or if files could not be deleted due to differences in deleted content,
2432 b078d5c4 2022-03-23 stsp the histedit operation will be interrupted to prevent potentially
2433 b078d5c4 2022-03-23 stsp incomplete changes from being committed to the repository without user
2434 417cb057 2021-10-03 stsp intervention. The work tree may be modified as desired and the histedit
2435 417cb057 2021-10-03 stsp operation can be continued once the changes present in the work tree are
2436 417cb057 2021-10-03 stsp considered complete. Alternatively, the histedit operation may be
2437 417cb057 2021-10-03 stsp aborted which will leave the work tree switched back to its original
2438 417cb057 2021-10-03 stsp branch.</p>
2439 8797b228 2019-08-04 stsp <p class="Pp">If a merge conflict is resolved in a way which renders the
2440 8797b228 2019-08-04 stsp merged change into a no-op change, the corresponding commit will be
2441 8797b228 2019-08-04 stsp elided when the histedit operation continues.</p>
2442 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got histedit</code> will refuse to run if
2443 8797b228 2019-08-04 stsp certain preconditions are not met. If the work tree's current branch is
2444 8797b228 2019-08-04 stsp not in the “refs/heads/” reference namespace, the history
2445 8797b228 2019-08-04 stsp of the branch may not be edited. If the work tree contains multiple base
2446 b078d5c4 2022-03-23 stsp commits, it must first be updated to a single base commit with
2447 8797b228 2019-08-04 stsp <code class="Cm">got update</code>. If changes have been staged with
2448 91b3da3f 2019-08-18 stsp <code class="Cm">got stage</code>, these changes must first be committed
2449 8797b228 2019-08-04 stsp with <code class="Cm">got commit</code> or unstaged with
2450 8797b228 2019-08-04 stsp <code class="Cm">got unstage</code>. If the work tree contains local
2451 8797b228 2019-08-04 stsp changes, these changes must first be committed with <code class="Cm">got
2452 8797b228 2019-08-04 stsp commit</code> or reverted with <code class="Cm">got revert</code>. If
2453 8797b228 2019-08-04 stsp the edited history contains changes to files outside of the work tree's
2454 8797b228 2019-08-04 stsp path prefix, the work tree cannot be used to edit the history of this
2455 8797b228 2019-08-04 stsp branch.</p>
2456 7c3b4ab8 2020-02-25 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2457 47f19dd5 2023-01-17 stsp rebase</code>, <code class="Cm">got merge</code>, and
2458 47f19dd5 2023-01-17 stsp <code class="Cm">got integrate</code> commands will refuse to run while
2459 47f19dd5 2023-01-17 stsp a histedit operation is in progress. Other commands which manipulate the
2460 47f19dd5 2023-01-17 stsp work tree may be used, and the <code class="Cm">got commit</code>
2461 47f19dd5 2023-01-17 stsp command may be used to commit arbitrary changes to the temporary branch
2462 47f19dd5 2023-01-17 stsp while the histedit operation is interrupted.</p>
2463 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got histedit</code> are as
2464 8797b228 2019-08-04 stsp follows:</p>
2465 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2466 def5be4a 2021-08-31 stsp <dt id="a~6"><a class="permalink" href="#a~6"><code class="Fl">-a</code></a></dt>
2467 8797b228 2019-08-04 stsp <dd>Abort an interrupted histedit operation. If this option is used, no
2468 9b0c768d 2019-08-08 stsp other command-line arguments are allowed.</dd>
2469 f6a6fa94 2023-02-22 stsp <dt id="C~5"><a class="permalink" href="#C~5"><code class="Fl">-C</code></a></dt>
2470 f6a6fa94 2023-02-22 stsp <dd>Allow a histedit operation to continue with files in conflicted
2471 f6a6fa94 2023-02-22 stsp status. This option should generally be avoided, and can only be used
2472 f6a6fa94 2023-02-22 stsp with the <code class="Fl">-c</code> option.</dd>
2473 63657f42 2022-09-07 stsp <dt id="c~12"><a class="permalink" href="#c~12"><code class="Fl">-c</code></a></dt>
2474 8797b228 2019-08-04 stsp <dd>Continue an interrupted histedit operation. If this option is used, no
2475 461d9094 2023-07-19 stsp other command-line arguments are allowed except
2476 461d9094 2023-07-19 stsp <code class="Fl">-C</code>.</dd>
2477 f6a6fa94 2023-02-22 stsp <dt id="d~7"><a class="permalink" href="#d~7"><code class="Fl">-d</code></a></dt>
2478 f6a6fa94 2023-02-22 stsp <dd>Drop all commits. This option is a quick equivalent to a histedit
2479 f6a6fa94 2023-02-22 stsp script which drops all commits. The <code class="Fl">-d</code> option
2480 f6a6fa94 2023-02-22 stsp can only be used when starting a new histedit operation. If this
2481 f6a6fa94 2023-02-22 stsp option is used, no other command-line arguments are allowed.</dd>
2482 417cb057 2021-10-03 stsp <dt id="e"><a class="permalink" href="#e"><code class="Fl">-e</code></a></dt>
2483 417cb057 2021-10-03 stsp <dd>Interrupt the histedit operation for editing after merging each
2484 417cb057 2021-10-03 stsp commit. This option is a quick equivalent to a histedit script which
2485 417cb057 2021-10-03 stsp uses the <code class="Cm">edit</code> command for all commits. The
2486 417cb057 2021-10-03 stsp <code class="Fl">-e</code> option can only be used when starting a new
2487 417cb057 2021-10-03 stsp histedit operation. If this option is used, no other command-line
2488 417cb057 2021-10-03 stsp arguments are allowed.</dd>
2489 039953c9 2021-03-22 stsp <dt id="F~3"><a class="permalink" href="#F~3"><code class="Fl">-F</code></a>
2490 7c3b4ab8 2020-02-25 stsp <var class="Ar">histedit-script</var></dt>
2491 7c3b4ab8 2020-02-25 stsp <dd>Use the specified <var class="Ar">histedit-script</var> instead of
2492 7c3b4ab8 2020-02-25 stsp opening a temporary file in an editor where a histedit script can be
2493 7c3b4ab8 2020-02-25 stsp written.</dd>
2494 63657f42 2022-09-07 stsp <dt id="f~3"><a class="permalink" href="#f~3"><code class="Fl">-f</code></a></dt>
2495 63657f42 2022-09-07 stsp <dd>Fold all commits into a single commit. This option is a quick
2496 63657f42 2022-09-07 stsp equivalent to a histedit script which folds all commits, combining
2497 63657f42 2022-09-07 stsp them all into one commit. The <code class="Fl">-f</code> option can
2498 7c3b4ab8 2020-02-25 stsp only be used when starting a new histedit operation. If this option is
2499 7c3b4ab8 2020-02-25 stsp used, no other command-line arguments are allowed.</dd>
2500 7985a487 2023-01-30 stsp <dt id="l~10"><a class="permalink" href="#l~10"><code class="Fl">-l</code></a></dt>
2501 039953c9 2021-03-22 stsp <dd>Show a list of past histedit operations, represented by references in
2502 039953c9 2021-03-22 stsp the “refs/got/backup/histedit” reference namespace.
2503 039953c9 2021-03-22 stsp <p class="Pp">Display the author, date, and log message of each backed
2504 039953c9 2021-03-22 stsp up commit, the object ID of the corresponding post-histedit commit,
2505 039953c9 2021-03-22 stsp and the object ID of their common ancestor commit. Given these
2506 039953c9 2021-03-22 stsp object IDs, the <code class="Cm">got log</code> command with the
2507 039953c9 2021-03-22 stsp <code class="Fl">-c</code> and <code class="Fl">-x</code> options
2508 039953c9 2021-03-22 stsp can be used to examine the history of either version of the branch,
2509 039953c9 2021-03-22 stsp and the <code class="Cm">got branch</code> command with the
2510 039953c9 2021-03-22 stsp <code class="Fl">-c</code> option can be used to create a new branch
2511 039953c9 2021-03-22 stsp from a pre-histedit state if desired.</p>
2512 039953c9 2021-03-22 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only show
2513 039953c9 2021-03-22 stsp commits which at some point in time represented this branch.
2514 039953c9 2021-03-22 stsp Otherwise, list all backed up commits for any branches.</p>
2515 039953c9 2021-03-22 stsp <p class="Pp">If this option is used, <code class="Cm">got
2516 039953c9 2021-03-22 stsp histedit</code> does not require a work tree. None of the other
2517 039953c9 2021-03-22 stsp options can be used together with <code class="Fl">-l</code>.</p>
2519 63657f42 2022-09-07 stsp <dt id="m~5"><a class="permalink" href="#m~5"><code class="Fl">-m</code></a></dt>
2520 63657f42 2022-09-07 stsp <dd>Edit log messages only. This option is a quick equivalent to a
2521 63657f42 2022-09-07 stsp histedit script which edits only log messages but otherwise leaves
2522 63657f42 2022-09-07 stsp every picked commit as-is. The <code class="Fl">-m</code> option can
2523 63657f42 2022-09-07 stsp only be used when starting a new histedit operation. If this option is
2524 63657f42 2022-09-07 stsp used, no other command-line arguments are allowed.</dd>
2525 7985a487 2023-01-30 stsp <dt id="X~5"><a class="permalink" href="#X~5"><code class="Fl">-X</code></a></dt>
2526 16cd1323 2021-07-26 stsp <dd>Delete backups created by past histedit operations, represented by
2527 16cd1323 2021-07-26 stsp references in the “refs/got/backup/histedit” reference
2528 16cd1323 2021-07-26 stsp namespace.
2529 16cd1323 2021-07-26 stsp <p class="Pp">If a <var class="Ar">branch</var> is specified, only
2530 16cd1323 2021-07-26 stsp delete backups which at some point in time represented this branch.
2531 16cd1323 2021-07-26 stsp Otherwise, delete all references found within
2532 16cd1323 2021-07-26 stsp “refs/got/backup/histedit”.</p>
2533 16cd1323 2021-07-26 stsp <p class="Pp">Any commit, tree, tag, and blob objects belonging to
2534 16cd1323 2021-07-26 stsp deleted backups remain in the repository and may be removed
2535 16cd1323 2021-07-26 stsp separately with Git's garbage collector or <code class="Cm">gotadmin
2536 16cd1323 2021-07-26 stsp cleanup</code>.</p>
2537 16cd1323 2021-07-26 stsp <p class="Pp">If this option is used, <code class="Cm">got
2538 16cd1323 2021-07-26 stsp histedit</code> does not require a work tree. None of the other
2539 16cd1323 2021-07-26 stsp options can be used together with <code class="Fl">-X</code>.</p>
2543 63b69821 2021-10-16 stsp <dt id="ig"><a class="permalink" href="#integrate"><code class="Cm" id="integrate">integrate</code></a>
2544 d8e62599 2019-10-21 stsp <var class="Ar">branch</var></dt>
2546 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2547 46043f6f 2021-11-23 stsp <code class="Cm">ig</code>)</code></div>
2548 46043f6f 2021-11-23 stsp Integrate the specified <var class="Ar">branch</var> into the work tree's
2549 d8e62599 2019-10-21 stsp current branch. Files in the work tree are updated to match the contents
2550 d8e62599 2019-10-21 stsp on the integrated <var class="Ar">branch</var>, and the reference of the
2551 d8e62599 2019-10-21 stsp work tree's branch is changed to point at the head commit of the
2552 d8e62599 2019-10-21 stsp integrated <var class="Ar">branch</var>.
2553 d8e62599 2019-10-21 stsp <p class="Pp">Both branches can be considered equivalent after integration
2554 d8e62599 2019-10-21 stsp since they will be pointing at the same commit. Both branches remain
2555 d8e62599 2019-10-21 stsp available for future work, if desired. In case the integrated
2556 d8e62599 2019-10-21 stsp <var class="Ar">branch</var> is no longer needed it may be deleted with
2557 d8e62599 2019-10-21 stsp <code class="Cm">got branch -d</code>.</p>
2558 d8e62599 2019-10-21 stsp <p class="Pp">Show the status of each affected file, using the following
2559 d8e62599 2019-10-21 stsp status codes:</p>
2560 d8e62599 2019-10-21 stsp <table class="Bl-column">
2562 d8e62599 2019-10-21 stsp <td>U</td>
2563 d8e62599 2019-10-21 stsp <td>file was updated</td>
2566 d8e62599 2019-10-21 stsp <td>D</td>
2567 d8e62599 2019-10-21 stsp <td>file was deleted</td>
2570 d8e62599 2019-10-21 stsp <td>A</td>
2571 d8e62599 2019-10-21 stsp <td>new file was added</td>
2574 d8e62599 2019-10-21 stsp <td>~</td>
2575 d8e62599 2019-10-21 stsp <td>versioned file is obstructed by a non-regular file</td>
2578 d8e62599 2019-10-21 stsp <td>!</td>
2579 d8e62599 2019-10-21 stsp <td>a missing versioned file was restored</td>
2582 d8e62599 2019-10-21 stsp <p class="Pp"><code class="Cm">got integrate</code> will refuse to run if
2583 d8e62599 2019-10-21 stsp certain preconditions are not met. Most importantly, the
2584 d8e62599 2019-10-21 stsp <var class="Ar">branch</var> must have been rebased onto the work tree's
2585 d8e62599 2019-10-21 stsp current branch with <code class="Cm">got rebase</code> before it can be
2586 d8e62599 2019-10-21 stsp integrated, in order to linearize commit history and resolve merge
2587 b078d5c4 2022-03-23 stsp conflicts. If the work tree contains multiple base commits, it must
2588 b078d5c4 2022-03-23 stsp first be updated to a single base commit with <code class="Cm">got
2589 d8e62599 2019-10-21 stsp update</code>. If changes have been staged with <code class="Cm">got
2590 d8e62599 2019-10-21 stsp stage</code>, these changes must first be committed with
2591 d8e62599 2019-10-21 stsp <code class="Cm">got commit</code> or unstaged with <code class="Cm">got
2592 d8e62599 2019-10-21 stsp unstage</code>. If the work tree contains local changes, these changes
2593 d8e62599 2019-10-21 stsp must first be committed with <code class="Cm">got commit</code> or
2594 d8e62599 2019-10-21 stsp reverted with <code class="Cm">got revert</code>.</p>
2596 63b69821 2021-10-16 stsp <dt id="mg"><a class="permalink" href="#merge"><code class="Cm" id="merge">merge</code></a>
2597 461d9094 2023-07-19 stsp [<code class="Fl">-aCcMn</code>] [<var class="Ar">branch</var>]</dt>
2599 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2600 46043f6f 2021-11-23 stsp <code class="Cm">mg</code>)</code></div>
2601 41ae98c9 2023-06-23 stsp Merge the specified <var class="Ar">branch</var> into the current branch of
2602 c8cf51c9 2023-11-29 stsp the work tree. If the branches have diverged, merge changes into the work
2603 c8cf51c9 2023-11-29 stsp tree and create a merge commit. Otherwise, if the specified
2604 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> is already based on the work tree's current
2605 c8cf51c9 2023-11-29 stsp branch, make the work tree's current branch equivalent to the specified
2606 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> and update files in the work tree
2607 c8cf51c9 2023-11-29 stsp accordingly.
2608 417cb057 2021-10-03 stsp <p class="Pp">Merge commits are commits based on multiple parent commits.
2609 c8cf51c9 2023-11-29 stsp The tip commit of the work tree's current branch will be used as the
2610 c8cf51c9 2023-11-29 stsp first parent. The tip commit of the specified
2611 c8cf51c9 2023-11-29 stsp <var class="Ar">branch</var> will be used as the second parent. The work
2612 c8cf51c9 2023-11-29 stsp tree's current branch must be in the “refs/heads/”
2613 c8cf51c9 2023-11-29 stsp reference namespace and can be set with <code class="Cm">got update
2614 c8cf51c9 2023-11-29 stsp -b</code> before starting the <code class="Cm">merge</code>
2615 c8cf51c9 2023-11-29 stsp operation.</p>
2616 417cb057 2021-10-03 stsp <p class="Pp">No ancestral relationship between the two branches is
2617 417cb057 2021-10-03 stsp required. If the two branches have already been merged previously, only
2618 417cb057 2021-10-03 stsp new changes will be merged.</p>
2619 417cb057 2021-10-03 stsp <p class="Pp">It is not possible to create merge commits with more than two
2620 417cb057 2021-10-03 stsp parents. If more than one branch needs to be merged, then multiple merge
2621 417cb057 2021-10-03 stsp commits with two parents each can be created in sequence.</p>
2622 c8cf51c9 2023-11-29 stsp <p class="Pp">If a linear project history is desired, then use of
2623 c8cf51c9 2023-11-29 stsp <code class="Cm">got rebase</code> should generally be preferred over
2624 c8cf51c9 2023-11-29 stsp <code class="Cm">got merge</code>. However, even strictly linear
2625 c8cf51c9 2023-11-29 stsp projects may require occasional merge commits, for example in order to
2626 c8cf51c9 2023-11-29 stsp merge in new versions of third-party code stored on
2627 c8cf51c9 2023-11-29 stsp “vendor” branches created with <code class="Cm">got
2628 c8cf51c9 2023-11-29 stsp import</code>.</p>
2629 417cb057 2021-10-03 stsp <p class="Pp">While merging changes found on the
2630 417cb057 2021-10-03 stsp <var class="Ar">branch</var> into the work tree, show the status of each
2631 417cb057 2021-10-03 stsp affected file, using the following status codes:</p>
2632 417cb057 2021-10-03 stsp <table class="Bl-column">
2634 417cb057 2021-10-03 stsp <td>G</td>
2635 417cb057 2021-10-03 stsp <td>file was merged</td>
2638 417cb057 2021-10-03 stsp <td>C</td>
2639 417cb057 2021-10-03 stsp <td>file was merged and conflicts occurred during merge</td>
2642 417cb057 2021-10-03 stsp <td>!</td>
2643 417cb057 2021-10-03 stsp <td>changes destined for a missing file were not merged</td>
2646 417cb057 2021-10-03 stsp <td>D</td>
2647 417cb057 2021-10-03 stsp <td>file was deleted</td>
2650 417cb057 2021-10-03 stsp <td>d</td>
2651 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2654 417cb057 2021-10-03 stsp <td>A</td>
2655 417cb057 2021-10-03 stsp <td>new file was added</td>
2658 417cb057 2021-10-03 stsp <td>~</td>
2659 417cb057 2021-10-03 stsp <td>changes destined for a non-regular file were not merged</td>
2662 417cb057 2021-10-03 stsp <td>?</td>
2663 417cb057 2021-10-03 stsp <td>changes destined for an unversioned file were not merged</td>
2666 417cb057 2021-10-03 stsp <p class="Pp">If merge conflicts occur, the merge operation is interrupted
2667 417cb057 2021-10-03 stsp and conflicts must be resolved before the merge operation can continue.
2668 417cb057 2021-10-03 stsp If any files with destined changes are found to be missing or
2669 417cb057 2021-10-03 stsp unversioned, or if files could not be deleted due to differences in
2670 417cb057 2021-10-03 stsp deleted content, the merge operation will be interrupted to prevent
2671 417cb057 2021-10-03 stsp potentially incomplete changes from being committed to the repository
2672 417cb057 2021-10-03 stsp without user intervention. The work tree may be modified as desired and
2673 417cb057 2021-10-03 stsp the merge can be continued once the changes present in the work tree are
2674 417cb057 2021-10-03 stsp considered complete. Alternatively, the merge operation may be aborted
2675 417cb057 2021-10-03 stsp which will leave the work tree's current branch unmodified.</p>
2676 417cb057 2021-10-03 stsp <p class="Pp"><code class="Cm">got merge</code> will refuse to run if
2677 41ae98c9 2023-06-23 stsp certain preconditions are not met. If the work tree's current branch is
2678 41ae98c9 2023-06-23 stsp not in the “refs/heads/” reference namespace then the work
2679 41ae98c9 2023-06-23 stsp tree must first be switched to a branch in the
2680 41ae98c9 2023-06-23 stsp “refs/heads/” namespace with <code class="Cm">got update
2681 41ae98c9 2023-06-23 stsp -b</code>. If the work tree is not yet fully updated to the tip commit
2682 41ae98c9 2023-06-23 stsp of its branch, then the work tree must first be updated with
2683 41ae98c9 2023-06-23 stsp <code class="Cm">got update</code>. If the work tree contains multiple
2684 41ae98c9 2023-06-23 stsp base commits, it must first be updated to a single base commit with
2685 41ae98c9 2023-06-23 stsp <code class="Cm">got update</code>. If changes have been staged with
2686 41ae98c9 2023-06-23 stsp <code class="Cm">got stage</code>, these changes must first be committed
2687 41ae98c9 2023-06-23 stsp with <code class="Cm">got commit</code> or unstaged with
2688 41ae98c9 2023-06-23 stsp <code class="Cm">got unstage</code>. If the work tree contains local
2689 41ae98c9 2023-06-23 stsp changes, these changes must first be committed with <code class="Cm">got
2690 41ae98c9 2023-06-23 stsp commit</code> or reverted with <code class="Cm">got revert</code>. If
2691 41ae98c9 2023-06-23 stsp the <var class="Ar">branch</var> contains changes to files outside of
2692 41ae98c9 2023-06-23 stsp the work tree's path prefix, the work tree cannot be used to merge this
2693 41ae98c9 2023-06-23 stsp branch.</p>
2694 417cb057 2021-10-03 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2695 417cb057 2021-10-03 stsp commit</code>, <code class="Cm">got rebase</code>, <code class="Cm">got
2696 417cb057 2021-10-03 stsp histedit</code>, <code class="Cm">got integrate</code>, and
2697 417cb057 2021-10-03 stsp <code class="Cm">got stage</code> commands will refuse to run while a
2698 417cb057 2021-10-03 stsp merge operation is in progress. Other commands which manipulate the work
2699 417cb057 2021-10-03 stsp tree may be used for conflict resolution purposes.</p>
2700 417cb057 2021-10-03 stsp <p class="Pp">The options for <code class="Cm">got merge</code> are as
2701 417cb057 2021-10-03 stsp follows:</p>
2702 417cb057 2021-10-03 stsp <dl class="Bl-tag">
2703 417cb057 2021-10-03 stsp <dt id="a~7"><a class="permalink" href="#a~7"><code class="Fl">-a</code></a></dt>
2704 417cb057 2021-10-03 stsp <dd>Abort an interrupted merge operation. If this option is used, no other
2705 417cb057 2021-10-03 stsp command-line arguments are allowed.</dd>
2706 f6a6fa94 2023-02-22 stsp <dt id="C~6"><a class="permalink" href="#C~6"><code class="Fl">-C</code></a></dt>
2707 f6a6fa94 2023-02-22 stsp <dd>Allow a merge operation to continue with files in conflicted status.
2708 f6a6fa94 2023-02-22 stsp This option should generally be avoided, and can only be used with the
2709 f6a6fa94 2023-02-22 stsp <code class="Fl">-c</code> option.</dd>
2710 63657f42 2022-09-07 stsp <dt id="c~13"><a class="permalink" href="#c~13"><code class="Fl">-c</code></a></dt>
2711 417cb057 2021-10-03 stsp <dd>Continue an interrupted merge operation. If this option is used, no
2712 461d9094 2023-07-19 stsp other command-line arguments are allowed except
2713 461d9094 2023-07-19 stsp <code class="Fl">-C</code>.</dd>
2714 461d9094 2023-07-19 stsp <dt id="M"><a class="permalink" href="#M"><code class="Fl">-M</code></a></dt>
2715 461d9094 2023-07-19 stsp <dd>Create a merge commit even if the branches have not diverged.</dd>
2716 fd9580e1 2022-11-03 stsp <dt id="n~4"><a class="permalink" href="#n~4"><code class="Fl">-n</code></a></dt>
2717 417cb057 2021-10-03 stsp <dd>Merge changes into the work tree as usual but do not create a merge
2718 417cb057 2021-10-03 stsp commit immediately. The merge result can be adjusted as desired before
2719 417cb057 2021-10-03 stsp a merge commit is created with <code class="Cm">got merge -c</code>.
2720 417cb057 2021-10-03 stsp Alternatively, the merge may be aborted with <code class="Cm">got
2721 417cb057 2021-10-03 stsp merge -a</code>.</dd>
2724 63b69821 2021-10-16 stsp <dt id="sg"><a class="permalink" href="#stage"><code class="Cm" id="stage">stage</code></a>
2725 bd0bf387 2024-04-23 stsp [<code class="Fl">-lpRS</code>] [<code class="Fl">-F</code>
2726 63657f42 2022-09-07 stsp <var class="Ar">response-script</var>] [<var class="Ar">path ...</var>]</dt>
2728 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2729 46043f6f 2021-11-23 stsp <code class="Cm">sg</code>)</code></div>
2730 46043f6f 2021-11-23 stsp Stage local changes for inclusion in the next commit. If no
2731 e0ed36ae 2019-08-07 stsp <var class="Ar">path</var> is specified, stage all changes in the work
2732 e0ed36ae 2019-08-07 stsp tree. Otherwise, stage changes at or within the specified paths. Paths may
2733 e0ed36ae 2019-08-07 stsp be staged if they are added, modified, or deleted according to
2734 e0ed36ae 2019-08-07 stsp <code class="Cm">got status</code>.
2735 00261839 2019-08-05 stsp <p class="Pp">Show the status of each affected file, using the following
2736 00261839 2019-08-05 stsp status codes:</p>
2737 00261839 2019-08-05 stsp <table class="Bl-column">
2739 00261839 2019-08-05 stsp <td>A</td>
2740 00261839 2019-08-05 stsp <td>file addition has been staged</td>
2743 00261839 2019-08-05 stsp <td>M</td>
2744 00261839 2019-08-05 stsp <td>file modification has been staged</td>
2747 00261839 2019-08-05 stsp <td>D</td>
2748 00261839 2019-08-05 stsp <td>file deletion has been staged</td>
2751 00261839 2019-08-05 stsp <p class="Pp">Staged file contents are saved in newly created blob objects
2752 00261839 2019-08-05 stsp in the repository. These blobs will be referred to by tree objects once
2753 00261839 2019-08-05 stsp staged changes have been committed.</p>
2754 8797b228 2019-08-04 stsp <p class="Pp">Staged changes affect the behaviour of <code class="Cm">got
2755 8797b228 2019-08-04 stsp commit</code>, <code class="Cm">got status</code>, and
2756 8797b228 2019-08-04 stsp <code class="Cm">got diff</code>. While paths with staged changes exist,
2757 8797b228 2019-08-04 stsp the <code class="Cm">got commit</code> command will refuse to commit any
2758 8797b228 2019-08-04 stsp paths which do not have staged changes. Local changes created on top of
2759 8797b228 2019-08-04 stsp staged changes can only be committed if the path is staged again, or if
2760 8797b228 2019-08-04 stsp the staged changes are committed first. The <code class="Cm">got
2761 8797b228 2019-08-04 stsp status</code> command will show both local changes and staged changes.
2762 8797b228 2019-08-04 stsp The <code class="Cm">got diff</code> command is able to display local
2763 8797b228 2019-08-04 stsp changes relative to staged changes, and to display staged changes
2764 8797b228 2019-08-04 stsp relative to the repository. The <code class="Cm">got revert</code>
2765 8797b228 2019-08-04 stsp command cannot revert staged changes but may be used to revert local
2766 fc62dacd 2019-08-08 stsp changes created on top of staged changes.</p>
2767 8797b228 2019-08-04 stsp <p class="Pp">The options for <code class="Cm">got stage</code> are as
2768 8797b228 2019-08-04 stsp follows:</p>
2769 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2770 63657f42 2022-09-07 stsp <dt id="F~4"><a class="permalink" href="#F~4"><code class="Fl">-F</code></a>
2771 63657f42 2022-09-07 stsp <var class="Ar">response-script</var></dt>
2772 63657f42 2022-09-07 stsp <dd>With the <code class="Fl">-p</code> option, read “y”,
2773 63657f42 2022-09-07 stsp “n”, and “q” responses line-by-line from
2774 63657f42 2022-09-07 stsp the specified <var class="Ar">response-script</var> file instead of
2775 63657f42 2022-09-07 stsp prompting interactively.</dd>
2776 7985a487 2023-01-30 stsp <dt id="l~11"><a class="permalink" href="#l~11"><code class="Fl">-l</code></a></dt>
2777 8797b228 2019-08-04 stsp <dd>Instead of staging new changes, list paths which are already staged,
2778 00261839 2019-08-05 stsp along with the IDs of staged blob objects and stage status codes. If
2779 b078d5c4 2022-03-23 stsp paths were provided on the command line, show the staged paths among
2780 00261839 2019-08-05 stsp the specified paths. Otherwise, show all staged paths.</dd>
2781 15ba8349 2022-04-24 stsp <dt id="p~5"><a class="permalink" href="#p~5"><code class="Fl">-p</code></a></dt>
2782 e0ed36ae 2019-08-07 stsp <dd>Instead of staging the entire content of a changed file, interactively
2783 fc62dacd 2019-08-08 stsp select or reject changes for staging based on “y” (stage
2784 fc62dacd 2019-08-08 stsp change), “n” (reject change), and “q”
2785 fc62dacd 2019-08-08 stsp (quit staging this file) responses. If a file is in modified status,
2786 fc62dacd 2019-08-08 stsp individual patches derived from the modified file content can be
2787 fc62dacd 2019-08-08 stsp staged. Files in added or deleted status may only be staged or
2788 fc62dacd 2019-08-08 stsp rejected in their entirety.</dd>
2789 bd0bf387 2024-04-23 stsp <dt id="R~9"><a class="permalink" href="#R~9"><code class="Fl">-R</code></a></dt>
2790 bd0bf387 2024-04-23 stsp <dd>Permit recursion into directories. If this option is not specified,
2791 bd0bf387 2024-04-23 stsp <code class="Cm">got stage</code> will refuse to run if a specified
2792 bd0bf387 2024-04-23 stsp <var class="Ar">path</var> is a directory.</dd>
2793 a701a2ae 2022-06-17 stsp <dt id="S~4"><a class="permalink" href="#S~4"><code class="Fl">-S</code></a></dt>
2794 1554b334 2020-08-02 stsp <dd>Allow staging of symbolic links which point outside of the path space
2795 1554b334 2020-08-02 stsp that is under version control. By default, <code class="Cm">got
2796 1554b334 2020-08-02 stsp stage</code> will reject such symbolic links due to safety concerns.
2797 1554b334 2020-08-02 stsp As a precaution, <code class="Nm">got</code> may decide to represent
2798 1554b334 2020-08-02 stsp such a symbolic link as a regular file which contains the link's
2799 1554b334 2020-08-02 stsp target path, rather than creating an actual symbolic link which points
2800 1554b334 2020-08-02 stsp outside of the work tree. Use of this option is discouraged because
2801 1554b334 2020-08-02 stsp external mechanisms such as “make obj” are better suited
2802 1554b334 2020-08-02 stsp for managing symbolic links to paths not under version control.</dd>
2804 8797b228 2019-08-04 stsp <p class="Pp"><code class="Cm">got stage</code> will refuse to run if
2805 8797b228 2019-08-04 stsp certain preconditions are not met. If a file contains merge conflicts,
2806 8797b228 2019-08-04 stsp these conflicts must be resolved first. If a file is found to be out of
2807 8797b228 2019-08-04 stsp date relative to the head commit on the work tree's current branch, the
2808 8797b228 2019-08-04 stsp file must be updated with <code class="Cm">got update</code> before it
2809 8797b228 2019-08-04 stsp can be staged (however, this does not prevent the file from becoming
2810 8797b228 2019-08-04 stsp out-of-date at some point after having been staged).</p>
2811 8797b228 2019-08-04 stsp <p class="Pp">The <code class="Cm">got update</code>, <code class="Cm">got
2812 461d9094 2023-07-19 stsp rebase</code>, <code class="Cm">got merge</code>, and
2813 461d9094 2023-07-19 stsp <code class="Cm">got histedit</code> commands will refuse to run while
2814 461d9094 2023-07-19 stsp staged changes exist. If staged changes cannot be committed because a
2815 461d9094 2023-07-19 stsp staged path is out of date, the path must be unstaged with
2816 461d9094 2023-07-19 stsp <code class="Cm">got unstage</code> before it can be updated with
2817 461d9094 2023-07-19 stsp <code class="Cm">got update</code>, and may then be staged again if
2818 461d9094 2023-07-19 stsp necessary.</p>
2820 63b69821 2021-10-16 stsp <dt id="ug"><a class="permalink" href="#unstage"><code class="Cm" id="unstage">unstage</code></a>
2821 bd0bf387 2024-04-23 stsp [<code class="Fl">-pR</code>] [<code class="Fl">-F</code>
2822 fc62dacd 2019-08-08 stsp <var class="Ar">response-script</var>] [<var class="Ar">path ...</var>]</dt>
2824 63b69821 2021-10-16 stsp <div class="Bd Bd-indent"><code class="Li">(alias:
2825 46043f6f 2021-11-23 stsp <code class="Cm">ug</code>)</code></div>
2826 46043f6f 2021-11-23 stsp Merge staged changes back into the work tree and put affected paths back
2827 8797b228 2019-08-04 stsp into non-staged status. If no <var class="Ar">path</var> is specified,
2828 e0ed36ae 2019-08-07 stsp unstage all staged changes across the entire work tree. Otherwise, unstage
2829 e0ed36ae 2019-08-07 stsp changes at or within the specified paths.
2830 8797b228 2019-08-04 stsp <p class="Pp">Show the status of each affected file, using the following
2831 8797b228 2019-08-04 stsp status codes:</p>
2832 8797b228 2019-08-04 stsp <table class="Bl-column">
2834 8797b228 2019-08-04 stsp <td>G</td>
2835 8797b228 2019-08-04 stsp <td>file was unstaged</td>
2838 8797b228 2019-08-04 stsp <td>C</td>
2839 8797b228 2019-08-04 stsp <td>file was unstaged and conflicts occurred during merge</td>
2842 8797b228 2019-08-04 stsp <td>!</td>
2843 8797b228 2019-08-04 stsp <td>changes destined for a missing file were not merged</td>
2846 8797b228 2019-08-04 stsp <td>D</td>
2847 8797b228 2019-08-04 stsp <td>file was staged as deleted and still is deleted</td>
2850 8797b228 2019-08-04 stsp <td>d</td>
2851 417cb057 2021-10-03 stsp <td>file's deletion was prevented by local modifications</td>
2854 8797b228 2019-08-04 stsp <td>~</td>
2855 8797b228 2019-08-04 stsp <td>changes destined for a non-regular file were not merged</td>
2858 fc62dacd 2019-08-08 stsp <p class="Pp">The options for <code class="Cm">got unstage</code> are as
2859 fc62dacd 2019-08-08 stsp follows:</p>
2860 fc62dacd 2019-08-08 stsp <dl class="Bl-tag">
2861 63657f42 2022-09-07 stsp <dt id="F~5"><a class="permalink" href="#F~5"><code class="Fl">-F</code></a>
2862 63657f42 2022-09-07 stsp <var class="Ar">response-script</var></dt>
2863 63657f42 2022-09-07 stsp <dd>With the <code class="Fl">-p</code> option, read “y”,
2864 63657f42 2022-09-07 stsp “n”, and “q” responses line-by-line from
2865 63657f42 2022-09-07 stsp the specified <var class="Ar">response-script</var> file instead of
2866 63657f42 2022-09-07 stsp prompting interactively.</dd>
2867 15ba8349 2022-04-24 stsp <dt id="p~6"><a class="permalink" href="#p~6"><code class="Fl">-p</code></a></dt>
2868 fc62dacd 2019-08-08 stsp <dd>Instead of unstaging the entire content of a changed file,
2869 fc62dacd 2019-08-08 stsp interactively select or reject changes for unstaging based on
2870 fc62dacd 2019-08-08 stsp “y” (unstage change), “n” (keep change
2871 fc62dacd 2019-08-08 stsp staged), and “q” (quit unstaging this file) responses.
2872 fc62dacd 2019-08-08 stsp If a file is staged in modified status, individual patches derived
2873 fc62dacd 2019-08-08 stsp from the staged file content can be unstaged. Files staged in added or
2874 fc62dacd 2019-08-08 stsp deleted status may only be unstaged in their entirety.</dd>
2875 bd0bf387 2024-04-23 stsp <dt id="R~10"><a class="permalink" href="#R~10"><code class="Fl">-R</code></a></dt>
2876 bd0bf387 2024-04-23 stsp <dd>Permit recursion into directories. If this option is not specified,
2877 bd0bf387 2024-04-23 stsp <code class="Cm">got unstage</code> will refuse to run if a specified
2878 bd0bf387 2024-04-23 stsp <var class="Ar">path</var> is a directory.</dd>
2881 2dbbbc3a 2020-07-23 stsp <dt id="cat"><a class="permalink" href="#cat"><code class="Cm">cat</code></a>
2882 63657f42 2022-09-07 stsp [<code class="Fl">-P</code>] [<code class="Fl">-c</code>
2883 63657f42 2022-09-07 stsp <var class="Ar">commit</var>] [<code class="Fl">-r</code>
2884 63657f42 2022-09-07 stsp <var class="Ar">repository-path</var>] <var class="Ar">arg ...</var></dt>
2885 ba0a4168 2019-08-26 stsp <dd>Parse and print contents of objects to standard output in a line-based
2886 ba0a4168 2019-08-26 stsp text format. Content of commit, tree, and tag objects is printed in a way
2887 ba0a4168 2019-08-26 stsp similar to the actual content stored in such objects. Blob object contents
2888 ba0a4168 2019-08-26 stsp are printed as they would appear in files on disk.
2889 ba0a4168 2019-08-26 stsp <p class="Pp">Attempt to interpret each argument as a reference, a tag name,
2890 ba0a4168 2019-08-26 stsp or an object ID SHA1 hash. References will be resolved to an object ID.
2891 ba0a4168 2019-08-26 stsp Tag names will resolved to a tag object. An abbreviated hash argument
2892 ba0a4168 2019-08-26 stsp will be expanded to a full SHA1 hash automatically, provided the
2893 ba0a4168 2019-08-26 stsp abbreviation is unique.</p>
2894 ba0a4168 2019-08-26 stsp <p class="Pp">If none of the above interpretations produce a valid result,
2895 ba0a4168 2019-08-26 stsp or if the <code class="Fl">-P</code> option is used, attempt to
2896 ba0a4168 2019-08-26 stsp interpret the argument as a path which will be resolved to the ID of an
2897 ba0a4168 2019-08-26 stsp object found at this path in the repository.</p>
2898 f447d26b 2019-08-23 stsp <p class="Pp">The options for <code class="Cm">got cat</code> are as
2899 f447d26b 2019-08-23 stsp follows:</p>
2900 f447d26b 2019-08-23 stsp <dl class="Bl-tag">
2901 63657f42 2022-09-07 stsp <dt id="c~14"><a class="permalink" href="#c~14"><code class="Fl">-c</code></a>
2902 ba0a4168 2019-08-26 stsp <var class="Ar">commit</var></dt>
2903 ba0a4168 2019-08-26 stsp <dd>Look up paths in the specified <var class="Ar">commit</var>. If this
2904 ba0a4168 2019-08-26 stsp option is not used, paths are looked up in the commit resolved via the
2905 461d9094 2023-07-19 stsp repository's HEAD reference.
2906 461d9094 2023-07-19 stsp <p class="Pp" id="quux:-8">The expected argument is a commit ID SHA1
2907 461d9094 2023-07-19 stsp hash, or a reference name or keyword which will be resolved to a
2908 461d9094 2023-07-19 stsp commit ID. An abbreviated hash argument will be expanded to a full
2909 461d9094 2023-07-19 stsp SHA1 hash automatically, provided the abbreviation is unique. The
2910 461d9094 2023-07-19 stsp keywords ":base" and ":head" resolve to the work
2911 461d9094 2023-07-19 stsp tree's base commit and branch head, respectively. The former is only
2912 461d9094 2023-07-19 stsp valid if invoked in a work tree, while the latter will resolve to
2913 461d9094 2023-07-19 stsp the tip of the work tree's current branch if invoked in a work tree,
2914 461d9094 2023-07-19 stsp otherwise it will resolve to the repository's HEAD reference.
2915 461d9094 2023-07-19 stsp Keywords and references may be appended with ":+" or
2916 461d9094 2023-07-19 stsp ":-" modifiers and an optional integer N to denote the Nth
2917 461d9094 2023-07-19 stsp descendant or antecedent by first parent traversal, respectively;
2918 461d9094 2023-07-19 stsp for example, <b class="Sy">:head:-2</b> denotes the work tree branch
2919 461d9094 2023-07-19 stsp head's 2nd generation ancestor, and <b class="Sy">:base:+4</b>
2920 461d9094 2023-07-19 stsp denotes the 4th generation descendant of the work tree's base
2921 461d9094 2023-07-19 stsp commit. Similarly,
2922 461d9094 2023-07-19 stsp <a class="permalink" href="#quux:-8"><b class="Sy">quux:-8</b></a>
2923 461d9094 2023-07-19 stsp will denote the 8th generation ancestor of the commit resolved by
2924 461d9094 2023-07-19 stsp the "quux" reference. A ":+" or ":-"
2925 461d9094 2023-07-19 stsp modifier without a trailing integer has an implicit "1"
2926 461d9094 2023-07-19 stsp appended (e.g., <b class="Sy">:base:+</b> is equivalent to
2927 461d9094 2023-07-19 stsp <b class="Sy">:base:+1</b>).</p>
2929 63657f42 2022-09-07 stsp <dt id="P~3"><a class="permalink" href="#P~3"><code class="Fl">-P</code></a></dt>
2930 63657f42 2022-09-07 stsp <dd>Interpret all arguments as paths only. This option can be used to
2931 63657f42 2022-09-07 stsp resolve ambiguity in cases where paths look like tag names, reference
2932 63657f42 2022-09-07 stsp names, or object IDs.</dd>
2933 def5be4a 2021-08-31 stsp <dt id="r~11"><a class="permalink" href="#r~11"><code class="Fl">-r</code></a>
2934 f447d26b 2019-08-23 stsp <var class="Ar">repository-path</var></dt>
2935 f447d26b 2019-08-23 stsp <dd>Use the repository at the specified path. If not specified, assume the
2936 f447d26b 2019-08-23 stsp repository is located at or above the current working directory. If
2937 f447d26b 2019-08-23 stsp this directory is a <code class="Nm">got</code> work tree, use the
2938 f447d26b 2019-08-23 stsp repository path associated with this work tree.</dd>
2941 1554b334 2020-08-02 stsp <dt id="info"><a class="permalink" href="#info"><code class="Cm">info</code></a>
2942 1554b334 2020-08-02 stsp [<var class="Ar">path ...</var>]</dt>
2943 1554b334 2020-08-02 stsp <dd>Display meta-data stored in a work tree. See
2944 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a> for
2946 1554b334 2020-08-02 stsp <p class="Pp">The work tree to use is resolved implicitly by walking upwards
2947 1554b334 2020-08-02 stsp from the current working directory.</p>
2948 1554b334 2020-08-02 stsp <p class="Pp">If one or more <var class="Ar">path</var> arguments are
2949 1554b334 2020-08-02 stsp specified, show additional per-file information for tracked files
2950 1554b334 2020-08-02 stsp located at or within these paths. If a <var class="Ar">path</var>
2951 1554b334 2020-08-02 stsp argument corresponds to the work tree's root directory, display
2952 1554b334 2020-08-02 stsp information for all tracked files.</p>
2955 8797b228 2019-08-04 stsp </section>
2956 8797b228 2019-08-04 stsp <section class="Sh">
2957 63657f42 2022-09-07 stsp <h2 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h2>
2958 8797b228 2019-08-04 stsp <dl class="Bl-tag">
2959 2dbbbc3a 2020-07-23 stsp <dt id="GOT_AUTHOR"><a class="permalink" href="#GOT_AUTHOR"><code class="Ev">GOT_AUTHOR</code></a></dt>
2960 865e5ba9 2024-02-13 stsp <dd>The author's name and email address, such as "<span class="An">Flan
2961 63657f42 2022-09-07 stsp Hacker</span>
2962 865e5ba9 2024-02-13 stsp <<a class="Mt" href="mailto:flan_hacker@openbsd.org">flan_hacker@openbsd.org</a>>".
2963 63657f42 2022-09-07 stsp Used by the <code class="Cm">got commit</code>, <code class="Cm">got
2964 461d9094 2023-07-19 stsp import</code>, <code class="Cm">got rebase</code>, <code class="Cm">got
2965 461d9094 2023-07-19 stsp merge</code>, and <code class="Cm">got histedit</code> commands. Because
2966 63657f42 2022-09-07 stsp <a class="Xr" aria-label="git, section 1">git(1)</a> may fail to parse
2967 63657f42 2022-09-07 stsp commits without an email address in author data,
2968 376d4d52 2022-07-04 stsp <code class="Nm">got</code> attempts to reject
2969 376d4d52 2022-07-04 stsp <code class="Ev">GOT_AUTHOR</code> environment variables with a missing
2970 376d4d52 2022-07-04 stsp email address.
2971 def5be4a 2021-08-31 stsp <p class="Pp"><code class="Ev">GOT_AUTHOR will be overridden by
2972 376d4d52 2022-07-04 stsp configuration settings in</code> <a class="Xr" aria-label="got.conf,
2973 376d4d52 2022-07-04 stsp section 5">got.conf(5)</a> or by Git's <code class="Dv">user.name</code>
2974 376d4d52 2022-07-04 stsp and <code class="Dv">user.email</code> configuration settings in the
2975 def5be4a 2021-08-31 stsp repository's <span class="Pa">.git/config</span> file. The
2976 feee6923 2020-09-17 stsp <code class="Dv">user.name</code> and <code class="Dv">user.email</code>
2977 c2a52be5 2019-09-08 stsp configuration settings contained in Git's global
2978 feee6923 2020-09-17 stsp <span class="Pa">~/.gitconfig</span> configuration file will only be
2979 376d4d52 2022-07-04 stsp used if neither <a class="Xr" aria-label="got.conf, section
2980 376d4d52 2022-07-04 stsp 5">got.conf(5)</a> nor the <code class="Ev">GOT_AUTHOR</code>
2981 376d4d52 2022-07-04 stsp environment variable provide author information.</p>
2983 47fa70d4 2023-01-23 stsp <dt id="GOT_IGNORE_GITCONFIG"><a class="permalink" href="#GOT_IGNORE_GITCONFIG"><code class="Ev">GOT_IGNORE_GITCONFIG</code></a></dt>
2984 47fa70d4 2023-01-23 stsp <dd>If this variable is set then any remote repository definitions or author
2985 47fa70d4 2023-01-23 stsp information found in Git configuration files will be ignored.</dd>
2986 47fa70d4 2023-01-23 stsp <dt id="GOT_LOG_DEFAULT_LIMIT"><a class="permalink" href="#GOT_LOG_DEFAULT_LIMIT"><code class="Ev">GOT_LOG_DEFAULT_LIMIT</code></a></dt>
2987 47fa70d4 2023-01-23 stsp <dd>The default limit on the number of commits traversed by
2988 47fa70d4 2023-01-23 stsp <code class="Cm">got log</code>. If set to zero, the limit is unbounded.
2989 47fa70d4 2023-01-23 stsp This variable will be silently ignored if it is set to a non-numeric
2990 47fa70d4 2023-01-23 stsp value.</dd>
2991 2dbbbc3a 2020-07-23 stsp <dt id="VISUAL"><a class="permalink" href="#VISUAL"><code class="Ev">VISUAL</code></a>,
2992 8797b228 2019-08-04 stsp <code class="Ev">EDITOR</code></dt>
2993 f447d26b 2019-08-23 stsp <dd>The editor spawned by <code class="Cm">got commit</code>,
2994 feee6923 2020-09-17 stsp <code class="Cm">got histedit</code>, <code class="Cm">got import</code>,
2995 feee6923 2020-09-17 stsp or <code class="Cm">got tag</code>. If not set, the
2996 297acb86 2023-03-07 stsp <a class="Xr" aria-label="vi, section 1">vi(1)</a> text editor will be
2997 297acb86 2023-03-07 stsp spawned.</dd>
2999 8797b228 2019-08-04 stsp </section>
3000 8797b228 2019-08-04 stsp <section class="Sh">
3001 63657f42 2022-09-07 stsp <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
3002 feee6923 2020-09-17 stsp <dl class="Bl-tag Bl-compact">
3003 feee6923 2020-09-17 stsp <dt><span class="Pa">got.conf</span></dt>
3004 feee6923 2020-09-17 stsp <dd>Repository-wide configuration settings for <code class="Nm">got</code>. If
3005 376d4d52 2022-07-04 stsp present, a <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>
3006 376d4d52 2022-07-04 stsp configuration file located in the root directory of a Git repository
3007 376d4d52 2022-07-04 stsp supersedes any relevant settings in Git's <span class="Pa">config</span>
3009 feee6923 2020-09-17 stsp <p class="Pp"></p>
3011 feee6923 2020-09-17 stsp <dt><span class="Pa">.got/got.conf</span></dt>
3012 feee6923 2020-09-17 stsp <dd>Worktree-specific configuration settings for <code class="Nm">got</code>.
3013 376d4d52 2022-07-04 stsp If present, a <a class="Xr" aria-label="got.conf, section
3014 376d4d52 2022-07-04 stsp 5">got.conf(5)</a> configuration file in the <span class="Pa">.got</span>
3015 376d4d52 2022-07-04 stsp meta-data directory of a work tree supersedes any relevant settings in the
3016 376d4d52 2022-07-04 stsp repository's <a class="Xr" aria-label="got.conf, section
3017 376d4d52 2022-07-04 stsp 5">got.conf(5)</a> configuration file and Git's
3018 376d4d52 2022-07-04 stsp <span class="Pa">config</span> file.</dd>
3020 feee6923 2020-09-17 stsp </section>
3021 feee6923 2020-09-17 stsp <section class="Sh">
3022 63657f42 2022-09-07 stsp <h2 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT
3023 63657f42 2022-09-07 stsp STATUS</a></h2>
3024 d8e62599 2019-10-21 stsp <p class="Pp">The <code class="Nm">got</code> utility exits 0 on success,
3025 d8e62599 2019-10-21 stsp and >0 if an error occurs.</p>
3026 8797b228 2019-08-04 stsp </section>
3027 8797b228 2019-08-04 stsp <section class="Sh">
3028 63657f42 2022-09-07 stsp <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
3029 def5be4a 2021-08-31 stsp <p class="Pp">Enable tab-completion of <code class="Nm">got</code> command names
3030 376d4d52 2022-07-04 stsp in <a class="Xr" aria-label="ksh, section 1">ksh(1)</a>:</p>
3031 def5be4a 2021-08-31 stsp <p class="Pp"></p>
3032 1e80276a 2021-09-03 stsp <div class="Bd Bd-indent"><code class="Li">$ set -A complete_got_1 -- $(got -h
3033 def5be4a 2021-08-31 stsp 2>&1 | sed -n s/commands://p)</code></div>
3034 d8e62599 2019-10-21 stsp <p class="Pp">Clone an existing Git repository for use with
3035 41ae98c9 2023-06-23 stsp <code class="Nm">got</code>:</p>
3036 8797b228 2019-08-04 stsp <p class="Pp"></p>
3037 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/</code></div>
3038 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got clone
3039 b213cbf7 2020-03-23 stsp ssh://git@github.com/openbsd/src.git</code></div>
3040 41ae98c9 2023-06-23 stsp <p class="Pp">Unfortunately, many of the popular Git hosting sites do not offer
3041 41ae98c9 2023-06-23 stsp anonymous access via SSH. Such sites will require an account to be created,
3042 41ae98c9 2023-06-23 stsp and a public SSH key to be uploaded to this account, before repository
3043 41ae98c9 2023-06-23 stsp access via ssh:// URLs will work.</p>
3044 bd0bf387 2024-04-23 stsp <p class="Pp">Most sites offer anonymous repository access via HTTPS:</p>
3045 b213cbf7 2020-03-23 stsp <p class="Pp"></p>
3046 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/</code></div>
3047 bd0bf387 2024-04-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got clone
3048 8797b228 2019-08-04 stsp https://github.com/openbsd/src.git</code></div>
3049 8797b228 2019-08-04 stsp <p class="Pp">Alternatively, for quick and dirty local testing of
3050 8797b228 2019-08-04 stsp <code class="Nm">got</code> a new Git repository could be created and
3051 8797b228 2019-08-04 stsp populated with files, e.g. from a temporary CVS checkout located at
3052 8797b228 2019-08-04 stsp <span class="Pa">/tmp/src</span>:</p>
3053 8797b228 2019-08-04 stsp <p class="Pp"></p>
3054 51683866 2022-07-14 stsp <div class="Bd Bd-indent"><code class="Li">$ gotadmin init
3055 8797b228 2019-08-04 stsp /var/git/src.git</code></div>
3056 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got import -r /var/git/src.git -I
3057 8797b228 2019-08-04 stsp CVS -I obj /tmp/src</code></div>
3058 8797b228 2019-08-04 stsp <p class="Pp">Check out a work tree from the Git repository to /usr/src:</p>
3059 8797b228 2019-08-04 stsp <p class="Pp"></p>
3060 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got checkout /var/git/src.git
3061 8797b228 2019-08-04 stsp /usr/src</code></div>
3062 8797b228 2019-08-04 stsp <p class="Pp">View local changes in a work tree directory:</p>
3063 8797b228 2019-08-04 stsp <p class="Pp"></p>
3064 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got diff | less</code></div>
3065 feee6923 2020-09-17 stsp <p class="Pp">In a work tree, display files in a potentially problematic
3066 feee6923 2020-09-17 stsp state:</p>
3067 feee6923 2020-09-17 stsp <p class="Pp"></p>
3068 feee6923 2020-09-17 stsp <div class="Bd Bd-indent"><code class="Li">$ got status -s 'C!~?'</code></div>
3069 7da3b7f6 2019-08-08 stsp <p class="Pp">Interactively revert selected local changes in a work tree
3070 7da3b7f6 2019-08-08 stsp directory:</p>
3071 7da3b7f6 2019-08-08 stsp <p class="Pp"></p>
3072 7da3b7f6 2019-08-08 stsp <div class="Bd Bd-indent"><code class="Li">$ got revert -p
3073 7da3b7f6 2019-08-08 stsp -R .</code></div>
3074 8797b228 2019-08-04 stsp <p class="Pp">In a work tree or a git repository directory, list all branch
3075 8797b228 2019-08-04 stsp references:</p>
3076 8797b228 2019-08-04 stsp <p class="Pp"></p>
3077 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got branch -l</code></div>
3078 47f19dd5 2023-01-17 stsp <p class="Pp">As above, but list the most recently modified branches only:</p>
3079 47f19dd5 2023-01-17 stsp <p class="Pp"></p>
3080 47f19dd5 2023-01-17 stsp <div class="Bd Bd-indent"><code class="Li">$ got branch -lt | head</code></div>
3081 8797b228 2019-08-04 stsp <p class="Pp">In a work tree or a git repository directory, create a new branch
3082 8797b228 2019-08-04 stsp called “unified-buffer-cache” which is forked off the
3083 8797b228 2019-08-04 stsp “master” branch:</p>
3084 8797b228 2019-08-04 stsp <p class="Pp"></p>
3085 039953c9 2021-03-22 stsp <div class="Bd Bd-indent"><code class="Li">$ got branch -c master
3086 039953c9 2021-03-22 stsp unified-buffer-cache</code></div>
3087 8797b228 2019-08-04 stsp <p class="Pp">Switch an existing work tree to the branch
3088 8797b228 2019-08-04 stsp “unified-buffer-cache”. Local changes in the work tree will be
3089 8797b228 2019-08-04 stsp preserved and merged if necessary:</p>
3090 8797b228 2019-08-04 stsp <p class="Pp"></p>
3091 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b
3092 8797b228 2019-08-04 stsp unified-buffer-cache</code></div>
3093 8797b228 2019-08-04 stsp <p class="Pp">Create a new commit from local changes in a work tree directory.
3094 8797b228 2019-08-04 stsp This new commit will become the head commit of the work tree's current
3095 8797b228 2019-08-04 stsp branch:</p>
3096 8797b228 2019-08-04 stsp <p class="Pp"></p>
3097 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got commit</code></div>
3098 8797b228 2019-08-04 stsp <p class="Pp">In a work tree or a git repository directory, view changes
3099 8797b228 2019-08-04 stsp committed in the 3 most recent commits to the work tree's branch, or the
3100 8797b228 2019-08-04 stsp branch resolved via the repository's HEAD reference, respectively:</p>
3101 8797b228 2019-08-04 stsp <p class="Pp"></p>
3102 8b679b4b 2020-02-17 stsp <div class="Bd Bd-indent"><code class="Li">$ got log -p -l 3</code></div>
3103 a462773e 2020-04-19 stsp <p class="Pp">As above, but display changes in the order in which
3104 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="patch, section 1">patch(1)</a> could apply them in
3105 376d4d52 2022-07-04 stsp sequence:</p>
3106 a462773e 2020-04-19 stsp <p class="Pp"></p>
3107 a462773e 2020-04-19 stsp <div class="Bd Bd-indent"><code class="Li">$ got log -p -l 3 -R</code></div>
3108 7c3b4ab8 2020-02-25 stsp <p class="Pp">In a work tree or a git repository directory, log the history of a
3109 7c3b4ab8 2020-02-25 stsp subdirectory:</p>
3110 7c3b4ab8 2020-02-25 stsp <p class="Pp"></p>
3111 7c3b4ab8 2020-02-25 stsp <div class="Bd Bd-indent"><code class="Li">$ got log sys/uvm</code></div>
3112 7c3b4ab8 2020-02-25 stsp <p class="Pp">While operating inside a work tree, paths are specified relative
3113 7c3b4ab8 2020-02-25 stsp to the current working directory, so this command will log the subdirectory
3114 7c3b4ab8 2020-02-25 stsp <span class="Pa">sys/uvm</span>:</p>
3115 7c3b4ab8 2020-02-25 stsp <p class="Pp"></p>
3116 1554b334 2020-08-02 stsp <div class="Bd Bd-indent"><code class="Li">$ cd sys/uvm && got
3117 1554b334 2020-08-02 stsp log .</code></div>
3118 7c3b4ab8 2020-02-25 stsp <p class="Pp">And this command has the same effect:</p>
3119 7c3b4ab8 2020-02-25 stsp <p class="Pp"></p>
3120 7c3b4ab8 2020-02-25 stsp <div class="Bd Bd-indent"><code class="Li">$ cd sys/dev/usb && got log
3121 7c3b4ab8 2020-02-25 stsp ../../uvm</code></div>
3122 1554b334 2020-08-02 stsp <p class="Pp">And this command displays work tree meta-data about all tracked
3123 1554b334 2020-08-02 stsp files:</p>
3124 1554b334 2020-08-02 stsp <p class="Pp"></p>
3125 1554b334 2020-08-02 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3126 1554b334 2020-08-02 stsp <div class="Bd Bd-indent"><code class="Li">$ got info . |
3127 1554b334 2020-08-02 stsp less</code></div>
3128 8797b228 2019-08-04 stsp <p class="Pp">Add new files and remove obsolete files in a work tree
3129 8797b228 2019-08-04 stsp directory:</p>
3130 8797b228 2019-08-04 stsp <p class="Pp"></p>
3131 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got add
3132 8797b228 2019-08-04 stsp sys/uvm/uvm_ubc.c</code></div>
3133 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got remove
3134 8797b228 2019-08-04 stsp sys/uvm/uvm_vnode.c</code></div>
3135 8797b228 2019-08-04 stsp <p class="Pp">Create a new commit from local changes in a work tree directory
3136 8797b228 2019-08-04 stsp with a pre-defined log message.</p>
3137 8797b228 2019-08-04 stsp <p class="Pp"></p>
3138 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got commit -m 'unify the buffer
3139 8797b228 2019-08-04 stsp cache'</code></div>
3140 2dbbbc3a 2020-07-23 stsp <p class="Pp">Alternatively, create a new commit from local changes in a work
3141 2dbbbc3a 2020-07-23 stsp tree directory with a log message that has been prepared in the file
3142 56dd4d48 2021-04-05 stsp <span class="Pa">/tmp/msg</span>:</p>
3143 2dbbbc3a 2020-07-23 stsp <p class="Pp"></p>
3144 039953c9 2021-03-22 stsp <div class="Bd Bd-indent"><code class="Li">$ got commit -F /tmp/msg</code></div>
3145 8797b228 2019-08-04 stsp <p class="Pp">Update any work tree checked out from the
3146 8797b228 2019-08-04 stsp “unified-buffer-cache” branch to the latest commit on this
3147 8797b228 2019-08-04 stsp branch:</p>
3148 8797b228 2019-08-04 stsp <p class="Pp"></p>
3149 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update</code></div>
3150 8797b228 2019-08-04 stsp <p class="Pp">Roll file content on the unified-buffer-cache branch back by one
3151 8797b228 2019-08-04 stsp commit, and then fetch the rolled-back change into the work tree as a local
3152 8797b228 2019-08-04 stsp change to be amended and perhaps committed again:</p>
3153 8797b228 2019-08-04 stsp <p class="Pp"></p>
3154 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got backout
3155 8797b228 2019-08-04 stsp unified-buffer-cache</code></div>
3156 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got commit -m 'roll back
3157 8797b228 2019-08-04 stsp previous'</code></div>
3158 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ # now back out the previous backout
3159 8797b228 2019-08-04 stsp :-)</code></div>
3160 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got backout
3161 8797b228 2019-08-04 stsp unified-buffer-cache</code></div>
3162 def5be4a 2021-08-31 stsp <p class="Pp">Fetch new changes on the remote repository's
3163 def5be4a 2021-08-31 stsp “master” branch, making them visible on the local repository's
3164 b213cbf7 2020-03-23 stsp “origin/master” branch:</p>
3165 8797b228 2019-08-04 stsp <p class="Pp"></p>
3166 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3167 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got fetch</code></div>
3168 b213cbf7 2020-03-23 stsp <p class="Pp">Rebase the local “master” branch to merge the new
3169 b213cbf7 2020-03-23 stsp changes that are now visible on the “origin/master”
3170 b213cbf7 2020-03-23 stsp branch:</p>
3171 b213cbf7 2020-03-23 stsp <p class="Pp"></p>
3172 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /usr/src</code></div>
3173 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b
3174 b213cbf7 2020-03-23 stsp origin/master</code></div>
3175 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3176 8797b228 2019-08-04 stsp <p class="Pp">Rebase the “unified-buffer-cache” branch on top of
3177 8797b228 2019-08-04 stsp the new head commit of the “master” branch.</p>
3178 8797b228 2019-08-04 stsp <p class="Pp"></p>
3179 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3180 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got rebase
3181 8797b228 2019-08-04 stsp unified-buffer-cache</code></div>
3182 8797b228 2019-08-04 stsp <p class="Pp">Create a patch from all changes on the unified-buffer-cache
3183 4967d3c2 2019-08-12 stsp branch. The patch can be mailed out for review and applied to
3184 4967d3c2 2019-08-12 stsp <span class="Ux">OpenBSD</span>'s CVS tree:</p>
3185 8797b228 2019-08-04 stsp <p class="Pp"></p>
3186 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got diff master
3187 8797b228 2019-08-04 stsp unified-buffer-cache > /tmp/ubc.diff</code></div>
3188 8797b228 2019-08-04 stsp <p class="Pp">Edit the entire commit history of the
3189 8797b228 2019-08-04 stsp “unified-buffer-cache” branch:</p>
3190 8797b228 2019-08-04 stsp <p class="Pp"></p>
3191 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b
3192 8797b228 2019-08-04 stsp unified-buffer-cache</code></div>
3193 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -c master</code></div>
3194 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got histedit</code></div>
3195 def5be4a 2021-08-31 stsp <p class="Pp">Before working against existing branches in a repository cloned
3196 def5be4a 2021-08-31 stsp with <code class="Cm">git clone --bare</code> instead of
3197 def5be4a 2021-08-31 stsp <code class="Cm">got clone</code>, a Git “refspec” must be
3198 b213cbf7 2020-03-23 stsp configured to map all references in the remote repository into the
3199 56dd4d48 2021-04-05 stsp “refs/remotes” namespace of the local repository. This can be
3200 b213cbf7 2020-03-23 stsp achieved by setting Git's <span class="Pa">remote.origin.fetch</span>
3201 b213cbf7 2020-03-23 stsp configuration variable to the value
3202 b213cbf7 2020-03-23 stsp “+refs/heads/*:refs/remotes/origin/*” with the
3203 8797b228 2019-08-04 stsp <code class="Cm">git config</code> command:</p>
3204 8797b228 2019-08-04 stsp <p class="Pp"></p>
3205 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/repo</code></div>
3206 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ git config remote.origin.fetch
3207 8797b228 2019-08-04 stsp '+refs/heads/*:refs/remotes/origin/*'</code></div>
3208 b213cbf7 2020-03-23 stsp <p class="Pp">Additionally, the “mirror” option must be
3209 b213cbf7 2020-03-23 stsp disabled:</p>
3210 b213cbf7 2020-03-23 stsp <p class="Pp"></p>
3211 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/repo</code></div>
3212 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">$ git config remote.origin.mirror
3213 b213cbf7 2020-03-23 stsp false</code></div>
3214 376d4d52 2022-07-04 stsp <p class="Pp">Alternatively, the following <a class="Xr" aria-label="git-fetch,
3215 376d4d52 2022-07-04 stsp section 1">git-fetch(1)</a> configuration item can be added manually to the
3216 376d4d52 2022-07-04 stsp Git repository's <span class="Pa">config</span> file:</p>
3217 8797b228 2019-08-04 stsp <p class="Pp"></p>
3218 a954aa0a 2021-06-22 stsp <div class="Bd Bd-indent"><code class="Li">[remote
3219 a954aa0a 2021-06-22 stsp "origin"]</code></div>
3220 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">url = ...</code></div>
3221 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">fetch =
3222 8797b228 2019-08-04 stsp +refs/heads/*:refs/remotes/origin/*</code></div>
3223 b213cbf7 2020-03-23 stsp <div class="Bd Bd-indent"><code class="Li">mirror = false</code></div>
3224 8797b228 2019-08-04 stsp <p class="Pp">This configuration leaves the local repository's
3225 8797b228 2019-08-04 stsp “refs/heads” namespace free for use by local branches checked
3226 8797b228 2019-08-04 stsp out with <code class="Cm">got checkout</code> and, if needed, created with
3227 def5be4a 2021-08-31 stsp <code class="Cm">got branch</code>. Branches in the
3228 def5be4a 2021-08-31 stsp “refs/remotes/origin” namespace can now be updated with
3229 def5be4a 2021-08-31 stsp incoming changes from the remote repository with <code class="Cm">got
3230 376d4d52 2022-07-04 stsp fetch</code> or <a class="Xr" aria-label="git-fetch, section
3231 376d4d52 2022-07-04 stsp 1">git-fetch(1)</a> without extra command line arguments. Newly fetched
3232 376d4d52 2022-07-04 stsp changes can be examined with <code class="Cm">got log</code>.</p>
3233 def5be4a 2021-08-31 stsp <p class="Pp">Display changes on the remote repository's version of the
3234 def5be4a 2021-08-31 stsp “master” branch, as of the last time <code class="Cm">got
3235 def5be4a 2021-08-31 stsp fetch</code> was run:</p>
3236 8797b228 2019-08-04 stsp <p class="Pp"></p>
3237 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got log -c origin/master |
3238 def5be4a 2021-08-31 stsp less</code></div>
3239 def5be4a 2021-08-31 stsp <p class="Pp">As shown here, most commands accept abbreviated reference names
3240 def5be4a 2021-08-31 stsp such as “origin/master” instead of
3241 def5be4a 2021-08-31 stsp “refs/remotes/origin/master”. The latter is only needed in
3242 def5be4a 2021-08-31 stsp case of ambiguity.</p>
3243 41ae98c9 2023-06-23 stsp <p class="Pp"><code class="Cm">got rebase</code> can be used to merge changes
3244 def5be4a 2021-08-31 stsp which are visible on the “origin/master” branch into the
3245 def5be4a 2021-08-31 stsp “master” branch. This will also merge local changes, if any,
3246 def5be4a 2021-08-31 stsp with the incoming changes:</p>
3247 8797b228 2019-08-04 stsp <p class="Pp"></p>
3248 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b
3249 8797b228 2019-08-04 stsp origin/master</code></div>
3250 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3251 def5be4a 2021-08-31 stsp <p class="Pp">In order to make changes committed to the
3252 def5be4a 2021-08-31 stsp “unified-buffer-cache” visible on the “master”
3253 41ae98c9 2023-06-23 stsp branch, the “unified-buffer-cache” branch can be rebased onto
3254 41ae98c9 2023-06-23 stsp the “master” branch:</p>
3255 def5be4a 2021-08-31 stsp <p class="Pp"></p>
3256 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3257 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got rebase
3258 def5be4a 2021-08-31 stsp unified-buffer-cache</code></div>
3259 def5be4a 2021-08-31 stsp <p class="Pp">Changes on the “unified-buffer-cache” branch can now
3260 def5be4a 2021-08-31 stsp be made visible on the “master” branch with
3261 def5be4a 2021-08-31 stsp <code class="Cm">got integrate</code>. Because the rebase operation switched
3262 b078d5c4 2022-03-23 stsp the work tree to the “unified-buffer-cache” branch, the work
3263 def5be4a 2021-08-31 stsp tree must be switched back to the “master” branch first:</p>
3264 def5be4a 2021-08-31 stsp <p class="Pp"></p>
3265 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3266 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got integrate
3267 def5be4a 2021-08-31 stsp unified-buffer-cache</code></div>
3268 7c3b4ab8 2020-02-25 stsp <p class="Pp">On the “master” branch, log messages for local
3269 7c3b4ab8 2020-02-25 stsp changes can now be amended with “OK” by other developers and
3270 7c3b4ab8 2020-02-25 stsp any other important new information:</p>
3271 7c3b4ab8 2020-02-25 stsp <p class="Pp"></p>
3272 7c3b4ab8 2020-02-25 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -c
3273 7c3b4ab8 2020-02-25 stsp origin/master</code></div>
3274 7c3b4ab8 2020-02-25 stsp <div class="Bd Bd-indent"><code class="Li">$ got histedit -m</code></div>
3275 b078d5c4 2022-03-23 stsp <p class="Pp">If the remote repository offers write access, local changes on the
3276 def5be4a 2021-08-31 stsp “master” branch can be sent to the remote repository with
3277 63b69821 2021-10-16 stsp <code class="Cm">got send</code>. Usually, <code class="Cm">got send</code>
3278 def5be4a 2021-08-31 stsp can be run without further arguments. The arguments shown here match
3279 def5be4a 2021-08-31 stsp defaults, provided the work tree's current branch is the
3280 def5be4a 2021-08-31 stsp “master” branch:</p>
3281 8797b228 2019-08-04 stsp <p class="Pp"></p>
3282 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ got send -b master
3283 def5be4a 2021-08-31 stsp origin</code></div>
3284 b078d5c4 2022-03-23 stsp <p class="Pp">If the remote repository requires the HTTPS protocol, the
3285 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-push, section 1">git-push(1)</a> command must
3286 376d4d52 2022-07-04 stsp be used instead:</p>
3287 def5be4a 2021-08-31 stsp <p class="Pp"></p>
3288 def5be4a 2021-08-31 stsp <div class="Bd Bd-indent"><code class="Li">$ cd /var/git/src.git</code></div>
3289 8797b228 2019-08-04 stsp <div class="Bd Bd-indent"><code class="Li">$ git push origin master</code></div>
3290 63657f42 2022-09-07 stsp <p class="Pp">When making contributions to projects which use the “pull
3291 63657f42 2022-09-07 stsp request” workflow, SSH protocol repository access needs to be set up
3292 63657f42 2022-09-07 stsp first. Once an account has been created on a Git hosting site it should be
3293 63657f42 2022-09-07 stsp possible to upload a public SSH key for repository access
3294 63657f42 2022-09-07 stsp authentication.</p>
3295 63657f42 2022-09-07 stsp <p class="Pp">The “pull request” workflow will usually involve two
3296 63657f42 2022-09-07 stsp remote repositories. In the real-life example below, the
3297 63657f42 2022-09-07 stsp “origin” repository was forked from the
3298 63657f42 2022-09-07 stsp “upstream” repository by using the Git hosting site's web
3299 63657f42 2022-09-07 stsp interface. The <a class="Xr" aria-label="got.conf, section
3300 63657f42 2022-09-07 stsp 5">got.conf(5)</a> file in the local repository describes both remote
3301 63657f42 2022-09-07 stsp repositories:</p>
3302 63657f42 2022-09-07 stsp <div class="Bd Pp Bd-indent Li">
3303 63657f42 2022-09-07 stsp <pre># Jelmers's repository, which accepts pull requests
3304 63657f42 2022-09-07 stsp remote "upstream" {
3305 63657f42 2022-09-07 stsp server git@github.com
3306 63657f42 2022-09-07 stsp protocol ssh
3307 63657f42 2022-09-07 stsp repository "/jelmer/dulwich"
3308 63657f42 2022-09-07 stsp branch { "master" }
3311 63657f42 2022-09-07 stsp # Stefan's fork, used as the default remote repository
3312 63657f42 2022-09-07 stsp remote "origin" {
3313 63657f42 2022-09-07 stsp server git@github.com
3314 63657f42 2022-09-07 stsp protocol ssh
3315 63657f42 2022-09-07 stsp repository "/stspdotname/dulwich"
3316 63657f42 2022-09-07 stsp branch { "master" }
3319 63657f42 2022-09-07 stsp <p class="Pp">With this configuration, Stefan can create commits on
3320 63657f42 2022-09-07 stsp “refs/heads/master” and send them to the
3321 63657f42 2022-09-07 stsp “origin” repository by running:</p>
3322 63657f42 2022-09-07 stsp <p class="Pp"></p>
3323 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got send -b master
3324 63657f42 2022-09-07 stsp origin</code></div>
3325 63657f42 2022-09-07 stsp <p class="Pp">The changes can now be proposed to Jelmer by opening a pull
3326 63657f42 2022-09-07 stsp request via the Git hosting site's web interface. If Jelmer requests further
3327 63657f42 2022-09-07 stsp changes to be made, additional commits can be created on the
3328 63657f42 2022-09-07 stsp “master” branch and be added to the pull request by running
3329 63657f42 2022-09-07 stsp <code class="Cd">got send</code> again.</p>
3330 63657f42 2022-09-07 stsp <p class="Pp">If Jelmer prefers additional commits to be
3331 63657f42 2022-09-07 stsp “squashed” then the following commands can be used to achieve
3333 63657f42 2022-09-07 stsp <p class="Pp"></p>
3334 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3335 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -c
3336 63657f42 2022-09-07 stsp origin/master</code></div>
3337 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got histedit -f</code></div>
3338 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got send -f -b master
3339 e68eaba8 2023-04-20 stsp origin</code></div>
3340 e68eaba8 2023-04-20 stsp <p class="Pp">In addition to reviewing the pull request in the web user
3341 e68eaba8 2023-04-20 stsp interface, Jelmer can fetch the pull request's branch into his local
3342 e68eaba8 2023-04-20 stsp repository and create a local branch which contains the proposed
3343 e68eaba8 2023-04-20 stsp changes:</p>
3344 e68eaba8 2023-04-20 stsp <p class="Pp"></p>
3345 e68eaba8 2023-04-20 stsp <div class="Bd Bd-indent"><code class="Li">$ got fetch -R refs/pull/1046/head
3346 63657f42 2022-09-07 stsp origin</code></div>
3347 e68eaba8 2023-04-20 stsp <div class="Bd Bd-indent"><code class="Li">$ got branch -c
3348 e68eaba8 2023-04-20 stsp refs/remotes/origin/pull/1046/head pr1046</code></div>
3349 63657f42 2022-09-07 stsp <p class="Pp">Once Jelmer has accepted the pull request, Stefan can fetch the
3350 63657f42 2022-09-07 stsp merged changes, and possibly several other new changes, by running:</p>
3351 63657f42 2022-09-07 stsp <p class="Pp"></p>
3352 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got fetch upstream</code></div>
3353 63657f42 2022-09-07 stsp <p class="Pp">The merged changes will now be visible under the reference
3354 63657f42 2022-09-07 stsp “refs/remotes/upstream/master”. The local
3355 63657f42 2022-09-07 stsp “master” branch can now be rebased on top of the latest
3356 63657f42 2022-09-07 stsp changes from upstream:</p>
3357 63657f42 2022-09-07 stsp <p class="Pp"></p>
3358 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b
3359 63657f42 2022-09-07 stsp upstream/master</code></div>
3360 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got rebase master</code></div>
3361 41ae98c9 2023-06-23 stsp <p class="Pp">As an alternative to <code class="Cm">got rebase</code>, branches
3362 41ae98c9 2023-06-23 stsp can be merged with <code class="Cm">got merge</code>:</p>
3363 41ae98c9 2023-06-23 stsp <p class="Pp"></p>
3364 41ae98c9 2023-06-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got update -b master</code></div>
3365 41ae98c9 2023-06-23 stsp <div class="Bd Bd-indent"><code class="Li">$ got merge
3366 41ae98c9 2023-06-23 stsp upstream/master</code></div>
3367 41ae98c9 2023-06-23 stsp <p class="Pp">The question of whether to rebase or merge branches is
3368 41ae98c9 2023-06-23 stsp philosophical. When in doubt, refer to the software project's policies set
3369 41ae98c9 2023-06-23 stsp by project maintainers.</p>
3370 63657f42 2022-09-07 stsp <p class="Pp">As a final step, the forked repository's copy of the master branch
3371 63657f42 2022-09-07 stsp needs to be kept in sync by sending the new changes there:</p>
3372 63657f42 2022-09-07 stsp <p class="Pp"></p>
3373 63657f42 2022-09-07 stsp <div class="Bd Bd-indent"><code class="Li">$ got send -f -b master
3374 63657f42 2022-09-07 stsp origin</code></div>
3375 63657f42 2022-09-07 stsp <p class="Pp">If multiple pull requests need to be managed in parallel, a
3376 63657f42 2022-09-07 stsp separate branch must be created for each pull request with
3377 63657f42 2022-09-07 stsp <code class="Cm">got branch</code>. Each such branch can then be used as
3378 63657f42 2022-09-07 stsp above, in place of “refs/heads/master”. Changes for any
3379 63657f42 2022-09-07 stsp accepted pull requests will still appear under
3380 63657f42 2022-09-07 stsp “refs/remotes/upstream/master,” regardless of which branch was
3381 63657f42 2022-09-07 stsp used in the forked repository to create a pull request.</p>
3382 8797b228 2019-08-04 stsp </section>
3383 8797b228 2019-08-04 stsp <section class="Sh">
3384 63657f42 2022-09-07 stsp <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
3385 63657f42 2022-09-07 stsp ALSO</a></h2>
3386 376d4d52 2022-07-04 stsp <p class="Pp"><a class="Xr" aria-label="gotadmin, section 1">gotadmin(1)</a>,
3387 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="tog, section 1">tog(1)</a>,
3388 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-repository, section 5">git-repository(5)</a>,
3389 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="got-worktree, section 5">got-worktree(5)</a>,
3390 51683866 2022-07-14 stsp <a class="Xr" aria-label="got.conf, section 5">got.conf(5)</a>,
3391 47f19dd5 2023-01-17 stsp <a class="Xr" aria-label="gotwebd, section 8">gotwebd(8)</a></p>
3392 8797b228 2019-08-04 stsp </section>
3393 8797b228 2019-08-04 stsp <section class="Sh">
3394 63657f42 2022-09-07 stsp <h2 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h2>
3395 51683866 2022-07-14 stsp <p class="Pp"><span class="An">Anthony J. Bentley</span>
3396 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:bentley@openbsd.org">bentley@openbsd.org</a>>
3398 51683866 2022-07-14 stsp <span class="An">Christian Weisgerber</span>
3399 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:naddy@openbsd.org">naddy@openbsd.org</a>>
3401 51683866 2022-07-14 stsp <span class="An">Hiltjo Posthuma</span>
3402 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:hiltjo@codemadness.org">hiltjo@codemadness.org</a>>
3404 51683866 2022-07-14 stsp <span class="An">Josh Rickmar</span>
3405 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:jrick@zettaport.com">jrick@zettaport.com</a>>
3407 d8e62599 2019-10-21 stsp <span class="An">Joshua Stein</span>
3408 b213cbf7 2020-03-23 stsp <<a class="Mt" href="mailto:jcs@openbsd.org">jcs@openbsd.org</a>>
3410 51683866 2022-07-14 stsp <span class="An">Klemens Nanni</span>
3411 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:kn@openbsd.org">kn@openbsd.org</a>>
3413 51683866 2022-07-14 stsp <span class="An">Martin Pieuchot</span>
3414 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:mpi@openbsd.org">mpi@openbsd.org</a>>
3416 51683866 2022-07-14 stsp <span class="An">Neels Hofmeyr</span>
3417 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:neels@hofmeyr.de">neels@hofmeyr.de</a>>
3419 51683866 2022-07-14 stsp <span class="An">Omar Polo</span>
3420 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:op@openbsd.org">op@openbsd.org</a>>
3422 b213cbf7 2020-03-23 stsp <span class="An">Ori Bernstein</span>
3423 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:ori@openbsd.org">ori@openbsd.org</a>>
3425 51683866 2022-07-14 stsp <span class="An">Sebastien Marie</span>
3426 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:semarie@openbsd.org">semarie@openbsd.org</a>>
3428 51683866 2022-07-14 stsp <span class="An">Stefan Sperling</span>
3429 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:stsp@openbsd.org">stsp@openbsd.org</a>>
3431 51683866 2022-07-14 stsp <span class="An">Steven McDonald</span>
3432 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:steven@steven-mcdonald.id.au">steven@steven-mcdonald.id.au</a>>
3434 51683866 2022-07-14 stsp <span class="An">Theo Buehler</span>
3435 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:tb@openbsd.org">tb@openbsd.org</a>>
3437 51683866 2022-07-14 stsp <span class="An">Thomas Adam</span>
3438 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:thomas@xteddy.org">thomas@xteddy.org</a>>
3440 51683866 2022-07-14 stsp <span class="An">Tracey Emery</span>
3441 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:tracey@traceyemery.net">tracey@traceyemery.net</a>>
3443 51683866 2022-07-14 stsp <span class="An">Yang Zhong</span>
3444 51683866 2022-07-14 stsp <<a class="Mt" href="mailto:yzhong@freebsdfoundation.org">yzhong@freebsdfoundation.org</a>></p>
3445 51683866 2022-07-14 stsp <p class="Pp">Parts of <code class="Nm">got</code>,
3446 51683866 2022-07-14 stsp <a class="Xr" aria-label="tog, section 1">tog(1)</a>, and
3447 47f19dd5 2023-01-17 stsp <a class="Xr" aria-label="gotwebd, section 8">gotwebd(8)</a> were derived
3448 47f19dd5 2023-01-17 stsp from code under copyright by:</p>
3449 51683866 2022-07-14 stsp <p class="Pp">
3451 63657f42 2022-09-07 stsp <span class="An">Caldera International</span>
3453 51683866 2022-07-14 stsp <span class="An">Daniel Hartmeier</span>
3455 51683866 2022-07-14 stsp <span class="An">Esben Norby</span>
3457 51683866 2022-07-14 stsp <span class="An">Henning Brauer</span>
3459 51683866 2022-07-14 stsp <span class="An">Håkan Olsson</span>
3461 51683866 2022-07-14 stsp <span class="An">Ingo Schwarze</span>
3463 51683866 2022-07-14 stsp <span class="An">Jean-Francois Brousseau</span>
3465 51683866 2022-07-14 stsp <span class="An">Joris Vink</span>
3467 51683866 2022-07-14 stsp <span class="An">Jyri J. Virkki</span>
3469 51683866 2022-07-14 stsp <span class="An">Larry Wall</span>
3471 51683866 2022-07-14 stsp <span class="An">Markus Friedl</span>
3473 51683866 2022-07-14 stsp <span class="An">Niall O'Higgins</span>
3475 51683866 2022-07-14 stsp <span class="An">Niklas Hallqvist</span>
3477 51683866 2022-07-14 stsp <span class="An">Ray Lai</span>
3479 51683866 2022-07-14 stsp <span class="An">Ryan McBride</span>
3481 51683866 2022-07-14 stsp <span class="An">Theo de Raadt</span>
3483 51683866 2022-07-14 stsp <span class="An">Todd C. Miller</span>
3485 51683866 2022-07-14 stsp <span class="An">Xavier Santolaria</span></p>
3486 51683866 2022-07-14 stsp <p class="Pp"><code class="Nm">got</code> contains code contributed to the
3487 51683866 2022-07-14 stsp public domain by
3489 47f19dd5 2023-01-17 stsp <span class="An">Austin Appleby</span>.</p>
3490 8797b228 2019-08-04 stsp </section>
3491 8797b228 2019-08-04 stsp <section class="Sh">
3492 63657f42 2022-09-07 stsp <h2 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h2>
3493 bbf83bf8 2020-12-27 stsp <p class="Pp"><code class="Nm">got</code> is a work-in-progress and some
3494 bbf83bf8 2020-12-27 stsp features remain to be implemented.</p>
3495 376d4d52 2022-07-04 stsp <p class="Pp">At present, the user has to fall back on
3496 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git, section 1">git(1)</a> to perform some tasks.
3497 376d4d52 2022-07-04 stsp In particular:</p>
3498 bbf83bf8 2020-12-27 stsp <ul class="Bl-bullet">
3499 def5be4a 2021-08-31 stsp <li>Writing to remote repositories over HTTP or HTTPS protocols requires
3500 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-push, section 1">git-push(1)</a>.</li>
3501 417cb057 2021-10-03 stsp <li>The creation of merge commits with more than two parent commits requires
3502 376d4d52 2022-07-04 stsp <a class="Xr" aria-label="git-merge, section 1">git-merge(1)</a>.</li>
3503 bbf83bf8 2020-12-27 stsp <li>In situations where files or directories were moved around
3504 bbf83bf8 2020-12-27 stsp <code class="Cm">got</code> will not automatically merge changes to new
3505 376d4d52 2022-07-04 stsp locations and <a class="Xr" aria-label="git, section 1">git(1)</a> will
3506 376d4d52 2022-07-04 stsp usually produce better results.</li>
3508 8797b228 2019-08-04 stsp </section>
3510 63657f42 2022-09-07 stsp <div class="foot" role="doc-pagefooter" aria-label="Manual footer
3511 bd0bf387 2024-04-23 stsp line"><span class="foot-left"></span><span class="foot-date">April 23,
3512 2b1d45b9 2024-03-11 stsp 2024</span> <span class="foot-os">OpenBSD 7.5</span></div>
