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 .
52 285dc8a4 2018-03-13 stsp provides global and command-specific options.
53 bc3056e3 2019-08-18 stsp Global options must precede the command name, and are as follows:
54 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
56 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
57 1795b260 2021-04-02 kn .It Fl V , -version
58 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
61 38e11793 2018-06-13 stsp The commands for
63 38e11793 2018-06-13 stsp are as follows:
64 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
68 5fc4f020 2022-08-30 op .Op Fl b Ar branch
69 5fc4f020 2022-08-30 op .Op Fl I Ar pattern
70 5fc4f020 2022-08-30 op .Op Fl m Ar message
71 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
74 4683a10b 2021-11-04 kn .Dl Pq alias: Cm im
75 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
76 3ce1b845 2019-07-15 stsp within the specified
77 3ce1b845 2019-07-15 stsp .Ar directory .
78 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
79 3ce1b845 2019-07-15 stsp root commit.
80 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
81 3ce1b845 2019-07-15 stsp created commit.
82 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
85 21a44f98 2019-07-15 stsp .Cm got import
86 21a44f98 2019-07-15 stsp command requires the
87 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
88 aba9c984 2019-09-08 stsp environment variable to be set,
89 257add31 2020-09-09 stsp unless an author has been configured in
90 257add31 2020-09-09 stsp .Xr got.conf 5
92 aba9c984 2019-09-08 stsp .Dv user.name
94 709ae9eb 2019-09-08 stsp .Dv user.email
95 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
96 aba9c984 2019-09-08 stsp .Pa .git/config
97 c9956ddf 2019-09-08 stsp file or from Git's global
98 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
99 c9956ddf 2019-09-08 stsp configuration file.
101 3ce1b845 2019-07-15 stsp The options for
102 3ce1b845 2019-07-15 stsp .Cm got import
103 3ce1b845 2019-07-15 stsp are as follows:
104 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
105 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
106 3ce1b845 2019-07-15 stsp Create the specified
107 6f04a73d 2022-09-20 mark .Ar branch .
108 6f04a73d 2022-09-20 mark If this option is not specified, a branch corresponding to the repository's
109 6f04a73d 2022-09-20 mark HEAD reference will be used.
110 6f04a73d 2022-09-20 mark Use of this option is required if the branch resolved via the repository's
111 6f04a73d 2022-09-20 mark HEAD reference already exists.
112 827a167b 2022-08-16 stsp .It Fl I Ar pattern
113 827a167b 2022-08-16 stsp Ignore files or directories with a name which matches the specified
114 827a167b 2022-08-16 stsp .Ar pattern .
115 827a167b 2022-08-16 stsp This option may be specified multiple times to build a list of ignore patterns.
117 827a167b 2022-08-16 stsp .Ar pattern
118 827a167b 2022-08-16 stsp follows the globbing rules documented in
119 827a167b 2022-08-16 stsp .Xr glob 7 .
120 49351f3b 2023-02-06 stsp Ignore patterns which end with a slash,
122 49351f3b 2023-02-06 stsp will only match directories.
123 3ce1b845 2019-07-15 stsp .It Fl m Ar message
124 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
125 3ce1b845 2019-07-15 stsp Without the
128 3ce1b845 2019-07-15 stsp .Cm got import
129 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
130 ee27b57e 2023-07-15 naddy Quitting the editor without saving the file will abort the import operation.
131 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
132 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
133 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
134 3ce1b845 2019-07-15 stsp working directory.
140 5fc4f020 2022-08-30 op .Op Fl b Ar branch
141 5fc4f020 2022-08-30 op .Op Fl R Ar reference
142 5fc4f020 2022-08-30 op .Ar repository-URL
143 5fc4f020 2022-08-30 op .Op Ar directory
145 4683a10b 2021-11-04 kn .Dl Pq alias: Cm cl
146 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
147 2ab43947 2020-03-18 stsp .Ar repository-URL
148 2ab43947 2020-03-18 stsp into the specified
149 3493b628 2020-03-20 stsp .Ar directory .
151 3493b628 2020-03-20 stsp .Ar directory
152 e38d4cde 2022-03-21 naddy is specified, the directory name will be derived from the name of the
153 2ab43947 2020-03-18 stsp cloned repository.
154 2ab43947 2020-03-18 stsp .Cm got clone
155 2ab43947 2020-03-18 stsp will refuse to run if the
156 3493b628 2020-03-20 stsp .Ar directory
157 2ab43947 2020-03-18 stsp already exists.
160 2ab43947 2020-03-18 stsp .Ar repository-URL
161 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
162 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
163 619eb6dd 2020-03-20 stsp the server:
164 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
166 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
167 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
169 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
170 2ab43947 2020-03-18 stsp .Xr git-daemon 1
172 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
173 10c073e7 2020-03-20 stsp nor encryption.
174 2ab43947 2020-03-18 stsp .It git+ssh
175 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
178 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
181 2ab43947 2020-03-18 stsp .Mt user@hostname
183 2ab43947 2020-03-18 stsp Short alias for git+ssh.
186 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
187 89c3c67b 2020-03-20 stsp from the server.
188 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
190 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
191 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
192 89c3c67b 2020-03-20 stsp This can take some time.
193 010f7279 2020-03-20 stsp More details about the pack file format are documented in
194 010f7279 2020-03-20 stsp .Xr git-repository 5 .
196 7848a0e1 2020-03-19 stsp .Cm got clone
197 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
198 257add31 2020-09-09 stsp .Xr got.conf 5
201 257add31 2020-09-09 stsp files of the cloned repository to store the
202 7848a0e1 2020-03-19 stsp .Ar repository-url
206 99495ddb 2021-01-10 stsp .Ar reference
207 132af4a5 2021-01-05 stsp arguments for future use by
208 7848a0e1 2020-03-19 stsp .Cm got fetch
210 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
212 2ab43947 2020-03-18 stsp The options for
213 2ab43947 2020-03-18 stsp .Cm got clone
214 2ab43947 2020-03-18 stsp are as follows:
215 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
217 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
218 1d4b192f 2020-03-21 stsp .Dq refs/heads/
219 5aa20203 2021-01-05 stsp reference namespace and set
220 f1bf60d1 2022-07-03 stsp .Cm fetch_all_branches
221 5aa20203 2021-01-05 stsp in the cloned repository's
222 5aa20203 2021-01-05 stsp .Xr got.conf 5
223 5aa20203 2021-01-05 stsp file for future use by
224 5aa20203 2021-01-05 stsp .Cm got fetch .
225 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
226 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
227 4ba14133 2020-03-20 stsp Cannot be used together with the
230 4ba14133 2020-03-20 stsp .It Fl b Ar branch
231 4ba14133 2020-03-20 stsp Fetch the specified
233 1d4b192f 2020-03-21 stsp from the remote repository's
234 1d4b192f 2020-03-21 stsp .Dq refs/heads/
235 1d4b192f 2020-03-21 stsp reference namespace.
236 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
238 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
239 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
240 4ba14133 2020-03-20 stsp branch which was fetched.
241 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
242 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
243 4ba14133 2020-03-20 stsp Cannot be used together with the
247 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
248 41b0de12 2020-03-21 stsp and exit immediately.
249 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
254 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
255 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
256 bd81cfb7 2020-04-19 stsp locally created commits.
258 469dd726 2020-03-20 stsp The repository's
259 257add31 2020-09-09 stsp .Xr got.conf 5
262 257add31 2020-09-09 stsp files will be set up with the
264 469dd726 2020-03-20 stsp option enabled, such that
265 469dd726 2020-03-20 stsp .Cm got fetch
267 469dd726 2020-03-20 stsp .Xr git-fetch 1
268 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
269 469dd726 2020-03-20 stsp .Dq refs/heads/
270 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
271 469dd726 2020-03-20 stsp .Dq refs/remotes/
273 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
274 469dd726 2020-03-20 stsp .Cm got rebase
276 7b53188e 2023-07-03 stsp .Cm got merge
278 469dd726 2020-03-20 stsp .Cm got fetch
279 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
280 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
282 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
283 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
284 498ef124 2020-03-21 stsp changes are fetched.
286 2ab43947 2020-03-18 stsp Suppress progress reporting output.
287 2ab43947 2020-03-18 stsp The same option will be passed to
289 2ab43947 2020-03-18 stsp if applicable.
290 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
291 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
292 0e4002ca 2020-03-21 stsp .Ar reference
293 0e4002ca 2020-03-21 stsp from the remote repository's
296 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
297 0e4002ca 2020-03-21 stsp references to fetch.
298 71f12362 2020-03-21 stsp The specified
299 71f12362 2020-03-21 stsp .Ar reference
300 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
301 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
303 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
304 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
305 0e4002ca 2020-03-21 stsp namespace, unless the
307 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
311 0e4002ca 2020-03-21 stsp .Cm got clone
312 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
313 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
315 0e4002ca 2020-03-21 stsp .Dq refs/got/
318 827a167b 2022-08-16 stsp Verbose mode.
320 827a167b 2022-08-16 stsp .Cm got clone
321 827a167b 2022-08-16 stsp to print debugging messages to standard error output.
322 827a167b 2022-08-16 stsp This option will be passed to
324 827a167b 2022-08-16 stsp if applicable.
325 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
326 827a167b 2022-08-16 stsp The maximum is 3.
331 5fc4f020 2022-08-30 op .Op Fl adlqtvX
332 5fc4f020 2022-08-30 op .Op Fl b Ar branch
333 5fc4f020 2022-08-30 op .Op Fl R Ar reference
334 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
335 5fc4f020 2022-08-30 op .Op Ar remote-repository
337 4683a10b 2021-11-04 kn .Dl Pq alias: Cm fe
338 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
340 4ba14133 2020-03-20 stsp .Ar remote-repository
341 4ba14133 2020-03-20 stsp is specified,
343 7848a0e1 2020-03-19 stsp will be used.
344 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
345 257add31 2020-09-09 stsp .Xr got.conf 5
348 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
349 7848a0e1 2020-03-19 stsp .Cm got clone .
351 ccbbf026 2023-02-06 stsp By default, any branches configured in
352 ccbbf026 2023-02-06 stsp .Xr got.conf 5
354 4bff57b4 2023-02-14 stsp .Ar remote-repository
355 ccbbf026 2023-02-06 stsp will be fetched.
357 ccbbf026 2023-02-06 stsp .Cm got fetch
358 ccbbf026 2023-02-06 stsp is invoked in a work tree then this work tree's current branch will be
359 ccbbf026 2023-02-06 stsp fetched, too, provided it is present on the server.
360 4bff57b4 2023-02-14 stsp If no branches to fetch can be found in
361 4bff57b4 2023-02-14 stsp .Xr got.conf 5
362 4bff57b4 2023-02-14 stsp or via a work tree, or said branches are not found on the server, a branch
363 4bff57b4 2023-02-14 stsp resolved via the remote repository's HEAD reference will be fetched.
364 118a625d 2023-02-18 mark Likewise, if a HEAD reference for the
365 118a625d 2023-02-18 mark .Ar remote-repository
366 118a625d 2023-02-18 mark exists but its target no longer matches the remote HEAD, then
367 118a625d 2023-02-18 mark the new target branch will be fetched.
368 ccbbf026 2023-02-06 stsp This default behaviour can be overridden with the
374 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
375 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
376 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
378 498ef124 2020-03-21 stsp By default, branch references in the
379 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
380 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
382 498ef124 2020-03-21 stsp .Cm got rebase
384 7b53188e 2023-07-03 stsp .Cm got merge
385 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
386 7848a0e1 2020-03-19 stsp .Dq refs/heads/
387 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
388 bd81cfb7 2020-04-19 stsp as necessary.
390 498ef124 2020-03-21 stsp If the repository was created as a mirror with
391 e38d4cde 2022-03-21 naddy .Cm got clone -m ,
392 498ef124 2020-03-21 stsp then all branches in the
393 469dd726 2020-03-20 stsp .Dq refs/heads/
394 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
395 498ef124 2020-03-21 stsp the remote repository.
396 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
397 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
398 e6786710 2021-07-03 stsp by Git's garbage collector or
399 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
400 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
402 db6d8ad8 2020-03-21 stsp In any case, references in the
403 7848a0e1 2020-03-19 stsp .Dq refs/tags/
404 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
405 db6d8ad8 2020-03-21 stsp in the same namespace.
407 7848a0e1 2020-03-19 stsp The options for
408 7848a0e1 2020-03-19 stsp .Cm got fetch
409 7848a0e1 2020-03-19 stsp are as follows:
410 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
412 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
413 1d4b192f 2020-03-21 stsp .Dq refs/heads/
414 1d4b192f 2020-03-21 stsp reference namespace.
415 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
416 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
417 4ba14133 2020-03-20 stsp Cannot be used together with the
420 4ba14133 2020-03-20 stsp .It Fl b Ar branch
421 4ba14133 2020-03-20 stsp Fetch the specified
423 1d4b192f 2020-03-21 stsp from the remote repository's
424 1d4b192f 2020-03-21 stsp .Dq refs/heads/
425 1d4b192f 2020-03-21 stsp reference namespace.
426 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
428 4ba14133 2020-03-20 stsp Cannot be used together with the
432 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
433 f21ec2f0 2020-03-21 stsp present in the remote repository.
434 f21ec2f0 2020-03-21 stsp Only references are deleted.
435 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
436 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
437 e6786710 2021-07-03 stsp Git's garbage collector or
438 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
440 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
441 41b0de12 2020-03-21 stsp and exit immediately.
442 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
448 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
449 7848a0e1 2020-03-19 stsp The same option will be passed to
451 7848a0e1 2020-03-19 stsp if applicable.
452 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
453 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
454 0e4002ca 2020-03-21 stsp .Ar reference
455 0e4002ca 2020-03-21 stsp from the remote repository's
458 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
459 0e4002ca 2020-03-21 stsp references to fetch.
460 71f12362 2020-03-21 stsp The specified
461 71f12362 2020-03-21 stsp .Ar reference
462 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
463 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
465 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
466 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
467 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
468 a18cccf9 2020-03-21 stsp .Cm got clone -m
469 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
473 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
474 0e4002ca 2020-03-21 stsp .Cm got branch
477 0e4002ca 2020-03-21 stsp .Cm got fetch
478 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
479 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
481 0e4002ca 2020-03-21 stsp .Dq refs/got/
483 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
484 827a167b 2022-08-16 stsp Use the repository at the specified path.
485 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
486 827a167b 2022-08-16 stsp working directory.
487 827a167b 2022-08-16 stsp If this directory is a
489 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
491 827a167b 2022-08-16 stsp Allow existing references in the
492 827a167b 2022-08-16 stsp .Dq refs/tags
493 827a167b 2022-08-16 stsp namespace to be updated if they have changed on the server.
494 827a167b 2022-08-16 stsp If not specified, only new tag references will be created.
496 827a167b 2022-08-16 stsp Verbose mode.
498 827a167b 2022-08-16 stsp .Cm got fetch
499 827a167b 2022-08-16 stsp to print debugging messages to standard error output.
500 827a167b 2022-08-16 stsp The same option will be passed to
502 827a167b 2022-08-16 stsp if applicable.
503 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
504 827a167b 2022-08-16 stsp The maximum is 3.
506 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
507 161728eb 2021-07-24 stsp .Ar remote-repository
508 161728eb 2021-07-24 stsp instead of fetching new changes.
509 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
510 161728eb 2021-07-24 stsp .Xr got.conf 5 .
515 161728eb 2021-07-24 stsp .Ar remote-repository
516 161728eb 2021-07-24 stsp argument is mandatory and no other options except
521 161728eb 2021-07-24 stsp are allowed.
523 161728eb 2021-07-24 stsp Only references are deleted.
524 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
525 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
526 161728eb 2021-07-24 stsp .Xr git-repack 1
527 161728eb 2021-07-24 stsp and Git's garbage collector.
533 5fc4f020 2022-08-30 op .Op Fl b Ar branch
534 5fc4f020 2022-08-30 op .Op Fl c Ar commit
535 5fc4f020 2022-08-30 op .Op Fl p Ar path-prefix
536 5fc4f020 2022-08-30 op .Ar repository-path
537 5fc4f020 2022-08-30 op .Op Ar work-tree-path
539 4683a10b 2021-11-04 kn .Dl Pq alias: Cm co
540 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
541 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
542 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
543 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
544 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
548 5d7c1dab 2018-04-01 stsp .Ar work tree path
549 c844a238 2019-02-06 stsp is not specified, either use the last component of
550 5d7c1dab 2018-04-01 stsp .Ar repository path ,
552 5d7c1dab 2018-04-01 stsp .Ar path prefix
553 c844a238 2019-02-06 stsp was specified use the last component of
554 5d7c1dab 2018-04-01 stsp .Ar path prefix .
556 38e11793 2018-06-13 stsp The options for
557 38e11793 2018-06-13 stsp .Cm got checkout
558 38e11793 2018-06-13 stsp are as follows:
559 38e11793 2018-06-13 stsp .Bl -tag -width Ds
560 08573d5b 2019-05-14 stsp .It Fl b Ar branch
561 3c575567 2019-07-28 stsp Check out files from a commit on the specified
562 08573d5b 2019-05-14 stsp .Ar branch .
563 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
564 08573d5b 2019-05-14 stsp reference will be used.
565 8069f636 2019-01-12 stsp .It Fl c Ar commit
566 8069f636 2019-01-12 stsp Check out files from the specified
568 3c575567 2019-07-28 stsp on the selected branch.
569 10d73284 2023-07-18 stsp If this option is not specified, the most recent commit on the selected
570 10d73284 2023-07-18 stsp branch will be used.
572 10d73284 2023-07-18 stsp The expected
574 6b483b31 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
575 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
576 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
577 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
578 6b483b31 2023-07-18 stsp The keywords
582 6b483b31 2023-07-18 stsp resolve to the repository's HEAD reference, or, if the
584 c8d1a97c 2023-07-17 mark option is used, the head of the checked-out
585 c8d1a97c 2023-07-17 mark .Ar branch .
586 c8d1a97c 2023-07-17 mark Keywords and reference names may be appended with
590 c8d1a97c 2023-07-17 mark modifiers and an optional integer N to denote the
591 c8d1a97c 2023-07-17 mark Nth descendant or antecedent by first parent traversal, respectively;
592 c8d1a97c 2023-07-17 mark for example,
593 c8d1a97c 2023-07-17 mark .Sy :head:-2
594 c8d1a97c 2023-07-17 mark denotes the work tree branch head's 2nd generation ancestor, and
596 c8d1a97c 2023-07-17 mark will denote the 3rd generation ancestor of the commit resolved by the
599 c8d1a97c 2023-07-17 mark If an integer does not follow the
603 c8d1a97c 2023-07-17 mark modifier, a
605 c8d1a97c 2023-07-17 mark is implicitly appended
607 c8d1a97c 2023-07-17 mark .Sy :head:-
608 c8d1a97c 2023-07-17 mark is equivalent to
609 c8d1a97c 2023-07-17 mark .Sy :head:-1
612 4b6c9460 2020-03-05 stsp If the specified
614 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
615 4b6c9460 2020-03-05 stsp this commit must be specified with the
618 e38d4cde 2022-03-21 naddy If no such branch is known, a new branch must be created for this
619 4b6c9460 2020-03-05 stsp commit with
620 4b6c9460 2020-03-05 stsp .Cm got branch
622 4b6c9460 2020-03-05 stsp .Cm got checkout
623 4b6c9460 2020-03-05 stsp can be used.
624 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
626 827a167b 2022-08-16 stsp Proceed with the checkout operation even if the directory at
627 827a167b 2022-08-16 stsp .Ar work-tree-path
628 827a167b 2022-08-16 stsp is not empty.
629 827a167b 2022-08-16 stsp Existing files will be left intact.
630 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
631 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
632 38e11793 2018-06-13 stsp Only files beneath the specified
633 38e11793 2018-06-13 stsp .Ar path-prefix
634 38e11793 2018-06-13 stsp will be checked out.
636 4ad4a1ec 2021-09-13 tracey Silence progress output.
642 5fc4f020 2022-08-30 op .Op Fl b Ar branch
643 5fc4f020 2022-08-30 op .Op Fl c Ar commit
644 5fc4f020 2022-08-30 op .Op Ar path ...
646 4683a10b 2021-11-04 kn .Dl Pq alias: Cm up
647 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
648 4f331d3a 2020-04-01 stsp .Ar commit .
649 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
650 4f331d3a 2020-04-01 stsp of this commit.
651 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
652 4f331d3a 2020-04-01 stsp incoming changes.
654 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
655 5036ab18 2020-04-18 stsp further complications.
656 5036ab18 2020-04-18 stsp Such files will be updated when
657 5036ab18 2020-04-18 stsp .Cm got update
658 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
659 e38d4cde 2022-03-21 naddy If the conflicting changes are no longer needed, affected files can be
660 5036ab18 2020-04-18 stsp reverted with
661 5036ab18 2020-04-18 stsp .Cm got revert
662 5036ab18 2020-04-18 stsp before running
663 5036ab18 2020-04-18 stsp .Cm got update
666 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
667 7f838b36 2019-02-08 stsp .Bl -column YXZ description
668 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
669 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
670 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
671 7f838b36 2019-02-08 stsp .It D Ta file was deleted
672 07fa9365 2023-03-10 stsp .It d Ta file's deletion was prevented by local modifications
673 7f838b36 2019-02-08 stsp .It A Ta new file was added
674 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
675 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
676 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
677 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
682 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
683 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
684 f2ea84fa 2019-07-27 stsp specified paths.
685 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
686 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
687 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
690 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
691 c4cdcb68 2019-04-03 stsp multiple base commits.
692 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
693 47ec7be7 2019-05-12 stsp .Cm got update
694 47ec7be7 2019-05-12 stsp across the entire work tree.
695 024e9686 2019-05-14 stsp Specifying a
697 024e9686 2019-05-14 stsp is incompatible with the
701 4ed9f614 2019-08-04 stsp .Cm got update
702 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
703 4ed9f614 2019-08-04 stsp If changes have been staged with
704 4ed9f614 2019-08-04 stsp .Cm got stage ,
705 bc3056e3 2019-08-18 stsp these changes must first be committed with
706 4ed9f614 2019-08-04 stsp .Cm got commit
707 4ed9f614 2019-08-04 stsp or unstaged with
708 4ed9f614 2019-08-04 stsp .Cm got unstage .
710 507dc3bb 2018-12-29 stsp The options for
711 507dc3bb 2018-12-29 stsp .Cm got update
712 507dc3bb 2018-12-29 stsp are as follows:
713 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
714 024e9686 2019-05-14 stsp .It Fl b Ar branch
715 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
717 024e9686 2019-05-14 stsp before updating the work tree.
718 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
720 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
721 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
722 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
724 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
725 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
726 4f331d3a 2020-04-01 stsp .Ar branch .
727 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
728 4f331d3a 2020-04-01 stsp .Cm got commit ,
729 4f331d3a 2020-04-01 stsp or could be discarded with
730 4f331d3a 2020-04-01 stsp .Cm got revert .
731 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
732 507dc3bb 2018-12-29 stsp Update the work tree to the specified
733 507dc3bb 2018-12-29 stsp .Ar commit .
734 10d73284 2023-07-18 stsp If this option is not specified, the most recent commit on the work tree's
735 10d73284 2023-07-18 stsp branch will be used.
737 10d73284 2023-07-18 stsp The expected
739 6b483b31 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
740 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
741 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
742 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
743 6b483b31 2023-07-18 stsp The keywords
747 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
748 fd7552d2 2023-07-17 mark Keywords and reference names may be appended with
752 fd7552d2 2023-07-17 mark modifiers and an optional integer N to denote the
753 fd7552d2 2023-07-17 mark Nth descendant or antecedent, respectively, by first parent traversal;
754 fd7552d2 2023-07-17 mark for example,
755 fd7552d2 2023-07-17 mark .Sy :head:-2
756 e764eb5b 2023-07-17 stsp denotes the work tree branch head's 2nd generation ancestor, and
757 fd7552d2 2023-07-17 mark .Sy :base:+4
758 fd7552d2 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
761 fd7552d2 2023-07-17 mark will denote the 3rd generation ancestor of the commit resolved by the
764 fd7552d2 2023-07-17 mark If an integer does not follow the
768 fd7552d2 2023-07-17 mark modifier, a
770 fd7552d2 2023-07-17 mark is implicitly appended
772 fd7552d2 2023-07-17 mark .Sy :head:-
773 fd7552d2 2023-07-17 mark is equivalent to
774 fd7552d2 2023-07-17 mark .Sy :head:-1
777 4ad4a1ec 2021-09-13 tracey Silence progress output.
783 5fc4f020 2022-08-30 op .Op Fl S Ar status-codes
784 5fc4f020 2022-08-30 op .Op Fl s Ar status-codes
785 5fc4f020 2022-08-30 op .Op Ar path ...
787 4683a10b 2021-11-04 kn .Dl Pq alias: Cm st
788 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
789 6bad629b 2019-02-04 stsp using the following status codes:
790 6bad629b 2019-02-04 stsp .Bl -column YXZ description
791 6bad629b 2019-02-04 stsp .It M Ta modified file
792 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
793 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
794 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
795 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
796 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
797 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
799 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
800 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
802 2a06fe5f 2019-08-24 stsp specified on the command line
807 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
808 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
810 4ed9f614 2019-08-04 stsp If changes have been staged with
811 4ed9f614 2019-08-04 stsp .Cm got stage ,
812 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
813 4ed9f614 2019-08-04 stsp status codes:
814 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
815 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
816 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
817 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
820 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
821 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
822 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
823 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
826 081470ac 2020-08-13 stsp The options for
827 081470ac 2020-08-13 stsp .Cm got status
828 081470ac 2020-08-13 stsp are as follows:
829 081470ac 2020-08-13 stsp .Bl -tag -width Ds
831 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
832 827a167b 2022-08-16 stsp .It Fl S Ar status-codes
833 827a167b 2022-08-16 stsp Suppress the output of files with a modification status matching any of the
834 00357e4d 2021-09-14 tracey single-character status codes contained in the
835 00357e4d 2021-09-14 tracey .Ar status-codes
836 00357e4d 2021-09-14 tracey argument.
837 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
838 00357e4d 2021-09-14 tracey may be specified.
839 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
840 b043307b 2021-09-14 stsp Cannot be used together with the
843 827a167b 2022-08-16 stsp .It Fl s Ar status-codes
844 827a167b 2022-08-16 stsp Only show files with a modification status matching any of the
845 081470ac 2020-08-13 stsp single-character status codes contained in the
846 081470ac 2020-08-13 stsp .Ar status-codes
848 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
849 081470ac 2020-08-13 stsp may be specified.
850 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
851 b043307b 2021-09-14 stsp Cannot be used together with the
856 6841da00 2019-08-08 stsp For compatibility with
859 bd8de430 2019-10-04 stsp .Xr git 1 ,
860 6841da00 2019-08-08 stsp .Cm got status
863 bd8de430 2019-10-04 stsp patterns from
864 6841da00 2019-08-08 stsp .Pa .cvsignore
866 bd8de430 2019-10-04 stsp .Pa .gitignore
867 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
868 bd8de430 2019-10-04 stsp which match these patterns.
869 249b637c 2023-02-20 stsp Ignore patterns which end with a slash,
871 249b637c 2023-02-20 stsp will only match directories.
872 bd8de430 2019-10-04 stsp As an extension to
874 bd8de430 2019-10-04 stsp matching rules,
875 bd8de430 2019-10-04 stsp .Cm got status
876 bd8de430 2019-10-04 stsp supports consecutive asterisks,
878 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
880 6841da00 2019-08-08 stsp .Xr cvs 1 ,
881 6841da00 2019-08-08 stsp .Cm got status
882 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
884 bd8de430 2019-10-04 stsp .Xr git 1 ,
885 bd8de430 2019-10-04 stsp .Cm got status
886 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
888 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
890 bd8de430 2019-10-04 stsp in a pattern.
893 d651dcfa 2023-01-07 mark .Op Fl bdPpRs
894 5fc4f020 2022-08-30 op .Op Fl C Ar number
895 5fc4f020 2022-08-30 op .Op Fl c Ar commit
896 5fc4f020 2022-08-30 op .Op Fl l Ar N
897 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
898 5fc4f020 2022-08-30 op .Op Fl S Ar search-pattern
899 5fc4f020 2022-08-30 op .Op Fl x Ar commit
902 38e11793 2018-06-13 stsp Display history of a repository.
905 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
906 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
908 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
909 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
910 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
912 38e11793 2018-06-13 stsp The options for
913 38e11793 2018-06-13 stsp .Cm got log
914 38e11793 2018-06-13 stsp are as follows:
915 38e11793 2018-06-13 stsp .Bl -tag -width Ds
917 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
918 1137e0ae 2020-01-27 stsp from other branches.
919 48c8c60d 2020-01-27 stsp By default,
920 48c8c60d 2020-01-27 stsp .Cm got log
921 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
922 827a167b 2022-08-16 stsp .It Fl C Ar number
923 827a167b 2022-08-16 stsp Set the number of context lines shown in diffs with
925 827a167b 2022-08-16 stsp By default, 3 lines of context are shown.
926 38e11793 2018-06-13 stsp .It Fl c Ar commit
927 38e11793 2018-06-13 stsp Start traversing history at the specified
928 38e11793 2018-06-13 stsp .Ar commit .
929 10d73284 2023-07-18 stsp If this option is not specified, default to the work tree's current branch
930 10d73284 2023-07-18 stsp if invoked in a work tree, or to the repository's HEAD reference.
932 10d73284 2023-07-18 stsp The expected
934 6b483b31 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
935 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
936 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
937 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
938 6b483b31 2023-07-18 stsp The keywords
942 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
943 fd7552d2 2023-07-17 mark The former is only valid if invoked in a work tree, while the latter will
944 fd7552d2 2023-07-17 mark resolve to the tip of the work tree's current branch if invoked in a
945 fd7552d2 2023-07-17 mark work tree, otherwise it will resolve to the repository's HEAD reference.
946 fd7552d2 2023-07-17 mark Keywords and references may be appended with
950 fd7552d2 2023-07-17 mark modifiers and an optional integer N to denote the
951 fd7552d2 2023-07-17 mark Nth descendant or antecedent, respectively, by first parent traversal;
952 fd7552d2 2023-07-17 mark for example,
953 fd7552d2 2023-07-17 mark .Sy :head:-2
954 fd7552d2 2023-07-17 mark denotes the HEAD reference's 2nd generation ancestor, and
955 fd7552d2 2023-07-17 mark .Sy :base:+4
956 fd7552d2 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
959 fd7552d2 2023-07-17 mark will denote the 3rd generation descendant of the commit resolved by the
966 fd7552d2 2023-07-17 mark modifier without a trailing integer has an implicit
970 fd7552d2 2023-07-17 mark .Sy :base:+
971 fd7552d2 2023-07-17 mark is equivalent to
972 fd7552d2 2023-07-17 mark .Sy :base:+1
975 1f3405c9 2023-01-17 mark Display diffstat of changes introduced in each commit.
976 5191b70b 2023-01-07 mark Cannot be used with the
979 123cba5a 2023-08-11 stsp Implies the
981 123cba5a 2023-08-11 stsp option (diffstat displays a list of changed paths).
982 6238ee32 2018-06-13 stsp .It Fl l Ar N
983 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
984 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
985 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
987 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
988 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
990 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
991 0208f208 2020-05-05 stsp status codes:
992 0208f208 2020-05-05 stsp .Bl -column YXZ description
993 0208f208 2020-05-05 stsp .It M Ta modified file
994 0208f208 2020-05-05 stsp .It D Ta file was deleted
995 0208f208 2020-05-05 stsp .It A Ta new file was added
996 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
999 c1c775eb 2022-06-08 stsp Cannot be used with the
1003 827a167b 2022-08-16 stsp Display the patch of modifications made in each commit.
1006 827a167b 2022-08-16 stsp is specified, only show the patch of modifications at or within this path.
1007 827a167b 2022-08-16 stsp Cannot be used with the
1011 827a167b 2022-08-16 stsp Determine a set of commits to display as usual, but display these commits
1012 827a167b 2022-08-16 stsp in reverse order.
1013 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
1014 827a167b 2022-08-16 stsp Use the repository at the specified path.
1015 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
1016 827a167b 2022-08-16 stsp working directory.
1017 827a167b 2022-08-16 stsp If this directory is a
1019 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
1020 c1c775eb 2022-06-08 stsp .It Fl S Ar search-pattern
1021 793b9394 2022-06-12 op If specified, show only commits with a log message, author name,
1022 793b9394 2022-06-12 op committer name, or ID SHA1 hash matched by the extended regular
1024 6841bf13 2019-11-29 kn .Ar search-pattern .
1025 3ef807ee 2022-06-08 stsp Lines in committed patches will be matched if
1027 3ef807ee 2022-06-08 stsp is specified.
1028 3ef807ee 2022-06-08 stsp File paths changed by a commit will be matched if
1030 3ef807ee 2022-06-08 stsp is specified.
1031 6841bf13 2019-11-29 kn Regular expression syntax is documented in
1032 6841bf13 2019-11-29 kn .Xr re_format 7 .
1034 827a167b 2022-08-16 stsp Display a short one-line summary of each commit, instead of the default
1035 827a167b 2022-08-16 stsp history format.
1036 827a167b 2022-08-16 stsp Cannot be used together with the
1041 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
1042 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
1043 d1fe46f9 2020-04-18 stsp .Ar commit
1044 52ab7958 2020-04-18 stsp has been traversed.
1047 93c250cd 2023-08-07 mark the expected
1048 93c250cd 2023-08-07 mark .Ar commit
1049 93c250cd 2023-08-07 mark argument is a commit ID SHA1 hash, or a reference name or a keyword
1050 93c250cd 2023-08-07 mark which will be resolved to a commit ID.
1051 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
1052 d1fe46f9 2020-04-18 stsp .Ar commit
1053 d1fe46f9 2020-04-18 stsp is never traversed.
1058 a76e88e5 2023-01-10 mark .Op Fl adPsw
1059 5fc4f020 2022-08-30 op .Op Fl C Ar number
1060 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1061 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1062 5fc4f020 2022-08-30 op .Op Ar object1 Ar object2 | Ar path ...
1064 4683a10b 2021-11-04 kn .Dl Pq alias: Cm di
1065 e7ffb0b0 2021-10-07 stsp When invoked within a work tree without any arguments, display all
1066 bd81cfb7 2020-04-19 stsp local changes in the work tree.
1067 e7ffb0b0 2021-10-07 stsp If one or more
1069 e7ffb0b0 2021-10-07 stsp arguments are specified, only show changes within the specified paths.
1071 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
1072 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
1073 d24820bf 2019-08-11 stsp corresponding objects.
1074 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
1075 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1076 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1077 e7ffb0b0 2021-10-07 stsp If none of these interpretations produce a valid result or if the
1079 e7ffb0b0 2021-10-07 stsp option is used,
1081 e7ffb0b0 2021-10-07 stsp .Cm got diff
1082 e7ffb0b0 2021-10-07 stsp is running in a work tree, attempt to interpret the two arguments as paths.
1084 c0cc5c62 2018-10-18 stsp The options for
1085 c0cc5c62 2018-10-18 stsp .Cm got diff
1086 c0cc5c62 2018-10-18 stsp are as follows:
1087 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
1089 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
1090 827a167b 2022-08-16 stsp .It Fl C Ar number
1091 827a167b 2022-08-16 stsp Set the number of context lines shown in the diff.
1092 827a167b 2022-08-16 stsp By default, 3 lines of context are shown.
1093 67b631c9 2021-10-10 stsp .It Fl c Ar commit
1094 67b631c9 2021-10-10 stsp Show differences between commits in the repository.
1095 827a167b 2022-08-16 stsp This option may be used up to two times.
1096 67b631c9 2021-10-10 stsp When used only once, show differences between the specified
1097 67b631c9 2021-10-10 stsp .Ar commit
1098 67b631c9 2021-10-10 stsp and its first parent commit.
1099 67b631c9 2021-10-10 stsp When used twice, show differences between the two specified commits.
1103 10d73284 2023-07-18 stsp option is used, all non-option arguments will be interpreted as paths.
1104 10d73284 2023-07-18 stsp If one or more such
1106 10d73284 2023-07-18 stsp arguments are provided, only show differences for the specified paths.
1108 10d73284 2023-07-18 stsp The expected
1109 10d73284 2023-07-18 stsp .Ar commit
1110 6b483b31 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
1111 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
1112 67b631c9 2021-10-10 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1113 67b631c9 2021-10-10 stsp automatically, provided the abbreviation is unique.
1114 6b483b31 2023-07-18 stsp The keywords
1118 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1119 fd7552d2 2023-07-17 mark The former is only valid if invoked in a work tree, while the latter will
1120 fd7552d2 2023-07-17 mark resolve to the tip of the work tree's current branch if invoked in a
1121 fd7552d2 2023-07-17 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1122 fd7552d2 2023-07-17 mark Keywords and references may be appended with
1126 fd7552d2 2023-07-17 mark modifiers and an optional integer N to denote the
1127 fd7552d2 2023-07-17 mark Nth descendant or antecedent, respectively, by first parent traversal;
1128 fd7552d2 2023-07-17 mark for example,
1129 fd7552d2 2023-07-17 mark .Sy :head:-2
1130 fd7552d2 2023-07-17 mark denotes the HEAD reference's 2nd generation ancestor, and
1131 fd7552d2 2023-07-17 mark .Sy :base:+4
1132 fd7552d2 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
1133 fd7552d2 2023-07-17 mark Similarly,
1134 fd7552d2 2023-07-17 mark .Sy baz:+8
1135 fd7552d2 2023-07-17 mark will denote the 8th generation descendant of the commit resolved by the
1137 fd7552d2 2023-07-17 mark reference.
1138 fd7552d2 2023-07-17 mark If an integer does not follow the
1142 fd7552d2 2023-07-17 mark modifier, a
1144 fd7552d2 2023-07-17 mark is implicitly appended
1146 fd7552d2 2023-07-17 mark .Sy :head:-
1147 fd7552d2 2023-07-17 mark is equivalent to
1148 fd7552d2 2023-07-17 mark .Sy :head:-1
1151 67b631c9 2021-10-10 stsp Cannot be used together with the
1155 a76e88e5 2023-01-10 mark Display diffstat of changes before the actual diff by annotating each file path
1156 a76e88e5 2023-01-10 mark or blob hash being diffed with the total number of lines added and removed.
1157 a76e88e5 2023-01-10 mark A summary line will display the total number of changes across all files.
1159 827a167b 2022-08-16 stsp Interpret all arguments as paths only.
1160 827a167b 2022-08-16 stsp This option can be used to resolve ambiguity in cases where paths
1161 827a167b 2022-08-16 stsp look like tag names, reference names, or object IDs.
1162 827a167b 2022-08-16 stsp This option is only valid when
1163 827a167b 2022-08-16 stsp .Cm got diff
1164 827a167b 2022-08-16 stsp is invoked in a work tree.
1165 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
1166 b72f483a 2019-02-05 stsp Use the repository at the specified path.
1167 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
1168 b72f483a 2019-02-05 stsp working directory.
1169 b72f483a 2019-02-05 stsp If this directory is a
1171 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1173 4ed9f614 2019-08-04 stsp Show changes staged with
1174 4ed9f614 2019-08-04 stsp .Cm got stage
1175 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
1176 e7ffb0b0 2021-10-07 stsp This option is only valid when
1177 e7ffb0b0 2021-10-07 stsp .Cm got diff
1178 e7ffb0b0 2021-10-07 stsp is invoked in a work tree.
1180 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
1185 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1186 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1189 4683a10b 2021-11-04 kn .Dl Pq alias: Cm bl
1190 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1192 1ff8e573 2018-08-02 stsp The options for
1193 1ff8e573 2018-08-02 stsp .Cm got blame
1194 1ff8e573 2018-08-02 stsp are as follows:
1195 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1196 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1197 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1198 1ff8e573 2018-08-02 stsp .Ar commit .
1199 fd220d9f 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name
1200 fd220d9f 2023-07-18 stsp or a keyword which will be resolved to a commit ID.
1201 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1202 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1203 fd220d9f 2023-07-18 stsp The keywords
1207 fd220d9f 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1208 4390d6c1 2023-07-18 mark The former is only valid if invoked in a work tree, while the latter will
1209 4390d6c1 2023-07-18 mark resolve to the tip of the work tree's current branch if invoked in a
1210 4390d6c1 2023-07-18 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1211 4390d6c1 2023-07-18 mark Keywords and references may be appended with
1215 4390d6c1 2023-07-18 mark modifiers and an optional integer N to denote the
1216 4390d6c1 2023-07-18 mark Nth descendant or antecedent by first parent traversal, respectively;
1217 4390d6c1 2023-07-18 mark for example,
1218 4390d6c1 2023-07-18 mark .Sy :head:-2
1219 4390d6c1 2023-07-18 mark denotes the work tree branch head's 2nd generation ancestor, and
1220 4390d6c1 2023-07-18 mark .Sy :base:+4
1221 4390d6c1 2023-07-18 mark denotes the 4th generation descendant of the work tree's base commit.
1222 4390d6c1 2023-07-18 mark Similarly,
1223 4390d6c1 2023-07-18 mark .Sy xyz:-5
1224 4390d6c1 2023-07-18 mark will denote the 5th generation ancestor of the commit resolved by the
1226 4390d6c1 2023-07-18 mark reference.
1231 4390d6c1 2023-07-18 mark modifier without a trailing integer has an implicit
1235 4390d6c1 2023-07-18 mark .Sy :base:+
1236 4390d6c1 2023-07-18 mark is equivalent to
1237 4390d6c1 2023-07-18 mark .Sy :base:+1
1239 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1240 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1241 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1242 1ff8e573 2018-08-02 stsp working directory.
1243 0c06baac 2019-02-05 stsp If this directory is a
1245 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1251 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1252 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1255 4683a10b 2021-11-04 kn .Dl Pq alias: Cm tr
1256 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1257 5de5890b 2018-10-18 stsp directory path in the repository.
1258 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1259 db0c2996 2019-02-10 stsp annotations:
1260 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1261 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1262 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1263 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1264 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1267 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1271 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1272 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1273 0c849583 2019-02-05 stsp if there is no work tree.
1275 5de5890b 2018-10-18 stsp The options for
1276 5de5890b 2018-10-18 stsp .Cm got tree
1277 5de5890b 2018-10-18 stsp are as follows:
1278 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1279 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1280 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1281 5de5890b 2018-10-18 stsp .Ar commit .
1283 fd220d9f 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name
1284 fd220d9f 2023-07-18 stsp or a keyword which will be resolved to a commit ID.
1285 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1286 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1287 fd220d9f 2023-07-18 stsp The keywords
1291 fd220d9f 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1292 4390d6c1 2023-07-18 mark The former is only valid if invoked in a work tree, while the latter will
1293 4390d6c1 2023-07-18 mark resolve to the tip of the work tree's current branch if invoked in a
1294 4390d6c1 2023-07-18 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1295 4390d6c1 2023-07-18 mark Keywords and references may be appended with
1299 4390d6c1 2023-07-18 mark modifiers and an optional integer N to denote the
1300 4390d6c1 2023-07-18 mark Nth descendant or antecedent by first parent traversal, respectively;
1301 4390d6c1 2023-07-18 mark for example,
1302 4390d6c1 2023-07-18 mark .Sy :head:-2
1303 4390d6c1 2023-07-18 mark denotes the work tree branch head's 2nd generation ancestor, and
1304 4390d6c1 2023-07-18 mark .Sy :base:+4
1305 4390d6c1 2023-07-18 mark denotes the 4th generation descendant of the work tree's base commit.
1306 4390d6c1 2023-07-18 mark Similarly,
1307 4390d6c1 2023-07-18 mark .Sy spam:-3
1308 4390d6c1 2023-07-18 mark will denote the 3rd generation ancestor of the commit resolved by the
1310 4390d6c1 2023-07-18 mark reference.
1315 4390d6c1 2023-07-18 mark modifier without a trailing integer has an implicit
1319 4390d6c1 2023-07-18 mark .Sy :base:+
1320 4390d6c1 2023-07-18 mark is equivalent to
1321 4390d6c1 2023-07-18 mark .Sy :base:+1
1324 827a167b 2022-08-16 stsp Show object IDs of files (blob objects) and directories (tree objects).
1326 827a167b 2022-08-16 stsp Recurse into sub-directories in the repository.
1327 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
1328 5de5890b 2018-10-18 stsp Use the repository at the specified path.
1329 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
1330 5de5890b 2018-10-18 stsp working directory.
1331 0c849583 2019-02-05 stsp If this directory is a
1333 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1338 5e91dae4 2022-08-30 stsp .Op Fl c Ar object
1339 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1340 5fc4f020 2022-08-30 op .Op Fl s Ar reference
1343 d0eebce4 2019-03-11 stsp Manage references in a repository.
1345 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1346 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1348 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1349 f16e4044 2019-10-09 stsp .Dq refs/ .
1351 d0eebce4 2019-03-11 stsp The options for
1352 d0eebce4 2019-03-11 stsp .Cm got ref
1353 d0eebce4 2019-03-11 stsp are as follows:
1354 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1355 827a167b 2022-08-16 stsp .It Fl c Ar object
1356 827a167b 2022-08-16 stsp Create a reference or change an existing reference.
1357 827a167b 2022-08-16 stsp The reference with the specified
1359 827a167b 2022-08-16 stsp will point at the specified
1360 827a167b 2022-08-16 stsp .Ar object .
1362 827a167b 2022-08-16 stsp The expected
1363 827a167b 2022-08-16 stsp .Ar object
1364 4390d6c1 2023-07-18 mark argument is an ID SHA1 hash or an existing reference or tag name
1365 4390d6c1 2023-07-18 mark or a keyword which will be resolved to the ID of a corresponding commit,
1366 4390d6c1 2023-07-18 mark tree, tag, or blob object.
1367 4390d6c1 2023-07-18 mark An abbreviated hash argument will be expanded to a full SHA1 hash
1368 4390d6c1 2023-07-18 mark automatically, provided the abbreviation is unique.
1369 4390d6c1 2023-07-18 mark The keywords
1373 4390d6c1 2023-07-18 mark resolve to the work tree's base commit and branch head, respectively.
1374 4390d6c1 2023-07-18 mark The former is only valid if invoked in a work tree, while the latter will
1375 4390d6c1 2023-07-18 mark resolve to the tip of the work tree's current branch if invoked in a
1376 4390d6c1 2023-07-18 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1377 4390d6c1 2023-07-18 mark Keywords and reference names may be appended with
1381 4390d6c1 2023-07-18 mark modifiers and an optional integer N to denote the
1382 4390d6c1 2023-07-18 mark Nth descendant or antecedent by first parent traversal, respectively;
1383 4390d6c1 2023-07-18 mark for example,
1384 4390d6c1 2023-07-18 mark .Sy :head:-2
1385 4390d6c1 2023-07-18 mark denotes the work tree branch head's 2nd generation ancestor, and
1386 4390d6c1 2023-07-18 mark .Sy tagged:-3
1387 4390d6c1 2023-07-18 mark will denote the 3rd generation ancestor of the commit resolved by the
1388 4390d6c1 2023-07-18 mark .Qq tagged
1389 4390d6c1 2023-07-18 mark reference.
1390 4390d6c1 2023-07-18 mark If an integer does not follow the
1394 4390d6c1 2023-07-18 mark modifier, a
1396 4390d6c1 2023-07-18 mark is implicitly appended
1398 4390d6c1 2023-07-18 mark .Sy :head:-
1399 4390d6c1 2023-07-18 mark is equivalent to
1400 4390d6c1 2023-07-18 mark .Sy :head:-1
1403 827a167b 2022-08-16 stsp Cannot be used together with any other options except
1406 827a167b 2022-08-16 stsp Delete the reference with the specified
1408 827a167b 2022-08-16 stsp from the repository.
1409 827a167b 2022-08-16 stsp Any commit, tree, tag, and blob objects belonging to deleted references
1410 827a167b 2022-08-16 stsp remain in the repository and may be removed separately with
1411 827a167b 2022-08-16 stsp Git's garbage collector or
1412 827a167b 2022-08-16 stsp .Cm gotadmin cleanup .
1413 827a167b 2022-08-16 stsp Cannot be used together with any other options except
1416 b2070a3f 2020-03-22 stsp List references in the repository.
1419 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
1422 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
1423 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
1424 b2070a3f 2020-03-22 stsp .Ar name .
1425 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1429 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
1430 827a167b 2022-08-16 stsp Use the repository at the specified path.
1431 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
1432 827a167b 2022-08-16 stsp working directory.
1433 827a167b 2022-08-16 stsp If this directory is a
1435 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
1436 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1437 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1438 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1440 e31abbf2 2020-03-22 stsp will point at the specified
1441 e31abbf2 2020-03-22 stsp .Ar reference
1442 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1443 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1444 d1c1ae5f 2019-08-12 stsp this option is used.
1445 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1448 827a167b 2022-08-16 stsp Sort listed references by modification time (most recently modified first)
1449 827a167b 2022-08-16 stsp instead of sorting by lexicographical order.
1450 827a167b 2022-08-16 stsp Use of this option requires the
1452 827a167b 2022-08-16 stsp option to be used as well.
1458 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1459 5fc4f020 2022-08-30 op .Op Fl d Ar name
1460 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1463 4683a10b 2021-11-04 kn .Dl Pq alias: Cm br
1464 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1466 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1467 4e759de4 2019-06-26 stsp .Dq refs/heads/
1468 4e759de4 2019-06-26 stsp reference namespace.
1470 4e759de4 2019-06-26 stsp .Cm got branch
1471 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1473 e38d4cde 2022-03-21 naddy When deleting branches, the specified
1475 2f1457c6 2021-08-27 stsp is searched in the
1476 2f1457c6 2021-08-27 stsp .Dq refs/heads
1477 2f1457c6 2021-08-27 stsp reference namespace first.
1478 e38d4cde 2022-03-21 naddy If no corresponding branch is found, the
1479 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1480 2f1457c6 2021-08-27 stsp namespace will be searched next.
1482 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1483 ad89fa31 2019-10-04 stsp work tree's current branch.
1487 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1488 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1489 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1490 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1492 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1493 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1494 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1495 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1497 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1498 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1499 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1500 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1501 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1502 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1503 da76fce2 2020-02-24 stsp .It A Ta new file was added
1504 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1505 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1508 4e759de4 2019-06-26 stsp The options for
1509 4e759de4 2019-06-26 stsp .Cm got branch
1510 4e759de4 2019-06-26 stsp are as follows:
1511 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1512 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1513 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1514 a74f7e83 2019-11-10 stsp .Ar commit .
1515 6b483b31 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name or keyword
1516 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
1517 6b483b31 2023-07-18 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1518 6b483b31 2023-07-18 stsp automatically, provided the abbreviation is unique.
1519 6b483b31 2023-07-18 stsp The keywords
1523 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1524 c8d1a97c 2023-07-17 mark The former is only valid if invoked in a work tree, while the latter will
1525 c8d1a97c 2023-07-17 mark resolve to the tip of the work tree's current branch if invoked in a
1526 c8d1a97c 2023-07-17 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1527 c8d1a97c 2023-07-17 mark Keywords and references may be appended with
1531 c8d1a97c 2023-07-17 mark modifiers and an optional integer N to denote the
1532 c8d1a97c 2023-07-17 mark Nth descendant or antecedent by first parent traversal, respectively;
1533 c8d1a97c 2023-07-17 mark for example,
1534 c8d1a97c 2023-07-17 mark .Sy :head:-2
1535 c8d1a97c 2023-07-17 mark denotes the work tree branch head's 2nd generation ancestor, and
1536 c8d1a97c 2023-07-17 mark .Sy :base:+4
1537 c8d1a97c 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
1538 c8d1a97c 2023-07-17 mark Similarly,
1539 c8d1a97c 2023-07-17 mark .Sy foobar:+3
1540 c8d1a97c 2023-07-17 mark will denote the 3rd generation descendant of the commit resolved by the
1541 c8d1a97c 2023-07-17 mark .Qq foobar
1542 c8d1a97c 2023-07-17 mark reference.
1547 c8d1a97c 2023-07-17 mark modifier without a trailing integer has an implicit
1551 c8d1a97c 2023-07-17 mark .Sy :base:+
1552 c8d1a97c 2023-07-17 mark is equivalent to
1553 c8d1a97c 2023-07-17 mark .Sy :base:+1
1555 827a167b 2022-08-16 stsp .It Fl d Ar name
1556 827a167b 2022-08-16 stsp Delete the branch with the specified
1559 827a167b 2022-08-16 stsp .Dq refs/heads
1561 827a167b 2022-08-16 stsp .Dq refs/remotes
1562 827a167b 2022-08-16 stsp reference namespace.
1564 827a167b 2022-08-16 stsp Only the branch reference is deleted.
1565 827a167b 2022-08-16 stsp Any commit, tree, and blob objects belonging to the branch
1566 827a167b 2022-08-16 stsp remain in the repository and may be removed separately with
1567 827a167b 2022-08-16 stsp Git's garbage collector or
1568 827a167b 2022-08-16 stsp .Cm gotadmin cleanup .
1570 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1571 34d4e04c 2021-02-08 stsp repositories' branches in the
1572 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1573 34d4e04c 2021-02-08 stsp reference namespace.
1575 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1576 e19d5545 2023-07-04 stsp with one of the following annotations:
1577 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1578 863cc633 2023-07-23 mark .It * Ta work tree's base commit and the base commit of all tracked files
1579 863cc633 2023-07-23 mark matches the branch tip
1580 863cc633 2023-07-23 mark .It \(a~ Ta work tree comprises mixed commits or its base commit is out-of-date
1583 827a167b 2022-08-16 stsp Do not switch and update the work tree after creating a new branch.
1584 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
1585 827a167b 2022-08-16 stsp Use the repository at the specified path.
1586 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
1587 827a167b 2022-08-16 stsp working directory.
1588 827a167b 2022-08-16 stsp If this directory is a
1590 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
1592 f76670f0 2021-11-20 stsp Sort listed branches by modification time (most recently modified first)
1593 f76670f0 2021-11-20 stsp instead of sorting by lexicographical order.
1594 f76670f0 2021-11-20 stsp Branches in the
1595 f76670f0 2021-11-20 stsp .Dq refs/heads/
1596 f76670f0 2021-11-20 stsp reference namespace are listed before branches in
1597 f76670f0 2021-11-20 stsp .Dq refs/remotes/
1598 f76670f0 2021-11-20 stsp regardless.
1599 f76670f0 2021-11-20 stsp Use of this option requires the
1601 f76670f0 2021-11-20 stsp option to be used as well.
1606 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1607 5fc4f020 2022-08-30 op .Op Fl m Ar message
1608 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1609 5fc4f020 2022-08-30 op .Op Fl s Ar signer-id
1612 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1614 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1615 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1616 8e7bd50a 2019-08-22 stsp reference namespace.
1618 8e7bd50a 2019-08-22 stsp .Cm got tag
1619 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1620 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1621 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1623 80106605 2020-02-24 stsp Attempt to create a tag with the given
1624 8e7bd50a 2019-08-22 stsp .Ar name ,
1625 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1626 8e7bd50a 2019-08-22 stsp .Ar commit .
1627 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1628 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1629 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1631 8e7bd50a 2019-08-22 stsp The options for
1632 8e7bd50a 2019-08-22 stsp .Cm got tag
1633 8e7bd50a 2019-08-22 stsp are as follows:
1634 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1635 80106605 2020-02-24 stsp .It Fl c Ar commit
1636 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1637 80106605 2020-02-24 stsp .Ar commit .
1638 80106605 2020-02-24 stsp The expected
1639 80106605 2020-02-24 stsp .Ar commit
1640 fd220d9f 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference or keyword
1641 fd220d9f 2023-07-18 stsp which will be resolved to a commit ID.
1642 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1643 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1644 fd220d9f 2023-07-18 stsp The keywords
1648 fd220d9f 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1649 4390d6c1 2023-07-18 mark The former is only valid if invoked in a work tree, while the latter will
1650 4390d6c1 2023-07-18 mark resolve to the tip of the work tree's current branch if invoked in a
1651 4390d6c1 2023-07-18 mark work tree, otherwise it will resolve to the repository's HEAD reference.
1652 4390d6c1 2023-07-18 mark Keywords and references may be appended with
1656 4390d6c1 2023-07-18 mark modifiers and an optional integer N to denote the
1657 4390d6c1 2023-07-18 mark Nth descendant or antecedent by first parent traversal, respectively;
1658 4390d6c1 2023-07-18 mark for example,
1659 4390d6c1 2023-07-18 mark .Sy :head:-2
1660 4390d6c1 2023-07-18 mark denotes the work tree branch head's 2nd generation ancestor, and
1661 4390d6c1 2023-07-18 mark .Sy :base:+4
1662 4390d6c1 2023-07-18 mark denotes the 4th generation descendant of the work tree's base commit.
1663 4390d6c1 2023-07-18 mark Similarly,
1664 4390d6c1 2023-07-18 mark .Sy eggs:-3
1665 4390d6c1 2023-07-18 mark will denote the 3rd generation ancestor of the commit resolved by the
1667 4390d6c1 2023-07-18 mark reference.
1672 4390d6c1 2023-07-18 mark modifier without a trailing integer has an implicit
1676 4390d6c1 2023-07-18 mark .Sy :base:+
1677 4390d6c1 2023-07-18 mark is equivalent to
1678 4390d6c1 2023-07-18 mark .Sy :base:+1
1681 827a167b 2022-08-16 stsp List all existing tags in the repository instead of creating a new tag.
1684 827a167b 2022-08-16 stsp argument is passed, show only the tag with the given
1685 827a167b 2022-08-16 stsp .Ar name .
1686 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1687 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1688 8e7bd50a 2019-08-22 stsp Without the
1691 3a62228f 2019-11-08 stsp .Cm got tag
1692 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1693 ee27b57e 2023-07-15 naddy Quitting the editor without saving the file will abort the tag operation.
1694 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1695 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1696 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1697 8e7bd50a 2019-08-22 stsp working directory.
1698 8e7bd50a 2019-08-22 stsp If this directory is a
1700 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1701 10c4445c 2022-07-04 stsp .It Fl s Ar signer-id
1702 10c4445c 2022-07-04 stsp While creating a new tag, sign this tag with the identity given in
1703 10c4445c 2022-07-04 stsp .Ar signer-id .
1705 10c4445c 2022-07-04 stsp For SSH-based signatures,
1706 10c4445c 2022-07-04 stsp .Ar signer-id
1707 10c4445c 2022-07-04 stsp is the path to a file which may refer to either a private SSH key,
1708 10c4445c 2022-07-04 stsp or a public SSH key with the private half available via
1709 10c4445c 2022-07-04 stsp .Xr ssh-agent 1 .
1710 10c4445c 2022-07-04 stsp .Cm got tag
1711 10c4445c 2022-07-04 stsp will sign the tag object by invoking
1712 10c4445c 2022-07-04 stsp .Xr ssh-keygen 1
1714 217e00e5 2022-08-16 stsp .Fl Y Cm sign
1715 10c4445c 2022-07-04 stsp command, using the signature namespace
1717 10c4445c 2022-07-04 stsp for compatibility with
1718 10c4445c 2022-07-04 stsp .Xr git 1 .
1720 10c4445c 2022-07-04 stsp Verify tag object signatures.
1723 10c4445c 2022-07-04 stsp is specified, show and verify the tag object with the provided name.
1724 10c4445c 2022-07-04 stsp Otherwise, list all tag objects and verify signatures where present.
1726 10c4445c 2022-07-04 stsp .Cm got tag
1727 10c4445c 2022-07-04 stsp verifies SSH-based signatures by invoking
1728 10c4445c 2022-07-04 stsp .Xr ssh-keygen 1
1729 10c4445c 2022-07-04 stsp with the options
1730 217e00e5 2022-08-16 stsp .Fl Y Cm verify Fl f Ar allowed_signers .
1731 10c4445c 2022-07-04 stsp A path to the
1732 10c4445c 2022-07-04 stsp .Ar allowed_signers
1733 10c4445c 2022-07-04 stsp file must be set in
1734 10c4445c 2022-07-04 stsp .Xr got.conf 5 ,
1735 10c4445c 2022-07-04 stsp otherwise verification is impossible.
1737 827a167b 2022-08-16 stsp Verbose mode.
1738 827a167b 2022-08-16 stsp During SSH signature creation and verification this option will be passed to
1739 827a167b 2022-08-16 stsp .Xr ssh-keygen 1 .
1740 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
1741 827a167b 2022-08-16 stsp The maximum is 3.
1744 8e7bd50a 2019-08-22 stsp By design, the
1745 8e7bd50a 2019-08-22 stsp .Cm got tag
1746 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1747 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1748 8e7bd50a 2019-08-22 stsp .Cm got ref
1749 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1750 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1751 8e7bd50a 2019-08-22 stsp another repository.
1755 5fc4f020 2022-08-30 op .Ar path ...
1757 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1758 d00136be 2019-03-26 stsp repository in the next commit.
1759 ff56836b 2021-07-08 stsp By default, files which match a
1760 ff56836b 2021-07-08 stsp .Cm got status
1761 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1765 b88936d3 2023-06-21 stsp mentioned in the command line is not an unversioned file then
1766 b88936d3 2023-06-21 stsp .Cm got add
1767 b88936d3 2023-06-21 stsp may raise an error.
1768 b88936d3 2023-06-21 stsp To avoid unnecessary errors from paths picked up by file globbing patterns
1769 b88936d3 2023-06-21 stsp in the shell, paths in the argument list will be silently ignored if they
1770 b88936d3 2023-06-21 stsp are not reported by
1771 b88936d3 2023-06-21 stsp .Cm got status
1772 b88936d3 2023-06-21 stsp at all, or if they are reported with one of the following status codes
1773 b88936d3 2023-06-21 stsp and do not have changes staged via
1774 b88936d3 2023-06-21 stsp .Cm got stage :
1775 b88936d3 2023-06-21 stsp .Bl -column YXZ description
1776 b88936d3 2023-06-21 stsp .It M Ta modified file
1777 b88936d3 2023-06-21 stsp .It A Ta file scheduled for addition in next commit
1778 b88936d3 2023-06-21 stsp .It C Ta modified or added file which contains merge conflicts
1779 b88936d3 2023-06-21 stsp .It m Ta modified file modes (executable bit only)
1782 4e68cba3 2019-11-23 stsp The options for
1783 4e68cba3 2019-11-23 stsp .Cm got add
1784 4e68cba3 2019-11-23 stsp are as follows:
1785 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1787 827a167b 2022-08-16 stsp Add files even if they match a
1788 827a167b 2022-08-16 stsp .Cm got status
1789 827a167b 2022-08-16 stsp ignore pattern.
1791 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1792 4e68cba3 2019-11-23 stsp If this option is not specified,
1793 4e68cba3 2019-11-23 stsp .Cm got add
1794 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1796 4e68cba3 2019-11-23 stsp is a directory.
1802 5fc4f020 2022-08-30 op .Op Fl s Ar status-codes
1803 5fc4f020 2022-08-30 op .Ar path ...
1805 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rm
1806 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1807 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1809 2ec1f75b 2019-03-26 stsp The options for
1810 86d25a1b 2019-07-11 stsp .Cm got remove
1811 2ec1f75b 2019-03-26 stsp are as follows:
1812 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1814 4e12cd97 2022-01-25 stsp Perform the operation even if a file contains local modifications,
1815 4e12cd97 2022-01-25 stsp and do not raise an error if a specified
1817 4e12cd97 2022-01-25 stsp does not exist on disk.
1818 70e3e7f5 2019-12-13 tracey .It Fl k
1819 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1820 f2a9dc41 2019-12-13 tracey .It Fl R
1821 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1822 f2a9dc41 2019-12-13 tracey If this option is not specified,
1823 f2a9dc41 2019-12-13 tracey .Cm got remove
1824 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1825 f2a9dc41 2019-12-13 tracey .Ar path
1826 f2a9dc41 2019-12-13 tracey is a directory.
1827 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1828 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1829 766841c2 2020-08-13 stsp single-character status codes contained in the
1830 766841c2 2020-08-13 stsp .Ar status-codes
1832 766841c2 2020-08-13 stsp The following status codes may be specified:
1833 766841c2 2020-08-13 stsp .Bl -column YXZ description
1834 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1837 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1844 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1845 5fc4f020 2022-08-30 op .Op Fl p Ar strip-count
1846 5fc4f020 2022-08-30 op .Op Ar patchfile
1848 e9ce266e 2022-03-07 op .Dl Pq alias: Cm pa
1849 e9ce266e 2022-03-07 op Apply changes from
1850 e9ce266e 2022-03-07 op .Ar patchfile
1851 750a3093 2022-03-13 stsp to files in a work tree.
1852 986288a6 2022-03-13 stsp Files added or removed by a patch will be scheduled for addition or removal in
1853 986288a6 2022-03-13 stsp the work tree.
1855 750a3093 2022-03-13 stsp The patch must be in the unified diff format as produced by
1856 750a3093 2022-03-13 stsp .Cm got diff ,
1857 3f3a6472 2022-03-22 stsp .Xr git-diff 1 ,
1859 750a3093 2022-03-13 stsp .Xr diff 1
1862 1a7a534e 2022-03-22 stsp diff when invoked with their
1866 e9ce266e 2022-03-07 op .Ar patchfile
1867 750a3093 2022-03-13 stsp argument is provided, read unified diff data from standard input instead.
1870 750a3093 2022-03-13 stsp .Ar patchfile
1871 e38d4cde 2022-03-21 naddy contains multiple patches, then attempt to apply each of them in sequence.
1873 3e72b288 2022-03-13 stsp Show the status of each affected file, using the following status codes:
1874 e9ce266e 2022-03-07 op .Bl -column XYZ description
1875 750a3093 2022-03-13 stsp .It M Ta file was modified
1876 9802c41c 2022-06-21 op .It G Ta file was merged using a merge-base found in the repository
1877 9802c41c 2022-06-21 op .It C Ta file was merged and conflicts occurred during merge
1878 750a3093 2022-03-13 stsp .It D Ta file was deleted
1879 750a3093 2022-03-13 stsp .It A Ta file was added
1880 60aa1fa0 2022-03-17 op .It # Ta failed to patch the file
1883 750a3093 2022-03-13 stsp If a change does not match at its exact line number, attempt to
1884 3e72b288 2022-03-13 stsp apply it somewhere else in the file if a good spot can be found.
1885 3e72b288 2022-03-13 stsp Otherwise, the patch will fail to apply.
1889 dd6c3779 2022-03-13 op will refuse to apply a patch if certain preconditions are not met.
1890 3e72b288 2022-03-13 stsp Files to be deleted must already be under version control, and must
1891 3e72b288 2022-03-13 stsp not have been scheduled for deletion already.
1892 3e72b288 2022-03-13 stsp Files to be added must not yet be under version control and must not
1893 3e72b288 2022-03-13 stsp already be present on disk.
1894 3e72b288 2022-03-13 stsp Files to be modified must already be under version control and may not
1895 3e72b288 2022-03-13 stsp contain conflict markers.
1897 dd6c3779 2022-03-13 op If an error occurs, the
1899 dd6c3779 2022-03-13 op operation will be aborted.
1900 dd6c3779 2022-03-13 op Any changes made to the work tree up to this point will be left behind.
1901 750a3093 2022-03-13 stsp Such changes can be viewed with
1902 dd6c3779 2022-03-13 op .Cm got diff
1903 dd6c3779 2022-03-13 op and can be reverted with
1904 dd6c3779 2022-03-13 op .Cm got revert
1907 899fcfdf 2022-03-13 op The options for
1908 899fcfdf 2022-03-13 op .Cm got patch
1909 899fcfdf 2022-03-13 op are as follows:
1910 899fcfdf 2022-03-13 op .Bl -tag -width Ds
1911 5f56d41e 2022-07-28 op .It Fl c Ar commit
1912 76e495bd 2022-07-29 stsp Attempt to locate files within the specified
1914 76e495bd 2022-07-29 stsp for use as a merge-base for 3-way merges.
1918 10d73284 2023-07-18 stsp option is not used then
1919 10d73284 2023-07-18 stsp .Cm got patch
1920 10d73284 2023-07-18 stsp will attempt to locate merge-bases via object IDs found in
1921 10d73284 2023-07-18 stsp .Ar patchfile
1922 10d73284 2023-07-18 stsp meta-data, such as produced by
1923 10d73284 2023-07-18 stsp .Cm got diff
1925 10d73284 2023-07-18 stsp .Xr git-diff 1 .
1926 10d73284 2023-07-18 stsp Use of the
1928 10d73284 2023-07-18 stsp option is only recommended in the absence of such meta-data.
1930 10d73284 2023-07-18 stsp Ideally, the specified
1931 10d73284 2023-07-18 stsp .Ar commit
1932 10d73284 2023-07-18 stsp should contain versions of files which the changes contained in the
1933 10d73284 2023-07-18 stsp .Ar patchfile
1934 10d73284 2023-07-18 stsp were based on.
1935 10d73284 2023-07-18 stsp Files will be located by path, relative to the repository root.
1938 10d73284 2023-07-18 stsp option is used then leading path components will be stripped
1939 10d73284 2023-07-18 stsp before paths are looked up in the repository.
1941 10d73284 2023-07-18 stsp In case no merge-base is available for a file, changes will be applied
1942 10d73284 2023-07-18 stsp without doing a 3-way merge.
1943 10d73284 2023-07-18 stsp Changes which do not apply cleanly may then be rejected entirely, rather
1944 10d73284 2023-07-18 stsp than producing merge conflicts in the patched target file.
1946 c8d1a97c 2023-07-17 mark The expected
1947 c8d1a97c 2023-07-17 mark .Ar commit
1948 6b483b31 2023-07-18 stsp argument is a commit ID SHA1 hash, or a reference name or a keyword
1949 6b483b31 2023-07-18 stsp which will be resolved to a commit ID.
1950 c8d1a97c 2023-07-17 mark An abbreviated hash argument will be expanded to a full SHA1 hash
1951 c8d1a97c 2023-07-17 mark automatically, provided the abbreviation is unique.
1952 6b483b31 2023-07-18 stsp The keywords
1956 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
1957 c8d1a97c 2023-07-17 mark Keywords and references may be appended with
1961 c8d1a97c 2023-07-17 mark modifiers and an optional integer N to denote the
1962 c8d1a97c 2023-07-17 mark Nth descendant or antecedent by first parent traversal, respectively;
1963 c8d1a97c 2023-07-17 mark for example,
1964 c8d1a97c 2023-07-17 mark .Sy :head:-2
1965 c8d1a97c 2023-07-17 mark denotes the work tree branch head's 2nd generation ancestor, and
1966 c8d1a97c 2023-07-17 mark .Sy :base:+4
1967 c8d1a97c 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
1968 c8d1a97c 2023-07-17 mark Similarly,
1969 c8d1a97c 2023-07-17 mark .Sy flan:+3
1970 c8d1a97c 2023-07-17 mark will denote the 3rd generation descendant of the commit resolved by the
1972 c8d1a97c 2023-07-17 mark reference.
1977 c8d1a97c 2023-07-17 mark modifier without a trailing integer has an implicit
1981 c8d1a97c 2023-07-17 mark .Sy :base:+
1982 c8d1a97c 2023-07-17 mark is equivalent to
1983 c8d1a97c 2023-07-17 mark .Sy :base:+1
1986 899fcfdf 2022-03-13 op Do not make any modifications to the work tree.
1987 899fcfdf 2022-03-13 op This can be used to check whether a patch would apply without issues.
1989 899fcfdf 2022-03-13 op .Ar patchfile
1990 e38d4cde 2022-03-21 naddy contains diffs that affect the same file multiple times, the results
1991 899fcfdf 2022-03-13 op displayed may be incorrect.
1992 9d6cabd5 2022-04-07 op .It Fl p Ar strip-count
1993 9d6cabd5 2022-04-07 op Specify the number of leading path components to strip from paths
1995 9d6cabd5 2022-04-07 op .Ar patchfile .
1998 9d6cabd5 2022-04-07 op option is not used,
2002 9d6cabd5 2022-04-07 op path prefixes generated by
2003 9d6cabd5 2022-04-07 op .Xr git-diff 1
2004 9d6cabd5 2022-04-07 op will be recognized and stripped automatically.
2006 bad961bf 2022-04-23 op Reverse the patch before applying it.
2012 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
2013 5fc4f020 2022-08-30 op .Ar path ...
2015 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rv
2016 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
2017 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
2018 1dd86744 2019-08-12 anthony work tree's base commit.
2019 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
2020 a129376b 2019-03-28 stsp .Cm got revert !
2022 e20a8b6f 2019-06-04 stsp If a file was added with
2023 e38d4cde 2022-03-21 naddy .Cm got add ,
2024 a129376b 2019-03-28 stsp it will become an unversioned file again.
2025 e20a8b6f 2019-06-04 stsp If a file was deleted with
2026 e38d4cde 2022-03-21 naddy .Cm got remove ,
2027 a129376b 2019-03-28 stsp it will be restored.
2029 0f6d7415 2019-08-08 stsp The options for
2030 0f6d7415 2019-08-08 stsp .Cm got revert
2031 0f6d7415 2019-08-08 stsp are as follows:
2032 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
2033 827a167b 2022-08-16 stsp .It Fl F Ar response-script
2036 827a167b 2022-08-16 stsp option, read
2041 827a167b 2022-08-16 stsp responses line-by-line from the specified
2042 827a167b 2022-08-16 stsp .Ar response-script
2043 827a167b 2022-08-16 stsp file instead of prompting interactively.
2045 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
2046 33aa809d 2019-08-08 stsp changes to revert based on
2048 33aa809d 2019-08-08 stsp (revert change),
2050 33aa809d 2019-08-08 stsp (keep change), and
2052 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
2053 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
2054 33aa809d 2019-08-08 stsp modified file content can be reverted.
2055 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
2057 0f6d7415 2019-08-08 stsp Permit recursion into directories.
2058 0f6d7415 2019-08-08 stsp If this option is not specified,
2059 0f6d7415 2019-08-08 stsp .Cm got revert
2060 0f6d7415 2019-08-08 stsp will refuse to run if a specified
2062 0f6d7415 2019-08-08 stsp is a directory.
2067 12383673 2023-02-18 mark .Op Fl CNnS
2068 5fc4f020 2022-08-30 op .Op Fl A Ar author
2069 5fc4f020 2022-08-30 op .Op Fl F Ar path
2070 5fc4f020 2022-08-30 op .Op Fl m Ar message
2071 5fc4f020 2022-08-30 op .Op Ar path ...
2073 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ci
2074 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
2075 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
2078 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
2079 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
2081 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
2082 1dd86744 2019-08-12 anthony .Cm got stage ,
2083 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
2084 4ed9f614 2019-08-04 stsp have not been staged.
2086 28cf319f 2021-01-28 stsp .Cm got commit
2087 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
2088 28cf319f 2021-01-28 stsp unless the
2090 28cf319f 2021-01-28 stsp option is used
2095 28cf319f 2021-01-28 stsp options are used together.
2096 ee27b57e 2023-07-15 naddy Quitting the editor without saving the file will abort the commit operation.
2098 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
2099 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
2100 15cd91f7 2019-05-12 stsp .It M Ta modified file
2101 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
2102 15cd91f7 2019-05-12 stsp .It A Ta new file was added
2103 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
2106 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
2107 996d5ccd 2019-08-05 stsp recorded base commit.
2110 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
2111 15cd91f7 2019-05-12 stsp multiple base commits.
2112 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
2113 47ec7be7 2019-05-12 stsp .Cm got update
2114 47ec7be7 2019-05-12 stsp across the entire work tree.
2117 15cd91f7 2019-05-12 stsp .Cm got commit
2118 15cd91f7 2019-05-12 stsp command requires the
2119 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
2120 aba9c984 2019-09-08 stsp environment variable to be set,
2121 257add31 2020-09-09 stsp unless an author has been configured in
2122 257add31 2020-09-09 stsp .Xr got.conf 5
2124 aba9c984 2019-09-08 stsp .Dv user.name
2126 709ae9eb 2019-09-08 stsp .Dv user.email
2127 709ae9eb 2019-09-08 stsp configuration settings can be
2128 aba9c984 2019-09-08 stsp obtained from the repository's
2129 aba9c984 2019-09-08 stsp .Pa .git/config
2130 c9956ddf 2019-09-08 stsp file or from Git's global
2131 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2132 c9956ddf 2019-09-08 stsp configuration file.
2134 74416c47 2019-05-09 stsp The options for
2135 74416c47 2019-05-09 stsp .Cm got commit
2136 74416c47 2019-05-09 stsp are as follows:
2137 74416c47 2019-05-09 stsp .Bl -tag -width Ds
2138 62b21d33 2022-07-19 op .It Fl A Ar author
2139 62b21d33 2022-07-19 op Set author information in the newly created commit to
2140 62b21d33 2022-07-19 op .Ar author .
2141 e8049a88 2023-02-13 op This is useful when committing changes on behalf of someone else.
2144 62b21d33 2022-07-19 op argument must use the same format as the
2145 62b21d33 2022-07-19 op .Ev GOT_AUTHOR
2146 62b21d33 2022-07-19 op environment variable.
2148 62b21d33 2022-07-19 op In addition to storing author information, the newly created commit
2149 62b21d33 2022-07-19 op object will retain
2150 62b21d33 2022-07-19 op .Dq committer
2151 62b21d33 2022-07-19 op information which is obtained, as usual, from the
2152 62b21d33 2022-07-19 op .Ev GOT_AUTHOR
2153 62b21d33 2022-07-19 op environment variable, or
2154 62b21d33 2022-07-19 op .Xr got.conf 5 ,
2155 62b21d33 2022-07-19 op or Git configuration settings.
2157 12383673 2023-02-18 mark Allow committing files in conflicted status.
2159 12383673 2023-02-18 mark Committing files with conflict markers should generally be avoided.
2160 12383673 2023-02-18 mark Cases where conflict markers must be stored in the repository for
2161 12383673 2023-02-18 mark some legitimate reason should be very rare.
2162 12383673 2023-02-18 mark There are usually ways to avoid storing conflict markers verbatim by
2163 12383673 2023-02-18 mark applying appropriate programming tricks.
2164 28cf319f 2021-01-28 stsp .It Fl F Ar path
2165 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
2167 28cf319f 2021-01-28 stsp when creating the new commit.
2168 28cf319f 2021-01-28 stsp .Cm got commit
2169 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
2170 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
2171 28cf319f 2021-01-28 stsp Cannot be used together with the
2174 28cf319f 2021-01-28 stsp .It Fl m Ar message
2175 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
2176 28cf319f 2021-01-28 stsp Cannot be used together with the
2180 28cf319f 2021-01-28 stsp This option prevents
2181 23594da9 2019-05-13 stsp .Cm got commit
2182 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
2183 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
2185 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
2187 2a47b1e5 2022-11-01 stsp This option prevents
2188 2a47b1e5 2022-11-01 stsp .Cm got commit
2189 2a47b1e5 2022-11-01 stsp from generating a diff of the to-be-committed changes in a temporary file
2190 2a47b1e5 2022-11-01 stsp which can be viewed while editing a commit message.
2192 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
2193 af358f55 2020-07-23 stsp that is under version control.
2194 af358f55 2020-07-23 stsp By default,
2195 af358f55 2020-07-23 stsp .Cm got commit
2196 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2197 35213c7c 2020-07-23 stsp As a precaution,
2199 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2200 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2201 af358f55 2020-07-23 stsp points outside of the work tree.
2202 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2203 af358f55 2020-07-23 stsp .Dq make obj
2204 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2205 af358f55 2020-07-23 stsp version control.
2208 cfce0458 2019-07-28 stsp .Cm got commit
2209 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
2210 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
2211 916f288c 2019-07-30 stsp .Dq refs/heads/
2212 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
2213 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
2214 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
2215 cfce0458 2019-07-28 stsp If a path is found to be out of date,
2216 cfce0458 2019-07-28 stsp .Cm got update
2217 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
2218 cfce0458 2019-07-28 stsp in the repository.
2222 5fc4f020 2022-08-30 op .Op Fl afqTv
2223 5fc4f020 2022-08-30 op .Op Fl b Ar branch
2224 5fc4f020 2022-08-30 op .Op Fl d Ar branch
2225 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
2226 5fc4f020 2022-08-30 op .Op Fl t Ar tag
2227 5fc4f020 2022-08-30 op .Op Ar remote-repository
2229 4683a10b 2021-11-04 kn .Dl Pq alias: Cm se
2230 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
2232 f8a36e22 2021-08-26 stsp .Ar remote-repository
2233 f8a36e22 2021-08-26 stsp is specified,
2234 f8a36e22 2021-08-26 stsp .Dq origin
2235 f8a36e22 2021-08-26 stsp will be used.
2236 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
2237 f8a36e22 2021-08-26 stsp .Xr got.conf 5
2239 f8a36e22 2021-08-26 stsp .Pa config
2240 f8a36e22 2021-08-26 stsp file of the local repository, as created by
2241 f8a36e22 2021-08-26 stsp .Cm got clone .
2243 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
2244 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
2245 f8a36e22 2021-08-26 stsp Upon success, references in the
2246 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
2247 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
2248 f8a36e22 2021-08-26 stsp the commits which have been sent.
2250 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
2251 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
2252 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
2253 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
2254 fd44090b 2021-08-26 stsp be fetched from the server with
2255 f8a36e22 2021-08-26 stsp .Cm got fetch
2256 f8a36e22 2021-08-26 stsp and local branches must be rebased with
2257 f8a36e22 2021-08-26 stsp .Cm got rebase
2259 f8a36e22 2021-08-26 stsp .Cm got send
2260 f8a36e22 2021-08-26 stsp can succeed.
2263 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
2265 f8a36e22 2021-08-26 stsp The options for
2266 f8a36e22 2021-08-26 stsp .Cm got send
2267 f8a36e22 2021-08-26 stsp are as follows:
2268 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
2270 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
2271 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2272 f8a36e22 2021-08-26 stsp reference namespace.
2275 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
2278 f8a36e22 2021-08-26 stsp Cannot be used together with the
2281 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
2282 f8a36e22 2021-08-26 stsp Send the specified
2283 f8a36e22 2021-08-26 stsp .Ar branch
2284 f8a36e22 2021-08-26 stsp from the local repository's
2285 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2286 f8a36e22 2021-08-26 stsp reference namespace.
2287 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2289 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
2290 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
2291 f8a36e22 2021-08-26 stsp Cannot be used together with the
2294 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
2295 f8a36e22 2021-08-26 stsp Delete the specified
2296 f8a36e22 2021-08-26 stsp .Ar branch
2297 f8a36e22 2021-08-26 stsp from the remote repository's
2298 f8a36e22 2021-08-26 stsp .Dq refs/heads/
2299 f8a36e22 2021-08-26 stsp reference namespace.
2300 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
2301 f8a36e22 2021-08-26 stsp to delete.
2303 f8a36e22 2021-08-26 stsp Only references are deleted.
2304 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
2305 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
2306 f8a36e22 2021-08-26 stsp the server.
2308 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
2309 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
2310 fd44090b 2021-08-26 stsp based on its configuration.
2312 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
2313 fd44090b 2021-08-26 stsp in the remote repository, even when
2314 fd44090b 2021-08-26 stsp .Cm got fetch
2315 7b53188e 2023-07-03 stsp followed by
2316 fd44090b 2021-08-26 stsp .Cm got rebase
2318 7b53188e 2023-07-03 stsp .Cm got merge
2319 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
2320 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
2321 f8a36e22 2021-08-26 stsp configuration.
2323 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
2324 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
2325 f8a36e22 2021-08-26 stsp on the server.
2328 f8a36e22 2021-08-26 stsp .Dq refs/tags
2329 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
2330 f8a36e22 2021-08-26 stsp Use of the
2332 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
2333 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
2334 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2335 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2337 f8a36e22 2021-08-26 stsp Use of the
2339 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
2340 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
2341 f8a36e22 2021-08-26 stsp Instead of using the
2343 f8a36e22 2021-08-26 stsp option, new changes should
2344 f8a36e22 2021-08-26 stsp be fetched with
2345 f8a36e22 2021-08-26 stsp .Cm got fetch
2346 f8a36e22 2021-08-26 stsp and local branches should be rebased with
2347 7b53188e 2023-07-03 stsp .Cm got rebase
2348 7b53188e 2023-07-03 stsp or merged with
2349 7b53188e 2023-07-03 stsp .Cm got merge ,
2350 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
2354 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
2355 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
2356 f8a36e22 2021-08-26 stsp disposable.
2357 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
2358 f8a36e22 2021-08-26 stsp should also be taken into account.
2360 827a167b 2022-08-16 stsp Suppress progress reporting output.
2361 827a167b 2022-08-16 stsp The same option will be passed to
2363 827a167b 2022-08-16 stsp if applicable.
2364 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
2365 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
2366 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
2367 f8a36e22 2021-08-26 stsp working directory.
2368 f8a36e22 2021-08-26 stsp If this directory is a
2370 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
2372 827a167b 2022-08-16 stsp Attempt to send all tags from the local repository's
2373 827a167b 2022-08-16 stsp .Dq refs/tags/
2374 827a167b 2022-08-16 stsp reference namespace.
2377 827a167b 2022-08-16 stsp option is equivalent to listing all tags with multiple
2380 827a167b 2022-08-16 stsp Cannot be used together with the
2383 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
2384 f8a36e22 2021-08-26 stsp Send the specified
2386 f8a36e22 2021-08-26 stsp from the local repository's
2387 f8a36e22 2021-08-26 stsp .Dq refs/tags/
2388 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
2391 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
2392 f8a36e22 2021-08-26 stsp No tags will be sent if the
2394 f8a36e22 2021-08-26 stsp option is not used.
2396 f8a36e22 2021-08-26 stsp Raise an error if the specified
2398 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
2400 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
2401 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
2402 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
2404 f8a36e22 2021-08-26 stsp Cannot be used together with the
2408 f8a36e22 2021-08-26 stsp Verbose mode.
2410 f8a36e22 2021-08-26 stsp .Cm got send
2411 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
2412 f8a36e22 2021-08-26 stsp The same option will be passed to
2414 f8a36e22 2021-08-26 stsp if applicable.
2415 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
2416 f8a36e22 2021-08-26 stsp The maximum is 3.
2420 9587e6cc 2023-01-28 mark .Cm cherrypick
2422 555f1fe0 2023-01-28 stsp .Op Ar commit
2424 4683a10b 2021-11-04 kn .Dl Pq alias: Cm cy
2425 234035bc 2019-06-01 stsp Merge changes from a single
2426 234035bc 2019-06-01 stsp .Ar commit
2427 234035bc 2019-06-01 stsp into the work tree.
2428 234035bc 2019-06-01 stsp The specified
2429 234035bc 2019-06-01 stsp .Ar commit
2430 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
2432 6b483b31 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name or
2433 6b483b31 2023-07-18 stsp keyword which will be resolved to a commit ID.
2434 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2435 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2436 6b483b31 2023-07-18 stsp The keywords
2440 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
2441 c8d1a97c 2023-07-17 mark Keywords and references may be appended with
2445 c8d1a97c 2023-07-17 mark modifiers and an optional integer N to denote the
2446 c8d1a97c 2023-07-17 mark Nth descendant or antecedent by first parent traversal, respectively;
2447 c8d1a97c 2023-07-17 mark for example,
2448 c8d1a97c 2023-07-17 mark .Sy :head:-2
2449 c8d1a97c 2023-07-17 mark denotes the work tree branch head's 2nd generation ancestor, and
2450 c8d1a97c 2023-07-17 mark .Sy :base:+4
2451 c8d1a97c 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
2452 c8d1a97c 2023-07-17 mark Similarly,
2453 c8d1a97c 2023-07-17 mark .Sy barbaz:+3
2454 c8d1a97c 2023-07-17 mark will denote the 3rd generation descendant of the commit resolved by the
2455 c8d1a97c 2023-07-17 mark .Qq barbaz
2456 c8d1a97c 2023-07-17 mark reference.
2461 c8d1a97c 2023-07-17 mark modifier without a trailing integer has an implicit
2465 c8d1a97c 2023-07-17 mark .Sy :base:+
2466 c8d1a97c 2023-07-17 mark is equivalent to
2467 c8d1a97c 2023-07-17 mark .Sy :base:+1
2470 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
2471 234035bc 2019-06-01 stsp .Bl -column YXZ description
2472 234035bc 2019-06-01 stsp .It G Ta file was merged
2473 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
2474 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
2475 234035bc 2019-06-01 stsp .It D Ta file was deleted
2476 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2477 234035bc 2019-06-01 stsp .It A Ta new file was added
2478 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2479 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2482 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2483 234035bc 2019-06-01 stsp may be viewed with
2484 234035bc 2019-06-01 stsp .Cm got diff ,
2485 234035bc 2019-06-01 stsp amended manually or with further
2486 234035bc 2019-06-01 stsp .Cm got cherrypick
2488 234035bc 2019-06-01 stsp committed with
2489 4c16511c 2023-01-28 stsp .Cm got commit .
2491 4c16511c 2023-01-28 stsp If invoked in a work tree where no
2492 4c16511c 2023-01-28 stsp .Cm rebase ,
2493 4c16511c 2023-01-28 stsp .Cm histedit ,
2496 4c16511c 2023-01-28 stsp operation is taking place,
2497 4c16511c 2023-01-28 stsp .Cm got cherrypick
2498 4c16511c 2023-01-28 stsp creates a record of commits which have been merged into the work tree.
2499 4c16511c 2023-01-28 stsp When a file changed by
2500 4c16511c 2023-01-28 stsp .Cm got cherrypick
2501 4c16511c 2023-01-28 stsp is committed with
2502 4c16511c 2023-01-28 stsp .Cm got commit ,
2503 4c16511c 2023-01-28 stsp the log messages of relevant merged commits will then appear in the editor,
2504 91a3781a 2023-02-09 stsp where the messages should be further adjusted to convey the reasons for
2505 8bf76af3 2023-01-28 stsp cherrypicking the changes.
2506 93436ccd 2023-02-10 mark Upon exiting the editor, if the time stamp of the log message file
2507 93436ccd 2023-02-10 mark is unchanged or the log message is empty,
2508 91a3781a 2023-02-09 stsp .Cm got commit
2509 93436ccd 2023-02-10 mark will fail with an unmodified or empty log message error.
2511 4c16511c 2023-01-28 stsp If all the changes in all files touched by a given commit are discarded,
2513 4c16511c 2023-01-28 stsp .Cm got revert ,
2514 4c16511c 2023-01-28 stsp this commit's log message record will also disappear.
2516 234035bc 2019-06-01 stsp .Cm got cherrypick
2517 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2518 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2519 234035bc 2019-06-01 stsp to a single base commit with
2520 234035bc 2019-06-01 stsp .Cm got update .
2521 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2522 234035bc 2019-06-01 stsp conflicts must be resolved first.
2524 9587e6cc 2023-01-28 mark The options for
2526 9587e6cc 2023-01-28 mark .Cm cherrypick
2527 9587e6cc 2023-01-28 mark are as follows:
2528 9587e6cc 2023-01-28 mark .Bl -tag -width Ds
2530 9587e6cc 2023-01-28 mark Display a list of commit log messages recorded by cherrypick operations,
2531 9587e6cc 2023-01-28 mark represented by references in the
2532 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2533 9587e6cc 2023-01-28 mark reference namespace.
2535 9587e6cc 2023-01-28 mark .Ar commit
2536 9587e6cc 2023-01-28 mark is specified, only show the log message of the specified commit.
2538 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by cherrypick operations
2539 9587e6cc 2023-01-28 mark in the current work tree will be displayed.
2540 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be displayed irrespective of the
2541 9587e6cc 2023-01-28 mark work tree in which they were created.
2542 9587e6cc 2023-01-28 mark This option cannot be used with
2545 9587e6cc 2023-01-28 mark Delete log messages created by previous cherrypick operations, represented by
2546 9587e6cc 2023-01-28 mark references in the
2547 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2548 9587e6cc 2023-01-28 mark reference namespace.
2550 9587e6cc 2023-01-28 mark .Ar commit
2551 9587e6cc 2023-01-28 mark is specified, only delete the log message of the specified commit.
2553 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by cherrypick operations
2554 9587e6cc 2023-01-28 mark in the current work tree will be deleted.
2555 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be deleted irrespective of the
2556 9587e6cc 2023-01-28 mark work tree in which they were created.
2557 9587e6cc 2023-01-28 mark This option cannot be used with
2563 9587e6cc 2023-01-28 mark .Cm backout
2565 555f1fe0 2023-01-28 stsp .Op Ar commit
2567 4683a10b 2021-11-04 kn .Dl Pq alias: Cm bo
2568 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2569 5ef14e63 2019-06-02 stsp .Ar commit
2570 5ef14e63 2019-06-02 stsp into the work tree.
2571 5ef14e63 2019-06-02 stsp The specified
2572 5ef14e63 2019-06-02 stsp .Ar commit
2573 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2575 6b483b31 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name
2576 6b483b31 2023-07-18 stsp or keyword which will be resolved to a commit ID.
2577 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2578 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2579 6b483b31 2023-07-18 stsp The keywords
2583 6b483b31 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
2584 c8d1a97c 2023-07-17 mark Keywords and references may be appended with
2588 c8d1a97c 2023-07-17 mark modifiers and an optional integer N to denote the
2589 c8d1a97c 2023-07-17 mark Nth descendant or antecedent by first parent traversal, respectively;
2590 c8d1a97c 2023-07-17 mark for example,
2591 c8d1a97c 2023-07-17 mark .Sy :head:-2
2592 c8d1a97c 2023-07-17 mark denotes the work tree branch head's 2nd generation ancestor, and
2593 c8d1a97c 2023-07-17 mark .Sy :base:+4
2594 c8d1a97c 2023-07-17 mark denotes the 4th generation descendant of the work tree's base commit.
2595 c8d1a97c 2023-07-17 mark Similarly,
2596 c8d1a97c 2023-07-17 mark .Sy wip:+5
2597 c8d1a97c 2023-07-17 mark will denote the 5th generation descendant of the commit resolved by the
2599 c8d1a97c 2023-07-17 mark reference.
2604 c8d1a97c 2023-07-17 mark modifier without a trailing integer has an implicit
2608 c8d1a97c 2023-07-17 mark .Sy :base:+
2609 c8d1a97c 2023-07-17 mark is equivalent to
2610 c8d1a97c 2023-07-17 mark .Sy :base:+1
2613 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2614 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2615 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2616 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2617 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2618 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2619 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2620 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2621 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2622 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2625 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2626 5ef14e63 2019-06-02 stsp which may be viewed with
2627 5ef14e63 2019-06-02 stsp .Cm got diff ,
2628 5ef14e63 2019-06-02 stsp amended manually or with further
2629 778a73c2 2019-07-12 stsp .Cm got backout
2631 5ef14e63 2019-06-02 stsp committed with
2632 4c16511c 2023-01-28 stsp .Cm got commit .
2634 4c16511c 2023-01-28 stsp If invoked in a work tree where no
2635 4c16511c 2023-01-28 stsp .Cm rebase ,
2636 4c16511c 2023-01-28 stsp .Cm histedit ,
2639 4c16511c 2023-01-28 stsp operation is taking place,
2640 4c16511c 2023-01-28 stsp .Cm got backout
2641 4c16511c 2023-01-28 stsp creates a record of commits which have been reverse-merged into the work tree.
2642 4c16511c 2023-01-28 stsp When a file changed by
2643 4c16511c 2023-01-28 stsp .Cm got backout
2644 4c16511c 2023-01-28 stsp is committed with
2645 4c16511c 2023-01-28 stsp .Cm got commit ,
2646 4c16511c 2023-01-28 stsp the log messages of relevant reverse-merged commits will then appear in
2647 91a3781a 2023-02-09 stsp the editor, where the messages should be further adjusted to convey the
2648 8bf76af3 2023-01-28 stsp reasons for backing out the changes.
2649 93436ccd 2023-02-10 mark Upon exiting the editor, if the time stamp of the log message file
2650 93436ccd 2023-02-10 mark is unchanged or the log message is empty,
2651 91a3781a 2023-02-09 stsp .Cm got commit
2652 93436ccd 2023-02-10 mark will fail with an unmodified or empty log message error.
2654 4c16511c 2023-01-28 stsp If all the changes in all files touched by a given commit are discarded,
2656 4c16511c 2023-01-28 stsp .Cm got revert ,
2657 4c16511c 2023-01-28 stsp this commit's log message record will also disappear.
2659 92228c38 2019-06-02 stsp .Cm got backout
2660 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2661 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2662 92228c38 2019-06-02 stsp to a single base commit with
2663 92228c38 2019-06-02 stsp .Cm got update .
2664 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2665 92228c38 2019-06-02 stsp conflicts must be resolved first.
2667 9587e6cc 2023-01-28 mark The options for
2669 9587e6cc 2023-01-28 mark .Cm backout
2670 9587e6cc 2023-01-28 mark are as follows:
2671 9587e6cc 2023-01-28 mark .Bl -tag -width Ds
2673 9587e6cc 2023-01-28 mark Display a list of commit log messages recorded by backout operations,
2674 9587e6cc 2023-01-28 mark represented by references in the
2675 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2676 9587e6cc 2023-01-28 mark reference namespace.
2678 9587e6cc 2023-01-28 mark .Ar commit
2679 9587e6cc 2023-01-28 mark is specified, only show the log message of the specified commit.
2681 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by backout operations
2682 9587e6cc 2023-01-28 mark in the current work tree will be displayed.
2683 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be displayed irrespective of the
2684 9587e6cc 2023-01-28 mark work tree in which they were created.
2685 9587e6cc 2023-01-28 mark This option cannot be used with
2688 9587e6cc 2023-01-28 mark Delete log messages created by previous backout operations, represented by
2689 9587e6cc 2023-01-28 mark references in the
2690 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2691 9587e6cc 2023-01-28 mark reference namespace.
2693 9587e6cc 2023-01-28 mark .Ar commit
2694 9587e6cc 2023-01-28 mark is specified, only delete the log message of the specified commit.
2696 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by backout operations
2697 9587e6cc 2023-01-28 mark in the current work tree will be deleted.
2698 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be deleted irrespective of the
2699 9587e6cc 2023-01-28 mark work tree in which they were created.
2700 9587e6cc 2023-01-28 mark This option cannot be used with
2707 12383673 2023-02-18 mark .Op Fl aCclX
2708 5fc4f020 2022-08-30 op .Op Ar branch
2710 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rb
2711 818c7501 2019-07-11 stsp Rebase commits on the specified
2712 818c7501 2019-07-11 stsp .Ar branch
2713 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2715 818c7501 2019-07-11 stsp .Ar branch
2716 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2717 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2718 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2719 818c7501 2019-07-11 stsp .Ar branch
2720 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2721 f09e2405 2019-07-11 stsp of the specified
2722 818c7501 2019-07-11 stsp .Ar branch
2723 f09e2405 2019-07-11 stsp has been rebased.
2726 2b6826ba 2020-02-24 stsp .Cm got rebase
2727 2b6826ba 2020-02-24 stsp is used as intended, the specified
2728 2b6826ba 2020-02-24 stsp .Ar branch
2729 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2730 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2731 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2732 2b6826ba 2020-02-24 stsp .Cm got update -b
2733 2b6826ba 2020-02-24 stsp before starting the
2734 2b6826ba 2020-02-24 stsp .Cm rebase
2735 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2736 2b6826ba 2020-02-24 stsp a common history with the specified
2737 2b6826ba 2020-02-24 stsp .Ar branch
2738 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2739 c10890ce 2020-02-25 stsp remote repository.
2741 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2742 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2743 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2744 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2745 818c7501 2019-07-11 stsp .Ar branch ,
2746 818c7501 2019-07-11 stsp but with different commit IDs.
2747 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2748 f09e2405 2019-07-11 stsp the new version of the specified
2749 818c7501 2019-07-11 stsp .Ar branch
2750 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2751 7f5531cd 2022-07-22 stsp If author information is available via the
2752 7f5531cd 2022-07-22 stsp .Ev GOT_AUTHOR
2753 7f5531cd 2022-07-22 stsp environment variable,
2754 7f5531cd 2022-07-22 stsp .Xr got.conf 5
2756 7f5531cd 2022-07-22 stsp .Dv user.name
2758 7f5531cd 2022-07-22 stsp .Dv user.email
2759 7f5531cd 2022-07-22 stsp configuration settings, this author information will be used to identify
2761 7f5531cd 2022-07-22 stsp .Dq committer
2762 7f5531cd 2022-07-22 stsp of rebased commits.
2764 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2765 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2766 e600f124 2021-03-21 stsp reference namespace.
2767 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2768 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2769 e600f124 2021-03-21 stsp .Cm got rebase -l
2771 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2772 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2773 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2775 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2776 818c7501 2019-07-11 stsp using the following status codes:
2777 818c7501 2019-07-11 stsp .Bl -column YXZ description
2778 818c7501 2019-07-11 stsp .It G Ta file was merged
2779 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2780 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2781 818c7501 2019-07-11 stsp .It D Ta file was deleted
2782 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2783 818c7501 2019-07-11 stsp .It A Ta new file was added
2784 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2785 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2788 e38d4cde 2022-03-21 naddy If merge conflicts occur, the rebase operation is interrupted and may
2789 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2790 1fa49072 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
2791 1fa49072 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
2792 1fa49072 2021-09-28 stsp the rebase operation will be interrupted to prevent potentially incomplete
2793 1fa49072 2021-09-28 stsp changes from being committed to the repository without user intervention.
2794 1fa49072 2021-09-28 stsp The work tree may be modified as desired and the rebase operation can be
2795 1fa49072 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
2796 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2797 818c7501 2019-07-11 stsp .Ar branch
2798 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2800 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2801 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2802 f09e2405 2019-07-11 stsp when the rebase operation continues.
2804 818c7501 2019-07-11 stsp .Cm got rebase
2805 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2807 442ede73 2022-09-04 stsp .Ar branch
2808 442ede73 2022-09-04 stsp is not in the
2809 442ede73 2022-09-04 stsp .Dq refs/heads/
2810 442ede73 2022-09-04 stsp reference namespace, the branch may not be rebased.
2811 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2812 e38d4cde 2022-03-21 naddy branch, then the work tree must first be updated with
2813 818c7501 2019-07-11 stsp .Cm got update .
2814 4ed9f614 2019-08-04 stsp If changes have been staged with
2815 4ed9f614 2019-08-04 stsp .Cm got stage ,
2816 bc3056e3 2019-08-18 stsp these changes must first be committed with
2817 4ed9f614 2019-08-04 stsp .Cm got commit
2818 4ed9f614 2019-08-04 stsp or unstaged with
2819 4ed9f614 2019-08-04 stsp .Cm got unstage .
2820 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2821 f09e2405 2019-07-11 stsp committed with
2822 f09e2405 2019-07-11 stsp .Cm got commit
2823 f09e2405 2019-07-11 stsp or reverted with
2824 f09e2405 2019-07-11 stsp .Cm got revert .
2826 64c6d990 2019-07-11 stsp .Ar branch
2827 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2828 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2831 dae92a24 2023-01-08 stsp .Cm got update ,
2832 dae92a24 2023-01-08 stsp .Cm got integrate ,
2833 dae92a24 2023-01-08 stsp .Cm got merge ,
2834 dae92a24 2023-01-08 stsp .Cm got commit ,
2836 dae92a24 2023-01-08 stsp .Cm got histedit
2837 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2838 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2839 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2841 2af61735 2021-11-03 stsp If the specified
2842 2af61735 2021-11-03 stsp .Ar branch
2843 e38d4cde 2022-03-21 naddy is already based on the work tree's current branch, then no commits
2844 2af61735 2021-11-03 stsp need to be rebased and
2845 2af61735 2021-11-03 stsp .Cm got rebase
2846 2af61735 2021-11-03 stsp will simply switch the work tree to the specified
2847 2af61735 2021-11-03 stsp .Ar branch
2848 2af61735 2021-11-03 stsp and update files in the work tree accordingly.
2850 818c7501 2019-07-11 stsp The options for
2851 818c7501 2019-07-11 stsp .Cm got rebase
2852 818c7501 2019-07-11 stsp are as follows:
2853 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2855 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2856 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2858 12383673 2023-02-18 mark Allow a rebase operation to continue with files in conflicted status.
2859 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
2863 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2864 a6c2ea42 2023-07-01 falsifian If this option is used, no other command-line arguments are allowed except
2865 a6c2ea42 2023-07-01 falsifian .Fl C .
2867 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2868 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2869 e600f124 2021-03-21 stsp reference namespace.
2871 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2872 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2873 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2874 e600f124 2021-03-21 stsp Given these object IDs,
2876 e600f124 2021-03-21 stsp .Cm got log
2877 e600f124 2021-03-21 stsp command with the
2881 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2883 e600f124 2021-03-21 stsp .Cm got branch
2884 e600f124 2021-03-21 stsp command with the
2886 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2889 e600f124 2021-03-21 stsp .Ar branch
2890 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2892 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2894 e600f124 2021-03-21 stsp If this option is used,
2895 e600f124 2021-03-21 stsp .Cm got rebase
2896 e600f124 2021-03-21 stsp does not require a work tree.
2897 e600f124 2021-03-21 stsp None of the other options can be used together with
2900 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
2902 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
2903 643b85bc 2021-07-16 stsp reference namespace.
2906 643b85bc 2021-07-16 stsp .Ar branch
2907 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2908 643b85bc 2021-07-16 stsp this branch.
2909 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2910 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
2912 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2913 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2914 643b85bc 2021-07-16 stsp Git's garbage collector or
2915 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2917 643b85bc 2021-07-16 stsp If this option is used,
2918 643b85bc 2021-07-16 stsp .Cm got rebase
2919 643b85bc 2021-07-16 stsp does not require a work tree.
2920 643b85bc 2021-07-16 stsp None of the other options can be used together with
2925 5fc4f020 2022-08-30 op .Cm histedit
2926 12383673 2023-02-18 mark .Op Fl aCcdeflmX
2927 5fc4f020 2022-08-30 op .Op Fl F Ar histedit-script
2928 5fc4f020 2022-08-30 op .Op Ar branch
2930 4683a10b 2021-11-04 kn .Dl Pq alias: Cm he
2931 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
2932 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
2935 7f5531cd 2022-07-22 stsp .Cm got histedit
2936 7f5531cd 2022-07-22 stsp command requires the
2937 7f5531cd 2022-07-22 stsp .Ev GOT_AUTHOR
2938 7f5531cd 2022-07-22 stsp environment variable to be set,
2939 7f5531cd 2022-07-22 stsp unless an author has been configured in
2940 7f5531cd 2022-07-22 stsp .Xr got.conf 5
2942 7f5531cd 2022-07-22 stsp .Dv user.name
2944 7f5531cd 2022-07-22 stsp .Dv user.email
2945 7f5531cd 2022-07-22 stsp configuration settings can be obtained from the repository's
2946 7f5531cd 2022-07-22 stsp .Pa .git/config
2947 7f5531cd 2022-07-22 stsp file or from Git's global
2948 7f5531cd 2022-07-22 stsp .Pa ~/.gitconfig
2949 7f5531cd 2022-07-22 stsp configuration file.
2951 6e54d307 2020-02-24 stsp Before starting a
2952 6e54d307 2020-02-24 stsp .Cm histedit
2953 e38d4cde 2022-03-21 naddy operation, the work tree's current branch must be set with
2954 6e54d307 2020-02-24 stsp .Cm got update -b
2955 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
2956 6e54d307 2020-02-24 stsp current branch of the work tree.
2957 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
2958 6e54d307 2020-02-24 stsp touched by the
2959 6e54d307 2020-02-24 stsp .Cm histedit
2960 6e54d307 2020-02-24 stsp operation.
2962 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
2963 6e54d307 2020-02-24 stsp must be set with
2964 6e54d307 2020-02-24 stsp .Cm got update -c
2965 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
2966 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
2968 6e54d307 2020-02-24 stsp .Cm histedit
2969 6e54d307 2020-02-24 stsp operation.
2971 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
2972 0ebf8283 2019-07-24 stsp .Ar histedit script
2973 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
2974 46fa4c83 2020-02-24 stsp command line, or generated with the
2981 ee27b57e 2023-07-15 naddy Quitting the editor without saving the file will abort the histedit operation.
2983 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
2984 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
2985 0ebf8283 2019-07-24 stsp whitespace and an argument.
2986 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
2987 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
2988 0ebf8283 2019-07-24 stsp Lines which begin with the
2990 0ebf8283 2019-07-24 stsp character are ignored entirely.
2992 d42bbff9 2022-07-12 stsp The available histedit script commands are as follows:
2993 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
2994 d42bbff9 2022-07-12 stsp .It Cm pick Ar commit Ta Use the specified commit as it is.
2995 6685e2e8 2023-02-27 stsp .It Cm edit Ar commit Ta Apply the changes from the specified commit, but
2996 6685e2e8 2023-02-27 stsp then interrupt the histedit operation for amending, without creating a commit.
2997 456d8970 2023-02-27 stsp While the histedit operation is interrupted arbitrary files may be edited,
2998 456d8970 2023-02-27 stsp and commands which manipulate the work tree can be used freely.
3000 456d8970 2023-02-27 stsp .Cm got add
3002 456d8970 2023-02-27 stsp .Cm got remove
3003 456d8970 2023-02-27 stsp commands can be used to add new files or remove existing ones.
3005 456d8970 2023-02-27 stsp .Cm got revert -p
3006 456d8970 2023-02-27 stsp command can be used to eliminate arbitrary changes from files in the work tree.
3008 456d8970 2023-02-27 stsp .Cm got stage -p
3009 456d8970 2023-02-27 stsp command may be used to prepare a subset of changes for inclusion in the
3010 456d8970 2023-02-27 stsp next commit.
3011 456d8970 2023-02-27 stsp Finally, the
3012 456d8970 2023-02-27 stsp .Cm got commit
3013 456d8970 2023-02-27 stsp command can be used to insert arbitrary commits into the edited history.
3014 456d8970 2023-02-27 stsp Regular editing of history must eventually be resumed by running
3015 456d8970 2023-02-27 stsp .Cm got histedit -c .
3016 d42bbff9 2022-07-12 stsp .It Cm fold Ar commit Ta Combine the specified commit with the next commit
3017 0ebf8283 2019-07-24 stsp listed further below that will be used.
3018 d42bbff9 2022-07-12 stsp .It Cm drop Ar commit Ta Remove this commit from the edited history.
3019 14eb0fef 2023-10-26 stsp .It Cm mesg Ar commit Ta Open an editor to create a new log message for this
3023 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
3024 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
3025 5b87815e 2020-03-05 stsp No commit may be listed more than once.
3027 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
3028 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
3029 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
3030 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
3031 498a90b7 2019-07-25 stsp switched to it.
3033 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
3034 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3035 e600f124 2021-03-21 stsp reference namespace.
3036 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
3037 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
3038 e600f124 2021-03-21 stsp .Cm got histedit -l
3040 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
3041 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
3042 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
3044 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
3045 0ebf8283 2019-07-24 stsp using the following status codes:
3046 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
3047 0ebf8283 2019-07-24 stsp .It G Ta file was merged
3048 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
3049 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
3050 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
3051 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
3052 0ebf8283 2019-07-24 stsp .It A Ta new file was added
3053 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3054 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
3057 e38d4cde 2022-03-21 naddy If merge conflicts occur, the histedit operation is interrupted and may
3058 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
3059 cd33da48 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
3060 cd33da48 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
3061 cd33da48 2021-09-28 stsp the histedit operation will be interrupted to prevent potentially incomplete
3062 cd33da48 2021-09-28 stsp changes from being committed to the repository without user intervention.
3063 cd33da48 2021-09-28 stsp The work tree may be modified as desired and the histedit operation can be
3064 cd33da48 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
3065 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
3066 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
3068 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
3069 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
3070 0ebf8283 2019-07-24 stsp when the histedit operation continues.
3072 0ebf8283 2019-07-24 stsp .Cm got histedit
3073 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
3074 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
3075 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
3076 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
3077 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
3078 0ebf8283 2019-07-24 stsp to a single base commit with
3079 0ebf8283 2019-07-24 stsp .Cm got update .
3080 4ed9f614 2019-08-04 stsp If changes have been staged with
3081 4ed9f614 2019-08-04 stsp .Cm got stage ,
3082 bc3056e3 2019-08-18 stsp these changes must first be committed with
3083 4ed9f614 2019-08-04 stsp .Cm got commit
3084 4ed9f614 2019-08-04 stsp or unstaged with
3085 4ed9f614 2019-08-04 stsp .Cm got unstage .
3086 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
3087 0ebf8283 2019-07-24 stsp committed with
3088 0ebf8283 2019-07-24 stsp .Cm got commit
3089 0ebf8283 2019-07-24 stsp or reverted with
3090 0ebf8283 2019-07-24 stsp .Cm got revert .
3091 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
3092 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
3095 7ef62c4e 2020-02-24 stsp .Cm got update ,
3096 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
3097 dae92a24 2023-01-08 stsp .Cm got merge ,
3099 65db4ffb 2020-02-24 stsp .Cm got integrate
3100 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
3101 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
3102 0ebf8283 2019-07-24 stsp .Cm got commit
3103 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
3104 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
3106 0ebf8283 2019-07-24 stsp The options for
3107 0ebf8283 2019-07-24 stsp .Cm got histedit
3108 0ebf8283 2019-07-24 stsp are as follows:
3109 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
3111 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
3112 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
3114 12383673 2023-02-18 mark Allow a histedit operation to continue with files in conflicted status.
3115 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
3119 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
3120 a6c2ea42 2023-07-01 falsifian If this option is used, no other command-line arguments are allowed except
3121 a6c2ea42 2023-07-01 falsifian .Fl C .
3123 f1c9fe20 2023-01-30 mark Drop all commits.
3124 f1c9fe20 2023-01-30 mark This option is a quick equivalent to a histedit script which drops all
3128 f1c9fe20 2023-01-30 mark option can only be used when starting a new histedit operation.
3129 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
3131 b93c7142 2021-10-01 stsp Interrupt the histedit operation for editing after merging each commit.
3132 b93c7142 2021-10-01 stsp This option is a quick equivalent to a histedit script which uses the
3134 b93c7142 2021-10-01 stsp command for all commits.
3137 b93c7142 2021-10-01 stsp option can only be used when starting a new histedit operation.
3138 b93c7142 2021-10-01 stsp If this option is used, no other command-line arguments are allowed.
3139 827a167b 2022-08-16 stsp .It Fl F Ar histedit-script
3140 827a167b 2022-08-16 stsp Use the specified
3141 827a167b 2022-08-16 stsp .Ar histedit-script
3142 827a167b 2022-08-16 stsp instead of opening a temporary file in an editor where a histedit script
3143 827a167b 2022-08-16 stsp can be written.
3145 466785b9 2020-12-10 jrick Fold all commits into a single commit.
3146 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
3147 466785b9 2020-12-10 jrick commits, combining them all into one commit.
3150 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
3151 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
3153 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
3154 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
3155 e600f124 2021-03-21 stsp reference namespace.
3157 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
3158 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
3159 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
3160 e600f124 2021-03-21 stsp Given these object IDs,
3162 e600f124 2021-03-21 stsp .Cm got log
3163 e600f124 2021-03-21 stsp command with the
3167 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
3169 e600f124 2021-03-21 stsp .Cm got branch
3170 e600f124 2021-03-21 stsp command with the
3172 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
3175 e600f124 2021-03-21 stsp .Ar branch
3176 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
3178 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
3180 e600f124 2021-03-21 stsp If this option is used,
3181 e600f124 2021-03-21 stsp .Cm got histedit
3182 e600f124 2021-03-21 stsp does not require a work tree.
3183 e600f124 2021-03-21 stsp None of the other options can be used together with
3186 827a167b 2022-08-16 stsp Edit log messages only.
3187 827a167b 2022-08-16 stsp This option is a quick equivalent to a histedit script which edits
3188 827a167b 2022-08-16 stsp only log messages but otherwise leaves every picked commit as-is.
3191 827a167b 2022-08-16 stsp option can only be used when starting a new histedit operation.
3192 827a167b 2022-08-16 stsp If this option is used, no other command-line arguments are allowed.
3194 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
3196 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
3197 643b85bc 2021-07-16 stsp reference namespace.
3200 643b85bc 2021-07-16 stsp .Ar branch
3201 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
3202 643b85bc 2021-07-16 stsp this branch.
3203 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
3204 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
3206 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
3207 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
3208 643b85bc 2021-07-16 stsp Git's garbage collector or
3209 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
3211 643b85bc 2021-07-16 stsp If this option is used,
3212 643b85bc 2021-07-16 stsp .Cm got histedit
3213 643b85bc 2021-07-16 stsp does not require a work tree.
3214 643b85bc 2021-07-16 stsp None of the other options can be used together with
3218 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
3219 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ig
3220 2822a352 2019-10-15 stsp Integrate the specified
3221 2822a352 2019-10-15 stsp .Ar branch
3222 2822a352 2019-10-15 stsp into the work tree's current branch.
3223 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
3224 2822a352 2019-10-15 stsp .Ar branch ,
3225 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
3226 2822a352 2019-10-15 stsp head commit of the integrated
3227 2822a352 2019-10-15 stsp .Ar branch .
3229 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
3230 2822a352 2019-10-15 stsp will be pointing at the same commit.
3231 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
3232 2822a352 2019-10-15 stsp In case the integrated
3233 2822a352 2019-10-15 stsp .Ar branch
3234 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
3235 2822a352 2019-10-15 stsp .Cm got branch -d .
3237 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
3238 2822a352 2019-10-15 stsp .Bl -column YXZ description
3239 2822a352 2019-10-15 stsp .It U Ta file was updated
3240 2822a352 2019-10-15 stsp .It D Ta file was deleted
3241 2822a352 2019-10-15 stsp .It A Ta new file was added
3242 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
3243 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
3246 2822a352 2019-10-15 stsp .Cm got integrate
3247 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
3248 2822a352 2019-10-15 stsp Most importantly, the
3249 2822a352 2019-10-15 stsp .Ar branch
3250 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
3251 2822a352 2019-10-15 stsp .Cm got rebase
3252 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
3253 2822a352 2019-10-15 stsp resolve merge conflicts.
3254 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
3255 2822a352 2019-10-15 stsp to a single base commit with
3256 2822a352 2019-10-15 stsp .Cm got update .
3257 2822a352 2019-10-15 stsp If changes have been staged with
3258 2822a352 2019-10-15 stsp .Cm got stage ,
3259 2822a352 2019-10-15 stsp these changes must first be committed with
3260 2822a352 2019-10-15 stsp .Cm got commit
3261 2822a352 2019-10-15 stsp or unstaged with
3262 2822a352 2019-10-15 stsp .Cm got unstage .
3263 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
3264 2822a352 2019-10-15 stsp committed with
3265 2822a352 2019-10-15 stsp .Cm got commit
3266 2822a352 2019-10-15 stsp or reverted with
3267 2822a352 2019-10-15 stsp .Cm got revert .
3271 481cdc74 2023-07-01 falsifian .Op Fl aCcMn
3272 5fc4f020 2022-08-30 op .Op Ar branch
3274 4683a10b 2021-11-04 kn .Dl Pq alias: Cm mg
3275 179f9db0 2023-06-20 falsifian Merge the specified
3276 179f9db0 2023-06-20 falsifian .Ar branch
3277 179f9db0 2023-06-20 falsifian into the current branch of the work tree.
3278 b610c677 2023-10-05 stsp If the branches have diverged, merge changes into the work tree
3279 b610c677 2023-10-05 stsp and create a merge commit.
3280 b610c677 2023-10-05 stsp Otherwise, if the specified
3281 179f9db0 2023-06-20 falsifian .Ar branch
3282 b610c677 2023-10-05 stsp is already based on the work tree's current branch, make the work tree's
3283 b610c677 2023-10-05 stsp current branch equivalent to the specified
3284 179f9db0 2023-06-20 falsifian .Ar branch
3285 b610c677 2023-10-05 stsp and update files in the work tree accordingly.
3287 f259c4c1 2021-09-24 stsp Merge commits are commits based on multiple parent commits.
3288 b610c677 2023-10-05 stsp The tip commit of the work tree's current branch will be used as the
3289 b610c677 2023-10-05 stsp first parent.
3290 b610c677 2023-10-05 stsp The tip commit of the specified
3291 b610c677 2023-10-05 stsp .Ar branch
3292 b610c677 2023-10-05 stsp will be used as the second parent.
3293 b610c677 2023-10-05 stsp The work tree's current branch
3294 b610c677 2023-10-05 stsp must be in the
3295 13342307 2023-06-21 stsp .Dq refs/heads/
3296 b610c677 2023-10-05 stsp reference namespace and can be set with
3297 f259c4c1 2021-09-24 stsp .Cm got update -b
3298 f259c4c1 2021-09-24 stsp before starting the
3300 b610c677 2023-10-05 stsp operation.
3302 4e91ef15 2021-09-26 stsp No ancestral relationship between the two branches is required.
3303 4e91ef15 2021-09-26 stsp If the two branches have already been merged previously, only new changes
3304 4e91ef15 2021-09-26 stsp will be merged.
3306 f259c4c1 2021-09-24 stsp It is not possible to create merge commits with more than two parents.
3307 f259c4c1 2021-09-24 stsp If more than one branch needs to be merged, then multiple merge commits
3308 f259c4c1 2021-09-24 stsp with two parents each can be created in sequence.
3310 b610c677 2023-10-05 stsp If a linear project history is desired, then use of
3311 b610c677 2023-10-05 stsp .Cm got rebase
3312 b610c677 2023-10-05 stsp should generally be preferred over
3313 b610c677 2023-10-05 stsp .Cm got merge .
3314 b610c677 2023-10-05 stsp However, even strictly linear projects may require occasional merge commits,
3315 b610c677 2023-10-05 stsp for example in order to merge in new versions of third-party code stored
3317 b610c677 2023-10-05 stsp .Dq vendor
3318 b610c677 2023-10-05 stsp branches created with
3319 b610c677 2023-10-05 stsp .Cm got import .
3322 f259c4c1 2021-09-24 stsp While merging changes found on the
3323 f259c4c1 2021-09-24 stsp .Ar branch
3324 f259c4c1 2021-09-24 stsp into the work tree, show the status of each affected file,
3325 f259c4c1 2021-09-24 stsp using the following status codes:
3326 f259c4c1 2021-09-24 stsp .Bl -column YXZ description
3327 f259c4c1 2021-09-24 stsp .It G Ta file was merged
3328 f259c4c1 2021-09-24 stsp .It C Ta file was merged and conflicts occurred during merge
3329 f259c4c1 2021-09-24 stsp .It ! Ta changes destined for a missing file were not merged
3330 f259c4c1 2021-09-24 stsp .It D Ta file was deleted
3331 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
3332 f259c4c1 2021-09-24 stsp .It A Ta new file was added
3333 f259c4c1 2021-09-24 stsp .It \(a~ Ta changes destined for a non-regular file were not merged
3334 f259c4c1 2021-09-24 stsp .It ? Ta changes destined for an unversioned file were not merged
3337 f259c4c1 2021-09-24 stsp If merge conflicts occur, the merge operation is interrupted and conflicts
3338 f259c4c1 2021-09-24 stsp must be resolved before the merge operation can continue.
3339 606719cd 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
3340 606719cd 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
3341 f259c4c1 2021-09-24 stsp the merge operation will be interrupted to prevent potentially incomplete
3342 f259c4c1 2021-09-24 stsp changes from being committed to the repository without user intervention.
3343 f259c4c1 2021-09-24 stsp The work tree may be modified as desired and the merge can be continued
3344 f259c4c1 2021-09-24 stsp once the changes present in the work tree are considered complete.
3345 f259c4c1 2021-09-24 stsp Alternatively, the merge operation may be aborted which will leave
3346 f259c4c1 2021-09-24 stsp the work tree's current branch unmodified.
3348 f259c4c1 2021-09-24 stsp .Cm got merge
3349 f259c4c1 2021-09-24 stsp will refuse to run if certain preconditions are not met.
3350 13342307 2023-06-21 stsp If the work tree's current branch is not in the
3351 13342307 2023-06-21 stsp .Dq refs/heads/
3352 13342307 2023-06-21 stsp reference namespace then the work tree must first be switched to a
3353 13342307 2023-06-21 stsp branch in the
3354 13342307 2023-06-21 stsp .Dq refs/heads/
3355 13342307 2023-06-21 stsp namespace with
3356 13342307 2023-06-21 stsp .Cm got update -b .
3357 f259c4c1 2021-09-24 stsp If the work tree is not yet fully updated to the tip commit of its
3358 f259c4c1 2021-09-24 stsp branch, then the work tree must first be updated with
3359 f259c4c1 2021-09-24 stsp .Cm got update .
3360 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
3361 f259c4c1 2021-09-24 stsp to a single base commit with
3362 f259c4c1 2021-09-24 stsp .Cm got update .
3363 f259c4c1 2021-09-24 stsp If changes have been staged with
3364 f259c4c1 2021-09-24 stsp .Cm got stage ,
3365 f259c4c1 2021-09-24 stsp these changes must first be committed with
3366 f259c4c1 2021-09-24 stsp .Cm got commit
3367 f259c4c1 2021-09-24 stsp or unstaged with
3368 f259c4c1 2021-09-24 stsp .Cm got unstage .
3369 f259c4c1 2021-09-24 stsp If the work tree contains local changes, these changes must first be
3370 f259c4c1 2021-09-24 stsp committed with
3371 f259c4c1 2021-09-24 stsp .Cm got commit
3372 f259c4c1 2021-09-24 stsp or reverted with
3373 f259c4c1 2021-09-24 stsp .Cm got revert .
3375 f259c4c1 2021-09-24 stsp .Ar branch
3376 f259c4c1 2021-09-24 stsp contains changes to files outside of the work tree's path prefix,
3377 f259c4c1 2021-09-24 stsp the work tree cannot be used to merge this branch.
3380 f259c4c1 2021-09-24 stsp .Cm got update ,
3381 f259c4c1 2021-09-24 stsp .Cm got commit ,
3382 f259c4c1 2021-09-24 stsp .Cm got rebase ,
3383 90e6e620 2021-10-04 kn .Cm got histedit ,
3384 f259c4c1 2021-09-24 stsp .Cm got integrate ,
3386 f259c4c1 2021-09-24 stsp .Cm got stage
3387 f259c4c1 2021-09-24 stsp commands will refuse to run while a merge operation is in progress.
3388 f259c4c1 2021-09-24 stsp Other commands which manipulate the work tree may be used for
3389 f259c4c1 2021-09-24 stsp conflict resolution purposes.
3391 f259c4c1 2021-09-24 stsp The options for
3392 f259c4c1 2021-09-24 stsp .Cm got merge
3393 f259c4c1 2021-09-24 stsp are as follows:
3394 f259c4c1 2021-09-24 stsp .Bl -tag -width Ds
3396 f259c4c1 2021-09-24 stsp Abort an interrupted merge operation.
3397 f259c4c1 2021-09-24 stsp If this option is used, no other command-line arguments are allowed.
3399 12383673 2023-02-18 mark Allow a merge operation to continue with files in conflicted status.
3400 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
3404 f259c4c1 2021-09-24 stsp Continue an interrupted merge operation.
3405 18877383 2023-07-01 falsifian If this option is used, no other command-line arguments are allowed except
3406 18877383 2023-07-01 falsifian .Fl C .
3407 481cdc74 2023-07-01 falsifian .It Fl M
3408 481cdc74 2023-07-01 falsifian Create a merge commit even if the branches have not diverged.
3410 088449d3 2021-09-26 stsp Merge changes into the work tree as usual but do not create a merge
3411 088449d3 2021-09-26 stsp commit immediately.
3412 088449d3 2021-09-26 stsp The merge result can be adjusted as desired before a merge commit is
3413 088449d3 2021-09-26 stsp created with
3414 088449d3 2021-09-26 stsp .Cm got merge -c .
3415 088449d3 2021-09-26 stsp Alternatively, the merge may be aborted with
3416 088449d3 2021-09-26 stsp .Cm got merge -a .
3422 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
3423 5fc4f020 2022-08-30 op .Op Ar path ...
3425 4683a10b 2021-11-04 kn .Dl Pq alias: Cm sg
3426 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
3429 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
3430 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
3431 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
3432 4ed9f614 2019-08-04 stsp .Cm got status .
3434 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3435 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
3436 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
3437 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
3438 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
3441 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
3442 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
3443 9d8b19a4 2019-08-04 stsp committed.
3445 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
3446 4ed9f614 2019-08-04 stsp .Cm got commit ,
3447 4ed9f614 2019-08-04 stsp .Cm got status ,
3449 4ed9f614 2019-08-04 stsp .Cm got diff .
3450 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
3451 4ed9f614 2019-08-04 stsp .Cm got commit
3452 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
3453 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
3454 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
3456 4ed9f614 2019-08-04 stsp .Cm got status
3457 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
3459 4ed9f614 2019-08-04 stsp .Cm got diff
3460 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
3461 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
3463 4ed9f614 2019-08-04 stsp .Cm got revert
3464 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
3465 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
3467 4ed9f614 2019-08-04 stsp The options for
3468 4ed9f614 2019-08-04 stsp .Cm got stage
3469 4ed9f614 2019-08-04 stsp are as follows:
3470 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
3471 827a167b 2022-08-16 stsp .It Fl F Ar response-script
3474 827a167b 2022-08-16 stsp option, read
3479 827a167b 2022-08-16 stsp responses line-by-line from the specified
3480 827a167b 2022-08-16 stsp .Ar response-script
3481 827a167b 2022-08-16 stsp file instead of prompting interactively.
3483 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
3484 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
3485 e38d4cde 2022-03-21 naddy If paths were provided on the command line, show the staged paths
3486 1dd86744 2019-08-12 anthony among the specified paths.
3487 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
3489 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
3490 dc424a06 2019-08-07 stsp select or reject changes for staging based on
3492 6d23ec10 2019-08-08 stsp (stage change),
3494 6d23ec10 2019-08-08 stsp (reject change), and
3496 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
3497 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
3498 dc424a06 2019-08-07 stsp modified file content can be staged.
3499 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
3500 6d23ec10 2019-08-08 stsp their entirety.
3502 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
3503 af358f55 2020-07-23 stsp that is under version control.
3504 af358f55 2020-07-23 stsp By default,
3505 af358f55 2020-07-23 stsp .Cm got stage
3506 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
3507 35213c7c 2020-07-23 stsp As a precaution,
3509 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
3510 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
3511 af358f55 2020-07-23 stsp points outside of the work tree.
3512 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
3513 af358f55 2020-07-23 stsp .Dq make obj
3514 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
3515 af358f55 2020-07-23 stsp version control.
3518 4ed9f614 2019-08-04 stsp .Cm got stage
3519 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
3520 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
3521 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
3522 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
3523 4ed9f614 2019-08-04 stsp .Cm got update
3524 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
3525 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
3528 4ed9f614 2019-08-04 stsp .Cm got update ,
3529 4ed9f614 2019-08-04 stsp .Cm got rebase ,
3530 7b53188e 2023-07-03 stsp .Cm got merge ,
3532 4ed9f614 2019-08-04 stsp .Cm got histedit
3533 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
3534 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
3535 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
3536 4ed9f614 2019-08-04 stsp .Cm got unstage
3537 4ed9f614 2019-08-04 stsp before it can be updated with
3538 4ed9f614 2019-08-04 stsp .Cm got update ,
3539 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
3544 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
3545 5fc4f020 2022-08-30 op .Op Ar path ...
3547 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ug
3548 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
3549 4ed9f614 2019-08-04 stsp back into non-staged status.
3552 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
3553 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
3555 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3556 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
3557 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
3558 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
3559 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
3560 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
3561 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
3562 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3565 2e1f37b0 2019-08-08 stsp The options for
3566 2e1f37b0 2019-08-08 stsp .Cm got unstage
3567 2e1f37b0 2019-08-08 stsp are as follows:
3568 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
3569 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
3572 2e1f37b0 2019-08-08 stsp option, read
3577 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
3578 2e1f37b0 2019-08-08 stsp .Ar response-script
3579 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
3581 827a167b 2022-08-16 stsp Instead of unstaging the entire content of a changed file, interactively
3582 827a167b 2022-08-16 stsp select or reject changes for unstaging based on
3584 827a167b 2022-08-16 stsp (unstage change),
3586 827a167b 2022-08-16 stsp (keep change staged), and
3588 827a167b 2022-08-16 stsp (quit unstaging this file) responses.
3589 827a167b 2022-08-16 stsp If a file is staged in modified status, individual patches derived from the
3590 827a167b 2022-08-16 stsp staged file content can be unstaged.
3591 827a167b 2022-08-16 stsp Files staged in added or deleted status may only be unstaged in their entirety.
3596 5fc4f020 2022-08-30 op .Op Fl c Ar commit
3597 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
3600 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3601 896e9b6f 2019-08-26 stsp text format.
3602 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3603 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3604 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3606 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3607 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3608 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3609 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3610 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3611 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3613 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3615 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3616 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3618 01073a5d 2019-08-22 stsp The options for
3619 01073a5d 2019-08-22 stsp .Cm got cat
3620 01073a5d 2019-08-22 stsp are as follows:
3621 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3622 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3623 896e9b6f 2019-08-26 stsp Look up paths in the specified
3624 896e9b6f 2019-08-26 stsp .Ar commit .
3625 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3626 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3628 fd220d9f 2023-07-18 stsp The expected argument is a commit ID SHA1 hash, or a reference name
3629 fd220d9f 2023-07-18 stsp or keyword which will be resolved to a commit ID.
3630 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3631 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3632 fd220d9f 2023-07-18 stsp The keywords
3636 fd220d9f 2023-07-18 stsp resolve to the work tree's base commit and branch head, respectively.
3637 4390d6c1 2023-07-18 mark The former is only valid if invoked in a work tree, while the latter will
3638 4390d6c1 2023-07-18 mark resolve to the tip of the work tree's current branch if invoked in a
3639 4390d6c1 2023-07-18 mark work tree, otherwise it will resolve to the repository's HEAD reference.
3640 4390d6c1 2023-07-18 mark Keywords and references may be appended with
3644 4390d6c1 2023-07-18 mark modifiers and an optional integer N to denote the
3645 4390d6c1 2023-07-18 mark Nth descendant or antecedent by first parent traversal, respectively;
3646 4390d6c1 2023-07-18 mark for example,
3647 4390d6c1 2023-07-18 mark .Sy :head:-2
3648 4390d6c1 2023-07-18 mark denotes the work tree branch head's 2nd generation ancestor, and
3649 4390d6c1 2023-07-18 mark .Sy :base:+4
3650 4390d6c1 2023-07-18 mark denotes the 4th generation descendant of the work tree's base commit.
3651 4390d6c1 2023-07-18 mark Similarly,
3652 4390d6c1 2023-07-18 mark .Sy quux:-8
3653 4390d6c1 2023-07-18 mark will denote the 8th generation ancestor of the commit resolved by the
3655 4390d6c1 2023-07-18 mark reference.
3660 4390d6c1 2023-07-18 mark modifier without a trailing integer has an implicit
3664 4390d6c1 2023-07-18 mark .Sy :base:+
3665 4390d6c1 2023-07-18 mark is equivalent to
3666 4390d6c1 2023-07-18 mark .Sy :base:+1
3669 827a167b 2022-08-16 stsp Interpret all arguments as paths only.
3670 827a167b 2022-08-16 stsp This option can be used to resolve ambiguity in cases where paths
3671 827a167b 2022-08-16 stsp look like tag names, reference names, or object IDs.
3672 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3673 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3674 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3675 01073a5d 2019-08-22 stsp working directory.
3676 01073a5d 2019-08-22 stsp If this directory is a
3678 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3680 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3681 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3683 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3684 b2118c49 2020-07-28 stsp for details.
3686 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3687 b2118c49 2020-07-28 stsp current working directory.
3689 b2118c49 2020-07-28 stsp If one or more
3691 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3692 b2118c49 2020-07-28 stsp files located at or within these paths.
3695 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3696 b2118c49 2020-07-28 stsp for all tracked files.
3698 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3699 3e0f95fc 2022-07-23 stsp .Bl -tag -width GOT_IGNORE_GITCONFIG
3700 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3701 7f5531cd 2022-07-22 stsp The author's name and email address, such as
3702 d0980f09 2024-01-19 stsp .Qq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3703 7f5531cd 2022-07-22 stsp Used by the
3704 7f5531cd 2022-07-22 stsp .Cm got commit ,
3705 7f5531cd 2022-07-22 stsp .Cm got import ,
3706 7f5531cd 2022-07-22 stsp .Cm got rebase ,
3707 7b53188e 2023-07-03 stsp .Cm got merge ,
3709 7f5531cd 2022-07-22 stsp .Cm got histedit
3713 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3715 84792843 2019-08-09 stsp attempts to reject
3716 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3717 84792843 2019-08-09 stsp environment variables with a missing email address.
3719 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3720 50b0790e 2020-09-11 stsp .Xr got.conf 5
3721 50b0790e 2020-09-11 stsp or by Git's
3722 aba9c984 2019-09-08 stsp .Dv user.name
3724 709ae9eb 2019-09-08 stsp .Dv user.email
3725 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3726 aba9c984 2019-09-08 stsp .Pa .git/config
3729 c9956ddf 2019-09-08 stsp .Dv user.name
3731 c9956ddf 2019-09-08 stsp .Dv user.email
3732 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3733 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3734 257add31 2020-09-09 stsp configuration file will only be used if neither
3735 257add31 2020-09-09 stsp .Xr got.conf 5
3737 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3738 257add31 2020-09-09 stsp environment variable provide author information.
3739 7713cc5e 2023-01-20 op .It Ev GOT_IGNORE_GITCONFIG
3740 7713cc5e 2023-01-20 op If this variable is set then any remote repository definitions or author
3741 7713cc5e 2023-01-20 op information found in Git configuration files will be ignored.
3742 7713cc5e 2023-01-20 op .It Ev GOT_LOG_DEFAULT_LIMIT
3743 7713cc5e 2023-01-20 op The default limit on the number of commits traversed by
3744 7713cc5e 2023-01-20 op .Cm got log .
3745 7713cc5e 2023-01-20 op If set to zero, the limit is unbounded.
3746 7713cc5e 2023-01-20 op This variable will be silently ignored if it is set to a non-numeric value.
3747 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3748 23594da9 2019-05-13 stsp The editor spawned by
3749 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3750 46215d2a 2020-09-11 stsp .Cm got histedit ,
3751 8e7bd50a 2019-08-22 stsp .Cm got import ,
3753 8e7bd50a 2019-08-22 stsp .Cm got tag .
3754 5b735925 2020-09-15 stsp If not set, the
3756 5a53ca9d 2023-02-27 stsp text editor will be spawned.
3759 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3760 257add31 2020-09-09 stsp .It Pa got.conf
3761 257add31 2020-09-09 stsp Repository-wide configuration settings for
3763 50b0790e 2020-09-11 stsp If present, a
3764 50b0790e 2020-09-11 stsp .Xr got.conf 5
3765 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3766 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3767 257add31 2020-09-09 stsp .Pa config
3770 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3771 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3773 50b0790e 2020-09-11 stsp If present, a
3774 1795b260 2021-04-02 kn .Xr got.conf 5
3775 50b0790e 2020-09-11 stsp configuration file in the
3777 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3778 50b0790e 2020-09-11 stsp the repository's
3779 50b0790e 2020-09-11 stsp .Xr got.conf 5
3780 50b0790e 2020-09-11 stsp configuration file and Git's
3781 50b0790e 2020-09-11 stsp .Pa config
3784 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3785 5c860e29 2018-03-12 stsp .Ex -std got
3786 97925469 2018-03-17 stsp .Sh EXAMPLES
3787 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3789 43e4eb1b 2021-08-29 stsp command names in
3790 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3792 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3794 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3797 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3798 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3800 de25a610 2023-06-22 stsp Unfortunately, many of the popular Git hosting sites do not offer anonymous
3801 de25a610 2023-06-22 stsp access via SSH.
3802 de25a610 2023-06-22 stsp Such sites will require an account to be created, and a public SSH key to be
3803 de25a610 2023-06-22 stsp uploaded to this account, before repository access via ssh:// URLs will work.
3805 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
3806 fa6e0e48 2019-05-23 stsp .Xr git 1 :
3808 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3809 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
3811 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3813 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3814 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3815 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3817 02a5c5d0 2022-07-04 stsp .Dl $ gotadmin init /var/git/src.git
3818 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3820 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3822 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3824 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3826 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3828 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3830 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3832 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3834 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3836 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3838 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3840 bfed0e20 2023-01-10 stsp As above, but list the most recently modified branches only:
3842 bfed0e20 2023-01-10 stsp .Dl $ got branch -lt | head
3844 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3845 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3846 d83d9d5c 2019-05-13 stsp which is forked off the
3847 d83d9d5c 2019-05-13 stsp .Dq master
3850 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3852 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3853 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3854 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3856 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3858 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3859 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3861 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3863 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3864 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3865 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3867 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3869 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3870 04e9dcf3 2020-04-18 stsp .Xr patch 1
3871 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3873 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3875 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3877 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3879 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3880 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3881 5b666081 2020-02-24 stsp .Pa sys/uvm :
3883 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3885 5b666081 2020-02-24 stsp And this command has the same effect:
3887 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3889 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3891 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3892 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3894 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3896 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3897 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3899 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
3900 e70c17ce 2019-05-22 stsp with a pre-defined log message.
3902 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
3904 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
3905 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
3906 1795b260 2021-04-02 kn .Pa /tmp/msg :
3908 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
3910 95fc3404 2019-07-15 stsp Update any work tree checked out from the
3911 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
3912 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
3914 95fc3404 2019-07-15 stsp .Dl $ got update
3916 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
3917 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
3918 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
3920 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3921 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
3922 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
3923 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3925 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
3926 a099809f 2021-08-27 stsp .Dq master
3927 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
3928 469dd726 2020-03-20 stsp .Dq origin/master
3931 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3932 469dd726 2020-03-20 stsp .Dl $ got fetch
3934 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
3935 469dd726 2020-03-20 stsp .Cm git clone --bare
3937 469dd726 2020-03-20 stsp .Xr git-fetch 1
3938 469dd726 2020-03-20 stsp command must be used instead:
3940 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
3941 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
3943 469dd726 2020-03-20 stsp Rebase the local
3944 469dd726 2020-03-20 stsp .Dq master
3945 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
3946 469dd726 2020-03-20 stsp .Dq origin/master
3949 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3950 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
3951 469dd726 2020-03-20 stsp .Dl $ got rebase master
3953 fa6e0e48 2019-05-23 stsp Rebase the
3954 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
3955 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
3956 fa6e0e48 2019-05-23 stsp .Dq master
3959 818c7501 2019-07-11 stsp .Dl $ got update -b master
3960 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
3962 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
3963 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
3964 1dd86744 2019-08-12 anthony .Ox Ns 's
3965 1dd86744 2019-08-12 anthony CVS tree:
3967 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3969 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
3970 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
3973 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
3974 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
3975 0ebf8283 2019-07-24 stsp .Dl $ got histedit
3977 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
3978 469dd726 2020-03-20 stsp .Cm git clone --bare
3979 7848a0e1 2020-03-19 stsp instead of
3980 7848a0e1 2020-03-19 stsp .Cm got clone ,
3982 ff2cf171 2019-07-28 stsp .Dq refspec
3983 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
3985 ff2cf171 2019-07-28 stsp .Dq refs/remotes
3986 ff2cf171 2019-07-28 stsp namespace of the local repository.
3987 1795b260 2021-04-02 kn This can be achieved by setting Git's
3988 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
3989 ff2cf171 2019-07-28 stsp configuration variable to the value
3990 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
3992 ff2cf171 2019-07-28 stsp .Cm git config
3995 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
3996 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3998 469dd726 2020-03-20 stsp Additionally, the
3999 469dd726 2020-03-20 stsp .Dq mirror
4000 469dd726 2020-03-20 stsp option must be disabled:
4002 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
4003 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
4005 ff2cf171 2019-07-28 stsp Alternatively, the following
4006 469dd726 2020-03-20 stsp .Xr git-fetch 1
4007 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
4008 ff2cf171 2019-07-28 stsp .Pa config
4011 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
4012 ff2cf171 2019-07-28 stsp .Dl url = ...
4013 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
4014 469dd726 2020-03-20 stsp .Dl mirror = false
4016 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
4017 ff2cf171 2019-07-28 stsp .Dq refs/heads
4018 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
4019 ff2cf171 2019-07-28 stsp .Cm got checkout
4020 ff2cf171 2019-07-28 stsp and, if needed, created with
4021 ff2cf171 2019-07-28 stsp .Cm got branch .
4022 ff2cf171 2019-07-28 stsp Branches in the
4023 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
4024 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
4025 ff2cf171 2019-07-28 stsp repository with
4026 469dd726 2020-03-20 stsp .Cm got fetch
4028 469dd726 2020-03-20 stsp .Xr git-fetch 1
4029 a099809f 2021-08-27 stsp without extra command line arguments.
4030 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
4031 a099809f 2021-08-27 stsp .Cm got log .
4033 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
4034 ff2cf171 2019-07-28 stsp .Dq master
4035 a099809f 2021-08-27 stsp branch, as of the last time
4036 a099809f 2021-08-27 stsp .Cm got fetch
4039 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
4041 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
4042 ff2cf171 2019-07-28 stsp .Dq origin/master
4043 a099809f 2021-08-27 stsp instead of
4044 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
4045 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
4047 a099809f 2021-08-27 stsp .Cm got rebase
4048 a60eb2cc 2023-06-22 stsp can be used to merge changes which are visible on the
4049 a099809f 2021-08-27 stsp .Dq origin/master
4050 a099809f 2021-08-27 stsp branch into the
4051 a099809f 2021-08-27 stsp .Dq master
4053 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
4055 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
4056 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
4058 a099809f 2021-08-27 stsp In order to make changes committed to the
4059 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4060 a099809f 2021-08-27 stsp visible on the
4061 a099809f 2021-08-27 stsp .Dq master
4062 a099809f 2021-08-27 stsp branch, the
4063 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4064 a60eb2cc 2023-06-22 stsp branch can be rebased onto the
4065 a099809f 2021-08-27 stsp .Dq master
4068 a099809f 2021-08-27 stsp .Dl $ got update -b master
4069 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
4071 a099809f 2021-08-27 stsp Changes on the
4072 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4073 a099809f 2021-08-27 stsp branch can now be made visible on the
4074 a099809f 2021-08-27 stsp .Dq master
4075 a099809f 2021-08-27 stsp branch with
4076 a099809f 2021-08-27 stsp .Cm got integrate .
4077 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
4078 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
4079 e38d4cde 2022-03-21 naddy branch, the work tree must be switched back to the
4080 a099809f 2021-08-27 stsp .Dq master
4081 a099809f 2021-08-27 stsp branch first:
4083 a099809f 2021-08-27 stsp .Dl $ got update -b master
4084 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
4087 083957f4 2020-02-24 stsp .Dq master
4088 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
4090 083957f4 2020-02-24 stsp by other developers and any other important new information:
4092 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
4093 083957f4 2020-02-24 stsp .Dl $ got histedit -m
4095 e38d4cde 2022-03-21 naddy If the remote repository offers write access, local changes on the
4096 ff2cf171 2019-07-28 stsp .Dq master
4097 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
4098 90e6e620 2021-10-04 kn .Cm got send .
4100 a099809f 2021-08-27 stsp .Cm got send
4101 a099809f 2021-08-27 stsp can be run without further arguments.
4102 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
4103 a099809f 2021-08-27 stsp current branch is the
4104 a099809f 2021-08-27 stsp .Dq master
4107 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
4109 e38d4cde 2022-03-21 naddy If the remote repository requires the HTTPS protocol, the
4110 a099809f 2021-08-27 stsp .Xr git-push 1
4111 a099809f 2021-08-27 stsp command must be used instead:
4113 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
4114 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
4116 8978dfde 2022-07-20 stsp When making contributions to projects which use the
4117 8978dfde 2022-07-20 stsp .Dq pull request
4118 8978dfde 2022-07-20 stsp workflow, SSH protocol repository access needs to be set up first.
4119 8978dfde 2022-07-20 stsp Once an account has been created on a Git hosting site it should
4120 8978dfde 2022-07-20 stsp be possible to upload a public SSH key for repository access
4121 8978dfde 2022-07-20 stsp authentication.
4124 8978dfde 2022-07-20 stsp .Dq pull request
4125 8978dfde 2022-07-20 stsp workflow will usually involve two remote repositories.
4126 8978dfde 2022-07-20 stsp In the real-life example below, the
4127 8978dfde 2022-07-20 stsp .Dq origin
4128 8978dfde 2022-07-20 stsp repository was forked from the
4129 8978dfde 2022-07-20 stsp .Dq upstream
4130 8978dfde 2022-07-20 stsp repository by using the Git hosting site's web interface.
4132 8978dfde 2022-07-20 stsp .Xr got.conf 5
4133 8978dfde 2022-07-20 stsp file in the local repository describes both remote repositories:
4134 8978dfde 2022-07-20 stsp .Bd -literal -offset indent
4135 8978dfde 2022-07-20 stsp # Jelmers's repository, which accepts pull requests
4136 8978dfde 2022-07-20 stsp remote "upstream" {
4137 8978dfde 2022-07-20 stsp server git@github.com
4138 8978dfde 2022-07-20 stsp protocol ssh
4139 8978dfde 2022-07-20 stsp repository "/jelmer/dulwich"
4140 8978dfde 2022-07-20 stsp branch { "master" }
4143 8978dfde 2022-07-20 stsp # Stefan's fork, used as the default remote repository
4144 8978dfde 2022-07-20 stsp remote "origin" {
4145 8978dfde 2022-07-20 stsp server git@github.com
4146 8978dfde 2022-07-20 stsp protocol ssh
4147 8978dfde 2022-07-20 stsp repository "/stspdotname/dulwich"
4148 8978dfde 2022-07-20 stsp branch { "master" }
4152 8978dfde 2022-07-20 stsp With this configuration, Stefan can create commits on
4153 8978dfde 2022-07-20 stsp .Dq refs/heads/master
4154 8978dfde 2022-07-20 stsp and send them to the
4155 8978dfde 2022-07-20 stsp .Dq origin
4156 8978dfde 2022-07-20 stsp repository by running:
4158 8978dfde 2022-07-20 stsp .Dl $ got send -b master origin
4160 8978dfde 2022-07-20 stsp The changes can now be proposed to Jelmer by opening a pull request
4161 8978dfde 2022-07-20 stsp via the Git hosting site's web interface.
4162 8978dfde 2022-07-20 stsp If Jelmer requests further changes to be made, additional commits
4163 8978dfde 2022-07-20 stsp can be created on the
4164 8978dfde 2022-07-20 stsp .Dq master
4165 8978dfde 2022-07-20 stsp branch and be added to the pull request by running
4166 8978dfde 2022-07-20 stsp .Cd got send
4169 8978dfde 2022-07-20 stsp If Jelmer prefers additional commits to be
4170 8978dfde 2022-07-20 stsp .Dq squashed
4171 8978dfde 2022-07-20 stsp then the following commands can be used to achieve this:
4173 8978dfde 2022-07-20 stsp .Dl $ got update -b master
4174 8978dfde 2022-07-20 stsp .Dl $ got update -c origin/master
4175 8978dfde 2022-07-20 stsp .Dl $ got histedit -f
4176 8978dfde 2022-07-20 stsp .Dl $ got send -f -b master origin
4178 0ffe39b0 2023-04-18 stsp In addition to reviewing the pull request in the web user interface,
4179 0ffe39b0 2023-04-18 stsp Jelmer can fetch the pull request's branch into his local repository
4180 0ffe39b0 2023-04-18 stsp and create a local branch which contains the proposed changes:
4182 0ffe39b0 2023-04-18 stsp .Dl $ got fetch -R refs/pull/1046/head origin
4183 0ffe39b0 2023-04-18 stsp .Dl $ got branch -c refs/remotes/origin/pull/1046/head pr1046
4185 8978dfde 2022-07-20 stsp Once Jelmer has accepted the pull request, Stefan can fetch the
4186 8978dfde 2022-07-20 stsp merged changes, and possibly several other new changes, by running:
4188 8978dfde 2022-07-20 stsp .Dl $ got fetch upstream
4190 8978dfde 2022-07-20 stsp The merged changes will now be visible under the reference
4191 8978dfde 2022-07-20 stsp .Dq refs/remotes/upstream/master .
4193 8978dfde 2022-07-20 stsp .Dq master
4194 8978dfde 2022-07-20 stsp branch can now be rebased on top of the latest changes
4195 8978dfde 2022-07-20 stsp from upstream:
4197 8978dfde 2022-07-20 stsp .Dl $ got update -b upstream/master
4198 8978dfde 2022-07-20 stsp .Dl $ got rebase master
4200 77a54eed 2023-06-22 stsp As an alternative to
4201 77a54eed 2023-06-22 stsp .Cm got rebase ,
4202 77a54eed 2023-06-22 stsp branches can be merged with
4203 77a54eed 2023-06-22 stsp .Cm got merge :
4205 77a54eed 2023-06-22 stsp .Dl $ got update -b master
4206 77a54eed 2023-06-22 stsp .Dl $ got merge upstream/master
4208 77a54eed 2023-06-22 stsp The question of whether to rebase or merge branches is philosophical.
4209 77a54eed 2023-06-22 stsp When in doubt, refer to the software project's policies set by project
4210 77a54eed 2023-06-22 stsp maintainers.
4212 8978dfde 2022-07-20 stsp As a final step, the forked repository's copy of the master branch needs
4213 8978dfde 2022-07-20 stsp to be kept in sync by sending the new changes there:
4215 8978dfde 2022-07-20 stsp .Dl $ got send -f -b master origin
4217 8978dfde 2022-07-20 stsp If multiple pull requests need to be managed in parallel, a separate branch
4218 8978dfde 2022-07-20 stsp must be created for each pull request with
4219 8978dfde 2022-07-20 stsp .Cm got branch .
4220 8978dfde 2022-07-20 stsp Each such branch can then be used as above, in place of
4221 8978dfde 2022-07-20 stsp .Dq refs/heads/master .
4222 8978dfde 2022-07-20 stsp Changes for any accepted pull requests will still appear under
4223 8978dfde 2022-07-20 stsp .Dq refs/remotes/upstream/master,
4224 8978dfde 2022-07-20 stsp regardless of which branch was used in the forked repository to
4225 8978dfde 2022-07-20 stsp create a pull request.
4226 5c860e29 2018-03-12 stsp .Sh SEE ALSO
4227 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
4228 2312fc47 2019-07-15 stsp .Xr tog 1 ,
4229 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
4230 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
4231 2b16c2bc 2022-07-05 stsp .Xr got.conf 5 ,
4232 06991378 2022-12-30 tracey .Xr gotwebd 8
4233 1a208aaf 2018-04-01 stsp .Sh AUTHORS
4234 8ca658b9 2022-07-05 stsp .An Anthony J. Bentley Aq Mt bentley@openbsd.org
4235 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
4236 8ca658b9 2022-07-05 stsp .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
4237 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
4238 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
4239 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
4240 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
4241 49be94bd 2022-07-05 stsp .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
4242 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
4243 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
4244 8ca658b9 2022-07-05 stsp .An Sebastien Marie Aq Mt semarie@openbsd.org
4245 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
4246 ad8bd524 2022-07-05 stsp .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
4247 8ca658b9 2022-07-05 stsp .An Theo Buehler Aq Mt tb@openbsd.org
4248 8ca658b9 2022-07-05 stsp .An Thomas Adam Aq Mt thomas@xteddy.org
4249 8ca658b9 2022-07-05 stsp .An Tracey Emery Aq Mt tracey@traceyemery.net
4250 8ca658b9 2022-07-05 stsp .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
4254 cc63cb4e 2022-07-05 stsp .Xr tog 1 ,
4256 06991378 2022-12-30 tracey .Xr gotwebd 8
4257 cc63cb4e 2022-07-05 stsp were derived from code under copyright by:
4259 65858f9a 2022-07-22 stsp .An Caldera International
4260 cc63cb4e 2022-07-05 stsp .An Daniel Hartmeier
4261 cc63cb4e 2022-07-05 stsp .An Esben Norby
4262 cc63cb4e 2022-07-05 stsp .An Henning Brauer
4263 cc63cb4e 2022-07-05 stsp .An Håkan Olsson
4264 cc63cb4e 2022-07-05 stsp .An Ingo Schwarze
4265 cc63cb4e 2022-07-05 stsp .An Jean-Francois Brousseau
4266 cc63cb4e 2022-07-05 stsp .An Joris Vink
4267 cc63cb4e 2022-07-05 stsp .An Jyri J. Virkki
4268 cc63cb4e 2022-07-05 stsp .An Larry Wall
4269 65858f9a 2022-07-22 stsp .An Markus Friedl
4270 cc63cb4e 2022-07-05 stsp .An Niall O'Higgins
4271 cc63cb4e 2022-07-05 stsp .An Niklas Hallqvist
4272 cc63cb4e 2022-07-05 stsp .An Ray Lai
4273 cc63cb4e 2022-07-05 stsp .An Ryan McBride
4274 cc63cb4e 2022-07-05 stsp .An Theo de Raadt
4275 cc63cb4e 2022-07-05 stsp .An Todd C. Miller
4276 cc63cb4e 2022-07-05 stsp .An Xavier Santolaria
4279 bd957eac 2022-07-05 stsp contains code contributed to the public domain by
4280 9430e858 2022-12-25 stsp .An Austin Appleby .
4281 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
4283 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
4285 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
4287 cc63216e 2020-12-26 stsp to perform some tasks.
4288 cc63216e 2020-12-26 stsp In particular:
4289 cc63216e 2020-12-26 stsp .Bl -bullet
4291 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
4292 cc63216e 2020-12-26 stsp .Xr git-clone 1
4294 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
4296 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
4297 cc63216e 2020-12-26 stsp .Xr git-push 1 .
4299 fa161f0b 2021-09-28 stsp The creation of merge commits with more than two parent commits requires
4300 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
4302 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
4304 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
4306 cc63216e 2020-12-26 stsp will usually produce better results.
