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
67 56c96eff 2022-08-30 thomas .Cm import
68 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
69 56c96eff 2022-08-30 thomas .Op Fl I Ar pattern
70 56c96eff 2022-08-30 thomas .Op Fl m Ar message
71 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
72 56c96eff 2022-08-30 thomas .Ar directory
74 d912d125 2021-11-04 thomas .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 e9424ba1 2022-09-20 thomas .Ar branch .
108 e9424ba1 2022-09-20 thomas If this option is not specified, a branch corresponding to the repository's
109 e9424ba1 2022-09-20 thomas HEAD reference will be used.
110 e9424ba1 2022-09-20 thomas Use of this option is required if the branch resolved via the repository's
111 e9424ba1 2022-09-20 thomas HEAD reference already exists.
112 d6506a3d 2022-08-16 thomas .It Fl I Ar pattern
113 d6506a3d 2022-08-16 thomas Ignore files or directories with a name which matches the specified
114 d6506a3d 2022-08-16 thomas .Ar pattern .
115 d6506a3d 2022-08-16 thomas This option may be specified multiple times to build a list of ignore patterns.
117 d6506a3d 2022-08-16 thomas .Ar pattern
118 d6506a3d 2022-08-16 thomas follows the globbing rules documented in
119 d6506a3d 2022-08-16 thomas .Xr glob 7 .
120 e012cf94 2023-02-07 thomas Ignore patterns which end with a slash,
122 e012cf94 2023-02-07 thomas 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 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
131 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
132 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
133 3ce1b845 2019-07-15 stsp working directory.
137 56c96eff 2022-08-30 thomas .Cm clone
138 56c96eff 2022-08-30 thomas .Op Fl almqv
139 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
140 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
141 56c96eff 2022-08-30 thomas .Ar repository-URL
142 56c96eff 2022-08-30 thomas .Op Ar directory
144 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cl
145 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
146 2ab43947 2020-03-18 stsp .Ar repository-URL
147 2ab43947 2020-03-18 stsp into the specified
148 3493b628 2020-03-20 stsp .Ar directory .
150 3493b628 2020-03-20 stsp .Ar directory
151 4b06140e 2022-03-22 thomas is specified, the directory name will be derived from the name of the
152 2ab43947 2020-03-18 stsp cloned repository.
153 2ab43947 2020-03-18 stsp .Cm got clone
154 2ab43947 2020-03-18 stsp will refuse to run if the
155 3493b628 2020-03-20 stsp .Ar directory
156 2ab43947 2020-03-18 stsp already exists.
159 2ab43947 2020-03-18 stsp .Ar repository-URL
160 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
161 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
162 619eb6dd 2020-03-20 stsp the server:
163 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
165 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
166 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
168 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
169 2ab43947 2020-03-18 stsp .Xr git-daemon 1
171 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
172 10c073e7 2020-03-20 stsp nor encryption.
173 2ab43947 2020-03-18 stsp .It git+ssh
174 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
177 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
180 2ab43947 2020-03-18 stsp .Mt user@hostname
182 2ab43947 2020-03-18 stsp Short alias for git+ssh.
185 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
186 89c3c67b 2020-03-20 stsp from the server.
187 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
189 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
190 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
191 89c3c67b 2020-03-20 stsp This can take some time.
192 010f7279 2020-03-20 stsp More details about the pack file format are documented in
193 010f7279 2020-03-20 stsp .Xr git-repository 5 .
195 7848a0e1 2020-03-19 stsp .Cm got clone
196 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
197 257add31 2020-09-09 stsp .Xr got.conf 5
200 257add31 2020-09-09 stsp files of the cloned repository to store the
201 7848a0e1 2020-03-19 stsp .Ar repository-url
205 99495ddb 2021-01-10 stsp .Ar reference
206 132af4a5 2021-01-05 stsp arguments for future use by
207 7848a0e1 2020-03-19 stsp .Cm got fetch
209 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
211 2ab43947 2020-03-18 stsp The options for
212 2ab43947 2020-03-18 stsp .Cm got clone
213 2ab43947 2020-03-18 stsp are as follows:
214 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
216 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
217 1d4b192f 2020-03-21 stsp .Dq refs/heads/
218 5aa20203 2021-01-05 stsp reference namespace and set
219 25eb5847 2022-07-03 thomas .Cm fetch_all_branches
220 5aa20203 2021-01-05 stsp in the cloned repository's
221 5aa20203 2021-01-05 stsp .Xr got.conf 5
222 5aa20203 2021-01-05 stsp file for future use by
223 5aa20203 2021-01-05 stsp .Cm got fetch .
224 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
225 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
226 4ba14133 2020-03-20 stsp Cannot be used together with the
229 4ba14133 2020-03-20 stsp .It Fl b Ar branch
230 4ba14133 2020-03-20 stsp Fetch the specified
232 1d4b192f 2020-03-21 stsp from the remote repository's
233 1d4b192f 2020-03-21 stsp .Dq refs/heads/
234 1d4b192f 2020-03-21 stsp reference namespace.
235 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
237 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
238 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
239 4ba14133 2020-03-20 stsp branch which was fetched.
240 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
241 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
242 4ba14133 2020-03-20 stsp Cannot be used together with the
246 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
247 41b0de12 2020-03-21 stsp and exit immediately.
248 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
253 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
254 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
255 bd81cfb7 2020-04-19 stsp locally created commits.
257 469dd726 2020-03-20 stsp The repository's
258 257add31 2020-09-09 stsp .Xr got.conf 5
261 257add31 2020-09-09 stsp files will be set up with the
263 469dd726 2020-03-20 stsp option enabled, such that
264 469dd726 2020-03-20 stsp .Cm got fetch
266 469dd726 2020-03-20 stsp .Xr git-fetch 1
267 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
268 469dd726 2020-03-20 stsp .Dq refs/heads/
269 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
270 469dd726 2020-03-20 stsp .Dq refs/remotes/
272 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
273 469dd726 2020-03-20 stsp .Cm got rebase
275 469dd726 2020-03-20 stsp .Cm got fetch
276 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
277 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
279 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
280 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
281 498ef124 2020-03-21 stsp changes are fetched.
283 2ab43947 2020-03-18 stsp Suppress progress reporting output.
284 2ab43947 2020-03-18 stsp The same option will be passed to
286 2ab43947 2020-03-18 stsp if applicable.
287 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
288 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
289 0e4002ca 2020-03-21 stsp .Ar reference
290 0e4002ca 2020-03-21 stsp from the remote repository's
293 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
294 0e4002ca 2020-03-21 stsp references to fetch.
295 71f12362 2020-03-21 stsp The specified
296 71f12362 2020-03-21 stsp .Ar reference
297 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
298 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
300 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
301 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
302 0e4002ca 2020-03-21 stsp namespace, unless the
304 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
308 0e4002ca 2020-03-21 stsp .Cm got clone
309 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
310 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
312 0e4002ca 2020-03-21 stsp .Dq refs/got/
315 d6506a3d 2022-08-16 thomas Verbose mode.
317 d6506a3d 2022-08-16 thomas .Cm got clone
318 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
319 d6506a3d 2022-08-16 thomas This option will be passed to
320 d6506a3d 2022-08-16 thomas .Xr ssh 1
321 d6506a3d 2022-08-16 thomas if applicable.
322 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
323 d6506a3d 2022-08-16 thomas The maximum is 3.
327 56c96eff 2022-08-30 thomas .Cm fetch
328 56c96eff 2022-08-30 thomas .Op Fl adlqtvX
329 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
330 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
331 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
332 56c96eff 2022-08-30 thomas .Op Ar remote-repository
334 d912d125 2021-11-04 thomas .Dl Pq alias: Cm fe
335 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
337 4ba14133 2020-03-20 stsp .Ar remote-repository
338 4ba14133 2020-03-20 stsp is specified,
340 7848a0e1 2020-03-19 stsp will be used.
341 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
342 257add31 2020-09-09 stsp .Xr got.conf 5
345 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
346 7848a0e1 2020-03-19 stsp .Cm got clone .
348 8d0dceb3 2023-02-07 thomas By default, any branches configured in
349 8d0dceb3 2023-02-07 thomas .Xr got.conf 5
351 7917d6d5 2023-02-17 thomas .Ar remote-repository
352 8d0dceb3 2023-02-07 thomas will be fetched.
354 8d0dceb3 2023-02-07 thomas .Cm got fetch
355 8d0dceb3 2023-02-07 thomas is invoked in a work tree then this work tree's current branch will be
356 8d0dceb3 2023-02-07 thomas fetched, too, provided it is present on the server.
357 7917d6d5 2023-02-17 thomas If no branches to fetch can be found in
358 7917d6d5 2023-02-17 thomas .Xr got.conf 5
359 7917d6d5 2023-02-17 thomas or via a work tree, or said branches are not found on the server, a branch
360 7917d6d5 2023-02-17 thomas resolved via the remote repository's HEAD reference will be fetched.
361 7abf1863 2023-02-20 thomas Likewise, if a HEAD reference for the
362 7abf1863 2023-02-20 thomas .Ar remote-repository
363 7abf1863 2023-02-20 thomas exists but its target no longer matches the remote HEAD, then
364 7abf1863 2023-02-20 thomas the new target branch will be fetched.
365 8d0dceb3 2023-02-07 thomas This default behaviour can be overridden with the
371 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
372 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
373 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
375 498ef124 2020-03-21 stsp By default, branch references in the
376 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
377 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
379 498ef124 2020-03-21 stsp .Cm got rebase
380 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
381 7848a0e1 2020-03-19 stsp .Dq refs/heads/
382 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
383 bd81cfb7 2020-04-19 stsp as necessary.
385 498ef124 2020-03-21 stsp If the repository was created as a mirror with
386 4b06140e 2022-03-22 thomas .Cm got clone -m ,
387 498ef124 2020-03-21 stsp then all branches in the
388 469dd726 2020-03-20 stsp .Dq refs/heads/
389 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
390 498ef124 2020-03-21 stsp the remote repository.
391 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
392 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
393 e6786710 2021-07-03 stsp by Git's garbage collector or
394 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
395 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
397 db6d8ad8 2020-03-21 stsp In any case, references in the
398 7848a0e1 2020-03-19 stsp .Dq refs/tags/
399 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
400 db6d8ad8 2020-03-21 stsp in the same namespace.
402 7848a0e1 2020-03-19 stsp The options for
403 7848a0e1 2020-03-19 stsp .Cm got fetch
404 7848a0e1 2020-03-19 stsp are as follows:
405 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
407 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
408 1d4b192f 2020-03-21 stsp .Dq refs/heads/
409 1d4b192f 2020-03-21 stsp reference namespace.
410 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
411 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
412 4ba14133 2020-03-20 stsp Cannot be used together with the
415 4ba14133 2020-03-20 stsp .It Fl b Ar branch
416 4ba14133 2020-03-20 stsp Fetch the specified
418 1d4b192f 2020-03-21 stsp from the remote repository's
419 1d4b192f 2020-03-21 stsp .Dq refs/heads/
420 1d4b192f 2020-03-21 stsp reference namespace.
421 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
423 4ba14133 2020-03-20 stsp Cannot be used together with the
427 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
428 f21ec2f0 2020-03-21 stsp present in the remote repository.
429 f21ec2f0 2020-03-21 stsp Only references are deleted.
430 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
431 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
432 e6786710 2021-07-03 stsp Git's garbage collector or
433 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
435 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
436 41b0de12 2020-03-21 stsp and exit immediately.
437 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
443 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
444 7848a0e1 2020-03-19 stsp The same option will be passed to
446 7848a0e1 2020-03-19 stsp if applicable.
447 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
448 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
449 0e4002ca 2020-03-21 stsp .Ar reference
450 0e4002ca 2020-03-21 stsp from the remote repository's
453 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
454 0e4002ca 2020-03-21 stsp references to fetch.
455 71f12362 2020-03-21 stsp The specified
456 71f12362 2020-03-21 stsp .Ar reference
457 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
458 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
460 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
461 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
462 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
463 a18cccf9 2020-03-21 stsp .Cm got clone -m
464 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
468 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
469 0e4002ca 2020-03-21 stsp .Cm got branch
472 0e4002ca 2020-03-21 stsp .Cm got fetch
473 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
474 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
476 0e4002ca 2020-03-21 stsp .Dq refs/got/
478 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
479 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
480 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
481 d6506a3d 2022-08-16 thomas working directory.
482 d6506a3d 2022-08-16 thomas If this directory is a
484 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
486 d6506a3d 2022-08-16 thomas Allow existing references in the
487 d6506a3d 2022-08-16 thomas .Dq refs/tags
488 d6506a3d 2022-08-16 thomas namespace to be updated if they have changed on the server.
489 d6506a3d 2022-08-16 thomas If not specified, only new tag references will be created.
491 d6506a3d 2022-08-16 thomas Verbose mode.
493 d6506a3d 2022-08-16 thomas .Cm got fetch
494 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
495 d6506a3d 2022-08-16 thomas The same option will be passed to
496 d6506a3d 2022-08-16 thomas .Xr ssh 1
497 d6506a3d 2022-08-16 thomas if applicable.
498 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
499 d6506a3d 2022-08-16 thomas The maximum is 3.
501 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
502 161728eb 2021-07-24 stsp .Ar remote-repository
503 161728eb 2021-07-24 stsp instead of fetching new changes.
504 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
505 161728eb 2021-07-24 stsp .Xr got.conf 5 .
510 161728eb 2021-07-24 stsp .Ar remote-repository
511 161728eb 2021-07-24 stsp argument is mandatory and no other options except
516 161728eb 2021-07-24 stsp are allowed.
518 161728eb 2021-07-24 stsp Only references are deleted.
519 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
520 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
521 161728eb 2021-07-24 stsp .Xr git-repack 1
522 161728eb 2021-07-24 stsp and Git's garbage collector.
526 56c96eff 2022-08-30 thomas .Cm checkout
527 56c96eff 2022-08-30 thomas .Op Fl Eq
528 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
529 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
530 56c96eff 2022-08-30 thomas .Op Fl p Ar path-prefix
531 56c96eff 2022-08-30 thomas .Ar repository-path
532 56c96eff 2022-08-30 thomas .Op Ar work-tree-path
534 d912d125 2021-11-04 thomas .Dl Pq alias: Cm co
535 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
536 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
537 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
538 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
539 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
543 5d7c1dab 2018-04-01 stsp .Ar work tree path
544 c844a238 2019-02-06 stsp is not specified, either use the last component of
545 5d7c1dab 2018-04-01 stsp .Ar repository path ,
547 5d7c1dab 2018-04-01 stsp .Ar path prefix
548 c844a238 2019-02-06 stsp was specified use the last component of
549 5d7c1dab 2018-04-01 stsp .Ar path prefix .
551 38e11793 2018-06-13 stsp The options for
552 38e11793 2018-06-13 stsp .Cm got checkout
553 38e11793 2018-06-13 stsp are as follows:
554 38e11793 2018-06-13 stsp .Bl -tag -width Ds
555 08573d5b 2019-05-14 stsp .It Fl b Ar branch
556 3c575567 2019-07-28 stsp Check out files from a commit on the specified
557 08573d5b 2019-05-14 stsp .Ar branch .
558 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
559 08573d5b 2019-05-14 stsp reference will be used.
560 8069f636 2019-01-12 stsp .It Fl c Ar commit
561 8069f636 2019-01-12 stsp Check out files from the specified
563 3c575567 2019-07-28 stsp on the selected branch.
564 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
565 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
566 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
567 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
568 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
569 08573d5b 2019-05-14 stsp branch will be used.
571 4b6c9460 2020-03-05 stsp If the specified
573 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
574 4b6c9460 2020-03-05 stsp this commit must be specified with the
577 4b06140e 2022-03-22 thomas If no such branch is known, a new branch must be created for this
578 4b6c9460 2020-03-05 stsp commit with
579 4b6c9460 2020-03-05 stsp .Cm got branch
581 4b6c9460 2020-03-05 stsp .Cm got checkout
582 4b6c9460 2020-03-05 stsp can be used.
583 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
585 d6506a3d 2022-08-16 thomas Proceed with the checkout operation even if the directory at
586 d6506a3d 2022-08-16 thomas .Ar work-tree-path
587 d6506a3d 2022-08-16 thomas is not empty.
588 d6506a3d 2022-08-16 thomas Existing files will be left intact.
589 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
590 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
591 38e11793 2018-06-13 stsp Only files beneath the specified
592 38e11793 2018-06-13 stsp .Ar path-prefix
593 38e11793 2018-06-13 stsp will be checked out.
595 4ad4a1ec 2021-09-13 tracey Silence progress output.
599 56c96eff 2022-08-30 thomas .Cm update
601 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
602 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
603 56c96eff 2022-08-30 thomas .Op Ar path ...
605 d912d125 2021-11-04 thomas .Dl Pq alias: Cm up
606 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
607 4f331d3a 2020-04-01 stsp .Ar commit .
608 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
609 4f331d3a 2020-04-01 stsp of this commit.
610 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
611 4f331d3a 2020-04-01 stsp incoming changes.
613 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
614 5036ab18 2020-04-18 stsp further complications.
615 5036ab18 2020-04-18 stsp Such files will be updated when
616 5036ab18 2020-04-18 stsp .Cm got update
617 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
618 4b06140e 2022-03-22 thomas If the conflicting changes are no longer needed, affected files can be
619 5036ab18 2020-04-18 stsp reverted with
620 5036ab18 2020-04-18 stsp .Cm got revert
621 5036ab18 2020-04-18 stsp before running
622 5036ab18 2020-04-18 stsp .Cm got update
625 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
626 7f838b36 2019-02-08 stsp .Bl -column YXZ description
627 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
628 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
629 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
630 7f838b36 2019-02-08 stsp .It D Ta file was deleted
631 7f838b36 2019-02-08 stsp .It A Ta new file was added
632 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
633 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
634 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
635 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
640 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
641 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
642 f2ea84fa 2019-07-27 stsp specified paths.
643 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
644 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
645 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
648 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
649 c4cdcb68 2019-04-03 stsp multiple base commits.
650 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
651 47ec7be7 2019-05-12 stsp .Cm got update
652 47ec7be7 2019-05-12 stsp across the entire work tree.
653 024e9686 2019-05-14 stsp Specifying a
655 024e9686 2019-05-14 stsp is incompatible with the
659 4ed9f614 2019-08-04 stsp .Cm got update
660 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
661 4ed9f614 2019-08-04 stsp If changes have been staged with
662 4ed9f614 2019-08-04 stsp .Cm got stage ,
663 bc3056e3 2019-08-18 stsp these changes must first be committed with
664 4ed9f614 2019-08-04 stsp .Cm got commit
665 4ed9f614 2019-08-04 stsp or unstaged with
666 4ed9f614 2019-08-04 stsp .Cm got unstage .
668 507dc3bb 2018-12-29 stsp The options for
669 507dc3bb 2018-12-29 stsp .Cm got update
670 507dc3bb 2018-12-29 stsp are as follows:
671 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
672 024e9686 2019-05-14 stsp .It Fl b Ar branch
673 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
675 024e9686 2019-05-14 stsp before updating the work tree.
676 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
678 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
679 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
680 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
682 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
683 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
684 4f331d3a 2020-04-01 stsp .Ar branch .
685 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
686 4f331d3a 2020-04-01 stsp .Cm got commit ,
687 4f331d3a 2020-04-01 stsp or could be discarded with
688 4f331d3a 2020-04-01 stsp .Cm got revert .
689 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
690 507dc3bb 2018-12-29 stsp Update the work tree to the specified
691 507dc3bb 2018-12-29 stsp .Ar commit .
692 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
693 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
694 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
695 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
696 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
697 024e9686 2019-05-14 stsp branch will be used.
699 4ad4a1ec 2021-09-13 tracey Silence progress output.
703 56c96eff 2022-08-30 thomas .Cm status
705 56c96eff 2022-08-30 thomas .Op Fl S Ar status-codes
706 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
707 56c96eff 2022-08-30 thomas .Op Ar path ...
709 d912d125 2021-11-04 thomas .Dl Pq alias: Cm st
710 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
711 6bad629b 2019-02-04 stsp using the following status codes:
712 6bad629b 2019-02-04 stsp .Bl -column YXZ description
713 6bad629b 2019-02-04 stsp .It M Ta modified file
714 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
715 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
716 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
717 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
718 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
719 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
721 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
722 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
724 2a06fe5f 2019-08-24 stsp specified on the command line
729 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
730 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
732 4ed9f614 2019-08-04 stsp If changes have been staged with
733 4ed9f614 2019-08-04 stsp .Cm got stage ,
734 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
735 4ed9f614 2019-08-04 stsp status codes:
736 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
737 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
738 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
739 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
742 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
743 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
744 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
745 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
748 081470ac 2020-08-13 stsp The options for
749 081470ac 2020-08-13 stsp .Cm got status
750 081470ac 2020-08-13 stsp are as follows:
751 081470ac 2020-08-13 stsp .Bl -tag -width Ds
753 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
754 d6506a3d 2022-08-16 thomas .It Fl S Ar status-codes
755 d6506a3d 2022-08-16 thomas Suppress the output of files with a modification status matching any of the
756 00357e4d 2021-09-14 tracey single-character status codes contained in the
757 00357e4d 2021-09-14 tracey .Ar status-codes
758 00357e4d 2021-09-14 tracey argument.
759 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
760 00357e4d 2021-09-14 tracey may be specified.
761 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
762 b043307b 2021-09-14 stsp Cannot be used together with the
765 d6506a3d 2022-08-16 thomas .It Fl s Ar status-codes
766 d6506a3d 2022-08-16 thomas Only show files with a modification status matching any of the
767 081470ac 2020-08-13 stsp single-character status codes contained in the
768 081470ac 2020-08-13 stsp .Ar status-codes
770 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
771 081470ac 2020-08-13 stsp may be specified.
772 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
773 b043307b 2021-09-14 stsp Cannot be used together with the
778 6841da00 2019-08-08 stsp For compatibility with
781 bd8de430 2019-10-04 stsp .Xr git 1 ,
782 6841da00 2019-08-08 stsp .Cm got status
785 bd8de430 2019-10-04 stsp patterns from
786 6841da00 2019-08-08 stsp .Pa .cvsignore
788 bd8de430 2019-10-04 stsp .Pa .gitignore
789 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
790 bd8de430 2019-10-04 stsp which match these patterns.
791 bd8de430 2019-10-04 stsp As an extension to
793 bd8de430 2019-10-04 stsp matching rules,
794 bd8de430 2019-10-04 stsp .Cm got status
795 bd8de430 2019-10-04 stsp supports consecutive asterisks,
797 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
799 6841da00 2019-08-08 stsp .Xr cvs 1 ,
800 6841da00 2019-08-08 stsp .Cm got status
801 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
803 bd8de430 2019-10-04 stsp .Xr git 1 ,
804 bd8de430 2019-10-04 stsp .Cm got status
805 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
807 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
809 bd8de430 2019-10-04 stsp in a pattern.
812 f3ad4b0a 2023-01-07 thomas .Op Fl bdPpRs
813 56c96eff 2022-08-30 thomas .Op Fl C Ar number
814 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
815 56c96eff 2022-08-30 thomas .Op Fl l Ar N
816 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
817 56c96eff 2022-08-30 thomas .Op Fl S Ar search-pattern
818 56c96eff 2022-08-30 thomas .Op Fl x Ar commit
819 56c96eff 2022-08-30 thomas .Op Ar path
821 38e11793 2018-06-13 stsp Display history of a repository.
824 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
825 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
827 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
828 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
829 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
831 38e11793 2018-06-13 stsp The options for
832 38e11793 2018-06-13 stsp .Cm got log
833 38e11793 2018-06-13 stsp are as follows:
834 38e11793 2018-06-13 stsp .Bl -tag -width Ds
836 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
837 1137e0ae 2020-01-27 stsp from other branches.
838 48c8c60d 2020-01-27 stsp By default,
839 48c8c60d 2020-01-27 stsp .Cm got log
840 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
841 d6506a3d 2022-08-16 thomas .It Fl C Ar number
842 d6506a3d 2022-08-16 thomas Set the number of context lines shown in diffs with
844 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
845 38e11793 2018-06-13 stsp .It Fl c Ar commit
846 38e11793 2018-06-13 stsp Start traversing history at the specified
847 38e11793 2018-06-13 stsp .Ar commit .
848 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
849 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
850 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
851 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
852 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
853 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
855 be97ab03 2023-01-19 thomas Display diffstat of changes introduced in each commit.
856 772fcad5 2023-01-07 thomas Cannot be used with the
859 6238ee32 2018-06-13 stsp .It Fl l Ar N
860 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
861 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
862 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
864 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
865 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
867 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
868 0208f208 2020-05-05 stsp status codes:
869 0208f208 2020-05-05 stsp .Bl -column YXZ description
870 0208f208 2020-05-05 stsp .It M Ta modified file
871 0208f208 2020-05-05 stsp .It D Ta file was deleted
872 0208f208 2020-05-05 stsp .It A Ta new file was added
873 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
876 2f7ada20 2022-06-13 thomas Cannot be used with the
880 d6506a3d 2022-08-16 thomas Display the patch of modifications made in each commit.
883 d6506a3d 2022-08-16 thomas is specified, only show the patch of modifications at or within this path.
884 d6506a3d 2022-08-16 thomas Cannot be used with the
888 d6506a3d 2022-08-16 thomas Determine a set of commits to display as usual, but display these commits
889 d6506a3d 2022-08-16 thomas in reverse order.
890 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
891 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
892 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
893 d6506a3d 2022-08-16 thomas working directory.
894 d6506a3d 2022-08-16 thomas If this directory is a
896 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
897 2f7ada20 2022-06-13 thomas .It Fl S Ar search-pattern
898 4fe9456b 2022-06-13 thomas If specified, show only commits with a log message, author name,
899 4fe9456b 2022-06-13 thomas committer name, or ID SHA1 hash matched by the extended regular
900 4fe9456b 2022-06-13 thomas expression
901 6841bf13 2019-11-29 kn .Ar search-pattern .
902 314444e4 2022-06-13 thomas Lines in committed patches will be matched if
904 314444e4 2022-06-13 thomas is specified.
905 314444e4 2022-06-13 thomas File paths changed by a commit will be matched if
907 314444e4 2022-06-13 thomas is specified.
908 6841bf13 2019-11-29 kn Regular expression syntax is documented in
909 6841bf13 2019-11-29 kn .Xr re_format 7 .
911 d6506a3d 2022-08-16 thomas Display a short one-line summary of each commit, instead of the default
912 d6506a3d 2022-08-16 thomas history format.
913 d6506a3d 2022-08-16 thomas Cannot be used together with the
918 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
919 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
921 52ab7958 2020-04-18 stsp has been traversed.
922 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
924 d1fe46f9 2020-04-18 stsp is never traversed.
929 53d03f97 2023-01-10 thomas .Op Fl adPsw
930 56c96eff 2022-08-30 thomas .Op Fl C Ar number
931 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
932 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
933 56c96eff 2022-08-30 thomas .Op Ar object1 Ar object2 | Ar path ...
935 d912d125 2021-11-04 thomas .Dl Pq alias: Cm di
936 30f6c0c6 2021-10-08 thomas When invoked within a work tree without any arguments, display all
937 bd81cfb7 2020-04-19 stsp local changes in the work tree.
938 30f6c0c6 2021-10-08 thomas If one or more
940 30f6c0c6 2021-10-08 thomas arguments are specified, only show changes within the specified paths.
942 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
943 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
944 d24820bf 2019-08-11 stsp corresponding objects.
945 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
946 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
947 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
948 30f6c0c6 2021-10-08 thomas If none of these interpretations produce a valid result or if the
950 30f6c0c6 2021-10-08 thomas option is used,
952 30f6c0c6 2021-10-08 thomas .Cm got diff
953 30f6c0c6 2021-10-08 thomas is running in a work tree, attempt to interpret the two arguments as paths.
955 c0cc5c62 2018-10-18 stsp The options for
956 c0cc5c62 2018-10-18 stsp .Cm got diff
957 c0cc5c62 2018-10-18 stsp are as follows:
958 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
960 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
961 d6506a3d 2022-08-16 thomas .It Fl C Ar number
962 d6506a3d 2022-08-16 thomas Set the number of context lines shown in the diff.
963 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
964 cc8021af 2021-10-12 thomas .It Fl c Ar commit
965 cc8021af 2021-10-12 thomas Show differences between commits in the repository.
966 d6506a3d 2022-08-16 thomas This option may be used up to two times.
967 cc8021af 2021-10-12 thomas When used only once, show differences between the specified
968 cc8021af 2021-10-12 thomas .Ar commit
969 cc8021af 2021-10-12 thomas and its first parent commit.
970 cc8021af 2021-10-12 thomas When used twice, show differences between the two specified commits.
972 cc8021af 2021-10-12 thomas The expected argument is a commit ID SHA1 hash or an existing reference
973 cc8021af 2021-10-12 thomas or tag name which will be resolved to a commit ID.
974 cc8021af 2021-10-12 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
975 cc8021af 2021-10-12 thomas automatically, provided the abbreviation is unique.
979 cc8021af 2021-10-12 thomas option is used, all non-option arguments will be interpreted as paths.
980 cc8021af 2021-10-12 thomas If one or more such
982 cc8021af 2021-10-12 thomas arguments are provided, only show differences for the specified paths.
984 cc8021af 2021-10-12 thomas Cannot be used together with the
988 53d03f97 2023-01-10 thomas Display diffstat of changes before the actual diff by annotating each file path
989 53d03f97 2023-01-10 thomas or blob hash being diffed with the total number of lines added and removed.
990 53d03f97 2023-01-10 thomas A summary line will display the total number of changes across all files.
992 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
993 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
994 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
995 d6506a3d 2022-08-16 thomas This option is only valid when
996 d6506a3d 2022-08-16 thomas .Cm got diff
997 d6506a3d 2022-08-16 thomas is invoked in a work tree.
998 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
999 b72f483a 2019-02-05 stsp Use the repository at the specified path.
1000 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
1001 b72f483a 2019-02-05 stsp working directory.
1002 b72f483a 2019-02-05 stsp If this directory is a
1004 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1006 4ed9f614 2019-08-04 stsp Show changes staged with
1007 4ed9f614 2019-08-04 stsp .Cm got stage
1008 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
1009 30f6c0c6 2021-10-08 thomas This option is only valid when
1010 30f6c0c6 2021-10-08 thomas .Cm got diff
1011 30f6c0c6 2021-10-08 thomas is invoked in a work tree.
1013 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
1017 56c96eff 2022-08-30 thomas .Cm blame
1018 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1019 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1020 56c96eff 2022-08-30 thomas .Ar path
1022 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bl
1023 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1025 1ff8e573 2018-08-02 stsp The options for
1026 1ff8e573 2018-08-02 stsp .Cm got blame
1027 1ff8e573 2018-08-02 stsp are as follows:
1028 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1029 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1030 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1031 1ff8e573 2018-08-02 stsp .Ar commit .
1032 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1033 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1034 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1035 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1036 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1037 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1038 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1039 1ff8e573 2018-08-02 stsp working directory.
1040 0c06baac 2019-02-05 stsp If this directory is a
1042 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1046 56c96eff 2022-08-30 thomas .Cm tree
1047 56c96eff 2022-08-30 thomas .Op Fl iR
1048 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1049 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1050 56c96eff 2022-08-30 thomas .Op Ar path
1052 d912d125 2021-11-04 thomas .Dl Pq alias: Cm tr
1053 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1054 5de5890b 2018-10-18 stsp directory path in the repository.
1055 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1056 db0c2996 2019-02-10 stsp annotations:
1057 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1058 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1059 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1060 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1061 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1064 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1068 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1069 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1070 0c849583 2019-02-05 stsp if there is no work tree.
1072 5de5890b 2018-10-18 stsp The options for
1073 5de5890b 2018-10-18 stsp .Cm got tree
1074 5de5890b 2018-10-18 stsp are as follows:
1075 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1076 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1077 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1078 5de5890b 2018-10-18 stsp .Ar commit .
1079 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1080 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1081 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1082 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1083 d6506a3d 2022-08-16 thomas .It Fl i
1084 d6506a3d 2022-08-16 thomas Show object IDs of files (blob objects) and directories (tree objects).
1085 d6506a3d 2022-08-16 thomas .It Fl R
1086 d6506a3d 2022-08-16 thomas Recurse into sub-directories in the repository.
1087 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
1088 5de5890b 2018-10-18 stsp Use the repository at the specified path.
1089 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
1090 5de5890b 2018-10-18 stsp working directory.
1091 0c849583 2019-02-05 stsp If this directory is a
1093 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1097 56c96eff 2022-08-30 thomas .Op Fl dlt
1098 b6b86fd1 2022-08-30 thomas .Op Fl c Ar object
1099 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1100 56c96eff 2022-08-30 thomas .Op Fl s Ar reference
1101 56c96eff 2022-08-30 thomas .Op Ar name
1103 d0eebce4 2019-03-11 stsp Manage references in a repository.
1105 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1106 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1108 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1109 f16e4044 2019-10-09 stsp .Dq refs/ .
1111 d0eebce4 2019-03-11 stsp The options for
1112 d0eebce4 2019-03-11 stsp .Cm got ref
1113 d0eebce4 2019-03-11 stsp are as follows:
1114 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1115 d6506a3d 2022-08-16 thomas .It Fl c Ar object
1116 d6506a3d 2022-08-16 thomas Create a reference or change an existing reference.
1117 d6506a3d 2022-08-16 thomas The reference with the specified
1118 d6506a3d 2022-08-16 thomas .Ar name
1119 d6506a3d 2022-08-16 thomas will point at the specified
1120 d6506a3d 2022-08-16 thomas .Ar object .
1121 d6506a3d 2022-08-16 thomas The expected
1122 d6506a3d 2022-08-16 thomas .Ar object
1123 d6506a3d 2022-08-16 thomas argument is a ID SHA1 hash or an existing reference or tag name which will
1124 d6506a3d 2022-08-16 thomas be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1125 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1127 d6506a3d 2022-08-16 thomas .It Fl d
1128 d6506a3d 2022-08-16 thomas Delete the reference with the specified
1129 d6506a3d 2022-08-16 thomas .Ar name
1130 d6506a3d 2022-08-16 thomas from the repository.
1131 d6506a3d 2022-08-16 thomas Any commit, tree, tag, and blob objects belonging to deleted references
1132 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1133 d6506a3d 2022-08-16 thomas Git's garbage collector or
1134 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1135 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1138 b2070a3f 2020-03-22 stsp List references in the repository.
1141 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
1144 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
1145 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
1146 b2070a3f 2020-03-22 stsp .Ar name .
1147 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1151 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1152 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1153 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1154 d6506a3d 2022-08-16 thomas working directory.
1155 d6506a3d 2022-08-16 thomas If this directory is a
1157 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1158 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1159 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1160 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1162 e31abbf2 2020-03-22 stsp will point at the specified
1163 e31abbf2 2020-03-22 stsp .Ar reference
1164 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1165 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1166 d1c1ae5f 2019-08-12 stsp this option is used.
1167 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1169 d6506a3d 2022-08-16 thomas .It Fl t
1170 d6506a3d 2022-08-16 thomas Sort listed references by modification time (most recently modified first)
1171 d6506a3d 2022-08-16 thomas instead of sorting by lexicographical order.
1172 d6506a3d 2022-08-16 thomas Use of this option requires the
1174 d6506a3d 2022-08-16 thomas option to be used as well.
1178 56c96eff 2022-08-30 thomas .Cm branch
1179 56c96eff 2022-08-30 thomas .Op Fl lnt
1180 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1181 56c96eff 2022-08-30 thomas .Op Fl d Ar name
1182 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1183 56c96eff 2022-08-30 thomas .Op Ar name
1185 d912d125 2021-11-04 thomas .Dl Pq alias: Cm br
1186 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1188 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1189 4e759de4 2019-06-26 stsp .Dq refs/heads/
1190 4e759de4 2019-06-26 stsp reference namespace.
1192 4e759de4 2019-06-26 stsp .Cm got branch
1193 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1195 4b06140e 2022-03-22 thomas When deleting branches, the specified
1197 2f1457c6 2021-08-27 stsp is searched in the
1198 2f1457c6 2021-08-27 stsp .Dq refs/heads
1199 2f1457c6 2021-08-27 stsp reference namespace first.
1200 4b06140e 2022-03-22 thomas If no corresponding branch is found, the
1201 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1202 2f1457c6 2021-08-27 stsp namespace will be searched next.
1204 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1205 ad89fa31 2019-10-04 stsp work tree's current branch.
1209 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1210 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1211 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1212 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1214 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1215 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1216 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1217 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1219 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1220 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1221 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1222 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1223 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1224 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1225 da76fce2 2020-02-24 stsp .It A Ta new file was added
1226 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1227 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1230 4e759de4 2019-06-26 stsp The options for
1231 4e759de4 2019-06-26 stsp .Cm got branch
1232 4e759de4 2019-06-26 stsp are as follows:
1233 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1234 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1235 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1236 a74f7e83 2019-11-10 stsp .Ar commit .
1237 a74f7e83 2019-11-10 stsp The expected
1238 a74f7e83 2019-11-10 stsp .Ar commit
1239 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1240 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1241 d6506a3d 2022-08-16 thomas .It Fl d Ar name
1242 d6506a3d 2022-08-16 thomas Delete the branch with the specified
1243 d6506a3d 2022-08-16 thomas .Ar name
1244 d6506a3d 2022-08-16 thomas from the
1245 d6506a3d 2022-08-16 thomas .Dq refs/heads
1247 d6506a3d 2022-08-16 thomas .Dq refs/remotes
1248 d6506a3d 2022-08-16 thomas reference namespace.
1250 d6506a3d 2022-08-16 thomas Only the branch reference is deleted.
1251 d6506a3d 2022-08-16 thomas Any commit, tree, and blob objects belonging to the branch
1252 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1253 d6506a3d 2022-08-16 thomas Git's garbage collector or
1254 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1256 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1257 34d4e04c 2021-02-08 stsp repositories' branches in the
1258 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1259 34d4e04c 2021-02-08 stsp reference namespace.
1261 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1262 ba882ee3 2019-07-11 stsp with one the following annotations:
1263 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1264 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1265 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1267 d6506a3d 2022-08-16 thomas .It Fl n
1268 d6506a3d 2022-08-16 thomas Do not switch and update the work tree after creating a new branch.
1269 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1270 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1271 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1272 d6506a3d 2022-08-16 thomas working directory.
1273 d6506a3d 2022-08-16 thomas If this directory is a
1275 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1276 a0b48eaf 2021-11-20 thomas .It Fl t
1277 a0b48eaf 2021-11-20 thomas Sort listed branches by modification time (most recently modified first)
1278 a0b48eaf 2021-11-20 thomas instead of sorting by lexicographical order.
1279 a0b48eaf 2021-11-20 thomas Branches in the
1280 a0b48eaf 2021-11-20 thomas .Dq refs/heads/
1281 a0b48eaf 2021-11-20 thomas reference namespace are listed before branches in
1282 a0b48eaf 2021-11-20 thomas .Dq refs/remotes/
1283 a0b48eaf 2021-11-20 thomas regardless.
1284 a0b48eaf 2021-11-20 thomas Use of this option requires the
1286 a0b48eaf 2021-11-20 thomas option to be used as well.
1290 56c96eff 2022-08-30 thomas .Op Fl lVv
1291 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1292 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1293 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1294 56c96eff 2022-08-30 thomas .Op Fl s Ar signer-id
1295 56c96eff 2022-08-30 thomas .Ar name
1297 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1299 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1300 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1301 8e7bd50a 2019-08-22 stsp reference namespace.
1303 8e7bd50a 2019-08-22 stsp .Cm got tag
1304 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1305 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1306 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1308 80106605 2020-02-24 stsp Attempt to create a tag with the given
1309 8e7bd50a 2019-08-22 stsp .Ar name ,
1310 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1311 8e7bd50a 2019-08-22 stsp .Ar commit .
1312 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1313 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1314 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1316 8e7bd50a 2019-08-22 stsp The options for
1317 8e7bd50a 2019-08-22 stsp .Cm got tag
1318 8e7bd50a 2019-08-22 stsp are as follows:
1319 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1320 80106605 2020-02-24 stsp .It Fl c Ar commit
1321 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1322 80106605 2020-02-24 stsp .Ar commit .
1323 80106605 2020-02-24 stsp The expected
1324 80106605 2020-02-24 stsp .Ar commit
1325 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1326 80106605 2020-02-24 stsp will be resolved to a commit ID.
1327 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1328 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1329 d6506a3d 2022-08-16 thomas .It Fl l
1330 d6506a3d 2022-08-16 thomas List all existing tags in the repository instead of creating a new tag.
1332 d6506a3d 2022-08-16 thomas .Ar name
1333 d6506a3d 2022-08-16 thomas argument is passed, show only the tag with the given
1334 d6506a3d 2022-08-16 thomas .Ar name .
1335 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1336 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1337 8e7bd50a 2019-08-22 stsp Without the
1340 3a62228f 2019-11-08 stsp .Cm got tag
1341 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1342 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1343 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1344 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1345 8e7bd50a 2019-08-22 stsp working directory.
1346 8e7bd50a 2019-08-22 stsp If this directory is a
1348 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1349 839dd04f 2022-07-04 thomas .It Fl s Ar signer-id
1350 839dd04f 2022-07-04 thomas While creating a new tag, sign this tag with the identity given in
1351 839dd04f 2022-07-04 thomas .Ar signer-id .
1353 839dd04f 2022-07-04 thomas For SSH-based signatures,
1354 839dd04f 2022-07-04 thomas .Ar signer-id
1355 839dd04f 2022-07-04 thomas is the path to a file which may refer to either a private SSH key,
1356 839dd04f 2022-07-04 thomas or a public SSH key with the private half available via
1357 839dd04f 2022-07-04 thomas .Xr ssh-agent 1 .
1358 839dd04f 2022-07-04 thomas .Cm got tag
1359 839dd04f 2022-07-04 thomas will sign the tag object by invoking
1360 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1361 839dd04f 2022-07-04 thomas with the
1362 b6bfeb85 2022-08-16 thomas .Fl Y Cm sign
1363 839dd04f 2022-07-04 thomas command, using the signature namespace
1365 839dd04f 2022-07-04 thomas for compatibility with
1366 839dd04f 2022-07-04 thomas .Xr git 1 .
1367 839dd04f 2022-07-04 thomas .It Fl V
1368 839dd04f 2022-07-04 thomas Verify tag object signatures.
1370 839dd04f 2022-07-04 thomas .Ar name
1371 839dd04f 2022-07-04 thomas is specified, show and verify the tag object with the provided name.
1372 839dd04f 2022-07-04 thomas Otherwise, list all tag objects and verify signatures where present.
1374 839dd04f 2022-07-04 thomas .Cm got tag
1375 839dd04f 2022-07-04 thomas verifies SSH-based signatures by invoking
1376 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1377 839dd04f 2022-07-04 thomas with the options
1378 b6bfeb85 2022-08-16 thomas .Fl Y Cm verify Fl f Ar allowed_signers .
1379 839dd04f 2022-07-04 thomas A path to the
1380 839dd04f 2022-07-04 thomas .Ar allowed_signers
1381 839dd04f 2022-07-04 thomas file must be set in
1382 839dd04f 2022-07-04 thomas .Xr got.conf 5 ,
1383 839dd04f 2022-07-04 thomas otherwise verification is impossible.
1384 d6506a3d 2022-08-16 thomas .It Fl v
1385 d6506a3d 2022-08-16 thomas Verbose mode.
1386 d6506a3d 2022-08-16 thomas During SSH signature creation and verification this option will be passed to
1387 d6506a3d 2022-08-16 thomas .Xr ssh-keygen 1 .
1388 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
1389 d6506a3d 2022-08-16 thomas The maximum is 3.
1392 8e7bd50a 2019-08-22 stsp By design, the
1393 8e7bd50a 2019-08-22 stsp .Cm got tag
1394 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1395 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1396 8e7bd50a 2019-08-22 stsp .Cm got ref
1397 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1398 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1399 8e7bd50a 2019-08-22 stsp another repository.
1402 56c96eff 2022-08-30 thomas .Op Fl IR
1403 56c96eff 2022-08-30 thomas .Ar path ...
1405 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1406 d00136be 2019-03-26 stsp repository in the next commit.
1407 ff56836b 2021-07-08 stsp By default, files which match a
1408 ff56836b 2021-07-08 stsp .Cm got status
1409 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1411 4e68cba3 2019-11-23 stsp The options for
1412 4e68cba3 2019-11-23 stsp .Cm got add
1413 4e68cba3 2019-11-23 stsp are as follows:
1414 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1415 d6506a3d 2022-08-16 thomas .It Fl I
1416 d6506a3d 2022-08-16 thomas Add files even if they match a
1417 d6506a3d 2022-08-16 thomas .Cm got status
1418 d6506a3d 2022-08-16 thomas ignore pattern.
1420 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1421 4e68cba3 2019-11-23 stsp If this option is not specified,
1422 4e68cba3 2019-11-23 stsp .Cm got add
1423 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1425 4e68cba3 2019-11-23 stsp is a directory.
1429 56c96eff 2022-08-30 thomas .Cm remove
1430 56c96eff 2022-08-30 thomas .Op Fl fkR
1431 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
1432 56c96eff 2022-08-30 thomas .Ar path ...
1434 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rm
1435 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1436 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1438 2ec1f75b 2019-03-26 stsp The options for
1439 86d25a1b 2019-07-11 stsp .Cm got remove
1440 2ec1f75b 2019-03-26 stsp are as follows:
1441 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1443 d64cc78a 2022-01-25 thomas Perform the operation even if a file contains local modifications,
1444 d64cc78a 2022-01-25 thomas and do not raise an error if a specified
1445 d64cc78a 2022-01-25 thomas .Ar path
1446 d64cc78a 2022-01-25 thomas does not exist on disk.
1447 70e3e7f5 2019-12-13 tracey .It Fl k
1448 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1449 f2a9dc41 2019-12-13 tracey .It Fl R
1450 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1451 f2a9dc41 2019-12-13 tracey If this option is not specified,
1452 f2a9dc41 2019-12-13 tracey .Cm got remove
1453 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1454 f2a9dc41 2019-12-13 tracey .Ar path
1455 f2a9dc41 2019-12-13 tracey is a directory.
1456 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1457 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1458 766841c2 2020-08-13 stsp single-character status codes contained in the
1459 766841c2 2020-08-13 stsp .Ar status-codes
1461 766841c2 2020-08-13 stsp The following status codes may be specified:
1462 766841c2 2020-08-13 stsp .Bl -column YXZ description
1463 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1466 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1471 56c96eff 2022-08-30 thomas .Cm patch
1472 56c96eff 2022-08-30 thomas .Op Fl nR
1473 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1474 56c96eff 2022-08-30 thomas .Op Fl p Ar strip-count
1475 56c96eff 2022-08-30 thomas .Op Ar patchfile
1477 069bbb86 2022-03-07 thomas .Dl Pq alias: Cm pa
1478 069bbb86 2022-03-07 thomas Apply changes from
1479 069bbb86 2022-03-07 thomas .Ar patchfile
1480 07f74738 2022-03-13 thomas to files in a work tree.
1481 443c08c9 2022-03-13 thomas Files added or removed by a patch will be scheduled for addition or removal in
1482 443c08c9 2022-03-13 thomas the work tree.
1484 07f74738 2022-03-13 thomas The patch must be in the unified diff format as produced by
1485 07f74738 2022-03-13 thomas .Cm got diff ,
1486 99e34129 2022-03-22 thomas .Xr git-diff 1 ,
1488 07f74738 2022-03-13 thomas .Xr diff 1
1490 3eb4f629 2022-03-22 thomas .Xr cvs 1
1491 6f7394ad 2022-03-22 thomas diff when invoked with their
1493 6f7394ad 2022-03-22 thomas options.
1495 069bbb86 2022-03-07 thomas .Ar patchfile
1496 07f74738 2022-03-13 thomas argument is provided, read unified diff data from standard input instead.
1499 07f74738 2022-03-13 thomas .Ar patchfile
1500 4b06140e 2022-03-22 thomas contains multiple patches, then attempt to apply each of them in sequence.
1502 4929098b 2022-03-13 thomas Show the status of each affected file, using the following status codes:
1503 069bbb86 2022-03-07 thomas .Bl -column XYZ description
1504 07f74738 2022-03-13 thomas .It M Ta file was modified
1505 762b8e82 2022-06-23 thomas .It G Ta file was merged using a merge-base found in the repository
1506 762b8e82 2022-06-23 thomas .It C Ta file was merged and conflicts occurred during merge
1507 07f74738 2022-03-13 thomas .It D Ta file was deleted
1508 07f74738 2022-03-13 thomas .It A Ta file was added
1509 49114f01 2022-03-22 thomas .It # Ta failed to patch the file
1512 07f74738 2022-03-13 thomas If a change does not match at its exact line number, attempt to
1513 4929098b 2022-03-13 thomas apply it somewhere else in the file if a good spot can be found.
1514 4929098b 2022-03-13 thomas Otherwise, the patch will fail to apply.
1517 2cfc25ac 2022-03-13 thomas .Cm patch
1518 2cfc25ac 2022-03-13 thomas will refuse to apply a patch if certain preconditions are not met.
1519 4929098b 2022-03-13 thomas Files to be deleted must already be under version control, and must
1520 4929098b 2022-03-13 thomas not have been scheduled for deletion already.
1521 4929098b 2022-03-13 thomas Files to be added must not yet be under version control and must not
1522 4929098b 2022-03-13 thomas already be present on disk.
1523 4929098b 2022-03-13 thomas Files to be modified must already be under version control and may not
1524 4929098b 2022-03-13 thomas contain conflict markers.
1526 2cfc25ac 2022-03-13 thomas If an error occurs, the
1527 2cfc25ac 2022-03-13 thomas .Cm patch
1528 2cfc25ac 2022-03-13 thomas operation will be aborted.
1529 2cfc25ac 2022-03-13 thomas Any changes made to the work tree up to this point will be left behind.
1530 07f74738 2022-03-13 thomas Such changes can be viewed with
1531 2cfc25ac 2022-03-13 thomas .Cm got diff
1532 2cfc25ac 2022-03-13 thomas and can be reverted with
1533 2cfc25ac 2022-03-13 thomas .Cm got revert
1534 2cfc25ac 2022-03-13 thomas if needed.
1536 bfc91212 2022-03-13 thomas The options for
1537 bfc91212 2022-03-13 thomas .Cm got patch
1538 bfc91212 2022-03-13 thomas are as follows:
1539 bfc91212 2022-03-13 thomas .Bl -tag -width Ds
1540 7d8bcb99 2022-07-28 thomas .It Fl c Ar commit
1541 82a8b7ec 2022-08-06 thomas Attempt to locate files within the specified
1542 7d8bcb99 2022-07-28 thomas .Ar commit
1543 82a8b7ec 2022-08-06 thomas for use as a merge-base for 3-way merges.
1544 82a8b7ec 2022-08-06 thomas Ideally, the specified
1545 82a8b7ec 2022-08-06 thomas .Ar commit
1546 82a8b7ec 2022-08-06 thomas should contain versions of files which the changes contained in the
1547 82a8b7ec 2022-08-06 thomas .Ar patchfile
1548 82a8b7ec 2022-08-06 thomas were based on.
1549 82a8b7ec 2022-08-06 thomas Files will be located by path, relative to the repository root.
1552 82a8b7ec 2022-08-06 thomas option is used then leading path components will be stripped
1553 82a8b7ec 2022-08-06 thomas before paths are looked up in the repository.
1557 82a8b7ec 2022-08-06 thomas option is not used then
1558 82a8b7ec 2022-08-06 thomas .Cm got patch
1559 82a8b7ec 2022-08-06 thomas will attempt to locate merge-bases via object IDs found in
1560 82a8b7ec 2022-08-06 thomas .Ar patchfile
1561 82a8b7ec 2022-08-06 thomas meta-data, such as produced by
1562 82a8b7ec 2022-08-06 thomas .Cm got diff
1564 82a8b7ec 2022-08-06 thomas .Xr git-diff 1 .
1565 82a8b7ec 2022-08-06 thomas Use of the
1567 82a8b7ec 2022-08-06 thomas option is only recommended in the absence of such meta-data.
1569 82a8b7ec 2022-08-06 thomas In case no merge-base is available for a file, changes will be applied
1570 82a8b7ec 2022-08-06 thomas without doing a 3-way merge.
1571 82a8b7ec 2022-08-06 thomas Changes which do not apply cleanly may then be rejected entirely, rather
1572 82a8b7ec 2022-08-06 thomas than producing merge conflicts in the patched target file.
1573 bfc91212 2022-03-13 thomas .It Fl n
1574 bfc91212 2022-03-13 thomas Do not make any modifications to the work tree.
1575 bfc91212 2022-03-13 thomas This can be used to check whether a patch would apply without issues.
1577 bfc91212 2022-03-13 thomas .Ar patchfile
1578 4b06140e 2022-03-22 thomas contains diffs that affect the same file multiple times, the results
1579 bfc91212 2022-03-13 thomas displayed may be incorrect.
1580 d9db2ff9 2022-04-16 thomas .It Fl p Ar strip-count
1581 d9db2ff9 2022-04-16 thomas Specify the number of leading path components to strip from paths
1582 d9db2ff9 2022-04-16 thomas parsed from
1583 d9db2ff9 2022-04-16 thomas .Ar patchfile .
1586 d9db2ff9 2022-04-16 thomas option is not used,
1590 d9db2ff9 2022-04-16 thomas path prefixes generated by
1591 d9db2ff9 2022-04-16 thomas .Xr git-diff 1
1592 d9db2ff9 2022-04-16 thomas will be recognized and stripped automatically.
1593 eaef698f 2022-04-23 thomas .It Fl R
1594 eaef698f 2022-04-23 thomas Reverse the patch before applying it.
1598 56c96eff 2022-08-30 thomas .Cm revert
1599 56c96eff 2022-08-30 thomas .Op Fl pR
1600 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
1601 56c96eff 2022-08-30 thomas .Ar path ...
1603 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rv
1604 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1605 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1606 1dd86744 2019-08-12 anthony work tree's base commit.
1607 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1608 a129376b 2019-03-28 stsp .Cm got revert !
1610 e20a8b6f 2019-06-04 stsp If a file was added with
1611 4b06140e 2022-03-22 thomas .Cm got add ,
1612 a129376b 2019-03-28 stsp it will become an unversioned file again.
1613 e20a8b6f 2019-06-04 stsp If a file was deleted with
1614 4b06140e 2022-03-22 thomas .Cm got remove ,
1615 a129376b 2019-03-28 stsp it will be restored.
1617 0f6d7415 2019-08-08 stsp The options for
1618 0f6d7415 2019-08-08 stsp .Cm got revert
1619 0f6d7415 2019-08-08 stsp are as follows:
1620 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1621 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
1622 d6506a3d 2022-08-16 thomas With the
1624 d6506a3d 2022-08-16 thomas option, read
1629 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
1630 d6506a3d 2022-08-16 thomas .Ar response-script
1631 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
1633 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1634 33aa809d 2019-08-08 stsp changes to revert based on
1636 33aa809d 2019-08-08 stsp (revert change),
1638 33aa809d 2019-08-08 stsp (keep change), and
1640 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1641 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1642 33aa809d 2019-08-08 stsp modified file content can be reverted.
1643 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1645 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1646 0f6d7415 2019-08-08 stsp If this option is not specified,
1647 0f6d7415 2019-08-08 stsp .Cm got revert
1648 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1650 0f6d7415 2019-08-08 stsp is a directory.
1654 56c96eff 2022-08-30 thomas .Cm commit
1655 ef899790 2022-11-01 thomas .Op Fl NnS
1656 56c96eff 2022-08-30 thomas .Op Fl A Ar author
1657 56c96eff 2022-08-30 thomas .Op Fl F Ar path
1658 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1659 56c96eff 2022-08-30 thomas .Op Ar path ...
1661 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ci
1662 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1663 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1666 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1667 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1669 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1670 1dd86744 2019-08-12 anthony .Cm got stage ,
1671 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1672 4ed9f614 2019-08-04 stsp have not been staged.
1674 28cf319f 2021-01-28 stsp .Cm got commit
1675 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1676 28cf319f 2021-01-28 stsp unless the
1678 28cf319f 2021-01-28 stsp option is used
1683 28cf319f 2021-01-28 stsp options are used together.
1685 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1686 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1687 15cd91f7 2019-05-12 stsp .It M Ta modified file
1688 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1689 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1690 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1693 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1694 996d5ccd 2019-08-05 stsp recorded base commit.
1697 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1698 15cd91f7 2019-05-12 stsp multiple base commits.
1699 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1700 47ec7be7 2019-05-12 stsp .Cm got update
1701 47ec7be7 2019-05-12 stsp across the entire work tree.
1704 15cd91f7 2019-05-12 stsp .Cm got commit
1705 15cd91f7 2019-05-12 stsp command requires the
1706 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1707 aba9c984 2019-09-08 stsp environment variable to be set,
1708 257add31 2020-09-09 stsp unless an author has been configured in
1709 257add31 2020-09-09 stsp .Xr got.conf 5
1711 aba9c984 2019-09-08 stsp .Dv user.name
1713 709ae9eb 2019-09-08 stsp .Dv user.email
1714 709ae9eb 2019-09-08 stsp configuration settings can be
1715 aba9c984 2019-09-08 stsp obtained from the repository's
1716 aba9c984 2019-09-08 stsp .Pa .git/config
1717 c9956ddf 2019-09-08 stsp file or from Git's global
1718 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1719 c9956ddf 2019-09-08 stsp configuration file.
1721 74416c47 2019-05-09 stsp The options for
1722 74416c47 2019-05-09 stsp .Cm got commit
1723 74416c47 2019-05-09 stsp are as follows:
1724 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1725 18d1acad 2022-07-20 thomas .It Fl A Ar author
1726 18d1acad 2022-07-20 thomas Set author information in the newly created commit to
1727 18d1acad 2022-07-20 thomas .Ar author .
1728 fbbd3dd5 2023-02-17 thomas This is useful when committing changes on behalf of someone else.
1730 18d1acad 2022-07-20 thomas .Ar author
1731 18d1acad 2022-07-20 thomas argument must use the same format as the
1732 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
1733 18d1acad 2022-07-20 thomas environment variable.
1735 18d1acad 2022-07-20 thomas In addition to storing author information, the newly created commit
1736 18d1acad 2022-07-20 thomas object will retain
1737 18d1acad 2022-07-20 thomas .Dq committer
1738 18d1acad 2022-07-20 thomas information which is obtained, as usual, from the
1739 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
1740 18d1acad 2022-07-20 thomas environment variable, or
1741 18d1acad 2022-07-20 thomas .Xr got.conf 5 ,
1742 18d1acad 2022-07-20 thomas or Git configuration settings.
1743 28cf319f 2021-01-28 stsp .It Fl F Ar path
1744 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1746 28cf319f 2021-01-28 stsp when creating the new commit.
1747 28cf319f 2021-01-28 stsp .Cm got commit
1748 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1749 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1750 28cf319f 2021-01-28 stsp Cannot be used together with the
1753 28cf319f 2021-01-28 stsp .It Fl m Ar message
1754 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1755 28cf319f 2021-01-28 stsp Cannot be used together with the
1759 28cf319f 2021-01-28 stsp This option prevents
1760 23594da9 2019-05-13 stsp .Cm got commit
1761 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1762 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1764 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1765 ef899790 2022-11-01 thomas .It Fl n
1766 ef899790 2022-11-01 thomas This option prevents
1767 ef899790 2022-11-01 thomas .Cm got commit
1768 ef899790 2022-11-01 thomas from generating a diff of the to-be-committed changes in a temporary file
1769 ef899790 2022-11-01 thomas which can be viewed while editing a commit message.
1771 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1772 af358f55 2020-07-23 stsp that is under version control.
1773 af358f55 2020-07-23 stsp By default,
1774 af358f55 2020-07-23 stsp .Cm got commit
1775 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1776 35213c7c 2020-07-23 stsp As a precaution,
1778 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1779 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1780 af358f55 2020-07-23 stsp points outside of the work tree.
1781 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1782 af358f55 2020-07-23 stsp .Dq make obj
1783 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1784 af358f55 2020-07-23 stsp version control.
1787 cfce0458 2019-07-28 stsp .Cm got commit
1788 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1789 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1790 916f288c 2019-07-30 stsp .Dq refs/heads/
1791 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1792 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1793 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1794 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1795 cfce0458 2019-07-28 stsp .Cm got update
1796 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1797 cfce0458 2019-07-28 stsp in the repository.
1800 56c96eff 2022-08-30 thomas .Cm send
1801 56c96eff 2022-08-30 thomas .Op Fl afqTv
1802 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
1803 56c96eff 2022-08-30 thomas .Op Fl d Ar branch
1804 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1805 56c96eff 2022-08-30 thomas .Op Fl t Ar tag
1806 56c96eff 2022-08-30 thomas .Op Ar remote-repository
1808 d912d125 2021-11-04 thomas .Dl Pq alias: Cm se
1809 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
1811 f8a36e22 2021-08-26 stsp .Ar remote-repository
1812 f8a36e22 2021-08-26 stsp is specified,
1813 f8a36e22 2021-08-26 stsp .Dq origin
1814 f8a36e22 2021-08-26 stsp will be used.
1815 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
1816 f8a36e22 2021-08-26 stsp .Xr got.conf 5
1818 f8a36e22 2021-08-26 stsp .Pa config
1819 f8a36e22 2021-08-26 stsp file of the local repository, as created by
1820 f8a36e22 2021-08-26 stsp .Cm got clone .
1822 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
1823 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
1824 f8a36e22 2021-08-26 stsp Upon success, references in the
1825 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
1826 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
1827 f8a36e22 2021-08-26 stsp the commits which have been sent.
1829 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
1830 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
1831 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
1832 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
1833 fd44090b 2021-08-26 stsp be fetched from the server with
1834 f8a36e22 2021-08-26 stsp .Cm got fetch
1835 f8a36e22 2021-08-26 stsp and local branches must be rebased with
1836 f8a36e22 2021-08-26 stsp .Cm got rebase
1838 f8a36e22 2021-08-26 stsp .Cm got send
1839 f8a36e22 2021-08-26 stsp can succeed.
1842 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
1844 f8a36e22 2021-08-26 stsp The options for
1845 f8a36e22 2021-08-26 stsp .Cm got send
1846 f8a36e22 2021-08-26 stsp are as follows:
1847 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
1849 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
1850 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1851 f8a36e22 2021-08-26 stsp reference namespace.
1854 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
1857 f8a36e22 2021-08-26 stsp Cannot be used together with the
1860 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
1861 f8a36e22 2021-08-26 stsp Send the specified
1862 f8a36e22 2021-08-26 stsp .Ar branch
1863 f8a36e22 2021-08-26 stsp from the local repository's
1864 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1865 f8a36e22 2021-08-26 stsp reference namespace.
1866 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1868 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
1869 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
1870 f8a36e22 2021-08-26 stsp Cannot be used together with the
1873 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
1874 f8a36e22 2021-08-26 stsp Delete the specified
1875 f8a36e22 2021-08-26 stsp .Ar branch
1876 f8a36e22 2021-08-26 stsp from the remote repository's
1877 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1878 f8a36e22 2021-08-26 stsp reference namespace.
1879 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1880 f8a36e22 2021-08-26 stsp to delete.
1882 f8a36e22 2021-08-26 stsp Only references are deleted.
1883 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
1884 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
1885 f8a36e22 2021-08-26 stsp the server.
1887 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
1888 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
1889 fd44090b 2021-08-26 stsp based on its configuration.
1891 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
1892 fd44090b 2021-08-26 stsp in the remote repository, even when
1893 fd44090b 2021-08-26 stsp .Cm got fetch
1895 fd44090b 2021-08-26 stsp .Cm got rebase
1896 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
1897 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
1898 f8a36e22 2021-08-26 stsp configuration.
1900 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
1901 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
1902 f8a36e22 2021-08-26 stsp on the server.
1905 f8a36e22 2021-08-26 stsp .Dq refs/tags
1906 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
1907 f8a36e22 2021-08-26 stsp Use of the
1909 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
1910 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
1911 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1912 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1914 f8a36e22 2021-08-26 stsp Use of the
1916 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
1917 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
1918 f8a36e22 2021-08-26 stsp Instead of using the
1920 f8a36e22 2021-08-26 stsp option, new changes should
1921 f8a36e22 2021-08-26 stsp be fetched with
1922 f8a36e22 2021-08-26 stsp .Cm got fetch
1923 f8a36e22 2021-08-26 stsp and local branches should be rebased with
1924 f8a36e22 2021-08-26 stsp .Cm got rebase ,
1925 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
1929 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
1930 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
1931 f8a36e22 2021-08-26 stsp disposable.
1932 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
1933 f8a36e22 2021-08-26 stsp should also be taken into account.
1934 d6506a3d 2022-08-16 thomas .It Fl q
1935 d6506a3d 2022-08-16 thomas Suppress progress reporting output.
1936 d6506a3d 2022-08-16 thomas The same option will be passed to
1937 d6506a3d 2022-08-16 thomas .Xr ssh 1
1938 d6506a3d 2022-08-16 thomas if applicable.
1939 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
1940 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
1941 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
1942 f8a36e22 2021-08-26 stsp working directory.
1943 f8a36e22 2021-08-26 stsp If this directory is a
1945 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
1946 d6506a3d 2022-08-16 thomas .It Fl T
1947 d6506a3d 2022-08-16 thomas Attempt to send all tags from the local repository's
1948 d6506a3d 2022-08-16 thomas .Dq refs/tags/
1949 d6506a3d 2022-08-16 thomas reference namespace.
1952 d6506a3d 2022-08-16 thomas option is equivalent to listing all tags with multiple
1954 d6506a3d 2022-08-16 thomas options.
1955 d6506a3d 2022-08-16 thomas Cannot be used together with the
1958 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
1959 f8a36e22 2021-08-26 stsp Send the specified
1961 f8a36e22 2021-08-26 stsp from the local repository's
1962 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1963 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
1966 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
1967 f8a36e22 2021-08-26 stsp No tags will be sent if the
1969 f8a36e22 2021-08-26 stsp option is not used.
1971 f8a36e22 2021-08-26 stsp Raise an error if the specified
1973 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
1975 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
1976 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1977 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1979 f8a36e22 2021-08-26 stsp Cannot be used together with the
1983 f8a36e22 2021-08-26 stsp Verbose mode.
1985 f8a36e22 2021-08-26 stsp .Cm got send
1986 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
1987 f8a36e22 2021-08-26 stsp The same option will be passed to
1989 f8a36e22 2021-08-26 stsp if applicable.
1990 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
1991 f8a36e22 2021-08-26 stsp The maximum is 3.
1995 f6cd0243 2023-01-28 thomas .Cm cherrypick
1996 f6cd0243 2023-01-28 thomas .Op Fl lX
1997 7e710171 2023-01-28 thomas .Op Ar commit
1999 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cy
2000 234035bc 2019-06-01 stsp Merge changes from a single
2001 234035bc 2019-06-01 stsp .Ar commit
2002 234035bc 2019-06-01 stsp into the work tree.
2003 234035bc 2019-06-01 stsp The specified
2004 234035bc 2019-06-01 stsp .Ar commit
2005 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
2006 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
2007 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2008 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2010 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
2011 234035bc 2019-06-01 stsp .Bl -column YXZ description
2012 234035bc 2019-06-01 stsp .It G Ta file was merged
2013 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
2014 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
2015 234035bc 2019-06-01 stsp .It D Ta file was deleted
2016 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2017 234035bc 2019-06-01 stsp .It A Ta new file was added
2018 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2019 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2022 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2023 234035bc 2019-06-01 stsp may be viewed with
2024 234035bc 2019-06-01 stsp .Cm got diff ,
2025 234035bc 2019-06-01 stsp amended manually or with further
2026 234035bc 2019-06-01 stsp .Cm got cherrypick
2028 234035bc 2019-06-01 stsp committed with
2029 52d3950d 2023-01-28 thomas .Cm got commit .
2031 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2032 52d3950d 2023-01-28 thomas .Cm rebase ,
2033 52d3950d 2023-01-28 thomas .Cm histedit ,
2035 52d3950d 2023-01-28 thomas .Cm merge
2036 52d3950d 2023-01-28 thomas operation is taking place,
2037 52d3950d 2023-01-28 thomas .Cm got cherrypick
2038 52d3950d 2023-01-28 thomas creates a record of commits which have been merged into the work tree.
2039 52d3950d 2023-01-28 thomas When a file changed by
2040 52d3950d 2023-01-28 thomas .Cm got cherrypick
2041 52d3950d 2023-01-28 thomas is committed with
2042 52d3950d 2023-01-28 thomas .Cm got commit ,
2043 52d3950d 2023-01-28 thomas the log messages of relevant merged commits will then appear in the editor,
2044 75a8c854 2023-02-17 thomas where the messages should be further adjusted to convey the reasons for
2045 95e6f77e 2023-01-28 thomas cherrypicking the changes.
2046 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2047 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2048 75a8c854 2023-02-17 thomas .Cm got commit
2049 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2051 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2052 52d3950d 2023-01-28 thomas e.g. with
2053 52d3950d 2023-01-28 thomas .Cm got revert ,
2054 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2056 234035bc 2019-06-01 stsp .Cm got cherrypick
2057 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2058 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2059 234035bc 2019-06-01 stsp to a single base commit with
2060 234035bc 2019-06-01 stsp .Cm got update .
2061 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2062 234035bc 2019-06-01 stsp conflicts must be resolved first.
2064 f6cd0243 2023-01-28 thomas The options for
2066 f6cd0243 2023-01-28 thomas .Cm cherrypick
2067 f6cd0243 2023-01-28 thomas are as follows:
2068 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2069 f6cd0243 2023-01-28 thomas .It Fl l
2070 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by cherrypick operations,
2071 f6cd0243 2023-01-28 thomas represented by references in the
2072 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2073 f6cd0243 2023-01-28 thomas reference namespace.
2075 f6cd0243 2023-01-28 thomas .Ar commit
2076 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2078 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2079 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2080 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2081 f6cd0243 2023-01-28 thomas work tree in which they were created.
2082 f6cd0243 2023-01-28 thomas This option cannot be used with
2084 f6cd0243 2023-01-28 thomas .It Fl X
2085 f6cd0243 2023-01-28 thomas Delete log messages created by previous cherrypick operations, represented by
2086 f6cd0243 2023-01-28 thomas references in the
2087 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2088 f6cd0243 2023-01-28 thomas reference namespace.
2090 f6cd0243 2023-01-28 thomas .Ar commit
2091 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2093 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2094 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2095 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2096 f6cd0243 2023-01-28 thomas work tree in which they were created.
2097 f6cd0243 2023-01-28 thomas This option cannot be used with
2103 f6cd0243 2023-01-28 thomas .Cm backout
2104 f6cd0243 2023-01-28 thomas .Op Fl lX
2105 7e710171 2023-01-28 thomas .Op Ar commit
2107 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bo
2108 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2109 5ef14e63 2019-06-02 stsp .Ar commit
2110 5ef14e63 2019-06-02 stsp into the work tree.
2111 5ef14e63 2019-06-02 stsp The specified
2112 5ef14e63 2019-06-02 stsp .Ar commit
2113 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2114 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
2115 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2116 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2118 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2119 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2120 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2121 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2122 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2123 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2124 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2125 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2126 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2127 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2130 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2131 5ef14e63 2019-06-02 stsp which may be viewed with
2132 5ef14e63 2019-06-02 stsp .Cm got diff ,
2133 5ef14e63 2019-06-02 stsp amended manually or with further
2134 778a73c2 2019-07-12 stsp .Cm got backout
2136 5ef14e63 2019-06-02 stsp committed with
2137 52d3950d 2023-01-28 thomas .Cm got commit .
2139 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2140 52d3950d 2023-01-28 thomas .Cm rebase ,
2141 52d3950d 2023-01-28 thomas .Cm histedit ,
2143 52d3950d 2023-01-28 thomas .Cm merge
2144 52d3950d 2023-01-28 thomas operation is taking place,
2145 52d3950d 2023-01-28 thomas .Cm got backout
2146 52d3950d 2023-01-28 thomas creates a record of commits which have been reverse-merged into the work tree.
2147 52d3950d 2023-01-28 thomas When a file changed by
2148 52d3950d 2023-01-28 thomas .Cm got backout
2149 52d3950d 2023-01-28 thomas is committed with
2150 52d3950d 2023-01-28 thomas .Cm got commit ,
2151 52d3950d 2023-01-28 thomas the log messages of relevant reverse-merged commits will then appear in
2152 75a8c854 2023-02-17 thomas the editor, where the messages should be further adjusted to convey the
2153 95e6f77e 2023-01-28 thomas reasons for backing out the changes.
2154 83389425 2023-02-17 thomas Upon exiting the editor, if the time stamp of the log message file
2155 83389425 2023-02-17 thomas is unchanged or the log message is empty,
2156 75a8c854 2023-02-17 thomas .Cm got commit
2157 83389425 2023-02-17 thomas will fail with an unmodified or empty log message error.
2159 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2160 52d3950d 2023-01-28 thomas e.g. with
2161 52d3950d 2023-01-28 thomas .Cm got revert ,
2162 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2164 92228c38 2019-06-02 stsp .Cm got backout
2165 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2166 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2167 92228c38 2019-06-02 stsp to a single base commit with
2168 92228c38 2019-06-02 stsp .Cm got update .
2169 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2170 92228c38 2019-06-02 stsp conflicts must be resolved first.
2172 f6cd0243 2023-01-28 thomas The options for
2174 f6cd0243 2023-01-28 thomas .Cm backout
2175 f6cd0243 2023-01-28 thomas are as follows:
2176 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2177 f6cd0243 2023-01-28 thomas .It Fl l
2178 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by backout operations,
2179 f6cd0243 2023-01-28 thomas represented by references in the
2180 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2181 f6cd0243 2023-01-28 thomas reference namespace.
2183 f6cd0243 2023-01-28 thomas .Ar commit
2184 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2186 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2187 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2188 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2189 f6cd0243 2023-01-28 thomas work tree in which they were created.
2190 f6cd0243 2023-01-28 thomas This option cannot be used with
2192 f6cd0243 2023-01-28 thomas .It Fl X
2193 f6cd0243 2023-01-28 thomas Delete log messages created by previous backout operations, represented by
2194 f6cd0243 2023-01-28 thomas references in the
2195 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2196 f6cd0243 2023-01-28 thomas reference namespace.
2198 f6cd0243 2023-01-28 thomas .Ar commit
2199 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2201 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2202 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2203 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2204 f6cd0243 2023-01-28 thomas work tree in which they were created.
2205 f6cd0243 2023-01-28 thomas This option cannot be used with
2211 56c96eff 2022-08-30 thomas .Cm rebase
2212 56c96eff 2022-08-30 thomas .Op Fl aclX
2213 56c96eff 2022-08-30 thomas .Op Ar branch
2215 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rb
2216 818c7501 2019-07-11 stsp Rebase commits on the specified
2217 818c7501 2019-07-11 stsp .Ar branch
2218 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2220 818c7501 2019-07-11 stsp .Ar branch
2221 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2222 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2223 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2224 818c7501 2019-07-11 stsp .Ar branch
2225 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2226 f09e2405 2019-07-11 stsp of the specified
2227 818c7501 2019-07-11 stsp .Ar branch
2228 f09e2405 2019-07-11 stsp has been rebased.
2231 2b6826ba 2020-02-24 stsp .Cm got rebase
2232 2b6826ba 2020-02-24 stsp is used as intended, the specified
2233 2b6826ba 2020-02-24 stsp .Ar branch
2234 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2235 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2236 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2237 2b6826ba 2020-02-24 stsp .Cm got update -b
2238 2b6826ba 2020-02-24 stsp before starting the
2239 2b6826ba 2020-02-24 stsp .Cm rebase
2240 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2241 2b6826ba 2020-02-24 stsp a common history with the specified
2242 2b6826ba 2020-02-24 stsp .Ar branch
2243 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2244 c10890ce 2020-02-25 stsp remote repository.
2246 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2247 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2248 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2249 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2250 818c7501 2019-07-11 stsp .Ar branch ,
2251 818c7501 2019-07-11 stsp but with different commit IDs.
2252 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2253 f09e2405 2019-07-11 stsp the new version of the specified
2254 818c7501 2019-07-11 stsp .Ar branch
2255 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2256 d4dddcbf 2022-07-22 thomas If author information is available via the
2257 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2258 d4dddcbf 2022-07-22 thomas environment variable,
2259 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2260 d4dddcbf 2022-07-22 thomas or Git's
2261 d4dddcbf 2022-07-22 thomas .Dv user.name
2263 d4dddcbf 2022-07-22 thomas .Dv user.email
2264 d4dddcbf 2022-07-22 thomas configuration settings, this author information will be used to identify
2266 d4dddcbf 2022-07-22 thomas .Dq committer
2267 d4dddcbf 2022-07-22 thomas of rebased commits.
2269 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2270 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2271 e600f124 2021-03-21 stsp reference namespace.
2272 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2273 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2274 e600f124 2021-03-21 stsp .Cm got rebase -l
2276 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2277 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2278 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2280 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2281 818c7501 2019-07-11 stsp using the following status codes:
2282 818c7501 2019-07-11 stsp .Bl -column YXZ description
2283 818c7501 2019-07-11 stsp .It G Ta file was merged
2284 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2285 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2286 818c7501 2019-07-11 stsp .It D Ta file was deleted
2287 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2288 818c7501 2019-07-11 stsp .It A Ta new file was added
2289 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2290 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2293 4b06140e 2022-03-22 thomas If merge conflicts occur, the rebase operation is interrupted and may
2294 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2295 bb494413 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2296 bb494413 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2297 bb494413 2021-09-28 thomas the rebase operation will be interrupted to prevent potentially incomplete
2298 bb494413 2021-09-28 thomas changes from being committed to the repository without user intervention.
2299 bb494413 2021-09-28 thomas The work tree may be modified as desired and the rebase operation can be
2300 bb494413 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2301 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2302 818c7501 2019-07-11 stsp .Ar branch
2303 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2305 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2306 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2307 f09e2405 2019-07-11 stsp when the rebase operation continues.
2309 818c7501 2019-07-11 stsp .Cm got rebase
2310 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2312 8dbcf388 2022-09-04 thomas .Ar branch
2313 8dbcf388 2022-09-04 thomas is not in the
2314 8dbcf388 2022-09-04 thomas .Dq refs/heads/
2315 8dbcf388 2022-09-04 thomas reference namespace, the branch may not be rebased.
2316 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2317 4b06140e 2022-03-22 thomas branch, then the work tree must first be updated with
2318 818c7501 2019-07-11 stsp .Cm got update .
2319 4ed9f614 2019-08-04 stsp If changes have been staged with
2320 4ed9f614 2019-08-04 stsp .Cm got stage ,
2321 bc3056e3 2019-08-18 stsp these changes must first be committed with
2322 4ed9f614 2019-08-04 stsp .Cm got commit
2323 4ed9f614 2019-08-04 stsp or unstaged with
2324 4ed9f614 2019-08-04 stsp .Cm got unstage .
2325 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2326 f09e2405 2019-07-11 stsp committed with
2327 f09e2405 2019-07-11 stsp .Cm got commit
2328 f09e2405 2019-07-11 stsp or reverted with
2329 f09e2405 2019-07-11 stsp .Cm got revert .
2331 64c6d990 2019-07-11 stsp .Ar branch
2332 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2333 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2336 8bcebf69 2023-01-08 thomas .Cm got update ,
2337 8bcebf69 2023-01-08 thomas .Cm got integrate ,
2338 8bcebf69 2023-01-08 thomas .Cm got merge ,
2339 8bcebf69 2023-01-08 thomas .Cm got commit ,
2341 8bcebf69 2023-01-08 thomas .Cm got histedit
2342 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2343 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2344 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2346 d10218e7 2021-11-04 thomas If the specified
2347 d10218e7 2021-11-04 thomas .Ar branch
2348 4b06140e 2022-03-22 thomas is already based on the work tree's current branch, then no commits
2349 d10218e7 2021-11-04 thomas need to be rebased and
2350 d10218e7 2021-11-04 thomas .Cm got rebase
2351 d10218e7 2021-11-04 thomas will simply switch the work tree to the specified
2352 d10218e7 2021-11-04 thomas .Ar branch
2353 d10218e7 2021-11-04 thomas and update files in the work tree accordingly.
2355 818c7501 2019-07-11 stsp The options for
2356 818c7501 2019-07-11 stsp .Cm got rebase
2357 818c7501 2019-07-11 stsp are as follows:
2358 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2360 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2361 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2363 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2364 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2366 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2367 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2368 e600f124 2021-03-21 stsp reference namespace.
2370 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2371 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2372 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2373 e600f124 2021-03-21 stsp Given these object IDs,
2375 e600f124 2021-03-21 stsp .Cm got log
2376 e600f124 2021-03-21 stsp command with the
2380 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2382 e600f124 2021-03-21 stsp .Cm got branch
2383 e600f124 2021-03-21 stsp command with the
2385 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2388 e600f124 2021-03-21 stsp .Ar branch
2389 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2391 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2393 e600f124 2021-03-21 stsp If this option is used,
2394 e600f124 2021-03-21 stsp .Cm got rebase
2395 e600f124 2021-03-21 stsp does not require a work tree.
2396 e600f124 2021-03-21 stsp None of the other options can be used together with
2399 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
2401 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
2402 643b85bc 2021-07-16 stsp reference namespace.
2405 643b85bc 2021-07-16 stsp .Ar branch
2406 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2407 643b85bc 2021-07-16 stsp this branch.
2408 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2409 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
2411 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2412 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2413 643b85bc 2021-07-16 stsp Git's garbage collector or
2414 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2416 643b85bc 2021-07-16 stsp If this option is used,
2417 643b85bc 2021-07-16 stsp .Cm got rebase
2418 643b85bc 2021-07-16 stsp does not require a work tree.
2419 643b85bc 2021-07-16 stsp None of the other options can be used together with
2424 56c96eff 2022-08-30 thomas .Cm histedit
2425 070c80a5 2023-01-31 thomas .Op Fl acdeflmX
2426 56c96eff 2022-08-30 thomas .Op Fl F Ar histedit-script
2427 56c96eff 2022-08-30 thomas .Op Ar branch
2429 d912d125 2021-11-04 thomas .Dl Pq alias: Cm he
2430 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
2431 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
2434 d4dddcbf 2022-07-22 thomas .Cm got histedit
2435 d4dddcbf 2022-07-22 thomas command requires the
2436 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2437 d4dddcbf 2022-07-22 thomas environment variable to be set,
2438 d4dddcbf 2022-07-22 thomas unless an author has been configured in
2439 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2440 d4dddcbf 2022-07-22 thomas or Git's
2441 d4dddcbf 2022-07-22 thomas .Dv user.name
2443 d4dddcbf 2022-07-22 thomas .Dv user.email
2444 d4dddcbf 2022-07-22 thomas configuration settings can be obtained from the repository's
2445 d4dddcbf 2022-07-22 thomas .Pa .git/config
2446 d4dddcbf 2022-07-22 thomas file or from Git's global
2447 d4dddcbf 2022-07-22 thomas .Pa ~/.gitconfig
2448 d4dddcbf 2022-07-22 thomas configuration file.
2450 6e54d307 2020-02-24 stsp Before starting a
2451 6e54d307 2020-02-24 stsp .Cm histedit
2452 4b06140e 2022-03-22 thomas operation, the work tree's current branch must be set with
2453 6e54d307 2020-02-24 stsp .Cm got update -b
2454 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
2455 6e54d307 2020-02-24 stsp current branch of the work tree.
2456 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
2457 6e54d307 2020-02-24 stsp touched by the
2458 6e54d307 2020-02-24 stsp .Cm histedit
2459 6e54d307 2020-02-24 stsp operation.
2461 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
2462 6e54d307 2020-02-24 stsp must be set with
2463 6e54d307 2020-02-24 stsp .Cm got update -c
2464 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
2465 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
2467 6e54d307 2020-02-24 stsp .Cm histedit
2468 6e54d307 2020-02-24 stsp operation.
2470 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
2471 0ebf8283 2019-07-24 stsp .Ar histedit script
2472 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
2473 46fa4c83 2020-02-24 stsp command line, or generated with the
2479 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
2480 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
2481 0ebf8283 2019-07-24 stsp whitespace and an argument.
2482 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
2483 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
2484 0ebf8283 2019-07-24 stsp Lines which begin with the
2486 0ebf8283 2019-07-24 stsp character are ignored entirely.
2488 f3a5718a 2022-07-12 thomas The available histedit script commands are as follows:
2489 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
2490 f3a5718a 2022-07-12 thomas .It Cm pick Ar commit Ta Use the specified commit as it is.
2491 f3a5718a 2022-07-12 thomas .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2492 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
2493 f3a5718a 2022-07-12 thomas .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2494 0ebf8283 2019-07-24 stsp listed further below that will be used.
2495 f3a5718a 2022-07-12 thomas .It Cm drop Ar commit Ta Remove this commit from the edited history.
2496 f3a5718a 2022-07-12 thomas .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2497 f3a5718a 2022-07-12 thomas a preceding
2498 f3a5718a 2022-07-12 thomas .Cm pick
2500 f3a5718a 2022-07-12 thomas .Cm edit
2501 f3a5718a 2022-07-12 thomas command on the previous line of the histedit script.
2502 eefbc049 2022-07-12 thomas The optional
2503 eefbc049 2022-07-12 thomas .Ar log-message
2504 eefbc049 2022-07-12 thomas argument provides a new single-line log message to use.
2506 eefbc049 2022-07-12 thomas .Ar log-message
2507 eefbc049 2022-07-12 thomas argument is omitted, open an editor where a new log message can be written.
2510 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
2511 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
2512 5b87815e 2020-03-05 stsp No commit may be listed more than once.
2514 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
2515 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
2516 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
2517 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
2518 498a90b7 2019-07-25 stsp switched to it.
2520 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
2521 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2522 e600f124 2021-03-21 stsp reference namespace.
2523 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
2524 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2525 e600f124 2021-03-21 stsp .Cm got histedit -l
2527 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2528 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2529 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2531 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
2532 0ebf8283 2019-07-24 stsp using the following status codes:
2533 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
2534 0ebf8283 2019-07-24 stsp .It G Ta file was merged
2535 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
2536 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
2537 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
2538 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2539 0ebf8283 2019-07-24 stsp .It A Ta new file was added
2540 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2541 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2544 4b06140e 2022-03-22 thomas If merge conflicts occur, the histedit operation is interrupted and may
2545 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
2546 dddbe150 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2547 dddbe150 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2548 dddbe150 2021-09-28 thomas the histedit operation will be interrupted to prevent potentially incomplete
2549 dddbe150 2021-09-28 thomas changes from being committed to the repository without user intervention.
2550 dddbe150 2021-09-28 thomas The work tree may be modified as desired and the histedit operation can be
2551 dddbe150 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2552 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
2553 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
2555 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
2556 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
2557 0ebf8283 2019-07-24 stsp when the histedit operation continues.
2559 0ebf8283 2019-07-24 stsp .Cm got histedit
2560 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
2561 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
2562 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
2563 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
2564 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2565 0ebf8283 2019-07-24 stsp to a single base commit with
2566 0ebf8283 2019-07-24 stsp .Cm got update .
2567 4ed9f614 2019-08-04 stsp If changes have been staged with
2568 4ed9f614 2019-08-04 stsp .Cm got stage ,
2569 bc3056e3 2019-08-18 stsp these changes must first be committed with
2570 4ed9f614 2019-08-04 stsp .Cm got commit
2571 4ed9f614 2019-08-04 stsp or unstaged with
2572 4ed9f614 2019-08-04 stsp .Cm got unstage .
2573 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
2574 0ebf8283 2019-07-24 stsp committed with
2575 0ebf8283 2019-07-24 stsp .Cm got commit
2576 0ebf8283 2019-07-24 stsp or reverted with
2577 0ebf8283 2019-07-24 stsp .Cm got revert .
2578 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
2579 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
2582 7ef62c4e 2020-02-24 stsp .Cm got update ,
2583 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
2584 8bcebf69 2023-01-08 thomas .Cm got merge ,
2586 65db4ffb 2020-02-24 stsp .Cm got integrate
2587 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
2588 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
2589 0ebf8283 2019-07-24 stsp .Cm got commit
2590 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
2591 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
2593 0ebf8283 2019-07-24 stsp The options for
2594 0ebf8283 2019-07-24 stsp .Cm got histedit
2595 0ebf8283 2019-07-24 stsp are as follows:
2596 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
2598 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
2599 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2601 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
2602 070c80a5 2023-01-31 thomas If this option is used, no other command-line arguments are allowed.
2603 070c80a5 2023-01-31 thomas .It Fl d
2604 070c80a5 2023-01-31 thomas Drop all commits.
2605 070c80a5 2023-01-31 thomas This option is a quick equivalent to a histedit script which drops all
2606 070c80a5 2023-01-31 thomas commits.
2609 070c80a5 2023-01-31 thomas option can only be used when starting a new histedit operation.
2610 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2611 c50a7455 2021-10-04 thomas .It Fl e
2612 c50a7455 2021-10-04 thomas Interrupt the histedit operation for editing after merging each commit.
2613 c50a7455 2021-10-04 thomas This option is a quick equivalent to a histedit script which uses the
2614 c50a7455 2021-10-04 thomas .Cm edit
2615 c50a7455 2021-10-04 thomas command for all commits.
2618 c50a7455 2021-10-04 thomas option can only be used when starting a new histedit operation.
2619 c50a7455 2021-10-04 thomas If this option is used, no other command-line arguments are allowed.
2620 d6506a3d 2022-08-16 thomas .It Fl F Ar histedit-script
2621 d6506a3d 2022-08-16 thomas Use the specified
2622 d6506a3d 2022-08-16 thomas .Ar histedit-script
2623 d6506a3d 2022-08-16 thomas instead of opening a temporary file in an editor where a histedit script
2624 d6506a3d 2022-08-16 thomas can be written.
2626 466785b9 2020-12-10 jrick Fold all commits into a single commit.
2627 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
2628 466785b9 2020-12-10 jrick commits, combining them all into one commit.
2631 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
2632 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
2634 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
2635 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2636 e600f124 2021-03-21 stsp reference namespace.
2638 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2639 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
2640 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2641 e600f124 2021-03-21 stsp Given these object IDs,
2643 e600f124 2021-03-21 stsp .Cm got log
2644 e600f124 2021-03-21 stsp command with the
2648 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2650 e600f124 2021-03-21 stsp .Cm got branch
2651 e600f124 2021-03-21 stsp command with the
2653 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
2656 e600f124 2021-03-21 stsp .Ar branch
2657 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2659 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2661 e600f124 2021-03-21 stsp If this option is used,
2662 e600f124 2021-03-21 stsp .Cm got histedit
2663 e600f124 2021-03-21 stsp does not require a work tree.
2664 e600f124 2021-03-21 stsp None of the other options can be used together with
2666 d6506a3d 2022-08-16 thomas .It Fl m
2667 d6506a3d 2022-08-16 thomas Edit log messages only.
2668 d6506a3d 2022-08-16 thomas This option is a quick equivalent to a histedit script which edits
2669 d6506a3d 2022-08-16 thomas only log messages but otherwise leaves every picked commit as-is.
2672 d6506a3d 2022-08-16 thomas option can only be used when starting a new histedit operation.
2673 d6506a3d 2022-08-16 thomas If this option is used, no other command-line arguments are allowed.
2675 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
2677 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
2678 643b85bc 2021-07-16 stsp reference namespace.
2681 643b85bc 2021-07-16 stsp .Ar branch
2682 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2683 643b85bc 2021-07-16 stsp this branch.
2684 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2685 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
2687 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2688 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2689 643b85bc 2021-07-16 stsp Git's garbage collector or
2690 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2692 643b85bc 2021-07-16 stsp If this option is used,
2693 643b85bc 2021-07-16 stsp .Cm got histedit
2694 643b85bc 2021-07-16 stsp does not require a work tree.
2695 643b85bc 2021-07-16 stsp None of the other options can be used together with
2699 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
2700 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ig
2701 2822a352 2019-10-15 stsp Integrate the specified
2702 2822a352 2019-10-15 stsp .Ar branch
2703 2822a352 2019-10-15 stsp into the work tree's current branch.
2704 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
2705 2822a352 2019-10-15 stsp .Ar branch ,
2706 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
2707 2822a352 2019-10-15 stsp head commit of the integrated
2708 2822a352 2019-10-15 stsp .Ar branch .
2710 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
2711 2822a352 2019-10-15 stsp will be pointing at the same commit.
2712 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
2713 2822a352 2019-10-15 stsp In case the integrated
2714 2822a352 2019-10-15 stsp .Ar branch
2715 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
2716 2822a352 2019-10-15 stsp .Cm got branch -d .
2718 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
2719 2822a352 2019-10-15 stsp .Bl -column YXZ description
2720 2822a352 2019-10-15 stsp .It U Ta file was updated
2721 2822a352 2019-10-15 stsp .It D Ta file was deleted
2722 2822a352 2019-10-15 stsp .It A Ta new file was added
2723 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
2724 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
2727 2822a352 2019-10-15 stsp .Cm got integrate
2728 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
2729 2822a352 2019-10-15 stsp Most importantly, the
2730 2822a352 2019-10-15 stsp .Ar branch
2731 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
2732 2822a352 2019-10-15 stsp .Cm got rebase
2733 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
2734 2822a352 2019-10-15 stsp resolve merge conflicts.
2735 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2736 2822a352 2019-10-15 stsp to a single base commit with
2737 2822a352 2019-10-15 stsp .Cm got update .
2738 2822a352 2019-10-15 stsp If changes have been staged with
2739 2822a352 2019-10-15 stsp .Cm got stage ,
2740 2822a352 2019-10-15 stsp these changes must first be committed with
2741 2822a352 2019-10-15 stsp .Cm got commit
2742 2822a352 2019-10-15 stsp or unstaged with
2743 2822a352 2019-10-15 stsp .Cm got unstage .
2744 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
2745 2822a352 2019-10-15 stsp committed with
2746 2822a352 2019-10-15 stsp .Cm got commit
2747 2822a352 2019-10-15 stsp or reverted with
2748 2822a352 2019-10-15 stsp .Cm got revert .
2751 56c96eff 2022-08-30 thomas .Cm merge
2752 56c96eff 2022-08-30 thomas .Op Fl acn
2753 56c96eff 2022-08-30 thomas .Op Ar branch
2755 d912d125 2021-11-04 thomas .Dl Pq alias: Cm mg
2756 10604dce 2021-09-24 thomas Create a merge commit based on the current branch of the work tree and
2757 10604dce 2021-09-24 thomas the specified
2758 10604dce 2021-09-24 thomas .Ar branch .
2759 10604dce 2021-09-24 thomas If a linear project history is desired, then use of
2760 10604dce 2021-09-24 thomas .Cm got rebase
2761 10604dce 2021-09-24 thomas should be preferred over
2762 10604dce 2021-09-24 thomas .Cm got merge .
2763 10604dce 2021-09-24 thomas However, even strictly linear projects may require merge commits in order
2764 768705e3 2021-09-27 thomas to merge in new versions of third-party code stored on vendor branches
2765 768705e3 2021-09-27 thomas created with
2766 768705e3 2021-09-27 thomas .Cm got import .
2768 10604dce 2021-09-24 thomas Merge commits are commits based on multiple parent commits.
2769 10604dce 2021-09-24 thomas The tip commit of the work tree's current branch, which must be set with
2770 10604dce 2021-09-24 thomas .Cm got update -b
2771 10604dce 2021-09-24 thomas before starting the
2772 10604dce 2021-09-24 thomas .Cm merge
2773 10604dce 2021-09-24 thomas operation, will be used as the first parent.
2774 10604dce 2021-09-24 thomas The tip commit of the specified
2775 10604dce 2021-09-24 thomas .Ar branch
2776 10604dce 2021-09-24 thomas will be used as the second parent.
2778 768705e3 2021-09-27 thomas No ancestral relationship between the two branches is required.
2779 768705e3 2021-09-27 thomas If the two branches have already been merged previously, only new changes
2780 768705e3 2021-09-27 thomas will be merged.
2782 10604dce 2021-09-24 thomas It is not possible to create merge commits with more than two parents.
2783 10604dce 2021-09-24 thomas If more than one branch needs to be merged, then multiple merge commits
2784 10604dce 2021-09-24 thomas with two parents each can be created in sequence.
2786 10604dce 2021-09-24 thomas While merging changes found on the
2787 10604dce 2021-09-24 thomas .Ar branch
2788 10604dce 2021-09-24 thomas into the work tree, show the status of each affected file,
2789 10604dce 2021-09-24 thomas using the following status codes:
2790 10604dce 2021-09-24 thomas .Bl -column YXZ description
2791 10604dce 2021-09-24 thomas .It G Ta file was merged
2792 10604dce 2021-09-24 thomas .It C Ta file was merged and conflicts occurred during merge
2793 10604dce 2021-09-24 thomas .It ! Ta changes destined for a missing file were not merged
2794 10604dce 2021-09-24 thomas .It D Ta file was deleted
2795 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2796 10604dce 2021-09-24 thomas .It A Ta new file was added
2797 10604dce 2021-09-24 thomas .It \(a~ Ta changes destined for a non-regular file were not merged
2798 10604dce 2021-09-24 thomas .It ? Ta changes destined for an unversioned file were not merged
2801 10604dce 2021-09-24 thomas If merge conflicts occur, the merge operation is interrupted and conflicts
2802 10604dce 2021-09-24 thomas must be resolved before the merge operation can continue.
2803 8cf2970b 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2804 8cf2970b 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2805 10604dce 2021-09-24 thomas the merge operation will be interrupted to prevent potentially incomplete
2806 10604dce 2021-09-24 thomas changes from being committed to the repository without user intervention.
2807 10604dce 2021-09-24 thomas The work tree may be modified as desired and the merge can be continued
2808 10604dce 2021-09-24 thomas once the changes present in the work tree are considered complete.
2809 10604dce 2021-09-24 thomas Alternatively, the merge operation may be aborted which will leave
2810 10604dce 2021-09-24 thomas the work tree's current branch unmodified.
2812 10604dce 2021-09-24 thomas If a merge conflict is resolved in a way which renders all merged
2813 10604dce 2021-09-24 thomas changes into no-op changes, the merge operation cannot continue
2814 10604dce 2021-09-24 thomas and must be aborted.
2816 10604dce 2021-09-24 thomas .Cm got merge
2817 10604dce 2021-09-24 thomas will refuse to run if certain preconditions are not met.
2818 10604dce 2021-09-24 thomas If history of the
2819 10604dce 2021-09-24 thomas .Ar branch
2820 10604dce 2021-09-24 thomas is based on the work tree's current branch, then no merge commit can
2821 10604dce 2021-09-24 thomas be created and
2822 10604dce 2021-09-24 thomas .Cm got integrate
2823 10604dce 2021-09-24 thomas may be used to integrate the
2824 10604dce 2021-09-24 thomas .Ar branch
2825 10604dce 2021-09-24 thomas instead.
2826 10604dce 2021-09-24 thomas If the work tree is not yet fully updated to the tip commit of its
2827 10604dce 2021-09-24 thomas branch, then the work tree must first be updated with
2828 10604dce 2021-09-24 thomas .Cm got update .
2829 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2830 10604dce 2021-09-24 thomas to a single base commit with
2831 10604dce 2021-09-24 thomas .Cm got update .
2832 10604dce 2021-09-24 thomas If changes have been staged with
2833 10604dce 2021-09-24 thomas .Cm got stage ,
2834 10604dce 2021-09-24 thomas these changes must first be committed with
2835 10604dce 2021-09-24 thomas .Cm got commit
2836 10604dce 2021-09-24 thomas or unstaged with
2837 10604dce 2021-09-24 thomas .Cm got unstage .
2838 10604dce 2021-09-24 thomas If the work tree contains local changes, these changes must first be
2839 10604dce 2021-09-24 thomas committed with
2840 10604dce 2021-09-24 thomas .Cm got commit
2841 10604dce 2021-09-24 thomas or reverted with
2842 10604dce 2021-09-24 thomas .Cm got revert .
2844 10604dce 2021-09-24 thomas .Ar branch
2845 10604dce 2021-09-24 thomas contains changes to files outside of the work tree's path prefix,
2846 10604dce 2021-09-24 thomas the work tree cannot be used to merge this branch.
2849 10604dce 2021-09-24 thomas .Cm got update ,
2850 10604dce 2021-09-24 thomas .Cm got commit ,
2851 10604dce 2021-09-24 thomas .Cm got rebase ,
2852 ac93b2c5 2021-10-08 thomas .Cm got histedit ,
2853 10604dce 2021-09-24 thomas .Cm got integrate ,
2855 10604dce 2021-09-24 thomas .Cm got stage
2856 10604dce 2021-09-24 thomas commands will refuse to run while a merge operation is in progress.
2857 10604dce 2021-09-24 thomas Other commands which manipulate the work tree may be used for
2858 10604dce 2021-09-24 thomas conflict resolution purposes.
2860 10604dce 2021-09-24 thomas The options for
2861 10604dce 2021-09-24 thomas .Cm got merge
2862 10604dce 2021-09-24 thomas are as follows:
2863 10604dce 2021-09-24 thomas .Bl -tag -width Ds
2864 10604dce 2021-09-24 thomas .It Fl a
2865 10604dce 2021-09-24 thomas Abort an interrupted merge operation.
2866 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
2867 10604dce 2021-09-24 thomas .It Fl c
2868 10604dce 2021-09-24 thomas Continue an interrupted merge operation.
2869 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
2870 ba34626b 2021-09-27 thomas .It Fl n
2871 ba34626b 2021-09-27 thomas Merge changes into the work tree as usual but do not create a merge
2872 ba34626b 2021-09-27 thomas commit immediately.
2873 ba34626b 2021-09-27 thomas The merge result can be adjusted as desired before a merge commit is
2874 ba34626b 2021-09-27 thomas created with
2875 ba34626b 2021-09-27 thomas .Cm got merge -c .
2876 ba34626b 2021-09-27 thomas Alternatively, the merge may be aborted with
2877 ba34626b 2021-09-27 thomas .Cm got merge -a .
2881 56c96eff 2022-08-30 thomas .Cm stage
2882 56c96eff 2022-08-30 thomas .Op Fl lpS
2883 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
2884 56c96eff 2022-08-30 thomas .Op Ar path ...
2886 d912d125 2021-11-04 thomas .Dl Pq alias: Cm sg
2887 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
2890 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
2891 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
2892 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
2893 4ed9f614 2019-08-04 stsp .Cm got status .
2895 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2896 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
2897 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
2898 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
2899 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
2902 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
2903 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
2904 9d8b19a4 2019-08-04 stsp committed.
2906 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
2907 4ed9f614 2019-08-04 stsp .Cm got commit ,
2908 4ed9f614 2019-08-04 stsp .Cm got status ,
2910 4ed9f614 2019-08-04 stsp .Cm got diff .
2911 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
2912 4ed9f614 2019-08-04 stsp .Cm got commit
2913 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
2914 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
2915 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
2917 4ed9f614 2019-08-04 stsp .Cm got status
2918 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
2920 4ed9f614 2019-08-04 stsp .Cm got diff
2921 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
2922 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
2924 4ed9f614 2019-08-04 stsp .Cm got revert
2925 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
2926 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
2928 4ed9f614 2019-08-04 stsp The options for
2929 4ed9f614 2019-08-04 stsp .Cm got stage
2930 4ed9f614 2019-08-04 stsp are as follows:
2931 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
2932 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
2933 d6506a3d 2022-08-16 thomas With the
2935 d6506a3d 2022-08-16 thomas option, read
2940 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
2941 d6506a3d 2022-08-16 thomas .Ar response-script
2942 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
2944 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
2945 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
2946 4b06140e 2022-03-22 thomas If paths were provided on the command line, show the staged paths
2947 1dd86744 2019-08-12 anthony among the specified paths.
2948 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
2950 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
2951 dc424a06 2019-08-07 stsp select or reject changes for staging based on
2953 6d23ec10 2019-08-08 stsp (stage change),
2955 6d23ec10 2019-08-08 stsp (reject change), and
2957 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
2958 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
2959 dc424a06 2019-08-07 stsp modified file content can be staged.
2960 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
2961 6d23ec10 2019-08-08 stsp their entirety.
2963 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
2964 af358f55 2020-07-23 stsp that is under version control.
2965 af358f55 2020-07-23 stsp By default,
2966 af358f55 2020-07-23 stsp .Cm got stage
2967 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2968 35213c7c 2020-07-23 stsp As a precaution,
2970 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2971 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2972 af358f55 2020-07-23 stsp points outside of the work tree.
2973 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2974 af358f55 2020-07-23 stsp .Dq make obj
2975 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2976 af358f55 2020-07-23 stsp version control.
2979 4ed9f614 2019-08-04 stsp .Cm got stage
2980 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
2981 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
2982 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
2983 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
2984 4ed9f614 2019-08-04 stsp .Cm got update
2985 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
2986 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
2989 4ed9f614 2019-08-04 stsp .Cm got update ,
2990 4ed9f614 2019-08-04 stsp .Cm got rebase ,
2992 4ed9f614 2019-08-04 stsp .Cm got histedit
2993 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
2994 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
2995 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
2996 4ed9f614 2019-08-04 stsp .Cm got unstage
2997 4ed9f614 2019-08-04 stsp before it can be updated with
2998 4ed9f614 2019-08-04 stsp .Cm got update ,
2999 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
3002 56c96eff 2022-08-30 thomas .Cm unstage
3003 56c96eff 2022-08-30 thomas .Op Fl p
3004 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
3005 56c96eff 2022-08-30 thomas .Op Ar path ...
3007 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ug
3008 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
3009 4ed9f614 2019-08-04 stsp back into non-staged status.
3012 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
3013 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
3015 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3016 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
3017 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
3018 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
3019 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
3020 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
3021 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
3022 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3025 2e1f37b0 2019-08-08 stsp The options for
3026 2e1f37b0 2019-08-08 stsp .Cm got unstage
3027 2e1f37b0 2019-08-08 stsp are as follows:
3028 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
3029 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
3032 2e1f37b0 2019-08-08 stsp option, read
3037 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
3038 2e1f37b0 2019-08-08 stsp .Ar response-script
3039 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
3040 d6506a3d 2022-08-16 thomas .It Fl p
3041 d6506a3d 2022-08-16 thomas Instead of unstaging the entire content of a changed file, interactively
3042 d6506a3d 2022-08-16 thomas select or reject changes for unstaging based on
3044 d6506a3d 2022-08-16 thomas (unstage change),
3046 d6506a3d 2022-08-16 thomas (keep change staged), and
3048 d6506a3d 2022-08-16 thomas (quit unstaging this file) responses.
3049 d6506a3d 2022-08-16 thomas If a file is staged in modified status, individual patches derived from the
3050 d6506a3d 2022-08-16 thomas staged file content can be unstaged.
3051 d6506a3d 2022-08-16 thomas Files staged in added or deleted status may only be unstaged in their entirety.
3055 56c96eff 2022-08-30 thomas .Op Fl P
3056 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
3057 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
3058 56c96eff 2022-08-30 thomas .Ar arg ...
3060 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3061 896e9b6f 2019-08-26 stsp text format.
3062 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3063 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3064 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3066 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3067 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3068 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3069 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3070 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3071 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3073 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3075 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3076 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3078 01073a5d 2019-08-22 stsp The options for
3079 01073a5d 2019-08-22 stsp .Cm got cat
3080 01073a5d 2019-08-22 stsp are as follows:
3081 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3082 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3083 896e9b6f 2019-08-26 stsp Look up paths in the specified
3084 896e9b6f 2019-08-26 stsp .Ar commit .
3085 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3086 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3087 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
3088 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
3089 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3090 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3091 d6506a3d 2022-08-16 thomas .It Fl P
3092 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
3093 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
3094 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
3095 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3096 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3097 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3098 01073a5d 2019-08-22 stsp working directory.
3099 01073a5d 2019-08-22 stsp If this directory is a
3101 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3103 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3104 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3106 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3107 b2118c49 2020-07-28 stsp for details.
3109 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3110 b2118c49 2020-07-28 stsp current working directory.
3112 b2118c49 2020-07-28 stsp If one or more
3114 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3115 b2118c49 2020-07-28 stsp files located at or within these paths.
3118 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3119 b2118c49 2020-07-28 stsp for all tracked files.
3121 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3122 5daf5c53 2022-07-23 thomas .Bl -tag -width GOT_IGNORE_GITCONFIG
3123 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3124 d4dddcbf 2022-07-22 thomas The author's name and email address, such as
3125 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3126 d4dddcbf 2022-07-22 thomas Used by the
3127 d4dddcbf 2022-07-22 thomas .Cm got commit ,
3128 d4dddcbf 2022-07-22 thomas .Cm got import ,
3129 d4dddcbf 2022-07-22 thomas .Cm got rebase ,
3131 d4dddcbf 2022-07-22 thomas .Cm got histedit
3132 d4dddcbf 2022-07-22 thomas commands.
3135 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3137 84792843 2019-08-09 stsp attempts to reject
3138 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3139 84792843 2019-08-09 stsp environment variables with a missing email address.
3141 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3142 50b0790e 2020-09-11 stsp .Xr got.conf 5
3143 50b0790e 2020-09-11 stsp or by Git's
3144 aba9c984 2019-09-08 stsp .Dv user.name
3146 709ae9eb 2019-09-08 stsp .Dv user.email
3147 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3148 aba9c984 2019-09-08 stsp .Pa .git/config
3151 c9956ddf 2019-09-08 stsp .Dv user.name
3153 c9956ddf 2019-09-08 stsp .Dv user.email
3154 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3155 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3156 257add31 2020-09-09 stsp configuration file will only be used if neither
3157 257add31 2020-09-09 stsp .Xr got.conf 5
3159 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3160 257add31 2020-09-09 stsp environment variable provide author information.
3161 bd15e874 2023-01-20 thomas .It Ev GOT_IGNORE_GITCONFIG
3162 bd15e874 2023-01-20 thomas If this variable is set then any remote repository definitions or author
3163 bd15e874 2023-01-20 thomas information found in Git configuration files will be ignored.
3164 bd15e874 2023-01-20 thomas .It Ev GOT_LOG_DEFAULT_LIMIT
3165 bd15e874 2023-01-20 thomas The default limit on the number of commits traversed by
3166 bd15e874 2023-01-20 thomas .Cm got log .
3167 bd15e874 2023-01-20 thomas If set to zero, the limit is unbounded.
3168 bd15e874 2023-01-20 thomas This variable will be silently ignored if it is set to a non-numeric value.
3169 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3170 23594da9 2019-05-13 stsp The editor spawned by
3171 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3172 46215d2a 2020-09-11 stsp .Cm got histedit ,
3173 8e7bd50a 2019-08-22 stsp .Cm got import ,
3175 8e7bd50a 2019-08-22 stsp .Cm got tag .
3176 5b735925 2020-09-15 stsp If not set, the
3178 5b735925 2020-09-15 stsp text editor will be spawned in order to give
3180 5b735925 2020-09-15 stsp the attention it deserves.
3183 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3184 257add31 2020-09-09 stsp .It Pa got.conf
3185 257add31 2020-09-09 stsp Repository-wide configuration settings for
3187 50b0790e 2020-09-11 stsp If present, a
3188 50b0790e 2020-09-11 stsp .Xr got.conf 5
3189 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3190 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3191 257add31 2020-09-09 stsp .Pa config
3194 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3195 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3197 50b0790e 2020-09-11 stsp If present, a
3198 1795b260 2021-04-02 kn .Xr got.conf 5
3199 50b0790e 2020-09-11 stsp configuration file in the
3201 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3202 50b0790e 2020-09-11 stsp the repository's
3203 50b0790e 2020-09-11 stsp .Xr got.conf 5
3204 50b0790e 2020-09-11 stsp configuration file and Git's
3205 50b0790e 2020-09-11 stsp .Pa config
3208 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3209 5c860e29 2018-03-12 stsp .Ex -std got
3210 97925469 2018-03-17 stsp .Sh EXAMPLES
3211 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3213 43e4eb1b 2021-08-29 stsp command names in
3214 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3216 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3218 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3221 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3222 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3224 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
3225 fa6e0e48 2019-05-23 stsp .Xr git 1 :
3227 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3228 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
3230 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3232 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3233 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3234 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3236 27b10c3c 2022-07-04 thomas .Dl $ gotadmin init /var/git/src.git
3237 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3239 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3241 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3243 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3245 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3247 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3249 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3251 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3253 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3255 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3257 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3259 7fc94106 2023-01-14 thomas As above, but list the most recently modified branches only:
3261 7fc94106 2023-01-14 thomas .Dl $ got branch -lt | head
3263 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3264 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3265 d83d9d5c 2019-05-13 stsp which is forked off the
3266 d83d9d5c 2019-05-13 stsp .Dq master
3269 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3271 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3272 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3273 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3275 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3277 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3278 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3280 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3282 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3283 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3284 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3286 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3288 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3289 04e9dcf3 2020-04-18 stsp .Xr patch 1
3290 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3292 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3294 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3296 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3298 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3299 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3300 5b666081 2020-02-24 stsp .Pa sys/uvm :
3302 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3304 5b666081 2020-02-24 stsp And this command has the same effect:
3306 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3308 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3310 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3311 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3313 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3315 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3316 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3318 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
3319 e70c17ce 2019-05-22 stsp with a pre-defined log message.
3321 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
3323 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
3324 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
3325 1795b260 2021-04-02 kn .Pa /tmp/msg :
3327 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
3329 95fc3404 2019-07-15 stsp Update any work tree checked out from the
3330 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
3331 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
3333 95fc3404 2019-07-15 stsp .Dl $ got update
3335 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
3336 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
3337 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
3339 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3340 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
3341 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
3342 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3344 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
3345 a099809f 2021-08-27 stsp .Dq master
3346 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
3347 469dd726 2020-03-20 stsp .Dq origin/master
3350 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3351 469dd726 2020-03-20 stsp .Dl $ got fetch
3353 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
3354 469dd726 2020-03-20 stsp .Cm git clone --bare
3356 469dd726 2020-03-20 stsp .Xr git-fetch 1
3357 469dd726 2020-03-20 stsp command must be used instead:
3359 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
3360 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
3362 469dd726 2020-03-20 stsp Rebase the local
3363 469dd726 2020-03-20 stsp .Dq master
3364 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
3365 469dd726 2020-03-20 stsp .Dq origin/master
3368 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3369 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
3370 469dd726 2020-03-20 stsp .Dl $ got rebase master
3372 fa6e0e48 2019-05-23 stsp Rebase the
3373 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
3374 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
3375 fa6e0e48 2019-05-23 stsp .Dq master
3378 818c7501 2019-07-11 stsp .Dl $ got update -b master
3379 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
3381 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
3382 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
3383 1dd86744 2019-08-12 anthony .Ox Ns 's
3384 1dd86744 2019-08-12 anthony CVS tree:
3386 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3388 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
3389 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
3392 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
3393 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
3394 0ebf8283 2019-07-24 stsp .Dl $ got histedit
3396 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
3397 469dd726 2020-03-20 stsp .Cm git clone --bare
3398 7848a0e1 2020-03-19 stsp instead of
3399 7848a0e1 2020-03-19 stsp .Cm got clone ,
3401 ff2cf171 2019-07-28 stsp .Dq refspec
3402 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
3404 ff2cf171 2019-07-28 stsp .Dq refs/remotes
3405 ff2cf171 2019-07-28 stsp namespace of the local repository.
3406 1795b260 2021-04-02 kn This can be achieved by setting Git's
3407 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
3408 ff2cf171 2019-07-28 stsp configuration variable to the value
3409 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
3411 ff2cf171 2019-07-28 stsp .Cm git config
3414 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
3415 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3417 469dd726 2020-03-20 stsp Additionally, the
3418 469dd726 2020-03-20 stsp .Dq mirror
3419 469dd726 2020-03-20 stsp option must be disabled:
3421 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
3422 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
3424 ff2cf171 2019-07-28 stsp Alternatively, the following
3425 469dd726 2020-03-20 stsp .Xr git-fetch 1
3426 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
3427 ff2cf171 2019-07-28 stsp .Pa config
3430 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
3431 ff2cf171 2019-07-28 stsp .Dl url = ...
3432 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3433 469dd726 2020-03-20 stsp .Dl mirror = false
3435 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
3436 ff2cf171 2019-07-28 stsp .Dq refs/heads
3437 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
3438 ff2cf171 2019-07-28 stsp .Cm got checkout
3439 ff2cf171 2019-07-28 stsp and, if needed, created with
3440 ff2cf171 2019-07-28 stsp .Cm got branch .
3441 ff2cf171 2019-07-28 stsp Branches in the
3442 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
3443 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
3444 ff2cf171 2019-07-28 stsp repository with
3445 469dd726 2020-03-20 stsp .Cm got fetch
3447 469dd726 2020-03-20 stsp .Xr git-fetch 1
3448 a099809f 2021-08-27 stsp without extra command line arguments.
3449 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
3450 a099809f 2021-08-27 stsp .Cm got log .
3452 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
3453 ff2cf171 2019-07-28 stsp .Dq master
3454 a099809f 2021-08-27 stsp branch, as of the last time
3455 a099809f 2021-08-27 stsp .Cm got fetch
3458 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
3460 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
3461 ff2cf171 2019-07-28 stsp .Dq origin/master
3462 a099809f 2021-08-27 stsp instead of
3463 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
3464 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
3466 a099809f 2021-08-27 stsp .Cm got rebase
3467 a099809f 2021-08-27 stsp must be used to merge changes which are visible on the
3468 a099809f 2021-08-27 stsp .Dq origin/master
3469 a099809f 2021-08-27 stsp branch into the
3470 a099809f 2021-08-27 stsp .Dq master
3472 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
3474 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
3475 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
3477 a099809f 2021-08-27 stsp In order to make changes committed to the
3478 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3479 a099809f 2021-08-27 stsp visible on the
3480 a099809f 2021-08-27 stsp .Dq master
3481 a099809f 2021-08-27 stsp branch, the
3482 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3483 a099809f 2021-08-27 stsp branch must first be rebased onto the
3484 a099809f 2021-08-27 stsp .Dq master
3487 a099809f 2021-08-27 stsp .Dl $ got update -b master
3488 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
3490 a099809f 2021-08-27 stsp Changes on the
3491 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3492 a099809f 2021-08-27 stsp branch can now be made visible on the
3493 a099809f 2021-08-27 stsp .Dq master
3494 a099809f 2021-08-27 stsp branch with
3495 a099809f 2021-08-27 stsp .Cm got integrate .
3496 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
3497 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3498 4b06140e 2022-03-22 thomas branch, the work tree must be switched back to the
3499 a099809f 2021-08-27 stsp .Dq master
3500 a099809f 2021-08-27 stsp branch first:
3502 a099809f 2021-08-27 stsp .Dl $ got update -b master
3503 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
3506 083957f4 2020-02-24 stsp .Dq master
3507 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
3509 083957f4 2020-02-24 stsp by other developers and any other important new information:
3511 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
3512 083957f4 2020-02-24 stsp .Dl $ got histedit -m
3514 4b06140e 2022-03-22 thomas If the remote repository offers write access, local changes on the
3515 ff2cf171 2019-07-28 stsp .Dq master
3516 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
3517 ac93b2c5 2021-10-08 thomas .Cm got send .
3518 ac93b2c5 2021-10-08 thomas Usually,
3519 a099809f 2021-08-27 stsp .Cm got send
3520 a099809f 2021-08-27 stsp can be run without further arguments.
3521 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
3522 a099809f 2021-08-27 stsp current branch is the
3523 a099809f 2021-08-27 stsp .Dq master
3526 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
3528 4b06140e 2022-03-22 thomas If the remote repository requires the HTTPS protocol, the
3529 a099809f 2021-08-27 stsp .Xr git-push 1
3530 a099809f 2021-08-27 stsp command must be used instead:
3532 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
3533 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
3535 4ff74dcf 2022-07-20 thomas When making contributions to projects which use the
3536 4ff74dcf 2022-07-20 thomas .Dq pull request
3537 4ff74dcf 2022-07-20 thomas workflow, SSH protocol repository access needs to be set up first.
3538 4ff74dcf 2022-07-20 thomas Once an account has been created on a Git hosting site it should
3539 4ff74dcf 2022-07-20 thomas be possible to upload a public SSH key for repository access
3540 4ff74dcf 2022-07-20 thomas authentication.
3543 4ff74dcf 2022-07-20 thomas .Dq pull request
3544 4ff74dcf 2022-07-20 thomas workflow will usually involve two remote repositories.
3545 4ff74dcf 2022-07-20 thomas In the real-life example below, the
3546 4ff74dcf 2022-07-20 thomas .Dq origin
3547 4ff74dcf 2022-07-20 thomas repository was forked from the
3548 4ff74dcf 2022-07-20 thomas .Dq upstream
3549 4ff74dcf 2022-07-20 thomas repository by using the Git hosting site's web interface.
3551 4ff74dcf 2022-07-20 thomas .Xr got.conf 5
3552 4ff74dcf 2022-07-20 thomas file in the local repository describes both remote repositories:
3553 4ff74dcf 2022-07-20 thomas .Bd -literal -offset indent
3554 4ff74dcf 2022-07-20 thomas # Jelmers's repository, which accepts pull requests
3555 4ff74dcf 2022-07-20 thomas remote "upstream" {
3556 4ff74dcf 2022-07-20 thomas server git@github.com
3557 4ff74dcf 2022-07-20 thomas protocol ssh
3558 4ff74dcf 2022-07-20 thomas repository "/jelmer/dulwich"
3559 4ff74dcf 2022-07-20 thomas branch { "master" }
3562 4ff74dcf 2022-07-20 thomas # Stefan's fork, used as the default remote repository
3563 4ff74dcf 2022-07-20 thomas remote "origin" {
3564 4ff74dcf 2022-07-20 thomas server git@github.com
3565 4ff74dcf 2022-07-20 thomas protocol ssh
3566 4ff74dcf 2022-07-20 thomas repository "/stspdotname/dulwich"
3567 4ff74dcf 2022-07-20 thomas branch { "master" }
3571 4ff74dcf 2022-07-20 thomas With this configuration, Stefan can create commits on
3572 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master
3573 4ff74dcf 2022-07-20 thomas and send them to the
3574 4ff74dcf 2022-07-20 thomas .Dq origin
3575 4ff74dcf 2022-07-20 thomas repository by running:
3577 4ff74dcf 2022-07-20 thomas .Dl $ got send -b master origin
3579 4ff74dcf 2022-07-20 thomas The changes can now be proposed to Jelmer by opening a pull request
3580 4ff74dcf 2022-07-20 thomas via the Git hosting site's web interface.
3581 4ff74dcf 2022-07-20 thomas If Jelmer requests further changes to be made, additional commits
3582 4ff74dcf 2022-07-20 thomas can be created on the
3583 4ff74dcf 2022-07-20 thomas .Dq master
3584 4ff74dcf 2022-07-20 thomas branch and be added to the pull request by running
3585 4ff74dcf 2022-07-20 thomas .Cd got send
3588 4ff74dcf 2022-07-20 thomas If Jelmer prefers additional commits to be
3589 4ff74dcf 2022-07-20 thomas .Dq squashed
3590 4ff74dcf 2022-07-20 thomas then the following commands can be used to achieve this:
3592 4ff74dcf 2022-07-20 thomas .Dl $ got update -b master
3593 4ff74dcf 2022-07-20 thomas .Dl $ got update -c origin/master
3594 4ff74dcf 2022-07-20 thomas .Dl $ got histedit -f
3595 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
3597 4ff74dcf 2022-07-20 thomas Once Jelmer has accepted the pull request, Stefan can fetch the
3598 4ff74dcf 2022-07-20 thomas merged changes, and possibly several other new changes, by running:
3600 4ff74dcf 2022-07-20 thomas .Dl $ got fetch upstream
3602 4ff74dcf 2022-07-20 thomas The merged changes will now be visible under the reference
3603 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master .
3604 4ff74dcf 2022-07-20 thomas The local
3605 4ff74dcf 2022-07-20 thomas .Dq master
3606 4ff74dcf 2022-07-20 thomas branch can now be rebased on top of the latest changes
3607 4ff74dcf 2022-07-20 thomas from upstream:
3609 4ff74dcf 2022-07-20 thomas .Dl $ got update -b upstream/master
3610 4ff74dcf 2022-07-20 thomas .Dl $ got rebase master
3612 4ff74dcf 2022-07-20 thomas As a final step, the forked repository's copy of the master branch needs
3613 4ff74dcf 2022-07-20 thomas to be kept in sync by sending the new changes there:
3615 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
3617 4ff74dcf 2022-07-20 thomas If multiple pull requests need to be managed in parallel, a separate branch
3618 4ff74dcf 2022-07-20 thomas must be created for each pull request with
3619 4ff74dcf 2022-07-20 thomas .Cm got branch .
3620 4ff74dcf 2022-07-20 thomas Each such branch can then be used as above, in place of
3621 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master .
3622 4ff74dcf 2022-07-20 thomas Changes for any accepted pull requests will still appear under
3623 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master,
3624 4ff74dcf 2022-07-20 thomas regardless of which branch was used in the forked repository to
3625 4ff74dcf 2022-07-20 thomas create a pull request.
3626 5c860e29 2018-03-12 stsp .Sh SEE ALSO
3627 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
3628 2312fc47 2019-07-15 stsp .Xr tog 1 ,
3629 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
3630 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
3631 b345cf8f 2022-07-05 thomas .Xr got.conf 5 ,
3632 85c360aa 2023-01-02 thomas .Xr gotwebd 8
3633 1a208aaf 2018-04-01 stsp .Sh AUTHORS
3634 60c73080 2022-07-05 thomas .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3635 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
3636 60c73080 2022-07-05 thomas .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3637 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
3638 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
3639 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
3640 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
3641 f6fad9f6 2022-07-05 thomas .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3642 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
3643 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
3644 60c73080 2022-07-05 thomas .An Sebastien Marie Aq Mt semarie@openbsd.org
3645 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
3646 bee5044f 2022-07-05 thomas .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3647 60c73080 2022-07-05 thomas .An Theo Buehler Aq Mt tb@openbsd.org
3648 60c73080 2022-07-05 thomas .An Thomas Adam Aq Mt thomas@xteddy.org
3649 60c73080 2022-07-05 thomas .An Tracey Emery Aq Mt tracey@traceyemery.net
3650 60c73080 2022-07-05 thomas .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3652 de71b616 2022-07-05 thomas Parts of
3654 de71b616 2022-07-05 thomas .Xr tog 1 ,
3656 85c360aa 2023-01-02 thomas .Xr gotwebd 8
3657 de71b616 2022-07-05 thomas were derived from code under copyright by:
3659 408db73d 2022-07-22 thomas .An Caldera International
3660 de71b616 2022-07-05 thomas .An Daniel Hartmeier
3661 de71b616 2022-07-05 thomas .An Esben Norby
3662 de71b616 2022-07-05 thomas .An Henning Brauer
3663 de71b616 2022-07-05 thomas .An Håkan Olsson
3664 de71b616 2022-07-05 thomas .An Ingo Schwarze
3665 de71b616 2022-07-05 thomas .An Jean-Francois Brousseau
3666 de71b616 2022-07-05 thomas .An Joris Vink
3667 de71b616 2022-07-05 thomas .An Jyri J. Virkki
3668 de71b616 2022-07-05 thomas .An Larry Wall
3669 408db73d 2022-07-22 thomas .An Markus Friedl
3670 de71b616 2022-07-05 thomas .An Niall O'Higgins
3671 de71b616 2022-07-05 thomas .An Niklas Hallqvist
3672 de71b616 2022-07-05 thomas .An Ray Lai
3673 de71b616 2022-07-05 thomas .An Ryan McBride
3674 de71b616 2022-07-05 thomas .An Theo de Raadt
3675 de71b616 2022-07-05 thomas .An Todd C. Miller
3676 de71b616 2022-07-05 thomas .An Xavier Santolaria
3679 e4badaa9 2022-07-05 thomas contains code contributed to the public domain by
3680 86f8a176 2022-12-30 thomas .An Austin Appleby .
3681 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
3683 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
3685 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
3687 cc63216e 2020-12-26 stsp to perform some tasks.
3688 cc63216e 2020-12-26 stsp In particular:
3689 cc63216e 2020-12-26 stsp .Bl -bullet
3691 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
3692 cc63216e 2020-12-26 stsp .Xr git-clone 1
3694 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
3696 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
3697 cc63216e 2020-12-26 stsp .Xr git-push 1 .
3699 22a38a43 2021-09-28 thomas The creation of merge commits with more than two parent commits requires
3700 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
3702 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
3704 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
3706 cc63216e 2020-12-26 stsp will usually produce better results.
