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 3ce1b845 2019-07-15 stsp .It Fl m Ar message
121 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
122 3ce1b845 2019-07-15 stsp Without the
125 3ce1b845 2019-07-15 stsp .Cm got import
126 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
127 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
128 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
129 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
130 3ce1b845 2019-07-15 stsp working directory.
134 56c96eff 2022-08-30 thomas .Cm clone
135 56c96eff 2022-08-30 thomas .Op Fl almqv
136 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
137 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
138 56c96eff 2022-08-30 thomas .Ar repository-URL
139 56c96eff 2022-08-30 thomas .Op Ar directory
141 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cl
142 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
143 2ab43947 2020-03-18 stsp .Ar repository-URL
144 2ab43947 2020-03-18 stsp into the specified
145 3493b628 2020-03-20 stsp .Ar directory .
147 3493b628 2020-03-20 stsp .Ar directory
148 4b06140e 2022-03-22 thomas is specified, the directory name will be derived from the name of the
149 2ab43947 2020-03-18 stsp cloned repository.
150 2ab43947 2020-03-18 stsp .Cm got clone
151 2ab43947 2020-03-18 stsp will refuse to run if the
152 3493b628 2020-03-20 stsp .Ar directory
153 2ab43947 2020-03-18 stsp already exists.
156 2ab43947 2020-03-18 stsp .Ar repository-URL
157 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
158 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
159 619eb6dd 2020-03-20 stsp the server:
160 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
162 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
163 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
165 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
166 2ab43947 2020-03-18 stsp .Xr git-daemon 1
168 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
169 10c073e7 2020-03-20 stsp nor encryption.
170 2ab43947 2020-03-18 stsp .It git+ssh
171 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
174 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
177 2ab43947 2020-03-18 stsp .Mt user@hostname
179 2ab43947 2020-03-18 stsp Short alias for git+ssh.
182 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
183 89c3c67b 2020-03-20 stsp from the server.
184 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
186 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
187 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
188 89c3c67b 2020-03-20 stsp This can take some time.
189 010f7279 2020-03-20 stsp More details about the pack file format are documented in
190 010f7279 2020-03-20 stsp .Xr git-repository 5 .
192 7848a0e1 2020-03-19 stsp .Cm got clone
193 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
194 257add31 2020-09-09 stsp .Xr got.conf 5
197 257add31 2020-09-09 stsp files of the cloned repository to store the
198 7848a0e1 2020-03-19 stsp .Ar repository-url
202 99495ddb 2021-01-10 stsp .Ar reference
203 132af4a5 2021-01-05 stsp arguments for future use by
204 7848a0e1 2020-03-19 stsp .Cm got fetch
206 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
208 2ab43947 2020-03-18 stsp The options for
209 2ab43947 2020-03-18 stsp .Cm got clone
210 2ab43947 2020-03-18 stsp are as follows:
211 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
213 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
214 1d4b192f 2020-03-21 stsp .Dq refs/heads/
215 5aa20203 2021-01-05 stsp reference namespace and set
216 25eb5847 2022-07-03 thomas .Cm fetch_all_branches
217 5aa20203 2021-01-05 stsp in the cloned repository's
218 5aa20203 2021-01-05 stsp .Xr got.conf 5
219 5aa20203 2021-01-05 stsp file for future use by
220 5aa20203 2021-01-05 stsp .Cm got fetch .
221 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
222 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
223 4ba14133 2020-03-20 stsp Cannot be used together with the
226 4ba14133 2020-03-20 stsp .It Fl b Ar branch
227 4ba14133 2020-03-20 stsp Fetch the specified
229 1d4b192f 2020-03-21 stsp from the remote repository's
230 1d4b192f 2020-03-21 stsp .Dq refs/heads/
231 1d4b192f 2020-03-21 stsp reference namespace.
232 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
234 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
235 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
236 4ba14133 2020-03-20 stsp branch which was fetched.
237 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
238 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
239 4ba14133 2020-03-20 stsp Cannot be used together with the
243 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
244 41b0de12 2020-03-21 stsp and exit immediately.
245 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
250 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
251 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
252 bd81cfb7 2020-04-19 stsp locally created commits.
254 469dd726 2020-03-20 stsp The repository's
255 257add31 2020-09-09 stsp .Xr got.conf 5
258 257add31 2020-09-09 stsp files will be set up with the
260 469dd726 2020-03-20 stsp option enabled, such that
261 469dd726 2020-03-20 stsp .Cm got fetch
263 469dd726 2020-03-20 stsp .Xr git-fetch 1
264 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
265 469dd726 2020-03-20 stsp .Dq refs/heads/
266 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
267 469dd726 2020-03-20 stsp .Dq refs/remotes/
269 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
270 469dd726 2020-03-20 stsp .Cm got rebase
272 469dd726 2020-03-20 stsp .Cm got fetch
273 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
274 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
276 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
277 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
278 498ef124 2020-03-21 stsp changes are fetched.
280 2ab43947 2020-03-18 stsp Suppress progress reporting output.
281 2ab43947 2020-03-18 stsp The same option will be passed to
283 2ab43947 2020-03-18 stsp if applicable.
284 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
285 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
286 0e4002ca 2020-03-21 stsp .Ar reference
287 0e4002ca 2020-03-21 stsp from the remote repository's
290 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
291 0e4002ca 2020-03-21 stsp references to fetch.
292 71f12362 2020-03-21 stsp The specified
293 71f12362 2020-03-21 stsp .Ar reference
294 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
295 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
297 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
298 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
299 0e4002ca 2020-03-21 stsp namespace, unless the
301 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
305 0e4002ca 2020-03-21 stsp .Cm got clone
306 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
307 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
309 0e4002ca 2020-03-21 stsp .Dq refs/got/
312 d6506a3d 2022-08-16 thomas Verbose mode.
314 d6506a3d 2022-08-16 thomas .Cm got clone
315 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
316 d6506a3d 2022-08-16 thomas This option will be passed to
317 d6506a3d 2022-08-16 thomas .Xr ssh 1
318 d6506a3d 2022-08-16 thomas if applicable.
319 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
320 d6506a3d 2022-08-16 thomas The maximum is 3.
324 56c96eff 2022-08-30 thomas .Cm fetch
325 56c96eff 2022-08-30 thomas .Op Fl adlqtvX
326 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
327 56c96eff 2022-08-30 thomas .Op Fl R Ar reference
328 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
329 56c96eff 2022-08-30 thomas .Op Ar remote-repository
331 d912d125 2021-11-04 thomas .Dl Pq alias: Cm fe
332 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
334 4ba14133 2020-03-20 stsp .Ar remote-repository
335 4ba14133 2020-03-20 stsp is specified,
337 7848a0e1 2020-03-19 stsp will be used.
338 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
339 257add31 2020-09-09 stsp .Xr got.conf 5
342 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
343 7848a0e1 2020-03-19 stsp .Cm got clone .
345 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
346 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
347 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
349 498ef124 2020-03-21 stsp By default, branch references in the
350 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
351 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
353 498ef124 2020-03-21 stsp .Cm got rebase
354 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
355 7848a0e1 2020-03-19 stsp .Dq refs/heads/
356 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
357 bd81cfb7 2020-04-19 stsp as necessary.
359 498ef124 2020-03-21 stsp If the repository was created as a mirror with
360 4b06140e 2022-03-22 thomas .Cm got clone -m ,
361 498ef124 2020-03-21 stsp then all branches in the
362 469dd726 2020-03-20 stsp .Dq refs/heads/
363 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
364 498ef124 2020-03-21 stsp the remote repository.
365 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
366 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
367 e6786710 2021-07-03 stsp by Git's garbage collector or
368 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
369 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
371 db6d8ad8 2020-03-21 stsp In any case, references in the
372 7848a0e1 2020-03-19 stsp .Dq refs/tags/
373 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
374 db6d8ad8 2020-03-21 stsp in the same namespace.
376 7848a0e1 2020-03-19 stsp The options for
377 7848a0e1 2020-03-19 stsp .Cm got fetch
378 7848a0e1 2020-03-19 stsp are as follows:
379 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
381 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
382 1d4b192f 2020-03-21 stsp .Dq refs/heads/
383 1d4b192f 2020-03-21 stsp reference namespace.
384 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
385 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
386 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
387 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
388 4ba14133 2020-03-20 stsp Cannot be used together with the
391 4ba14133 2020-03-20 stsp .It Fl b Ar branch
392 4ba14133 2020-03-20 stsp Fetch the specified
394 1d4b192f 2020-03-21 stsp from the remote repository's
395 1d4b192f 2020-03-21 stsp .Dq refs/heads/
396 1d4b192f 2020-03-21 stsp reference namespace.
397 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
399 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
400 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
401 4ba14133 2020-03-20 stsp Cannot be used together with the
405 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
406 f21ec2f0 2020-03-21 stsp present in the remote repository.
407 f21ec2f0 2020-03-21 stsp Only references are deleted.
408 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
409 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
410 e6786710 2021-07-03 stsp Git's garbage collector or
411 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
413 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
414 41b0de12 2020-03-21 stsp and exit immediately.
415 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
421 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
422 7848a0e1 2020-03-19 stsp The same option will be passed to
424 7848a0e1 2020-03-19 stsp if applicable.
425 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
426 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
427 0e4002ca 2020-03-21 stsp .Ar reference
428 0e4002ca 2020-03-21 stsp from the remote repository's
431 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
432 0e4002ca 2020-03-21 stsp references to fetch.
433 71f12362 2020-03-21 stsp The specified
434 71f12362 2020-03-21 stsp .Ar reference
435 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
436 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
438 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
439 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
440 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
441 a18cccf9 2020-03-21 stsp .Cm got clone -m
442 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
446 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
447 0e4002ca 2020-03-21 stsp .Cm got branch
450 0e4002ca 2020-03-21 stsp .Cm got fetch
451 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
452 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
454 0e4002ca 2020-03-21 stsp .Dq refs/got/
456 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
457 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
458 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
459 d6506a3d 2022-08-16 thomas working directory.
460 d6506a3d 2022-08-16 thomas If this directory is a
462 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
464 d6506a3d 2022-08-16 thomas Allow existing references in the
465 d6506a3d 2022-08-16 thomas .Dq refs/tags
466 d6506a3d 2022-08-16 thomas namespace to be updated if they have changed on the server.
467 d6506a3d 2022-08-16 thomas If not specified, only new tag references will be created.
469 d6506a3d 2022-08-16 thomas Verbose mode.
471 d6506a3d 2022-08-16 thomas .Cm got fetch
472 d6506a3d 2022-08-16 thomas to print debugging messages to standard error output.
473 d6506a3d 2022-08-16 thomas The same option will be passed to
474 d6506a3d 2022-08-16 thomas .Xr ssh 1
475 d6506a3d 2022-08-16 thomas if applicable.
476 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
477 d6506a3d 2022-08-16 thomas The maximum is 3.
479 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
480 161728eb 2021-07-24 stsp .Ar remote-repository
481 161728eb 2021-07-24 stsp instead of fetching new changes.
482 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
483 161728eb 2021-07-24 stsp .Xr got.conf 5 .
488 161728eb 2021-07-24 stsp .Ar remote-repository
489 161728eb 2021-07-24 stsp argument is mandatory and no other options except
494 161728eb 2021-07-24 stsp are allowed.
496 161728eb 2021-07-24 stsp Only references are deleted.
497 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
498 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
499 161728eb 2021-07-24 stsp .Xr git-repack 1
500 161728eb 2021-07-24 stsp and Git's garbage collector.
504 56c96eff 2022-08-30 thomas .Cm checkout
505 56c96eff 2022-08-30 thomas .Op Fl Eq
506 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
507 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
508 56c96eff 2022-08-30 thomas .Op Fl p Ar path-prefix
509 56c96eff 2022-08-30 thomas .Ar repository-path
510 56c96eff 2022-08-30 thomas .Op Ar work-tree-path
512 d912d125 2021-11-04 thomas .Dl Pq alias: Cm co
513 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
514 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
515 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
516 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
517 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
521 5d7c1dab 2018-04-01 stsp .Ar work tree path
522 c844a238 2019-02-06 stsp is not specified, either use the last component of
523 5d7c1dab 2018-04-01 stsp .Ar repository path ,
525 5d7c1dab 2018-04-01 stsp .Ar path prefix
526 c844a238 2019-02-06 stsp was specified use the last component of
527 5d7c1dab 2018-04-01 stsp .Ar path prefix .
529 38e11793 2018-06-13 stsp The options for
530 38e11793 2018-06-13 stsp .Cm got checkout
531 38e11793 2018-06-13 stsp are as follows:
532 38e11793 2018-06-13 stsp .Bl -tag -width Ds
533 08573d5b 2019-05-14 stsp .It Fl b Ar branch
534 3c575567 2019-07-28 stsp Check out files from a commit on the specified
535 08573d5b 2019-05-14 stsp .Ar branch .
536 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
537 08573d5b 2019-05-14 stsp reference will be used.
538 8069f636 2019-01-12 stsp .It Fl c Ar commit
539 8069f636 2019-01-12 stsp Check out files from the specified
541 3c575567 2019-07-28 stsp on the selected branch.
542 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
543 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
544 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
545 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
546 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
547 08573d5b 2019-05-14 stsp branch will be used.
549 4b6c9460 2020-03-05 stsp If the specified
551 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
552 4b6c9460 2020-03-05 stsp this commit must be specified with the
555 4b06140e 2022-03-22 thomas If no such branch is known, a new branch must be created for this
556 4b6c9460 2020-03-05 stsp commit with
557 4b6c9460 2020-03-05 stsp .Cm got branch
559 4b6c9460 2020-03-05 stsp .Cm got checkout
560 4b6c9460 2020-03-05 stsp can be used.
561 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
563 d6506a3d 2022-08-16 thomas Proceed with the checkout operation even if the directory at
564 d6506a3d 2022-08-16 thomas .Ar work-tree-path
565 d6506a3d 2022-08-16 thomas is not empty.
566 d6506a3d 2022-08-16 thomas Existing files will be left intact.
567 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
568 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
569 38e11793 2018-06-13 stsp Only files beneath the specified
570 38e11793 2018-06-13 stsp .Ar path-prefix
571 38e11793 2018-06-13 stsp will be checked out.
573 4ad4a1ec 2021-09-13 tracey Silence progress output.
577 56c96eff 2022-08-30 thomas .Cm update
579 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
580 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
581 56c96eff 2022-08-30 thomas .Op Ar path ...
583 d912d125 2021-11-04 thomas .Dl Pq alias: Cm up
584 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
585 4f331d3a 2020-04-01 stsp .Ar commit .
586 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
587 4f331d3a 2020-04-01 stsp of this commit.
588 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
589 4f331d3a 2020-04-01 stsp incoming changes.
591 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
592 5036ab18 2020-04-18 stsp further complications.
593 5036ab18 2020-04-18 stsp Such files will be updated when
594 5036ab18 2020-04-18 stsp .Cm got update
595 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
596 4b06140e 2022-03-22 thomas If the conflicting changes are no longer needed, affected files can be
597 5036ab18 2020-04-18 stsp reverted with
598 5036ab18 2020-04-18 stsp .Cm got revert
599 5036ab18 2020-04-18 stsp before running
600 5036ab18 2020-04-18 stsp .Cm got update
603 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
604 7f838b36 2019-02-08 stsp .Bl -column YXZ description
605 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
606 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
607 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
608 7f838b36 2019-02-08 stsp .It D Ta file was deleted
609 7f838b36 2019-02-08 stsp .It A Ta new file was added
610 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
611 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
612 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
613 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
618 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
619 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
620 f2ea84fa 2019-07-27 stsp specified paths.
621 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
622 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
623 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
626 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
627 c4cdcb68 2019-04-03 stsp multiple base commits.
628 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
629 47ec7be7 2019-05-12 stsp .Cm got update
630 47ec7be7 2019-05-12 stsp across the entire work tree.
631 024e9686 2019-05-14 stsp Specifying a
633 024e9686 2019-05-14 stsp is incompatible with the
637 4ed9f614 2019-08-04 stsp .Cm got update
638 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
639 4ed9f614 2019-08-04 stsp If changes have been staged with
640 4ed9f614 2019-08-04 stsp .Cm got stage ,
641 bc3056e3 2019-08-18 stsp these changes must first be committed with
642 4ed9f614 2019-08-04 stsp .Cm got commit
643 4ed9f614 2019-08-04 stsp or unstaged with
644 4ed9f614 2019-08-04 stsp .Cm got unstage .
646 507dc3bb 2018-12-29 stsp The options for
647 507dc3bb 2018-12-29 stsp .Cm got update
648 507dc3bb 2018-12-29 stsp are as follows:
649 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
650 024e9686 2019-05-14 stsp .It Fl b Ar branch
651 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
653 024e9686 2019-05-14 stsp before updating the work tree.
654 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
656 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
657 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
658 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
660 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
661 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
662 4f331d3a 2020-04-01 stsp .Ar branch .
663 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
664 4f331d3a 2020-04-01 stsp .Cm got commit ,
665 4f331d3a 2020-04-01 stsp or could be discarded with
666 4f331d3a 2020-04-01 stsp .Cm got revert .
667 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
668 507dc3bb 2018-12-29 stsp Update the work tree to the specified
669 507dc3bb 2018-12-29 stsp .Ar commit .
670 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
671 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
672 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
673 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
674 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
675 024e9686 2019-05-14 stsp branch will be used.
677 4ad4a1ec 2021-09-13 tracey Silence progress output.
681 56c96eff 2022-08-30 thomas .Cm status
683 56c96eff 2022-08-30 thomas .Op Fl S Ar status-codes
684 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
685 56c96eff 2022-08-30 thomas .Op Ar path ...
687 d912d125 2021-11-04 thomas .Dl Pq alias: Cm st
688 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
689 6bad629b 2019-02-04 stsp using the following status codes:
690 6bad629b 2019-02-04 stsp .Bl -column YXZ description
691 6bad629b 2019-02-04 stsp .It M Ta modified file
692 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
693 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
694 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
695 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
696 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
697 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
699 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
700 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
702 2a06fe5f 2019-08-24 stsp specified on the command line
707 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
708 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
710 4ed9f614 2019-08-04 stsp If changes have been staged with
711 4ed9f614 2019-08-04 stsp .Cm got stage ,
712 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
713 4ed9f614 2019-08-04 stsp status codes:
714 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
715 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
716 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
717 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
720 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
721 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
722 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
723 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
726 081470ac 2020-08-13 stsp The options for
727 081470ac 2020-08-13 stsp .Cm got status
728 081470ac 2020-08-13 stsp are as follows:
729 081470ac 2020-08-13 stsp .Bl -tag -width Ds
731 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
732 d6506a3d 2022-08-16 thomas .It Fl S Ar status-codes
733 d6506a3d 2022-08-16 thomas Suppress the output of files with a modification status matching any of the
734 00357e4d 2021-09-14 tracey single-character status codes contained in the
735 00357e4d 2021-09-14 tracey .Ar status-codes
736 00357e4d 2021-09-14 tracey argument.
737 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
738 00357e4d 2021-09-14 tracey may be specified.
739 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
740 b043307b 2021-09-14 stsp Cannot be used together with the
743 d6506a3d 2022-08-16 thomas .It Fl s Ar status-codes
744 d6506a3d 2022-08-16 thomas Only show files with a modification status matching any of the
745 081470ac 2020-08-13 stsp single-character status codes contained in the
746 081470ac 2020-08-13 stsp .Ar status-codes
748 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
749 081470ac 2020-08-13 stsp may be specified.
750 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
751 b043307b 2021-09-14 stsp Cannot be used together with the
756 6841da00 2019-08-08 stsp For compatibility with
759 bd8de430 2019-10-04 stsp .Xr git 1 ,
760 6841da00 2019-08-08 stsp .Cm got status
763 bd8de430 2019-10-04 stsp patterns from
764 6841da00 2019-08-08 stsp .Pa .cvsignore
766 bd8de430 2019-10-04 stsp .Pa .gitignore
767 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
768 bd8de430 2019-10-04 stsp which match these patterns.
769 bd8de430 2019-10-04 stsp As an extension to
771 bd8de430 2019-10-04 stsp matching rules,
772 bd8de430 2019-10-04 stsp .Cm got status
773 bd8de430 2019-10-04 stsp supports consecutive asterisks,
775 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
777 6841da00 2019-08-08 stsp .Xr cvs 1 ,
778 6841da00 2019-08-08 stsp .Cm got status
779 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
781 bd8de430 2019-10-04 stsp .Xr git 1 ,
782 bd8de430 2019-10-04 stsp .Cm got status
783 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
785 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
787 bd8de430 2019-10-04 stsp in a pattern.
790 f3ad4b0a 2023-01-07 thomas .Op Fl bdPpRs
791 56c96eff 2022-08-30 thomas .Op Fl C Ar number
792 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
793 56c96eff 2022-08-30 thomas .Op Fl l Ar N
794 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
795 56c96eff 2022-08-30 thomas .Op Fl S Ar search-pattern
796 56c96eff 2022-08-30 thomas .Op Fl x Ar commit
797 56c96eff 2022-08-30 thomas .Op Ar path
799 38e11793 2018-06-13 stsp Display history of a repository.
802 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
803 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
805 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
806 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
807 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
809 38e11793 2018-06-13 stsp The options for
810 38e11793 2018-06-13 stsp .Cm got log
811 38e11793 2018-06-13 stsp are as follows:
812 38e11793 2018-06-13 stsp .Bl -tag -width Ds
814 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
815 1137e0ae 2020-01-27 stsp from other branches.
816 48c8c60d 2020-01-27 stsp By default,
817 48c8c60d 2020-01-27 stsp .Cm got log
818 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
819 d6506a3d 2022-08-16 thomas .It Fl C Ar number
820 d6506a3d 2022-08-16 thomas Set the number of context lines shown in diffs with
822 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
823 38e11793 2018-06-13 stsp .It Fl c Ar commit
824 38e11793 2018-06-13 stsp Start traversing history at the specified
825 38e11793 2018-06-13 stsp .Ar commit .
826 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
827 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
828 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
829 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
830 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
831 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
833 be97ab03 2023-01-19 thomas Display diffstat of changes introduced in each commit.
834 772fcad5 2023-01-07 thomas Cannot be used with the
837 6238ee32 2018-06-13 stsp .It Fl l Ar N
838 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
839 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
840 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
842 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
843 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
845 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
846 0208f208 2020-05-05 stsp status codes:
847 0208f208 2020-05-05 stsp .Bl -column YXZ description
848 0208f208 2020-05-05 stsp .It M Ta modified file
849 0208f208 2020-05-05 stsp .It D Ta file was deleted
850 0208f208 2020-05-05 stsp .It A Ta new file was added
851 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
854 2f7ada20 2022-06-13 thomas Cannot be used with the
858 d6506a3d 2022-08-16 thomas Display the patch of modifications made in each commit.
861 d6506a3d 2022-08-16 thomas is specified, only show the patch of modifications at or within this path.
862 d6506a3d 2022-08-16 thomas Cannot be used with the
866 d6506a3d 2022-08-16 thomas Determine a set of commits to display as usual, but display these commits
867 d6506a3d 2022-08-16 thomas in reverse order.
868 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
869 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
870 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
871 d6506a3d 2022-08-16 thomas working directory.
872 d6506a3d 2022-08-16 thomas If this directory is a
874 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
875 2f7ada20 2022-06-13 thomas .It Fl S Ar search-pattern
876 4fe9456b 2022-06-13 thomas If specified, show only commits with a log message, author name,
877 4fe9456b 2022-06-13 thomas committer name, or ID SHA1 hash matched by the extended regular
878 4fe9456b 2022-06-13 thomas expression
879 6841bf13 2019-11-29 kn .Ar search-pattern .
880 314444e4 2022-06-13 thomas Lines in committed patches will be matched if
882 314444e4 2022-06-13 thomas is specified.
883 314444e4 2022-06-13 thomas File paths changed by a commit will be matched if
885 314444e4 2022-06-13 thomas is specified.
886 6841bf13 2019-11-29 kn Regular expression syntax is documented in
887 6841bf13 2019-11-29 kn .Xr re_format 7 .
889 d6506a3d 2022-08-16 thomas Display a short one-line summary of each commit, instead of the default
890 d6506a3d 2022-08-16 thomas history format.
891 d6506a3d 2022-08-16 thomas Cannot be used together with the
896 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
897 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
899 52ab7958 2020-04-18 stsp has been traversed.
900 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
902 d1fe46f9 2020-04-18 stsp is never traversed.
907 53d03f97 2023-01-10 thomas .Op Fl adPsw
908 56c96eff 2022-08-30 thomas .Op Fl C Ar number
909 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
910 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
911 56c96eff 2022-08-30 thomas .Op Ar object1 Ar object2 | Ar path ...
913 d912d125 2021-11-04 thomas .Dl Pq alias: Cm di
914 30f6c0c6 2021-10-08 thomas When invoked within a work tree without any arguments, display all
915 bd81cfb7 2020-04-19 stsp local changes in the work tree.
916 30f6c0c6 2021-10-08 thomas If one or more
918 30f6c0c6 2021-10-08 thomas arguments are specified, only show changes within the specified paths.
920 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
921 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
922 d24820bf 2019-08-11 stsp corresponding objects.
923 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
924 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
925 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
926 30f6c0c6 2021-10-08 thomas If none of these interpretations produce a valid result or if the
928 30f6c0c6 2021-10-08 thomas option is used,
930 30f6c0c6 2021-10-08 thomas .Cm got diff
931 30f6c0c6 2021-10-08 thomas is running in a work tree, attempt to interpret the two arguments as paths.
933 c0cc5c62 2018-10-18 stsp The options for
934 c0cc5c62 2018-10-18 stsp .Cm got diff
935 c0cc5c62 2018-10-18 stsp are as follows:
936 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
938 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
939 d6506a3d 2022-08-16 thomas .It Fl C Ar number
940 d6506a3d 2022-08-16 thomas Set the number of context lines shown in the diff.
941 d6506a3d 2022-08-16 thomas By default, 3 lines of context are shown.
942 cc8021af 2021-10-12 thomas .It Fl c Ar commit
943 cc8021af 2021-10-12 thomas Show differences between commits in the repository.
944 d6506a3d 2022-08-16 thomas This option may be used up to two times.
945 cc8021af 2021-10-12 thomas When used only once, show differences between the specified
946 cc8021af 2021-10-12 thomas .Ar commit
947 cc8021af 2021-10-12 thomas and its first parent commit.
948 cc8021af 2021-10-12 thomas When used twice, show differences between the two specified commits.
950 cc8021af 2021-10-12 thomas The expected argument is a commit ID SHA1 hash or an existing reference
951 cc8021af 2021-10-12 thomas or tag name which will be resolved to a commit ID.
952 cc8021af 2021-10-12 thomas An abbreviated hash argument will be expanded to a full SHA1 hash
953 cc8021af 2021-10-12 thomas automatically, provided the abbreviation is unique.
957 cc8021af 2021-10-12 thomas option is used, all non-option arguments will be interpreted as paths.
958 cc8021af 2021-10-12 thomas If one or more such
960 cc8021af 2021-10-12 thomas arguments are provided, only show differences for the specified paths.
962 cc8021af 2021-10-12 thomas Cannot be used together with the
966 53d03f97 2023-01-10 thomas Display diffstat of changes before the actual diff by annotating each file path
967 53d03f97 2023-01-10 thomas or blob hash being diffed with the total number of lines added and removed.
968 53d03f97 2023-01-10 thomas A summary line will display the total number of changes across all files.
970 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
971 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
972 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
973 d6506a3d 2022-08-16 thomas This option is only valid when
974 d6506a3d 2022-08-16 thomas .Cm got diff
975 d6506a3d 2022-08-16 thomas is invoked in a work tree.
976 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
977 b72f483a 2019-02-05 stsp Use the repository at the specified path.
978 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
979 b72f483a 2019-02-05 stsp working directory.
980 b72f483a 2019-02-05 stsp If this directory is a
982 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
984 4ed9f614 2019-08-04 stsp Show changes staged with
985 4ed9f614 2019-08-04 stsp .Cm got stage
986 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
987 30f6c0c6 2021-10-08 thomas This option is only valid when
988 30f6c0c6 2021-10-08 thomas .Cm got diff
989 30f6c0c6 2021-10-08 thomas is invoked in a work tree.
991 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
995 56c96eff 2022-08-30 thomas .Cm blame
996 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
997 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1000 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bl
1001 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1003 1ff8e573 2018-08-02 stsp The options for
1004 1ff8e573 2018-08-02 stsp .Cm got blame
1005 1ff8e573 2018-08-02 stsp are as follows:
1006 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1007 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1008 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1009 1ff8e573 2018-08-02 stsp .Ar commit .
1010 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1011 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1012 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1013 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1014 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1015 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1016 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1017 1ff8e573 2018-08-02 stsp working directory.
1018 0c06baac 2019-02-05 stsp If this directory is a
1020 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1024 56c96eff 2022-08-30 thomas .Cm tree
1025 56c96eff 2022-08-30 thomas .Op Fl iR
1026 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1027 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1028 56c96eff 2022-08-30 thomas .Op Ar path
1030 d912d125 2021-11-04 thomas .Dl Pq alias: Cm tr
1031 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1032 5de5890b 2018-10-18 stsp directory path in the repository.
1033 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1034 db0c2996 2019-02-10 stsp annotations:
1035 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1036 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1037 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1038 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1039 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1042 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1046 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1047 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1048 0c849583 2019-02-05 stsp if there is no work tree.
1050 5de5890b 2018-10-18 stsp The options for
1051 5de5890b 2018-10-18 stsp .Cm got tree
1052 5de5890b 2018-10-18 stsp are as follows:
1053 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1054 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1055 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1056 5de5890b 2018-10-18 stsp .Ar commit .
1057 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1058 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1059 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1060 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1061 d6506a3d 2022-08-16 thomas .It Fl i
1062 d6506a3d 2022-08-16 thomas Show object IDs of files (blob objects) and directories (tree objects).
1063 d6506a3d 2022-08-16 thomas .It Fl R
1064 d6506a3d 2022-08-16 thomas Recurse into sub-directories in the repository.
1065 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
1066 5de5890b 2018-10-18 stsp Use the repository at the specified path.
1067 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
1068 5de5890b 2018-10-18 stsp working directory.
1069 0c849583 2019-02-05 stsp If this directory is a
1071 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1075 56c96eff 2022-08-30 thomas .Op Fl dlt
1076 b6b86fd1 2022-08-30 thomas .Op Fl c Ar object
1077 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1078 56c96eff 2022-08-30 thomas .Op Fl s Ar reference
1079 56c96eff 2022-08-30 thomas .Op Ar name
1081 d0eebce4 2019-03-11 stsp Manage references in a repository.
1083 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1084 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1086 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1087 f16e4044 2019-10-09 stsp .Dq refs/ .
1089 d0eebce4 2019-03-11 stsp The options for
1090 d0eebce4 2019-03-11 stsp .Cm got ref
1091 d0eebce4 2019-03-11 stsp are as follows:
1092 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1093 d6506a3d 2022-08-16 thomas .It Fl c Ar object
1094 d6506a3d 2022-08-16 thomas Create a reference or change an existing reference.
1095 d6506a3d 2022-08-16 thomas The reference with the specified
1096 d6506a3d 2022-08-16 thomas .Ar name
1097 d6506a3d 2022-08-16 thomas will point at the specified
1098 d6506a3d 2022-08-16 thomas .Ar object .
1099 d6506a3d 2022-08-16 thomas The expected
1100 d6506a3d 2022-08-16 thomas .Ar object
1101 d6506a3d 2022-08-16 thomas argument is a ID SHA1 hash or an existing reference or tag name which will
1102 d6506a3d 2022-08-16 thomas be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1103 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1105 d6506a3d 2022-08-16 thomas .It Fl d
1106 d6506a3d 2022-08-16 thomas Delete the reference with the specified
1107 d6506a3d 2022-08-16 thomas .Ar name
1108 d6506a3d 2022-08-16 thomas from the repository.
1109 d6506a3d 2022-08-16 thomas Any commit, tree, tag, and blob objects belonging to deleted references
1110 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1111 d6506a3d 2022-08-16 thomas Git's garbage collector or
1112 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1113 d6506a3d 2022-08-16 thomas Cannot be used together with any other options except
1116 b2070a3f 2020-03-22 stsp List references in the repository.
1119 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
1122 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
1123 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
1124 b2070a3f 2020-03-22 stsp .Ar name .
1125 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1129 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1130 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1131 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1132 d6506a3d 2022-08-16 thomas working directory.
1133 d6506a3d 2022-08-16 thomas If this directory is a
1135 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1136 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1137 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1138 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1140 e31abbf2 2020-03-22 stsp will point at the specified
1141 e31abbf2 2020-03-22 stsp .Ar reference
1142 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1143 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1144 d1c1ae5f 2019-08-12 stsp this option is used.
1145 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1147 d6506a3d 2022-08-16 thomas .It Fl t
1148 d6506a3d 2022-08-16 thomas Sort listed references by modification time (most recently modified first)
1149 d6506a3d 2022-08-16 thomas instead of sorting by lexicographical order.
1150 d6506a3d 2022-08-16 thomas Use of this option requires the
1152 d6506a3d 2022-08-16 thomas option to be used as well.
1156 56c96eff 2022-08-30 thomas .Cm branch
1157 56c96eff 2022-08-30 thomas .Op Fl lnt
1158 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1159 56c96eff 2022-08-30 thomas .Op Fl d Ar name
1160 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1161 56c96eff 2022-08-30 thomas .Op Ar name
1163 d912d125 2021-11-04 thomas .Dl Pq alias: Cm br
1164 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1166 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1167 4e759de4 2019-06-26 stsp .Dq refs/heads/
1168 4e759de4 2019-06-26 stsp reference namespace.
1170 4e759de4 2019-06-26 stsp .Cm got branch
1171 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1173 4b06140e 2022-03-22 thomas When deleting branches, the specified
1175 2f1457c6 2021-08-27 stsp is searched in the
1176 2f1457c6 2021-08-27 stsp .Dq refs/heads
1177 2f1457c6 2021-08-27 stsp reference namespace first.
1178 4b06140e 2022-03-22 thomas If no corresponding branch is found, the
1179 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1180 2f1457c6 2021-08-27 stsp namespace will be searched next.
1182 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1183 ad89fa31 2019-10-04 stsp work tree's current branch.
1187 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1188 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1189 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1190 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1192 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1193 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1194 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1195 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1197 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1198 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1199 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1200 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1201 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1202 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1203 da76fce2 2020-02-24 stsp .It A Ta new file was added
1204 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1205 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1208 4e759de4 2019-06-26 stsp The options for
1209 4e759de4 2019-06-26 stsp .Cm got branch
1210 4e759de4 2019-06-26 stsp are as follows:
1211 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1212 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1213 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1214 a74f7e83 2019-11-10 stsp .Ar commit .
1215 a74f7e83 2019-11-10 stsp The expected
1216 a74f7e83 2019-11-10 stsp .Ar commit
1217 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1218 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1219 d6506a3d 2022-08-16 thomas .It Fl d Ar name
1220 d6506a3d 2022-08-16 thomas Delete the branch with the specified
1221 d6506a3d 2022-08-16 thomas .Ar name
1222 d6506a3d 2022-08-16 thomas from the
1223 d6506a3d 2022-08-16 thomas .Dq refs/heads
1225 d6506a3d 2022-08-16 thomas .Dq refs/remotes
1226 d6506a3d 2022-08-16 thomas reference namespace.
1228 d6506a3d 2022-08-16 thomas Only the branch reference is deleted.
1229 d6506a3d 2022-08-16 thomas Any commit, tree, and blob objects belonging to the branch
1230 d6506a3d 2022-08-16 thomas remain in the repository and may be removed separately with
1231 d6506a3d 2022-08-16 thomas Git's garbage collector or
1232 d6506a3d 2022-08-16 thomas .Cm gotadmin cleanup .
1234 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1235 34d4e04c 2021-02-08 stsp repositories' branches in the
1236 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1237 34d4e04c 2021-02-08 stsp reference namespace.
1239 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1240 ba882ee3 2019-07-11 stsp with one the following annotations:
1241 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1242 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1243 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1245 d6506a3d 2022-08-16 thomas .It Fl n
1246 d6506a3d 2022-08-16 thomas Do not switch and update the work tree after creating a new branch.
1247 d6506a3d 2022-08-16 thomas .It Fl r Ar repository-path
1248 d6506a3d 2022-08-16 thomas Use the repository at the specified path.
1249 d6506a3d 2022-08-16 thomas If not specified, assume the repository is located at or above the current
1250 d6506a3d 2022-08-16 thomas working directory.
1251 d6506a3d 2022-08-16 thomas If this directory is a
1253 d6506a3d 2022-08-16 thomas work tree, use the repository path associated with this work tree.
1254 a0b48eaf 2021-11-20 thomas .It Fl t
1255 a0b48eaf 2021-11-20 thomas Sort listed branches by modification time (most recently modified first)
1256 a0b48eaf 2021-11-20 thomas instead of sorting by lexicographical order.
1257 a0b48eaf 2021-11-20 thomas Branches in the
1258 a0b48eaf 2021-11-20 thomas .Dq refs/heads/
1259 a0b48eaf 2021-11-20 thomas reference namespace are listed before branches in
1260 a0b48eaf 2021-11-20 thomas .Dq refs/remotes/
1261 a0b48eaf 2021-11-20 thomas regardless.
1262 a0b48eaf 2021-11-20 thomas Use of this option requires the
1264 a0b48eaf 2021-11-20 thomas option to be used as well.
1268 56c96eff 2022-08-30 thomas .Op Fl lVv
1269 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1270 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1271 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1272 56c96eff 2022-08-30 thomas .Op Fl s Ar signer-id
1273 56c96eff 2022-08-30 thomas .Ar name
1275 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1277 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1278 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1279 8e7bd50a 2019-08-22 stsp reference namespace.
1281 8e7bd50a 2019-08-22 stsp .Cm got tag
1282 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1283 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1284 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1286 80106605 2020-02-24 stsp Attempt to create a tag with the given
1287 8e7bd50a 2019-08-22 stsp .Ar name ,
1288 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1289 8e7bd50a 2019-08-22 stsp .Ar commit .
1290 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1291 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1292 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1294 8e7bd50a 2019-08-22 stsp The options for
1295 8e7bd50a 2019-08-22 stsp .Cm got tag
1296 8e7bd50a 2019-08-22 stsp are as follows:
1297 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1298 80106605 2020-02-24 stsp .It Fl c Ar commit
1299 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1300 80106605 2020-02-24 stsp .Ar commit .
1301 80106605 2020-02-24 stsp The expected
1302 80106605 2020-02-24 stsp .Ar commit
1303 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1304 80106605 2020-02-24 stsp will be resolved to a commit ID.
1305 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1306 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1307 d6506a3d 2022-08-16 thomas .It Fl l
1308 d6506a3d 2022-08-16 thomas List all existing tags in the repository instead of creating a new tag.
1310 d6506a3d 2022-08-16 thomas .Ar name
1311 d6506a3d 2022-08-16 thomas argument is passed, show only the tag with the given
1312 d6506a3d 2022-08-16 thomas .Ar name .
1313 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1314 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1315 8e7bd50a 2019-08-22 stsp Without the
1318 3a62228f 2019-11-08 stsp .Cm got tag
1319 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1320 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1321 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1322 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1323 8e7bd50a 2019-08-22 stsp working directory.
1324 8e7bd50a 2019-08-22 stsp If this directory is a
1326 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1327 839dd04f 2022-07-04 thomas .It Fl s Ar signer-id
1328 839dd04f 2022-07-04 thomas While creating a new tag, sign this tag with the identity given in
1329 839dd04f 2022-07-04 thomas .Ar signer-id .
1331 839dd04f 2022-07-04 thomas For SSH-based signatures,
1332 839dd04f 2022-07-04 thomas .Ar signer-id
1333 839dd04f 2022-07-04 thomas is the path to a file which may refer to either a private SSH key,
1334 839dd04f 2022-07-04 thomas or a public SSH key with the private half available via
1335 839dd04f 2022-07-04 thomas .Xr ssh-agent 1 .
1336 839dd04f 2022-07-04 thomas .Cm got tag
1337 839dd04f 2022-07-04 thomas will sign the tag object by invoking
1338 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1339 839dd04f 2022-07-04 thomas with the
1340 b6bfeb85 2022-08-16 thomas .Fl Y Cm sign
1341 839dd04f 2022-07-04 thomas command, using the signature namespace
1343 839dd04f 2022-07-04 thomas for compatibility with
1344 839dd04f 2022-07-04 thomas .Xr git 1 .
1345 839dd04f 2022-07-04 thomas .It Fl V
1346 839dd04f 2022-07-04 thomas Verify tag object signatures.
1348 839dd04f 2022-07-04 thomas .Ar name
1349 839dd04f 2022-07-04 thomas is specified, show and verify the tag object with the provided name.
1350 839dd04f 2022-07-04 thomas Otherwise, list all tag objects and verify signatures where present.
1352 839dd04f 2022-07-04 thomas .Cm got tag
1353 839dd04f 2022-07-04 thomas verifies SSH-based signatures by invoking
1354 839dd04f 2022-07-04 thomas .Xr ssh-keygen 1
1355 839dd04f 2022-07-04 thomas with the options
1356 b6bfeb85 2022-08-16 thomas .Fl Y Cm verify Fl f Ar allowed_signers .
1357 839dd04f 2022-07-04 thomas A path to the
1358 839dd04f 2022-07-04 thomas .Ar allowed_signers
1359 839dd04f 2022-07-04 thomas file must be set in
1360 839dd04f 2022-07-04 thomas .Xr got.conf 5 ,
1361 839dd04f 2022-07-04 thomas otherwise verification is impossible.
1362 d6506a3d 2022-08-16 thomas .It Fl v
1363 d6506a3d 2022-08-16 thomas Verbose mode.
1364 d6506a3d 2022-08-16 thomas During SSH signature creation and verification this option will be passed to
1365 d6506a3d 2022-08-16 thomas .Xr ssh-keygen 1 .
1366 d6506a3d 2022-08-16 thomas Multiple -v options increase the verbosity.
1367 d6506a3d 2022-08-16 thomas The maximum is 3.
1370 8e7bd50a 2019-08-22 stsp By design, the
1371 8e7bd50a 2019-08-22 stsp .Cm got tag
1372 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1373 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1374 8e7bd50a 2019-08-22 stsp .Cm got ref
1375 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1376 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1377 8e7bd50a 2019-08-22 stsp another repository.
1380 56c96eff 2022-08-30 thomas .Op Fl IR
1381 56c96eff 2022-08-30 thomas .Ar path ...
1383 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1384 d00136be 2019-03-26 stsp repository in the next commit.
1385 ff56836b 2021-07-08 stsp By default, files which match a
1386 ff56836b 2021-07-08 stsp .Cm got status
1387 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1389 4e68cba3 2019-11-23 stsp The options for
1390 4e68cba3 2019-11-23 stsp .Cm got add
1391 4e68cba3 2019-11-23 stsp are as follows:
1392 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1393 d6506a3d 2022-08-16 thomas .It Fl I
1394 d6506a3d 2022-08-16 thomas Add files even if they match a
1395 d6506a3d 2022-08-16 thomas .Cm got status
1396 d6506a3d 2022-08-16 thomas ignore pattern.
1398 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1399 4e68cba3 2019-11-23 stsp If this option is not specified,
1400 4e68cba3 2019-11-23 stsp .Cm got add
1401 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1403 4e68cba3 2019-11-23 stsp is a directory.
1407 56c96eff 2022-08-30 thomas .Cm remove
1408 56c96eff 2022-08-30 thomas .Op Fl fkR
1409 56c96eff 2022-08-30 thomas .Op Fl s Ar status-codes
1410 56c96eff 2022-08-30 thomas .Ar path ...
1412 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rm
1413 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1414 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1416 2ec1f75b 2019-03-26 stsp The options for
1417 86d25a1b 2019-07-11 stsp .Cm got remove
1418 2ec1f75b 2019-03-26 stsp are as follows:
1419 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1421 d64cc78a 2022-01-25 thomas Perform the operation even if a file contains local modifications,
1422 d64cc78a 2022-01-25 thomas and do not raise an error if a specified
1423 d64cc78a 2022-01-25 thomas .Ar path
1424 d64cc78a 2022-01-25 thomas does not exist on disk.
1425 70e3e7f5 2019-12-13 tracey .It Fl k
1426 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1427 f2a9dc41 2019-12-13 tracey .It Fl R
1428 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1429 f2a9dc41 2019-12-13 tracey If this option is not specified,
1430 f2a9dc41 2019-12-13 tracey .Cm got remove
1431 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1432 f2a9dc41 2019-12-13 tracey .Ar path
1433 f2a9dc41 2019-12-13 tracey is a directory.
1434 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1435 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1436 766841c2 2020-08-13 stsp single-character status codes contained in the
1437 766841c2 2020-08-13 stsp .Ar status-codes
1439 766841c2 2020-08-13 stsp The following status codes may be specified:
1440 766841c2 2020-08-13 stsp .Bl -column YXZ description
1441 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1444 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1449 56c96eff 2022-08-30 thomas .Cm patch
1450 56c96eff 2022-08-30 thomas .Op Fl nR
1451 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
1452 56c96eff 2022-08-30 thomas .Op Fl p Ar strip-count
1453 56c96eff 2022-08-30 thomas .Op Ar patchfile
1455 069bbb86 2022-03-07 thomas .Dl Pq alias: Cm pa
1456 069bbb86 2022-03-07 thomas Apply changes from
1457 069bbb86 2022-03-07 thomas .Ar patchfile
1458 07f74738 2022-03-13 thomas to files in a work tree.
1459 443c08c9 2022-03-13 thomas Files added or removed by a patch will be scheduled for addition or removal in
1460 443c08c9 2022-03-13 thomas the work tree.
1462 07f74738 2022-03-13 thomas The patch must be in the unified diff format as produced by
1463 07f74738 2022-03-13 thomas .Cm got diff ,
1464 99e34129 2022-03-22 thomas .Xr git-diff 1 ,
1466 07f74738 2022-03-13 thomas .Xr diff 1
1468 3eb4f629 2022-03-22 thomas .Xr cvs 1
1469 6f7394ad 2022-03-22 thomas diff when invoked with their
1471 6f7394ad 2022-03-22 thomas options.
1473 069bbb86 2022-03-07 thomas .Ar patchfile
1474 07f74738 2022-03-13 thomas argument is provided, read unified diff data from standard input instead.
1477 07f74738 2022-03-13 thomas .Ar patchfile
1478 4b06140e 2022-03-22 thomas contains multiple patches, then attempt to apply each of them in sequence.
1480 4929098b 2022-03-13 thomas Show the status of each affected file, using the following status codes:
1481 069bbb86 2022-03-07 thomas .Bl -column XYZ description
1482 07f74738 2022-03-13 thomas .It M Ta file was modified
1483 762b8e82 2022-06-23 thomas .It G Ta file was merged using a merge-base found in the repository
1484 762b8e82 2022-06-23 thomas .It C Ta file was merged and conflicts occurred during merge
1485 07f74738 2022-03-13 thomas .It D Ta file was deleted
1486 07f74738 2022-03-13 thomas .It A Ta file was added
1487 49114f01 2022-03-22 thomas .It # Ta failed to patch the file
1490 07f74738 2022-03-13 thomas If a change does not match at its exact line number, attempt to
1491 4929098b 2022-03-13 thomas apply it somewhere else in the file if a good spot can be found.
1492 4929098b 2022-03-13 thomas Otherwise, the patch will fail to apply.
1495 2cfc25ac 2022-03-13 thomas .Cm patch
1496 2cfc25ac 2022-03-13 thomas will refuse to apply a patch if certain preconditions are not met.
1497 4929098b 2022-03-13 thomas Files to be deleted must already be under version control, and must
1498 4929098b 2022-03-13 thomas not have been scheduled for deletion already.
1499 4929098b 2022-03-13 thomas Files to be added must not yet be under version control and must not
1500 4929098b 2022-03-13 thomas already be present on disk.
1501 4929098b 2022-03-13 thomas Files to be modified must already be under version control and may not
1502 4929098b 2022-03-13 thomas contain conflict markers.
1504 2cfc25ac 2022-03-13 thomas If an error occurs, the
1505 2cfc25ac 2022-03-13 thomas .Cm patch
1506 2cfc25ac 2022-03-13 thomas operation will be aborted.
1507 2cfc25ac 2022-03-13 thomas Any changes made to the work tree up to this point will be left behind.
1508 07f74738 2022-03-13 thomas Such changes can be viewed with
1509 2cfc25ac 2022-03-13 thomas .Cm got diff
1510 2cfc25ac 2022-03-13 thomas and can be reverted with
1511 2cfc25ac 2022-03-13 thomas .Cm got revert
1512 2cfc25ac 2022-03-13 thomas if needed.
1514 bfc91212 2022-03-13 thomas The options for
1515 bfc91212 2022-03-13 thomas .Cm got patch
1516 bfc91212 2022-03-13 thomas are as follows:
1517 bfc91212 2022-03-13 thomas .Bl -tag -width Ds
1518 7d8bcb99 2022-07-28 thomas .It Fl c Ar commit
1519 82a8b7ec 2022-08-06 thomas Attempt to locate files within the specified
1520 7d8bcb99 2022-07-28 thomas .Ar commit
1521 82a8b7ec 2022-08-06 thomas for use as a merge-base for 3-way merges.
1522 82a8b7ec 2022-08-06 thomas Ideally, the specified
1523 82a8b7ec 2022-08-06 thomas .Ar commit
1524 82a8b7ec 2022-08-06 thomas should contain versions of files which the changes contained in the
1525 82a8b7ec 2022-08-06 thomas .Ar patchfile
1526 82a8b7ec 2022-08-06 thomas were based on.
1527 82a8b7ec 2022-08-06 thomas Files will be located by path, relative to the repository root.
1530 82a8b7ec 2022-08-06 thomas option is used then leading path components will be stripped
1531 82a8b7ec 2022-08-06 thomas before paths are looked up in the repository.
1535 82a8b7ec 2022-08-06 thomas option is not used then
1536 82a8b7ec 2022-08-06 thomas .Cm got patch
1537 82a8b7ec 2022-08-06 thomas will attempt to locate merge-bases via object IDs found in
1538 82a8b7ec 2022-08-06 thomas .Ar patchfile
1539 82a8b7ec 2022-08-06 thomas meta-data, such as produced by
1540 82a8b7ec 2022-08-06 thomas .Cm got diff
1542 82a8b7ec 2022-08-06 thomas .Xr git-diff 1 .
1543 82a8b7ec 2022-08-06 thomas Use of the
1545 82a8b7ec 2022-08-06 thomas option is only recommended in the absence of such meta-data.
1547 82a8b7ec 2022-08-06 thomas In case no merge-base is available for a file, changes will be applied
1548 82a8b7ec 2022-08-06 thomas without doing a 3-way merge.
1549 82a8b7ec 2022-08-06 thomas Changes which do not apply cleanly may then be rejected entirely, rather
1550 82a8b7ec 2022-08-06 thomas than producing merge conflicts in the patched target file.
1551 bfc91212 2022-03-13 thomas .It Fl n
1552 bfc91212 2022-03-13 thomas Do not make any modifications to the work tree.
1553 bfc91212 2022-03-13 thomas This can be used to check whether a patch would apply without issues.
1555 bfc91212 2022-03-13 thomas .Ar patchfile
1556 4b06140e 2022-03-22 thomas contains diffs that affect the same file multiple times, the results
1557 bfc91212 2022-03-13 thomas displayed may be incorrect.
1558 d9db2ff9 2022-04-16 thomas .It Fl p Ar strip-count
1559 d9db2ff9 2022-04-16 thomas Specify the number of leading path components to strip from paths
1560 d9db2ff9 2022-04-16 thomas parsed from
1561 d9db2ff9 2022-04-16 thomas .Ar patchfile .
1564 d9db2ff9 2022-04-16 thomas option is not used,
1568 d9db2ff9 2022-04-16 thomas path prefixes generated by
1569 d9db2ff9 2022-04-16 thomas .Xr git-diff 1
1570 d9db2ff9 2022-04-16 thomas will be recognized and stripped automatically.
1571 eaef698f 2022-04-23 thomas .It Fl R
1572 eaef698f 2022-04-23 thomas Reverse the patch before applying it.
1576 56c96eff 2022-08-30 thomas .Cm revert
1577 56c96eff 2022-08-30 thomas .Op Fl pR
1578 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
1579 56c96eff 2022-08-30 thomas .Ar path ...
1581 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rv
1582 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1583 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1584 1dd86744 2019-08-12 anthony work tree's base commit.
1585 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1586 a129376b 2019-03-28 stsp .Cm got revert !
1588 e20a8b6f 2019-06-04 stsp If a file was added with
1589 4b06140e 2022-03-22 thomas .Cm got add ,
1590 a129376b 2019-03-28 stsp it will become an unversioned file again.
1591 e20a8b6f 2019-06-04 stsp If a file was deleted with
1592 4b06140e 2022-03-22 thomas .Cm got remove ,
1593 a129376b 2019-03-28 stsp it will be restored.
1595 0f6d7415 2019-08-08 stsp The options for
1596 0f6d7415 2019-08-08 stsp .Cm got revert
1597 0f6d7415 2019-08-08 stsp are as follows:
1598 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1599 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
1600 d6506a3d 2022-08-16 thomas With the
1602 d6506a3d 2022-08-16 thomas option, read
1607 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
1608 d6506a3d 2022-08-16 thomas .Ar response-script
1609 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
1611 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1612 33aa809d 2019-08-08 stsp changes to revert based on
1614 33aa809d 2019-08-08 stsp (revert change),
1616 33aa809d 2019-08-08 stsp (keep change), and
1618 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1619 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1620 33aa809d 2019-08-08 stsp modified file content can be reverted.
1621 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1623 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1624 0f6d7415 2019-08-08 stsp If this option is not specified,
1625 0f6d7415 2019-08-08 stsp .Cm got revert
1626 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1628 0f6d7415 2019-08-08 stsp is a directory.
1632 56c96eff 2022-08-30 thomas .Cm commit
1633 ef899790 2022-11-01 thomas .Op Fl NnS
1634 56c96eff 2022-08-30 thomas .Op Fl A Ar author
1635 56c96eff 2022-08-30 thomas .Op Fl F Ar path
1636 56c96eff 2022-08-30 thomas .Op Fl m Ar message
1637 56c96eff 2022-08-30 thomas .Op Ar path ...
1639 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ci
1640 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1641 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1644 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1645 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1647 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1648 1dd86744 2019-08-12 anthony .Cm got stage ,
1649 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1650 4ed9f614 2019-08-04 stsp have not been staged.
1652 28cf319f 2021-01-28 stsp .Cm got commit
1653 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1654 28cf319f 2021-01-28 stsp unless the
1656 28cf319f 2021-01-28 stsp option is used
1661 28cf319f 2021-01-28 stsp options are used together.
1663 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1664 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1665 15cd91f7 2019-05-12 stsp .It M Ta modified file
1666 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1667 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1668 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1671 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1672 996d5ccd 2019-08-05 stsp recorded base commit.
1675 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1676 15cd91f7 2019-05-12 stsp multiple base commits.
1677 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1678 47ec7be7 2019-05-12 stsp .Cm got update
1679 47ec7be7 2019-05-12 stsp across the entire work tree.
1682 15cd91f7 2019-05-12 stsp .Cm got commit
1683 15cd91f7 2019-05-12 stsp command requires the
1684 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1685 aba9c984 2019-09-08 stsp environment variable to be set,
1686 257add31 2020-09-09 stsp unless an author has been configured in
1687 257add31 2020-09-09 stsp .Xr got.conf 5
1689 aba9c984 2019-09-08 stsp .Dv user.name
1691 709ae9eb 2019-09-08 stsp .Dv user.email
1692 709ae9eb 2019-09-08 stsp configuration settings can be
1693 aba9c984 2019-09-08 stsp obtained from the repository's
1694 aba9c984 2019-09-08 stsp .Pa .git/config
1695 c9956ddf 2019-09-08 stsp file or from Git's global
1696 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1697 c9956ddf 2019-09-08 stsp configuration file.
1699 74416c47 2019-05-09 stsp The options for
1700 74416c47 2019-05-09 stsp .Cm got commit
1701 74416c47 2019-05-09 stsp are as follows:
1702 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1703 18d1acad 2022-07-20 thomas .It Fl A Ar author
1704 18d1acad 2022-07-20 thomas Set author information in the newly created commit to
1705 18d1acad 2022-07-20 thomas .Ar author .
1706 18d1acad 2022-07-20 thomas This is useful when committing changes which were written by someone
1709 18d1acad 2022-07-20 thomas .Ar author
1710 18d1acad 2022-07-20 thomas argument must use the same format as the
1711 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
1712 18d1acad 2022-07-20 thomas environment variable.
1714 18d1acad 2022-07-20 thomas In addition to storing author information, the newly created commit
1715 18d1acad 2022-07-20 thomas object will retain
1716 18d1acad 2022-07-20 thomas .Dq committer
1717 18d1acad 2022-07-20 thomas information which is obtained, as usual, from the
1718 18d1acad 2022-07-20 thomas .Ev GOT_AUTHOR
1719 18d1acad 2022-07-20 thomas environment variable, or
1720 18d1acad 2022-07-20 thomas .Xr got.conf 5 ,
1721 18d1acad 2022-07-20 thomas or Git configuration settings.
1722 28cf319f 2021-01-28 stsp .It Fl F Ar path
1723 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1725 28cf319f 2021-01-28 stsp when creating the new commit.
1726 28cf319f 2021-01-28 stsp .Cm got commit
1727 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1728 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1729 28cf319f 2021-01-28 stsp Cannot be used together with the
1732 28cf319f 2021-01-28 stsp .It Fl m Ar message
1733 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1734 28cf319f 2021-01-28 stsp Cannot be used together with the
1738 28cf319f 2021-01-28 stsp This option prevents
1739 23594da9 2019-05-13 stsp .Cm got commit
1740 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1741 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1743 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1744 ef899790 2022-11-01 thomas .It Fl n
1745 ef899790 2022-11-01 thomas This option prevents
1746 ef899790 2022-11-01 thomas .Cm got commit
1747 ef899790 2022-11-01 thomas from generating a diff of the to-be-committed changes in a temporary file
1748 ef899790 2022-11-01 thomas which can be viewed while editing a commit message.
1750 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1751 af358f55 2020-07-23 stsp that is under version control.
1752 af358f55 2020-07-23 stsp By default,
1753 af358f55 2020-07-23 stsp .Cm got commit
1754 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1755 35213c7c 2020-07-23 stsp As a precaution,
1757 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1758 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1759 af358f55 2020-07-23 stsp points outside of the work tree.
1760 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1761 af358f55 2020-07-23 stsp .Dq make obj
1762 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1763 af358f55 2020-07-23 stsp version control.
1766 cfce0458 2019-07-28 stsp .Cm got commit
1767 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1768 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1769 916f288c 2019-07-30 stsp .Dq refs/heads/
1770 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1771 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1772 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1773 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1774 cfce0458 2019-07-28 stsp .Cm got update
1775 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1776 cfce0458 2019-07-28 stsp in the repository.
1779 56c96eff 2022-08-30 thomas .Cm send
1780 56c96eff 2022-08-30 thomas .Op Fl afqTv
1781 56c96eff 2022-08-30 thomas .Op Fl b Ar branch
1782 56c96eff 2022-08-30 thomas .Op Fl d Ar branch
1783 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
1784 56c96eff 2022-08-30 thomas .Op Fl t Ar tag
1785 56c96eff 2022-08-30 thomas .Op Ar remote-repository
1787 d912d125 2021-11-04 thomas .Dl Pq alias: Cm se
1788 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
1790 f8a36e22 2021-08-26 stsp .Ar remote-repository
1791 f8a36e22 2021-08-26 stsp is specified,
1792 f8a36e22 2021-08-26 stsp .Dq origin
1793 f8a36e22 2021-08-26 stsp will be used.
1794 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
1795 f8a36e22 2021-08-26 stsp .Xr got.conf 5
1797 f8a36e22 2021-08-26 stsp .Pa config
1798 f8a36e22 2021-08-26 stsp file of the local repository, as created by
1799 f8a36e22 2021-08-26 stsp .Cm got clone .
1801 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
1802 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
1803 f8a36e22 2021-08-26 stsp Upon success, references in the
1804 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
1805 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
1806 f8a36e22 2021-08-26 stsp the commits which have been sent.
1808 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
1809 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
1810 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
1811 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
1812 fd44090b 2021-08-26 stsp be fetched from the server with
1813 f8a36e22 2021-08-26 stsp .Cm got fetch
1814 f8a36e22 2021-08-26 stsp and local branches must be rebased with
1815 f8a36e22 2021-08-26 stsp .Cm got rebase
1817 f8a36e22 2021-08-26 stsp .Cm got send
1818 f8a36e22 2021-08-26 stsp can succeed.
1821 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
1823 f8a36e22 2021-08-26 stsp The options for
1824 f8a36e22 2021-08-26 stsp .Cm got send
1825 f8a36e22 2021-08-26 stsp are as follows:
1826 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
1828 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
1829 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1830 f8a36e22 2021-08-26 stsp reference namespace.
1833 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
1836 f8a36e22 2021-08-26 stsp Cannot be used together with the
1839 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
1840 f8a36e22 2021-08-26 stsp Send the specified
1841 f8a36e22 2021-08-26 stsp .Ar branch
1842 f8a36e22 2021-08-26 stsp from the local repository's
1843 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1844 f8a36e22 2021-08-26 stsp reference namespace.
1845 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1847 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
1848 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
1849 f8a36e22 2021-08-26 stsp Cannot be used together with the
1852 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
1853 f8a36e22 2021-08-26 stsp Delete the specified
1854 f8a36e22 2021-08-26 stsp .Ar branch
1855 f8a36e22 2021-08-26 stsp from the remote repository's
1856 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1857 f8a36e22 2021-08-26 stsp reference namespace.
1858 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1859 f8a36e22 2021-08-26 stsp to delete.
1861 f8a36e22 2021-08-26 stsp Only references are deleted.
1862 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
1863 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
1864 f8a36e22 2021-08-26 stsp the server.
1866 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
1867 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
1868 fd44090b 2021-08-26 stsp based on its configuration.
1870 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
1871 fd44090b 2021-08-26 stsp in the remote repository, even when
1872 fd44090b 2021-08-26 stsp .Cm got fetch
1874 fd44090b 2021-08-26 stsp .Cm got rebase
1875 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
1876 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
1877 f8a36e22 2021-08-26 stsp configuration.
1879 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
1880 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
1881 f8a36e22 2021-08-26 stsp on the server.
1884 f8a36e22 2021-08-26 stsp .Dq refs/tags
1885 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
1886 f8a36e22 2021-08-26 stsp Use of the
1888 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
1889 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
1890 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1891 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1893 f8a36e22 2021-08-26 stsp Use of the
1895 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
1896 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
1897 f8a36e22 2021-08-26 stsp Instead of using the
1899 f8a36e22 2021-08-26 stsp option, new changes should
1900 f8a36e22 2021-08-26 stsp be fetched with
1901 f8a36e22 2021-08-26 stsp .Cm got fetch
1902 f8a36e22 2021-08-26 stsp and local branches should be rebased with
1903 f8a36e22 2021-08-26 stsp .Cm got rebase ,
1904 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
1908 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
1909 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
1910 f8a36e22 2021-08-26 stsp disposable.
1911 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
1912 f8a36e22 2021-08-26 stsp should also be taken into account.
1913 d6506a3d 2022-08-16 thomas .It Fl q
1914 d6506a3d 2022-08-16 thomas Suppress progress reporting output.
1915 d6506a3d 2022-08-16 thomas The same option will be passed to
1916 d6506a3d 2022-08-16 thomas .Xr ssh 1
1917 d6506a3d 2022-08-16 thomas if applicable.
1918 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
1919 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
1920 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
1921 f8a36e22 2021-08-26 stsp working directory.
1922 f8a36e22 2021-08-26 stsp If this directory is a
1924 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
1925 d6506a3d 2022-08-16 thomas .It Fl T
1926 d6506a3d 2022-08-16 thomas Attempt to send all tags from the local repository's
1927 d6506a3d 2022-08-16 thomas .Dq refs/tags/
1928 d6506a3d 2022-08-16 thomas reference namespace.
1931 d6506a3d 2022-08-16 thomas option is equivalent to listing all tags with multiple
1933 d6506a3d 2022-08-16 thomas options.
1934 d6506a3d 2022-08-16 thomas Cannot be used together with the
1937 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
1938 f8a36e22 2021-08-26 stsp Send the specified
1940 f8a36e22 2021-08-26 stsp from the local repository's
1941 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1942 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
1945 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
1946 f8a36e22 2021-08-26 stsp No tags will be sent if the
1948 f8a36e22 2021-08-26 stsp option is not used.
1950 f8a36e22 2021-08-26 stsp Raise an error if the specified
1952 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
1954 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
1955 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1956 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1958 f8a36e22 2021-08-26 stsp Cannot be used together with the
1962 f8a36e22 2021-08-26 stsp Verbose mode.
1964 f8a36e22 2021-08-26 stsp .Cm got send
1965 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
1966 f8a36e22 2021-08-26 stsp The same option will be passed to
1968 f8a36e22 2021-08-26 stsp if applicable.
1969 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
1970 f8a36e22 2021-08-26 stsp The maximum is 3.
1974 f6cd0243 2023-01-28 thomas .Cm cherrypick
1975 f6cd0243 2023-01-28 thomas .Op Fl lX
1976 7e710171 2023-01-28 thomas .Op Ar commit
1978 d912d125 2021-11-04 thomas .Dl Pq alias: Cm cy
1979 234035bc 2019-06-01 stsp Merge changes from a single
1980 234035bc 2019-06-01 stsp .Ar commit
1981 234035bc 2019-06-01 stsp into the work tree.
1982 234035bc 2019-06-01 stsp The specified
1983 234035bc 2019-06-01 stsp .Ar commit
1984 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
1985 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1986 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1987 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1989 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1990 234035bc 2019-06-01 stsp .Bl -column YXZ description
1991 234035bc 2019-06-01 stsp .It G Ta file was merged
1992 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1993 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1994 234035bc 2019-06-01 stsp .It D Ta file was deleted
1995 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
1996 234035bc 2019-06-01 stsp .It A Ta new file was added
1997 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1998 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2001 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2002 234035bc 2019-06-01 stsp may be viewed with
2003 234035bc 2019-06-01 stsp .Cm got diff ,
2004 234035bc 2019-06-01 stsp amended manually or with further
2005 234035bc 2019-06-01 stsp .Cm got cherrypick
2007 234035bc 2019-06-01 stsp committed with
2008 52d3950d 2023-01-28 thomas .Cm got commit .
2010 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2011 52d3950d 2023-01-28 thomas .Cm rebase ,
2012 52d3950d 2023-01-28 thomas .Cm histedit ,
2014 52d3950d 2023-01-28 thomas .Cm merge
2015 52d3950d 2023-01-28 thomas operation is taking place,
2016 52d3950d 2023-01-28 thomas .Cm got cherrypick
2017 52d3950d 2023-01-28 thomas creates a record of commits which have been merged into the work tree.
2018 52d3950d 2023-01-28 thomas When a file changed by
2019 52d3950d 2023-01-28 thomas .Cm got cherrypick
2020 52d3950d 2023-01-28 thomas is committed with
2021 52d3950d 2023-01-28 thomas .Cm got commit ,
2022 52d3950d 2023-01-28 thomas the log messages of relevant merged commits will then appear in the editor,
2023 95e6f77e 2023-01-28 thomas where the messages must be further adjusted to convey the reasons for
2024 95e6f77e 2023-01-28 thomas cherrypicking the changes.
2025 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2026 52d3950d 2023-01-28 thomas e.g. with
2027 52d3950d 2023-01-28 thomas .Cm got revert ,
2028 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2030 234035bc 2019-06-01 stsp .Cm got cherrypick
2031 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2032 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2033 234035bc 2019-06-01 stsp to a single base commit with
2034 234035bc 2019-06-01 stsp .Cm got update .
2035 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2036 234035bc 2019-06-01 stsp conflicts must be resolved first.
2038 f6cd0243 2023-01-28 thomas The options for
2040 f6cd0243 2023-01-28 thomas .Cm cherrypick
2041 f6cd0243 2023-01-28 thomas are as follows:
2042 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2043 f6cd0243 2023-01-28 thomas .It Fl l
2044 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by cherrypick operations,
2045 f6cd0243 2023-01-28 thomas represented by references in the
2046 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2047 f6cd0243 2023-01-28 thomas reference namespace.
2049 f6cd0243 2023-01-28 thomas .Ar commit
2050 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2052 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2053 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2054 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2055 f6cd0243 2023-01-28 thomas work tree in which they were created.
2056 f6cd0243 2023-01-28 thomas This option cannot be used with
2058 f6cd0243 2023-01-28 thomas .It Fl X
2059 f6cd0243 2023-01-28 thomas Delete log messages created by previous cherrypick operations, represented by
2060 f6cd0243 2023-01-28 thomas references in the
2061 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2062 f6cd0243 2023-01-28 thomas reference namespace.
2064 f6cd0243 2023-01-28 thomas .Ar commit
2065 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2067 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by cherrypick operations
2068 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2069 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2070 f6cd0243 2023-01-28 thomas work tree in which they were created.
2071 f6cd0243 2023-01-28 thomas This option cannot be used with
2077 f6cd0243 2023-01-28 thomas .Cm backout
2078 f6cd0243 2023-01-28 thomas .Op Fl lX
2079 7e710171 2023-01-28 thomas .Op Ar commit
2081 d912d125 2021-11-04 thomas .Dl Pq alias: Cm bo
2082 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2083 5ef14e63 2019-06-02 stsp .Ar commit
2084 5ef14e63 2019-06-02 stsp into the work tree.
2085 5ef14e63 2019-06-02 stsp The specified
2086 5ef14e63 2019-06-02 stsp .Ar commit
2087 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2088 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
2089 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2090 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2092 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2093 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2094 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2095 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2096 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2097 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2098 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2099 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2100 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2101 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2104 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2105 5ef14e63 2019-06-02 stsp which may be viewed with
2106 5ef14e63 2019-06-02 stsp .Cm got diff ,
2107 5ef14e63 2019-06-02 stsp amended manually or with further
2108 778a73c2 2019-07-12 stsp .Cm got backout
2110 5ef14e63 2019-06-02 stsp committed with
2111 52d3950d 2023-01-28 thomas .Cm got commit .
2113 52d3950d 2023-01-28 thomas If invoked in a work tree where no
2114 52d3950d 2023-01-28 thomas .Cm rebase ,
2115 52d3950d 2023-01-28 thomas .Cm histedit ,
2117 52d3950d 2023-01-28 thomas .Cm merge
2118 52d3950d 2023-01-28 thomas operation is taking place,
2119 52d3950d 2023-01-28 thomas .Cm got backout
2120 52d3950d 2023-01-28 thomas creates a record of commits which have been reverse-merged into the work tree.
2121 52d3950d 2023-01-28 thomas When a file changed by
2122 52d3950d 2023-01-28 thomas .Cm got backout
2123 52d3950d 2023-01-28 thomas is committed with
2124 52d3950d 2023-01-28 thomas .Cm got commit ,
2125 52d3950d 2023-01-28 thomas the log messages of relevant reverse-merged commits will then appear in
2126 95e6f77e 2023-01-28 thomas the editor, where the messages must be further adjusted to convey the
2127 95e6f77e 2023-01-28 thomas reasons for backing out the changes.
2128 52d3950d 2023-01-28 thomas If all the changes in all files touched by a given commit are discarded,
2129 52d3950d 2023-01-28 thomas e.g. with
2130 52d3950d 2023-01-28 thomas .Cm got revert ,
2131 52d3950d 2023-01-28 thomas this commit's log message record will also disappear.
2133 92228c38 2019-06-02 stsp .Cm got backout
2134 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2135 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2136 92228c38 2019-06-02 stsp to a single base commit with
2137 92228c38 2019-06-02 stsp .Cm got update .
2138 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2139 92228c38 2019-06-02 stsp conflicts must be resolved first.
2141 f6cd0243 2023-01-28 thomas The options for
2143 f6cd0243 2023-01-28 thomas .Cm backout
2144 f6cd0243 2023-01-28 thomas are as follows:
2145 f6cd0243 2023-01-28 thomas .Bl -tag -width Ds
2146 f6cd0243 2023-01-28 thomas .It Fl l
2147 f6cd0243 2023-01-28 thomas Display a list of commit log messages recorded by backout operations,
2148 f6cd0243 2023-01-28 thomas represented by references in the
2149 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2150 f6cd0243 2023-01-28 thomas reference namespace.
2152 f6cd0243 2023-01-28 thomas .Ar commit
2153 f6cd0243 2023-01-28 thomas is specified, only show the log message of the specified commit.
2155 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2156 f6cd0243 2023-01-28 thomas in the current work tree will be displayed.
2157 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be displayed irrespective of the
2158 f6cd0243 2023-01-28 thomas work tree in which they were created.
2159 f6cd0243 2023-01-28 thomas This option cannot be used with
2161 f6cd0243 2023-01-28 thomas .It Fl X
2162 f6cd0243 2023-01-28 thomas Delete log messages created by previous backout operations, represented by
2163 f6cd0243 2023-01-28 thomas references in the
2164 f6cd0243 2023-01-28 thomas .Dq refs/got/worktree
2165 f6cd0243 2023-01-28 thomas reference namespace.
2167 f6cd0243 2023-01-28 thomas .Ar commit
2168 f6cd0243 2023-01-28 thomas is specified, only delete the log message of the specified commit.
2170 f6cd0243 2023-01-28 thomas If invoked in a work tree, only log messages recorded by backout operations
2171 f6cd0243 2023-01-28 thomas in the current work tree will be deleted.
2172 f6cd0243 2023-01-28 thomas Otherwise, all commit log messages will be deleted irrespective of the
2173 f6cd0243 2023-01-28 thomas work tree in which they were created.
2174 f6cd0243 2023-01-28 thomas This option cannot be used with
2180 56c96eff 2022-08-30 thomas .Cm rebase
2181 56c96eff 2022-08-30 thomas .Op Fl aclX
2182 56c96eff 2022-08-30 thomas .Op Ar branch
2184 d912d125 2021-11-04 thomas .Dl Pq alias: Cm rb
2185 818c7501 2019-07-11 stsp Rebase commits on the specified
2186 818c7501 2019-07-11 stsp .Ar branch
2187 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2189 818c7501 2019-07-11 stsp .Ar branch
2190 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2191 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2192 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2193 818c7501 2019-07-11 stsp .Ar branch
2194 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2195 f09e2405 2019-07-11 stsp of the specified
2196 818c7501 2019-07-11 stsp .Ar branch
2197 f09e2405 2019-07-11 stsp has been rebased.
2200 2b6826ba 2020-02-24 stsp .Cm got rebase
2201 2b6826ba 2020-02-24 stsp is used as intended, the specified
2202 2b6826ba 2020-02-24 stsp .Ar branch
2203 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2204 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2205 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2206 2b6826ba 2020-02-24 stsp .Cm got update -b
2207 2b6826ba 2020-02-24 stsp before starting the
2208 2b6826ba 2020-02-24 stsp .Cm rebase
2209 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2210 2b6826ba 2020-02-24 stsp a common history with the specified
2211 2b6826ba 2020-02-24 stsp .Ar branch
2212 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2213 c10890ce 2020-02-25 stsp remote repository.
2215 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2216 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2217 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2218 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2219 818c7501 2019-07-11 stsp .Ar branch ,
2220 818c7501 2019-07-11 stsp but with different commit IDs.
2221 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2222 f09e2405 2019-07-11 stsp the new version of the specified
2223 818c7501 2019-07-11 stsp .Ar branch
2224 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2225 d4dddcbf 2022-07-22 thomas If author information is available via the
2226 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2227 d4dddcbf 2022-07-22 thomas environment variable,
2228 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2229 d4dddcbf 2022-07-22 thomas or Git's
2230 d4dddcbf 2022-07-22 thomas .Dv user.name
2232 d4dddcbf 2022-07-22 thomas .Dv user.email
2233 d4dddcbf 2022-07-22 thomas configuration settings, this author information will be used to identify
2235 d4dddcbf 2022-07-22 thomas .Dq committer
2236 d4dddcbf 2022-07-22 thomas of rebased commits.
2238 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2239 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2240 e600f124 2021-03-21 stsp reference namespace.
2241 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2242 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2243 e600f124 2021-03-21 stsp .Cm got rebase -l
2245 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2246 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2247 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2249 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2250 818c7501 2019-07-11 stsp using the following status codes:
2251 818c7501 2019-07-11 stsp .Bl -column YXZ description
2252 818c7501 2019-07-11 stsp .It G Ta file was merged
2253 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2254 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2255 818c7501 2019-07-11 stsp .It D Ta file was deleted
2256 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2257 818c7501 2019-07-11 stsp .It A Ta new file was added
2258 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2259 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2262 4b06140e 2022-03-22 thomas If merge conflicts occur, the rebase operation is interrupted and may
2263 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2264 bb494413 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2265 bb494413 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2266 bb494413 2021-09-28 thomas the rebase operation will be interrupted to prevent potentially incomplete
2267 bb494413 2021-09-28 thomas changes from being committed to the repository without user intervention.
2268 bb494413 2021-09-28 thomas The work tree may be modified as desired and the rebase operation can be
2269 bb494413 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2270 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2271 818c7501 2019-07-11 stsp .Ar branch
2272 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2274 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2275 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2276 f09e2405 2019-07-11 stsp when the rebase operation continues.
2278 818c7501 2019-07-11 stsp .Cm got rebase
2279 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2281 8dbcf388 2022-09-04 thomas .Ar branch
2282 8dbcf388 2022-09-04 thomas is not in the
2283 8dbcf388 2022-09-04 thomas .Dq refs/heads/
2284 8dbcf388 2022-09-04 thomas reference namespace, the branch may not be rebased.
2285 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2286 4b06140e 2022-03-22 thomas branch, then the work tree must first be updated with
2287 818c7501 2019-07-11 stsp .Cm got update .
2288 4ed9f614 2019-08-04 stsp If changes have been staged with
2289 4ed9f614 2019-08-04 stsp .Cm got stage ,
2290 bc3056e3 2019-08-18 stsp these changes must first be committed with
2291 4ed9f614 2019-08-04 stsp .Cm got commit
2292 4ed9f614 2019-08-04 stsp or unstaged with
2293 4ed9f614 2019-08-04 stsp .Cm got unstage .
2294 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2295 f09e2405 2019-07-11 stsp committed with
2296 f09e2405 2019-07-11 stsp .Cm got commit
2297 f09e2405 2019-07-11 stsp or reverted with
2298 f09e2405 2019-07-11 stsp .Cm got revert .
2300 64c6d990 2019-07-11 stsp .Ar branch
2301 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2302 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2305 8bcebf69 2023-01-08 thomas .Cm got update ,
2306 8bcebf69 2023-01-08 thomas .Cm got integrate ,
2307 8bcebf69 2023-01-08 thomas .Cm got merge ,
2308 8bcebf69 2023-01-08 thomas .Cm got commit ,
2310 8bcebf69 2023-01-08 thomas .Cm got histedit
2311 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2312 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2313 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2315 d10218e7 2021-11-04 thomas If the specified
2316 d10218e7 2021-11-04 thomas .Ar branch
2317 4b06140e 2022-03-22 thomas is already based on the work tree's current branch, then no commits
2318 d10218e7 2021-11-04 thomas need to be rebased and
2319 d10218e7 2021-11-04 thomas .Cm got rebase
2320 d10218e7 2021-11-04 thomas will simply switch the work tree to the specified
2321 d10218e7 2021-11-04 thomas .Ar branch
2322 d10218e7 2021-11-04 thomas and update files in the work tree accordingly.
2324 818c7501 2019-07-11 stsp The options for
2325 818c7501 2019-07-11 stsp .Cm got rebase
2326 818c7501 2019-07-11 stsp are as follows:
2327 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2329 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2330 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2332 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2333 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2335 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2336 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2337 e600f124 2021-03-21 stsp reference namespace.
2339 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2340 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2341 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2342 e600f124 2021-03-21 stsp Given these object IDs,
2344 e600f124 2021-03-21 stsp .Cm got log
2345 e600f124 2021-03-21 stsp command with the
2349 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2351 e600f124 2021-03-21 stsp .Cm got branch
2352 e600f124 2021-03-21 stsp command with the
2354 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2357 e600f124 2021-03-21 stsp .Ar branch
2358 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2360 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2362 e600f124 2021-03-21 stsp If this option is used,
2363 e600f124 2021-03-21 stsp .Cm got rebase
2364 e600f124 2021-03-21 stsp does not require a work tree.
2365 e600f124 2021-03-21 stsp None of the other options can be used together with
2368 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
2370 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
2371 643b85bc 2021-07-16 stsp reference namespace.
2374 643b85bc 2021-07-16 stsp .Ar branch
2375 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2376 643b85bc 2021-07-16 stsp this branch.
2377 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2378 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
2380 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2381 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2382 643b85bc 2021-07-16 stsp Git's garbage collector or
2383 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2385 643b85bc 2021-07-16 stsp If this option is used,
2386 643b85bc 2021-07-16 stsp .Cm got rebase
2387 643b85bc 2021-07-16 stsp does not require a work tree.
2388 643b85bc 2021-07-16 stsp None of the other options can be used together with
2393 56c96eff 2022-08-30 thomas .Cm histedit
2394 070c80a5 2023-01-31 thomas .Op Fl acdeflmX
2395 56c96eff 2022-08-30 thomas .Op Fl F Ar histedit-script
2396 56c96eff 2022-08-30 thomas .Op Ar branch
2398 d912d125 2021-11-04 thomas .Dl Pq alias: Cm he
2399 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
2400 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
2403 d4dddcbf 2022-07-22 thomas .Cm got histedit
2404 d4dddcbf 2022-07-22 thomas command requires the
2405 d4dddcbf 2022-07-22 thomas .Ev GOT_AUTHOR
2406 d4dddcbf 2022-07-22 thomas environment variable to be set,
2407 d4dddcbf 2022-07-22 thomas unless an author has been configured in
2408 d4dddcbf 2022-07-22 thomas .Xr got.conf 5
2409 d4dddcbf 2022-07-22 thomas or Git's
2410 d4dddcbf 2022-07-22 thomas .Dv user.name
2412 d4dddcbf 2022-07-22 thomas .Dv user.email
2413 d4dddcbf 2022-07-22 thomas configuration settings can be obtained from the repository's
2414 d4dddcbf 2022-07-22 thomas .Pa .git/config
2415 d4dddcbf 2022-07-22 thomas file or from Git's global
2416 d4dddcbf 2022-07-22 thomas .Pa ~/.gitconfig
2417 d4dddcbf 2022-07-22 thomas configuration file.
2419 6e54d307 2020-02-24 stsp Before starting a
2420 6e54d307 2020-02-24 stsp .Cm histedit
2421 4b06140e 2022-03-22 thomas operation, the work tree's current branch must be set with
2422 6e54d307 2020-02-24 stsp .Cm got update -b
2423 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
2424 6e54d307 2020-02-24 stsp current branch of the work tree.
2425 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
2426 6e54d307 2020-02-24 stsp touched by the
2427 6e54d307 2020-02-24 stsp .Cm histedit
2428 6e54d307 2020-02-24 stsp operation.
2430 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
2431 6e54d307 2020-02-24 stsp must be set with
2432 6e54d307 2020-02-24 stsp .Cm got update -c
2433 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
2434 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
2436 6e54d307 2020-02-24 stsp .Cm histedit
2437 6e54d307 2020-02-24 stsp operation.
2439 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
2440 0ebf8283 2019-07-24 stsp .Ar histedit script
2441 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
2442 46fa4c83 2020-02-24 stsp command line, or generated with the
2448 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
2449 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
2450 0ebf8283 2019-07-24 stsp whitespace and an argument.
2451 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
2452 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
2453 0ebf8283 2019-07-24 stsp Lines which begin with the
2455 0ebf8283 2019-07-24 stsp character are ignored entirely.
2457 f3a5718a 2022-07-12 thomas The available histedit script commands are as follows:
2458 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
2459 f3a5718a 2022-07-12 thomas .It Cm pick Ar commit Ta Use the specified commit as it is.
2460 f3a5718a 2022-07-12 thomas .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2461 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
2462 f3a5718a 2022-07-12 thomas .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2463 0ebf8283 2019-07-24 stsp listed further below that will be used.
2464 f3a5718a 2022-07-12 thomas .It Cm drop Ar commit Ta Remove this commit from the edited history.
2465 f3a5718a 2022-07-12 thomas .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2466 f3a5718a 2022-07-12 thomas a preceding
2467 f3a5718a 2022-07-12 thomas .Cm pick
2469 f3a5718a 2022-07-12 thomas .Cm edit
2470 f3a5718a 2022-07-12 thomas command on the previous line of the histedit script.
2471 eefbc049 2022-07-12 thomas The optional
2472 eefbc049 2022-07-12 thomas .Ar log-message
2473 eefbc049 2022-07-12 thomas argument provides a new single-line log message to use.
2475 eefbc049 2022-07-12 thomas .Ar log-message
2476 eefbc049 2022-07-12 thomas argument is omitted, open an editor where a new log message can be written.
2479 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
2480 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
2481 5b87815e 2020-03-05 stsp No commit may be listed more than once.
2483 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
2484 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
2485 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
2486 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
2487 498a90b7 2019-07-25 stsp switched to it.
2489 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
2490 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2491 e600f124 2021-03-21 stsp reference namespace.
2492 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
2493 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2494 e600f124 2021-03-21 stsp .Cm got histedit -l
2496 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2497 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2498 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2500 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
2501 0ebf8283 2019-07-24 stsp using the following status codes:
2502 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
2503 0ebf8283 2019-07-24 stsp .It G Ta file was merged
2504 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
2505 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
2506 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
2507 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2508 0ebf8283 2019-07-24 stsp .It A Ta new file was added
2509 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2510 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2513 4b06140e 2022-03-22 thomas If merge conflicts occur, the histedit operation is interrupted and may
2514 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
2515 dddbe150 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2516 dddbe150 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2517 dddbe150 2021-09-28 thomas the histedit operation will be interrupted to prevent potentially incomplete
2518 dddbe150 2021-09-28 thomas changes from being committed to the repository without user intervention.
2519 dddbe150 2021-09-28 thomas The work tree may be modified as desired and the histedit operation can be
2520 dddbe150 2021-09-28 thomas continued once the changes present in the work tree are considered complete.
2521 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
2522 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
2524 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
2525 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
2526 0ebf8283 2019-07-24 stsp when the histedit operation continues.
2528 0ebf8283 2019-07-24 stsp .Cm got histedit
2529 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
2530 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
2531 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
2532 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
2533 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2534 0ebf8283 2019-07-24 stsp to a single base commit with
2535 0ebf8283 2019-07-24 stsp .Cm got update .
2536 4ed9f614 2019-08-04 stsp If changes have been staged with
2537 4ed9f614 2019-08-04 stsp .Cm got stage ,
2538 bc3056e3 2019-08-18 stsp these changes must first be committed with
2539 4ed9f614 2019-08-04 stsp .Cm got commit
2540 4ed9f614 2019-08-04 stsp or unstaged with
2541 4ed9f614 2019-08-04 stsp .Cm got unstage .
2542 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
2543 0ebf8283 2019-07-24 stsp committed with
2544 0ebf8283 2019-07-24 stsp .Cm got commit
2545 0ebf8283 2019-07-24 stsp or reverted with
2546 0ebf8283 2019-07-24 stsp .Cm got revert .
2547 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
2548 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
2551 7ef62c4e 2020-02-24 stsp .Cm got update ,
2552 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
2553 8bcebf69 2023-01-08 thomas .Cm got merge ,
2555 65db4ffb 2020-02-24 stsp .Cm got integrate
2556 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
2557 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
2558 0ebf8283 2019-07-24 stsp .Cm got commit
2559 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
2560 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
2562 0ebf8283 2019-07-24 stsp The options for
2563 0ebf8283 2019-07-24 stsp .Cm got histedit
2564 0ebf8283 2019-07-24 stsp are as follows:
2565 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
2567 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
2568 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2570 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
2571 070c80a5 2023-01-31 thomas If this option is used, no other command-line arguments are allowed.
2572 070c80a5 2023-01-31 thomas .It Fl d
2573 070c80a5 2023-01-31 thomas Drop all commits.
2574 070c80a5 2023-01-31 thomas This option is a quick equivalent to a histedit script which drops all
2575 070c80a5 2023-01-31 thomas commits.
2578 070c80a5 2023-01-31 thomas option can only be used when starting a new histedit operation.
2579 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2580 c50a7455 2021-10-04 thomas .It Fl e
2581 c50a7455 2021-10-04 thomas Interrupt the histedit operation for editing after merging each commit.
2582 c50a7455 2021-10-04 thomas This option is a quick equivalent to a histedit script which uses the
2583 c50a7455 2021-10-04 thomas .Cm edit
2584 c50a7455 2021-10-04 thomas command for all commits.
2587 c50a7455 2021-10-04 thomas option can only be used when starting a new histedit operation.
2588 c50a7455 2021-10-04 thomas If this option is used, no other command-line arguments are allowed.
2589 d6506a3d 2022-08-16 thomas .It Fl F Ar histedit-script
2590 d6506a3d 2022-08-16 thomas Use the specified
2591 d6506a3d 2022-08-16 thomas .Ar histedit-script
2592 d6506a3d 2022-08-16 thomas instead of opening a temporary file in an editor where a histedit script
2593 d6506a3d 2022-08-16 thomas can be written.
2595 466785b9 2020-12-10 jrick Fold all commits into a single commit.
2596 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
2597 466785b9 2020-12-10 jrick commits, combining them all into one commit.
2600 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
2601 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
2603 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
2604 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2605 e600f124 2021-03-21 stsp reference namespace.
2607 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2608 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
2609 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2610 e600f124 2021-03-21 stsp Given these object IDs,
2612 e600f124 2021-03-21 stsp .Cm got log
2613 e600f124 2021-03-21 stsp command with the
2617 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2619 e600f124 2021-03-21 stsp .Cm got branch
2620 e600f124 2021-03-21 stsp command with the
2622 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
2625 e600f124 2021-03-21 stsp .Ar branch
2626 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2628 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2630 e600f124 2021-03-21 stsp If this option is used,
2631 e600f124 2021-03-21 stsp .Cm got histedit
2632 e600f124 2021-03-21 stsp does not require a work tree.
2633 e600f124 2021-03-21 stsp None of the other options can be used together with
2635 d6506a3d 2022-08-16 thomas .It Fl m
2636 d6506a3d 2022-08-16 thomas Edit log messages only.
2637 d6506a3d 2022-08-16 thomas This option is a quick equivalent to a histedit script which edits
2638 d6506a3d 2022-08-16 thomas only log messages but otherwise leaves every picked commit as-is.
2641 d6506a3d 2022-08-16 thomas option can only be used when starting a new histedit operation.
2642 d6506a3d 2022-08-16 thomas If this option is used, no other command-line arguments are allowed.
2644 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
2646 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
2647 643b85bc 2021-07-16 stsp reference namespace.
2650 643b85bc 2021-07-16 stsp .Ar branch
2651 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2652 643b85bc 2021-07-16 stsp this branch.
2653 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2654 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
2656 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2657 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2658 643b85bc 2021-07-16 stsp Git's garbage collector or
2659 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2661 643b85bc 2021-07-16 stsp If this option is used,
2662 643b85bc 2021-07-16 stsp .Cm got histedit
2663 643b85bc 2021-07-16 stsp does not require a work tree.
2664 643b85bc 2021-07-16 stsp None of the other options can be used together with
2668 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
2669 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ig
2670 2822a352 2019-10-15 stsp Integrate the specified
2671 2822a352 2019-10-15 stsp .Ar branch
2672 2822a352 2019-10-15 stsp into the work tree's current branch.
2673 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
2674 2822a352 2019-10-15 stsp .Ar branch ,
2675 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
2676 2822a352 2019-10-15 stsp head commit of the integrated
2677 2822a352 2019-10-15 stsp .Ar branch .
2679 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
2680 2822a352 2019-10-15 stsp will be pointing at the same commit.
2681 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
2682 2822a352 2019-10-15 stsp In case the integrated
2683 2822a352 2019-10-15 stsp .Ar branch
2684 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
2685 2822a352 2019-10-15 stsp .Cm got branch -d .
2687 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
2688 2822a352 2019-10-15 stsp .Bl -column YXZ description
2689 2822a352 2019-10-15 stsp .It U Ta file was updated
2690 2822a352 2019-10-15 stsp .It D Ta file was deleted
2691 2822a352 2019-10-15 stsp .It A Ta new file was added
2692 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
2693 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
2696 2822a352 2019-10-15 stsp .Cm got integrate
2697 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
2698 2822a352 2019-10-15 stsp Most importantly, the
2699 2822a352 2019-10-15 stsp .Ar branch
2700 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
2701 2822a352 2019-10-15 stsp .Cm got rebase
2702 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
2703 2822a352 2019-10-15 stsp resolve merge conflicts.
2704 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2705 2822a352 2019-10-15 stsp to a single base commit with
2706 2822a352 2019-10-15 stsp .Cm got update .
2707 2822a352 2019-10-15 stsp If changes have been staged with
2708 2822a352 2019-10-15 stsp .Cm got stage ,
2709 2822a352 2019-10-15 stsp these changes must first be committed with
2710 2822a352 2019-10-15 stsp .Cm got commit
2711 2822a352 2019-10-15 stsp or unstaged with
2712 2822a352 2019-10-15 stsp .Cm got unstage .
2713 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
2714 2822a352 2019-10-15 stsp committed with
2715 2822a352 2019-10-15 stsp .Cm got commit
2716 2822a352 2019-10-15 stsp or reverted with
2717 2822a352 2019-10-15 stsp .Cm got revert .
2720 56c96eff 2022-08-30 thomas .Cm merge
2721 56c96eff 2022-08-30 thomas .Op Fl acn
2722 56c96eff 2022-08-30 thomas .Op Ar branch
2724 d912d125 2021-11-04 thomas .Dl Pq alias: Cm mg
2725 10604dce 2021-09-24 thomas Create a merge commit based on the current branch of the work tree and
2726 10604dce 2021-09-24 thomas the specified
2727 10604dce 2021-09-24 thomas .Ar branch .
2728 10604dce 2021-09-24 thomas If a linear project history is desired, then use of
2729 10604dce 2021-09-24 thomas .Cm got rebase
2730 10604dce 2021-09-24 thomas should be preferred over
2731 10604dce 2021-09-24 thomas .Cm got merge .
2732 10604dce 2021-09-24 thomas However, even strictly linear projects may require merge commits in order
2733 768705e3 2021-09-27 thomas to merge in new versions of third-party code stored on vendor branches
2734 768705e3 2021-09-27 thomas created with
2735 768705e3 2021-09-27 thomas .Cm got import .
2737 10604dce 2021-09-24 thomas Merge commits are commits based on multiple parent commits.
2738 10604dce 2021-09-24 thomas The tip commit of the work tree's current branch, which must be set with
2739 10604dce 2021-09-24 thomas .Cm got update -b
2740 10604dce 2021-09-24 thomas before starting the
2741 10604dce 2021-09-24 thomas .Cm merge
2742 10604dce 2021-09-24 thomas operation, will be used as the first parent.
2743 10604dce 2021-09-24 thomas The tip commit of the specified
2744 10604dce 2021-09-24 thomas .Ar branch
2745 10604dce 2021-09-24 thomas will be used as the second parent.
2747 768705e3 2021-09-27 thomas No ancestral relationship between the two branches is required.
2748 768705e3 2021-09-27 thomas If the two branches have already been merged previously, only new changes
2749 768705e3 2021-09-27 thomas will be merged.
2751 10604dce 2021-09-24 thomas It is not possible to create merge commits with more than two parents.
2752 10604dce 2021-09-24 thomas If more than one branch needs to be merged, then multiple merge commits
2753 10604dce 2021-09-24 thomas with two parents each can be created in sequence.
2755 10604dce 2021-09-24 thomas While merging changes found on the
2756 10604dce 2021-09-24 thomas .Ar branch
2757 10604dce 2021-09-24 thomas into the work tree, show the status of each affected file,
2758 10604dce 2021-09-24 thomas using the following status codes:
2759 10604dce 2021-09-24 thomas .Bl -column YXZ description
2760 10604dce 2021-09-24 thomas .It G Ta file was merged
2761 10604dce 2021-09-24 thomas .It C Ta file was merged and conflicts occurred during merge
2762 10604dce 2021-09-24 thomas .It ! Ta changes destined for a missing file were not merged
2763 10604dce 2021-09-24 thomas .It D Ta file was deleted
2764 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2765 10604dce 2021-09-24 thomas .It A Ta new file was added
2766 10604dce 2021-09-24 thomas .It \(a~ Ta changes destined for a non-regular file were not merged
2767 10604dce 2021-09-24 thomas .It ? Ta changes destined for an unversioned file were not merged
2770 10604dce 2021-09-24 thomas If merge conflicts occur, the merge operation is interrupted and conflicts
2771 10604dce 2021-09-24 thomas must be resolved before the merge operation can continue.
2772 8cf2970b 2021-09-28 thomas If any files with destined changes are found to be missing or unversioned,
2773 8cf2970b 2021-09-28 thomas or if files could not be deleted due to differences in deleted content,
2774 10604dce 2021-09-24 thomas the merge operation will be interrupted to prevent potentially incomplete
2775 10604dce 2021-09-24 thomas changes from being committed to the repository without user intervention.
2776 10604dce 2021-09-24 thomas The work tree may be modified as desired and the merge can be continued
2777 10604dce 2021-09-24 thomas once the changes present in the work tree are considered complete.
2778 10604dce 2021-09-24 thomas Alternatively, the merge operation may be aborted which will leave
2779 10604dce 2021-09-24 thomas the work tree's current branch unmodified.
2781 10604dce 2021-09-24 thomas If a merge conflict is resolved in a way which renders all merged
2782 10604dce 2021-09-24 thomas changes into no-op changes, the merge operation cannot continue
2783 10604dce 2021-09-24 thomas and must be aborted.
2785 10604dce 2021-09-24 thomas .Cm got merge
2786 10604dce 2021-09-24 thomas will refuse to run if certain preconditions are not met.
2787 10604dce 2021-09-24 thomas If history of the
2788 10604dce 2021-09-24 thomas .Ar branch
2789 10604dce 2021-09-24 thomas is based on the work tree's current branch, then no merge commit can
2790 10604dce 2021-09-24 thomas be created and
2791 10604dce 2021-09-24 thomas .Cm got integrate
2792 10604dce 2021-09-24 thomas may be used to integrate the
2793 10604dce 2021-09-24 thomas .Ar branch
2794 10604dce 2021-09-24 thomas instead.
2795 10604dce 2021-09-24 thomas If the work tree is not yet fully updated to the tip commit of its
2796 10604dce 2021-09-24 thomas branch, then the work tree must first be updated with
2797 10604dce 2021-09-24 thomas .Cm got update .
2798 4b06140e 2022-03-22 thomas If the work tree contains multiple base commits, it must first be updated
2799 10604dce 2021-09-24 thomas to a single base commit with
2800 10604dce 2021-09-24 thomas .Cm got update .
2801 10604dce 2021-09-24 thomas If changes have been staged with
2802 10604dce 2021-09-24 thomas .Cm got stage ,
2803 10604dce 2021-09-24 thomas these changes must first be committed with
2804 10604dce 2021-09-24 thomas .Cm got commit
2805 10604dce 2021-09-24 thomas or unstaged with
2806 10604dce 2021-09-24 thomas .Cm got unstage .
2807 10604dce 2021-09-24 thomas If the work tree contains local changes, these changes must first be
2808 10604dce 2021-09-24 thomas committed with
2809 10604dce 2021-09-24 thomas .Cm got commit
2810 10604dce 2021-09-24 thomas or reverted with
2811 10604dce 2021-09-24 thomas .Cm got revert .
2813 10604dce 2021-09-24 thomas .Ar branch
2814 10604dce 2021-09-24 thomas contains changes to files outside of the work tree's path prefix,
2815 10604dce 2021-09-24 thomas the work tree cannot be used to merge this branch.
2818 10604dce 2021-09-24 thomas .Cm got update ,
2819 10604dce 2021-09-24 thomas .Cm got commit ,
2820 10604dce 2021-09-24 thomas .Cm got rebase ,
2821 ac93b2c5 2021-10-08 thomas .Cm got histedit ,
2822 10604dce 2021-09-24 thomas .Cm got integrate ,
2824 10604dce 2021-09-24 thomas .Cm got stage
2825 10604dce 2021-09-24 thomas commands will refuse to run while a merge operation is in progress.
2826 10604dce 2021-09-24 thomas Other commands which manipulate the work tree may be used for
2827 10604dce 2021-09-24 thomas conflict resolution purposes.
2829 10604dce 2021-09-24 thomas The options for
2830 10604dce 2021-09-24 thomas .Cm got merge
2831 10604dce 2021-09-24 thomas are as follows:
2832 10604dce 2021-09-24 thomas .Bl -tag -width Ds
2833 10604dce 2021-09-24 thomas .It Fl a
2834 10604dce 2021-09-24 thomas Abort an interrupted merge operation.
2835 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
2836 10604dce 2021-09-24 thomas .It Fl c
2837 10604dce 2021-09-24 thomas Continue an interrupted merge operation.
2838 10604dce 2021-09-24 thomas If this option is used, no other command-line arguments are allowed.
2839 ba34626b 2021-09-27 thomas .It Fl n
2840 ba34626b 2021-09-27 thomas Merge changes into the work tree as usual but do not create a merge
2841 ba34626b 2021-09-27 thomas commit immediately.
2842 ba34626b 2021-09-27 thomas The merge result can be adjusted as desired before a merge commit is
2843 ba34626b 2021-09-27 thomas created with
2844 ba34626b 2021-09-27 thomas .Cm got merge -c .
2845 ba34626b 2021-09-27 thomas Alternatively, the merge may be aborted with
2846 ba34626b 2021-09-27 thomas .Cm got merge -a .
2850 56c96eff 2022-08-30 thomas .Cm stage
2851 56c96eff 2022-08-30 thomas .Op Fl lpS
2852 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
2853 56c96eff 2022-08-30 thomas .Op Ar path ...
2855 d912d125 2021-11-04 thomas .Dl Pq alias: Cm sg
2856 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
2859 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
2860 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
2861 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
2862 4ed9f614 2019-08-04 stsp .Cm got status .
2864 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2865 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
2866 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
2867 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
2868 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
2871 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
2872 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
2873 9d8b19a4 2019-08-04 stsp committed.
2875 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
2876 4ed9f614 2019-08-04 stsp .Cm got commit ,
2877 4ed9f614 2019-08-04 stsp .Cm got status ,
2879 4ed9f614 2019-08-04 stsp .Cm got diff .
2880 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
2881 4ed9f614 2019-08-04 stsp .Cm got commit
2882 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
2883 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
2884 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
2886 4ed9f614 2019-08-04 stsp .Cm got status
2887 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
2889 4ed9f614 2019-08-04 stsp .Cm got diff
2890 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
2891 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
2893 4ed9f614 2019-08-04 stsp .Cm got revert
2894 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
2895 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
2897 4ed9f614 2019-08-04 stsp The options for
2898 4ed9f614 2019-08-04 stsp .Cm got stage
2899 4ed9f614 2019-08-04 stsp are as follows:
2900 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
2901 d6506a3d 2022-08-16 thomas .It Fl F Ar response-script
2902 d6506a3d 2022-08-16 thomas With the
2904 d6506a3d 2022-08-16 thomas option, read
2909 d6506a3d 2022-08-16 thomas responses line-by-line from the specified
2910 d6506a3d 2022-08-16 thomas .Ar response-script
2911 d6506a3d 2022-08-16 thomas file instead of prompting interactively.
2913 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
2914 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
2915 4b06140e 2022-03-22 thomas If paths were provided on the command line, show the staged paths
2916 1dd86744 2019-08-12 anthony among the specified paths.
2917 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
2919 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
2920 dc424a06 2019-08-07 stsp select or reject changes for staging based on
2922 6d23ec10 2019-08-08 stsp (stage change),
2924 6d23ec10 2019-08-08 stsp (reject change), and
2926 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
2927 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
2928 dc424a06 2019-08-07 stsp modified file content can be staged.
2929 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
2930 6d23ec10 2019-08-08 stsp their entirety.
2932 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
2933 af358f55 2020-07-23 stsp that is under version control.
2934 af358f55 2020-07-23 stsp By default,
2935 af358f55 2020-07-23 stsp .Cm got stage
2936 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2937 35213c7c 2020-07-23 stsp As a precaution,
2939 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2940 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2941 af358f55 2020-07-23 stsp points outside of the work tree.
2942 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2943 af358f55 2020-07-23 stsp .Dq make obj
2944 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2945 af358f55 2020-07-23 stsp version control.
2948 4ed9f614 2019-08-04 stsp .Cm got stage
2949 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
2950 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
2951 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
2952 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
2953 4ed9f614 2019-08-04 stsp .Cm got update
2954 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
2955 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
2958 4ed9f614 2019-08-04 stsp .Cm got update ,
2959 4ed9f614 2019-08-04 stsp .Cm got rebase ,
2961 4ed9f614 2019-08-04 stsp .Cm got histedit
2962 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
2963 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
2964 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
2965 4ed9f614 2019-08-04 stsp .Cm got unstage
2966 4ed9f614 2019-08-04 stsp before it can be updated with
2967 4ed9f614 2019-08-04 stsp .Cm got update ,
2968 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
2971 56c96eff 2022-08-30 thomas .Cm unstage
2972 56c96eff 2022-08-30 thomas .Op Fl p
2973 56c96eff 2022-08-30 thomas .Op Fl F Ar response-script
2974 56c96eff 2022-08-30 thomas .Op Ar path ...
2976 d912d125 2021-11-04 thomas .Dl Pq alias: Cm ug
2977 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
2978 4ed9f614 2019-08-04 stsp back into non-staged status.
2981 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
2982 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
2984 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2985 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
2986 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
2987 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
2988 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
2989 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
2990 df3d7c3e 2021-09-24 thomas .It d Ta file's deletion was prevented by local modifications
2991 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2994 2e1f37b0 2019-08-08 stsp The options for
2995 2e1f37b0 2019-08-08 stsp .Cm got unstage
2996 2e1f37b0 2019-08-08 stsp are as follows:
2997 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
2998 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
3001 2e1f37b0 2019-08-08 stsp option, read
3006 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
3007 2e1f37b0 2019-08-08 stsp .Ar response-script
3008 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
3009 d6506a3d 2022-08-16 thomas .It Fl p
3010 d6506a3d 2022-08-16 thomas Instead of unstaging the entire content of a changed file, interactively
3011 d6506a3d 2022-08-16 thomas select or reject changes for unstaging based on
3013 d6506a3d 2022-08-16 thomas (unstage change),
3015 d6506a3d 2022-08-16 thomas (keep change staged), and
3017 d6506a3d 2022-08-16 thomas (quit unstaging this file) responses.
3018 d6506a3d 2022-08-16 thomas If a file is staged in modified status, individual patches derived from the
3019 d6506a3d 2022-08-16 thomas staged file content can be unstaged.
3020 d6506a3d 2022-08-16 thomas Files staged in added or deleted status may only be unstaged in their entirety.
3024 56c96eff 2022-08-30 thomas .Op Fl P
3025 56c96eff 2022-08-30 thomas .Op Fl c Ar commit
3026 56c96eff 2022-08-30 thomas .Op Fl r Ar repository-path
3027 56c96eff 2022-08-30 thomas .Ar arg ...
3029 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3030 896e9b6f 2019-08-26 stsp text format.
3031 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3032 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3033 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3035 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3036 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3037 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3038 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3039 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3040 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3042 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3044 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3045 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3047 01073a5d 2019-08-22 stsp The options for
3048 01073a5d 2019-08-22 stsp .Cm got cat
3049 01073a5d 2019-08-22 stsp are as follows:
3050 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3051 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3052 896e9b6f 2019-08-26 stsp Look up paths in the specified
3053 896e9b6f 2019-08-26 stsp .Ar commit .
3054 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3055 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3056 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
3057 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
3058 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3059 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3060 d6506a3d 2022-08-16 thomas .It Fl P
3061 d6506a3d 2022-08-16 thomas Interpret all arguments as paths only.
3062 d6506a3d 2022-08-16 thomas This option can be used to resolve ambiguity in cases where paths
3063 d6506a3d 2022-08-16 thomas look like tag names, reference names, or object IDs.
3064 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3065 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3066 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3067 01073a5d 2019-08-22 stsp working directory.
3068 01073a5d 2019-08-22 stsp If this directory is a
3070 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3072 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3073 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3075 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3076 b2118c49 2020-07-28 stsp for details.
3078 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3079 b2118c49 2020-07-28 stsp current working directory.
3081 b2118c49 2020-07-28 stsp If one or more
3083 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3084 b2118c49 2020-07-28 stsp files located at or within these paths.
3087 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3088 b2118c49 2020-07-28 stsp for all tracked files.
3090 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3091 5daf5c53 2022-07-23 thomas .Bl -tag -width GOT_IGNORE_GITCONFIG
3092 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3093 d4dddcbf 2022-07-22 thomas The author's name and email address, such as
3094 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3095 d4dddcbf 2022-07-22 thomas Used by the
3096 d4dddcbf 2022-07-22 thomas .Cm got commit ,
3097 d4dddcbf 2022-07-22 thomas .Cm got import ,
3098 d4dddcbf 2022-07-22 thomas .Cm got rebase ,
3100 d4dddcbf 2022-07-22 thomas .Cm got histedit
3101 d4dddcbf 2022-07-22 thomas commands.
3104 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3106 84792843 2019-08-09 stsp attempts to reject
3107 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3108 84792843 2019-08-09 stsp environment variables with a missing email address.
3110 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3111 50b0790e 2020-09-11 stsp .Xr got.conf 5
3112 50b0790e 2020-09-11 stsp or by Git's
3113 aba9c984 2019-09-08 stsp .Dv user.name
3115 709ae9eb 2019-09-08 stsp .Dv user.email
3116 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3117 aba9c984 2019-09-08 stsp .Pa .git/config
3120 c9956ddf 2019-09-08 stsp .Dv user.name
3122 c9956ddf 2019-09-08 stsp .Dv user.email
3123 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3124 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3125 257add31 2020-09-09 stsp configuration file will only be used if neither
3126 257add31 2020-09-09 stsp .Xr got.conf 5
3128 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3129 257add31 2020-09-09 stsp environment variable provide author information.
3130 bd15e874 2023-01-20 thomas .It Ev GOT_IGNORE_GITCONFIG
3131 bd15e874 2023-01-20 thomas If this variable is set then any remote repository definitions or author
3132 bd15e874 2023-01-20 thomas information found in Git configuration files will be ignored.
3133 bd15e874 2023-01-20 thomas .It Ev GOT_LOG_DEFAULT_LIMIT
3134 bd15e874 2023-01-20 thomas The default limit on the number of commits traversed by
3135 bd15e874 2023-01-20 thomas .Cm got log .
3136 bd15e874 2023-01-20 thomas If set to zero, the limit is unbounded.
3137 bd15e874 2023-01-20 thomas This variable will be silently ignored if it is set to a non-numeric value.
3138 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3139 23594da9 2019-05-13 stsp The editor spawned by
3140 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3141 46215d2a 2020-09-11 stsp .Cm got histedit ,
3142 8e7bd50a 2019-08-22 stsp .Cm got import ,
3144 8e7bd50a 2019-08-22 stsp .Cm got tag .
3145 5b735925 2020-09-15 stsp If not set, the
3147 5b735925 2020-09-15 stsp text editor will be spawned in order to give
3149 5b735925 2020-09-15 stsp the attention it deserves.
3152 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3153 257add31 2020-09-09 stsp .It Pa got.conf
3154 257add31 2020-09-09 stsp Repository-wide configuration settings for
3156 50b0790e 2020-09-11 stsp If present, a
3157 50b0790e 2020-09-11 stsp .Xr got.conf 5
3158 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3159 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3160 257add31 2020-09-09 stsp .Pa config
3163 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3164 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3166 50b0790e 2020-09-11 stsp If present, a
3167 1795b260 2021-04-02 kn .Xr got.conf 5
3168 50b0790e 2020-09-11 stsp configuration file in the
3170 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3171 50b0790e 2020-09-11 stsp the repository's
3172 50b0790e 2020-09-11 stsp .Xr got.conf 5
3173 50b0790e 2020-09-11 stsp configuration file and Git's
3174 50b0790e 2020-09-11 stsp .Pa config
3177 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3178 5c860e29 2018-03-12 stsp .Ex -std got
3179 97925469 2018-03-17 stsp .Sh EXAMPLES
3180 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3182 43e4eb1b 2021-08-29 stsp command names in
3183 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3185 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3187 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3190 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3191 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3193 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
3194 fa6e0e48 2019-05-23 stsp .Xr git 1 :
3196 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3197 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
3199 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3201 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3202 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3203 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3205 27b10c3c 2022-07-04 thomas .Dl $ gotadmin init /var/git/src.git
3206 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3208 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3210 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3212 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3214 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3216 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3218 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3220 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3222 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3224 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3226 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3228 7fc94106 2023-01-14 thomas As above, but list the most recently modified branches only:
3230 7fc94106 2023-01-14 thomas .Dl $ got branch -lt | head
3232 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3233 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3234 d83d9d5c 2019-05-13 stsp which is forked off the
3235 d83d9d5c 2019-05-13 stsp .Dq master
3238 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3240 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3241 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3242 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3244 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3246 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3247 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3249 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3251 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3252 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3253 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3255 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3257 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3258 04e9dcf3 2020-04-18 stsp .Xr patch 1
3259 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3261 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3263 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3265 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3267 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3268 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3269 5b666081 2020-02-24 stsp .Pa sys/uvm :
3271 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3273 5b666081 2020-02-24 stsp And this command has the same effect:
3275 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3277 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3279 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3280 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3282 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3284 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3285 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3287 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
3288 e70c17ce 2019-05-22 stsp with a pre-defined log message.
3290 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
3292 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
3293 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
3294 1795b260 2021-04-02 kn .Pa /tmp/msg :
3296 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
3298 95fc3404 2019-07-15 stsp Update any work tree checked out from the
3299 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
3300 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
3302 95fc3404 2019-07-15 stsp .Dl $ got update
3304 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
3305 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
3306 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
3308 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3309 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
3310 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
3311 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3313 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
3314 a099809f 2021-08-27 stsp .Dq master
3315 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
3316 469dd726 2020-03-20 stsp .Dq origin/master
3319 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3320 469dd726 2020-03-20 stsp .Dl $ got fetch
3322 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
3323 469dd726 2020-03-20 stsp .Cm git clone --bare
3325 469dd726 2020-03-20 stsp .Xr git-fetch 1
3326 469dd726 2020-03-20 stsp command must be used instead:
3328 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
3329 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
3331 469dd726 2020-03-20 stsp Rebase the local
3332 469dd726 2020-03-20 stsp .Dq master
3333 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
3334 469dd726 2020-03-20 stsp .Dq origin/master
3337 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3338 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
3339 469dd726 2020-03-20 stsp .Dl $ got rebase master
3341 fa6e0e48 2019-05-23 stsp Rebase the
3342 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
3343 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
3344 fa6e0e48 2019-05-23 stsp .Dq master
3347 818c7501 2019-07-11 stsp .Dl $ got update -b master
3348 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
3350 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
3351 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
3352 1dd86744 2019-08-12 anthony .Ox Ns 's
3353 1dd86744 2019-08-12 anthony CVS tree:
3355 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3357 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
3358 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
3361 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
3362 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
3363 0ebf8283 2019-07-24 stsp .Dl $ got histedit
3365 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
3366 469dd726 2020-03-20 stsp .Cm git clone --bare
3367 7848a0e1 2020-03-19 stsp instead of
3368 7848a0e1 2020-03-19 stsp .Cm got clone ,
3370 ff2cf171 2019-07-28 stsp .Dq refspec
3371 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
3373 ff2cf171 2019-07-28 stsp .Dq refs/remotes
3374 ff2cf171 2019-07-28 stsp namespace of the local repository.
3375 1795b260 2021-04-02 kn This can be achieved by setting Git's
3376 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
3377 ff2cf171 2019-07-28 stsp configuration variable to the value
3378 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
3380 ff2cf171 2019-07-28 stsp .Cm git config
3383 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
3384 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3386 469dd726 2020-03-20 stsp Additionally, the
3387 469dd726 2020-03-20 stsp .Dq mirror
3388 469dd726 2020-03-20 stsp option must be disabled:
3390 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
3391 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
3393 ff2cf171 2019-07-28 stsp Alternatively, the following
3394 469dd726 2020-03-20 stsp .Xr git-fetch 1
3395 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
3396 ff2cf171 2019-07-28 stsp .Pa config
3399 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
3400 ff2cf171 2019-07-28 stsp .Dl url = ...
3401 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3402 469dd726 2020-03-20 stsp .Dl mirror = false
3404 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
3405 ff2cf171 2019-07-28 stsp .Dq refs/heads
3406 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
3407 ff2cf171 2019-07-28 stsp .Cm got checkout
3408 ff2cf171 2019-07-28 stsp and, if needed, created with
3409 ff2cf171 2019-07-28 stsp .Cm got branch .
3410 ff2cf171 2019-07-28 stsp Branches in the
3411 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
3412 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
3413 ff2cf171 2019-07-28 stsp repository with
3414 469dd726 2020-03-20 stsp .Cm got fetch
3416 469dd726 2020-03-20 stsp .Xr git-fetch 1
3417 a099809f 2021-08-27 stsp without extra command line arguments.
3418 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
3419 a099809f 2021-08-27 stsp .Cm got log .
3421 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
3422 ff2cf171 2019-07-28 stsp .Dq master
3423 a099809f 2021-08-27 stsp branch, as of the last time
3424 a099809f 2021-08-27 stsp .Cm got fetch
3427 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
3429 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
3430 ff2cf171 2019-07-28 stsp .Dq origin/master
3431 a099809f 2021-08-27 stsp instead of
3432 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
3433 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
3435 a099809f 2021-08-27 stsp .Cm got rebase
3436 a099809f 2021-08-27 stsp must be used to merge changes which are visible on the
3437 a099809f 2021-08-27 stsp .Dq origin/master
3438 a099809f 2021-08-27 stsp branch into the
3439 a099809f 2021-08-27 stsp .Dq master
3441 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
3443 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
3444 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
3446 a099809f 2021-08-27 stsp In order to make changes committed to the
3447 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3448 a099809f 2021-08-27 stsp visible on the
3449 a099809f 2021-08-27 stsp .Dq master
3450 a099809f 2021-08-27 stsp branch, the
3451 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3452 a099809f 2021-08-27 stsp branch must first be rebased onto the
3453 a099809f 2021-08-27 stsp .Dq master
3456 a099809f 2021-08-27 stsp .Dl $ got update -b master
3457 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
3459 a099809f 2021-08-27 stsp Changes on the
3460 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3461 a099809f 2021-08-27 stsp branch can now be made visible on the
3462 a099809f 2021-08-27 stsp .Dq master
3463 a099809f 2021-08-27 stsp branch with
3464 a099809f 2021-08-27 stsp .Cm got integrate .
3465 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
3466 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3467 4b06140e 2022-03-22 thomas branch, the work tree must be switched back to the
3468 a099809f 2021-08-27 stsp .Dq master
3469 a099809f 2021-08-27 stsp branch first:
3471 a099809f 2021-08-27 stsp .Dl $ got update -b master
3472 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
3475 083957f4 2020-02-24 stsp .Dq master
3476 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
3478 083957f4 2020-02-24 stsp by other developers and any other important new information:
3480 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
3481 083957f4 2020-02-24 stsp .Dl $ got histedit -m
3483 4b06140e 2022-03-22 thomas If the remote repository offers write access, local changes on the
3484 ff2cf171 2019-07-28 stsp .Dq master
3485 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
3486 ac93b2c5 2021-10-08 thomas .Cm got send .
3487 ac93b2c5 2021-10-08 thomas Usually,
3488 a099809f 2021-08-27 stsp .Cm got send
3489 a099809f 2021-08-27 stsp can be run without further arguments.
3490 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
3491 a099809f 2021-08-27 stsp current branch is the
3492 a099809f 2021-08-27 stsp .Dq master
3495 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
3497 4b06140e 2022-03-22 thomas If the remote repository requires the HTTPS protocol, the
3498 a099809f 2021-08-27 stsp .Xr git-push 1
3499 a099809f 2021-08-27 stsp command must be used instead:
3501 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
3502 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
3504 4ff74dcf 2022-07-20 thomas When making contributions to projects which use the
3505 4ff74dcf 2022-07-20 thomas .Dq pull request
3506 4ff74dcf 2022-07-20 thomas workflow, SSH protocol repository access needs to be set up first.
3507 4ff74dcf 2022-07-20 thomas Once an account has been created on a Git hosting site it should
3508 4ff74dcf 2022-07-20 thomas be possible to upload a public SSH key for repository access
3509 4ff74dcf 2022-07-20 thomas authentication.
3512 4ff74dcf 2022-07-20 thomas .Dq pull request
3513 4ff74dcf 2022-07-20 thomas workflow will usually involve two remote repositories.
3514 4ff74dcf 2022-07-20 thomas In the real-life example below, the
3515 4ff74dcf 2022-07-20 thomas .Dq origin
3516 4ff74dcf 2022-07-20 thomas repository was forked from the
3517 4ff74dcf 2022-07-20 thomas .Dq upstream
3518 4ff74dcf 2022-07-20 thomas repository by using the Git hosting site's web interface.
3520 4ff74dcf 2022-07-20 thomas .Xr got.conf 5
3521 4ff74dcf 2022-07-20 thomas file in the local repository describes both remote repositories:
3522 4ff74dcf 2022-07-20 thomas .Bd -literal -offset indent
3523 4ff74dcf 2022-07-20 thomas # Jelmers's repository, which accepts pull requests
3524 4ff74dcf 2022-07-20 thomas remote "upstream" {
3525 4ff74dcf 2022-07-20 thomas server git@github.com
3526 4ff74dcf 2022-07-20 thomas protocol ssh
3527 4ff74dcf 2022-07-20 thomas repository "/jelmer/dulwich"
3528 4ff74dcf 2022-07-20 thomas branch { "master" }
3531 4ff74dcf 2022-07-20 thomas # Stefan's fork, used as the default remote repository
3532 4ff74dcf 2022-07-20 thomas remote "origin" {
3533 4ff74dcf 2022-07-20 thomas server git@github.com
3534 4ff74dcf 2022-07-20 thomas protocol ssh
3535 4ff74dcf 2022-07-20 thomas repository "/stspdotname/dulwich"
3536 4ff74dcf 2022-07-20 thomas branch { "master" }
3540 4ff74dcf 2022-07-20 thomas With this configuration, Stefan can create commits on
3541 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master
3542 4ff74dcf 2022-07-20 thomas and send them to the
3543 4ff74dcf 2022-07-20 thomas .Dq origin
3544 4ff74dcf 2022-07-20 thomas repository by running:
3546 4ff74dcf 2022-07-20 thomas .Dl $ got send -b master origin
3548 4ff74dcf 2022-07-20 thomas The changes can now be proposed to Jelmer by opening a pull request
3549 4ff74dcf 2022-07-20 thomas via the Git hosting site's web interface.
3550 4ff74dcf 2022-07-20 thomas If Jelmer requests further changes to be made, additional commits
3551 4ff74dcf 2022-07-20 thomas can be created on the
3552 4ff74dcf 2022-07-20 thomas .Dq master
3553 4ff74dcf 2022-07-20 thomas branch and be added to the pull request by running
3554 4ff74dcf 2022-07-20 thomas .Cd got send
3557 4ff74dcf 2022-07-20 thomas If Jelmer prefers additional commits to be
3558 4ff74dcf 2022-07-20 thomas .Dq squashed
3559 4ff74dcf 2022-07-20 thomas then the following commands can be used to achieve this:
3561 4ff74dcf 2022-07-20 thomas .Dl $ got update -b master
3562 4ff74dcf 2022-07-20 thomas .Dl $ got update -c origin/master
3563 4ff74dcf 2022-07-20 thomas .Dl $ got histedit -f
3564 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
3566 4ff74dcf 2022-07-20 thomas Once Jelmer has accepted the pull request, Stefan can fetch the
3567 4ff74dcf 2022-07-20 thomas merged changes, and possibly several other new changes, by running:
3569 4ff74dcf 2022-07-20 thomas .Dl $ got fetch upstream
3571 4ff74dcf 2022-07-20 thomas The merged changes will now be visible under the reference
3572 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master .
3573 4ff74dcf 2022-07-20 thomas The local
3574 4ff74dcf 2022-07-20 thomas .Dq master
3575 4ff74dcf 2022-07-20 thomas branch can now be rebased on top of the latest changes
3576 4ff74dcf 2022-07-20 thomas from upstream:
3578 4ff74dcf 2022-07-20 thomas .Dl $ got update -b upstream/master
3579 4ff74dcf 2022-07-20 thomas .Dl $ got rebase master
3581 4ff74dcf 2022-07-20 thomas As a final step, the forked repository's copy of the master branch needs
3582 4ff74dcf 2022-07-20 thomas to be kept in sync by sending the new changes there:
3584 4ff74dcf 2022-07-20 thomas .Dl $ got send -f -b master origin
3586 4ff74dcf 2022-07-20 thomas If multiple pull requests need to be managed in parallel, a separate branch
3587 4ff74dcf 2022-07-20 thomas must be created for each pull request with
3588 4ff74dcf 2022-07-20 thomas .Cm got branch .
3589 4ff74dcf 2022-07-20 thomas Each such branch can then be used as above, in place of
3590 4ff74dcf 2022-07-20 thomas .Dq refs/heads/master .
3591 4ff74dcf 2022-07-20 thomas Changes for any accepted pull requests will still appear under
3592 4ff74dcf 2022-07-20 thomas .Dq refs/remotes/upstream/master,
3593 4ff74dcf 2022-07-20 thomas regardless of which branch was used in the forked repository to
3594 4ff74dcf 2022-07-20 thomas create a pull request.
3595 5c860e29 2018-03-12 stsp .Sh SEE ALSO
3596 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
3597 2312fc47 2019-07-15 stsp .Xr tog 1 ,
3598 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
3599 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
3600 b345cf8f 2022-07-05 thomas .Xr got.conf 5 ,
3601 85c360aa 2023-01-02 thomas .Xr gotwebd 8
3602 1a208aaf 2018-04-01 stsp .Sh AUTHORS
3603 60c73080 2022-07-05 thomas .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3604 60c73080 2022-07-05 thomas .An Christian Weisgerber Aq Mt naddy@openbsd.org
3605 60c73080 2022-07-05 thomas .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3606 60c73080 2022-07-05 thomas .An Josh Rickmar Aq Mt jrick@zettaport.com
3607 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
3608 60c73080 2022-07-05 thomas .An Klemens Nanni Aq Mt kn@openbsd.org
3609 60c73080 2022-07-05 thomas .An Martin Pieuchot Aq Mt mpi@openbsd.org
3610 f6fad9f6 2022-07-05 thomas .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3611 60c73080 2022-07-05 thomas .An Omar Polo Aq Mt op@openbsd.org
3612 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
3613 60c73080 2022-07-05 thomas .An Sebastien Marie Aq Mt semarie@openbsd.org
3614 60c73080 2022-07-05 thomas .An Stefan Sperling Aq Mt stsp@openbsd.org
3615 bee5044f 2022-07-05 thomas .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3616 60c73080 2022-07-05 thomas .An Theo Buehler Aq Mt tb@openbsd.org
3617 60c73080 2022-07-05 thomas .An Thomas Adam Aq Mt thomas@xteddy.org
3618 60c73080 2022-07-05 thomas .An Tracey Emery Aq Mt tracey@traceyemery.net
3619 60c73080 2022-07-05 thomas .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3621 de71b616 2022-07-05 thomas Parts of
3623 de71b616 2022-07-05 thomas .Xr tog 1 ,
3625 85c360aa 2023-01-02 thomas .Xr gotwebd 8
3626 de71b616 2022-07-05 thomas were derived from code under copyright by:
3628 408db73d 2022-07-22 thomas .An Caldera International
3629 de71b616 2022-07-05 thomas .An Daniel Hartmeier
3630 de71b616 2022-07-05 thomas .An Esben Norby
3631 de71b616 2022-07-05 thomas .An Henning Brauer
3632 de71b616 2022-07-05 thomas .An Håkan Olsson
3633 de71b616 2022-07-05 thomas .An Ingo Schwarze
3634 de71b616 2022-07-05 thomas .An Jean-Francois Brousseau
3635 de71b616 2022-07-05 thomas .An Joris Vink
3636 de71b616 2022-07-05 thomas .An Jyri J. Virkki
3637 de71b616 2022-07-05 thomas .An Larry Wall
3638 408db73d 2022-07-22 thomas .An Markus Friedl
3639 de71b616 2022-07-05 thomas .An Niall O'Higgins
3640 de71b616 2022-07-05 thomas .An Niklas Hallqvist
3641 de71b616 2022-07-05 thomas .An Ray Lai
3642 de71b616 2022-07-05 thomas .An Ryan McBride
3643 de71b616 2022-07-05 thomas .An Theo de Raadt
3644 de71b616 2022-07-05 thomas .An Todd C. Miller
3645 de71b616 2022-07-05 thomas .An Xavier Santolaria
3648 e4badaa9 2022-07-05 thomas contains code contributed to the public domain by
3649 86f8a176 2022-12-30 thomas .An Austin Appleby .
3650 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
3652 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
3654 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
3656 cc63216e 2020-12-26 stsp to perform some tasks.
3657 cc63216e 2020-12-26 stsp In particular:
3658 cc63216e 2020-12-26 stsp .Bl -bullet
3660 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
3661 cc63216e 2020-12-26 stsp .Xr git-clone 1
3663 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
3665 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
3666 cc63216e 2020-12-26 stsp .Xr git-push 1 .
3668 22a38a43 2021-09-28 thomas The creation of merge commits with more than two parent commits requires
3669 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
3671 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
3673 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
3675 cc63216e 2020-12-26 stsp will usually produce better results.
