2 5c860e29 2018-03-12 stsp .\" Copyright (c) 2017 Martin Pieuchot
3 5aa81393 2020-01-06 stsp .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 5c860e29 2018-03-12 stsp .\" Permission to use, copy, modify, and distribute this software for any
6 5c860e29 2018-03-12 stsp .\" purpose with or without fee is hereby granted, provided that the above
7 5c860e29 2018-03-12 stsp .\" copyright notice and this permission notice appear in all copies.
9 5c860e29 2018-03-12 stsp .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 5c860e29 2018-03-12 stsp .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 5c860e29 2018-03-12 stsp .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 5c860e29 2018-03-12 stsp .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 5c860e29 2018-03-12 stsp .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 5c860e29 2018-03-12 stsp .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 5c860e29 2018-03-12 stsp .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 5c860e29 2018-03-12 stsp .Dd $Mdocdate$
22 8e13c46f 2019-08-05 stsp .Nd Game of Trees
23 5c860e29 2018-03-12 stsp .Sh SYNOPSIS
27 5c860e29 2018-03-12 stsp .Op Ar arg ...
28 5c860e29 2018-03-12 stsp .Sh DESCRIPTION
30 4dfb2f0f 2019-03-26 stsp is a version control system which stores the history of tracked files
31 4dfb2f0f 2019-03-26 stsp in a Git repository, as used by the Git version control system.
32 285dc8a4 2018-03-13 stsp This repository format is described in
33 5e5560e1 2018-08-01 stsp .Xr git-repository 5 .
37 ae73e26f 2019-03-26 stsp .Dq distributed
38 4129c201 2018-03-13 stsp version control system because every copy of a repository is writeable.
39 4129c201 2018-03-13 stsp Modifications made to files can be synchronized between repositories
40 97925469 2018-03-17 stsp at any time.
42 285dc8a4 2018-03-13 stsp Files managed by
44 4129c201 2018-03-13 stsp must be checked out from the repository for modification.
45 285dc8a4 2018-03-13 stsp Checked out files are stored in a
46 285dc8a4 2018-03-13 stsp .Em work tree
47 c5867b47 2018-03-13 stsp which can be placed at an arbitrary directory in the filesystem hierarchy.
48 fb2921d0 2019-03-26 stsp The on-disk format of this work tree is described in
49 285dc8a4 2018-03-13 stsp .Xr got-worktree 5 .
52 285dc8a4 2018-03-13 stsp provides global and command-specific options.
53 bc3056e3 2019-08-18 stsp Global options must precede the command name, and are as follows:
54 1b6b95a8 2018-03-12 stsp .Bl -tag -width tenletters
56 fef8a0d3 2019-08-04 stsp Display usage information and exit immediately.
57 1795b260 2021-04-02 kn .It Fl V , -version
58 53ccebc2 2019-07-30 stsp Display program version and exit immediately.
61 38e11793 2018-06-13 stsp The commands for
63 38e11793 2018-06-13 stsp are as follows:
64 0bb8a95e 2018-03-12 stsp .Bl -tag -width checkout
68 5fc4f020 2022-08-30 op .Op Fl b Ar branch
69 5fc4f020 2022-08-30 op .Op Fl I Ar pattern
70 5fc4f020 2022-08-30 op .Op Fl m Ar message
71 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
74 4683a10b 2021-11-04 kn .Dl Pq alias: Cm im
75 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
76 3ce1b845 2019-07-15 stsp within the specified
77 3ce1b845 2019-07-15 stsp .Ar directory .
78 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
79 3ce1b845 2019-07-15 stsp root commit.
80 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
81 3ce1b845 2019-07-15 stsp created commit.
82 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
85 21a44f98 2019-07-15 stsp .Cm got import
86 21a44f98 2019-07-15 stsp command requires the
87 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
88 aba9c984 2019-09-08 stsp environment variable to be set,
89 257add31 2020-09-09 stsp unless an author has been configured in
90 257add31 2020-09-09 stsp .Xr got.conf 5
92 aba9c984 2019-09-08 stsp .Dv user.name
94 709ae9eb 2019-09-08 stsp .Dv user.email
95 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
96 aba9c984 2019-09-08 stsp .Pa .git/config
97 c9956ddf 2019-09-08 stsp file or from Git's global
98 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
99 c9956ddf 2019-09-08 stsp configuration file.
101 3ce1b845 2019-07-15 stsp The options for
102 3ce1b845 2019-07-15 stsp .Cm got import
103 3ce1b845 2019-07-15 stsp are as follows:
104 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
105 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
106 3ce1b845 2019-07-15 stsp Create the specified
107 6f04a73d 2022-09-20 mark .Ar branch .
108 6f04a73d 2022-09-20 mark If this option is not specified, a branch corresponding to the repository's
109 6f04a73d 2022-09-20 mark HEAD reference will be used.
110 6f04a73d 2022-09-20 mark Use of this option is required if the branch resolved via the repository's
111 6f04a73d 2022-09-20 mark HEAD reference already exists.
112 827a167b 2022-08-16 stsp .It Fl I Ar pattern
113 827a167b 2022-08-16 stsp Ignore files or directories with a name which matches the specified
114 827a167b 2022-08-16 stsp .Ar pattern .
115 827a167b 2022-08-16 stsp This option may be specified multiple times to build a list of ignore patterns.
117 827a167b 2022-08-16 stsp .Ar pattern
118 827a167b 2022-08-16 stsp follows the globbing rules documented in
119 827a167b 2022-08-16 stsp .Xr glob 7 .
120 49351f3b 2023-02-06 stsp Ignore patterns which end with a slash,
122 49351f3b 2023-02-06 stsp will only match directories.
123 3ce1b845 2019-07-15 stsp .It Fl m Ar message
124 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
125 3ce1b845 2019-07-15 stsp Without the
128 3ce1b845 2019-07-15 stsp .Cm got import
129 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
130 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
131 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
132 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
133 3ce1b845 2019-07-15 stsp working directory.
139 5fc4f020 2022-08-30 op .Op Fl b Ar branch
140 5fc4f020 2022-08-30 op .Op Fl R Ar reference
141 5fc4f020 2022-08-30 op .Ar repository-URL
142 5fc4f020 2022-08-30 op .Op Ar directory
144 4683a10b 2021-11-04 kn .Dl Pq alias: Cm cl
145 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
146 2ab43947 2020-03-18 stsp .Ar repository-URL
147 2ab43947 2020-03-18 stsp into the specified
148 3493b628 2020-03-20 stsp .Ar directory .
150 3493b628 2020-03-20 stsp .Ar directory
151 e38d4cde 2022-03-21 naddy is specified, the directory name will be derived from the name of the
152 2ab43947 2020-03-18 stsp cloned repository.
153 2ab43947 2020-03-18 stsp .Cm got clone
154 2ab43947 2020-03-18 stsp will refuse to run if the
155 3493b628 2020-03-20 stsp .Ar directory
156 2ab43947 2020-03-18 stsp already exists.
159 2ab43947 2020-03-18 stsp .Ar repository-URL
160 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
161 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
162 619eb6dd 2020-03-20 stsp the server:
163 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
165 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
166 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
168 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
169 2ab43947 2020-03-18 stsp .Xr git-daemon 1
171 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
172 10c073e7 2020-03-20 stsp nor encryption.
173 2ab43947 2020-03-18 stsp .It git+ssh
174 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
177 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
180 2ab43947 2020-03-18 stsp .Mt user@hostname
182 2ab43947 2020-03-18 stsp Short alias for git+ssh.
185 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
186 89c3c67b 2020-03-20 stsp from the server.
187 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
189 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
190 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
191 89c3c67b 2020-03-20 stsp This can take some time.
192 010f7279 2020-03-20 stsp More details about the pack file format are documented in
193 010f7279 2020-03-20 stsp .Xr git-repository 5 .
195 7848a0e1 2020-03-19 stsp .Cm got clone
196 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
197 257add31 2020-09-09 stsp .Xr got.conf 5
200 257add31 2020-09-09 stsp files of the cloned repository to store the
201 7848a0e1 2020-03-19 stsp .Ar repository-url
205 99495ddb 2021-01-10 stsp .Ar reference
206 132af4a5 2021-01-05 stsp arguments for future use by
207 7848a0e1 2020-03-19 stsp .Cm got fetch
209 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
211 2ab43947 2020-03-18 stsp The options for
212 2ab43947 2020-03-18 stsp .Cm got clone
213 2ab43947 2020-03-18 stsp are as follows:
214 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
216 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
217 1d4b192f 2020-03-21 stsp .Dq refs/heads/
218 5aa20203 2021-01-05 stsp reference namespace and set
219 f1bf60d1 2022-07-03 stsp .Cm fetch_all_branches
220 5aa20203 2021-01-05 stsp in the cloned repository's
221 5aa20203 2021-01-05 stsp .Xr got.conf 5
222 5aa20203 2021-01-05 stsp file for future use by
223 5aa20203 2021-01-05 stsp .Cm got fetch .
224 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
225 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
226 4ba14133 2020-03-20 stsp Cannot be used together with the
229 4ba14133 2020-03-20 stsp .It Fl b Ar branch
230 4ba14133 2020-03-20 stsp Fetch the specified
232 1d4b192f 2020-03-21 stsp from the remote repository's
233 1d4b192f 2020-03-21 stsp .Dq refs/heads/
234 1d4b192f 2020-03-21 stsp reference namespace.
235 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
237 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
238 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
239 4ba14133 2020-03-20 stsp branch which was fetched.
240 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
241 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
242 4ba14133 2020-03-20 stsp Cannot be used together with the
246 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
247 41b0de12 2020-03-21 stsp and exit immediately.
248 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
253 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
254 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
255 bd81cfb7 2020-04-19 stsp locally created commits.
257 469dd726 2020-03-20 stsp The repository's
258 257add31 2020-09-09 stsp .Xr got.conf 5
261 257add31 2020-09-09 stsp files will be set up with the
263 469dd726 2020-03-20 stsp option enabled, such that
264 469dd726 2020-03-20 stsp .Cm got fetch
266 469dd726 2020-03-20 stsp .Xr git-fetch 1
267 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
268 469dd726 2020-03-20 stsp .Dq refs/heads/
269 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
270 469dd726 2020-03-20 stsp .Dq refs/remotes/
272 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
273 469dd726 2020-03-20 stsp .Cm got rebase
275 469dd726 2020-03-20 stsp .Cm got fetch
276 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
277 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
279 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
280 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
281 498ef124 2020-03-21 stsp changes are fetched.
283 2ab43947 2020-03-18 stsp Suppress progress reporting output.
284 2ab43947 2020-03-18 stsp The same option will be passed to
286 2ab43947 2020-03-18 stsp if applicable.
287 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
288 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
289 0e4002ca 2020-03-21 stsp .Ar reference
290 0e4002ca 2020-03-21 stsp from the remote repository's
293 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
294 0e4002ca 2020-03-21 stsp references to fetch.
295 71f12362 2020-03-21 stsp The specified
296 71f12362 2020-03-21 stsp .Ar reference
297 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
298 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
300 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
301 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
302 0e4002ca 2020-03-21 stsp namespace, unless the
304 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
308 0e4002ca 2020-03-21 stsp .Cm got clone
309 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
310 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
312 0e4002ca 2020-03-21 stsp .Dq refs/got/
315 827a167b 2022-08-16 stsp Verbose mode.
317 827a167b 2022-08-16 stsp .Cm got clone
318 827a167b 2022-08-16 stsp to print debugging messages to standard error output.
319 827a167b 2022-08-16 stsp This option will be passed to
321 827a167b 2022-08-16 stsp if applicable.
322 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
323 827a167b 2022-08-16 stsp The maximum is 3.
328 5fc4f020 2022-08-30 op .Op Fl adlqtvX
329 5fc4f020 2022-08-30 op .Op Fl b Ar branch
330 5fc4f020 2022-08-30 op .Op Fl R Ar reference
331 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
332 5fc4f020 2022-08-30 op .Op Ar remote-repository
334 4683a10b 2021-11-04 kn .Dl Pq alias: Cm fe
335 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
337 4ba14133 2020-03-20 stsp .Ar remote-repository
338 4ba14133 2020-03-20 stsp is specified,
340 7848a0e1 2020-03-19 stsp will be used.
341 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
342 257add31 2020-09-09 stsp .Xr got.conf 5
345 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
346 7848a0e1 2020-03-19 stsp .Cm got clone .
348 ccbbf026 2023-02-06 stsp By default, any branches configured in
349 ccbbf026 2023-02-06 stsp .Xr got.conf 5
351 4bff57b4 2023-02-14 stsp .Ar remote-repository
352 ccbbf026 2023-02-06 stsp will be fetched.
354 ccbbf026 2023-02-06 stsp .Cm got fetch
355 ccbbf026 2023-02-06 stsp is invoked in a work tree then this work tree's current branch will be
356 ccbbf026 2023-02-06 stsp fetched, too, provided it is present on the server.
357 4bff57b4 2023-02-14 stsp If no branches to fetch can be found in
358 4bff57b4 2023-02-14 stsp .Xr got.conf 5
359 4bff57b4 2023-02-14 stsp or via a work tree, or said branches are not found on the server, a branch
360 4bff57b4 2023-02-14 stsp resolved via the remote repository's HEAD reference will be fetched.
361 118a625d 2023-02-18 mark Likewise, if a HEAD reference for the
362 118a625d 2023-02-18 mark .Ar remote-repository
363 118a625d 2023-02-18 mark exists but its target no longer matches the remote HEAD, then
364 118a625d 2023-02-18 mark the new target branch will be fetched.
365 ccbbf026 2023-02-06 stsp This default behaviour can be overridden with the
371 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
372 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
373 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
375 498ef124 2020-03-21 stsp By default, branch references in the
376 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
377 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
379 498ef124 2020-03-21 stsp .Cm got rebase
380 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
381 7848a0e1 2020-03-19 stsp .Dq refs/heads/
382 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
383 bd81cfb7 2020-04-19 stsp as necessary.
385 498ef124 2020-03-21 stsp If the repository was created as a mirror with
386 e38d4cde 2022-03-21 naddy .Cm got clone -m ,
387 498ef124 2020-03-21 stsp then all branches in the
388 469dd726 2020-03-20 stsp .Dq refs/heads/
389 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
390 498ef124 2020-03-21 stsp the remote repository.
391 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
392 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
393 e6786710 2021-07-03 stsp by Git's garbage collector or
394 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
395 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
397 db6d8ad8 2020-03-21 stsp In any case, references in the
398 7848a0e1 2020-03-19 stsp .Dq refs/tags/
399 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
400 db6d8ad8 2020-03-21 stsp in the same namespace.
402 7848a0e1 2020-03-19 stsp The options for
403 7848a0e1 2020-03-19 stsp .Cm got fetch
404 7848a0e1 2020-03-19 stsp are as follows:
405 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
407 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
408 1d4b192f 2020-03-21 stsp .Dq refs/heads/
409 1d4b192f 2020-03-21 stsp reference namespace.
410 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
411 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
412 4ba14133 2020-03-20 stsp Cannot be used together with the
415 4ba14133 2020-03-20 stsp .It Fl b Ar branch
416 4ba14133 2020-03-20 stsp Fetch the specified
418 1d4b192f 2020-03-21 stsp from the remote repository's
419 1d4b192f 2020-03-21 stsp .Dq refs/heads/
420 1d4b192f 2020-03-21 stsp reference namespace.
421 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
423 4ba14133 2020-03-20 stsp Cannot be used together with the
427 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
428 f21ec2f0 2020-03-21 stsp present in the remote repository.
429 f21ec2f0 2020-03-21 stsp Only references are deleted.
430 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
431 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
432 e6786710 2021-07-03 stsp Git's garbage collector or
433 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
435 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
436 41b0de12 2020-03-21 stsp and exit immediately.
437 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
443 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
444 7848a0e1 2020-03-19 stsp The same option will be passed to
446 7848a0e1 2020-03-19 stsp if applicable.
447 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
448 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
449 0e4002ca 2020-03-21 stsp .Ar reference
450 0e4002ca 2020-03-21 stsp from the remote repository's
453 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
454 0e4002ca 2020-03-21 stsp references to fetch.
455 71f12362 2020-03-21 stsp The specified
456 71f12362 2020-03-21 stsp .Ar reference
457 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
458 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
460 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
461 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
462 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
463 a18cccf9 2020-03-21 stsp .Cm got clone -m
464 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
468 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
469 0e4002ca 2020-03-21 stsp .Cm got branch
472 0e4002ca 2020-03-21 stsp .Cm got fetch
473 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
474 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
476 0e4002ca 2020-03-21 stsp .Dq refs/got/
478 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
479 827a167b 2022-08-16 stsp Use the repository at the specified path.
480 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
481 827a167b 2022-08-16 stsp working directory.
482 827a167b 2022-08-16 stsp If this directory is a
484 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
486 827a167b 2022-08-16 stsp Allow existing references in the
487 827a167b 2022-08-16 stsp .Dq refs/tags
488 827a167b 2022-08-16 stsp namespace to be updated if they have changed on the server.
489 827a167b 2022-08-16 stsp If not specified, only new tag references will be created.
491 827a167b 2022-08-16 stsp Verbose mode.
493 827a167b 2022-08-16 stsp .Cm got fetch
494 827a167b 2022-08-16 stsp to print debugging messages to standard error output.
495 827a167b 2022-08-16 stsp The same option will be passed to
497 827a167b 2022-08-16 stsp if applicable.
498 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
499 827a167b 2022-08-16 stsp The maximum is 3.
501 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
502 161728eb 2021-07-24 stsp .Ar remote-repository
503 161728eb 2021-07-24 stsp instead of fetching new changes.
504 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
505 161728eb 2021-07-24 stsp .Xr got.conf 5 .
510 161728eb 2021-07-24 stsp .Ar remote-repository
511 161728eb 2021-07-24 stsp argument is mandatory and no other options except
516 161728eb 2021-07-24 stsp are allowed.
518 161728eb 2021-07-24 stsp Only references are deleted.
519 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
520 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
521 161728eb 2021-07-24 stsp .Xr git-repack 1
522 161728eb 2021-07-24 stsp and Git's garbage collector.
528 5fc4f020 2022-08-30 op .Op Fl b Ar branch
529 5fc4f020 2022-08-30 op .Op Fl c Ar commit
530 5fc4f020 2022-08-30 op .Op Fl p Ar path-prefix
531 5fc4f020 2022-08-30 op .Ar repository-path
532 5fc4f020 2022-08-30 op .Op Ar work-tree-path
534 4683a10b 2021-11-04 kn .Dl Pq alias: Cm co
535 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
536 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
537 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
538 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
539 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
543 5d7c1dab 2018-04-01 stsp .Ar work tree path
544 c844a238 2019-02-06 stsp is not specified, either use the last component of
545 5d7c1dab 2018-04-01 stsp .Ar repository path ,
547 5d7c1dab 2018-04-01 stsp .Ar path prefix
548 c844a238 2019-02-06 stsp was specified use the last component of
549 5d7c1dab 2018-04-01 stsp .Ar path prefix .
551 38e11793 2018-06-13 stsp The options for
552 38e11793 2018-06-13 stsp .Cm got checkout
553 38e11793 2018-06-13 stsp are as follows:
554 38e11793 2018-06-13 stsp .Bl -tag -width Ds
555 08573d5b 2019-05-14 stsp .It Fl b Ar branch
556 3c575567 2019-07-28 stsp Check out files from a commit on the specified
557 08573d5b 2019-05-14 stsp .Ar branch .
558 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
559 08573d5b 2019-05-14 stsp reference will be used.
560 8069f636 2019-01-12 stsp .It Fl c Ar commit
561 8069f636 2019-01-12 stsp Check out files from the specified
563 3c575567 2019-07-28 stsp on the selected branch.
564 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
565 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
566 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
567 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
568 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
569 08573d5b 2019-05-14 stsp branch will be used.
571 4b6c9460 2020-03-05 stsp If the specified
573 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
574 4b6c9460 2020-03-05 stsp this commit must be specified with the
577 e38d4cde 2022-03-21 naddy If no such branch is known, a new branch must be created for this
578 4b6c9460 2020-03-05 stsp commit with
579 4b6c9460 2020-03-05 stsp .Cm got branch
581 4b6c9460 2020-03-05 stsp .Cm got checkout
582 4b6c9460 2020-03-05 stsp can be used.
583 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
585 827a167b 2022-08-16 stsp Proceed with the checkout operation even if the directory at
586 827a167b 2022-08-16 stsp .Ar work-tree-path
587 827a167b 2022-08-16 stsp is not empty.
588 827a167b 2022-08-16 stsp Existing files will be left intact.
589 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
590 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
591 38e11793 2018-06-13 stsp Only files beneath the specified
592 38e11793 2018-06-13 stsp .Ar path-prefix
593 38e11793 2018-06-13 stsp will be checked out.
595 4ad4a1ec 2021-09-13 tracey Silence progress output.
601 5fc4f020 2022-08-30 op .Op Fl b Ar branch
602 5fc4f020 2022-08-30 op .Op Fl c Ar commit
603 5fc4f020 2022-08-30 op .Op Ar path ...
605 4683a10b 2021-11-04 kn .Dl Pq alias: Cm up
606 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
607 4f331d3a 2020-04-01 stsp .Ar commit .
608 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
609 4f331d3a 2020-04-01 stsp of this commit.
610 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
611 4f331d3a 2020-04-01 stsp incoming changes.
613 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
614 5036ab18 2020-04-18 stsp further complications.
615 5036ab18 2020-04-18 stsp Such files will be updated when
616 5036ab18 2020-04-18 stsp .Cm got update
617 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
618 e38d4cde 2022-03-21 naddy If the conflicting changes are no longer needed, affected files can be
619 5036ab18 2020-04-18 stsp reverted with
620 5036ab18 2020-04-18 stsp .Cm got revert
621 5036ab18 2020-04-18 stsp before running
622 5036ab18 2020-04-18 stsp .Cm got update
625 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
626 7f838b36 2019-02-08 stsp .Bl -column YXZ description
627 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
628 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
629 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
630 7f838b36 2019-02-08 stsp .It D Ta file was deleted
631 7f838b36 2019-02-08 stsp .It A Ta new file was added
632 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
633 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
634 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
635 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
640 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
641 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
642 f2ea84fa 2019-07-27 stsp specified paths.
643 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
644 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
645 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
648 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
649 c4cdcb68 2019-04-03 stsp multiple base commits.
650 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
651 47ec7be7 2019-05-12 stsp .Cm got update
652 47ec7be7 2019-05-12 stsp across the entire work tree.
653 024e9686 2019-05-14 stsp Specifying a
655 024e9686 2019-05-14 stsp is incompatible with the
659 4ed9f614 2019-08-04 stsp .Cm got update
660 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
661 4ed9f614 2019-08-04 stsp If changes have been staged with
662 4ed9f614 2019-08-04 stsp .Cm got stage ,
663 bc3056e3 2019-08-18 stsp these changes must first be committed with
664 4ed9f614 2019-08-04 stsp .Cm got commit
665 4ed9f614 2019-08-04 stsp or unstaged with
666 4ed9f614 2019-08-04 stsp .Cm got unstage .
668 507dc3bb 2018-12-29 stsp The options for
669 507dc3bb 2018-12-29 stsp .Cm got update
670 507dc3bb 2018-12-29 stsp are as follows:
671 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
672 024e9686 2019-05-14 stsp .It Fl b Ar branch
673 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
675 024e9686 2019-05-14 stsp before updating the work tree.
676 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
678 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
679 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
680 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
682 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
683 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
684 4f331d3a 2020-04-01 stsp .Ar branch .
685 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
686 4f331d3a 2020-04-01 stsp .Cm got commit ,
687 4f331d3a 2020-04-01 stsp or could be discarded with
688 4f331d3a 2020-04-01 stsp .Cm got revert .
689 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
690 507dc3bb 2018-12-29 stsp Update the work tree to the specified
691 507dc3bb 2018-12-29 stsp .Ar commit .
692 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
693 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
694 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
695 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
696 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
697 024e9686 2019-05-14 stsp branch will be used.
699 4ad4a1ec 2021-09-13 tracey Silence progress output.
705 5fc4f020 2022-08-30 op .Op Fl S Ar status-codes
706 5fc4f020 2022-08-30 op .Op Fl s Ar status-codes
707 5fc4f020 2022-08-30 op .Op Ar path ...
709 4683a10b 2021-11-04 kn .Dl Pq alias: Cm st
710 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
711 6bad629b 2019-02-04 stsp using the following status codes:
712 6bad629b 2019-02-04 stsp .Bl -column YXZ description
713 6bad629b 2019-02-04 stsp .It M Ta modified file
714 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
715 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
716 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
717 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
718 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
719 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
721 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
722 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
724 2a06fe5f 2019-08-24 stsp specified on the command line
729 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
730 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
732 4ed9f614 2019-08-04 stsp If changes have been staged with
733 4ed9f614 2019-08-04 stsp .Cm got stage ,
734 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
735 4ed9f614 2019-08-04 stsp status codes:
736 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
737 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
738 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
739 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
742 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
743 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
744 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
745 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
748 081470ac 2020-08-13 stsp The options for
749 081470ac 2020-08-13 stsp .Cm got status
750 081470ac 2020-08-13 stsp are as follows:
751 081470ac 2020-08-13 stsp .Bl -tag -width Ds
753 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
754 827a167b 2022-08-16 stsp .It Fl S Ar status-codes
755 827a167b 2022-08-16 stsp Suppress the output of files with a modification status matching any of the
756 00357e4d 2021-09-14 tracey single-character status codes contained in the
757 00357e4d 2021-09-14 tracey .Ar status-codes
758 00357e4d 2021-09-14 tracey argument.
759 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
760 00357e4d 2021-09-14 tracey may be specified.
761 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
762 b043307b 2021-09-14 stsp Cannot be used together with the
765 827a167b 2022-08-16 stsp .It Fl s Ar status-codes
766 827a167b 2022-08-16 stsp Only show files with a modification status matching any of the
767 081470ac 2020-08-13 stsp single-character status codes contained in the
768 081470ac 2020-08-13 stsp .Ar status-codes
770 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
771 081470ac 2020-08-13 stsp may be specified.
772 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
773 b043307b 2021-09-14 stsp Cannot be used together with the
778 6841da00 2019-08-08 stsp For compatibility with
781 bd8de430 2019-10-04 stsp .Xr git 1 ,
782 6841da00 2019-08-08 stsp .Cm got status
785 bd8de430 2019-10-04 stsp patterns from
786 6841da00 2019-08-08 stsp .Pa .cvsignore
788 bd8de430 2019-10-04 stsp .Pa .gitignore
789 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
790 bd8de430 2019-10-04 stsp which match these patterns.
791 249b637c 2023-02-20 stsp Ignore patterns which end with a slash,
793 249b637c 2023-02-20 stsp will only match directories.
794 bd8de430 2019-10-04 stsp As an extension to
796 bd8de430 2019-10-04 stsp matching rules,
797 bd8de430 2019-10-04 stsp .Cm got status
798 bd8de430 2019-10-04 stsp supports consecutive asterisks,
800 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
802 6841da00 2019-08-08 stsp .Xr cvs 1 ,
803 6841da00 2019-08-08 stsp .Cm got status
804 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
806 bd8de430 2019-10-04 stsp .Xr git 1 ,
807 bd8de430 2019-10-04 stsp .Cm got status
808 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
810 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
812 bd8de430 2019-10-04 stsp in a pattern.
815 d651dcfa 2023-01-07 mark .Op Fl bdPpRs
816 5fc4f020 2022-08-30 op .Op Fl C Ar number
817 5fc4f020 2022-08-30 op .Op Fl c Ar commit
818 5fc4f020 2022-08-30 op .Op Fl l Ar N
819 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
820 5fc4f020 2022-08-30 op .Op Fl S Ar search-pattern
821 5fc4f020 2022-08-30 op .Op Fl x Ar commit
824 38e11793 2018-06-13 stsp Display history of a repository.
827 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
828 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
830 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
831 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
832 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
834 38e11793 2018-06-13 stsp The options for
835 38e11793 2018-06-13 stsp .Cm got log
836 38e11793 2018-06-13 stsp are as follows:
837 38e11793 2018-06-13 stsp .Bl -tag -width Ds
839 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
840 1137e0ae 2020-01-27 stsp from other branches.
841 48c8c60d 2020-01-27 stsp By default,
842 48c8c60d 2020-01-27 stsp .Cm got log
843 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
844 827a167b 2022-08-16 stsp .It Fl C Ar number
845 827a167b 2022-08-16 stsp Set the number of context lines shown in diffs with
847 827a167b 2022-08-16 stsp By default, 3 lines of context are shown.
848 38e11793 2018-06-13 stsp .It Fl c Ar commit
849 38e11793 2018-06-13 stsp Start traversing history at the specified
850 38e11793 2018-06-13 stsp .Ar commit .
851 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
852 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
853 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
854 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
855 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
856 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
858 1f3405c9 2023-01-17 mark Display diffstat of changes introduced in each commit.
859 5191b70b 2023-01-07 mark Cannot be used with the
862 6238ee32 2018-06-13 stsp .It Fl l Ar N
863 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
864 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
865 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
867 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
868 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
870 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
871 0208f208 2020-05-05 stsp status codes:
872 0208f208 2020-05-05 stsp .Bl -column YXZ description
873 0208f208 2020-05-05 stsp .It M Ta modified file
874 0208f208 2020-05-05 stsp .It D Ta file was deleted
875 0208f208 2020-05-05 stsp .It A Ta new file was added
876 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
879 c1c775eb 2022-06-08 stsp Cannot be used with the
883 827a167b 2022-08-16 stsp Display the patch of modifications made in each commit.
886 827a167b 2022-08-16 stsp is specified, only show the patch of modifications at or within this path.
887 827a167b 2022-08-16 stsp Cannot be used with the
891 827a167b 2022-08-16 stsp Determine a set of commits to display as usual, but display these commits
892 827a167b 2022-08-16 stsp in reverse order.
893 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
894 827a167b 2022-08-16 stsp Use the repository at the specified path.
895 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
896 827a167b 2022-08-16 stsp working directory.
897 827a167b 2022-08-16 stsp If this directory is a
899 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
900 c1c775eb 2022-06-08 stsp .It Fl S Ar search-pattern
901 793b9394 2022-06-12 op If specified, show only commits with a log message, author name,
902 793b9394 2022-06-12 op committer name, or ID SHA1 hash matched by the extended regular
904 6841bf13 2019-11-29 kn .Ar search-pattern .
905 3ef807ee 2022-06-08 stsp Lines in committed patches will be matched if
907 3ef807ee 2022-06-08 stsp is specified.
908 3ef807ee 2022-06-08 stsp File paths changed by a commit will be matched if
910 3ef807ee 2022-06-08 stsp is specified.
911 6841bf13 2019-11-29 kn Regular expression syntax is documented in
912 6841bf13 2019-11-29 kn .Xr re_format 7 .
914 827a167b 2022-08-16 stsp Display a short one-line summary of each commit, instead of the default
915 827a167b 2022-08-16 stsp history format.
916 827a167b 2022-08-16 stsp Cannot be used together with the
921 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
922 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
924 52ab7958 2020-04-18 stsp has been traversed.
925 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
927 d1fe46f9 2020-04-18 stsp is never traversed.
932 a76e88e5 2023-01-10 mark .Op Fl adPsw
933 5fc4f020 2022-08-30 op .Op Fl C Ar number
934 5fc4f020 2022-08-30 op .Op Fl c Ar commit
935 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
936 5fc4f020 2022-08-30 op .Op Ar object1 Ar object2 | Ar path ...
938 4683a10b 2021-11-04 kn .Dl Pq alias: Cm di
939 e7ffb0b0 2021-10-07 stsp When invoked within a work tree without any arguments, display all
940 bd81cfb7 2020-04-19 stsp local changes in the work tree.
941 e7ffb0b0 2021-10-07 stsp If one or more
943 e7ffb0b0 2021-10-07 stsp arguments are specified, only show changes within the specified paths.
945 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
946 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
947 d24820bf 2019-08-11 stsp corresponding objects.
948 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
949 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
950 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
951 e7ffb0b0 2021-10-07 stsp If none of these interpretations produce a valid result or if the
953 e7ffb0b0 2021-10-07 stsp option is used,
955 e7ffb0b0 2021-10-07 stsp .Cm got diff
956 e7ffb0b0 2021-10-07 stsp is running in a work tree, attempt to interpret the two arguments as paths.
958 c0cc5c62 2018-10-18 stsp The options for
959 c0cc5c62 2018-10-18 stsp .Cm got diff
960 c0cc5c62 2018-10-18 stsp are as follows:
961 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
963 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
964 827a167b 2022-08-16 stsp .It Fl C Ar number
965 827a167b 2022-08-16 stsp Set the number of context lines shown in the diff.
966 827a167b 2022-08-16 stsp By default, 3 lines of context are shown.
967 67b631c9 2021-10-10 stsp .It Fl c Ar commit
968 67b631c9 2021-10-10 stsp Show differences between commits in the repository.
969 827a167b 2022-08-16 stsp This option may be used up to two times.
970 67b631c9 2021-10-10 stsp When used only once, show differences between the specified
972 67b631c9 2021-10-10 stsp and its first parent commit.
973 67b631c9 2021-10-10 stsp When used twice, show differences between the two specified commits.
975 67b631c9 2021-10-10 stsp The expected argument is a commit ID SHA1 hash or an existing reference
976 67b631c9 2021-10-10 stsp or tag name which will be resolved to a commit ID.
977 67b631c9 2021-10-10 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
978 67b631c9 2021-10-10 stsp automatically, provided the abbreviation is unique.
982 67b631c9 2021-10-10 stsp option is used, all non-option arguments will be interpreted as paths.
983 67b631c9 2021-10-10 stsp If one or more such
985 67b631c9 2021-10-10 stsp arguments are provided, only show differences for the specified paths.
987 67b631c9 2021-10-10 stsp Cannot be used together with the
991 a76e88e5 2023-01-10 mark Display diffstat of changes before the actual diff by annotating each file path
992 a76e88e5 2023-01-10 mark or blob hash being diffed with the total number of lines added and removed.
993 a76e88e5 2023-01-10 mark A summary line will display the total number of changes across all files.
995 827a167b 2022-08-16 stsp Interpret all arguments as paths only.
996 827a167b 2022-08-16 stsp This option can be used to resolve ambiguity in cases where paths
997 827a167b 2022-08-16 stsp look like tag names, reference names, or object IDs.
998 827a167b 2022-08-16 stsp This option is only valid when
999 827a167b 2022-08-16 stsp .Cm got diff
1000 827a167b 2022-08-16 stsp is invoked in a work tree.
1001 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
1002 b72f483a 2019-02-05 stsp Use the repository at the specified path.
1003 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
1004 b72f483a 2019-02-05 stsp working directory.
1005 b72f483a 2019-02-05 stsp If this directory is a
1007 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1009 4ed9f614 2019-08-04 stsp Show changes staged with
1010 4ed9f614 2019-08-04 stsp .Cm got stage
1011 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
1012 e7ffb0b0 2021-10-07 stsp This option is only valid when
1013 e7ffb0b0 2021-10-07 stsp .Cm got diff
1014 e7ffb0b0 2021-10-07 stsp is invoked in a work tree.
1016 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
1021 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1022 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1025 4683a10b 2021-11-04 kn .Dl Pq alias: Cm bl
1026 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
1028 1ff8e573 2018-08-02 stsp The options for
1029 1ff8e573 2018-08-02 stsp .Cm got blame
1030 1ff8e573 2018-08-02 stsp are as follows:
1031 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
1032 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
1033 1ff8e573 2018-08-02 stsp Start traversing history at the specified
1034 1ff8e573 2018-08-02 stsp .Ar commit .
1035 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1036 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1037 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1038 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1039 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
1040 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
1041 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
1042 1ff8e573 2018-08-02 stsp working directory.
1043 0c06baac 2019-02-05 stsp If this directory is a
1045 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1051 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1052 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1055 4683a10b 2021-11-04 kn .Dl Pq alias: Cm tr
1056 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
1057 5de5890b 2018-10-18 stsp directory path in the repository.
1058 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
1059 db0c2996 2019-02-10 stsp annotations:
1060 db0c2996 2019-02-10 stsp .Bl -column YXZ description
1061 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
1062 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
1063 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
1064 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
1067 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
1071 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
1072 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
1073 0c849583 2019-02-05 stsp if there is no work tree.
1075 5de5890b 2018-10-18 stsp The options for
1076 5de5890b 2018-10-18 stsp .Cm got tree
1077 5de5890b 2018-10-18 stsp are as follows:
1078 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
1079 5de5890b 2018-10-18 stsp .It Fl c Ar commit
1080 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
1081 5de5890b 2018-10-18 stsp .Ar commit .
1082 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1083 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
1084 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1085 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1087 827a167b 2022-08-16 stsp Show object IDs of files (blob objects) and directories (tree objects).
1089 827a167b 2022-08-16 stsp Recurse into sub-directories in the repository.
1090 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
1091 5de5890b 2018-10-18 stsp Use the repository at the specified path.
1092 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
1093 5de5890b 2018-10-18 stsp working directory.
1094 0c849583 2019-02-05 stsp If this directory is a
1096 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
1101 5e91dae4 2022-08-30 stsp .Op Fl c Ar object
1102 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1103 5fc4f020 2022-08-30 op .Op Fl s Ar reference
1106 d0eebce4 2019-03-11 stsp Manage references in a repository.
1108 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
1109 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
1111 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
1112 f16e4044 2019-10-09 stsp .Dq refs/ .
1114 d0eebce4 2019-03-11 stsp The options for
1115 d0eebce4 2019-03-11 stsp .Cm got ref
1116 d0eebce4 2019-03-11 stsp are as follows:
1117 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
1118 827a167b 2022-08-16 stsp .It Fl c Ar object
1119 827a167b 2022-08-16 stsp Create a reference or change an existing reference.
1120 827a167b 2022-08-16 stsp The reference with the specified
1122 827a167b 2022-08-16 stsp will point at the specified
1123 827a167b 2022-08-16 stsp .Ar object .
1124 827a167b 2022-08-16 stsp The expected
1125 827a167b 2022-08-16 stsp .Ar object
1126 827a167b 2022-08-16 stsp argument is a ID SHA1 hash or an existing reference or tag name which will
1127 827a167b 2022-08-16 stsp be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1128 827a167b 2022-08-16 stsp Cannot be used together with any other options except
1131 827a167b 2022-08-16 stsp Delete the reference with the specified
1133 827a167b 2022-08-16 stsp from the repository.
1134 827a167b 2022-08-16 stsp Any commit, tree, tag, and blob objects belonging to deleted references
1135 827a167b 2022-08-16 stsp remain in the repository and may be removed separately with
1136 827a167b 2022-08-16 stsp Git's garbage collector or
1137 827a167b 2022-08-16 stsp .Cm gotadmin cleanup .
1138 827a167b 2022-08-16 stsp Cannot be used together with any other options except
1141 b2070a3f 2020-03-22 stsp List references in the repository.
1144 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
1147 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
1148 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
1149 b2070a3f 2020-03-22 stsp .Ar name .
1150 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1154 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
1155 827a167b 2022-08-16 stsp Use the repository at the specified path.
1156 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
1157 827a167b 2022-08-16 stsp working directory.
1158 827a167b 2022-08-16 stsp If this directory is a
1160 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
1161 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
1162 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
1163 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1165 e31abbf2 2020-03-22 stsp will point at the specified
1166 e31abbf2 2020-03-22 stsp .Ar reference
1167 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1168 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1169 d1c1ae5f 2019-08-12 stsp this option is used.
1170 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1173 827a167b 2022-08-16 stsp Sort listed references by modification time (most recently modified first)
1174 827a167b 2022-08-16 stsp instead of sorting by lexicographical order.
1175 827a167b 2022-08-16 stsp Use of this option requires the
1177 827a167b 2022-08-16 stsp option to be used as well.
1183 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1184 5fc4f020 2022-08-30 op .Op Fl d Ar name
1185 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1188 4683a10b 2021-11-04 kn .Dl Pq alias: Cm br
1189 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1191 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1192 4e759de4 2019-06-26 stsp .Dq refs/heads/
1193 4e759de4 2019-06-26 stsp reference namespace.
1195 4e759de4 2019-06-26 stsp .Cm got branch
1196 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1198 e38d4cde 2022-03-21 naddy When deleting branches, the specified
1200 2f1457c6 2021-08-27 stsp is searched in the
1201 2f1457c6 2021-08-27 stsp .Dq refs/heads
1202 2f1457c6 2021-08-27 stsp reference namespace first.
1203 e38d4cde 2022-03-21 naddy If no corresponding branch is found, the
1204 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1205 2f1457c6 2021-08-27 stsp namespace will be searched next.
1207 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1208 ad89fa31 2019-10-04 stsp work tree's current branch.
1212 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1213 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1214 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1215 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1217 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1218 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1219 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1220 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1222 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1223 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1224 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1225 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1226 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1227 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1228 da76fce2 2020-02-24 stsp .It A Ta new file was added
1229 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1230 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1233 4e759de4 2019-06-26 stsp The options for
1234 4e759de4 2019-06-26 stsp .Cm got branch
1235 4e759de4 2019-06-26 stsp are as follows:
1236 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1237 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1238 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1239 a74f7e83 2019-11-10 stsp .Ar commit .
1240 a74f7e83 2019-11-10 stsp The expected
1241 a74f7e83 2019-11-10 stsp .Ar commit
1242 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1243 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1244 827a167b 2022-08-16 stsp .It Fl d Ar name
1245 827a167b 2022-08-16 stsp Delete the branch with the specified
1248 827a167b 2022-08-16 stsp .Dq refs/heads
1250 827a167b 2022-08-16 stsp .Dq refs/remotes
1251 827a167b 2022-08-16 stsp reference namespace.
1253 827a167b 2022-08-16 stsp Only the branch reference is deleted.
1254 827a167b 2022-08-16 stsp Any commit, tree, and blob objects belonging to the branch
1255 827a167b 2022-08-16 stsp remain in the repository and may be removed separately with
1256 827a167b 2022-08-16 stsp Git's garbage collector or
1257 827a167b 2022-08-16 stsp .Cm gotadmin cleanup .
1259 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1260 34d4e04c 2021-02-08 stsp repositories' branches in the
1261 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1262 34d4e04c 2021-02-08 stsp reference namespace.
1264 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1265 ba882ee3 2019-07-11 stsp with one the following annotations:
1266 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1267 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1268 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1271 827a167b 2022-08-16 stsp Do not switch and update the work tree after creating a new branch.
1272 827a167b 2022-08-16 stsp .It Fl r Ar repository-path
1273 827a167b 2022-08-16 stsp Use the repository at the specified path.
1274 827a167b 2022-08-16 stsp If not specified, assume the repository is located at or above the current
1275 827a167b 2022-08-16 stsp working directory.
1276 827a167b 2022-08-16 stsp If this directory is a
1278 827a167b 2022-08-16 stsp work tree, use the repository path associated with this work tree.
1280 f76670f0 2021-11-20 stsp Sort listed branches by modification time (most recently modified first)
1281 f76670f0 2021-11-20 stsp instead of sorting by lexicographical order.
1282 f76670f0 2021-11-20 stsp Branches in the
1283 f76670f0 2021-11-20 stsp .Dq refs/heads/
1284 f76670f0 2021-11-20 stsp reference namespace are listed before branches in
1285 f76670f0 2021-11-20 stsp .Dq refs/remotes/
1286 f76670f0 2021-11-20 stsp regardless.
1287 f76670f0 2021-11-20 stsp Use of this option requires the
1289 f76670f0 2021-11-20 stsp option to be used as well.
1294 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1295 5fc4f020 2022-08-30 op .Op Fl m Ar message
1296 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1297 5fc4f020 2022-08-30 op .Op Fl s Ar signer-id
1300 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1302 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1303 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1304 8e7bd50a 2019-08-22 stsp reference namespace.
1306 8e7bd50a 2019-08-22 stsp .Cm got tag
1307 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1308 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1309 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1311 80106605 2020-02-24 stsp Attempt to create a tag with the given
1312 8e7bd50a 2019-08-22 stsp .Ar name ,
1313 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1314 8e7bd50a 2019-08-22 stsp .Ar commit .
1315 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1316 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1317 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1319 8e7bd50a 2019-08-22 stsp The options for
1320 8e7bd50a 2019-08-22 stsp .Cm got tag
1321 8e7bd50a 2019-08-22 stsp are as follows:
1322 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1323 80106605 2020-02-24 stsp .It Fl c Ar commit
1324 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1325 80106605 2020-02-24 stsp .Ar commit .
1326 80106605 2020-02-24 stsp The expected
1327 80106605 2020-02-24 stsp .Ar commit
1328 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1329 80106605 2020-02-24 stsp will be resolved to a commit ID.
1330 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1331 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1333 827a167b 2022-08-16 stsp List all existing tags in the repository instead of creating a new tag.
1336 827a167b 2022-08-16 stsp argument is passed, show only the tag with the given
1337 827a167b 2022-08-16 stsp .Ar name .
1338 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1339 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1340 8e7bd50a 2019-08-22 stsp Without the
1343 3a62228f 2019-11-08 stsp .Cm got tag
1344 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1345 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1346 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1347 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1348 8e7bd50a 2019-08-22 stsp working directory.
1349 8e7bd50a 2019-08-22 stsp If this directory is a
1351 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1352 10c4445c 2022-07-04 stsp .It Fl s Ar signer-id
1353 10c4445c 2022-07-04 stsp While creating a new tag, sign this tag with the identity given in
1354 10c4445c 2022-07-04 stsp .Ar signer-id .
1356 10c4445c 2022-07-04 stsp For SSH-based signatures,
1357 10c4445c 2022-07-04 stsp .Ar signer-id
1358 10c4445c 2022-07-04 stsp is the path to a file which may refer to either a private SSH key,
1359 10c4445c 2022-07-04 stsp or a public SSH key with the private half available via
1360 10c4445c 2022-07-04 stsp .Xr ssh-agent 1 .
1361 10c4445c 2022-07-04 stsp .Cm got tag
1362 10c4445c 2022-07-04 stsp will sign the tag object by invoking
1363 10c4445c 2022-07-04 stsp .Xr ssh-keygen 1
1365 217e00e5 2022-08-16 stsp .Fl Y Cm sign
1366 10c4445c 2022-07-04 stsp command, using the signature namespace
1368 10c4445c 2022-07-04 stsp for compatibility with
1369 10c4445c 2022-07-04 stsp .Xr git 1 .
1371 10c4445c 2022-07-04 stsp Verify tag object signatures.
1374 10c4445c 2022-07-04 stsp is specified, show and verify the tag object with the provided name.
1375 10c4445c 2022-07-04 stsp Otherwise, list all tag objects and verify signatures where present.
1377 10c4445c 2022-07-04 stsp .Cm got tag
1378 10c4445c 2022-07-04 stsp verifies SSH-based signatures by invoking
1379 10c4445c 2022-07-04 stsp .Xr ssh-keygen 1
1380 10c4445c 2022-07-04 stsp with the options
1381 217e00e5 2022-08-16 stsp .Fl Y Cm verify Fl f Ar allowed_signers .
1382 10c4445c 2022-07-04 stsp A path to the
1383 10c4445c 2022-07-04 stsp .Ar allowed_signers
1384 10c4445c 2022-07-04 stsp file must be set in
1385 10c4445c 2022-07-04 stsp .Xr got.conf 5 ,
1386 10c4445c 2022-07-04 stsp otherwise verification is impossible.
1388 827a167b 2022-08-16 stsp Verbose mode.
1389 827a167b 2022-08-16 stsp During SSH signature creation and verification this option will be passed to
1390 827a167b 2022-08-16 stsp .Xr ssh-keygen 1 .
1391 827a167b 2022-08-16 stsp Multiple -v options increase the verbosity.
1392 827a167b 2022-08-16 stsp The maximum is 3.
1395 8e7bd50a 2019-08-22 stsp By design, the
1396 8e7bd50a 2019-08-22 stsp .Cm got tag
1397 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1398 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1399 8e7bd50a 2019-08-22 stsp .Cm got ref
1400 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1401 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1402 8e7bd50a 2019-08-22 stsp another repository.
1406 5fc4f020 2022-08-30 op .Ar path ...
1408 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1409 d00136be 2019-03-26 stsp repository in the next commit.
1410 ff56836b 2021-07-08 stsp By default, files which match a
1411 ff56836b 2021-07-08 stsp .Cm got status
1412 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1414 4e68cba3 2019-11-23 stsp The options for
1415 4e68cba3 2019-11-23 stsp .Cm got add
1416 4e68cba3 2019-11-23 stsp are as follows:
1417 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1419 827a167b 2022-08-16 stsp Add files even if they match a
1420 827a167b 2022-08-16 stsp .Cm got status
1421 827a167b 2022-08-16 stsp ignore pattern.
1423 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1424 4e68cba3 2019-11-23 stsp If this option is not specified,
1425 4e68cba3 2019-11-23 stsp .Cm got add
1426 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1428 4e68cba3 2019-11-23 stsp is a directory.
1434 5fc4f020 2022-08-30 op .Op Fl s Ar status-codes
1435 5fc4f020 2022-08-30 op .Ar path ...
1437 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rm
1438 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1439 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1441 2ec1f75b 2019-03-26 stsp The options for
1442 86d25a1b 2019-07-11 stsp .Cm got remove
1443 2ec1f75b 2019-03-26 stsp are as follows:
1444 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1446 4e12cd97 2022-01-25 stsp Perform the operation even if a file contains local modifications,
1447 4e12cd97 2022-01-25 stsp and do not raise an error if a specified
1449 4e12cd97 2022-01-25 stsp does not exist on disk.
1450 70e3e7f5 2019-12-13 tracey .It Fl k
1451 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1452 f2a9dc41 2019-12-13 tracey .It Fl R
1453 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1454 f2a9dc41 2019-12-13 tracey If this option is not specified,
1455 f2a9dc41 2019-12-13 tracey .Cm got remove
1456 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1457 f2a9dc41 2019-12-13 tracey .Ar path
1458 f2a9dc41 2019-12-13 tracey is a directory.
1459 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1460 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1461 766841c2 2020-08-13 stsp single-character status codes contained in the
1462 766841c2 2020-08-13 stsp .Ar status-codes
1464 766841c2 2020-08-13 stsp The following status codes may be specified:
1465 766841c2 2020-08-13 stsp .Bl -column YXZ description
1466 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1469 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1476 5fc4f020 2022-08-30 op .Op Fl c Ar commit
1477 5fc4f020 2022-08-30 op .Op Fl p Ar strip-count
1478 5fc4f020 2022-08-30 op .Op Ar patchfile
1480 e9ce266e 2022-03-07 op .Dl Pq alias: Cm pa
1481 e9ce266e 2022-03-07 op Apply changes from
1482 e9ce266e 2022-03-07 op .Ar patchfile
1483 750a3093 2022-03-13 stsp to files in a work tree.
1484 986288a6 2022-03-13 stsp Files added or removed by a patch will be scheduled for addition or removal in
1485 986288a6 2022-03-13 stsp the work tree.
1487 750a3093 2022-03-13 stsp The patch must be in the unified diff format as produced by
1488 750a3093 2022-03-13 stsp .Cm got diff ,
1489 3f3a6472 2022-03-22 stsp .Xr git-diff 1 ,
1491 750a3093 2022-03-13 stsp .Xr diff 1
1494 1a7a534e 2022-03-22 stsp diff when invoked with their
1498 e9ce266e 2022-03-07 op .Ar patchfile
1499 750a3093 2022-03-13 stsp argument is provided, read unified diff data from standard input instead.
1502 750a3093 2022-03-13 stsp .Ar patchfile
1503 e38d4cde 2022-03-21 naddy contains multiple patches, then attempt to apply each of them in sequence.
1505 3e72b288 2022-03-13 stsp Show the status of each affected file, using the following status codes:
1506 e9ce266e 2022-03-07 op .Bl -column XYZ description
1507 750a3093 2022-03-13 stsp .It M Ta file was modified
1508 9802c41c 2022-06-21 op .It G Ta file was merged using a merge-base found in the repository
1509 9802c41c 2022-06-21 op .It C Ta file was merged and conflicts occurred during merge
1510 750a3093 2022-03-13 stsp .It D Ta file was deleted
1511 750a3093 2022-03-13 stsp .It A Ta file was added
1512 60aa1fa0 2022-03-17 op .It # Ta failed to patch the file
1515 750a3093 2022-03-13 stsp If a change does not match at its exact line number, attempt to
1516 3e72b288 2022-03-13 stsp apply it somewhere else in the file if a good spot can be found.
1517 3e72b288 2022-03-13 stsp Otherwise, the patch will fail to apply.
1521 dd6c3779 2022-03-13 op will refuse to apply a patch if certain preconditions are not met.
1522 3e72b288 2022-03-13 stsp Files to be deleted must already be under version control, and must
1523 3e72b288 2022-03-13 stsp not have been scheduled for deletion already.
1524 3e72b288 2022-03-13 stsp Files to be added must not yet be under version control and must not
1525 3e72b288 2022-03-13 stsp already be present on disk.
1526 3e72b288 2022-03-13 stsp Files to be modified must already be under version control and may not
1527 3e72b288 2022-03-13 stsp contain conflict markers.
1529 dd6c3779 2022-03-13 op If an error occurs, the
1531 dd6c3779 2022-03-13 op operation will be aborted.
1532 dd6c3779 2022-03-13 op Any changes made to the work tree up to this point will be left behind.
1533 750a3093 2022-03-13 stsp Such changes can be viewed with
1534 dd6c3779 2022-03-13 op .Cm got diff
1535 dd6c3779 2022-03-13 op and can be reverted with
1536 dd6c3779 2022-03-13 op .Cm got revert
1539 899fcfdf 2022-03-13 op The options for
1540 899fcfdf 2022-03-13 op .Cm got patch
1541 899fcfdf 2022-03-13 op are as follows:
1542 899fcfdf 2022-03-13 op .Bl -tag -width Ds
1543 5f56d41e 2022-07-28 op .It Fl c Ar commit
1544 76e495bd 2022-07-29 stsp Attempt to locate files within the specified
1546 76e495bd 2022-07-29 stsp for use as a merge-base for 3-way merges.
1547 76e495bd 2022-07-29 stsp Ideally, the specified
1548 76e495bd 2022-07-29 stsp .Ar commit
1549 76e495bd 2022-07-29 stsp should contain versions of files which the changes contained in the
1550 76e495bd 2022-07-29 stsp .Ar patchfile
1551 76e495bd 2022-07-29 stsp were based on.
1552 76e495bd 2022-07-29 stsp Files will be located by path, relative to the repository root.
1555 76e495bd 2022-07-29 stsp option is used then leading path components will be stripped
1556 76e495bd 2022-07-29 stsp before paths are looked up in the repository.
1560 76e495bd 2022-07-29 stsp option is not used then
1561 76e495bd 2022-07-29 stsp .Cm got patch
1562 76e495bd 2022-07-29 stsp will attempt to locate merge-bases via object IDs found in
1563 76e495bd 2022-07-29 stsp .Ar patchfile
1564 76e495bd 2022-07-29 stsp meta-data, such as produced by
1565 76e495bd 2022-07-29 stsp .Cm got diff
1567 76e495bd 2022-07-29 stsp .Xr git-diff 1 .
1568 76e495bd 2022-07-29 stsp Use of the
1570 76e495bd 2022-07-29 stsp option is only recommended in the absence of such meta-data.
1572 76e495bd 2022-07-29 stsp In case no merge-base is available for a file, changes will be applied
1573 76e495bd 2022-07-29 stsp without doing a 3-way merge.
1574 76e495bd 2022-07-29 stsp Changes which do not apply cleanly may then be rejected entirely, rather
1575 76e495bd 2022-07-29 stsp than producing merge conflicts in the patched target file.
1577 899fcfdf 2022-03-13 op Do not make any modifications to the work tree.
1578 899fcfdf 2022-03-13 op This can be used to check whether a patch would apply without issues.
1580 899fcfdf 2022-03-13 op .Ar patchfile
1581 e38d4cde 2022-03-21 naddy contains diffs that affect the same file multiple times, the results
1582 899fcfdf 2022-03-13 op displayed may be incorrect.
1583 9d6cabd5 2022-04-07 op .It Fl p Ar strip-count
1584 9d6cabd5 2022-04-07 op Specify the number of leading path components to strip from paths
1586 9d6cabd5 2022-04-07 op .Ar patchfile .
1589 9d6cabd5 2022-04-07 op option is not used,
1593 9d6cabd5 2022-04-07 op path prefixes generated by
1594 9d6cabd5 2022-04-07 op .Xr git-diff 1
1595 9d6cabd5 2022-04-07 op will be recognized and stripped automatically.
1597 bad961bf 2022-04-23 op Reverse the patch before applying it.
1603 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
1604 5fc4f020 2022-08-30 op .Ar path ...
1606 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rv
1607 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1608 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1609 1dd86744 2019-08-12 anthony work tree's base commit.
1610 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1611 a129376b 2019-03-28 stsp .Cm got revert !
1613 e20a8b6f 2019-06-04 stsp If a file was added with
1614 e38d4cde 2022-03-21 naddy .Cm got add ,
1615 a129376b 2019-03-28 stsp it will become an unversioned file again.
1616 e20a8b6f 2019-06-04 stsp If a file was deleted with
1617 e38d4cde 2022-03-21 naddy .Cm got remove ,
1618 a129376b 2019-03-28 stsp it will be restored.
1620 0f6d7415 2019-08-08 stsp The options for
1621 0f6d7415 2019-08-08 stsp .Cm got revert
1622 0f6d7415 2019-08-08 stsp are as follows:
1623 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1624 827a167b 2022-08-16 stsp .It Fl F Ar response-script
1627 827a167b 2022-08-16 stsp option, read
1632 827a167b 2022-08-16 stsp responses line-by-line from the specified
1633 827a167b 2022-08-16 stsp .Ar response-script
1634 827a167b 2022-08-16 stsp file instead of prompting interactively.
1636 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1637 33aa809d 2019-08-08 stsp changes to revert based on
1639 33aa809d 2019-08-08 stsp (revert change),
1641 33aa809d 2019-08-08 stsp (keep change), and
1643 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1644 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1645 33aa809d 2019-08-08 stsp modified file content can be reverted.
1646 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1648 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1649 0f6d7415 2019-08-08 stsp If this option is not specified,
1650 0f6d7415 2019-08-08 stsp .Cm got revert
1651 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1653 0f6d7415 2019-08-08 stsp is a directory.
1658 12383673 2023-02-18 mark .Op Fl CNnS
1659 5fc4f020 2022-08-30 op .Op Fl A Ar author
1660 5fc4f020 2022-08-30 op .Op Fl F Ar path
1661 5fc4f020 2022-08-30 op .Op Fl m Ar message
1662 5fc4f020 2022-08-30 op .Op Ar path ...
1664 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ci
1665 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1666 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1669 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1670 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1672 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1673 1dd86744 2019-08-12 anthony .Cm got stage ,
1674 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1675 4ed9f614 2019-08-04 stsp have not been staged.
1677 28cf319f 2021-01-28 stsp .Cm got commit
1678 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1679 28cf319f 2021-01-28 stsp unless the
1681 28cf319f 2021-01-28 stsp option is used
1686 28cf319f 2021-01-28 stsp options are used together.
1688 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1689 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1690 15cd91f7 2019-05-12 stsp .It M Ta modified file
1691 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1692 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1693 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1696 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1697 996d5ccd 2019-08-05 stsp recorded base commit.
1700 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1701 15cd91f7 2019-05-12 stsp multiple base commits.
1702 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1703 47ec7be7 2019-05-12 stsp .Cm got update
1704 47ec7be7 2019-05-12 stsp across the entire work tree.
1707 15cd91f7 2019-05-12 stsp .Cm got commit
1708 15cd91f7 2019-05-12 stsp command requires the
1709 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1710 aba9c984 2019-09-08 stsp environment variable to be set,
1711 257add31 2020-09-09 stsp unless an author has been configured in
1712 257add31 2020-09-09 stsp .Xr got.conf 5
1714 aba9c984 2019-09-08 stsp .Dv user.name
1716 709ae9eb 2019-09-08 stsp .Dv user.email
1717 709ae9eb 2019-09-08 stsp configuration settings can be
1718 aba9c984 2019-09-08 stsp obtained from the repository's
1719 aba9c984 2019-09-08 stsp .Pa .git/config
1720 c9956ddf 2019-09-08 stsp file or from Git's global
1721 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1722 c9956ddf 2019-09-08 stsp configuration file.
1724 74416c47 2019-05-09 stsp The options for
1725 74416c47 2019-05-09 stsp .Cm got commit
1726 74416c47 2019-05-09 stsp are as follows:
1727 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1728 62b21d33 2022-07-19 op .It Fl A Ar author
1729 62b21d33 2022-07-19 op Set author information in the newly created commit to
1730 62b21d33 2022-07-19 op .Ar author .
1731 e8049a88 2023-02-13 op This is useful when committing changes on behalf of someone else.
1734 62b21d33 2022-07-19 op argument must use the same format as the
1735 62b21d33 2022-07-19 op .Ev GOT_AUTHOR
1736 62b21d33 2022-07-19 op environment variable.
1738 62b21d33 2022-07-19 op In addition to storing author information, the newly created commit
1739 62b21d33 2022-07-19 op object will retain
1740 62b21d33 2022-07-19 op .Dq committer
1741 62b21d33 2022-07-19 op information which is obtained, as usual, from the
1742 62b21d33 2022-07-19 op .Ev GOT_AUTHOR
1743 62b21d33 2022-07-19 op environment variable, or
1744 62b21d33 2022-07-19 op .Xr got.conf 5 ,
1745 62b21d33 2022-07-19 op or Git configuration settings.
1747 12383673 2023-02-18 mark Allow committing files in conflicted status.
1749 12383673 2023-02-18 mark Committing files with conflict markers should generally be avoided.
1750 12383673 2023-02-18 mark Cases where conflict markers must be stored in the repository for
1751 12383673 2023-02-18 mark some legitimate reason should be very rare.
1752 12383673 2023-02-18 mark There are usually ways to avoid storing conflict markers verbatim by
1753 12383673 2023-02-18 mark applying appropriate programming tricks.
1754 28cf319f 2021-01-28 stsp .It Fl F Ar path
1755 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1757 28cf319f 2021-01-28 stsp when creating the new commit.
1758 28cf319f 2021-01-28 stsp .Cm got commit
1759 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1760 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1761 28cf319f 2021-01-28 stsp Cannot be used together with the
1764 28cf319f 2021-01-28 stsp .It Fl m Ar message
1765 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1766 28cf319f 2021-01-28 stsp Cannot be used together with the
1770 28cf319f 2021-01-28 stsp This option prevents
1771 23594da9 2019-05-13 stsp .Cm got commit
1772 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1773 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1775 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1777 2a47b1e5 2022-11-01 stsp This option prevents
1778 2a47b1e5 2022-11-01 stsp .Cm got commit
1779 2a47b1e5 2022-11-01 stsp from generating a diff of the to-be-committed changes in a temporary file
1780 2a47b1e5 2022-11-01 stsp which can be viewed while editing a commit message.
1782 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1783 af358f55 2020-07-23 stsp that is under version control.
1784 af358f55 2020-07-23 stsp By default,
1785 af358f55 2020-07-23 stsp .Cm got commit
1786 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1787 35213c7c 2020-07-23 stsp As a precaution,
1789 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1790 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1791 af358f55 2020-07-23 stsp points outside of the work tree.
1792 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1793 af358f55 2020-07-23 stsp .Dq make obj
1794 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1795 af358f55 2020-07-23 stsp version control.
1798 cfce0458 2019-07-28 stsp .Cm got commit
1799 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1800 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1801 916f288c 2019-07-30 stsp .Dq refs/heads/
1802 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1803 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1804 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1805 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1806 cfce0458 2019-07-28 stsp .Cm got update
1807 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1808 cfce0458 2019-07-28 stsp in the repository.
1812 5fc4f020 2022-08-30 op .Op Fl afqTv
1813 5fc4f020 2022-08-30 op .Op Fl b Ar branch
1814 5fc4f020 2022-08-30 op .Op Fl d Ar branch
1815 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
1816 5fc4f020 2022-08-30 op .Op Fl t Ar tag
1817 5fc4f020 2022-08-30 op .Op Ar remote-repository
1819 4683a10b 2021-11-04 kn .Dl Pq alias: Cm se
1820 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
1822 f8a36e22 2021-08-26 stsp .Ar remote-repository
1823 f8a36e22 2021-08-26 stsp is specified,
1824 f8a36e22 2021-08-26 stsp .Dq origin
1825 f8a36e22 2021-08-26 stsp will be used.
1826 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
1827 f8a36e22 2021-08-26 stsp .Xr got.conf 5
1829 f8a36e22 2021-08-26 stsp .Pa config
1830 f8a36e22 2021-08-26 stsp file of the local repository, as created by
1831 f8a36e22 2021-08-26 stsp .Cm got clone .
1833 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
1834 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
1835 f8a36e22 2021-08-26 stsp Upon success, references in the
1836 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
1837 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
1838 f8a36e22 2021-08-26 stsp the commits which have been sent.
1840 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
1841 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
1842 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
1843 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
1844 fd44090b 2021-08-26 stsp be fetched from the server with
1845 f8a36e22 2021-08-26 stsp .Cm got fetch
1846 f8a36e22 2021-08-26 stsp and local branches must be rebased with
1847 f8a36e22 2021-08-26 stsp .Cm got rebase
1849 f8a36e22 2021-08-26 stsp .Cm got send
1850 f8a36e22 2021-08-26 stsp can succeed.
1853 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
1855 f8a36e22 2021-08-26 stsp The options for
1856 f8a36e22 2021-08-26 stsp .Cm got send
1857 f8a36e22 2021-08-26 stsp are as follows:
1858 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
1860 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
1861 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1862 f8a36e22 2021-08-26 stsp reference namespace.
1865 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
1868 f8a36e22 2021-08-26 stsp Cannot be used together with the
1871 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
1872 f8a36e22 2021-08-26 stsp Send the specified
1873 f8a36e22 2021-08-26 stsp .Ar branch
1874 f8a36e22 2021-08-26 stsp from the local repository's
1875 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1876 f8a36e22 2021-08-26 stsp reference namespace.
1877 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1879 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
1880 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
1881 f8a36e22 2021-08-26 stsp Cannot be used together with the
1884 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
1885 f8a36e22 2021-08-26 stsp Delete the specified
1886 f8a36e22 2021-08-26 stsp .Ar branch
1887 f8a36e22 2021-08-26 stsp from the remote repository's
1888 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1889 f8a36e22 2021-08-26 stsp reference namespace.
1890 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1891 f8a36e22 2021-08-26 stsp to delete.
1893 f8a36e22 2021-08-26 stsp Only references are deleted.
1894 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
1895 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
1896 f8a36e22 2021-08-26 stsp the server.
1898 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
1899 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
1900 fd44090b 2021-08-26 stsp based on its configuration.
1902 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
1903 fd44090b 2021-08-26 stsp in the remote repository, even when
1904 fd44090b 2021-08-26 stsp .Cm got fetch
1906 fd44090b 2021-08-26 stsp .Cm got rebase
1907 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
1908 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
1909 f8a36e22 2021-08-26 stsp configuration.
1911 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
1912 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
1913 f8a36e22 2021-08-26 stsp on the server.
1916 f8a36e22 2021-08-26 stsp .Dq refs/tags
1917 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
1918 f8a36e22 2021-08-26 stsp Use of the
1920 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
1921 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
1922 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1923 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1925 f8a36e22 2021-08-26 stsp Use of the
1927 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
1928 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
1929 f8a36e22 2021-08-26 stsp Instead of using the
1931 f8a36e22 2021-08-26 stsp option, new changes should
1932 f8a36e22 2021-08-26 stsp be fetched with
1933 f8a36e22 2021-08-26 stsp .Cm got fetch
1934 f8a36e22 2021-08-26 stsp and local branches should be rebased with
1935 f8a36e22 2021-08-26 stsp .Cm got rebase ,
1936 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
1940 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
1941 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
1942 f8a36e22 2021-08-26 stsp disposable.
1943 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
1944 f8a36e22 2021-08-26 stsp should also be taken into account.
1946 827a167b 2022-08-16 stsp Suppress progress reporting output.
1947 827a167b 2022-08-16 stsp The same option will be passed to
1949 827a167b 2022-08-16 stsp if applicable.
1950 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
1951 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
1952 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
1953 f8a36e22 2021-08-26 stsp working directory.
1954 f8a36e22 2021-08-26 stsp If this directory is a
1956 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
1958 827a167b 2022-08-16 stsp Attempt to send all tags from the local repository's
1959 827a167b 2022-08-16 stsp .Dq refs/tags/
1960 827a167b 2022-08-16 stsp reference namespace.
1963 827a167b 2022-08-16 stsp option is equivalent to listing all tags with multiple
1966 827a167b 2022-08-16 stsp Cannot be used together with the
1969 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
1970 f8a36e22 2021-08-26 stsp Send the specified
1972 f8a36e22 2021-08-26 stsp from the local repository's
1973 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1974 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
1977 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
1978 f8a36e22 2021-08-26 stsp No tags will be sent if the
1980 f8a36e22 2021-08-26 stsp option is not used.
1982 f8a36e22 2021-08-26 stsp Raise an error if the specified
1984 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
1986 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
1987 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1988 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1990 f8a36e22 2021-08-26 stsp Cannot be used together with the
1994 f8a36e22 2021-08-26 stsp Verbose mode.
1996 f8a36e22 2021-08-26 stsp .Cm got send
1997 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
1998 f8a36e22 2021-08-26 stsp The same option will be passed to
2000 f8a36e22 2021-08-26 stsp if applicable.
2001 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
2002 f8a36e22 2021-08-26 stsp The maximum is 3.
2006 9587e6cc 2023-01-28 mark .Cm cherrypick
2008 555f1fe0 2023-01-28 stsp .Op Ar commit
2010 4683a10b 2021-11-04 kn .Dl Pq alias: Cm cy
2011 234035bc 2019-06-01 stsp Merge changes from a single
2012 234035bc 2019-06-01 stsp .Ar commit
2013 234035bc 2019-06-01 stsp into the work tree.
2014 234035bc 2019-06-01 stsp The specified
2015 234035bc 2019-06-01 stsp .Ar commit
2016 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
2017 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
2018 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2019 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2021 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
2022 234035bc 2019-06-01 stsp .Bl -column YXZ description
2023 234035bc 2019-06-01 stsp .It G Ta file was merged
2024 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
2025 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
2026 234035bc 2019-06-01 stsp .It D Ta file was deleted
2027 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2028 234035bc 2019-06-01 stsp .It A Ta new file was added
2029 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2030 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2033 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
2034 234035bc 2019-06-01 stsp may be viewed with
2035 234035bc 2019-06-01 stsp .Cm got diff ,
2036 234035bc 2019-06-01 stsp amended manually or with further
2037 234035bc 2019-06-01 stsp .Cm got cherrypick
2039 234035bc 2019-06-01 stsp committed with
2040 4c16511c 2023-01-28 stsp .Cm got commit .
2042 4c16511c 2023-01-28 stsp If invoked in a work tree where no
2043 4c16511c 2023-01-28 stsp .Cm rebase ,
2044 4c16511c 2023-01-28 stsp .Cm histedit ,
2047 4c16511c 2023-01-28 stsp operation is taking place,
2048 4c16511c 2023-01-28 stsp .Cm got cherrypick
2049 4c16511c 2023-01-28 stsp creates a record of commits which have been merged into the work tree.
2050 4c16511c 2023-01-28 stsp When a file changed by
2051 4c16511c 2023-01-28 stsp .Cm got cherrypick
2052 4c16511c 2023-01-28 stsp is committed with
2053 4c16511c 2023-01-28 stsp .Cm got commit ,
2054 4c16511c 2023-01-28 stsp the log messages of relevant merged commits will then appear in the editor,
2055 91a3781a 2023-02-09 stsp where the messages should be further adjusted to convey the reasons for
2056 8bf76af3 2023-01-28 stsp cherrypicking the changes.
2057 93436ccd 2023-02-10 mark Upon exiting the editor, if the time stamp of the log message file
2058 93436ccd 2023-02-10 mark is unchanged or the log message is empty,
2059 91a3781a 2023-02-09 stsp .Cm got commit
2060 93436ccd 2023-02-10 mark will fail with an unmodified or empty log message error.
2062 4c16511c 2023-01-28 stsp If all the changes in all files touched by a given commit are discarded,
2064 4c16511c 2023-01-28 stsp .Cm got revert ,
2065 4c16511c 2023-01-28 stsp this commit's log message record will also disappear.
2067 234035bc 2019-06-01 stsp .Cm got cherrypick
2068 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
2069 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2070 234035bc 2019-06-01 stsp to a single base commit with
2071 234035bc 2019-06-01 stsp .Cm got update .
2072 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2073 234035bc 2019-06-01 stsp conflicts must be resolved first.
2075 9587e6cc 2023-01-28 mark The options for
2077 9587e6cc 2023-01-28 mark .Cm cherrypick
2078 9587e6cc 2023-01-28 mark are as follows:
2079 9587e6cc 2023-01-28 mark .Bl -tag -width Ds
2081 9587e6cc 2023-01-28 mark Display a list of commit log messages recorded by cherrypick operations,
2082 9587e6cc 2023-01-28 mark represented by references in the
2083 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2084 9587e6cc 2023-01-28 mark reference namespace.
2086 9587e6cc 2023-01-28 mark .Ar commit
2087 9587e6cc 2023-01-28 mark is specified, only show the log message of the specified commit.
2089 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by cherrypick operations
2090 9587e6cc 2023-01-28 mark in the current work tree will be displayed.
2091 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be displayed irrespective of the
2092 9587e6cc 2023-01-28 mark work tree in which they were created.
2093 9587e6cc 2023-01-28 mark This option cannot be used with
2096 9587e6cc 2023-01-28 mark Delete log messages created by previous cherrypick operations, represented by
2097 9587e6cc 2023-01-28 mark references in the
2098 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2099 9587e6cc 2023-01-28 mark reference namespace.
2101 9587e6cc 2023-01-28 mark .Ar commit
2102 9587e6cc 2023-01-28 mark is specified, only delete the log message of the specified commit.
2104 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by cherrypick operations
2105 9587e6cc 2023-01-28 mark in the current work tree will be deleted.
2106 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be deleted irrespective of the
2107 9587e6cc 2023-01-28 mark work tree in which they were created.
2108 9587e6cc 2023-01-28 mark This option cannot be used with
2114 9587e6cc 2023-01-28 mark .Cm backout
2116 555f1fe0 2023-01-28 stsp .Op Ar commit
2118 4683a10b 2021-11-04 kn .Dl Pq alias: Cm bo
2119 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
2120 5ef14e63 2019-06-02 stsp .Ar commit
2121 5ef14e63 2019-06-02 stsp into the work tree.
2122 5ef14e63 2019-06-02 stsp The specified
2123 5ef14e63 2019-06-02 stsp .Ar commit
2124 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
2125 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
2126 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2127 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
2129 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
2130 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
2131 5ef14e63 2019-06-02 stsp .It G Ta file was merged
2132 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
2133 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
2134 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
2135 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2136 5ef14e63 2019-06-02 stsp .It A Ta new file was added
2137 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2138 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2141 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
2142 5ef14e63 2019-06-02 stsp which may be viewed with
2143 5ef14e63 2019-06-02 stsp .Cm got diff ,
2144 5ef14e63 2019-06-02 stsp amended manually or with further
2145 778a73c2 2019-07-12 stsp .Cm got backout
2147 5ef14e63 2019-06-02 stsp committed with
2148 4c16511c 2023-01-28 stsp .Cm got commit .
2150 4c16511c 2023-01-28 stsp If invoked in a work tree where no
2151 4c16511c 2023-01-28 stsp .Cm rebase ,
2152 4c16511c 2023-01-28 stsp .Cm histedit ,
2155 4c16511c 2023-01-28 stsp operation is taking place,
2156 4c16511c 2023-01-28 stsp .Cm got backout
2157 4c16511c 2023-01-28 stsp creates a record of commits which have been reverse-merged into the work tree.
2158 4c16511c 2023-01-28 stsp When a file changed by
2159 4c16511c 2023-01-28 stsp .Cm got backout
2160 4c16511c 2023-01-28 stsp is committed with
2161 4c16511c 2023-01-28 stsp .Cm got commit ,
2162 4c16511c 2023-01-28 stsp the log messages of relevant reverse-merged commits will then appear in
2163 91a3781a 2023-02-09 stsp the editor, where the messages should be further adjusted to convey the
2164 8bf76af3 2023-01-28 stsp reasons for backing out the changes.
2165 93436ccd 2023-02-10 mark Upon exiting the editor, if the time stamp of the log message file
2166 93436ccd 2023-02-10 mark is unchanged or the log message is empty,
2167 91a3781a 2023-02-09 stsp .Cm got commit
2168 93436ccd 2023-02-10 mark will fail with an unmodified or empty log message error.
2170 4c16511c 2023-01-28 stsp If all the changes in all files touched by a given commit are discarded,
2172 4c16511c 2023-01-28 stsp .Cm got revert ,
2173 4c16511c 2023-01-28 stsp this commit's log message record will also disappear.
2175 92228c38 2019-06-02 stsp .Cm got backout
2176 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
2177 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2178 92228c38 2019-06-02 stsp to a single base commit with
2179 92228c38 2019-06-02 stsp .Cm got update .
2180 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
2181 92228c38 2019-06-02 stsp conflicts must be resolved first.
2183 9587e6cc 2023-01-28 mark The options for
2185 9587e6cc 2023-01-28 mark .Cm backout
2186 9587e6cc 2023-01-28 mark are as follows:
2187 9587e6cc 2023-01-28 mark .Bl -tag -width Ds
2189 9587e6cc 2023-01-28 mark Display a list of commit log messages recorded by backout operations,
2190 9587e6cc 2023-01-28 mark represented by references in the
2191 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2192 9587e6cc 2023-01-28 mark reference namespace.
2194 9587e6cc 2023-01-28 mark .Ar commit
2195 9587e6cc 2023-01-28 mark is specified, only show the log message of the specified commit.
2197 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by backout operations
2198 9587e6cc 2023-01-28 mark in the current work tree will be displayed.
2199 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be displayed irrespective of the
2200 9587e6cc 2023-01-28 mark work tree in which they were created.
2201 9587e6cc 2023-01-28 mark This option cannot be used with
2204 9587e6cc 2023-01-28 mark Delete log messages created by previous backout operations, represented by
2205 9587e6cc 2023-01-28 mark references in the
2206 9587e6cc 2023-01-28 mark .Dq refs/got/worktree
2207 9587e6cc 2023-01-28 mark reference namespace.
2209 9587e6cc 2023-01-28 mark .Ar commit
2210 9587e6cc 2023-01-28 mark is specified, only delete the log message of the specified commit.
2212 9587e6cc 2023-01-28 mark If invoked in a work tree, only log messages recorded by backout operations
2213 9587e6cc 2023-01-28 mark in the current work tree will be deleted.
2214 9587e6cc 2023-01-28 mark Otherwise, all commit log messages will be deleted irrespective of the
2215 9587e6cc 2023-01-28 mark work tree in which they were created.
2216 9587e6cc 2023-01-28 mark This option cannot be used with
2223 12383673 2023-02-18 mark .Op Fl aCclX
2224 5fc4f020 2022-08-30 op .Op Ar branch
2226 4683a10b 2021-11-04 kn .Dl Pq alias: Cm rb
2227 818c7501 2019-07-11 stsp Rebase commits on the specified
2228 818c7501 2019-07-11 stsp .Ar branch
2229 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
2231 818c7501 2019-07-11 stsp .Ar branch
2232 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
2233 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
2234 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
2235 818c7501 2019-07-11 stsp .Ar branch
2236 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
2237 f09e2405 2019-07-11 stsp of the specified
2238 818c7501 2019-07-11 stsp .Ar branch
2239 f09e2405 2019-07-11 stsp has been rebased.
2242 2b6826ba 2020-02-24 stsp .Cm got rebase
2243 2b6826ba 2020-02-24 stsp is used as intended, the specified
2244 2b6826ba 2020-02-24 stsp .Ar branch
2245 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
2246 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
2247 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
2248 2b6826ba 2020-02-24 stsp .Cm got update -b
2249 2b6826ba 2020-02-24 stsp before starting the
2250 2b6826ba 2020-02-24 stsp .Cm rebase
2251 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
2252 2b6826ba 2020-02-24 stsp a common history with the specified
2253 2b6826ba 2020-02-24 stsp .Ar branch
2254 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
2255 c10890ce 2020-02-25 stsp remote repository.
2257 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
2258 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
2259 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
2260 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
2261 818c7501 2019-07-11 stsp .Ar branch ,
2262 818c7501 2019-07-11 stsp but with different commit IDs.
2263 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
2264 f09e2405 2019-07-11 stsp the new version of the specified
2265 818c7501 2019-07-11 stsp .Ar branch
2266 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
2267 7f5531cd 2022-07-22 stsp If author information is available via the
2268 7f5531cd 2022-07-22 stsp .Ev GOT_AUTHOR
2269 7f5531cd 2022-07-22 stsp environment variable,
2270 7f5531cd 2022-07-22 stsp .Xr got.conf 5
2272 7f5531cd 2022-07-22 stsp .Dv user.name
2274 7f5531cd 2022-07-22 stsp .Dv user.email
2275 7f5531cd 2022-07-22 stsp configuration settings, this author information will be used to identify
2277 7f5531cd 2022-07-22 stsp .Dq committer
2278 7f5531cd 2022-07-22 stsp of rebased commits.
2280 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
2281 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2282 e600f124 2021-03-21 stsp reference namespace.
2283 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
2284 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2285 e600f124 2021-03-21 stsp .Cm got rebase -l
2287 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2288 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2289 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2291 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
2292 818c7501 2019-07-11 stsp using the following status codes:
2293 818c7501 2019-07-11 stsp .Bl -column YXZ description
2294 818c7501 2019-07-11 stsp .It G Ta file was merged
2295 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
2296 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
2297 818c7501 2019-07-11 stsp .It D Ta file was deleted
2298 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2299 818c7501 2019-07-11 stsp .It A Ta new file was added
2300 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2301 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2304 e38d4cde 2022-03-21 naddy If merge conflicts occur, the rebase operation is interrupted and may
2305 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
2306 1fa49072 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
2307 1fa49072 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
2308 1fa49072 2021-09-28 stsp the rebase operation will be interrupted to prevent potentially incomplete
2309 1fa49072 2021-09-28 stsp changes from being committed to the repository without user intervention.
2310 1fa49072 2021-09-28 stsp The work tree may be modified as desired and the rebase operation can be
2311 1fa49072 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
2312 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
2313 818c7501 2019-07-11 stsp .Ar branch
2314 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
2316 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
2317 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
2318 f09e2405 2019-07-11 stsp when the rebase operation continues.
2320 818c7501 2019-07-11 stsp .Cm got rebase
2321 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
2323 442ede73 2022-09-04 stsp .Ar branch
2324 442ede73 2022-09-04 stsp is not in the
2325 442ede73 2022-09-04 stsp .Dq refs/heads/
2326 442ede73 2022-09-04 stsp reference namespace, the branch may not be rebased.
2327 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
2328 e38d4cde 2022-03-21 naddy branch, then the work tree must first be updated with
2329 818c7501 2019-07-11 stsp .Cm got update .
2330 4ed9f614 2019-08-04 stsp If changes have been staged with
2331 4ed9f614 2019-08-04 stsp .Cm got stage ,
2332 bc3056e3 2019-08-18 stsp these changes must first be committed with
2333 4ed9f614 2019-08-04 stsp .Cm got commit
2334 4ed9f614 2019-08-04 stsp or unstaged with
2335 4ed9f614 2019-08-04 stsp .Cm got unstage .
2336 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
2337 f09e2405 2019-07-11 stsp committed with
2338 f09e2405 2019-07-11 stsp .Cm got commit
2339 f09e2405 2019-07-11 stsp or reverted with
2340 f09e2405 2019-07-11 stsp .Cm got revert .
2342 64c6d990 2019-07-11 stsp .Ar branch
2343 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
2344 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
2347 dae92a24 2023-01-08 stsp .Cm got update ,
2348 dae92a24 2023-01-08 stsp .Cm got integrate ,
2349 dae92a24 2023-01-08 stsp .Cm got merge ,
2350 dae92a24 2023-01-08 stsp .Cm got commit ,
2352 dae92a24 2023-01-08 stsp .Cm got histedit
2353 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
2354 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
2355 7d5807f4 2019-07-11 stsp conflict resolution purposes.
2357 2af61735 2021-11-03 stsp If the specified
2358 2af61735 2021-11-03 stsp .Ar branch
2359 e38d4cde 2022-03-21 naddy is already based on the work tree's current branch, then no commits
2360 2af61735 2021-11-03 stsp need to be rebased and
2361 2af61735 2021-11-03 stsp .Cm got rebase
2362 2af61735 2021-11-03 stsp will simply switch the work tree to the specified
2363 2af61735 2021-11-03 stsp .Ar branch
2364 2af61735 2021-11-03 stsp and update files in the work tree accordingly.
2366 818c7501 2019-07-11 stsp The options for
2367 818c7501 2019-07-11 stsp .Cm got rebase
2368 818c7501 2019-07-11 stsp are as follows:
2369 818c7501 2019-07-11 stsp .Bl -tag -width Ds
2371 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
2372 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2374 12383673 2023-02-18 mark Allow a rebase operation to continue with files in conflicted status.
2375 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
2379 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
2380 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2382 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
2383 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
2384 e600f124 2021-03-21 stsp reference namespace.
2386 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2387 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
2388 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2389 e600f124 2021-03-21 stsp Given these object IDs,
2391 e600f124 2021-03-21 stsp .Cm got log
2392 e600f124 2021-03-21 stsp command with the
2396 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2398 e600f124 2021-03-21 stsp .Cm got branch
2399 e600f124 2021-03-21 stsp command with the
2401 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
2404 e600f124 2021-03-21 stsp .Ar branch
2405 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2407 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2409 e600f124 2021-03-21 stsp If this option is used,
2410 e600f124 2021-03-21 stsp .Cm got rebase
2411 e600f124 2021-03-21 stsp does not require a work tree.
2412 e600f124 2021-03-21 stsp None of the other options can be used together with
2415 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
2417 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
2418 643b85bc 2021-07-16 stsp reference namespace.
2421 643b85bc 2021-07-16 stsp .Ar branch
2422 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2423 643b85bc 2021-07-16 stsp this branch.
2424 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2425 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
2427 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2428 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2429 643b85bc 2021-07-16 stsp Git's garbage collector or
2430 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2432 643b85bc 2021-07-16 stsp If this option is used,
2433 643b85bc 2021-07-16 stsp .Cm got rebase
2434 643b85bc 2021-07-16 stsp does not require a work tree.
2435 643b85bc 2021-07-16 stsp None of the other options can be used together with
2440 5fc4f020 2022-08-30 op .Cm histedit
2441 12383673 2023-02-18 mark .Op Fl aCcdeflmX
2442 5fc4f020 2022-08-30 op .Op Fl F Ar histedit-script
2443 5fc4f020 2022-08-30 op .Op Ar branch
2445 4683a10b 2021-11-04 kn .Dl Pq alias: Cm he
2446 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
2447 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
2450 7f5531cd 2022-07-22 stsp .Cm got histedit
2451 7f5531cd 2022-07-22 stsp command requires the
2452 7f5531cd 2022-07-22 stsp .Ev GOT_AUTHOR
2453 7f5531cd 2022-07-22 stsp environment variable to be set,
2454 7f5531cd 2022-07-22 stsp unless an author has been configured in
2455 7f5531cd 2022-07-22 stsp .Xr got.conf 5
2457 7f5531cd 2022-07-22 stsp .Dv user.name
2459 7f5531cd 2022-07-22 stsp .Dv user.email
2460 7f5531cd 2022-07-22 stsp configuration settings can be obtained from the repository's
2461 7f5531cd 2022-07-22 stsp .Pa .git/config
2462 7f5531cd 2022-07-22 stsp file or from Git's global
2463 7f5531cd 2022-07-22 stsp .Pa ~/.gitconfig
2464 7f5531cd 2022-07-22 stsp configuration file.
2466 6e54d307 2020-02-24 stsp Before starting a
2467 6e54d307 2020-02-24 stsp .Cm histedit
2468 e38d4cde 2022-03-21 naddy operation, the work tree's current branch must be set with
2469 6e54d307 2020-02-24 stsp .Cm got update -b
2470 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
2471 6e54d307 2020-02-24 stsp current branch of the work tree.
2472 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
2473 6e54d307 2020-02-24 stsp touched by the
2474 6e54d307 2020-02-24 stsp .Cm histedit
2475 6e54d307 2020-02-24 stsp operation.
2477 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
2478 6e54d307 2020-02-24 stsp must be set with
2479 6e54d307 2020-02-24 stsp .Cm got update -c
2480 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
2481 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
2483 6e54d307 2020-02-24 stsp .Cm histedit
2484 6e54d307 2020-02-24 stsp operation.
2486 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
2487 0ebf8283 2019-07-24 stsp .Ar histedit script
2488 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
2489 46fa4c83 2020-02-24 stsp command line, or generated with the
2495 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
2496 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
2497 0ebf8283 2019-07-24 stsp whitespace and an argument.
2498 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
2499 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
2500 0ebf8283 2019-07-24 stsp Lines which begin with the
2502 0ebf8283 2019-07-24 stsp character are ignored entirely.
2504 d42bbff9 2022-07-12 stsp The available histedit script commands are as follows:
2505 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
2506 d42bbff9 2022-07-12 stsp .It Cm pick Ar commit Ta Use the specified commit as it is.
2507 d42bbff9 2022-07-12 stsp .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2508 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
2509 d42bbff9 2022-07-12 stsp .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2510 0ebf8283 2019-07-24 stsp listed further below that will be used.
2511 d42bbff9 2022-07-12 stsp .It Cm drop Ar commit Ta Remove this commit from the edited history.
2512 d42bbff9 2022-07-12 stsp .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2513 d42bbff9 2022-07-12 stsp a preceding
2517 d42bbff9 2022-07-12 stsp command on the previous line of the histedit script.
2518 c5d51f20 2022-07-11 stsp The optional
2519 c5d51f20 2022-07-11 stsp .Ar log-message
2520 c5d51f20 2022-07-11 stsp argument provides a new single-line log message to use.
2522 c5d51f20 2022-07-11 stsp .Ar log-message
2523 c5d51f20 2022-07-11 stsp argument is omitted, open an editor where a new log message can be written.
2526 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
2527 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
2528 5b87815e 2020-03-05 stsp No commit may be listed more than once.
2530 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
2531 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
2532 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
2533 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
2534 498a90b7 2019-07-25 stsp switched to it.
2536 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
2537 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2538 e600f124 2021-03-21 stsp reference namespace.
2539 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
2540 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
2541 e600f124 2021-03-21 stsp .Cm got histedit -l
2543 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
2544 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
2545 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
2547 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
2548 0ebf8283 2019-07-24 stsp using the following status codes:
2549 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
2550 0ebf8283 2019-07-24 stsp .It G Ta file was merged
2551 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
2552 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
2553 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
2554 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2555 0ebf8283 2019-07-24 stsp .It A Ta new file was added
2556 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2557 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
2560 e38d4cde 2022-03-21 naddy If merge conflicts occur, the histedit operation is interrupted and may
2561 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
2562 cd33da48 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
2563 cd33da48 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
2564 cd33da48 2021-09-28 stsp the histedit operation will be interrupted to prevent potentially incomplete
2565 cd33da48 2021-09-28 stsp changes from being committed to the repository without user intervention.
2566 cd33da48 2021-09-28 stsp The work tree may be modified as desired and the histedit operation can be
2567 cd33da48 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
2568 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
2569 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
2571 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
2572 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
2573 0ebf8283 2019-07-24 stsp when the histedit operation continues.
2575 0ebf8283 2019-07-24 stsp .Cm got histedit
2576 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
2577 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
2578 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
2579 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
2580 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2581 0ebf8283 2019-07-24 stsp to a single base commit with
2582 0ebf8283 2019-07-24 stsp .Cm got update .
2583 4ed9f614 2019-08-04 stsp If changes have been staged with
2584 4ed9f614 2019-08-04 stsp .Cm got stage ,
2585 bc3056e3 2019-08-18 stsp these changes must first be committed with
2586 4ed9f614 2019-08-04 stsp .Cm got commit
2587 4ed9f614 2019-08-04 stsp or unstaged with
2588 4ed9f614 2019-08-04 stsp .Cm got unstage .
2589 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
2590 0ebf8283 2019-07-24 stsp committed with
2591 0ebf8283 2019-07-24 stsp .Cm got commit
2592 0ebf8283 2019-07-24 stsp or reverted with
2593 0ebf8283 2019-07-24 stsp .Cm got revert .
2594 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
2595 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
2598 7ef62c4e 2020-02-24 stsp .Cm got update ,
2599 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
2600 dae92a24 2023-01-08 stsp .Cm got merge ,
2602 65db4ffb 2020-02-24 stsp .Cm got integrate
2603 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
2604 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
2605 0ebf8283 2019-07-24 stsp .Cm got commit
2606 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
2607 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
2609 0ebf8283 2019-07-24 stsp The options for
2610 0ebf8283 2019-07-24 stsp .Cm got histedit
2611 0ebf8283 2019-07-24 stsp are as follows:
2612 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
2614 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
2615 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2617 12383673 2023-02-18 mark Allow a histedit operation to continue with files in conflicted status.
2618 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
2622 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
2623 f1c9fe20 2023-01-30 mark If this option is used, no other command-line arguments are allowed.
2625 f1c9fe20 2023-01-30 mark Drop all commits.
2626 f1c9fe20 2023-01-30 mark This option is a quick equivalent to a histedit script which drops all
2630 f1c9fe20 2023-01-30 mark option can only be used when starting a new histedit operation.
2631 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2633 b93c7142 2021-10-01 stsp Interrupt the histedit operation for editing after merging each commit.
2634 b93c7142 2021-10-01 stsp This option is a quick equivalent to a histedit script which uses the
2636 b93c7142 2021-10-01 stsp command for all commits.
2639 b93c7142 2021-10-01 stsp option can only be used when starting a new histedit operation.
2640 b93c7142 2021-10-01 stsp If this option is used, no other command-line arguments are allowed.
2641 827a167b 2022-08-16 stsp .It Fl F Ar histedit-script
2642 827a167b 2022-08-16 stsp Use the specified
2643 827a167b 2022-08-16 stsp .Ar histedit-script
2644 827a167b 2022-08-16 stsp instead of opening a temporary file in an editor where a histedit script
2645 827a167b 2022-08-16 stsp can be written.
2647 466785b9 2020-12-10 jrick Fold all commits into a single commit.
2648 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
2649 466785b9 2020-12-10 jrick commits, combining them all into one commit.
2652 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
2653 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
2655 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
2656 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2657 e600f124 2021-03-21 stsp reference namespace.
2659 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2660 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
2661 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2662 e600f124 2021-03-21 stsp Given these object IDs,
2664 e600f124 2021-03-21 stsp .Cm got log
2665 e600f124 2021-03-21 stsp command with the
2669 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2671 e600f124 2021-03-21 stsp .Cm got branch
2672 e600f124 2021-03-21 stsp command with the
2674 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
2677 e600f124 2021-03-21 stsp .Ar branch
2678 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2680 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2682 e600f124 2021-03-21 stsp If this option is used,
2683 e600f124 2021-03-21 stsp .Cm got histedit
2684 e600f124 2021-03-21 stsp does not require a work tree.
2685 e600f124 2021-03-21 stsp None of the other options can be used together with
2688 827a167b 2022-08-16 stsp Edit log messages only.
2689 827a167b 2022-08-16 stsp This option is a quick equivalent to a histedit script which edits
2690 827a167b 2022-08-16 stsp only log messages but otherwise leaves every picked commit as-is.
2693 827a167b 2022-08-16 stsp option can only be used when starting a new histedit operation.
2694 827a167b 2022-08-16 stsp If this option is used, no other command-line arguments are allowed.
2696 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
2698 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
2699 643b85bc 2021-07-16 stsp reference namespace.
2702 643b85bc 2021-07-16 stsp .Ar branch
2703 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2704 643b85bc 2021-07-16 stsp this branch.
2705 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2706 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
2708 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2709 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2710 643b85bc 2021-07-16 stsp Git's garbage collector or
2711 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2713 643b85bc 2021-07-16 stsp If this option is used,
2714 643b85bc 2021-07-16 stsp .Cm got histedit
2715 643b85bc 2021-07-16 stsp does not require a work tree.
2716 643b85bc 2021-07-16 stsp None of the other options can be used together with
2720 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
2721 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ig
2722 2822a352 2019-10-15 stsp Integrate the specified
2723 2822a352 2019-10-15 stsp .Ar branch
2724 2822a352 2019-10-15 stsp into the work tree's current branch.
2725 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
2726 2822a352 2019-10-15 stsp .Ar branch ,
2727 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
2728 2822a352 2019-10-15 stsp head commit of the integrated
2729 2822a352 2019-10-15 stsp .Ar branch .
2731 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
2732 2822a352 2019-10-15 stsp will be pointing at the same commit.
2733 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
2734 2822a352 2019-10-15 stsp In case the integrated
2735 2822a352 2019-10-15 stsp .Ar branch
2736 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
2737 2822a352 2019-10-15 stsp .Cm got branch -d .
2739 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
2740 2822a352 2019-10-15 stsp .Bl -column YXZ description
2741 2822a352 2019-10-15 stsp .It U Ta file was updated
2742 2822a352 2019-10-15 stsp .It D Ta file was deleted
2743 2822a352 2019-10-15 stsp .It A Ta new file was added
2744 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
2745 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
2748 2822a352 2019-10-15 stsp .Cm got integrate
2749 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
2750 2822a352 2019-10-15 stsp Most importantly, the
2751 2822a352 2019-10-15 stsp .Ar branch
2752 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
2753 2822a352 2019-10-15 stsp .Cm got rebase
2754 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
2755 2822a352 2019-10-15 stsp resolve merge conflicts.
2756 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2757 2822a352 2019-10-15 stsp to a single base commit with
2758 2822a352 2019-10-15 stsp .Cm got update .
2759 2822a352 2019-10-15 stsp If changes have been staged with
2760 2822a352 2019-10-15 stsp .Cm got stage ,
2761 2822a352 2019-10-15 stsp these changes must first be committed with
2762 2822a352 2019-10-15 stsp .Cm got commit
2763 2822a352 2019-10-15 stsp or unstaged with
2764 2822a352 2019-10-15 stsp .Cm got unstage .
2765 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
2766 2822a352 2019-10-15 stsp committed with
2767 2822a352 2019-10-15 stsp .Cm got commit
2768 2822a352 2019-10-15 stsp or reverted with
2769 2822a352 2019-10-15 stsp .Cm got revert .
2773 12383673 2023-02-18 mark .Op Fl aCcn
2774 5fc4f020 2022-08-30 op .Op Ar branch
2776 4683a10b 2021-11-04 kn .Dl Pq alias: Cm mg
2777 f259c4c1 2021-09-24 stsp Create a merge commit based on the current branch of the work tree and
2778 f259c4c1 2021-09-24 stsp the specified
2779 f259c4c1 2021-09-24 stsp .Ar branch .
2780 f259c4c1 2021-09-24 stsp If a linear project history is desired, then use of
2781 f259c4c1 2021-09-24 stsp .Cm got rebase
2782 f259c4c1 2021-09-24 stsp should be preferred over
2783 f259c4c1 2021-09-24 stsp .Cm got merge .
2784 f259c4c1 2021-09-24 stsp However, even strictly linear projects may require merge commits in order
2785 4e91ef15 2021-09-26 stsp to merge in new versions of third-party code stored on vendor branches
2786 4e91ef15 2021-09-26 stsp created with
2787 4e91ef15 2021-09-26 stsp .Cm got import .
2789 f259c4c1 2021-09-24 stsp Merge commits are commits based on multiple parent commits.
2790 f259c4c1 2021-09-24 stsp The tip commit of the work tree's current branch, which must be set with
2791 f259c4c1 2021-09-24 stsp .Cm got update -b
2792 f259c4c1 2021-09-24 stsp before starting the
2794 f259c4c1 2021-09-24 stsp operation, will be used as the first parent.
2795 f259c4c1 2021-09-24 stsp The tip commit of the specified
2796 f259c4c1 2021-09-24 stsp .Ar branch
2797 f259c4c1 2021-09-24 stsp will be used as the second parent.
2799 4e91ef15 2021-09-26 stsp No ancestral relationship between the two branches is required.
2800 4e91ef15 2021-09-26 stsp If the two branches have already been merged previously, only new changes
2801 4e91ef15 2021-09-26 stsp will be merged.
2803 f259c4c1 2021-09-24 stsp It is not possible to create merge commits with more than two parents.
2804 f259c4c1 2021-09-24 stsp If more than one branch needs to be merged, then multiple merge commits
2805 f259c4c1 2021-09-24 stsp with two parents each can be created in sequence.
2807 f259c4c1 2021-09-24 stsp While merging changes found on the
2808 f259c4c1 2021-09-24 stsp .Ar branch
2809 f259c4c1 2021-09-24 stsp into the work tree, show the status of each affected file,
2810 f259c4c1 2021-09-24 stsp using the following status codes:
2811 f259c4c1 2021-09-24 stsp .Bl -column YXZ description
2812 f259c4c1 2021-09-24 stsp .It G Ta file was merged
2813 f259c4c1 2021-09-24 stsp .It C Ta file was merged and conflicts occurred during merge
2814 f259c4c1 2021-09-24 stsp .It ! Ta changes destined for a missing file were not merged
2815 f259c4c1 2021-09-24 stsp .It D Ta file was deleted
2816 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2817 f259c4c1 2021-09-24 stsp .It A Ta new file was added
2818 f259c4c1 2021-09-24 stsp .It \(a~ Ta changes destined for a non-regular file were not merged
2819 f259c4c1 2021-09-24 stsp .It ? Ta changes destined for an unversioned file were not merged
2822 f259c4c1 2021-09-24 stsp If merge conflicts occur, the merge operation is interrupted and conflicts
2823 f259c4c1 2021-09-24 stsp must be resolved before the merge operation can continue.
2824 606719cd 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
2825 606719cd 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
2826 f259c4c1 2021-09-24 stsp the merge operation will be interrupted to prevent potentially incomplete
2827 f259c4c1 2021-09-24 stsp changes from being committed to the repository without user intervention.
2828 f259c4c1 2021-09-24 stsp The work tree may be modified as desired and the merge can be continued
2829 f259c4c1 2021-09-24 stsp once the changes present in the work tree are considered complete.
2830 f259c4c1 2021-09-24 stsp Alternatively, the merge operation may be aborted which will leave
2831 f259c4c1 2021-09-24 stsp the work tree's current branch unmodified.
2833 f259c4c1 2021-09-24 stsp If a merge conflict is resolved in a way which renders all merged
2834 f259c4c1 2021-09-24 stsp changes into no-op changes, the merge operation cannot continue
2835 f259c4c1 2021-09-24 stsp and must be aborted.
2837 f259c4c1 2021-09-24 stsp .Cm got merge
2838 f259c4c1 2021-09-24 stsp will refuse to run if certain preconditions are not met.
2839 f259c4c1 2021-09-24 stsp If history of the
2840 f259c4c1 2021-09-24 stsp .Ar branch
2841 f259c4c1 2021-09-24 stsp is based on the work tree's current branch, then no merge commit can
2842 f259c4c1 2021-09-24 stsp be created and
2843 f259c4c1 2021-09-24 stsp .Cm got integrate
2844 f259c4c1 2021-09-24 stsp may be used to integrate the
2845 f259c4c1 2021-09-24 stsp .Ar branch
2847 f259c4c1 2021-09-24 stsp If the work tree is not yet fully updated to the tip commit of its
2848 f259c4c1 2021-09-24 stsp branch, then the work tree must first be updated with
2849 f259c4c1 2021-09-24 stsp .Cm got update .
2850 e38d4cde 2022-03-21 naddy If the work tree contains multiple base commits, it must first be updated
2851 f259c4c1 2021-09-24 stsp to a single base commit with
2852 f259c4c1 2021-09-24 stsp .Cm got update .
2853 f259c4c1 2021-09-24 stsp If changes have been staged with
2854 f259c4c1 2021-09-24 stsp .Cm got stage ,
2855 f259c4c1 2021-09-24 stsp these changes must first be committed with
2856 f259c4c1 2021-09-24 stsp .Cm got commit
2857 f259c4c1 2021-09-24 stsp or unstaged with
2858 f259c4c1 2021-09-24 stsp .Cm got unstage .
2859 f259c4c1 2021-09-24 stsp If the work tree contains local changes, these changes must first be
2860 f259c4c1 2021-09-24 stsp committed with
2861 f259c4c1 2021-09-24 stsp .Cm got commit
2862 f259c4c1 2021-09-24 stsp or reverted with
2863 f259c4c1 2021-09-24 stsp .Cm got revert .
2865 f259c4c1 2021-09-24 stsp .Ar branch
2866 f259c4c1 2021-09-24 stsp contains changes to files outside of the work tree's path prefix,
2867 f259c4c1 2021-09-24 stsp the work tree cannot be used to merge this branch.
2870 f259c4c1 2021-09-24 stsp .Cm got update ,
2871 f259c4c1 2021-09-24 stsp .Cm got commit ,
2872 f259c4c1 2021-09-24 stsp .Cm got rebase ,
2873 90e6e620 2021-10-04 kn .Cm got histedit ,
2874 f259c4c1 2021-09-24 stsp .Cm got integrate ,
2876 f259c4c1 2021-09-24 stsp .Cm got stage
2877 f259c4c1 2021-09-24 stsp commands will refuse to run while a merge operation is in progress.
2878 f259c4c1 2021-09-24 stsp Other commands which manipulate the work tree may be used for
2879 f259c4c1 2021-09-24 stsp conflict resolution purposes.
2881 f259c4c1 2021-09-24 stsp The options for
2882 f259c4c1 2021-09-24 stsp .Cm got merge
2883 f259c4c1 2021-09-24 stsp are as follows:
2884 f259c4c1 2021-09-24 stsp .Bl -tag -width Ds
2886 f259c4c1 2021-09-24 stsp Abort an interrupted merge operation.
2887 f259c4c1 2021-09-24 stsp If this option is used, no other command-line arguments are allowed.
2889 12383673 2023-02-18 mark Allow a merge operation to continue with files in conflicted status.
2890 12383673 2023-02-18 mark This option should generally be avoided, and can only be used with the
2894 f259c4c1 2021-09-24 stsp Continue an interrupted merge operation.
2895 f259c4c1 2021-09-24 stsp If this option is used, no other command-line arguments are allowed.
2897 088449d3 2021-09-26 stsp Merge changes into the work tree as usual but do not create a merge
2898 088449d3 2021-09-26 stsp commit immediately.
2899 088449d3 2021-09-26 stsp The merge result can be adjusted as desired before a merge commit is
2900 088449d3 2021-09-26 stsp created with
2901 088449d3 2021-09-26 stsp .Cm got merge -c .
2902 088449d3 2021-09-26 stsp Alternatively, the merge may be aborted with
2903 088449d3 2021-09-26 stsp .Cm got merge -a .
2909 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
2910 5fc4f020 2022-08-30 op .Op Ar path ...
2912 4683a10b 2021-11-04 kn .Dl Pq alias: Cm sg
2913 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
2916 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
2917 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
2918 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
2919 4ed9f614 2019-08-04 stsp .Cm got status .
2921 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2922 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
2923 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
2924 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
2925 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
2928 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
2929 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
2930 9d8b19a4 2019-08-04 stsp committed.
2932 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
2933 4ed9f614 2019-08-04 stsp .Cm got commit ,
2934 4ed9f614 2019-08-04 stsp .Cm got status ,
2936 4ed9f614 2019-08-04 stsp .Cm got diff .
2937 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
2938 4ed9f614 2019-08-04 stsp .Cm got commit
2939 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
2940 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
2941 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
2943 4ed9f614 2019-08-04 stsp .Cm got status
2944 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
2946 4ed9f614 2019-08-04 stsp .Cm got diff
2947 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
2948 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
2950 4ed9f614 2019-08-04 stsp .Cm got revert
2951 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
2952 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
2954 4ed9f614 2019-08-04 stsp The options for
2955 4ed9f614 2019-08-04 stsp .Cm got stage
2956 4ed9f614 2019-08-04 stsp are as follows:
2957 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
2958 827a167b 2022-08-16 stsp .It Fl F Ar response-script
2961 827a167b 2022-08-16 stsp option, read
2966 827a167b 2022-08-16 stsp responses line-by-line from the specified
2967 827a167b 2022-08-16 stsp .Ar response-script
2968 827a167b 2022-08-16 stsp file instead of prompting interactively.
2970 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
2971 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
2972 e38d4cde 2022-03-21 naddy If paths were provided on the command line, show the staged paths
2973 1dd86744 2019-08-12 anthony among the specified paths.
2974 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
2976 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
2977 dc424a06 2019-08-07 stsp select or reject changes for staging based on
2979 6d23ec10 2019-08-08 stsp (stage change),
2981 6d23ec10 2019-08-08 stsp (reject change), and
2983 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
2984 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
2985 dc424a06 2019-08-07 stsp modified file content can be staged.
2986 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
2987 6d23ec10 2019-08-08 stsp their entirety.
2989 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
2990 af358f55 2020-07-23 stsp that is under version control.
2991 af358f55 2020-07-23 stsp By default,
2992 af358f55 2020-07-23 stsp .Cm got stage
2993 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2994 35213c7c 2020-07-23 stsp As a precaution,
2996 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2997 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2998 af358f55 2020-07-23 stsp points outside of the work tree.
2999 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
3000 af358f55 2020-07-23 stsp .Dq make obj
3001 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
3002 af358f55 2020-07-23 stsp version control.
3005 4ed9f614 2019-08-04 stsp .Cm got stage
3006 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
3007 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
3008 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
3009 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
3010 4ed9f614 2019-08-04 stsp .Cm got update
3011 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
3012 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
3015 4ed9f614 2019-08-04 stsp .Cm got update ,
3016 4ed9f614 2019-08-04 stsp .Cm got rebase ,
3018 4ed9f614 2019-08-04 stsp .Cm got histedit
3019 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
3020 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
3021 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
3022 4ed9f614 2019-08-04 stsp .Cm got unstage
3023 4ed9f614 2019-08-04 stsp before it can be updated with
3024 4ed9f614 2019-08-04 stsp .Cm got update ,
3025 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
3030 5fc4f020 2022-08-30 op .Op Fl F Ar response-script
3031 5fc4f020 2022-08-30 op .Op Ar path ...
3033 4683a10b 2021-11-04 kn .Dl Pq alias: Cm ug
3034 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
3035 4ed9f614 2019-08-04 stsp back into non-staged status.
3038 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
3039 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
3041 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
3042 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
3043 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
3044 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
3045 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
3046 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
3047 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
3048 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
3051 2e1f37b0 2019-08-08 stsp The options for
3052 2e1f37b0 2019-08-08 stsp .Cm got unstage
3053 2e1f37b0 2019-08-08 stsp are as follows:
3054 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
3055 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
3058 2e1f37b0 2019-08-08 stsp option, read
3063 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
3064 2e1f37b0 2019-08-08 stsp .Ar response-script
3065 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
3067 827a167b 2022-08-16 stsp Instead of unstaging the entire content of a changed file, interactively
3068 827a167b 2022-08-16 stsp select or reject changes for unstaging based on
3070 827a167b 2022-08-16 stsp (unstage change),
3072 827a167b 2022-08-16 stsp (keep change staged), and
3074 827a167b 2022-08-16 stsp (quit unstaging this file) responses.
3075 827a167b 2022-08-16 stsp If a file is staged in modified status, individual patches derived from the
3076 827a167b 2022-08-16 stsp staged file content can be unstaged.
3077 827a167b 2022-08-16 stsp Files staged in added or deleted status may only be unstaged in their entirety.
3082 5fc4f020 2022-08-30 op .Op Fl c Ar commit
3083 5fc4f020 2022-08-30 op .Op Fl r Ar repository-path
3086 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
3087 896e9b6f 2019-08-26 stsp text format.
3088 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
3089 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
3090 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
3092 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
3093 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
3094 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
3095 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
3096 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3097 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
3099 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
3101 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
3102 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
3104 01073a5d 2019-08-22 stsp The options for
3105 01073a5d 2019-08-22 stsp .Cm got cat
3106 01073a5d 2019-08-22 stsp are as follows:
3107 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
3108 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
3109 896e9b6f 2019-08-26 stsp Look up paths in the specified
3110 896e9b6f 2019-08-26 stsp .Ar commit .
3111 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
3112 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
3113 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
3114 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
3115 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
3116 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
3118 827a167b 2022-08-16 stsp Interpret all arguments as paths only.
3119 827a167b 2022-08-16 stsp This option can be used to resolve ambiguity in cases where paths
3120 827a167b 2022-08-16 stsp look like tag names, reference names, or object IDs.
3121 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
3122 01073a5d 2019-08-22 stsp Use the repository at the specified path.
3123 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
3124 01073a5d 2019-08-22 stsp working directory.
3125 01073a5d 2019-08-22 stsp If this directory is a
3127 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
3129 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
3130 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
3132 b2118c49 2020-07-28 stsp .Xr got-worktree 5
3133 b2118c49 2020-07-28 stsp for details.
3135 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
3136 b2118c49 2020-07-28 stsp current working directory.
3138 b2118c49 2020-07-28 stsp If one or more
3140 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
3141 b2118c49 2020-07-28 stsp files located at or within these paths.
3144 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
3145 b2118c49 2020-07-28 stsp for all tracked files.
3147 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
3148 3e0f95fc 2022-07-23 stsp .Bl -tag -width GOT_IGNORE_GITCONFIG
3149 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
3150 7f5531cd 2022-07-22 stsp The author's name and email address, such as
3151 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
3152 7f5531cd 2022-07-22 stsp Used by the
3153 7f5531cd 2022-07-22 stsp .Cm got commit ,
3154 7f5531cd 2022-07-22 stsp .Cm got import ,
3155 7f5531cd 2022-07-22 stsp .Cm got rebase ,
3157 7f5531cd 2022-07-22 stsp .Cm got histedit
3161 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
3163 84792843 2019-08-09 stsp attempts to reject
3164 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
3165 84792843 2019-08-09 stsp environment variables with a missing email address.
3167 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
3168 50b0790e 2020-09-11 stsp .Xr got.conf 5
3169 50b0790e 2020-09-11 stsp or by Git's
3170 aba9c984 2019-09-08 stsp .Dv user.name
3172 709ae9eb 2019-09-08 stsp .Dv user.email
3173 709ae9eb 2019-09-08 stsp configuration settings in the repository's
3174 aba9c984 2019-09-08 stsp .Pa .git/config
3177 c9956ddf 2019-09-08 stsp .Dv user.name
3179 c9956ddf 2019-09-08 stsp .Dv user.email
3180 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
3181 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
3182 257add31 2020-09-09 stsp configuration file will only be used if neither
3183 257add31 2020-09-09 stsp .Xr got.conf 5
3185 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
3186 257add31 2020-09-09 stsp environment variable provide author information.
3187 7713cc5e 2023-01-20 op .It Ev GOT_IGNORE_GITCONFIG
3188 7713cc5e 2023-01-20 op If this variable is set then any remote repository definitions or author
3189 7713cc5e 2023-01-20 op information found in Git configuration files will be ignored.
3190 7713cc5e 2023-01-20 op .It Ev GOT_LOG_DEFAULT_LIMIT
3191 7713cc5e 2023-01-20 op The default limit on the number of commits traversed by
3192 7713cc5e 2023-01-20 op .Cm got log .
3193 7713cc5e 2023-01-20 op If set to zero, the limit is unbounded.
3194 7713cc5e 2023-01-20 op This variable will be silently ignored if it is set to a non-numeric value.
3195 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
3196 23594da9 2019-05-13 stsp The editor spawned by
3197 8e7bd50a 2019-08-22 stsp .Cm got commit ,
3198 46215d2a 2020-09-11 stsp .Cm got histedit ,
3199 8e7bd50a 2019-08-22 stsp .Cm got import ,
3201 8e7bd50a 2019-08-22 stsp .Cm got tag .
3202 5b735925 2020-09-15 stsp If not set, the
3204 5b735925 2020-09-15 stsp text editor will be spawned in order to give
3206 5b735925 2020-09-15 stsp the attention it deserves.
3209 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
3210 257add31 2020-09-09 stsp .It Pa got.conf
3211 257add31 2020-09-09 stsp Repository-wide configuration settings for
3213 50b0790e 2020-09-11 stsp If present, a
3214 50b0790e 2020-09-11 stsp .Xr got.conf 5
3215 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
3216 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
3217 257add31 2020-09-09 stsp .Pa config
3220 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
3221 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
3223 50b0790e 2020-09-11 stsp If present, a
3224 1795b260 2021-04-02 kn .Xr got.conf 5
3225 50b0790e 2020-09-11 stsp configuration file in the
3227 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
3228 50b0790e 2020-09-11 stsp the repository's
3229 50b0790e 2020-09-11 stsp .Xr got.conf 5
3230 50b0790e 2020-09-11 stsp configuration file and Git's
3231 50b0790e 2020-09-11 stsp .Pa config
3234 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
3235 5c860e29 2018-03-12 stsp .Ex -std got
3236 97925469 2018-03-17 stsp .Sh EXAMPLES
3237 43e4eb1b 2021-08-29 stsp Enable tab-completion of
3239 43e4eb1b 2021-08-29 stsp command names in
3240 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
3242 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
3244 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
3247 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
3248 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
3250 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
3251 fa6e0e48 2019-05-23 stsp .Xr git 1 :
3253 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
3254 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
3256 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
3258 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
3259 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
3260 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
3262 02a5c5d0 2022-07-04 stsp .Dl $ gotadmin init /var/git/src.git
3263 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
3265 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
3267 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
3269 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
3271 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
3273 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
3275 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
3277 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
3279 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
3281 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
3283 4e759de4 2019-06-26 stsp .Dl $ got branch -l
3285 bfed0e20 2023-01-10 stsp As above, but list the most recently modified branches only:
3287 bfed0e20 2023-01-10 stsp .Dl $ got branch -lt | head
3289 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
3290 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
3291 d83d9d5c 2019-05-13 stsp which is forked off the
3292 d83d9d5c 2019-05-13 stsp .Dq master
3295 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
3297 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
3298 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
3299 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
3301 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
3303 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
3304 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
3306 fa6e0e48 2019-05-23 stsp .Dl $ got commit
3308 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
3309 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
3310 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
3312 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
3314 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
3315 04e9dcf3 2020-04-18 stsp .Xr patch 1
3316 04e9dcf3 2020-04-18 stsp could apply them in sequence:
3318 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
3320 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
3322 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
3324 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
3325 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
3326 5b666081 2020-02-24 stsp .Pa sys/uvm :
3328 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
3330 5b666081 2020-02-24 stsp And this command has the same effect:
3332 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
3334 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
3336 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
3337 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
3339 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
3341 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
3342 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
3344 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
3345 e70c17ce 2019-05-22 stsp with a pre-defined log message.
3347 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
3349 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
3350 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
3351 1795b260 2021-04-02 kn .Pa /tmp/msg :
3353 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
3355 95fc3404 2019-07-15 stsp Update any work tree checked out from the
3356 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
3357 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
3359 95fc3404 2019-07-15 stsp .Dl $ got update
3361 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
3362 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
3363 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
3365 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3366 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
3367 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
3368 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
3370 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
3371 a099809f 2021-08-27 stsp .Dq master
3372 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
3373 469dd726 2020-03-20 stsp .Dq origin/master
3376 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3377 469dd726 2020-03-20 stsp .Dl $ got fetch
3379 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
3380 469dd726 2020-03-20 stsp .Cm git clone --bare
3382 469dd726 2020-03-20 stsp .Xr git-fetch 1
3383 469dd726 2020-03-20 stsp command must be used instead:
3385 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
3386 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
3388 469dd726 2020-03-20 stsp Rebase the local
3389 469dd726 2020-03-20 stsp .Dq master
3390 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
3391 469dd726 2020-03-20 stsp .Dq origin/master
3394 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
3395 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
3396 469dd726 2020-03-20 stsp .Dl $ got rebase master
3398 fa6e0e48 2019-05-23 stsp Rebase the
3399 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
3400 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
3401 fa6e0e48 2019-05-23 stsp .Dq master
3404 818c7501 2019-07-11 stsp .Dl $ got update -b master
3405 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
3407 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
3408 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
3409 1dd86744 2019-08-12 anthony .Ox Ns 's
3410 1dd86744 2019-08-12 anthony CVS tree:
3412 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3414 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
3415 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
3418 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
3419 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
3420 0ebf8283 2019-07-24 stsp .Dl $ got histedit
3422 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
3423 469dd726 2020-03-20 stsp .Cm git clone --bare
3424 7848a0e1 2020-03-19 stsp instead of
3425 7848a0e1 2020-03-19 stsp .Cm got clone ,
3427 ff2cf171 2019-07-28 stsp .Dq refspec
3428 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
3430 ff2cf171 2019-07-28 stsp .Dq refs/remotes
3431 ff2cf171 2019-07-28 stsp namespace of the local repository.
3432 1795b260 2021-04-02 kn This can be achieved by setting Git's
3433 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
3434 ff2cf171 2019-07-28 stsp configuration variable to the value
3435 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
3437 ff2cf171 2019-07-28 stsp .Cm git config
3440 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
3441 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3443 469dd726 2020-03-20 stsp Additionally, the
3444 469dd726 2020-03-20 stsp .Dq mirror
3445 469dd726 2020-03-20 stsp option must be disabled:
3447 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
3448 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
3450 ff2cf171 2019-07-28 stsp Alternatively, the following
3451 469dd726 2020-03-20 stsp .Xr git-fetch 1
3452 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
3453 ff2cf171 2019-07-28 stsp .Pa config
3456 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
3457 ff2cf171 2019-07-28 stsp .Dl url = ...
3458 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3459 469dd726 2020-03-20 stsp .Dl mirror = false
3461 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
3462 ff2cf171 2019-07-28 stsp .Dq refs/heads
3463 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
3464 ff2cf171 2019-07-28 stsp .Cm got checkout
3465 ff2cf171 2019-07-28 stsp and, if needed, created with
3466 ff2cf171 2019-07-28 stsp .Cm got branch .
3467 ff2cf171 2019-07-28 stsp Branches in the
3468 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
3469 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
3470 ff2cf171 2019-07-28 stsp repository with
3471 469dd726 2020-03-20 stsp .Cm got fetch
3473 469dd726 2020-03-20 stsp .Xr git-fetch 1
3474 a099809f 2021-08-27 stsp without extra command line arguments.
3475 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
3476 a099809f 2021-08-27 stsp .Cm got log .
3478 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
3479 ff2cf171 2019-07-28 stsp .Dq master
3480 a099809f 2021-08-27 stsp branch, as of the last time
3481 a099809f 2021-08-27 stsp .Cm got fetch
3484 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
3486 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
3487 ff2cf171 2019-07-28 stsp .Dq origin/master
3488 a099809f 2021-08-27 stsp instead of
3489 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
3490 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
3492 a099809f 2021-08-27 stsp .Cm got rebase
3493 a099809f 2021-08-27 stsp must be used to merge changes which are visible on the
3494 a099809f 2021-08-27 stsp .Dq origin/master
3495 a099809f 2021-08-27 stsp branch into the
3496 a099809f 2021-08-27 stsp .Dq master
3498 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
3500 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
3501 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
3503 a099809f 2021-08-27 stsp In order to make changes committed to the
3504 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3505 a099809f 2021-08-27 stsp visible on the
3506 a099809f 2021-08-27 stsp .Dq master
3507 a099809f 2021-08-27 stsp branch, the
3508 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3509 a099809f 2021-08-27 stsp branch must first be rebased onto the
3510 a099809f 2021-08-27 stsp .Dq master
3513 a099809f 2021-08-27 stsp .Dl $ got update -b master
3514 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
3516 a099809f 2021-08-27 stsp Changes on the
3517 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3518 a099809f 2021-08-27 stsp branch can now be made visible on the
3519 a099809f 2021-08-27 stsp .Dq master
3520 a099809f 2021-08-27 stsp branch with
3521 a099809f 2021-08-27 stsp .Cm got integrate .
3522 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
3523 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
3524 e38d4cde 2022-03-21 naddy branch, the work tree must be switched back to the
3525 a099809f 2021-08-27 stsp .Dq master
3526 a099809f 2021-08-27 stsp branch first:
3528 a099809f 2021-08-27 stsp .Dl $ got update -b master
3529 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
3532 083957f4 2020-02-24 stsp .Dq master
3533 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
3535 083957f4 2020-02-24 stsp by other developers and any other important new information:
3537 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
3538 083957f4 2020-02-24 stsp .Dl $ got histedit -m
3540 e38d4cde 2022-03-21 naddy If the remote repository offers write access, local changes on the
3541 ff2cf171 2019-07-28 stsp .Dq master
3542 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
3543 90e6e620 2021-10-04 kn .Cm got send .
3545 a099809f 2021-08-27 stsp .Cm got send
3546 a099809f 2021-08-27 stsp can be run without further arguments.
3547 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
3548 a099809f 2021-08-27 stsp current branch is the
3549 a099809f 2021-08-27 stsp .Dq master
3552 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
3554 e38d4cde 2022-03-21 naddy If the remote repository requires the HTTPS protocol, the
3555 a099809f 2021-08-27 stsp .Xr git-push 1
3556 a099809f 2021-08-27 stsp command must be used instead:
3558 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
3559 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
3561 8978dfde 2022-07-20 stsp When making contributions to projects which use the
3562 8978dfde 2022-07-20 stsp .Dq pull request
3563 8978dfde 2022-07-20 stsp workflow, SSH protocol repository access needs to be set up first.
3564 8978dfde 2022-07-20 stsp Once an account has been created on a Git hosting site it should
3565 8978dfde 2022-07-20 stsp be possible to upload a public SSH key for repository access
3566 8978dfde 2022-07-20 stsp authentication.
3569 8978dfde 2022-07-20 stsp .Dq pull request
3570 8978dfde 2022-07-20 stsp workflow will usually involve two remote repositories.
3571 8978dfde 2022-07-20 stsp In the real-life example below, the
3572 8978dfde 2022-07-20 stsp .Dq origin
3573 8978dfde 2022-07-20 stsp repository was forked from the
3574 8978dfde 2022-07-20 stsp .Dq upstream
3575 8978dfde 2022-07-20 stsp repository by using the Git hosting site's web interface.
3577 8978dfde 2022-07-20 stsp .Xr got.conf 5
3578 8978dfde 2022-07-20 stsp file in the local repository describes both remote repositories:
3579 8978dfde 2022-07-20 stsp .Bd -literal -offset indent
3580 8978dfde 2022-07-20 stsp # Jelmers's repository, which accepts pull requests
3581 8978dfde 2022-07-20 stsp remote "upstream" {
3582 8978dfde 2022-07-20 stsp server git@github.com
3583 8978dfde 2022-07-20 stsp protocol ssh
3584 8978dfde 2022-07-20 stsp repository "/jelmer/dulwich"
3585 8978dfde 2022-07-20 stsp branch { "master" }
3588 8978dfde 2022-07-20 stsp # Stefan's fork, used as the default remote repository
3589 8978dfde 2022-07-20 stsp remote "origin" {
3590 8978dfde 2022-07-20 stsp server git@github.com
3591 8978dfde 2022-07-20 stsp protocol ssh
3592 8978dfde 2022-07-20 stsp repository "/stspdotname/dulwich"
3593 8978dfde 2022-07-20 stsp branch { "master" }
3597 8978dfde 2022-07-20 stsp With this configuration, Stefan can create commits on
3598 8978dfde 2022-07-20 stsp .Dq refs/heads/master
3599 8978dfde 2022-07-20 stsp and send them to the
3600 8978dfde 2022-07-20 stsp .Dq origin
3601 8978dfde 2022-07-20 stsp repository by running:
3603 8978dfde 2022-07-20 stsp .Dl $ got send -b master origin
3605 8978dfde 2022-07-20 stsp The changes can now be proposed to Jelmer by opening a pull request
3606 8978dfde 2022-07-20 stsp via the Git hosting site's web interface.
3607 8978dfde 2022-07-20 stsp If Jelmer requests further changes to be made, additional commits
3608 8978dfde 2022-07-20 stsp can be created on the
3609 8978dfde 2022-07-20 stsp .Dq master
3610 8978dfde 2022-07-20 stsp branch and be added to the pull request by running
3611 8978dfde 2022-07-20 stsp .Cd got send
3614 8978dfde 2022-07-20 stsp If Jelmer prefers additional commits to be
3615 8978dfde 2022-07-20 stsp .Dq squashed
3616 8978dfde 2022-07-20 stsp then the following commands can be used to achieve this:
3618 8978dfde 2022-07-20 stsp .Dl $ got update -b master
3619 8978dfde 2022-07-20 stsp .Dl $ got update -c origin/master
3620 8978dfde 2022-07-20 stsp .Dl $ got histedit -f
3621 8978dfde 2022-07-20 stsp .Dl $ got send -f -b master origin
3623 8978dfde 2022-07-20 stsp Once Jelmer has accepted the pull request, Stefan can fetch the
3624 8978dfde 2022-07-20 stsp merged changes, and possibly several other new changes, by running:
3626 8978dfde 2022-07-20 stsp .Dl $ got fetch upstream
3628 8978dfde 2022-07-20 stsp The merged changes will now be visible under the reference
3629 8978dfde 2022-07-20 stsp .Dq refs/remotes/upstream/master .
3631 8978dfde 2022-07-20 stsp .Dq master
3632 8978dfde 2022-07-20 stsp branch can now be rebased on top of the latest changes
3633 8978dfde 2022-07-20 stsp from upstream:
3635 8978dfde 2022-07-20 stsp .Dl $ got update -b upstream/master
3636 8978dfde 2022-07-20 stsp .Dl $ got rebase master
3638 8978dfde 2022-07-20 stsp As a final step, the forked repository's copy of the master branch needs
3639 8978dfde 2022-07-20 stsp to be kept in sync by sending the new changes there:
3641 8978dfde 2022-07-20 stsp .Dl $ got send -f -b master origin
3643 8978dfde 2022-07-20 stsp If multiple pull requests need to be managed in parallel, a separate branch
3644 8978dfde 2022-07-20 stsp must be created for each pull request with
3645 8978dfde 2022-07-20 stsp .Cm got branch .
3646 8978dfde 2022-07-20 stsp Each such branch can then be used as above, in place of
3647 8978dfde 2022-07-20 stsp .Dq refs/heads/master .
3648 8978dfde 2022-07-20 stsp Changes for any accepted pull requests will still appear under
3649 8978dfde 2022-07-20 stsp .Dq refs/remotes/upstream/master,
3650 8978dfde 2022-07-20 stsp regardless of which branch was used in the forked repository to
3651 8978dfde 2022-07-20 stsp create a pull request.
3652 5c860e29 2018-03-12 stsp .Sh SEE ALSO
3653 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
3654 2312fc47 2019-07-15 stsp .Xr tog 1 ,
3655 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
3656 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
3657 2b16c2bc 2022-07-05 stsp .Xr got.conf 5 ,
3658 06991378 2022-12-30 tracey .Xr gotwebd 8
3659 1a208aaf 2018-04-01 stsp .Sh AUTHORS
3660 8ca658b9 2022-07-05 stsp .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3661 8ca658b9 2022-07-05 stsp .An Christian Weisgerber Aq Mt naddy@openbsd.org
3662 8ca658b9 2022-07-05 stsp .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3663 8ca658b9 2022-07-05 stsp .An Josh Rickmar Aq Mt jrick@zettaport.com
3664 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
3665 8ca658b9 2022-07-05 stsp .An Klemens Nanni Aq Mt kn@openbsd.org
3666 8ca658b9 2022-07-05 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
3667 49be94bd 2022-07-05 stsp .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3668 8ca658b9 2022-07-05 stsp .An Omar Polo Aq Mt op@openbsd.org
3669 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
3670 8ca658b9 2022-07-05 stsp .An Sebastien Marie Aq Mt semarie@openbsd.org
3671 8ca658b9 2022-07-05 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
3672 ad8bd524 2022-07-05 stsp .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3673 8ca658b9 2022-07-05 stsp .An Theo Buehler Aq Mt tb@openbsd.org
3674 8ca658b9 2022-07-05 stsp .An Thomas Adam Aq Mt thomas@xteddy.org
3675 8ca658b9 2022-07-05 stsp .An Tracey Emery Aq Mt tracey@traceyemery.net
3676 8ca658b9 2022-07-05 stsp .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3680 cc63cb4e 2022-07-05 stsp .Xr tog 1 ,
3682 06991378 2022-12-30 tracey .Xr gotwebd 8
3683 cc63cb4e 2022-07-05 stsp were derived from code under copyright by:
3685 65858f9a 2022-07-22 stsp .An Caldera International
3686 cc63cb4e 2022-07-05 stsp .An Daniel Hartmeier
3687 cc63cb4e 2022-07-05 stsp .An Esben Norby
3688 cc63cb4e 2022-07-05 stsp .An Henning Brauer
3689 cc63cb4e 2022-07-05 stsp .An Håkan Olsson
3690 cc63cb4e 2022-07-05 stsp .An Ingo Schwarze
3691 cc63cb4e 2022-07-05 stsp .An Jean-Francois Brousseau
3692 cc63cb4e 2022-07-05 stsp .An Joris Vink
3693 cc63cb4e 2022-07-05 stsp .An Jyri J. Virkki
3694 cc63cb4e 2022-07-05 stsp .An Larry Wall
3695 65858f9a 2022-07-22 stsp .An Markus Friedl
3696 cc63cb4e 2022-07-05 stsp .An Niall O'Higgins
3697 cc63cb4e 2022-07-05 stsp .An Niklas Hallqvist
3698 cc63cb4e 2022-07-05 stsp .An Ray Lai
3699 cc63cb4e 2022-07-05 stsp .An Ryan McBride
3700 cc63cb4e 2022-07-05 stsp .An Theo de Raadt
3701 cc63cb4e 2022-07-05 stsp .An Todd C. Miller
3702 cc63cb4e 2022-07-05 stsp .An Xavier Santolaria
3705 bd957eac 2022-07-05 stsp contains code contributed to the public domain by
3706 9430e858 2022-12-25 stsp .An Austin Appleby .
3707 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
3709 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
3711 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
3713 cc63216e 2020-12-26 stsp to perform some tasks.
3714 cc63216e 2020-12-26 stsp In particular:
3715 cc63216e 2020-12-26 stsp .Bl -bullet
3717 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
3718 cc63216e 2020-12-26 stsp .Xr git-clone 1
3720 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
3722 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
3723 cc63216e 2020-12-26 stsp .Xr git-push 1 .
3725 fa161f0b 2021-09-28 stsp The creation of merge commits with more than two parent commits requires
3726 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
3728 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
3730 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
3732 cc63216e 2020-12-26 stsp will usually produce better results.
