2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5aa81393 2020-01-06 stsp .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
22 8e13c46f 2019-08-05 stsp .Nd Game of Trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
30 4dfb2f0f 2019-03-26 stsp is a version control system which stores the history of tracked files
31 4dfb2f0f 2019-03-26 stsp in a Git repository, as used by the Git version control system.
32 285dc8a4 2018-03-13 stsp This repository format is described in
33 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 ae73e26f 2019-03-26 stsp .Dq distributed
38 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
39 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
40 97925469 2018-03-17 stsp at any time.
42 285dc8a4 2018-03-13 stsp Files managed by
44 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
45 285dc8a4 2018-03-13 stsp Checked out files are stored in a
46 285dc8a4 2018-03-13 stsp .Em work tree
47 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
48 fb2921d0 2019-03-26 stsp The on-disk format of this work tree is described in
49 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
53 eeb02ce9 2024-06-03 thomas utility provides global and command-specific options.
54 bc3056e3 2019-08-18 stsp Global options must precede the command name, and are as follows:
55 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
57 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
58 1795b260 2021-04-02 kn .It Fl V , -version
59 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
64 eeb02ce9 2024-06-03 thomas utility only provides commands needed to perform version control tasks.
65 eeb02ce9 2024-06-03 thomas Commands needed for repository maintenance tasks are provided by
66 ada2ec4f 2024-06-03 thomas .Xr gotadmin 1 .
67 eeb02ce9 2024-06-03 thomas Git repository server functionality is provided by
68 eeb02ce9 2024-06-03 thomas .Xr gotd 8 .
69 eeb02ce9 2024-06-03 thomas A repository interface for web browsers is provided by
70 eeb02ce9 2024-06-03 thomas .Xr gotwebd 8 .
71 eeb02ce9 2024-06-03 thomas An interactive repository interface for the terminal is provided by
72 eeb02ce9 2024-06-03 thomas .Xr tog 1 .
74 38e11793 2018-06-13 stsp The commands for
76 38e11793 2018-06-13 stsp are as follows:
77 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
78 6becd179 2024-06-03 thomas .It Cm init Oo Fl b Ar branch Oc Ar repository-path
79 6becd179 2024-06-03 thomas Create a new empty repository at the specified
80 6becd179 2024-06-03 thomas .Ar repository-path .
83 6becd179 2024-06-03 thomas .Cm got init ,
84 6becd179 2024-06-03 thomas the new repository must be populated before
85 6becd179 2024-06-03 thomas .Cm got checkout
86 6becd179 2024-06-03 thomas can be used.
88 6becd179 2024-06-03 thomas .Cm got import
89 6becd179 2024-06-03 thomas command can be used to populate the new repository with data from
90 6becd179 2024-06-03 thomas a local directory.
91 6becd179 2024-06-03 thomas Alternatively, on a server running
92 6becd179 2024-06-03 thomas .Xr gotd 8 ,
93 6becd179 2024-06-03 thomas the new repository can be made available to
97 6becd179 2024-06-03 thomas clients by adding the repository to
98 6becd179 2024-06-03 thomas .Xr gotd.conf 5
99 6becd179 2024-06-03 thomas and restarting
100 6becd179 2024-06-03 thomas .Xr gotd 8 .
101 6becd179 2024-06-03 thomas Clients may then clone the new repository from the server, populate the cloned
102 6becd179 2024-06-03 thomas repository, and then populate the new repository on the server via
103 6becd179 2024-06-03 thomas .Cm got send
105 6becd179 2024-06-03 thomas .Cm git push .
107 6becd179 2024-06-03 thomas The options for
108 6becd179 2024-06-03 thomas .Cm got init
109 6becd179 2024-06-03 thomas are as follows:
110 6becd179 2024-06-03 thomas .Bl -tag -width Ds
111 6becd179 2024-06-03 thomas .It Fl b Ar branch
112 6becd179 2024-06-03 thomas Make the repository's HEAD reference point to the specified
113 6becd179 2024-06-03 thomas .Ar branch
114 6becd179 2024-06-03 thomas instead of the default branch
115 6becd179 2024-06-03 thomas .Dq main .
119 6becd179 2024-06-03 thomas .Cm got init
120 6becd179 2024-06-03 thomas command is equivalent to
121 6becd179 2024-06-03 thomas .Cm gotadmin init .
124 56c96eff 2022-08-30 thomas .Cm import
125 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
126 56c96eff 2022-08-30 thomas .Op Fl I Ar pattern
127 56c96eff 2022-08-30 thomas .Op Fl m Ar message
128 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
129 56c96eff 2022-08-30 thomas .Ar directory
131 d912d125 2021-11-04 thomas .Dl Pq alias: Cm im
132 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
133 3ce1b845 2019-07-15 stsp within the specified
134 3ce1b845 2019-07-15 stsp .Ar directory .
135 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
136 3ce1b845 2019-07-15 stsp root commit.
137 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
138 3ce1b845 2019-07-15 stsp created commit.
139 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
142 21a44f98 2019-07-15 stsp .Cm got import
143 21a44f98 2019-07-15 stsp command requires the
144 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
145 aba9c984 2019-09-08 stsp environment variable to be set,
146 257add31 2020-09-09 stsp unless an author has been configured in
147 257add31 2020-09-09 stsp .Xr got.conf 5
149 aba9c984 2019-09-08 stsp .Dv user.name
151 709ae9eb 2019-09-08 stsp .Dv user.email
152 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
153 aba9c984 2019-09-08 stsp .Pa .git/config
154 c9956ddf 2019-09-08 stsp file or from Git's global
155 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
156 c9956ddf 2019-09-08 stsp configuration file.
158 3ce1b845 2019-07-15 stsp The options for
159 3ce1b845 2019-07-15 stsp .Cm got import
160 3ce1b845 2019-07-15 stsp are as follows:
161 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
162 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
163 3ce1b845 2019-07-15 stsp Create the specified
164 e9424ba1 2022-09-20 thomas .Ar branch .
165 e9424ba1 2022-09-20 thomas If this option is not specified, a branch corresponding to the repository's
166 e9424ba1 2022-09-20 thomas HEAD reference will be used.
167 e9424ba1 2022-09-20 thomas Use of this option is required if the branch resolved via the repository's
168 e9424ba1 2022-09-20 thomas HEAD reference already exists.
169 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
170 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
171 3ce1b845 2019-07-15 stsp .Ar pattern .
172 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
174 3ce1b845 2019-07-15 stsp .Ar pattern
175 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
176 3ce1b845 2019-07-15 stsp .Xr glob 7 .
177 e012cf94 2023-02-07 thomas Ignore patterns which end with a slash,
179 e012cf94 2023-02-07 thomas will only match directories.
180 d6506a3d 2022-08-16 thomas .It Fl m Ar message
181 d6506a3d 2022-08-16 thomas Use the specified log message when creating the new commit.
182 d6506a3d 2022-08-16 thomas Without the
185 d6506a3d 2022-08-16 thomas .Cm got import
186 d6506a3d 2022-08-16 thomas opens a temporary file in an editor where a log message can be written.
187 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the import operation.
188 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
189 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
190 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
191 d6506a3d 2022-08-16 thomas working directory.
195 56c96eff 2022-08-30 thomas .Cm clone
196 56c96eff 2022-08-30 thomas .Op Fl almqv
197 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
198 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
199 56c96eff 2022-08-30 thomas .Ar repository-URL
200 56c96eff 2022-08-30 thomas .Op Ar directory
202 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cl
203 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
204 2ab43947 2020-03-18 stsp .Ar repository-URL
205 2ab43947 2020-03-18 stsp into the specified
206 3493b628 2020-03-20 stsp .Ar directory .
208 3493b628 2020-03-20 stsp .Ar directory
209 4b06140e 2022-03-22 thomas is specified, the directory name will be derived from the name of the
210 2ab43947 2020-03-18 stsp cloned repository.
211 2ab43947 2020-03-18 stsp .Cm got clone
212 2ab43947 2020-03-18 stsp will refuse to run if the
213 3493b628 2020-03-20 stsp .Ar directory
214 2ab43947 2020-03-18 stsp already exists.
217 2ab43947 2020-03-18 stsp .Ar repository-URL
218 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
219 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
220 619eb6dd 2020-03-20 stsp the server:
221 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
223 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
224 a2dbf179 2024-04-29 thomas .Bl -tag -width https
226 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
227 2ab43947 2020-03-18 stsp .Xr git-daemon 1
229 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
230 10c073e7 2020-03-20 stsp nor encryption.
231 32ce4ae6 2024-04-25 thomas.ad .It ssh
232 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
235 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
238 2ab43947 2020-03-18 stsp .Mt user@hostname
239 cda0eee6 2024-04-25 thomas.ad .It http
241 cda0eee6 2024-04-25 thomas.ad .Dq smart
242 4ef7a6b0 2024-04-25 thomas.ad Git HTTP protocol.
243 4ef7a6b0 2024-04-25 thomas.ad Not compatible with servers using the
244 4ef7a6b0 2024-04-25 thomas.ad .Dq dumb
245 4ef7a6b0 2024-04-25 thomas.ad Git HTTP protocol.
248 4ef7a6b0 2024-04-25 thomas.ad .Dq smart
249 4ef7a6b0 2024-04-25 thomas.ad Git HTTP protocol is supported by
250 cda0eee6 2024-04-25 thomas.ad .Cm got clone
252 cda0eee6 2024-04-25 thomas.ad .Cm got fetch ,
253 cda0eee6 2024-04-25 thomas.ad but not by
254 cda0eee6 2024-04-25 thomas.ad .Cm got send .
255 a2dbf179 2024-04-29 thomas Sending from a repository cloned over HTTP will require use of a
256 4ef7a6b0 2024-04-25 thomas.ad .Ic send
258 4ef7a6b0 2024-04-25 thomas.ad .Xr got.conf 5
259 4ef7a6b0 2024-04-25 thomas.ad to ensure that the
260 4ef7a6b0 2024-04-25 thomas.ad .Dq ssh://
261 4ef7a6b0 2024-04-25 thomas.ad protocol will be used by
262 4ef7a6b0 2024-04-25 thomas.ad .Cm got send .
264 cda0eee6 2024-04-25 thomas.ad Use of this protocol is discouraged since it supports neither authentication
265 cda0eee6 2024-04-25 thomas.ad nor encryption.
266 cda0eee6 2024-04-25 thomas.ad .It https
268 cda0eee6 2024-04-25 thomas.ad .Dq smart
269 cda0eee6 2024-04-25 thomas.ad Git HTTP protocol wrapped in SSL/TLS.
272 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
273 89c3c67b 2020-03-20 stsp from the server.
274 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
276 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
277 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
278 89c3c67b 2020-03-20 stsp This can take some time.
279 010f7279 2020-03-20 stsp More details about the pack file format are documented in
280 010f7279 2020-03-20 stsp .Xr git-repository 5 .
282 7848a0e1 2020-03-19 stsp .Cm got clone
283 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
284 257add31 2020-09-09 stsp .Xr got.conf 5
287 257add31 2020-09-09 stsp files of the cloned repository to store the
288 7848a0e1 2020-03-19 stsp .Ar repository-url
292 99495ddb 2021-01-10 stsp .Ar reference
293 132af4a5 2021-01-05 stsp arguments for future use by
294 7848a0e1 2020-03-19 stsp .Cm got fetch
296 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
298 2ab43947 2020-03-18 stsp The options for
299 2ab43947 2020-03-18 stsp .Cm got clone
300 2ab43947 2020-03-18 stsp are as follows:
301 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
303 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
304 1d4b192f 2020-03-21 stsp .Dq refs/heads/
305 5aa20203 2021-01-05 stsp reference namespace and set
306 25eb5847 2022-07-03 thomas .Cm fetch_all_branches
307 5aa20203 2021-01-05 stsp in the cloned repository's
308 5aa20203 2021-01-05 stsp .Xr got.conf 5
309 5aa20203 2021-01-05 stsp file for future use by
310 5aa20203 2021-01-05 stsp .Cm got fetch .
311 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
312 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
313 4ba14133 2020-03-20 stsp Cannot be used together with the
316 4ba14133 2020-03-20 stsp .It Fl b Ar branch
317 4ba14133 2020-03-20 stsp Fetch the specified
319 1d4b192f 2020-03-21 stsp from the remote repository's
320 1d4b192f 2020-03-21 stsp .Dq refs/heads/
321 1d4b192f 2020-03-21 stsp reference namespace.
322 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
324 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
325 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
326 4ba14133 2020-03-20 stsp branch which was fetched.
327 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
328 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
329 4ba14133 2020-03-20 stsp Cannot be used together with the
333 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
334 41b0de12 2020-03-21 stsp and exit immediately.
335 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
340 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
341 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
342 bd81cfb7 2020-04-19 stsp locally created commits.
344 469dd726 2020-03-20 stsp The repository's
345 257add31 2020-09-09 stsp .Xr got.conf 5
348 257add31 2020-09-09 stsp files will be set up with the
350 469dd726 2020-03-20 stsp option enabled, such that
351 469dd726 2020-03-20 stsp .Cm got fetch
353 469dd726 2020-03-20 stsp .Xr git-fetch 1
354 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
355 469dd726 2020-03-20 stsp .Dq refs/heads/
356 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
357 469dd726 2020-03-20 stsp .Dq refs/remotes/
359 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
360 469dd726 2020-03-20 stsp .Cm got rebase
362 1a70a207 2023-07-05 thomas .Cm got merge
364 469dd726 2020-03-20 stsp .Cm got fetch
365 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
366 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
368 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
369 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
370 498ef124 2020-03-21 stsp changes are fetched.
372 2ab43947 2020-03-18 stsp Suppress progress reporting output.
373 2ab43947 2020-03-18 stsp The same option will be passed to
375 2ab43947 2020-03-18 stsp if applicable.
376 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
377 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
378 0e4002ca 2020-03-21 stsp .Ar reference
379 0e4002ca 2020-03-21 stsp from the remote repository's
382 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
383 0e4002ca 2020-03-21 stsp references to fetch.
384 71f12362 2020-03-21 stsp The specified
385 71f12362 2020-03-21 stsp .Ar reference
386 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
387 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
389 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
390 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
391 0e4002ca 2020-03-21 stsp namespace, unless the
393 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
397 0e4002ca 2020-03-21 stsp .Cm got clone
398 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
399 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
401 0e4002ca 2020-03-21 stsp .Dq refs/got/
404 d6506a3d 2022-08-16 thomas Verbose mode.
406 d6506a3d 2022-08-16 thomas .Cm got clone
407 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
408 d6506a3d 2022-08-16 thomas This option will be passed to
409 d6506a3d 2022-08-16 thomas .Xr ssh 1
410 d6506a3d 2022-08-16 thomas if applicable.
411 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
412 d6506a3d 2022-08-16 thomas The maximum is 3.
416 56c96eff 2022-08-30 thomas .Cm fetch
417 56c96eff 2022-08-30 thomas .Op Fl adlqtvX
418 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
419 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
420 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
421 56c96eff 2022-08-30 thomas .Op Ar remote-repository
423 d912d125 2021-11-04 thomas .Dl Pq alias: Cm fe
424 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
426 4ba14133 2020-03-20 stsp .Ar remote-repository
427 4ba14133 2020-03-20 stsp is specified,
429 7848a0e1 2020-03-19 stsp will be used.
430 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
431 257add31 2020-09-09 stsp .Xr got.conf 5
434 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
435 7848a0e1 2020-03-19 stsp .Cm got clone .
437 8d0dceb3 2023-02-07 thomas By default, any branches configured in
438 8d0dceb3 2023-02-07 thomas .Xr got.conf 5
440 7917d6d5 2023-02-17 thomas .Ar remote-repository
441 8d0dceb3 2023-02-07 thomas will be fetched.
443 8d0dceb3 2023-02-07 thomas .Cm got fetch
444 8d0dceb3 2023-02-07 thomas is invoked in a work tree then this work tree's current branch will be
445 8d0dceb3 2023-02-07 thomas fetched, too, provided it is present on the server.
446 7917d6d5 2023-02-17 thomas If no branches to fetch can be found in
447 7917d6d5 2023-02-17 thomas .Xr got.conf 5
448 7917d6d5 2023-02-17 thomas or via a work tree, or said branches are not found on the server, a branch
449 7917d6d5 2023-02-17 thomas resolved via the remote repository's HEAD reference will be fetched.
450 7abf1863 2023-02-20 thomas Likewise, if a HEAD reference for the
451 7abf1863 2023-02-20 thomas .Ar remote-repository
452 7abf1863 2023-02-20 thomas exists but its target no longer matches the remote HEAD, then
453 7abf1863 2023-02-20 thomas the new target branch will be fetched.
454 e0380e3d 2023-02-17 thomas This default behaviour can be overridden with the
460 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
461 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
462 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
464 498ef124 2020-03-21 stsp By default, branch references in the
465 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
466 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
468 7848a0e1 2020-03-19 stsp .Cm got rebase
470 1a70a207 2023-07-05 thomas .Cm got merge
471 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
472 7848a0e1 2020-03-19 stsp .Dq refs/heads/
473 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
474 bd81cfb7 2020-04-19 stsp as necessary.
476 498ef124 2020-03-21 stsp If the repository was created as a mirror with
477 4b06140e 2022-03-22 thomas .Cm got clone -m ,
478 498ef124 2020-03-21 stsp then all branches in the
479 469dd726 2020-03-20 stsp .Dq refs/heads/
480 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
481 498ef124 2020-03-21 stsp the remote repository.
482 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
483 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
484 e6786710 2021-07-03 stsp by Git's garbage collector or
485 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
486 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
488 db6d8ad8 2020-03-21 stsp In any case, references in the
489 7848a0e1 2020-03-19 stsp .Dq refs/tags/
490 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
491 db6d8ad8 2020-03-21 stsp in the same namespace.
493 7848a0e1 2020-03-19 stsp The options for
494 7848a0e1 2020-03-19 stsp .Cm got fetch
495 7848a0e1 2020-03-19 stsp are as follows:
496 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
498 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
499 1d4b192f 2020-03-21 stsp .Dq refs/heads/
500 1d4b192f 2020-03-21 stsp reference namespace.
501 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
502 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
503 4ba14133 2020-03-20 stsp Cannot be used together with the
506 4ba14133 2020-03-20 stsp .It Fl b Ar branch
507 4ba14133 2020-03-20 stsp Fetch the specified
509 1d4b192f 2020-03-21 stsp from the remote repository's
510 1d4b192f 2020-03-21 stsp .Dq refs/heads/
511 1d4b192f 2020-03-21 stsp reference namespace.
512 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
514 4ba14133 2020-03-20 stsp Cannot be used together with the
518 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
519 f21ec2f0 2020-03-21 stsp present in the remote repository.
520 f21ec2f0 2020-03-21 stsp Only references are deleted.
521 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
522 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
523 e6786710 2021-07-03 stsp Git's garbage collector or
524 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
526 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
527 41b0de12 2020-03-21 stsp and exit immediately.
528 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
534 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
535 7848a0e1 2020-03-19 stsp The same option will be passed to
537 7848a0e1 2020-03-19 stsp if applicable.
538 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
539 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
540 0e4002ca 2020-03-21 stsp .Ar reference
541 0e4002ca 2020-03-21 stsp from the remote repository's
544 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
545 0e4002ca 2020-03-21 stsp references to fetch.
546 71f12362 2020-03-21 stsp The specified
547 71f12362 2020-03-21 stsp .Ar reference
548 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
549 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
551 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
552 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
553 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
554 a18cccf9 2020-03-21 stsp .Cm got clone -m
555 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
559 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
560 0e4002ca 2020-03-21 stsp .Cm got branch
563 0e4002ca 2020-03-21 stsp .Cm got fetch
564 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
565 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
567 0e4002ca 2020-03-21 stsp .Dq refs/got/
569 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
570 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
571 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
572 d6506a3d 2022-08-16 thomas working directory.
573 d6506a3d 2022-08-16 thomas If this directory is a
575 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
577 d6506a3d 2022-08-16 thomas Allow existing references in the
578 d6506a3d 2022-08-16 thomas .Dq refs/tags
579 d6506a3d 2022-08-16 thomas namespace to be updated if they have changed on the server.
580 d6506a3d 2022-08-16 thomas If not specified, only new tag references will be created.
582 d6506a3d 2022-08-16 thomas Verbose mode.
584 d6506a3d 2022-08-16 thomas .Cm got fetch
585 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
586 d6506a3d 2022-08-16 thomas The same option will be passed to
587 d6506a3d 2022-08-16 thomas .Xr ssh 1
588 d6506a3d 2022-08-16 thomas if applicable.
589 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
590 d6506a3d 2022-08-16 thomas The maximum is 3.
592 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
593 161728eb 2021-07-24 stsp .Ar remote-repository
594 161728eb 2021-07-24 stsp instead of fetching new changes.
595 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
596 161728eb 2021-07-24 stsp .Xr got.conf 5 .
601 161728eb 2021-07-24 stsp .Ar remote-repository
602 161728eb 2021-07-24 stsp argument is mandatory and no other options except
607 161728eb 2021-07-24 stsp are allowed.
609 161728eb 2021-07-24 stsp Only references are deleted.
610 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
611 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
612 161728eb 2021-07-24 stsp .Xr git-repack 1
613 161728eb 2021-07-24 stsp and Git's garbage collector.
617 56c96eff 2022-08-30 thomas .Cm checkout
618 233dfb11 2024-04-09 thomas .Op Fl \&Eq
619 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
620 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
621 56c96eff 2022-08-30 thomas .Op Fl p Ar path-prefix
622 56c96eff 2022-08-30 thomas .Ar repository-path
623 56c96eff 2022-08-30 thomas .Op Ar work-tree-path
625 d912d125 2021-11-04 thomas .Dl Pq alias: Cm co
626 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
627 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
628 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
629 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
630 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
634 5d7c1dab 2018-04-01 stsp .Ar work tree path
635 c844a238 2019-02-06 stsp is not specified, either use the last component of
636 5d7c1dab 2018-04-01 stsp .Ar repository path ,
638 5d7c1dab 2018-04-01 stsp .Ar path prefix
639 c844a238 2019-02-06 stsp was specified use the last component of
640 5d7c1dab 2018-04-01 stsp .Ar path prefix .
642 38e11793 2018-06-13 stsp The options for
643 38e11793 2018-06-13 stsp .Cm got checkout
644 38e11793 2018-06-13 stsp are as follows:
645 38e11793 2018-06-13 stsp .Bl -tag -width Ds
646 08573d5b 2019-05-14 stsp .It Fl b Ar branch
647 3c575567 2019-07-28 stsp Check out files from a commit on the specified
648 08573d5b 2019-05-14 stsp .Ar branch .
649 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
650 c844a238 2019-02-06 stsp reference will be used.
651 08573d5b 2019-05-14 stsp .It Fl c Ar commit
652 08573d5b 2019-05-14 stsp Check out files from the specified
654 3c575567 2019-07-28 stsp on the selected branch.
655 482b0b83 2023-07-19 thomas If this option is not specified, the most recent commit on the selected
656 482b0b83 2023-07-19 thomas branch will be used.
658 482b0b83 2023-07-19 thomas The expected
659 482b0b83 2023-07-19 thomas .Ar commit
660 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
661 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
662 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
663 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
664 a290e4b4 2023-07-19 thomas The keywords
665 fb885120 2023-07-19 thomas .Qq :base
667 fb885120 2023-07-19 thomas .Qq :head
668 a290e4b4 2023-07-19 thomas resolve to the repository's HEAD reference, or, if the
670 fb885120 2023-07-19 thomas option is used, the head of the checked-out
671 fb885120 2023-07-19 thomas .Ar branch .
672 fb885120 2023-07-19 thomas Keywords and reference names may be appended with
676 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
677 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
678 fb885120 2023-07-19 thomas for example,
679 fb885120 2023-07-19 thomas .Sy :head:-2
680 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
681 fb885120 2023-07-19 thomas .Sy foo:-3
682 fb885120 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
684 fb885120 2023-07-19 thomas reference.
685 fb885120 2023-07-19 thomas If an integer does not follow the
689 fb885120 2023-07-19 thomas modifier, a
691 fb885120 2023-07-19 thomas is implicitly appended
692 fb885120 2023-07-19 thomas .Po e.g.,
693 fb885120 2023-07-19 thomas .Sy :head:-
694 fb885120 2023-07-19 thomas is equivalent to
695 fb885120 2023-07-19 thomas .Sy :head:-1
698 4b6c9460 2020-03-05 stsp If the specified
700 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
701 4b6c9460 2020-03-05 stsp this commit must be specified with the
704 4b06140e 2022-03-22 thomas If no such branch is known, a new branch must be created for this
705 4b6c9460 2020-03-05 stsp commit with
706 4b6c9460 2020-03-05 stsp .Cm got branch
708 4b6c9460 2020-03-05 stsp .Cm got checkout
709 4b6c9460 2020-03-05 stsp can be used.
710 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
712 d6506a3d 2022-08-16 thomas Proceed with the checkout operation even if the directory at
713 d6506a3d 2022-08-16 thomas .Ar work-tree-path
714 d6506a3d 2022-08-16 thomas is not empty.
715 d6506a3d 2022-08-16 thomas Existing files will be left intact.
716 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
717 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
718 38e11793 2018-06-13 stsp Only files beneath the specified
719 38e11793 2018-06-13 stsp .Ar path-prefix
720 38e11793 2018-06-13 stsp will be checked out.
722 4ad4a1ec 2021-09-13 tracey Silence progress output.
726 56c96eff 2022-08-30 thomas .Cm update
728 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
729 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
730 56c96eff 2022-08-30 thomas .Op Ar path ...
732 d912d125 2021-11-04 thomas .Dl Pq alias: Cm up
733 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
734 4f331d3a 2020-04-01 stsp .Ar commit .
735 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
736 4f331d3a 2020-04-01 stsp of this commit.
737 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
738 4f331d3a 2020-04-01 stsp incoming changes.
740 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
741 5036ab18 2020-04-18 stsp further complications.
742 5036ab18 2020-04-18 stsp Such files will be updated when
743 5036ab18 2020-04-18 stsp .Cm got update
744 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
745 4b06140e 2022-03-22 thomas If the conflicting changes are no longer needed, affected files can be
746 5036ab18 2020-04-18 stsp reverted with
747 5036ab18 2020-04-18 stsp .Cm got revert
748 5036ab18 2020-04-18 stsp before running
749 5036ab18 2020-04-18 stsp .Cm got update
752 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
753 7f838b36 2019-02-08 stsp .Bl -column YXZ description
754 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
755 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
756 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
757 7f838b36 2019-02-08 stsp .It D Ta file was deleted
758 9f323212 2023-03-10 thomas .It d Ta file's deletion was prevented by local modifications
759 7f838b36 2019-02-08 stsp .It A Ta new file was added
760 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
761 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
762 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
763 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
768 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
769 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
770 f2ea84fa 2019-07-27 stsp specified paths.
771 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
772 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
773 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
776 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
777 c4cdcb68 2019-04-03 stsp multiple base commits.
778 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
779 47ec7be7 2019-05-12 stsp .Cm got update
780 47ec7be7 2019-05-12 stsp across the entire work tree.
781 024e9686 2019-05-14 stsp Specifying a
783 024e9686 2019-05-14 stsp is incompatible with the
787 4ed9f614 2019-08-04 stsp .Cm got update
788 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
789 4ed9f614 2019-08-04 stsp If changes have been staged with
790 4ed9f614 2019-08-04 stsp .Cm got stage ,
791 bc3056e3 2019-08-18 stsp these changes must first be committed with
792 4ed9f614 2019-08-04 stsp .Cm got commit
793 4ed9f614 2019-08-04 stsp or unstaged with
794 4ed9f614 2019-08-04 stsp .Cm got unstage .
796 507dc3bb 2018-12-29 stsp The options for
797 507dc3bb 2018-12-29 stsp .Cm got update
798 507dc3bb 2018-12-29 stsp are as follows:
799 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
800 024e9686 2019-05-14 stsp .It Fl b Ar branch
801 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
803 024e9686 2019-05-14 stsp before updating the work tree.
804 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
806 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
807 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
808 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
810 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
811 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
812 4f331d3a 2020-04-01 stsp .Ar branch .
813 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
814 4f331d3a 2020-04-01 stsp .Cm got commit ,
815 4f331d3a 2020-04-01 stsp or could be discarded with
816 4f331d3a 2020-04-01 stsp .Cm got revert .
817 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
818 507dc3bb 2018-12-29 stsp Update the work tree to the specified
819 507dc3bb 2018-12-29 stsp .Ar commit .
820 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
821 024e9686 2019-05-14 stsp branch will be used.
823 482b0b83 2023-07-19 thomas The expected
824 482b0b83 2023-07-19 thomas .Ar commit
825 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
826 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
827 482b0b83 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
828 482b0b83 2023-07-19 thomas automatically, provided the abbreviation is unique.
829 a290e4b4 2023-07-19 thomas The keywords
830 482b0b83 2023-07-19 thomas .Qq :base
832 482b0b83 2023-07-19 thomas .Qq :head
833 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
834 482b0b83 2023-07-19 thomas Keywords and reference names may be appended with
838 482b0b83 2023-07-19 thomas modifiers and an optional integer N to denote the
839 482b0b83 2023-07-19 thomas Nth descendant or antecedent, respectively, by first parent traversal;
840 482b0b83 2023-07-19 thomas for example,
841 482b0b83 2023-07-19 thomas .Sy :head:-2
842 482b0b83 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
843 482b0b83 2023-07-19 thomas .Sy :base:+4
844 482b0b83 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
845 482b0b83 2023-07-19 thomas Similarly,
846 482b0b83 2023-07-19 thomas .Sy foo:-3
847 482b0b83 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
849 482b0b83 2023-07-19 thomas reference.
850 482b0b83 2023-07-19 thomas If an integer does not follow the
854 482b0b83 2023-07-19 thomas modifier, a
856 482b0b83 2023-07-19 thomas is implicitly appended
857 482b0b83 2023-07-19 thomas .Po e.g.,
858 482b0b83 2023-07-19 thomas .Sy :head:-
859 482b0b83 2023-07-19 thomas is equivalent to
860 482b0b83 2023-07-19 thomas .Sy :head:-1
863 4ad4a1ec 2021-09-13 tracey Silence progress output.
867 56c96eff 2022-08-30 thomas .Cm status
869 56c96eff 2022-08-30 thomas .Op Fl S Ar status-codes
870 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
871 56c96eff 2022-08-30 thomas .Op Ar path ...
873 d912d125 2021-11-04 thomas .Dl Pq alias: Cm st
874 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
875 6bad629b 2019-02-04 stsp using the following status codes:
876 6bad629b 2019-02-04 stsp .Bl -column YXZ description
877 6bad629b 2019-02-04 stsp .It M Ta modified file
878 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
879 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
880 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
881 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
882 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
883 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
885 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
886 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
888 2a06fe5f 2019-08-24 stsp specified on the command line
893 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
894 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
896 4ed9f614 2019-08-04 stsp If changes have been staged with
897 4ed9f614 2019-08-04 stsp .Cm got stage ,
898 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
899 4ed9f614 2019-08-04 stsp status codes:
900 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
901 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
902 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
903 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
906 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
907 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
908 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
909 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
912 cd634f2d 2024-03-30 thomas If the work tree contains the results of an interrupted
913 cd634f2d 2024-03-30 thomas .Cm got rebase ,
914 e2e46a52 2024-03-30 thomas .Cm got histedit ,
916 cd634f2d 2024-03-30 thomas .Cm got merge
917 cd634f2d 2024-03-30 thomas operation then display a message which shows the branches involved.
919 081470ac 2020-08-13 stsp The options for
920 081470ac 2020-08-13 stsp .Cm got status
921 081470ac 2020-08-13 stsp are as follows:
922 081470ac 2020-08-13 stsp .Bl -tag -width Ds
924 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
925 00357e4d 2021-09-14 tracey .It Fl S Ar status-codes
926 00357e4d 2021-09-14 tracey Suppress the output of files with a modification status matching any of the
927 00357e4d 2021-09-14 tracey single-character status codes contained in the
928 00357e4d 2021-09-14 tracey .Ar status-codes
929 00357e4d 2021-09-14 tracey argument.
930 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
931 00357e4d 2021-09-14 tracey may be specified.
932 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
933 b043307b 2021-09-14 stsp Cannot be used together with the
936 d6506a3d 2022-08-16 thomas .It Fl s Ar status-codes
937 d6506a3d 2022-08-16 thomas Only show files with a modification status matching any of the
938 d6506a3d 2022-08-16 thomas single-character status codes contained in the
939 d6506a3d 2022-08-16 thomas .Ar status-codes
940 d6506a3d 2022-08-16 thomas argument.
941 d6506a3d 2022-08-16 thomas Any combination of codes from the above list of possible status codes
942 d6506a3d 2022-08-16 thomas may be specified.
943 d6506a3d 2022-08-16 thomas For staged files, status codes displayed in either column will be matched.
944 d6506a3d 2022-08-16 thomas Cannot be used together with the
949 6841da00 2019-08-08 stsp For compatibility with
952 bd8de430 2019-10-04 stsp .Xr git 1 ,
953 6841da00 2019-08-08 stsp .Cm got status
956 bd8de430 2019-10-04 stsp patterns from
957 6841da00 2019-08-08 stsp .Pa .cvsignore
959 bd8de430 2019-10-04 stsp .Pa .gitignore
960 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
961 bd8de430 2019-10-04 stsp which match these patterns.
962 1b5d300f 2023-02-20 thomas Ignore patterns which end with a slash,
964 1b5d300f 2023-02-20 thomas will only match directories.
965 bd8de430 2019-10-04 stsp As an extension to
967 bd8de430 2019-10-04 stsp matching rules,
968 bd8de430 2019-10-04 stsp .Cm got status
969 bd8de430 2019-10-04 stsp supports consecutive asterisks,
971 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
973 6841da00 2019-08-08 stsp .Xr cvs 1 ,
974 6841da00 2019-08-08 stsp .Cm got status
975 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
977 bd8de430 2019-10-04 stsp .Xr git 1 ,
978 bd8de430 2019-10-04 stsp .Cm got status
979 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
981 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
983 bd8de430 2019-10-04 stsp in a pattern.
986 e6fdf1dd 2024-03-30 thomas .Op Fl bdPpRst
987 56c96eff 2022-08-30 thomas .Op Fl C Ar number
988 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
989 56c96eff 2022-08-30 thomas .Op Fl l Ar N
990 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
991 56c96eff 2022-08-30 thomas .Op Fl S Ar search-pattern
992 56c96eff 2022-08-30 thomas .Op Fl x Ar commit
993 56c96eff 2022-08-30 thomas .Op Ar path
995 38e11793 2018-06-13 stsp Display history of a repository.
998 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
999 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
1001 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
1002 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
1003 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
1005 38e11793 2018-06-13 stsp The options for
1006 38e11793 2018-06-13 stsp .Cm got log
1007 38e11793 2018-06-13 stsp are as follows:
1008 38e11793 2018-06-13 stsp .Bl -tag -width Ds
1010 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
1011 1137e0ae 2020-01-27 stsp from other branches.
1012 48c8c60d 2020-01-27 stsp By default,
1013 48c8c60d 2020-01-27 stsp .Cm got log
1014 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
1015 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
1016 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
1018 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
1019 d6506a3d 2022-08-16 thomas .It Fl c Ar commit
1020 d6506a3d 2022-08-16 thomas Start traversing history at the specified
1021 d6506a3d 2022-08-16 thomas .Ar commit .
1022 482b0b83 2023-07-19 thomas If this option is not specified, default to the work tree's current branch
1023 482b0b83 2023-07-19 thomas if invoked in a work tree, or to the repository's HEAD reference.
1025 482b0b83 2023-07-19 thomas The expected
1026 482b0b83 2023-07-19 thomas .Ar commit
1027 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1028 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1029 d6506a3d 2022-08-16 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1030 d6506a3d 2022-08-16 thomas automatically, provided the abbreviation is unique.
1031 a290e4b4 2023-07-19 thomas The keywords
1032 9139e004 2023-07-17 thomas .Qq :base
1034 9139e004 2023-07-17 thomas .Qq :head
1035 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1036 9139e004 2023-07-17 thomas The former is only valid if invoked in a work tree, while the latter will
1037 9139e004 2023-07-17 thomas resolve to the tip of the work tree's current branch if invoked in a
1038 9139e004 2023-07-17 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1039 9139e004 2023-07-17 thomas Keywords and references may be appended with
1043 9139e004 2023-07-17 thomas modifiers and an optional integer N to denote the
1044 9139e004 2023-07-17 thomas Nth descendant or antecedent, respectively, by first parent traversal;
1045 9139e004 2023-07-17 thomas for example,
1046 9139e004 2023-07-17 thomas .Sy :head:-2
1047 9139e004 2023-07-17 thomas denotes the HEAD reference's 2nd generation ancestor, and
1048 9139e004 2023-07-17 thomas .Sy :base:+4
1049 9139e004 2023-07-17 thomas denotes the 4th generation descendant of the work tree's base commit.
1050 9139e004 2023-07-17 thomas Similarly,
1051 9139e004 2023-07-17 thomas .Sy bar:+3
1052 9139e004 2023-07-17 thomas will denote the 3rd generation descendant of the commit resolved by the
1054 9139e004 2023-07-17 thomas reference.
1059 9139e004 2023-07-17 thomas modifier without a trailing integer has an implicit
1061 9139e004 2023-07-17 thomas appended
1062 9139e004 2023-07-17 thomas .Po e.g.,
1063 9139e004 2023-07-17 thomas .Sy :base:+
1064 9139e004 2023-07-17 thomas is equivalent to
1065 9139e004 2023-07-17 thomas .Sy :base:+1
1067 772fcad5 2023-01-07 thomas .It Fl d
1068 be97ab03 2023-01-19 thomas Display diffstat of changes introduced in each commit.
1069 772fcad5 2023-01-07 thomas Cannot be used with the
1072 ba133bf3 2023-08-12 thomas Implies the
1074 ba133bf3 2023-08-12 thomas option (diffstat displays a list of changed paths).
1075 6238ee32 2018-06-13 stsp .It Fl l Ar N
1076 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
1077 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
1078 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
1080 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
1081 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
1082 d6506a3d 2022-08-16 thomas .It Fl P
1083 d6506a3d 2022-08-16 thomas Display the list of file paths changed in each commit, using the following
1084 d6506a3d 2022-08-16 thomas status codes:
1085 d6506a3d 2022-08-16 thomas .Bl -column YXZ description
1086 d6506a3d 2022-08-16 thomas .It M Ta modified file
1087 d6506a3d 2022-08-16 thomas .It D Ta file was deleted
1088 d6506a3d 2022-08-16 thomas .It A Ta new file was added
1089 d6506a3d 2022-08-16 thomas .It m Ta modified file modes (executable bit only)
1092 d6506a3d 2022-08-16 thomas Cannot be used with the
1096 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
1099 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
1100 2f7ada20 2022-06-13 thomas Cannot be used with the
1103 d6506a3d 2022-08-16 thomas .It Fl R
1104 d6506a3d 2022-08-16 thomas Determine a set of commits to display as usual, but display these commits
1105 d6506a3d 2022-08-16 thomas in reverse order.
1106 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1107 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1108 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1109 d6506a3d 2022-08-16 thomas working directory.
1110 d6506a3d 2022-08-16 thomas If this directory is a
1112 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1113 2f7ada20 2022-06-13 thomas .It Fl S Ar search-pattern
1114 4fe9456b 2022-06-13 thomas If specified, show only commits with a log message, author name,
1115 4fe9456b 2022-06-13 thomas committer name, or ID SHA1 hash matched by the extended regular
1116 4fe9456b 2022-06-13 thomas expression
1117 6841bf13 2019-11-29 kn .Ar search-pattern .
1118 314444e4 2022-06-13 thomas Lines in committed patches will be matched if
1120 314444e4 2022-06-13 thomas is specified.
1121 314444e4 2022-06-13 thomas File paths changed by a commit will be matched if
1123 314444e4 2022-06-13 thomas is specified.
1124 6841bf13 2019-11-29 kn Regular expression syntax is documented in
1125 6841bf13 2019-11-29 kn .Xr re_format 7 .
1126 d6506a3d 2022-08-16 thomas .It Fl s
1127 d6506a3d 2022-08-16 thomas Display a short one-line summary of each commit, instead of the default
1128 d6506a3d 2022-08-16 thomas history format.
1129 d6506a3d 2022-08-16 thomas Cannot be used together with the
1134 e6fdf1dd 2024-03-30 thomas .It Fl t
1135 e6fdf1dd 2024-03-30 thomas Display commits in topological order.
1136 e6fdf1dd 2024-03-30 thomas This option has no effect without the
1138 e6fdf1dd 2024-03-30 thomas option because a linear history is sorted in topological order by definition.
1139 e6fdf1dd 2024-03-30 thomas Topological sorting is disabled by default because the present implementation
1140 e6fdf1dd 2024-03-30 thomas requires that commit history is fully traversed before any output can be shown.
1141 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
1142 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
1143 d1fe46f9 2020-04-18 stsp .Ar commit
1144 52ab7958 2020-04-18 stsp has been traversed.
1147 ef153826 2023-08-08 thomas the expected
1148 ef153826 2023-08-08 thomas .Ar commit
1149 ef153826 2023-08-08 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1150 ef153826 2023-08-08 thomas which will be resolved to a commit ID.
1151 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
1152 d1fe46f9 2020-04-18 stsp .Ar commit
1153 d1fe46f9 2020-04-18 stsp is never traversed.
1157 56c96eff 2022-08-30 thomas .Cm diff
1158 53d03f97 2023-01-10 thomas .Op Fl adPsw
1159 56c96eff 2022-08-30 thomas .Op Fl C Ar number
1160 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1161 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1162 56c96eff 2022-08-30 thomas .Op Ar object1 Ar object2 | Ar path ...
1164 d912d125 2021-11-04 thomas .Dl Pq alias: Cm di
1165 30f6c0c6 2021-10-08 thomas When invoked within a work tree without any arguments, display all
1166 bd81cfb7 2020-04-19 stsp local changes in the work tree.
1167 30f6c0c6 2021-10-08 thomas If one or more
1169 30f6c0c6 2021-10-08 thomas arguments are specified, only show changes within the specified paths.
1171 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
1172 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
1173 d24820bf 2019-08-11 stsp corresponding objects.
1174 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
1175 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1176 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1177 30f6c0c6 2021-10-08 thomas If none of these interpretations produce a valid result or if the
1179 30f6c0c6 2021-10-08 thomas option is used,
1181 30f6c0c6 2021-10-08 thomas .Cm got diff
1182 30f6c0c6 2021-10-08 thomas is running in a work tree, attempt to interpret the two arguments as paths.
1184 c0cc5c62 2018-10-18 stsp The options for
1185 c0cc5c62 2018-10-18 stsp .Cm got diff
1186 c0cc5c62 2018-10-18 stsp are as follows:
1187 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
1189 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
1190 d6506a3d 2022-08-16 thomas .It Fl C Ar number
1191 d6506a3d 2022-08-16 thomas Set the number of context lines shown in the diff.
1192 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
1193 cc8021af 2021-10-12 thomas .It Fl c Ar commit
1194 cc8021af 2021-10-12 thomas Show differences between commits in the repository.
1195 d6506a3d 2022-08-16 thomas This option may be used up to two times.
1196 cc8021af 2021-10-12 thomas When used only once, show differences between the specified
1197 cc8021af 2021-10-12 thomas .Ar commit
1198 cc8021af 2021-10-12 thomas and its first parent commit.
1199 cc8021af 2021-10-12 thomas When used twice, show differences between the two specified commits.
1203 cc8021af 2021-10-12 thomas option is used, all non-option arguments will be interpreted as paths.
1204 cc8021af 2021-10-12 thomas If one or more such
1205 cc8021af 2021-10-12 thomas .Ar path
1206 cc8021af 2021-10-12 thomas arguments are provided, only show differences for the specified paths.
1208 482b0b83 2023-07-19 thomas The expected
1209 482b0b83 2023-07-19 thomas .Ar commit
1210 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
1211 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1212 482b0b83 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1213 482b0b83 2023-07-19 thomas automatically, provided the abbreviation is unique.
1214 a290e4b4 2023-07-19 thomas The keywords
1215 482b0b83 2023-07-19 thomas .Qq :base
1217 482b0b83 2023-07-19 thomas .Qq :head
1218 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1219 482b0b83 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1220 482b0b83 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1221 482b0b83 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1222 482b0b83 2023-07-19 thomas Keywords and references may be appended with
1226 482b0b83 2023-07-19 thomas modifiers and an optional integer N to denote the
1227 482b0b83 2023-07-19 thomas Nth descendant or antecedent, respectively, by first parent traversal;
1228 482b0b83 2023-07-19 thomas for example,
1229 482b0b83 2023-07-19 thomas .Sy :head:-2
1230 482b0b83 2023-07-19 thomas denotes the HEAD reference's 2nd generation ancestor, and
1231 482b0b83 2023-07-19 thomas .Sy :base:+4
1232 482b0b83 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1233 482b0b83 2023-07-19 thomas Similarly,
1234 482b0b83 2023-07-19 thomas .Sy baz:+8
1235 482b0b83 2023-07-19 thomas will denote the 8th generation descendant of the commit resolved by the
1237 482b0b83 2023-07-19 thomas reference.
1238 482b0b83 2023-07-19 thomas If an integer does not follow the
1242 482b0b83 2023-07-19 thomas modifier, a
1244 482b0b83 2023-07-19 thomas is implicitly appended
1245 482b0b83 2023-07-19 thomas .Po e.g.,
1246 482b0b83 2023-07-19 thomas .Sy :head:-
1247 482b0b83 2023-07-19 thomas is equivalent to
1248 482b0b83 2023-07-19 thomas .Sy :head:-1
1251 cc8021af 2021-10-12 thomas Cannot be used together with the
1254 53d03f97 2023-01-10 thomas .It Fl d
1255 53d03f97 2023-01-10 thomas Display diffstat of changes before the actual diff by annotating each file path
1256 53d03f97 2023-01-10 thomas or blob hash being diffed with the total number of lines added and removed.
1257 53d03f97 2023-01-10 thomas A summary line will display the total number of changes across all files.
1258 d6506a3d 2022-08-16 thomas .It Fl P
1259 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
1260 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
1261 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
1262 d6506a3d 2022-08-16 thomas This option is only valid when
1263 d6506a3d 2022-08-16 thomas .Cm got diff
1264 d6506a3d 2022-08-16 thomas is invoked in a work tree.
1265 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
1266 b72f483a 2019-02-05 stsp Use the repository at the specified path.
1267 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
1268 b72f483a 2019-02-05 stsp working directory.
1269 b72f483a 2019-02-05 stsp If this directory is a
1271 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1273 4ed9f614 2019-08-04 stsp Show changes staged with
1274 4ed9f614 2019-08-04 stsp .Cm got stage
1275 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
1276 4ed9f614 2019-08-04 stsp This option is only valid when
1277 4ed9f614 2019-08-04 stsp .Cm got diff
1278 4ed9f614 2019-08-04 stsp is invoked in a work tree.
1280 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
1284 56c96eff 2022-08-30 thomas .Cm blame
1285 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1286 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1287 56c96eff 2022-08-30 thomas .Ar path
1289 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bl
1290 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1292 1ff8e573 2018-08-02 stsp The options for
1293 1ff8e573 2018-08-02 stsp .Cm got blame
1294 1ff8e573 2018-08-02 stsp are as follows:
1295 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1296 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1297 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1298 1ff8e573 2018-08-02 stsp .Ar commit .
1299 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
1300 9f625d2d 2023-07-19 thomas or a keyword which will be resolved to a commit ID.
1301 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1302 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1303 9f625d2d 2023-07-19 thomas The keywords
1304 3795e2b6 2023-07-19 thomas .Qq :base
1306 3795e2b6 2023-07-19 thomas .Qq :head
1307 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1308 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1309 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1310 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1311 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1315 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1316 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1317 3795e2b6 2023-07-19 thomas for example,
1318 3795e2b6 2023-07-19 thomas .Sy :head:-2
1319 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1320 3795e2b6 2023-07-19 thomas .Sy :base:+4
1321 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1322 3795e2b6 2023-07-19 thomas Similarly,
1323 3795e2b6 2023-07-19 thomas .Sy xyz:-5
1324 3795e2b6 2023-07-19 thomas will denote the 5th generation ancestor of the commit resolved by the
1326 3795e2b6 2023-07-19 thomas reference.
1331 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1333 3795e2b6 2023-07-19 thomas appended
1334 3795e2b6 2023-07-19 thomas .Po e.g.,
1335 3795e2b6 2023-07-19 thomas .Sy :base:+
1336 3795e2b6 2023-07-19 thomas is equivalent to
1337 3795e2b6 2023-07-19 thomas .Sy :base:+1
1339 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1340 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1341 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1342 1ff8e573 2018-08-02 stsp working directory.
1343 0c06baac 2019-02-05 stsp If this directory is a
1345 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1349 56c96eff 2022-08-30 thomas .Cm tree
1350 56c96eff 2022-08-30 thomas .Op Fl iR
1351 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1352 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1353 56c96eff 2022-08-30 thomas .Op Ar path
1355 d912d125 2021-11-04 thomas .Dl Pq alias: Cm tr
1356 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1357 5de5890b 2018-10-18 stsp directory path in the repository.
1358 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1359 db0c2996 2019-02-10 stsp annotations:
1360 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1361 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1362 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1363 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1364 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1367 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1371 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1372 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1373 0c849583 2019-02-05 stsp if there is no work tree.
1375 5de5890b 2018-10-18 stsp The options for
1376 5de5890b 2018-10-18 stsp .Cm got tree
1377 5de5890b 2018-10-18 stsp are as follows:
1378 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1379 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1380 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1381 5de5890b 2018-10-18 stsp .Ar commit .
1383 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
1384 9f625d2d 2023-07-19 thomas or a keyword which will be resolved to a commit ID.
1385 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1386 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1387 9f625d2d 2023-07-19 thomas The keywords
1388 3795e2b6 2023-07-19 thomas .Qq :base
1390 3795e2b6 2023-07-19 thomas .Qq :head
1391 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1392 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1393 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1394 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1395 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1399 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1400 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1401 3795e2b6 2023-07-19 thomas for example,
1402 3795e2b6 2023-07-19 thomas .Sy :head:-2
1403 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1404 3795e2b6 2023-07-19 thomas .Sy :base:+4
1405 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1406 3795e2b6 2023-07-19 thomas Similarly,
1407 3795e2b6 2023-07-19 thomas .Sy spam:-3
1408 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1409 3795e2b6 2023-07-19 thomas .Qq spam
1410 3795e2b6 2023-07-19 thomas reference.
1415 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1417 3795e2b6 2023-07-19 thomas appended
1418 3795e2b6 2023-07-19 thomas .Po e.g.,
1419 3795e2b6 2023-07-19 thomas .Sy :base:+
1420 3795e2b6 2023-07-19 thomas is equivalent to
1421 3795e2b6 2023-07-19 thomas .Sy :base:+1
1424 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
1426 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
1427 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1428 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1429 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1430 d6506a3d 2022-08-16 thomas working directory.
1431 d6506a3d 2022-08-16 thomas If this directory is a
1433 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1437 56c96eff 2022-08-30 thomas .Op Fl dlt
1438 b6b86fd1 2022-08-30 thomas .Op Fl c Ar object
1439 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1440 56c96eff 2022-08-30 thomas .Op Fl s Ar reference
1441 56c96eff 2022-08-30 thomas .Op Ar name
1443 d0eebce4 2019-03-11 stsp Manage references in a repository.
1445 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1446 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1448 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1449 f16e4044 2019-10-09 stsp .Dq refs/ .
1451 d0eebce4 2019-03-11 stsp The options for
1452 d0eebce4 2019-03-11 stsp .Cm got ref
1453 d0eebce4 2019-03-11 stsp are as follows:
1454 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1455 e31abbf2 2020-03-22 stsp .It Fl c Ar object
1456 e31abbf2 2020-03-22 stsp Create a reference or change an existing reference.
1457 e31abbf2 2020-03-22 stsp The reference with the specified
1459 e31abbf2 2020-03-22 stsp will point at the specified
1460 1795b260 2021-04-02 kn .Ar object .
1462 e31abbf2 2020-03-22 stsp The expected
1463 e31abbf2 2020-03-22 stsp .Ar object
1464 3795e2b6 2023-07-19 thomas argument is an ID SHA1 hash or an existing reference or tag name
1465 3795e2b6 2023-07-19 thomas or a keyword which will be resolved to the ID of a corresponding commit,
1466 3795e2b6 2023-07-19 thomas tree, tag, or blob object.
1467 3795e2b6 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1468 3795e2b6 2023-07-19 thomas automatically, provided the abbreviation is unique.
1469 3795e2b6 2023-07-19 thomas The keywords
1470 3795e2b6 2023-07-19 thomas .Qq :base
1472 3795e2b6 2023-07-19 thomas .Qq :head
1473 3795e2b6 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1474 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1475 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1476 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1477 3795e2b6 2023-07-19 thomas Keywords and reference names may be appended with
1481 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1482 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1483 3795e2b6 2023-07-19 thomas for example,
1484 3795e2b6 2023-07-19 thomas .Sy :head:-2
1485 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1486 3795e2b6 2023-07-19 thomas .Sy tagged:-3
1487 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1488 3795e2b6 2023-07-19 thomas .Qq tagged
1489 3795e2b6 2023-07-19 thomas reference.
1490 3795e2b6 2023-07-19 thomas If an integer does not follow the
1494 3795e2b6 2023-07-19 thomas modifier, a
1496 3795e2b6 2023-07-19 thomas is implicitly appended
1497 3795e2b6 2023-07-19 thomas .Po e.g.,
1498 3795e2b6 2023-07-19 thomas .Sy :head:-
1499 3795e2b6 2023-07-19 thomas is equivalent to
1500 3795e2b6 2023-07-19 thomas .Sy :head:-1
1503 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1505 d6506a3d 2022-08-16 thomas .It Fl d
1506 d6506a3d 2022-08-16 thomas Delete the reference with the specified
1507 d6506a3d 2022-08-16 thomas .Ar name
1508 d6506a3d 2022-08-16 thomas from the repository.
1509 d6506a3d 2022-08-16 thomas Any commit, tree, tag, and blob objects belonging to deleted references
1510 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1511 d6506a3d 2022-08-16 thomas Git's garbage collector or
1512 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1513 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1515 d6506a3d 2022-08-16 thomas .It Fl l
1516 d6506a3d 2022-08-16 thomas List references in the repository.
1518 d6506a3d 2022-08-16 thomas .Ar name
1519 d6506a3d 2022-08-16 thomas is specified, list all existing references in the repository.
1521 d6506a3d 2022-08-16 thomas .Ar name
1522 d6506a3d 2022-08-16 thomas is a reference namespace, list all references in this namespace.
1523 d6506a3d 2022-08-16 thomas Otherwise, show only the reference with the given
1524 d6506a3d 2022-08-16 thomas .Ar name .
1525 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1529 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1530 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1531 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1532 d6506a3d 2022-08-16 thomas working directory.
1533 d6506a3d 2022-08-16 thomas If this directory is a
1535 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1536 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1537 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1538 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1540 e31abbf2 2020-03-22 stsp will point at the specified
1541 e31abbf2 2020-03-22 stsp .Ar reference
1542 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1543 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1544 d1c1ae5f 2019-08-12 stsp this option is used.
1545 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1547 d6506a3d 2022-08-16 thomas .It Fl t
1548 d6506a3d 2022-08-16 thomas Sort listed references by modification time (most recently modified first)
1549 d6506a3d 2022-08-16 thomas instead of sorting by lexicographical order.
1550 d6506a3d 2022-08-16 thomas Use of this option requires the
1552 d6506a3d 2022-08-16 thomas option to be used as well.
1556 56c96eff 2022-08-30 thomas .Cm branch
1557 56c96eff 2022-08-30 thomas .Op Fl lnt
1558 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1559 56c96eff 2022-08-30 thomas .Op Fl d Ar name
1560 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1561 56c96eff 2022-08-30 thomas .Op Ar name
1563 d912d125 2021-11-04 thomas .Dl Pq alias: Cm br
1564 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1566 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1567 4e759de4 2019-06-26 stsp .Dq refs/heads/
1568 4e759de4 2019-06-26 stsp reference namespace.
1570 4e759de4 2019-06-26 stsp .Cm got branch
1571 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1573 4b06140e 2022-03-22 thomas When deleting branches, the specified
1575 2f1457c6 2021-08-27 stsp is searched in the
1576 2f1457c6 2021-08-27 stsp .Dq refs/heads
1577 2f1457c6 2021-08-27 stsp reference namespace first.
1578 4b06140e 2022-03-22 thomas If no corresponding branch is found, the
1579 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1580 2f1457c6 2021-08-27 stsp namespace will be searched next.
1582 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1583 ad89fa31 2019-10-04 stsp work tree's current branch.
1587 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1588 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1589 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1590 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1592 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1593 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1594 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1595 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1597 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1598 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1599 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1600 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1601 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1602 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1603 da76fce2 2020-02-24 stsp .It A Ta new file was added
1604 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1605 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1608 a74f7e83 2019-11-10 stsp The options for
1609 a74f7e83 2019-11-10 stsp .Cm got branch
1610 a74f7e83 2019-11-10 stsp are as follows:
1611 a74f7e83 2019-11-10 stsp .Bl -tag -width Ds
1612 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1613 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1614 a4f89d48 2019-08-25 stsp .Ar commit .
1615 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1616 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
1617 a290e4b4 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
1618 a290e4b4 2023-07-19 thomas automatically, provided the abbreviation is unique.
1619 a290e4b4 2023-07-19 thomas The keywords
1620 fb885120 2023-07-19 thomas .Qq :base
1622 fb885120 2023-07-19 thomas .Qq :head
1623 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1624 fb885120 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1625 fb885120 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1626 fb885120 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1627 fb885120 2023-07-19 thomas Keywords and references may be appended with
1631 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
1632 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1633 fb885120 2023-07-19 thomas for example,
1634 fb885120 2023-07-19 thomas .Sy :head:-2
1635 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1636 fb885120 2023-07-19 thomas .Sy :base:+4
1637 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1638 fb885120 2023-07-19 thomas Similarly,
1639 fb885120 2023-07-19 thomas .Sy foobar:+3
1640 fb885120 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
1641 fb885120 2023-07-19 thomas .Qq foobar
1642 fb885120 2023-07-19 thomas reference.
1647 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
1649 fb885120 2023-07-19 thomas appended
1650 fb885120 2023-07-19 thomas .Po e.g.,
1651 fb885120 2023-07-19 thomas .Sy :base:+
1652 fb885120 2023-07-19 thomas is equivalent to
1653 fb885120 2023-07-19 thomas .Sy :base:+1
1655 d6506a3d 2022-08-16 thomas .It Fl d Ar name
1656 d6506a3d 2022-08-16 thomas Delete the branch with the specified
1657 d6506a3d 2022-08-16 thomas .Ar name
1658 d6506a3d 2022-08-16 thomas from the
1659 d6506a3d 2022-08-16 thomas .Dq refs/heads
1661 d6506a3d 2022-08-16 thomas .Dq refs/remotes
1662 d6506a3d 2022-08-16 thomas reference namespace.
1664 d6506a3d 2022-08-16 thomas Only the branch reference is deleted.
1665 d6506a3d 2022-08-16 thomas Any commit, tree, and blob objects belonging to the branch
1666 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1667 d6506a3d 2022-08-16 thomas Git's garbage collector or
1668 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1670 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1671 34d4e04c 2021-02-08 stsp repositories' branches in the
1672 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1673 34d4e04c 2021-02-08 stsp reference namespace.
1675 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1676 87c986b7 2023-07-05 thomas with one of the following annotations:
1677 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1678 44d79efa 2023-07-23 thomas .It * Ta work tree's base commit and the base commit of all tracked files
1679 44d79efa 2023-07-23 thomas matches the branch tip
1680 44d79efa 2023-07-23 thomas .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1682 d6506a3d 2022-08-16 thomas .It Fl n
1683 d6506a3d 2022-08-16 thomas Do not switch and update the work tree after creating a new branch.
1684 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1685 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1686 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1687 d6506a3d 2022-08-16 thomas working directory.
1688 d6506a3d 2022-08-16 thomas If this directory is a
1690 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1691 a0b48eaf 2021-11-20 thomas .It Fl t
1692 a0b48eaf 2021-11-20 thomas Sort listed branches by modification time (most recently modified first)
1693 a0b48eaf 2021-11-20 thomas instead of sorting by lexicographical order.
1694 a0b48eaf 2021-11-20 thomas Branches in the
1695 a0b48eaf 2021-11-20 thomas .Dq refs/heads/
1696 a0b48eaf 2021-11-20 thomas reference namespace are listed before branches in
1697 a0b48eaf 2021-11-20 thomas .Dq refs/remotes/
1698 a0b48eaf 2021-11-20 thomas regardless.
1699 a0b48eaf 2021-11-20 thomas Use of this option requires the
1701 a0b48eaf 2021-11-20 thomas option to be used as well.
1705 56c96eff 2022-08-30 thomas .Op Fl lVv
1706 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1707 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1708 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1709 56c96eff 2022-08-30 thomas .Op Fl s Ar signer-id
1710 56c96eff 2022-08-30 thomas .Ar name
1712 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1714 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1715 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1716 8e7bd50a 2019-08-22 stsp reference namespace.
1718 8e7bd50a 2019-08-22 stsp .Cm got tag
1719 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1720 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1721 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1723 80106605 2020-02-24 stsp Attempt to create a tag with the given
1724 8e7bd50a 2019-08-22 stsp .Ar name ,
1725 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1726 8e7bd50a 2019-08-22 stsp .Ar commit .
1727 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1728 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1729 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1731 8e7bd50a 2019-08-22 stsp The options for
1732 8e7bd50a 2019-08-22 stsp .Cm got tag
1733 8e7bd50a 2019-08-22 stsp are as follows:
1734 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1735 80106605 2020-02-24 stsp .It Fl c Ar commit
1736 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1737 80106605 2020-02-24 stsp .Ar commit .
1738 80106605 2020-02-24 stsp The expected
1739 80106605 2020-02-24 stsp .Ar commit
1740 9f625d2d 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference or keyword
1741 9f625d2d 2023-07-19 thomas which will be resolved to a commit ID.
1742 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1743 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1744 9f625d2d 2023-07-19 thomas The keywords
1745 3795e2b6 2023-07-19 thomas .Qq :base
1747 3795e2b6 2023-07-19 thomas .Qq :head
1748 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
1749 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
1750 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
1751 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
1752 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
1756 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
1757 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
1758 3795e2b6 2023-07-19 thomas for example,
1759 3795e2b6 2023-07-19 thomas .Sy :head:-2
1760 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
1761 3795e2b6 2023-07-19 thomas .Sy :base:+4
1762 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
1763 3795e2b6 2023-07-19 thomas Similarly,
1764 3795e2b6 2023-07-19 thomas .Sy eggs:-3
1765 3795e2b6 2023-07-19 thomas will denote the 3rd generation ancestor of the commit resolved by the
1766 3795e2b6 2023-07-19 thomas .Qq eggs
1767 3795e2b6 2023-07-19 thomas reference.
1772 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
1774 3795e2b6 2023-07-19 thomas appended
1775 3795e2b6 2023-07-19 thomas .Po e.g.,
1776 3795e2b6 2023-07-19 thomas .Sy :base:+
1777 3795e2b6 2023-07-19 thomas is equivalent to
1778 3795e2b6 2023-07-19 thomas .Sy :base:+1
1781 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
1783 68e8cedb 2022-07-01 thomas .Ar name
1784 68e8cedb 2022-07-01 thomas argument is passed, show only the tag with the given
1785 68e8cedb 2022-07-01 thomas .Ar name .
1786 d6506a3d 2022-08-16 thomas .It Fl m Ar message
1787 d6506a3d 2022-08-16 thomas Use the specified tag message when creating the new tag.
1788 d6506a3d 2022-08-16 thomas Without the
1791 d6506a3d 2022-08-16 thomas .Cm got tag
1792 d6506a3d 2022-08-16 thomas opens a temporary file in an editor where a tag message can be written.
1793 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the tag operation.
1794 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1795 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1796 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1797 d6506a3d 2022-08-16 thomas working directory.
1798 d6506a3d 2022-08-16 thomas If this directory is a
1800 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1801 839dd04f 2022-07-04 thomas .It Fl s Ar signer-id
1802 839dd04f 2022-07-04 thomas While creating a new tag, sign this tag with the identity given in
1803 839dd04f 2022-07-04 thomas .Ar signer-id .
1805 839dd04f 2022-07-04 thomas For SSH-based signatures,
1806 839dd04f 2022-07-04 thomas .Ar signer-id
1807 839dd04f 2022-07-04 thomas is the path to a file which may refer to either a private SSH key,
1808 839dd04f 2022-07-04 thomas or a public SSH key with the private half available via
1809 839dd04f 2022-07-04 thomas .Xr ssh-agent 1 .
1810 839dd04f 2022-07-04 thomas .Cm got tag
1811 839dd04f 2022-07-04 thomas will sign the tag object by invoking
1812 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1813 839dd04f 2022-07-04 thomas with the
1814 b6bfeb85 2022-08-16 thomas .Fl Y Cm sign
1815 839dd04f 2022-07-04 thomas command, using the signature namespace
1817 839dd04f 2022-07-04 thomas for compatibility with
1818 839dd04f 2022-07-04 thomas .Xr git 1 .
1819 839dd04f 2022-07-04 thomas .It Fl V
1820 839dd04f 2022-07-04 thomas Verify tag object signatures.
1822 839dd04f 2022-07-04 thomas .Ar name
1823 839dd04f 2022-07-04 thomas is specified, show and verify the tag object with the provided name.
1824 839dd04f 2022-07-04 thomas Otherwise, list all tag objects and verify signatures where present.
1826 839dd04f 2022-07-04 thomas .Cm got tag
1827 839dd04f 2022-07-04 thomas verifies SSH-based signatures by invoking
1828 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1829 839dd04f 2022-07-04 thomas with the options
1830 b6bfeb85 2022-08-16 thomas .Fl Y Cm verify Fl f Ar allowed_signers .
1831 839dd04f 2022-07-04 thomas A path to the
1832 839dd04f 2022-07-04 thomas .Ar allowed_signers
1833 839dd04f 2022-07-04 thomas file must be set in
1834 839dd04f 2022-07-04 thomas .Xr got.conf 5 ,
1835 839dd04f 2022-07-04 thomas otherwise verification is impossible.
1836 d6506a3d 2022-08-16 thomas .It Fl v
1837 d6506a3d 2022-08-16 thomas Verbose mode.
1838 d6506a3d 2022-08-16 thomas During SSH signature creation and verification this option will be passed to
1839 d6506a3d 2022-08-16 thomas .Xr ssh-keygen 1 .
1840 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
1841 d6506a3d 2022-08-16 thomas The maximum is 3.
1844 8e7bd50a 2019-08-22 stsp By design, the
1845 8e7bd50a 2019-08-22 stsp .Cm got tag
1846 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1847 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1848 8e7bd50a 2019-08-22 stsp .Cm got ref
1849 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1850 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1851 8e7bd50a 2019-08-22 stsp another repository.
1854 56c96eff 2022-08-30 thomas .Op Fl IR
1855 56c96eff 2022-08-30 thomas .Ar path ...
1857 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1858 d00136be 2019-03-26 stsp repository in the next commit.
1859 ff56836b 2021-07-08 stsp By default, files which match a
1860 ff56836b 2021-07-08 stsp .Cm got status
1861 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1864 b21ebdb0 2023-06-22 thomas .Ar path
1865 b21ebdb0 2023-06-22 thomas mentioned in the command line is not an unversioned file then
1866 b21ebdb0 2023-06-22 thomas .Cm got add
1867 b21ebdb0 2023-06-22 thomas may raise an error.
1868 b21ebdb0 2023-06-22 thomas To avoid unnecessary errors from paths picked up by file globbing patterns
1869 b21ebdb0 2023-06-22 thomas in the shell, paths in the argument list will be silently ignored if they
1870 b21ebdb0 2023-06-22 thomas are not reported by
1871 b21ebdb0 2023-06-22 thomas .Cm got status
1872 b21ebdb0 2023-06-22 thomas at all, or if they are reported with one of the following status codes
1873 b21ebdb0 2023-06-22 thomas and do not have changes staged via
1874 b21ebdb0 2023-06-22 thomas .Cm got stage :
1875 b21ebdb0 2023-06-22 thomas .Bl -column YXZ description
1876 b21ebdb0 2023-06-22 thomas .It M Ta modified file
1877 b21ebdb0 2023-06-22 thomas .It A Ta file scheduled for addition in next commit
1878 b21ebdb0 2023-06-22 thomas .It C Ta modified or added file which contains merge conflicts
1879 b21ebdb0 2023-06-22 thomas .It m Ta modified file modes (executable bit only)
1882 4e68cba3 2019-11-23 stsp The options for
1883 4e68cba3 2019-11-23 stsp .Cm got add
1884 4e68cba3 2019-11-23 stsp are as follows:
1885 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1886 022fae89 2019-12-06 tracey .It Fl I
1887 ff56836b 2021-07-08 stsp Add files even if they match a
1888 022fae89 2019-12-06 tracey .Cm got status
1889 022fae89 2019-12-06 tracey ignore pattern.
1890 d6506a3d 2022-08-16 thomas .It Fl R
1891 d6506a3d 2022-08-16 thomas Permit recursion into directories.
1892 d6506a3d 2022-08-16 thomas If this option is not specified,
1893 d6506a3d 2022-08-16 thomas .Cm got add
1894 d6506a3d 2022-08-16 thomas will refuse to run if a specified
1895 d6506a3d 2022-08-16 thomas .Ar path
1896 d6506a3d 2022-08-16 thomas is a directory.
1900 56c96eff 2022-08-30 thomas .Cm remove
1901 56c96eff 2022-08-30 thomas .Op Fl fkR
1902 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
1903 56c96eff 2022-08-30 thomas .Ar path ...
1905 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rm
1906 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1907 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1909 2ec1f75b 2019-03-26 stsp The options for
1910 86d25a1b 2019-07-11 stsp .Cm got remove
1911 2ec1f75b 2019-03-26 stsp are as follows:
1912 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1914 d64cc78a 2022-01-25 thomas Perform the operation even if a file contains local modifications,
1915 d64cc78a 2022-01-25 thomas and do not raise an error if a specified
1916 d64cc78a 2022-01-25 thomas .Ar path
1917 d64cc78a 2022-01-25 thomas does not exist on disk.
1918 70e3e7f5 2019-12-13 tracey .It Fl k
1919 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1920 f2a9dc41 2019-12-13 tracey .It Fl R
1921 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1922 f2a9dc41 2019-12-13 tracey If this option is not specified,
1923 f2a9dc41 2019-12-13 tracey .Cm got remove
1924 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1925 f2a9dc41 2019-12-13 tracey .Ar path
1926 f2a9dc41 2019-12-13 tracey is a directory.
1927 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1928 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1929 766841c2 2020-08-13 stsp single-character status codes contained in the
1930 766841c2 2020-08-13 stsp .Ar status-codes
1932 766841c2 2020-08-13 stsp The following status codes may be specified:
1933 766841c2 2020-08-13 stsp .Bl -column YXZ description
1934 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1937 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1942 56c96eff 2022-08-30 thomas .Cm patch
1943 56c96eff 2022-08-30 thomas .Op Fl nR
1944 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1945 56c96eff 2022-08-30 thomas .Op Fl p Ar strip-count
1946 56c96eff 2022-08-30 thomas .Op Ar patchfile
1948 069bbb86 2022-03-07 thomas .Dl Pq alias: Cm pa
1949 069bbb86 2022-03-07 thomas Apply changes from
1950 069bbb86 2022-03-07 thomas .Ar patchfile
1951 07f74738 2022-03-13 thomas to files in a work tree.
1952 443c08c9 2022-03-13 thomas Files added or removed by a patch will be scheduled for addition or removal in
1953 443c08c9 2022-03-13 thomas the work tree.
1955 07f74738 2022-03-13 thomas The patch must be in the unified diff format as produced by
1956 07f74738 2022-03-13 thomas .Cm got diff ,
1957 99e34129 2022-03-22 thomas .Xr git-diff 1 ,
1959 07f74738 2022-03-13 thomas .Xr diff 1
1961 3eb4f629 2022-03-22 thomas .Xr cvs 1
1962 6f7394ad 2022-03-22 thomas diff when invoked with their
1964 6f7394ad 2022-03-22 thomas options.
1966 069bbb86 2022-03-07 thomas .Ar patchfile
1967 07f74738 2022-03-13 thomas argument is provided, read unified diff data from standard input instead.
1970 07f74738 2022-03-13 thomas .Ar patchfile
1971 4b06140e 2022-03-22 thomas contains multiple patches, then attempt to apply each of them in sequence.
1973 4929098b 2022-03-13 thomas Show the status of each affected file, using the following status codes:
1974 069bbb86 2022-03-07 thomas .Bl -column XYZ description
1975 07f74738 2022-03-13 thomas .It M Ta file was modified
1976 762b8e82 2022-06-23 thomas .It G Ta file was merged using a merge-base found in the repository
1977 762b8e82 2022-06-23 thomas .It C Ta file was merged and conflicts occurred during merge
1978 07f74738 2022-03-13 thomas .It D Ta file was deleted
1979 07f74738 2022-03-13 thomas .It A Ta file was added
1980 49114f01 2022-03-22 thomas .It # Ta failed to patch the file
1983 07f74738 2022-03-13 thomas If a change does not match at its exact line number, attempt to
1984 4929098b 2022-03-13 thomas apply it somewhere else in the file if a good spot can be found.
1985 4929098b 2022-03-13 thomas Otherwise, the patch will fail to apply.
1988 2cfc25ac 2022-03-13 thomas .Cm patch
1989 2cfc25ac 2022-03-13 thomas will refuse to apply a patch if certain preconditions are not met.
1990 4929098b 2022-03-13 thomas Files to be deleted must already be under version control, and must
1991 4929098b 2022-03-13 thomas not have been scheduled for deletion already.
1992 4929098b 2022-03-13 thomas Files to be added must not yet be under version control and must not
1993 4929098b 2022-03-13 thomas already be present on disk.
1994 4929098b 2022-03-13 thomas Files to be modified must already be under version control and may not
1995 4929098b 2022-03-13 thomas contain conflict markers.
1997 2cfc25ac 2022-03-13 thomas If an error occurs, the
1998 2cfc25ac 2022-03-13 thomas .Cm patch
1999 2cfc25ac 2022-03-13 thomas operation will be aborted.
2000 2cfc25ac 2022-03-13 thomas Any changes made to the work tree up to this point will be left behind.
2001 07f74738 2022-03-13 thomas Such changes can be viewed with
2002 2cfc25ac 2022-03-13 thomas .Cm got diff
2003 2cfc25ac 2022-03-13 thomas and can be reverted with
2004 2cfc25ac 2022-03-13 thomas .Cm got revert
2005 2cfc25ac 2022-03-13 thomas if needed.
2007 bfc91212 2022-03-13 thomas The options for
2008 bfc91212 2022-03-13 thomas .Cm got patch
2009 bfc91212 2022-03-13 thomas are as follows:
2010 bfc91212 2022-03-13 thomas .Bl -tag -width Ds
2011 7d8bcb99 2022-07-28 thomas .It Fl c Ar commit
2012 82a8b7ec 2022-08-06 thomas Attempt to locate files within the specified
2013 7d8bcb99 2022-07-28 thomas .Ar commit
2014 82a8b7ec 2022-08-06 thomas for use as a merge-base for 3-way merges.
2018 482b0b83 2023-07-19 thomas option is not used then
2019 482b0b83 2023-07-19 thomas .Cm got patch
2020 482b0b83 2023-07-19 thomas will attempt to locate merge-bases via object IDs found in
2021 482b0b83 2023-07-19 thomas .Ar patchfile
2022 482b0b83 2023-07-19 thomas meta-data, such as produced by
2023 482b0b83 2023-07-19 thomas .Cm got diff
2025 482b0b83 2023-07-19 thomas .Xr git-diff 1 .
2026 482b0b83 2023-07-19 thomas Use of the
2028 482b0b83 2023-07-19 thomas option is only recommended in the absence of such meta-data.
2030 82a8b7ec 2022-08-06 thomas Ideally, the specified
2031 82a8b7ec 2022-08-06 thomas .Ar commit
2032 82a8b7ec 2022-08-06 thomas should contain versions of files which the changes contained in the
2033 7d8bcb99 2022-07-28 thomas .Ar patchfile
2034 82a8b7ec 2022-08-06 thomas were based on.
2035 82a8b7ec 2022-08-06 thomas Files will be located by path, relative to the repository root.
2038 82a8b7ec 2022-08-06 thomas option is used then leading path components will be stripped
2039 82a8b7ec 2022-08-06 thomas before paths are looked up in the repository.
2041 82a8b7ec 2022-08-06 thomas In case no merge-base is available for a file, changes will be applied
2042 82a8b7ec 2022-08-06 thomas without doing a 3-way merge.
2043 82a8b7ec 2022-08-06 thomas Changes which do not apply cleanly may then be rejected entirely, rather
2044 82a8b7ec 2022-08-06 thomas than producing merge conflicts in the patched target file.
2046 482b0b83 2023-07-19 thomas The expected
2047 482b0b83 2023-07-19 thomas .Ar commit
2048 a290e4b4 2023-07-19 thomas argument is a commit ID SHA1 hash, or a reference name or a keyword
2049 a290e4b4 2023-07-19 thomas which will be resolved to a commit ID.
2050 482b0b83 2023-07-19 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
2051 482b0b83 2023-07-19 thomas automatically, provided the abbreviation is unique.
2052 a290e4b4 2023-07-19 thomas The keywords
2053 482b0b83 2023-07-19 thomas .Qq :base
2055 482b0b83 2023-07-19 thomas .Qq :head
2056 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
2057 482b0b83 2023-07-19 thomas Keywords and references may be appended with
2061 482b0b83 2023-07-19 thomas modifiers and an optional integer N to denote the
2062 482b0b83 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
2063 482b0b83 2023-07-19 thomas for example,
2064 482b0b83 2023-07-19 thomas .Sy :head:-2
2065 482b0b83 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
2066 482b0b83 2023-07-19 thomas .Sy :base:+4
2067 482b0b83 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2068 482b0b83 2023-07-19 thomas Similarly,
2069 482b0b83 2023-07-19 thomas .Sy flan:+3
2070 482b0b83 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
2071 482b0b83 2023-07-19 thomas .Qq flan
2072 482b0b83 2023-07-19 thomas reference.
2077 482b0b83 2023-07-19 thomas modifier without a trailing integer has an implicit
2079 482b0b83 2023-07-19 thomas appended
2080 482b0b83 2023-07-19 thomas .Po e.g.,
2081 482b0b83 2023-07-19 thomas .Sy :base:+
2082 482b0b83 2023-07-19 thomas is equivalent to
2083 482b0b83 2023-07-19 thomas .Sy :base:+1
2085 bfc91212 2022-03-13 thomas .It Fl n
2086 bfc91212 2022-03-13 thomas Do not make any modifications to the work tree.
2087 bfc91212 2022-03-13 thomas This can be used to check whether a patch would apply without issues.
2089 bfc91212 2022-03-13 thomas .Ar patchfile
2090 4b06140e 2022-03-22 thomas contains diffs that affect the same file multiple times, the results
2091 bfc91212 2022-03-13 thomas displayed may be incorrect.
2092 d9db2ff9 2022-04-16 thomas .It Fl p Ar strip-count
2093 d9db2ff9 2022-04-16 thomas Specify the number of leading path components to strip from paths
2094 d9db2ff9 2022-04-16 thomas parsed from
2095 d9db2ff9 2022-04-16 thomas .Ar patchfile .
2098 d9db2ff9 2022-04-16 thomas option is not used,
2102 d9db2ff9 2022-04-16 thomas path prefixes generated by
2103 d9db2ff9 2022-04-16 thomas .Xr git-diff 1
2104 d9db2ff9 2022-04-16 thomas will be recognized and stripped automatically.
2105 eaef698f 2022-04-23 thomas .It Fl R
2106 eaef698f 2022-04-23 thomas Reverse the patch before applying it.
2110 56c96eff 2022-08-30 thomas .Cm revert
2111 56c96eff 2022-08-30 thomas .Op Fl pR
2112 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
2113 56c96eff 2022-08-30 thomas .Ar path ...
2115 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rv
2116 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
2117 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
2118 1dd86744 2019-08-12 anthony work tree's base commit.
2119 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
2120 a129376b 2019-03-28 stsp .Cm got revert !
2122 e20a8b6f 2019-06-04 stsp If a file was added with
2123 4b06140e 2022-03-22 thomas .Cm got add ,
2124 a129376b 2019-03-28 stsp it will become an unversioned file again.
2125 e20a8b6f 2019-06-04 stsp If a file was deleted with
2126 4b06140e 2022-03-22 thomas .Cm got remove ,
2127 a129376b 2019-03-28 stsp it will be restored.
2129 0f6d7415 2019-08-08 stsp The options for
2130 0f6d7415 2019-08-08 stsp .Cm got revert
2131 0f6d7415 2019-08-08 stsp are as follows:
2132 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
2133 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
2134 d6506a3d 2022-08-16 thomas With the
2136 d6506a3d 2022-08-16 thomas option, read
2141 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
2142 d6506a3d 2022-08-16 thomas .Ar response-script
2143 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
2145 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
2146 33aa809d 2019-08-08 stsp changes to revert based on
2148 33aa809d 2019-08-08 stsp (revert change),
2150 33aa809d 2019-08-08 stsp (keep change), and
2152 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
2153 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
2154 33aa809d 2019-08-08 stsp modified file content can be reverted.
2155 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
2157 0f6d7415 2019-08-08 stsp Permit recursion into directories.
2158 0f6d7415 2019-08-08 stsp If this option is not specified,
2159 0f6d7415 2019-08-08 stsp .Cm got revert
2160 0f6d7415 2019-08-08 stsp will refuse to run if a specified
2162 0f6d7415 2019-08-08 stsp is a directory.
2166 56c96eff 2022-08-30 thomas .Cm commit
2167 be94c032 2023-02-20 thomas .Op Fl CNnS
2168 56c96eff 2022-08-30 thomas .Op Fl A Ar author
2169 56c96eff 2022-08-30 thomas .Op Fl F Ar path
2170 56c96eff 2022-08-30 thomas .Op Fl m Ar message
2171 56c96eff 2022-08-30 thomas .Op Ar path ...
2173 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ci
2174 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
2175 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
2178 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
2179 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
2181 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
2182 1dd86744 2019-08-12 anthony .Cm got stage ,
2183 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
2184 4ed9f614 2019-08-04 stsp have not been staged.
2186 28cf319f 2021-01-28 stsp .Cm got commit
2187 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
2188 28cf319f 2021-01-28 stsp unless the
2190 28cf319f 2021-01-28 stsp option is used
2195 28cf319f 2021-01-28 stsp options are used together.
2196 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the commit operation.
2198 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
2199 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
2200 15cd91f7 2019-05-12 stsp .It M Ta modified file
2201 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
2202 15cd91f7 2019-05-12 stsp .It A Ta new file was added
2203 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
2206 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
2207 996d5ccd 2019-08-05 stsp recorded base commit.
2210 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
2211 15cd91f7 2019-05-12 stsp multiple base commits.
2212 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
2213 47ec7be7 2019-05-12 stsp .Cm got update
2214 47ec7be7 2019-05-12 stsp across the entire work tree.
2217 15cd91f7 2019-05-12 stsp .Cm got commit
2218 15cd91f7 2019-05-12 stsp command requires the
2219 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
2220 aba9c984 2019-09-08 stsp environment variable to be set,
2221 257add31 2020-09-09 stsp unless an author has been configured in
2222 257add31 2020-09-09 stsp .Xr got.conf 5
2224 aba9c984 2019-09-08 stsp .Dv user.name
2226 709ae9eb 2019-09-08 stsp .Dv user.email
2227 709ae9eb 2019-09-08 stsp configuration settings can be
2228 aba9c984 2019-09-08 stsp obtained from the repository's
2229 aba9c984 2019-09-08 stsp .Pa .git/config
2230 c9956ddf 2019-09-08 stsp file or from Git's global
2231 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2232 c9956ddf 2019-09-08 stsp configuration file.
2234 74416c47 2019-05-09 stsp The options for
2235 74416c47 2019-05-09 stsp .Cm got commit
2236 74416c47 2019-05-09 stsp are as follows:
2237 74416c47 2019-05-09 stsp .Bl -tag -width Ds
2238 18d1acad 2022-07-20 thomas .It Fl A Ar author
2239 18d1acad 2022-07-20 thomas Set author information in the newly created commit to
2240 18d1acad 2022-07-20 thomas .Ar author .
2241 fbbd3dd5 2023-02-17 thomas This is useful when committing changes on behalf of someone else.
2243 18d1acad 2022-07-20 thomas .Ar author
2244 18d1acad 2022-07-20 thomas argument must use the same format as the
2245 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
2246 18d1acad 2022-07-20 thomas environment variable.
2248 18d1acad 2022-07-20 thomas In addition to storing author information, the newly created commit
2249 18d1acad 2022-07-20 thomas object will retain
2250 18d1acad 2022-07-20 thomas .Dq committer
2251 18d1acad 2022-07-20 thomas information which is obtained, as usual, from the
2252 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
2253 18d1acad 2022-07-20 thomas environment variable, or
2254 18d1acad 2022-07-20 thomas .Xr got.conf 5 ,
2255 18d1acad 2022-07-20 thomas or Git configuration settings.
2256 be94c032 2023-02-20 thomas .It Fl C
2257 be94c032 2023-02-20 thomas Allow committing files in conflicted status.
2259 be94c032 2023-02-20 thomas Committing files with conflict markers should generally be avoided.
2260 be94c032 2023-02-20 thomas Cases where conflict markers must be stored in the repository for
2261 be94c032 2023-02-20 thomas some legitimate reason should be very rare.
2262 be94c032 2023-02-20 thomas There are usually ways to avoid storing conflict markers verbatim by
2263 be94c032 2023-02-20 thomas applying appropriate programming tricks.
2264 28cf319f 2021-01-28 stsp .It Fl F Ar path
2265 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
2267 28cf319f 2021-01-28 stsp when creating the new commit.
2268 28cf319f 2021-01-28 stsp .Cm got commit
2269 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
2270 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
2271 28cf319f 2021-01-28 stsp Cannot be used together with the
2274 74ff3f23 2019-07-07 stsp .It Fl m Ar message
2275 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
2276 28cf319f 2021-01-28 stsp Cannot be used together with the
2280 28cf319f 2021-01-28 stsp This option prevents
2281 23594da9 2019-05-13 stsp .Cm got commit
2282 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
2283 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
2285 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
2286 ef899790 2022-11-01 thomas .It Fl n
2287 ef899790 2022-11-01 thomas This option prevents
2288 ef899790 2022-11-01 thomas .Cm got commit
2289 ef899790 2022-11-01 thomas from generating a diff of the to-be-committed changes in a temporary file
2290 ef899790 2022-11-01 thomas which can be viewed while editing a commit message.
2292 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
2293 af358f55 2020-07-23 stsp that is under version control.
2294 af358f55 2020-07-23 stsp By default,
2295 af358f55 2020-07-23 stsp .Cm got commit
2296 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2297 35213c7c 2020-07-23 stsp As a precaution,
2299 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2300 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2301 af358f55 2020-07-23 stsp points outside of the work tree.
2302 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2303 af358f55 2020-07-23 stsp .Dq make obj
2304 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2305 af358f55 2020-07-23 stsp version control.
2308 cfce0458 2019-07-28 stsp .Cm got commit
2309 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
2310 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
2311 916f288c 2019-07-30 stsp .Dq refs/heads/
2312 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
2313 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
2314 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
2315 cfce0458 2019-07-28 stsp If a path is found to be out of date,
2316 cfce0458 2019-07-28 stsp .Cm got update
2317 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
2318 cfce0458 2019-07-28 stsp in the repository.
2321 56c96eff 2022-08-30 thomas .Cm send
2322 56c96eff 2022-08-30 thomas .Op Fl afqTv
2323 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
2324 56c96eff 2022-08-30 thomas .Op Fl d Ar branch
2325 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
2326 56c96eff 2022-08-30 thomas .Op Fl t Ar tag
2327 56c96eff 2022-08-30 thomas .Op Ar remote-repository
2329 d912d125 2021-11-04 thomas .Dl Pq alias: Cm se
2330 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
2332 f8a36e22 2021-08-26 stsp .Ar remote-repository
2333 f8a36e22 2021-08-26 stsp is specified,
2334 f8a36e22 2021-08-26 stsp .Dq origin
2335 f8a36e22 2021-08-26 stsp will be used.
2336 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
2337 f8a36e22 2021-08-26 stsp .Xr got.conf 5
2339 f8a36e22 2021-08-26 stsp .Pa config
2340 f8a36e22 2021-08-26 stsp file of the local repository, as created by
2341 f8a36e22 2021-08-26 stsp .Cm got clone .
2343 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
2344 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
2345 f8a36e22 2021-08-26 stsp Upon success, references in the
2346 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
2347 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
2348 f8a36e22 2021-08-26 stsp the commits which have been sent.
2350 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
2351 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
2352 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
2353 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
2354 fd44090b 2021-08-26 stsp be fetched from the server with
2355 f8a36e22 2021-08-26 stsp .Cm got fetch
2356 f8a36e22 2021-08-26 stsp and local branches must be rebased with
2357 f8a36e22 2021-08-26 stsp .Cm got rebase
2359 f8a36e22 2021-08-26 stsp .Cm got send
2360 f8a36e22 2021-08-26 stsp can succeed.
2363 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
2365 f8a36e22 2021-08-26 stsp The options for
2366 f8a36e22 2021-08-26 stsp .Cm got send
2367 f8a36e22 2021-08-26 stsp are as follows:
2368 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
2370 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
2371 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2372 f8a36e22 2021-08-26 stsp reference namespace.
2375 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
2378 f8a36e22 2021-08-26 stsp Cannot be used together with the
2381 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
2382 f8a36e22 2021-08-26 stsp Send the specified
2383 f8a36e22 2021-08-26 stsp .Ar branch
2384 f8a36e22 2021-08-26 stsp from the local repository's
2385 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2386 f8a36e22 2021-08-26 stsp reference namespace.
2387 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2389 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
2390 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
2391 f8a36e22 2021-08-26 stsp Cannot be used together with the
2394 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
2395 f8a36e22 2021-08-26 stsp Delete the specified
2396 f8a36e22 2021-08-26 stsp .Ar branch
2397 f8a36e22 2021-08-26 stsp from the remote repository's
2398 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2399 f8a36e22 2021-08-26 stsp reference namespace.
2400 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2401 f8a36e22 2021-08-26 stsp to delete.
2403 f8a36e22 2021-08-26 stsp Only references are deleted.
2404 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
2405 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
2406 f8a36e22 2021-08-26 stsp the server.
2408 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
2409 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
2410 fd44090b 2021-08-26 stsp based on its configuration.
2412 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
2413 fd44090b 2021-08-26 stsp in the remote repository, even when
2414 fd44090b 2021-08-26 stsp .Cm got fetch
2415 1a70a207 2023-07-05 thomas followed by
2416 fd44090b 2021-08-26 stsp .Cm got rebase
2418 1a70a207 2023-07-05 thomas .Cm got merge
2419 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
2420 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
2421 f8a36e22 2021-08-26 stsp configuration.
2423 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
2424 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
2425 f8a36e22 2021-08-26 stsp on the server.
2428 f8a36e22 2021-08-26 stsp .Dq refs/tags
2429 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
2430 f8a36e22 2021-08-26 stsp Use of the
2432 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
2433 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
2434 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2435 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2437 f8a36e22 2021-08-26 stsp Use of the
2439 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
2440 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
2441 f8a36e22 2021-08-26 stsp Instead of using the
2443 f8a36e22 2021-08-26 stsp option, new changes should
2444 f8a36e22 2021-08-26 stsp be fetched with
2445 f8a36e22 2021-08-26 stsp .Cm got fetch
2446 f8a36e22 2021-08-26 stsp and local branches should be rebased with
2447 1a70a207 2023-07-05 thomas .Cm got rebase
2448 1a70a207 2023-07-05 thomas or merged with
2449 1a70a207 2023-07-05 thomas .Cm got merge ,
2450 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
2454 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
2455 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
2456 f8a36e22 2021-08-26 stsp disposable.
2457 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
2458 f8a36e22 2021-08-26 stsp should also be taken into account.
2459 d6506a3d 2022-08-16 thomas .It Fl q
2460 d6506a3d 2022-08-16 thomas Suppress progress reporting output.
2461 d6506a3d 2022-08-16 thomas The same option will be passed to
2462 d6506a3d 2022-08-16 thomas .Xr ssh 1
2463 d6506a3d 2022-08-16 thomas if applicable.
2464 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
2465 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
2466 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
2467 f8a36e22 2021-08-26 stsp working directory.
2468 f8a36e22 2021-08-26 stsp If this directory is a
2470 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
2471 d6506a3d 2022-08-16 thomas .It Fl T
2472 d6506a3d 2022-08-16 thomas Attempt to send all tags from the local repository's
2473 d6506a3d 2022-08-16 thomas .Dq refs/tags/
2474 d6506a3d 2022-08-16 thomas reference namespace.
2477 d6506a3d 2022-08-16 thomas option is equivalent to listing all tags with multiple
2479 d6506a3d 2022-08-16 thomas options.
2480 d6506a3d 2022-08-16 thomas Cannot be used together with the
2483 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
2484 f8a36e22 2021-08-26 stsp Send the specified
2486 f8a36e22 2021-08-26 stsp from the local repository's
2487 f8a36e22 2021-08-26 stsp .Dq refs/tags/
2488 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
2491 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
2492 f8a36e22 2021-08-26 stsp No tags will be sent if the
2494 f8a36e22 2021-08-26 stsp option is not used.
2496 f8a36e22 2021-08-26 stsp Raise an error if the specified
2498 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
2500 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
2501 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2502 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2504 f8a36e22 2021-08-26 stsp Cannot be used together with the
2508 f8a36e22 2021-08-26 stsp Verbose mode.
2510 f8a36e22 2021-08-26 stsp .Cm got send
2511 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
2512 f8a36e22 2021-08-26 stsp The same option will be passed to
2514 f8a36e22 2021-08-26 stsp if applicable.
2515 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
2516 f8a36e22 2021-08-26 stsp The maximum is 3.
2520 f6cd0243 2023-01-28 thomas .Cm cherrypick
2521 f6cd0243 2023-01-28 thomas .Op Fl lX
2522 7e710171 2023-01-28 thomas .Op Ar commit
2524 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cy
2525 234035bc 2019-06-01 stsp Merge changes from a single
2526 234035bc 2019-06-01 stsp .Ar commit
2527 234035bc 2019-06-01 stsp into the work tree.
2528 234035bc 2019-06-01 stsp The specified
2529 234035bc 2019-06-01 stsp .Ar commit
2530 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
2532 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name or
2533 a290e4b4 2023-07-19 thomas keyword which will be resolved to a commit ID.
2534 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2535 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2536 a290e4b4 2023-07-19 thomas The keywords
2537 fb885120 2023-07-19 thomas .Qq :base
2539 fb885120 2023-07-19 thomas .Qq :head
2540 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
2541 fb885120 2023-07-19 thomas Keywords and references may be appended with
2545 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
2546 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
2547 fb885120 2023-07-19 thomas for example,
2548 fb885120 2023-07-19 thomas .Sy :head:-2
2549 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
2550 fb885120 2023-07-19 thomas .Sy :base:+4
2551 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2552 fb885120 2023-07-19 thomas Similarly,
2553 fb885120 2023-07-19 thomas .Sy barbaz:+3
2554 fb885120 2023-07-19 thomas will denote the 3rd generation descendant of the commit resolved by the
2555 fb885120 2023-07-19 thomas .Qq barbaz
2556 fb885120 2023-07-19 thomas reference.
2561 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
2563 fb885120 2023-07-19 thomas appended
2564 fb885120 2023-07-19 thomas .Po e.g.,
2565 fb885120 2023-07-19 thomas .Sy :base:+
2566 fb885120 2023-07-19 thomas is equivalent to
2567 fb885120 2023-07-19 thomas .Sy :base:+1
2570 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
2571 234035bc 2019-06-01 stsp .Bl -column YXZ description
2572 234035bc 2019-06-01 stsp .It G Ta file was merged
2573 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
2574 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
2575 234035bc 2019-06-01 stsp .It D Ta file was deleted
2576 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2577 234035bc 2019-06-01 stsp .It A Ta new file was added
2578 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2579 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2582 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2583 234035bc 2019-06-01 stsp may be viewed with
2584 234035bc 2019-06-01 stsp .Cm got diff ,
2585 234035bc 2019-06-01 stsp amended manually or with further
2586 234035bc 2019-06-01 stsp .Cm got cherrypick
2588 234035bc 2019-06-01 stsp committed with
2589 52d3950d 2023-01-28 thomas .Cm got commit .
2591 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2592 52d3950d 2023-01-28 thomas .Cm rebase ,
2593 52d3950d 2023-01-28 thomas .Cm histedit ,
2595 52d3950d 2023-01-28 thomas .Cm merge
2596 52d3950d 2023-01-28 thomas operation is taking place,
2597 234035bc 2019-06-01 stsp .Cm got cherrypick
2598 52d3950d 2023-01-28 thomas creates a record of commits which have been merged into the work tree.
2599 52d3950d 2023-01-28 thomas When a file changed by
2600 52d3950d 2023-01-28 thomas .Cm got cherrypick
2601 52d3950d 2023-01-28 thomas is committed with
2602 52d3950d 2023-01-28 thomas .Cm got commit ,
2603 52d3950d 2023-01-28 thomas the log messages of relevant merged commits will then appear in the editor,
2604 75a8c854 2023-02-17 thomas where the messages should be further adjusted to convey the reasons for
2605 95e6f77e 2023-01-28 thomas cherrypicking the changes.
2606 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2607 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2608 75a8c854 2023-02-17 thomas .Cm got commit
2609 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2611 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2612 52d3950d 2023-01-28 thomas e.g. with
2613 52d3950d 2023-01-28 thomas .Cm got revert ,
2614 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2616 52d3950d 2023-01-28 thomas .Cm got cherrypick
2617 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2618 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2619 234035bc 2019-06-01 stsp to a single base commit with
2620 234035bc 2019-06-01 stsp .Cm got update .
2621 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2622 234035bc 2019-06-01 stsp conflicts must be resolved first.
2624 f6cd0243 2023-01-28 thomas The options for
2626 f6cd0243 2023-01-28 thomas .Cm cherrypick
2627 f6cd0243 2023-01-28 thomas are as follows:
2628 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2629 f6cd0243 2023-01-28 thomas .It Fl l
2630 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by cherrypick operations,
2631 f6cd0243 2023-01-28 thomas represented by references in the
2632 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2633 f6cd0243 2023-01-28 thomas reference namespace.
2635 f6cd0243 2023-01-28 thomas .Ar commit
2636 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2638 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2639 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2640 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2641 f6cd0243 2023-01-28 thomas work tree in which they were created.
2642 f6cd0243 2023-01-28 thomas This option cannot be used with
2644 f6cd0243 2023-01-28 thomas .It Fl X
2645 f6cd0243 2023-01-28 thomas Delete log messages created by previous cherrypick operations, represented by
2646 f6cd0243 2023-01-28 thomas references in the
2647 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2648 f6cd0243 2023-01-28 thomas reference namespace.
2650 f6cd0243 2023-01-28 thomas .Ar commit
2651 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2653 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2654 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2655 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2656 f6cd0243 2023-01-28 thomas work tree in which they were created.
2657 f6cd0243 2023-01-28 thomas This option cannot be used with
2663 f6cd0243 2023-01-28 thomas .Cm backout
2664 f6cd0243 2023-01-28 thomas .Op Fl lX
2665 7e710171 2023-01-28 thomas .Op Ar commit
2667 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bo
2668 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2669 5ef14e63 2019-06-02 stsp .Ar commit
2670 5ef14e63 2019-06-02 stsp into the work tree.
2671 5ef14e63 2019-06-02 stsp The specified
2672 5ef14e63 2019-06-02 stsp .Ar commit
2673 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2675 a290e4b4 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
2676 a290e4b4 2023-07-19 thomas or keyword which will be resolved to a commit ID.
2677 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2678 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2679 a290e4b4 2023-07-19 thomas The keywords
2680 fb885120 2023-07-19 thomas .Qq :base
2682 fb885120 2023-07-19 thomas .Qq :head
2683 a290e4b4 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
2684 fb885120 2023-07-19 thomas Keywords and references may be appended with
2688 fb885120 2023-07-19 thomas modifiers and an optional integer N to denote the
2689 fb885120 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
2690 fb885120 2023-07-19 thomas for example,
2691 fb885120 2023-07-19 thomas .Sy :head:-2
2692 fb885120 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
2693 fb885120 2023-07-19 thomas .Sy :base:+4
2694 fb885120 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
2695 fb885120 2023-07-19 thomas Similarly,
2696 fb885120 2023-07-19 thomas .Sy wip:+5
2697 fb885120 2023-07-19 thomas will denote the 5th generation descendant of the commit resolved by the
2699 fb885120 2023-07-19 thomas reference.
2704 fb885120 2023-07-19 thomas modifier without a trailing integer has an implicit
2706 fb885120 2023-07-19 thomas appended
2707 fb885120 2023-07-19 thomas .Po e.g.,
2708 fb885120 2023-07-19 thomas .Sy :base:+
2709 fb885120 2023-07-19 thomas is equivalent to
2710 fb885120 2023-07-19 thomas .Sy :base:+1
2713 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2714 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2715 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2716 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2717 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2718 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2719 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2720 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2721 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2722 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2725 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2726 5ef14e63 2019-06-02 stsp which may be viewed with
2727 5ef14e63 2019-06-02 stsp .Cm got diff ,
2728 5ef14e63 2019-06-02 stsp amended manually or with further
2729 778a73c2 2019-07-12 stsp .Cm got backout
2731 5ef14e63 2019-06-02 stsp committed with
2732 52d3950d 2023-01-28 thomas .Cm got commit .
2734 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2735 52d3950d 2023-01-28 thomas .Cm rebase ,
2736 52d3950d 2023-01-28 thomas .Cm histedit ,
2738 52d3950d 2023-01-28 thomas .Cm merge
2739 52d3950d 2023-01-28 thomas operation is taking place,
2740 92228c38 2019-06-02 stsp .Cm got backout
2741 52d3950d 2023-01-28 thomas creates a record of commits which have been reverse-merged into the work tree.
2742 52d3950d 2023-01-28 thomas When a file changed by
2743 52d3950d 2023-01-28 thomas .Cm got backout
2744 52d3950d 2023-01-28 thomas is committed with
2745 52d3950d 2023-01-28 thomas .Cm got commit ,
2746 52d3950d 2023-01-28 thomas the log messages of relevant reverse-merged commits will then appear in
2747 75a8c854 2023-02-17 thomas the editor, where the messages should be further adjusted to convey the
2748 95e6f77e 2023-01-28 thomas reasons for backing out the changes.
2749 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2750 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2751 75a8c854 2023-02-17 thomas .Cm got commit
2752 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2754 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2755 52d3950d 2023-01-28 thomas e.g. with
2756 52d3950d 2023-01-28 thomas .Cm got revert ,
2757 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2759 52d3950d 2023-01-28 thomas .Cm got backout
2760 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2761 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2762 92228c38 2019-06-02 stsp to a single base commit with
2763 92228c38 2019-06-02 stsp .Cm got update .
2764 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2765 92228c38 2019-06-02 stsp conflicts must be resolved first.
2767 f6cd0243 2023-01-28 thomas The options for
2769 f6cd0243 2023-01-28 thomas .Cm backout
2770 f6cd0243 2023-01-28 thomas are as follows:
2771 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2772 f6cd0243 2023-01-28 thomas .It Fl l
2773 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by backout operations,
2774 f6cd0243 2023-01-28 thomas represented by references in the
2775 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2776 f6cd0243 2023-01-28 thomas reference namespace.
2778 f6cd0243 2023-01-28 thomas .Ar commit
2779 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2781 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2782 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2783 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2784 f6cd0243 2023-01-28 thomas work tree in which they were created.
2785 f6cd0243 2023-01-28 thomas This option cannot be used with
2787 f6cd0243 2023-01-28 thomas .It Fl X
2788 f6cd0243 2023-01-28 thomas Delete log messages created by previous backout operations, represented by
2789 f6cd0243 2023-01-28 thomas references in the
2790 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2791 f6cd0243 2023-01-28 thomas reference namespace.
2793 f6cd0243 2023-01-28 thomas .Ar commit
2794 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2796 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2797 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2798 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2799 f6cd0243 2023-01-28 thomas work tree in which they were created.
2800 f6cd0243 2023-01-28 thomas This option cannot be used with
2806 56c96eff 2022-08-30 thomas .Cm rebase
2807 be94c032 2023-02-20 thomas .Op Fl aCclX
2808 56c96eff 2022-08-30 thomas .Op Ar branch
2810 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rb
2811 818c7501 2019-07-11 stsp Rebase commits on the specified
2812 818c7501 2019-07-11 stsp .Ar branch
2813 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2815 818c7501 2019-07-11 stsp .Ar branch
2816 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2817 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2818 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2819 818c7501 2019-07-11 stsp .Ar branch
2820 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2821 f09e2405 2019-07-11 stsp of the specified
2822 818c7501 2019-07-11 stsp .Ar branch
2823 f09e2405 2019-07-11 stsp has been rebased.
2826 2b6826ba 2020-02-24 stsp .Cm got rebase
2827 2b6826ba 2020-02-24 stsp is used as intended, the specified
2828 2b6826ba 2020-02-24 stsp .Ar branch
2829 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2830 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2831 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2832 2b6826ba 2020-02-24 stsp .Cm got update -b
2833 2b6826ba 2020-02-24 stsp before starting the
2834 2b6826ba 2020-02-24 stsp .Cm rebase
2835 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2836 2b6826ba 2020-02-24 stsp a common history with the specified
2837 2b6826ba 2020-02-24 stsp .Ar branch
2838 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2839 c10890ce 2020-02-25 stsp remote repository.
2841 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2842 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2843 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2844 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2845 818c7501 2019-07-11 stsp .Ar branch ,
2846 818c7501 2019-07-11 stsp but with different commit IDs.
2847 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2848 f09e2405 2019-07-11 stsp the new version of the specified
2849 818c7501 2019-07-11 stsp .Ar branch
2850 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2851 d4dddcbf 2022-07-22 thomas If author information is available via the
2852 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2853 d4dddcbf 2022-07-22 thomas environment variable,
2854 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2855 d4dddcbf 2022-07-22 thomas or Git's
2856 d4dddcbf 2022-07-22 thomas .Dv user.name
2858 d4dddcbf 2022-07-22 thomas .Dv user.email
2859 d4dddcbf 2022-07-22 thomas configuration settings, this author information will be used to identify
2861 d4dddcbf 2022-07-22 thomas .Dq committer
2862 d4dddcbf 2022-07-22 thomas of rebased commits.
2864 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2865 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2866 e600f124 2021-03-21 stsp reference namespace.
2867 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2868 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2869 e600f124 2021-03-21 stsp .Cm got rebase -l
2871 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2872 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2873 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2875 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2876 818c7501 2019-07-11 stsp using the following status codes:
2877 818c7501 2019-07-11 stsp .Bl -column YXZ description
2878 818c7501 2019-07-11 stsp .It G Ta file was merged
2879 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2880 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2881 818c7501 2019-07-11 stsp .It D Ta file was deleted
2882 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2883 818c7501 2019-07-11 stsp .It A Ta new file was added
2884 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2885 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2888 4b06140e 2022-03-22 thomas If merge conflicts occur, the rebase operation is interrupted and may
2889 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2890 bb494413 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2891 bb494413 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2892 bb494413 2021-09-28 thomas the rebase operation will be interrupted to prevent potentially incomplete
2893 bb494413 2021-09-28 thomas changes from being committed to the repository without user intervention.
2894 bb494413 2021-09-28 thomas The work tree may be modified as desired and the rebase operation can be
2895 bb494413 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2896 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2897 818c7501 2019-07-11 stsp .Ar branch
2898 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2900 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2901 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2902 f09e2405 2019-07-11 stsp when the rebase operation continues.
2904 818c7501 2019-07-11 stsp .Cm got rebase
2905 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2907 8dbcf388 2022-09-04 thomas .Ar branch
2908 8dbcf388 2022-09-04 thomas is not in the
2909 8dbcf388 2022-09-04 thomas .Dq refs/heads/
2910 8dbcf388 2022-09-04 thomas reference namespace, the branch may not be rebased.
2911 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2912 4b06140e 2022-03-22 thomas branch, then the work tree must first be updated with
2913 818c7501 2019-07-11 stsp .Cm got update .
2914 4ed9f614 2019-08-04 stsp If changes have been staged with
2915 4ed9f614 2019-08-04 stsp .Cm got stage ,
2916 bc3056e3 2019-08-18 stsp these changes must first be committed with
2917 4ed9f614 2019-08-04 stsp .Cm got commit
2918 4ed9f614 2019-08-04 stsp or unstaged with
2919 4ed9f614 2019-08-04 stsp .Cm got unstage .
2920 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2921 f09e2405 2019-07-11 stsp committed with
2922 f09e2405 2019-07-11 stsp .Cm got commit
2923 f09e2405 2019-07-11 stsp or reverted with
2924 f09e2405 2019-07-11 stsp .Cm got revert .
2926 64c6d990 2019-07-11 stsp .Ar branch
2927 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2928 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2931 8bcebf69 2023-01-08 thomas .Cm got update ,
2932 8bcebf69 2023-01-08 thomas .Cm got integrate ,
2933 8bcebf69 2023-01-08 thomas .Cm got merge ,
2934 8bcebf69 2023-01-08 thomas .Cm got commit ,
2936 8bcebf69 2023-01-08 thomas .Cm got histedit
2937 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2938 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2939 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2941 d10218e7 2021-11-04 thomas If the specified
2942 d10218e7 2021-11-04 thomas .Ar branch
2943 4b06140e 2022-03-22 thomas is already based on the work tree's current branch, then no commits
2944 d10218e7 2021-11-04 thomas need to be rebased and
2945 d10218e7 2021-11-04 thomas .Cm got rebase
2946 d10218e7 2021-11-04 thomas will simply switch the work tree to the specified
2947 d10218e7 2021-11-04 thomas .Ar branch
2948 d10218e7 2021-11-04 thomas and update files in the work tree accordingly.
2950 818c7501 2019-07-11 stsp The options for
2951 818c7501 2019-07-11 stsp .Cm got rebase
2952 818c7501 2019-07-11 stsp are as follows:
2953 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2955 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2956 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2957 be94c032 2023-02-20 thomas .It Fl C
2958 be94c032 2023-02-20 thomas Allow a rebase operation to continue with files in conflicted status.
2959 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
2963 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2964 79878eb8 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
2967 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2968 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2969 e600f124 2021-03-21 stsp reference namespace.
2971 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2972 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2973 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2974 e600f124 2021-03-21 stsp Given these object IDs,
2976 e600f124 2021-03-21 stsp .Cm got log
2977 e600f124 2021-03-21 stsp command with the
2981 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2983 e600f124 2021-03-21 stsp .Cm got branch
2984 e600f124 2021-03-21 stsp command with the
2986 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2989 e600f124 2021-03-21 stsp .Ar branch
2990 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2992 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2994 e600f124 2021-03-21 stsp If this option is used,
2995 e600f124 2021-03-21 stsp .Cm got rebase
2996 e600f124 2021-03-21 stsp does not require a work tree.
2997 e600f124 2021-03-21 stsp None of the other options can be used together with
3000 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
3002 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
3003 643b85bc 2021-07-16 stsp reference namespace.
3006 643b85bc 2021-07-16 stsp .Ar branch
3007 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
3008 643b85bc 2021-07-16 stsp this branch.
3009 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
3010 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
3012 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
3013 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
3014 643b85bc 2021-07-16 stsp Git's garbage collector or
3015 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
3017 643b85bc 2021-07-16 stsp If this option is used,
3018 643b85bc 2021-07-16 stsp .Cm got rebase
3019 643b85bc 2021-07-16 stsp does not require a work tree.
3020 643b85bc 2021-07-16 stsp None of the other options can be used together with
3025 56c96eff 2022-08-30 thomas .Cm histedit
3026 be94c032 2023-02-20 thomas .Op Fl aCcdeflmX
3027 56c96eff 2022-08-30 thomas .Op Fl F Ar histedit-script
3028 56c96eff 2022-08-30 thomas .Op Ar branch
3030 d912d125 2021-11-04 thomas .Dl Pq alias: Cm he
3031 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
3032 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
3035 d4dddcbf 2022-07-22 thomas .Cm got histedit
3036 d4dddcbf 2022-07-22 thomas command requires the
3037 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
3038 d4dddcbf 2022-07-22 thomas environment variable to be set,
3039 d4dddcbf 2022-07-22 thomas unless an author has been configured in
3040 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
3041 d4dddcbf 2022-07-22 thomas or Git's
3042 d4dddcbf 2022-07-22 thomas .Dv user.name
3044 d4dddcbf 2022-07-22 thomas .Dv user.email
3045 d4dddcbf 2022-07-22 thomas configuration settings can be obtained from the repository's
3046 d4dddcbf 2022-07-22 thomas .Pa .git/config
3047 d4dddcbf 2022-07-22 thomas file or from Git's global
3048 d4dddcbf 2022-07-22 thomas .Pa ~/.gitconfig
3049 d4dddcbf 2022-07-22 thomas configuration file.
3051 6e54d307 2020-02-24 stsp Before starting a
3052 6e54d307 2020-02-24 stsp .Cm histedit
3053 4b06140e 2022-03-22 thomas operation, the work tree's current branch must be set with
3054 6e54d307 2020-02-24 stsp .Cm got update -b
3055 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
3056 6e54d307 2020-02-24 stsp current branch of the work tree.
3057 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
3058 6e54d307 2020-02-24 stsp touched by the
3059 6e54d307 2020-02-24 stsp .Cm histedit
3060 6e54d307 2020-02-24 stsp operation.
3062 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
3063 6e54d307 2020-02-24 stsp must be set with
3064 6e54d307 2020-02-24 stsp .Cm got update -c
3065 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
3066 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
3068 6e54d307 2020-02-24 stsp .Cm histedit
3069 6e54d307 2020-02-24 stsp operation.
3071 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
3072 0ebf8283 2019-07-24 stsp .Ar histedit script
3073 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
3074 46fa4c83 2020-02-24 stsp command line, or generated with the
3081 bccae03f 2023-07-17 thomas Quitting the editor without saving the file will abort the histedit operation.
3083 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
3084 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
3085 0ebf8283 2019-07-24 stsp whitespace and an argument.
3086 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
3087 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
3088 0ebf8283 2019-07-24 stsp Lines which begin with the
3090 0ebf8283 2019-07-24 stsp character are ignored entirely.
3092 f3a5718a 2022-07-12 thomas The available histedit script commands are as follows:
3093 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
3094 f3a5718a 2022-07-12 thomas .It Cm pick Ar commit Ta Use the specified commit as it is.
3095 71654e8d 2023-03-01 thomas .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
3096 71654e8d 2023-03-01 thomas then interrupt the histedit operation for amending, without creating a commit.
3097 49f76ad0 2023-03-01 thomas While the histedit operation is interrupted arbitrary files may be edited,
3098 49f76ad0 2023-03-01 thomas and commands which manipulate the work tree can be used freely.
3100 49f76ad0 2023-03-01 thomas .Cm got add
3102 49f76ad0 2023-03-01 thomas .Cm got remove
3103 49f76ad0 2023-03-01 thomas commands can be used to add new files or remove existing ones.
3105 49f76ad0 2023-03-01 thomas .Cm got revert -p
3106 49f76ad0 2023-03-01 thomas command can be used to eliminate arbitrary changes from files in the work tree.
3108 49f76ad0 2023-03-01 thomas .Cm got stage -p
3109 49f76ad0 2023-03-01 thomas command may be used to prepare a subset of changes for inclusion in the
3110 49f76ad0 2023-03-01 thomas next commit.
3111 49f76ad0 2023-03-01 thomas Finally, the
3112 49f76ad0 2023-03-01 thomas .Cm got commit
3113 49f76ad0 2023-03-01 thomas command can be used to insert arbitrary commits into the edited history.
3114 49f76ad0 2023-03-01 thomas Regular editing of history must eventually be resumed by running
3115 49f76ad0 2023-03-01 thomas .Cm got histedit -c .
3116 f3a5718a 2022-07-12 thomas .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3117 0ebf8283 2019-07-24 stsp listed further below that will be used.
3118 f3a5718a 2022-07-12 thomas .It Cm drop Ar commit Ta Remove this commit from the edited history.
3119 f52e24d8 2023-10-28 thomas .It Cm mesg Ar commit Ta Open an editor to create a new log message for this
3123 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
3124 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
3125 5b87815e 2020-03-05 stsp No commit may be listed more than once.
3127 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
3128 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
3129 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
3130 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
3131 498a90b7 2019-07-25 stsp switched to it.
3133 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
3134 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3135 e600f124 2021-03-21 stsp reference namespace.
3136 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
3137 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
3138 e600f124 2021-03-21 stsp .Cm got histedit -l
3140 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
3141 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
3142 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
3144 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
3145 0ebf8283 2019-07-24 stsp using the following status codes:
3146 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
3147 0ebf8283 2019-07-24 stsp .It G Ta file was merged
3148 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
3149 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
3150 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
3151 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3152 0ebf8283 2019-07-24 stsp .It A Ta new file was added
3153 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3154 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
3157 4b06140e 2022-03-22 thomas If merge conflicts occur, the histedit operation is interrupted and may
3158 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
3159 dddbe150 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
3160 dddbe150 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
3161 dddbe150 2021-09-28 thomas the histedit operation will be interrupted to prevent potentially incomplete
3162 dddbe150 2021-09-28 thomas changes from being committed to the repository without user intervention.
3163 dddbe150 2021-09-28 thomas The work tree may be modified as desired and the histedit operation can be
3164 dddbe150 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
3165 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
3166 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
3168 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
3169 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
3170 0ebf8283 2019-07-24 stsp when the histedit operation continues.
3172 0ebf8283 2019-07-24 stsp .Cm got histedit
3173 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
3174 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
3175 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
3176 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
3177 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3178 0ebf8283 2019-07-24 stsp to a single base commit with
3179 0ebf8283 2019-07-24 stsp .Cm got update .
3180 4ed9f614 2019-08-04 stsp If changes have been staged with
3181 4ed9f614 2019-08-04 stsp .Cm got stage ,
3182 bc3056e3 2019-08-18 stsp these changes must first be committed with
3183 4ed9f614 2019-08-04 stsp .Cm got commit
3184 4ed9f614 2019-08-04 stsp or unstaged with
3185 4ed9f614 2019-08-04 stsp .Cm got unstage .
3186 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
3187 0ebf8283 2019-07-24 stsp committed with
3188 0ebf8283 2019-07-24 stsp .Cm got commit
3189 0ebf8283 2019-07-24 stsp or reverted with
3190 0ebf8283 2019-07-24 stsp .Cm got revert .
3191 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
3192 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
3195 7ef62c4e 2020-02-24 stsp .Cm got update ,
3196 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
3197 8bcebf69 2023-01-08 thomas .Cm got merge ,
3199 65db4ffb 2020-02-24 stsp .Cm got integrate
3200 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
3201 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
3202 0ebf8283 2019-07-24 stsp .Cm got commit
3203 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
3204 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
3206 0ebf8283 2019-07-24 stsp The options for
3207 0ebf8283 2019-07-24 stsp .Cm got histedit
3208 0ebf8283 2019-07-24 stsp are as follows:
3209 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
3211 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
3212 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
3213 be94c032 2023-02-20 thomas .It Fl C
3214 be94c032 2023-02-20 thomas Allow a histedit operation to continue with files in conflicted status.
3215 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
3219 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
3220 79878eb8 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
3222 070c80a5 2023-01-31 thomas .It Fl d
3223 070c80a5 2023-01-31 thomas Drop all commits.
3224 070c80a5 2023-01-31 thomas This option is a quick equivalent to a histedit script which drops all
3225 070c80a5 2023-01-31 thomas commits.
3228 070c80a5 2023-01-31 thomas option can only be used when starting a new histedit operation.
3229 070c80a5 2023-01-31 thomas If this option is used, no other command-line arguments are allowed.
3230 c50a7455 2021-10-04 thomas .It Fl e
3231 c50a7455 2021-10-04 thomas Interrupt the histedit operation for editing after merging each commit.
3232 c50a7455 2021-10-04 thomas This option is a quick equivalent to a histedit script which uses the
3233 c50a7455 2021-10-04 thomas .Cm edit
3234 c50a7455 2021-10-04 thomas command for all commits.
3237 c50a7455 2021-10-04 thomas option can only be used when starting a new histedit operation.
3238 c50a7455 2021-10-04 thomas If this option is used, no other command-line arguments are allowed.
3239 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
3240 ddbfac99 2020-02-24 stsp Use the specified
3241 ddbfac99 2020-02-24 stsp .Ar histedit-script
3242 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
3243 ddbfac99 2020-02-24 stsp can be written.
3244 d6506a3d 2022-08-16 thomas .It Fl f
3245 d6506a3d 2022-08-16 thomas Fold all commits into a single commit.
3246 d6506a3d 2022-08-16 thomas This option is a quick equivalent to a histedit script which folds all
3247 d6506a3d 2022-08-16 thomas commits, combining them all into one commit.
3250 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
3251 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
3253 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
3254 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3255 e600f124 2021-03-21 stsp reference namespace.
3257 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
3258 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
3259 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
3260 e600f124 2021-03-21 stsp Given these object IDs,
3262 e600f124 2021-03-21 stsp .Cm got log
3263 e600f124 2021-03-21 stsp command with the
3267 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
3269 e600f124 2021-03-21 stsp .Cm got branch
3270 e600f124 2021-03-21 stsp command with the
3272 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
3275 e600f124 2021-03-21 stsp .Ar branch
3276 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
3278 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
3280 e600f124 2021-03-21 stsp If this option is used,
3281 e600f124 2021-03-21 stsp .Cm got histedit
3282 e600f124 2021-03-21 stsp does not require a work tree.
3283 e600f124 2021-03-21 stsp None of the other options can be used together with
3285 d6506a3d 2022-08-16 thomas .It Fl m
3286 d6506a3d 2022-08-16 thomas Edit log messages only.
3287 d6506a3d 2022-08-16 thomas This option is a quick equivalent to a histedit script which edits
3288 d6506a3d 2022-08-16 thomas only log messages but otherwise leaves every picked commit as-is.
3291 d6506a3d 2022-08-16 thomas option can only be used when starting a new histedit operation.
3292 d6506a3d 2022-08-16 thomas If this option is used, no other command-line arguments are allowed.
3294 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
3296 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
3297 643b85bc 2021-07-16 stsp reference namespace.
3300 643b85bc 2021-07-16 stsp .Ar branch
3301 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
3302 643b85bc 2021-07-16 stsp this branch.
3303 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
3304 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
3306 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
3307 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
3308 643b85bc 2021-07-16 stsp Git's garbage collector or
3309 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
3311 643b85bc 2021-07-16 stsp If this option is used,
3312 643b85bc 2021-07-16 stsp .Cm got histedit
3313 643b85bc 2021-07-16 stsp does not require a work tree.
3314 643b85bc 2021-07-16 stsp None of the other options can be used together with
3318 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
3319 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ig
3320 2822a352 2019-10-15 stsp Integrate the specified
3321 2822a352 2019-10-15 stsp .Ar branch
3322 2822a352 2019-10-15 stsp into the work tree's current branch.
3323 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
3324 2822a352 2019-10-15 stsp .Ar branch ,
3325 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
3326 2822a352 2019-10-15 stsp head commit of the integrated
3327 2822a352 2019-10-15 stsp .Ar branch .
3329 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
3330 2822a352 2019-10-15 stsp will be pointing at the same commit.
3331 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
3332 2822a352 2019-10-15 stsp In case the integrated
3333 2822a352 2019-10-15 stsp .Ar branch
3334 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
3335 2822a352 2019-10-15 stsp .Cm got branch -d .
3337 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
3338 2822a352 2019-10-15 stsp .Bl -column YXZ description
3339 2822a352 2019-10-15 stsp .It U Ta file was updated
3340 2822a352 2019-10-15 stsp .It D Ta file was deleted
3341 2822a352 2019-10-15 stsp .It A Ta new file was added
3342 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
3343 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
3346 2822a352 2019-10-15 stsp .Cm got integrate
3347 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
3348 2822a352 2019-10-15 stsp Most importantly, the
3349 2822a352 2019-10-15 stsp .Ar branch
3350 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
3351 2822a352 2019-10-15 stsp .Cm got rebase
3352 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
3353 2822a352 2019-10-15 stsp resolve merge conflicts.
3354 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3355 2822a352 2019-10-15 stsp to a single base commit with
3356 2822a352 2019-10-15 stsp .Cm got update .
3357 2822a352 2019-10-15 stsp If changes have been staged with
3358 2822a352 2019-10-15 stsp .Cm got stage ,
3359 2822a352 2019-10-15 stsp these changes must first be committed with
3360 2822a352 2019-10-15 stsp .Cm got commit
3361 2822a352 2019-10-15 stsp or unstaged with
3362 2822a352 2019-10-15 stsp .Cm got unstage .
3363 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
3364 2822a352 2019-10-15 stsp committed with
3365 2822a352 2019-10-15 stsp .Cm got commit
3366 2822a352 2019-10-15 stsp or reverted with
3367 2822a352 2019-10-15 stsp .Cm got revert .
3370 56c96eff 2022-08-30 thomas .Cm merge
3371 31009ade 2023-07-05 thomas .Op Fl aCcMn
3372 56c96eff 2022-08-30 thomas .Op Ar branch
3374 d912d125 2021-11-04 thomas .Dl Pq alias: Cm mg
3375 2b72f32d 2023-06-22 thomas Merge the specified
3376 2b72f32d 2023-06-22 thomas .Ar branch
3377 2b72f32d 2023-06-22 thomas into the current branch of the work tree.
3378 efba105a 2023-10-08 thomas If the branches have diverged, merge changes into the work tree
3379 efba105a 2023-10-08 thomas and create a merge commit.
3380 efba105a 2023-10-08 thomas Otherwise, if the specified
3381 2b72f32d 2023-06-22 thomas .Ar branch
3382 efba105a 2023-10-08 thomas is already based on the work tree's current branch, make the work tree's
3383 efba105a 2023-10-08 thomas current branch equivalent to the specified
3384 2b72f32d 2023-06-22 thomas .Ar branch
3385 efba105a 2023-10-08 thomas and update files in the work tree accordingly.
3387 10604dce 2021-09-24 thomas Merge commits are commits based on multiple parent commits.
3388 efba105a 2023-10-08 thomas The tip commit of the work tree's current branch will be used as the
3389 efba105a 2023-10-08 thomas first parent.
3390 10604dce 2021-09-24 thomas The tip commit of the specified
3391 10604dce 2021-09-24 thomas .Ar branch
3392 10604dce 2021-09-24 thomas will be used as the second parent.
3393 efba105a 2023-10-08 thomas The work tree's current branch
3394 efba105a 2023-10-08 thomas must be in the
3395 efba105a 2023-10-08 thomas .Dq refs/heads/
3396 efba105a 2023-10-08 thomas reference namespace and can be set with
3397 efba105a 2023-10-08 thomas .Cm got update -b
3398 efba105a 2023-10-08 thomas before starting the
3399 efba105a 2023-10-08 thomas .Cm merge
3400 efba105a 2023-10-08 thomas operation.
3402 768705e3 2021-09-27 thomas No ancestral relationship between the two branches is required.
3403 768705e3 2021-09-27 thomas If the two branches have already been merged previously, only new changes
3404 768705e3 2021-09-27 thomas will be merged.
3406 10604dce 2021-09-24 thomas It is not possible to create merge commits with more than two parents.
3407 10604dce 2021-09-24 thomas If more than one branch needs to be merged, then multiple merge commits
3408 10604dce 2021-09-24 thomas with two parents each can be created in sequence.
3410 efba105a 2023-10-08 thomas If a linear project history is desired, then use of
3411 efba105a 2023-10-08 thomas .Cm got rebase
3412 efba105a 2023-10-08 thomas should generally be preferred over
3413 efba105a 2023-10-08 thomas .Cm got merge .
3414 efba105a 2023-10-08 thomas However, even strictly linear projects may require occasional merge commits,
3415 efba105a 2023-10-08 thomas for example in order to merge in new versions of third-party code stored
3417 efba105a 2023-10-08 thomas .Dq vendor
3418 efba105a 2023-10-08 thomas branches created with
3419 efba105a 2023-10-08 thomas .Cm got import .
3421 10604dce 2021-09-24 thomas While merging changes found on the
3422 10604dce 2021-09-24 thomas .Ar branch
3423 10604dce 2021-09-24 thomas into the work tree, show the status of each affected file,
3424 10604dce 2021-09-24 thomas using the following status codes:
3425 10604dce 2021-09-24 thomas .Bl -column YXZ description
3426 10604dce 2021-09-24 thomas .It G Ta file was merged
3427 10604dce 2021-09-24 thomas .It C Ta file was merged and conflicts occurred during merge
3428 10604dce 2021-09-24 thomas .It ! Ta changes destined for a missing file were not merged
3429 10604dce 2021-09-24 thomas .It D Ta file was deleted
3430 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3431 10604dce 2021-09-24 thomas .It A Ta new file was added
3432 10604dce 2021-09-24 thomas .It \(a~ Ta changes destined for a non-regular file were not merged
3433 10604dce 2021-09-24 thomas .It ? Ta changes destined for an unversioned file were not merged
3436 10604dce 2021-09-24 thomas If merge conflicts occur, the merge operation is interrupted and conflicts
3437 10604dce 2021-09-24 thomas must be resolved before the merge operation can continue.
3438 8cf2970b 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
3439 8cf2970b 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
3440 10604dce 2021-09-24 thomas the merge operation will be interrupted to prevent potentially incomplete
3441 10604dce 2021-09-24 thomas changes from being committed to the repository without user intervention.
3442 10604dce 2021-09-24 thomas The work tree may be modified as desired and the merge can be continued
3443 10604dce 2021-09-24 thomas once the changes present in the work tree are considered complete.
3444 10604dce 2021-09-24 thomas Alternatively, the merge operation may be aborted which will leave
3445 10604dce 2021-09-24 thomas the work tree's current branch unmodified.
3447 10604dce 2021-09-24 thomas .Cm got merge
3448 10604dce 2021-09-24 thomas will refuse to run if certain preconditions are not met.
3449 4434a15a 2023-06-22 thomas If the work tree's current branch is not in the
3450 4434a15a 2023-06-22 thomas .Dq refs/heads/
3451 4434a15a 2023-06-22 thomas reference namespace then the work tree must first be switched to a
3452 4434a15a 2023-06-22 thomas branch in the
3453 4434a15a 2023-06-22 thomas .Dq refs/heads/
3454 4434a15a 2023-06-22 thomas namespace with
3455 4434a15a 2023-06-22 thomas .Cm got update -b .
3456 10604dce 2021-09-24 thomas If the work tree is not yet fully updated to the tip commit of its
3457 10604dce 2021-09-24 thomas branch, then the work tree must first be updated with
3458 10604dce 2021-09-24 thomas .Cm got update .
3459 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
3460 10604dce 2021-09-24 thomas to a single base commit with
3461 10604dce 2021-09-24 thomas .Cm got update .
3462 10604dce 2021-09-24 thomas If changes have been staged with
3463 10604dce 2021-09-24 thomas .Cm got stage ,
3464 10604dce 2021-09-24 thomas these changes must first be committed with
3465 10604dce 2021-09-24 thomas .Cm got commit
3466 10604dce 2021-09-24 thomas or unstaged with
3467 10604dce 2021-09-24 thomas .Cm got unstage .
3468 10604dce 2021-09-24 thomas If the work tree contains local changes, these changes must first be
3469 10604dce 2021-09-24 thomas committed with
3470 10604dce 2021-09-24 thomas .Cm got commit
3471 10604dce 2021-09-24 thomas or reverted with
3472 10604dce 2021-09-24 thomas .Cm got revert .
3474 10604dce 2021-09-24 thomas .Ar branch
3475 10604dce 2021-09-24 thomas contains changes to files outside of the work tree's path prefix,
3476 10604dce 2021-09-24 thomas the work tree cannot be used to merge this branch.
3479 10604dce 2021-09-24 thomas .Cm got update ,
3480 10604dce 2021-09-24 thomas .Cm got commit ,
3481 10604dce 2021-09-24 thomas .Cm got rebase ,
3482 ac93b2c5 2021-10-08 thomas .Cm got histedit ,
3483 10604dce 2021-09-24 thomas .Cm got integrate ,
3485 10604dce 2021-09-24 thomas .Cm got stage
3486 10604dce 2021-09-24 thomas commands will refuse to run while a merge operation is in progress.
3487 10604dce 2021-09-24 thomas Other commands which manipulate the work tree may be used for
3488 10604dce 2021-09-24 thomas conflict resolution purposes.
3490 10604dce 2021-09-24 thomas The options for
3491 10604dce 2021-09-24 thomas .Cm got merge
3492 10604dce 2021-09-24 thomas are as follows:
3493 10604dce 2021-09-24 thomas .Bl -tag -width Ds
3494 10604dce 2021-09-24 thomas .It Fl a
3495 10604dce 2021-09-24 thomas Abort an interrupted merge operation.
3496 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
3497 be94c032 2023-02-20 thomas .It Fl C
3498 be94c032 2023-02-20 thomas Allow a merge operation to continue with files in conflicted status.
3499 be94c032 2023-02-20 thomas This option should generally be avoided, and can only be used with the
3502 10604dce 2021-09-24 thomas .It Fl c
3503 10604dce 2021-09-24 thomas Continue an interrupted merge operation.
3504 dcd455ee 2023-07-05 thomas If this option is used, no other command-line arguments are allowed except
3506 31009ade 2023-07-05 thomas .It Fl M
3507 31009ade 2023-07-05 thomas Create a merge commit even if the branches have not diverged.
3508 ba34626b 2021-09-27 thomas .It Fl n
3509 ba34626b 2021-09-27 thomas Merge changes into the work tree as usual but do not create a merge
3510 ba34626b 2021-09-27 thomas commit immediately.
3511 ba34626b 2021-09-27 thomas The merge result can be adjusted as desired before a merge commit is
3512 ba34626b 2021-09-27 thomas created with
3513 ba34626b 2021-09-27 thomas .Cm got merge -c .
3514 ba34626b 2021-09-27 thomas Alternatively, the merge may be aborted with
3515 ba34626b 2021-09-27 thomas .Cm got merge -a .
3519 56c96eff 2022-08-30 thomas .Cm stage
3520 3779dc8f 2024-04-29 thomas .Op Fl lpS
3521 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
3522 56c96eff 2022-08-30 thomas .Op Ar path ...
3524 d912d125 2021-11-04 thomas .Dl Pq alias: Cm sg
3525 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
3528 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
3529 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
3530 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
3531 4ed9f614 2019-08-04 stsp .Cm got status .
3533 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3534 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
3535 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
3536 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
3537 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
3540 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
3541 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
3542 9d8b19a4 2019-08-04 stsp committed.
3544 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
3545 4ed9f614 2019-08-04 stsp .Cm got commit ,
3546 4ed9f614 2019-08-04 stsp .Cm got status ,
3548 4ed9f614 2019-08-04 stsp .Cm got diff .
3549 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
3550 4ed9f614 2019-08-04 stsp .Cm got commit
3551 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
3552 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
3553 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
3555 4ed9f614 2019-08-04 stsp .Cm got status
3556 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
3558 4ed9f614 2019-08-04 stsp .Cm got diff
3559 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
3560 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
3562 4ed9f614 2019-08-04 stsp .Cm got revert
3563 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
3564 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
3566 4ed9f614 2019-08-04 stsp The options for
3567 4ed9f614 2019-08-04 stsp .Cm got stage
3568 4ed9f614 2019-08-04 stsp are as follows:
3569 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
3570 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
3571 d6506a3d 2022-08-16 thomas With the
3573 d6506a3d 2022-08-16 thomas option, read
3578 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
3579 d6506a3d 2022-08-16 thomas .Ar response-script
3580 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
3582 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
3583 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
3584 4b06140e 2022-03-22 thomas If paths were provided on the command line, show the staged paths
3585 1dd86744 2019-08-12 anthony among the specified paths.
3586 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
3588 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
3589 dc424a06 2019-08-07 stsp select or reject changes for staging based on
3591 6d23ec10 2019-08-08 stsp (stage change),
3593 6d23ec10 2019-08-08 stsp (reject change), and
3595 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
3596 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
3597 dc424a06 2019-08-07 stsp modified file content can be staged.
3598 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
3599 6d23ec10 2019-08-08 stsp their entirety.
3601 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
3602 af358f55 2020-07-23 stsp that is under version control.
3603 af358f55 2020-07-23 stsp By default,
3604 af358f55 2020-07-23 stsp .Cm got stage
3605 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
3606 35213c7c 2020-07-23 stsp As a precaution,
3608 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
3609 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
3610 af358f55 2020-07-23 stsp points outside of the work tree.
3611 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
3612 af358f55 2020-07-23 stsp .Dq make obj
3613 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
3614 af358f55 2020-07-23 stsp version control.
3617 4ed9f614 2019-08-04 stsp .Cm got stage
3618 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
3619 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
3620 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
3621 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
3622 4ed9f614 2019-08-04 stsp .Cm got update
3623 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
3624 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
3627 4ed9f614 2019-08-04 stsp .Cm got update ,
3628 4ed9f614 2019-08-04 stsp .Cm got rebase ,
3629 1a70a207 2023-07-05 thomas .Cm got merge ,
3631 4ed9f614 2019-08-04 stsp .Cm got histedit
3632 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
3633 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
3634 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
3635 4ed9f614 2019-08-04 stsp .Cm got unstage
3636 4ed9f614 2019-08-04 stsp before it can be updated with
3637 4ed9f614 2019-08-04 stsp .Cm got update ,
3638 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
3641 56c96eff 2022-08-30 thomas .Cm unstage
3642 3779dc8f 2024-04-29 thomas .Op Fl p
3643 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
3644 56c96eff 2022-08-30 thomas .Op Ar path ...
3646 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ug
3647 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
3648 4ed9f614 2019-08-04 stsp back into non-staged status.
3651 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
3652 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
3654 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3655 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
3656 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
3657 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
3658 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
3659 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
3660 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3661 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3664 2e1f37b0 2019-08-08 stsp The options for
3665 2e1f37b0 2019-08-08 stsp .Cm got unstage
3666 2e1f37b0 2019-08-08 stsp are as follows:
3667 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
3668 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
3669 d6506a3d 2022-08-16 thomas With the
3671 d6506a3d 2022-08-16 thomas option, read
3676 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
3677 d6506a3d 2022-08-16 thomas .Ar response-script
3678 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
3680 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
3681 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
3683 2e1f37b0 2019-08-08 stsp (unstage change),
3685 2e1f37b0 2019-08-08 stsp (keep change staged), and
3687 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
3688 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
3689 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
3690 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
3694 56c96eff 2022-08-30 thomas .Op Fl P
3695 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
3696 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
3697 56c96eff 2022-08-30 thomas .Ar arg ...
3699 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3700 896e9b6f 2019-08-26 stsp text format.
3701 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3702 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3703 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3705 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3706 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3707 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3708 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3709 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3710 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3712 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3714 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3715 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3717 01073a5d 2019-08-22 stsp The options for
3718 01073a5d 2019-08-22 stsp .Cm got cat
3719 01073a5d 2019-08-22 stsp are as follows:
3720 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3721 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3722 896e9b6f 2019-08-26 stsp Look up paths in the specified
3723 896e9b6f 2019-08-26 stsp .Ar commit .
3724 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3725 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3727 9f625d2d 2023-07-19 thomas The expected argument is a commit ID SHA1 hash, or a reference name
3728 9f625d2d 2023-07-19 thomas or keyword which will be resolved to a commit ID.
3729 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3730 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3731 9f625d2d 2023-07-19 thomas The keywords
3732 3795e2b6 2023-07-19 thomas .Qq :base
3734 3795e2b6 2023-07-19 thomas .Qq :head
3735 9f625d2d 2023-07-19 thomas resolve to the work tree's base commit and branch head, respectively.
3736 3795e2b6 2023-07-19 thomas The former is only valid if invoked in a work tree, while the latter will
3737 3795e2b6 2023-07-19 thomas resolve to the tip of the work tree's current branch if invoked in a
3738 3795e2b6 2023-07-19 thomas work tree, otherwise it will resolve to the repository's HEAD reference.
3739 3795e2b6 2023-07-19 thomas Keywords and references may be appended with
3743 3795e2b6 2023-07-19 thomas modifiers and an optional integer N to denote the
3744 3795e2b6 2023-07-19 thomas Nth descendant or antecedent by first parent traversal, respectively;
3745 3795e2b6 2023-07-19 thomas for example,
3746 3795e2b6 2023-07-19 thomas .Sy :head:-2
3747 3795e2b6 2023-07-19 thomas denotes the work tree branch head's 2nd generation ancestor, and
3748 3795e2b6 2023-07-19 thomas .Sy :base:+4
3749 3795e2b6 2023-07-19 thomas denotes the 4th generation descendant of the work tree's base commit.
3750 3795e2b6 2023-07-19 thomas Similarly,
3751 3795e2b6 2023-07-19 thomas .Sy quux:-8
3752 3795e2b6 2023-07-19 thomas will denote the 8th generation ancestor of the commit resolved by the
3753 3795e2b6 2023-07-19 thomas .Qq quux
3754 3795e2b6 2023-07-19 thomas reference.
3759 3795e2b6 2023-07-19 thomas modifier without a trailing integer has an implicit
3761 3795e2b6 2023-07-19 thomas appended
3762 3795e2b6 2023-07-19 thomas .Po e.g.,
3763 3795e2b6 2023-07-19 thomas .Sy :base:+
3764 3795e2b6 2023-07-19 thomas is equivalent to
3765 3795e2b6 2023-07-19 thomas .Sy :base:+1
3767 d6506a3d 2022-08-16 thomas .It Fl P
3768 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
3769 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
3770 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
3771 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3772 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3773 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3774 01073a5d 2019-08-22 stsp working directory.
3775 01073a5d 2019-08-22 stsp If this directory is a
3777 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3779 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3780 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3782 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3783 b2118c49 2020-07-28 stsp for details.
3785 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3786 b2118c49 2020-07-28 stsp current working directory.
3788 b2118c49 2020-07-28 stsp If one or more
3790 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3791 b2118c49 2020-07-28 stsp files located at or within these paths.
3794 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3795 b2118c49 2020-07-28 stsp for all tracked files.
3797 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3798 5daf5c53 2022-07-23 thomas .Bl -tag -width GOT_IGNORE_GITCONFIG
3799 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3800 d4dddcbf 2022-07-22 thomas The author's name and email address, such as
3801 1d84e082 2024-01-26 thomas .Qq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3802 d4dddcbf 2022-07-22 thomas Used by the
3803 d4dddcbf 2022-07-22 thomas .Cm got commit ,
3804 d4dddcbf 2022-07-22 thomas .Cm got import ,
3805 d4dddcbf 2022-07-22 thomas .Cm got rebase ,
3806 1a70a207 2023-07-05 thomas .Cm got merge ,
3808 d4dddcbf 2022-07-22 thomas .Cm got histedit
3809 d4dddcbf 2022-07-22 thomas commands.
3812 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3814 84792843 2019-08-09 stsp attempts to reject
3815 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3816 84792843 2019-08-09 stsp environment variables with a missing email address.
3818 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3819 50b0790e 2020-09-11 stsp .Xr got.conf 5
3820 50b0790e 2020-09-11 stsp or by Git's
3821 aba9c984 2019-09-08 stsp .Dv user.name
3823 709ae9eb 2019-09-08 stsp .Dv user.email
3824 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3825 aba9c984 2019-09-08 stsp .Pa .git/config
3828 c9956ddf 2019-09-08 stsp .Dv user.name
3830 c9956ddf 2019-09-08 stsp .Dv user.email
3831 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3832 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3833 257add31 2020-09-09 stsp configuration file will only be used if neither
3834 257add31 2020-09-09 stsp .Xr got.conf 5
3836 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3837 257add31 2020-09-09 stsp environment variable provide author information.
3838 bd15e874 2023-01-20 thomas .It Ev GOT_IGNORE_GITCONFIG
3839 bd15e874 2023-01-20 thomas If this variable is set then any remote repository definitions or author
3840 bd15e874 2023-01-20 thomas information found in Git configuration files will be ignored.
3841 bd15e874 2023-01-20 thomas .It Ev GOT_LOG_DEFAULT_LIMIT
3842 bd15e874 2023-01-20 thomas The default limit on the number of commits traversed by
3843 bd15e874 2023-01-20 thomas .Cm got log .
3844 bd15e874 2023-01-20 thomas If set to zero, the limit is unbounded.
3845 bd15e874 2023-01-20 thomas This variable will be silently ignored if it is set to a non-numeric value.
3846 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3847 23594da9 2019-05-13 stsp The editor spawned by
3848 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3849 46215d2a 2020-09-11 stsp .Cm got histedit ,
3850 8e7bd50a 2019-08-22 stsp .Cm got import ,
3852 8e7bd50a 2019-08-22 stsp .Cm got tag .
3853 5b735925 2020-09-15 stsp If not set, the
3854 f8da67e8 2023-03-01 thomas .Xr vi 1
3855 f8da67e8 2023-03-01 thomas text editor will be spawned.
3858 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3859 257add31 2020-09-09 stsp .It Pa got.conf
3860 257add31 2020-09-09 stsp Repository-wide configuration settings for
3862 50b0790e 2020-09-11 stsp If present, a
3863 50b0790e 2020-09-11 stsp .Xr got.conf 5
3864 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3865 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3866 257add31 2020-09-09 stsp .Pa config
3869 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3870 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3872 50b0790e 2020-09-11 stsp If present, a
3873 1795b260 2021-04-02 kn .Xr got.conf 5
3874 50b0790e 2020-09-11 stsp configuration file in the
3876 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3877 50b0790e 2020-09-11 stsp the repository's
3878 50b0790e 2020-09-11 stsp .Xr got.conf 5
3879 50b0790e 2020-09-11 stsp configuration file and Git's
3880 50b0790e 2020-09-11 stsp .Pa config
3883 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3884 5c860e29 2018-03-12 stsp .Ex -std got
3885 97925469 2018-03-17 stsp .Sh EXAMPLES
3886 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3888 43e4eb1b 2021-08-29 stsp command names in
3889 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3891 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3893 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3896 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3897 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3899 f357763f 2023-06-22 thomas Unfortunately, many of the popular Git hosting sites do not offer anonymous
3900 f357763f 2023-06-22 thomas access via SSH.
3901 f357763f 2023-06-22 thomas Such sites will require an account to be created, and a public SSH key to be
3902 f357763f 2023-06-22 thomas uploaded to this account, before repository access via ssh:// URLs will work.
3904 cda0eee6 2024-04-25 thomas.ad Most sites offer anonymous repository access via HTTPS:
3906 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3907 cda0eee6 2024-04-25 thomas.ad .Dl $ got clone https://github.com/openbsd/src.git
3909 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3911 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3912 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3913 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3915 6becd179 2024-06-03 thomas .Dl $ got init /var/git/src.git
3916 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3918 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3920 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3922 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3924 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3926 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3928 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3930 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3932 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3934 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3936 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3938 7fc94106 2023-01-14 thomas As above, but list the most recently modified branches only:
3940 7fc94106 2023-01-14 thomas .Dl $ got branch -lt | head
3942 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3943 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3944 d83d9d5c 2019-05-13 stsp which is forked off the
3945 d83d9d5c 2019-05-13 stsp .Dq master
3948 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3950 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3951 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3952 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3954 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3956 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3957 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3959 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3961 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3962 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3963 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3965 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3967 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3968 04e9dcf3 2020-04-18 stsp .Xr patch 1
3969 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3971 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3973 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3975 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3977 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3978 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3979 5b666081 2020-02-24 stsp .Pa sys/uvm :
3981 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3983 5b666081 2020-02-24 stsp And this command has the same effect:
3985 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3987 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3989 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3990 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3992 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3994 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3995 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3997 b920a2b2 2024-05-06 thomas.ad A file can be renamed or moved by removing it from its old location
3998 b920a2b2 2024-05-06 thomas.ad and adding it at the new location:
4000 b920a2b2 2024-05-06 thomas.ad .Dl $ cp oldfile.c newfile.c
4001 b920a2b2 2024-05-06 thomas.ad .Dl $ got remove oldfile.c
4002 b920a2b2 2024-05-06 thomas.ad .Dl $ got add newfile.c
4005 b920a2b2 2024-05-06 thomas.ad does not yet follow file history across renames, but
4006 b920a2b2 2024-05-06 thomas.ad .Xr git 1
4007 b920a2b2 2024-05-06 thomas.ad will be able to do so regardless.
4009 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
4010 e70c17ce 2019-05-22 stsp with a pre-defined log message.
4012 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
4014 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
4015 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
4016 1795b260 2021-04-02 kn .Pa /tmp/msg :
4018 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
4020 95fc3404 2019-07-15 stsp Update any work tree checked out from the
4021 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
4022 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
4024 95fc3404 2019-07-15 stsp .Dl $ got update
4026 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
4027 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
4028 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
4030 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
4031 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
4032 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
4033 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
4035 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
4036 a099809f 2021-08-27 stsp .Dq master
4037 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
4038 469dd726 2020-03-20 stsp .Dq origin/master
4041 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
4042 469dd726 2020-03-20 stsp .Dl $ got fetch
4044 469dd726 2020-03-20 stsp Rebase the local
4045 469dd726 2020-03-20 stsp .Dq master
4046 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
4047 469dd726 2020-03-20 stsp .Dq origin/master
4050 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
4051 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
4052 469dd726 2020-03-20 stsp .Dl $ got rebase master
4054 fa6e0e48 2019-05-23 stsp Rebase the
4055 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
4056 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
4057 fa6e0e48 2019-05-23 stsp .Dq master
4060 818c7501 2019-07-11 stsp .Dl $ got update -b master
4061 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
4063 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
4064 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
4065 1dd86744 2019-08-12 anthony .Ox Ns 's
4066 1dd86744 2019-08-12 anthony CVS tree:
4068 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
4070 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
4071 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
4074 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
4075 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
4076 0ebf8283 2019-07-24 stsp .Dl $ got histedit
4078 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
4079 469dd726 2020-03-20 stsp .Cm git clone --bare
4080 7848a0e1 2020-03-19 stsp instead of
4081 7848a0e1 2020-03-19 stsp .Cm got clone ,
4083 ff2cf171 2019-07-28 stsp .Dq refspec
4084 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
4086 ff2cf171 2019-07-28 stsp .Dq refs/remotes
4087 ff2cf171 2019-07-28 stsp namespace of the local repository.
4088 1795b260 2021-04-02 kn This can be achieved by setting Git's
4089 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
4090 ff2cf171 2019-07-28 stsp configuration variable to the value
4091 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
4093 ff2cf171 2019-07-28 stsp .Cm git config
4096 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
4097 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
4099 469dd726 2020-03-20 stsp Additionally, the
4100 469dd726 2020-03-20 stsp .Dq mirror
4101 469dd726 2020-03-20 stsp option must be disabled:
4103 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
4104 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
4106 ff2cf171 2019-07-28 stsp Alternatively, the following
4107 469dd726 2020-03-20 stsp .Xr git-fetch 1
4108 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
4109 ff2cf171 2019-07-28 stsp .Pa config
4112 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
4113 ff2cf171 2019-07-28 stsp .Dl url = ...
4114 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4115 469dd726 2020-03-20 stsp .Dl mirror = false
4117 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
4118 ff2cf171 2019-07-28 stsp .Dq refs/heads
4119 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
4120 ff2cf171 2019-07-28 stsp .Cm got checkout
4121 ff2cf171 2019-07-28 stsp and, if needed, created with
4122 ff2cf171 2019-07-28 stsp .Cm got branch .
4123 ff2cf171 2019-07-28 stsp Branches in the
4124 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
4125 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
4126 ff2cf171 2019-07-28 stsp repository with
4127 469dd726 2020-03-20 stsp .Cm got fetch
4129 469dd726 2020-03-20 stsp .Xr git-fetch 1
4130 a099809f 2021-08-27 stsp without extra command line arguments.
4131 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
4132 a099809f 2021-08-27 stsp .Cm got log .
4134 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
4135 ff2cf171 2019-07-28 stsp .Dq master
4136 a099809f 2021-08-27 stsp branch, as of the last time
4137 a099809f 2021-08-27 stsp .Cm got fetch
4140 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
4142 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
4143 ff2cf171 2019-07-28 stsp .Dq origin/master
4144 a099809f 2021-08-27 stsp instead of
4145 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
4146 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
4148 a099809f 2021-08-27 stsp .Cm got rebase
4149 1fa75a87 2023-06-22 thomas can be used to merge changes which are visible on the
4150 a099809f 2021-08-27 stsp .Dq origin/master
4151 a099809f 2021-08-27 stsp branch into the
4152 a099809f 2021-08-27 stsp .Dq master
4154 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
4156 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
4157 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
4159 a099809f 2021-08-27 stsp In order to make changes committed to the
4160 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4161 a099809f 2021-08-27 stsp visible on the
4162 a099809f 2021-08-27 stsp .Dq master
4163 a099809f 2021-08-27 stsp branch, the
4164 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4165 1fa75a87 2023-06-22 thomas branch can be rebased onto the
4166 a099809f 2021-08-27 stsp .Dq master
4169 a099809f 2021-08-27 stsp .Dl $ got update -b master
4170 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
4172 a099809f 2021-08-27 stsp Changes on the
4173 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4174 a099809f 2021-08-27 stsp branch can now be made visible on the
4175 a099809f 2021-08-27 stsp .Dq master
4176 a099809f 2021-08-27 stsp branch with
4177 a099809f 2021-08-27 stsp .Cm got integrate .
4178 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
4179 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4180 4b06140e 2022-03-22 thomas branch, the work tree must be switched back to the
4181 a099809f 2021-08-27 stsp .Dq master
4182 a099809f 2021-08-27 stsp branch first:
4184 a099809f 2021-08-27 stsp .Dl $ got update -b master
4185 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
4188 083957f4 2020-02-24 stsp .Dq master
4189 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
4191 083957f4 2020-02-24 stsp by other developers and any other important new information:
4193 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
4194 083957f4 2020-02-24 stsp .Dl $ got histedit -m
4196 4b06140e 2022-03-22 thomas If the remote repository offers write access, local changes on the
4197 ff2cf171 2019-07-28 stsp .Dq master
4198 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
4199 ac93b2c5 2021-10-08 thomas .Cm got send .
4200 ac93b2c5 2021-10-08 thomas Usually,
4201 a099809f 2021-08-27 stsp .Cm got send
4202 a099809f 2021-08-27 stsp can be run without further arguments.
4203 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
4204 a099809f 2021-08-27 stsp current branch is the
4205 a099809f 2021-08-27 stsp .Dq master
4208 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
4210 4b06140e 2022-03-22 thomas If the remote repository requires the HTTPS protocol, the
4211 a099809f 2021-08-27 stsp .Xr git-push 1
4212 a099809f 2021-08-27 stsp command must be used instead:
4214 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
4215 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
4217 4ff74dcf 2022-07-20 thomas When making contributions to projects which use the
4218 4ff74dcf 2022-07-20 thomas .Dq pull request
4219 4ff74dcf 2022-07-20 thomas workflow, SSH protocol repository access needs to be set up first.
4220 4ff74dcf 2022-07-20 thomas Once an account has been created on a Git hosting site it should
4221 4ff74dcf 2022-07-20 thomas be possible to upload a public SSH key for repository access
4222 4ff74dcf 2022-07-20 thomas authentication.
4225 4ff74dcf 2022-07-20 thomas .Dq pull request
4226 4ff74dcf 2022-07-20 thomas workflow will usually involve two remote repositories.
4227 4ff74dcf 2022-07-20 thomas In the real-life example below, the
4228 4ff74dcf 2022-07-20 thomas .Dq origin
4229 4ff74dcf 2022-07-20 thomas repository was forked from the
4230 4ff74dcf 2022-07-20 thomas .Dq upstream
4231 4ff74dcf 2022-07-20 thomas repository by using the Git hosting site's web interface.
4233 4ff74dcf 2022-07-20 thomas .Xr got.conf 5
4234 4ff74dcf 2022-07-20 thomas file in the local repository describes both remote repositories:
4235 4ff74dcf 2022-07-20 thomas .Bd -literal -offset indent
4236 4ff74dcf 2022-07-20 thomas # Jelmers's repository, which accepts pull requests
4237 4ff74dcf 2022-07-20 thomas remote "upstream" {
4238 4ff74dcf 2022-07-20 thomas server git@github.com
4239 4ff74dcf 2022-07-20 thomas protocol ssh
4240 4ff74dcf 2022-07-20 thomas repository "/jelmer/dulwich"
4241 4ff74dcf 2022-07-20 thomas branch { "master" }
4244 4ff74dcf 2022-07-20 thomas # Stefan's fork, used as the default remote repository
4245 4ff74dcf 2022-07-20 thomas remote "origin" {
4246 4ff74dcf 2022-07-20 thomas server git@github.com
4247 4ff74dcf 2022-07-20 thomas protocol ssh
4248 4ff74dcf 2022-07-20 thomas repository "/stspdotname/dulwich"
4249 4ff74dcf 2022-07-20 thomas branch { "master" }
4253 4ff74dcf 2022-07-20 thomas With this configuration, Stefan can create commits on
4254 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master
4255 4ff74dcf 2022-07-20 thomas and send them to the
4256 4ff74dcf 2022-07-20 thomas .Dq origin
4257 4ff74dcf 2022-07-20 thomas repository by running:
4259 4ff74dcf 2022-07-20 thomas .Dl $ got send -b master origin
4261 4ff74dcf 2022-07-20 thomas The changes can now be proposed to Jelmer by opening a pull request
4262 4ff74dcf 2022-07-20 thomas via the Git hosting site's web interface.
4263 4ff74dcf 2022-07-20 thomas If Jelmer requests further changes to be made, additional commits
4264 4ff74dcf 2022-07-20 thomas can be created on the
4265 4ff74dcf 2022-07-20 thomas .Dq master
4266 4ff74dcf 2022-07-20 thomas branch and be added to the pull request by running
4267 4ff74dcf 2022-07-20 thomas .Cd got send
4270 4ff74dcf 2022-07-20 thomas If Jelmer prefers additional commits to be
4271 4ff74dcf 2022-07-20 thomas .Dq squashed
4272 4ff74dcf 2022-07-20 thomas then the following commands can be used to achieve this:
4274 4ff74dcf 2022-07-20 thomas .Dl $ got update -b master
4275 4ff74dcf 2022-07-20 thomas .Dl $ got update -c origin/master
4276 4ff74dcf 2022-07-20 thomas .Dl $ got histedit -f
4277 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
4279 f2afb89d 2023-04-22 thomas In addition to reviewing the pull request in the web user interface,
4280 f2afb89d 2023-04-22 thomas Jelmer can fetch the pull request's branch into his local repository
4281 f2afb89d 2023-04-22 thomas and create a local branch which contains the proposed changes:
4283 f2afb89d 2023-04-22 thomas .Dl $ got fetch -R refs/pull/1046/head origin
4284 f2afb89d 2023-04-22 thomas .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4286 4ff74dcf 2022-07-20 thomas Once Jelmer has accepted the pull request, Stefan can fetch the
4287 4ff74dcf 2022-07-20 thomas merged changes, and possibly several other new changes, by running:
4289 4ff74dcf 2022-07-20 thomas .Dl $ got fetch upstream
4291 4ff74dcf 2022-07-20 thomas The merged changes will now be visible under the reference
4292 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master .
4293 4ff74dcf 2022-07-20 thomas The local
4294 4ff74dcf 2022-07-20 thomas .Dq master
4295 4ff74dcf 2022-07-20 thomas branch can now be rebased on top of the latest changes
4296 4ff74dcf 2022-07-20 thomas from upstream:
4298 4ff74dcf 2022-07-20 thomas .Dl $ got update -b upstream/master
4299 4ff74dcf 2022-07-20 thomas .Dl $ got rebase master
4301 0b83b8f6 2023-06-22 thomas As an alternative to
4302 0b83b8f6 2023-06-22 thomas .Cm got rebase ,
4303 0b83b8f6 2023-06-22 thomas branches can be merged with
4304 0b83b8f6 2023-06-22 thomas .Cm got merge :
4306 0b83b8f6 2023-06-22 thomas .Dl $ got update -b master
4307 0b83b8f6 2023-06-22 thomas .Dl $ got merge upstream/master
4309 0b83b8f6 2023-06-22 thomas The question of whether to rebase or merge branches is philosophical.
4310 0b83b8f6 2023-06-22 thomas When in doubt, refer to the software project's policies set by project
4311 0b83b8f6 2023-06-22 thomas maintainers.
4313 4ff74dcf 2022-07-20 thomas As a final step, the forked repository's copy of the master branch needs
4314 4ff74dcf 2022-07-20 thomas to be kept in sync by sending the new changes there:
4316 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
4318 4ff74dcf 2022-07-20 thomas If multiple pull requests need to be managed in parallel, a separate branch
4319 4ff74dcf 2022-07-20 thomas must be created for each pull request with
4320 4ff74dcf 2022-07-20 thomas .Cm got branch .
4321 4ff74dcf 2022-07-20 thomas Each such branch can then be used as above, in place of
4322 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master .
4323 4ff74dcf 2022-07-20 thomas Changes for any accepted pull requests will still appear under
4324 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master,
4325 4ff74dcf 2022-07-20 thomas regardless of which branch was used in the forked repository to
4326 4ff74dcf 2022-07-20 thomas create a pull request.
4327 5c860e29 2018-03-12 stsp .Sh SEE ALSO
4328 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
4329 2312fc47 2019-07-15 stsp .Xr tog 1 ,
4330 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
4331 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
4332 b345cf8f 2022-07-05 thomas .Xr got.conf 5 ,
4333 85c360aa 2023-01-02 thomas .Xr gotwebd 8
4334 1a208aaf 2018-04-01 stsp .Sh AUTHORS
4335 60c73080 2022-07-05 thomas .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4336 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
4337 60c73080 2022-07-05 thomas .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4338 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
4339 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
4340 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
4341 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
4342 f6fad9f6 2022-07-05 thomas .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4343 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
4344 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
4345 60c73080 2022-07-05 thomas .An Sebastien Marie Aq Mt semarie@openbsd.org
4346 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
4347 bee5044f 2022-07-05 thomas .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4348 60c73080 2022-07-05 thomas .An Theo Buehler Aq Mt tb@openbsd.org
4349 60c73080 2022-07-05 thomas .An Thomas Adam Aq Mt thomas@xteddy.org
4350 60c73080 2022-07-05 thomas .An Tracey Emery Aq Mt tracey@traceyemery.net
4351 60c73080 2022-07-05 thomas .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4353 de71b616 2022-07-05 thomas Parts of
4355 de71b616 2022-07-05 thomas .Xr tog 1 ,
4357 85c360aa 2023-01-02 thomas .Xr gotwebd 8
4358 de71b616 2022-07-05 thomas were derived from code under copyright by:
4360 408db73d 2022-07-22 thomas .An Caldera International
4361 de71b616 2022-07-05 thomas .An Daniel Hartmeier
4362 de71b616 2022-07-05 thomas .An Esben Norby
4363 de71b616 2022-07-05 thomas .An Henning Brauer
4364 de71b616 2022-07-05 thomas .An Håkan Olsson
4365 de71b616 2022-07-05 thomas .An Ingo Schwarze
4366 de71b616 2022-07-05 thomas .An Jean-Francois Brousseau
4367 de71b616 2022-07-05 thomas .An Joris Vink
4368 de71b616 2022-07-05 thomas .An Jyri J. Virkki
4369 de71b616 2022-07-05 thomas .An Larry Wall
4370 408db73d 2022-07-22 thomas .An Markus Friedl
4371 de71b616 2022-07-05 thomas .An Niall O'Higgins
4372 de71b616 2022-07-05 thomas .An Niklas Hallqvist
4373 de71b616 2022-07-05 thomas .An Ray Lai
4374 de71b616 2022-07-05 thomas .An Ryan McBride
4375 de71b616 2022-07-05 thomas .An Theo de Raadt
4376 de71b616 2022-07-05 thomas .An Todd C. Miller
4377 de71b616 2022-07-05 thomas .An Xavier Santolaria
4380 e4badaa9 2022-07-05 thomas contains code contributed to the public domain by
4381 86f8a176 2022-12-30 thomas .An Austin Appleby .
4382 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
4384 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
4386 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
4388 cc63216e 2020-12-26 stsp to perform some tasks.
4389 cc63216e 2020-12-26 stsp In particular:
4390 cc63216e 2020-12-26 stsp .Bl -bullet
4392 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
4393 cc63216e 2020-12-26 stsp .Xr git-push 1 .
4395 22a38a43 2021-09-28 thomas The creation of merge commits with more than two parent commits requires
4396 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
4398 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
4400 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
4402 cc63216e 2020-12-26 stsp will usually produce better results.
