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
65 09ea71ba 2019-07-27 stsp .It Cm init Ar repository-path
66 2c7829a4 2019-06-17 stsp Create a new empty repository at the specified
67 09ea71ba 2019-07-27 stsp .Ar repository-path .
70 3ce1b845 2019-07-15 stsp .Cm got init ,
72 3ce1b845 2019-07-15 stsp .Cm got import
73 3ce1b845 2019-07-15 stsp command must be used to populate the empty repository before
74 3ce1b845 2019-07-15 stsp .Cm got checkout
75 3ce1b845 2019-07-15 stsp can be used.
77 dfc23429 2019-08-11 stsp .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
78 95f394e8 2021-10-04 kn .Dl (alias: Cm im )
79 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
80 3ce1b845 2019-07-15 stsp within the specified
81 3ce1b845 2019-07-15 stsp .Ar directory .
82 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
83 3ce1b845 2019-07-15 stsp root commit.
84 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
85 3ce1b845 2019-07-15 stsp created commit.
86 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
89 21a44f98 2019-07-15 stsp .Cm got import
90 21a44f98 2019-07-15 stsp command requires the
91 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
92 aba9c984 2019-09-08 stsp environment variable to be set,
93 257add31 2020-09-09 stsp unless an author has been configured in
94 257add31 2020-09-09 stsp .Xr got.conf 5
96 aba9c984 2019-09-08 stsp .Dv user.name
98 709ae9eb 2019-09-08 stsp .Dv user.email
99 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
100 aba9c984 2019-09-08 stsp .Pa .git/config
101 c9956ddf 2019-09-08 stsp file or from Git's global
102 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
103 c9956ddf 2019-09-08 stsp configuration file.
105 3ce1b845 2019-07-15 stsp The options for
106 3ce1b845 2019-07-15 stsp .Cm got import
107 3ce1b845 2019-07-15 stsp are as follows:
108 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
109 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
110 3ce1b845 2019-07-15 stsp Create the specified
112 3ce1b845 2019-07-15 stsp instead of creating the default branch
114 3ce1b845 2019-07-15 stsp Use of this option is required if the
116 3ce1b845 2019-07-15 stsp branch already exists.
117 3ce1b845 2019-07-15 stsp .It Fl m Ar message
118 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
119 3ce1b845 2019-07-15 stsp Without the
122 3ce1b845 2019-07-15 stsp .Cm got import
123 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
124 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
125 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
126 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
127 3ce1b845 2019-07-15 stsp working directory.
128 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
129 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
130 3ce1b845 2019-07-15 stsp .Ar pattern .
131 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
133 3ce1b845 2019-07-15 stsp .Ar pattern
134 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
135 3ce1b845 2019-07-15 stsp .Xr glob 7 .
138 0e4002ca 2020-03-21 stsp .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
139 95f394e8 2021-10-04 kn .Dl (alias: Cm cl )
140 2ab43947 2020-03-18 stsp Clone a Git repository at the specified
141 2ab43947 2020-03-18 stsp .Ar repository-URL
142 2ab43947 2020-03-18 stsp into the specified
143 3493b628 2020-03-20 stsp .Ar directory .
145 3493b628 2020-03-20 stsp .Ar directory
146 2ab43947 2020-03-18 stsp is specified the directory name will be derived from the name of the
147 2ab43947 2020-03-18 stsp cloned repository.
148 2ab43947 2020-03-18 stsp .Cm got clone
149 2ab43947 2020-03-18 stsp will refuse to run if the
150 3493b628 2020-03-20 stsp .Ar directory
151 2ab43947 2020-03-18 stsp already exists.
154 2ab43947 2020-03-18 stsp .Ar repository-URL
155 619eb6dd 2020-03-20 stsp specifies a protocol scheme, a server hostname, an optional port number
156 619eb6dd 2020-03-20 stsp separated from the hostname by a colon, and a path to the repository on
157 619eb6dd 2020-03-20 stsp the server:
158 619eb6dd 2020-03-20 stsp .Lk scheme://hostname:port/path/to/repository
160 2ab43947 2020-03-18 stsp The following protocol schemes are supported:
161 2ab43947 2020-03-18 stsp .Bl -tag -width git+ssh
163 2ab43947 2020-03-18 stsp The Git protocol as implemented by the
164 2ab43947 2020-03-18 stsp .Xr git-daemon 1
166 10c073e7 2020-03-20 stsp Use of this protocol is discouraged since it supports neither authentication
167 10c073e7 2020-03-20 stsp nor encryption.
168 2ab43947 2020-03-18 stsp .It git+ssh
169 2ab43947 2020-03-18 stsp The Git protocol wrapped in an authenticated and encrypted
172 2ab43947 2020-03-18 stsp With this protocol the hostname may contain an embedded username for
175 2ab43947 2020-03-18 stsp .Mt user@hostname
177 2ab43947 2020-03-18 stsp Short alias for git+ssh.
180 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
181 89c3c67b 2020-03-20 stsp from the server.
182 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
184 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
185 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
186 89c3c67b 2020-03-20 stsp This can take some time.
187 010f7279 2020-03-20 stsp More details about the pack file format are documented in
188 010f7279 2020-03-20 stsp .Xr git-repository 5 .
190 7848a0e1 2020-03-19 stsp .Cm got clone
191 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
192 257add31 2020-09-09 stsp .Xr got.conf 5
195 257add31 2020-09-09 stsp files of the cloned repository to store the
196 7848a0e1 2020-03-19 stsp .Ar repository-url
200 99495ddb 2021-01-10 stsp .Ar reference
201 132af4a5 2021-01-05 stsp arguments for future use by
202 7848a0e1 2020-03-19 stsp .Cm got fetch
204 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
206 2ab43947 2020-03-18 stsp The options for
207 2ab43947 2020-03-18 stsp .Cm got clone
208 2ab43947 2020-03-18 stsp are as follows:
209 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
211 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
212 1d4b192f 2020-03-21 stsp .Dq refs/heads/
213 5aa20203 2021-01-05 stsp reference namespace and set
214 5aa20203 2021-01-05 stsp .Cm fetch-all-branches
215 5aa20203 2021-01-05 stsp in the cloned repository's
216 5aa20203 2021-01-05 stsp .Xr got.conf 5
217 5aa20203 2021-01-05 stsp file for future use by
218 5aa20203 2021-01-05 stsp .Cm got fetch .
219 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
220 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
221 4ba14133 2020-03-20 stsp Cannot be used together with the
224 4ba14133 2020-03-20 stsp .It Fl b Ar branch
225 4ba14133 2020-03-20 stsp Fetch the specified
227 1d4b192f 2020-03-21 stsp from the remote repository's
228 1d4b192f 2020-03-21 stsp .Dq refs/heads/
229 1d4b192f 2020-03-21 stsp reference namespace.
230 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
232 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
233 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
234 4ba14133 2020-03-20 stsp branch which was fetched.
235 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
236 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
237 4ba14133 2020-03-20 stsp Cannot be used together with the
241 a18cccf9 2020-03-21 stsp List branches and tags available for fetching from the remote repository
242 41b0de12 2020-03-21 stsp and exit immediately.
243 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
248 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
249 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
250 bd81cfb7 2020-04-19 stsp locally created commits.
252 469dd726 2020-03-20 stsp The repository's
253 257add31 2020-09-09 stsp .Xr got.conf 5
256 257add31 2020-09-09 stsp files will be set up with the
258 469dd726 2020-03-20 stsp option enabled, such that
259 469dd726 2020-03-20 stsp .Cm got fetch
261 469dd726 2020-03-20 stsp .Xr git-fetch 1
262 bd81cfb7 2020-04-19 stsp will write incoming changes directly to branches in the
263 469dd726 2020-03-20 stsp .Dq refs/heads/
264 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
265 469dd726 2020-03-20 stsp .Dq refs/remotes/
267 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
268 469dd726 2020-03-20 stsp .Cm got rebase
270 469dd726 2020-03-20 stsp .Cm got fetch
271 bd81cfb7 2020-04-19 stsp in order to make incoming changes appear on branches in the
272 bd81cfb7 2020-04-19 stsp .Dq refs/heads/
274 bd81cfb7 2020-04-19 stsp But maintaining custom changes in the cloned repository becomes difficult
275 bd81cfb7 2020-04-19 stsp since such changes will be at risk of being discarded whenever incoming
276 498ef124 2020-03-21 stsp changes are fetched.
278 2ab43947 2020-03-18 stsp Suppress progress reporting output.
279 2ab43947 2020-03-18 stsp The same option will be passed to
281 2ab43947 2020-03-18 stsp if applicable.
283 2690194b 2020-03-21 stsp Verbose mode.
285 2690194b 2020-03-21 stsp .Cm got clone
286 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
287 2690194b 2020-03-21 stsp This option will be passed to
289 2ab43947 2020-03-18 stsp if applicable.
290 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
291 2ab43947 2020-03-18 stsp The maximum is 3.
292 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
293 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
294 0e4002ca 2020-03-21 stsp .Ar reference
295 0e4002ca 2020-03-21 stsp from the remote repository's
298 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
299 0e4002ca 2020-03-21 stsp references to fetch.
300 71f12362 2020-03-21 stsp The specified
301 71f12362 2020-03-21 stsp .Ar reference
302 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
303 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
305 71f12362 2020-03-21 stsp Each reference will be mapped into the cloned repository's
306 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
307 0e4002ca 2020-03-21 stsp namespace, unless the
309 0e4002ca 2020-03-21 stsp option is used to mirror references directly into the cloned repository's
313 0e4002ca 2020-03-21 stsp .Cm got clone
314 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
315 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
317 0e4002ca 2020-03-21 stsp .Dq refs/got/
321 161728eb 2021-07-24 stsp .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Oo Fl X Oc Op Ar remote-repository
322 95f394e8 2021-10-04 kn .Dl (alias: Cm fe )
323 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
325 4ba14133 2020-03-20 stsp .Ar remote-repository
326 4ba14133 2020-03-20 stsp is specified,
328 7848a0e1 2020-03-19 stsp will be used.
329 50b0790e 2020-09-11 stsp The remote repository's URL is obtained from the corresponding entry in
330 257add31 2020-09-09 stsp .Xr got.conf 5
333 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
334 7848a0e1 2020-03-19 stsp .Cm got clone .
336 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
337 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
338 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
340 498ef124 2020-03-21 stsp By default, branch references in the
341 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
342 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
344 498ef124 2020-03-21 stsp .Cm got rebase
345 bd81cfb7 2020-04-19 stsp command can then be used to make new changes visible on branches in the
346 7848a0e1 2020-03-19 stsp .Dq refs/heads/
347 bd81cfb7 2020-04-19 stsp namespace, merging incoming changes with the changes on those branches
348 bd81cfb7 2020-04-19 stsp as necessary.
350 498ef124 2020-03-21 stsp If the repository was created as a mirror with
351 498ef124 2020-03-21 stsp .Cm got clone -m
352 498ef124 2020-03-21 stsp then all branches in the
353 469dd726 2020-03-20 stsp .Dq refs/heads/
354 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
355 498ef124 2020-03-21 stsp the remote repository.
356 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
357 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
358 e6786710 2021-07-03 stsp by Git's garbage collector or
359 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
360 bd81cfb7 2020-04-19 stsp Maintaining custom changes in a mirror repository is therefore discouraged.
362 db6d8ad8 2020-03-21 stsp In any case, references in the
363 7848a0e1 2020-03-19 stsp .Dq refs/tags/
364 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
365 db6d8ad8 2020-03-21 stsp in the same namespace.
367 7848a0e1 2020-03-19 stsp The options for
368 7848a0e1 2020-03-19 stsp .Cm got fetch
369 7848a0e1 2020-03-19 stsp are as follows:
370 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
372 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
373 1d4b192f 2020-03-21 stsp .Dq refs/heads/
374 1d4b192f 2020-03-21 stsp reference namespace.
375 0c8b29c5 2021-01-05 stsp This option can be enabled by default for specific repositories in
376 0c8b29c5 2021-01-05 stsp .Xr got.conf 5 .
377 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
378 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
379 4ba14133 2020-03-20 stsp Cannot be used together with the
382 4ba14133 2020-03-20 stsp .It Fl b Ar branch
383 4ba14133 2020-03-20 stsp Fetch the specified
385 1d4b192f 2020-03-21 stsp from the remote repository's
386 1d4b192f 2020-03-21 stsp .Dq refs/heads/
387 1d4b192f 2020-03-21 stsp reference namespace.
388 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
390 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
391 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
392 4ba14133 2020-03-20 stsp Cannot be used together with the
396 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
397 f21ec2f0 2020-03-21 stsp present in the remote repository.
398 f21ec2f0 2020-03-21 stsp Only references are deleted.
399 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
400 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
401 e6786710 2021-07-03 stsp Git's garbage collector or
402 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
404 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
405 41b0de12 2020-03-21 stsp and exit immediately.
406 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
412 db6d8ad8 2020-03-21 stsp Allow existing references in the
413 db6d8ad8 2020-03-21 stsp .Dq refs/tags
414 db6d8ad8 2020-03-21 stsp namespace to be updated if they have changed on the server.
415 db6d8ad8 2020-03-21 stsp If not specified, only new tag references will be created.
416 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
417 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
418 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
419 7848a0e1 2020-03-19 stsp working directory.
420 7848a0e1 2020-03-19 stsp If this directory is a
422 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
424 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
425 7848a0e1 2020-03-19 stsp The same option will be passed to
427 7848a0e1 2020-03-19 stsp if applicable.
429 2690194b 2020-03-21 stsp Verbose mode.
431 2690194b 2020-03-21 stsp .Cm got fetch
432 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
433 7848a0e1 2020-03-19 stsp The same option will be passed to
435 7848a0e1 2020-03-19 stsp if applicable.
436 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
437 7848a0e1 2020-03-19 stsp The maximum is 3.
438 0e4002ca 2020-03-21 stsp .It Fl R Ar reference
439 0e4002ca 2020-03-21 stsp In addition to the branches and tags that will be fetched, fetch an arbitrary
440 0e4002ca 2020-03-21 stsp .Ar reference
441 0e4002ca 2020-03-21 stsp from the remote repository's
444 0e4002ca 2020-03-21 stsp This option may be specified multiple times to build a list of additional
445 0e4002ca 2020-03-21 stsp references to fetch.
446 71f12362 2020-03-21 stsp The specified
447 71f12362 2020-03-21 stsp .Ar reference
448 a18cccf9 2020-03-21 stsp may either be a path to a specific reference, or a reference namespace
449 71f12362 2020-03-21 stsp which will cause all references in this namespace to be fetched.
451 0e4002ca 2020-03-21 stsp Each reference will be mapped into the local repository's
452 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
453 0e4002ca 2020-03-21 stsp namespace, unless the local repository was created as a mirror with
454 a18cccf9 2020-03-21 stsp .Cm got clone -m
455 a18cccf9 2020-03-21 stsp in which case references will be mapped directly into the local repository's
459 bd81cfb7 2020-04-19 stsp Once a reference has been fetched, a branch based on it can be created with
460 0e4002ca 2020-03-21 stsp .Cm got branch
463 0e4002ca 2020-03-21 stsp .Cm got fetch
464 0e4002ca 2020-03-21 stsp will refuse to fetch references from the remote repository's
465 0e4002ca 2020-03-21 stsp .Dq refs/remotes/
467 0e4002ca 2020-03-21 stsp .Dq refs/got/
470 161728eb 2021-07-24 stsp Delete all references which correspond to a particular
471 161728eb 2021-07-24 stsp .Ar remote-repository
472 161728eb 2021-07-24 stsp instead of fetching new changes.
473 161728eb 2021-07-24 stsp This can be useful when a remote repository is being removed from
474 161728eb 2021-07-24 stsp .Xr got.conf 5 .
479 161728eb 2021-07-24 stsp .Ar remote-repository
480 161728eb 2021-07-24 stsp argument is mandatory and no other options except
485 161728eb 2021-07-24 stsp are allowed.
487 161728eb 2021-07-24 stsp Only references are deleted.
488 161728eb 2021-07-24 stsp Any commit, tree, tag, and blob objects fetched from a remote repository
489 161728eb 2021-07-24 stsp will generally be stored in pack files and may be removed separately with
490 161728eb 2021-07-24 stsp .Xr git-repack 1
491 161728eb 2021-07-24 stsp and Git's garbage collector.
494 4ad4a1ec 2021-09-13 tracey .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Oo Fl q Oc Ar repository-path Op Ar work-tree-path
495 95f394e8 2021-10-04 kn .Dl (alias: Cm co )
496 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
497 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
498 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
499 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
500 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
504 5d7c1dab 2018-04-01 stsp .Ar work tree path
505 c844a238 2019-02-06 stsp is not specified, either use the last component of
506 5d7c1dab 2018-04-01 stsp .Ar repository path ,
508 5d7c1dab 2018-04-01 stsp .Ar path prefix
509 c844a238 2019-02-06 stsp was specified use the last component of
510 5d7c1dab 2018-04-01 stsp .Ar path prefix .
512 38e11793 2018-06-13 stsp The options for
513 38e11793 2018-06-13 stsp .Cm got checkout
514 38e11793 2018-06-13 stsp are as follows:
515 38e11793 2018-06-13 stsp .Bl -tag -width Ds
517 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
518 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
519 bb51a5b4 2020-01-13 stsp is not empty.
520 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
521 08573d5b 2019-05-14 stsp .It Fl b Ar branch
522 3c575567 2019-07-28 stsp Check out files from a commit on the specified
523 08573d5b 2019-05-14 stsp .Ar branch .
524 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
525 08573d5b 2019-05-14 stsp reference will be used.
526 8069f636 2019-01-12 stsp .It Fl c Ar commit
527 8069f636 2019-01-12 stsp Check out files from the specified
529 3c575567 2019-07-28 stsp on the selected branch.
530 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
531 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
532 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
533 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
534 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
535 08573d5b 2019-05-14 stsp branch will be used.
537 4b6c9460 2020-03-05 stsp If the specified
539 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
540 4b6c9460 2020-03-05 stsp this commit must be specified with the
543 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
544 4b6c9460 2020-03-05 stsp commit with
545 4b6c9460 2020-03-05 stsp .Cm got branch
547 4b6c9460 2020-03-05 stsp .Cm got checkout
548 4b6c9460 2020-03-05 stsp can be used.
549 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
550 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
551 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
552 38e11793 2018-06-13 stsp Only files beneath the specified
553 38e11793 2018-06-13 stsp .Ar path-prefix
554 38e11793 2018-06-13 stsp will be checked out.
556 4ad4a1ec 2021-09-13 tracey Silence progress output.
559 4ad4a1ec 2021-09-13 tracey .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl q Oc Op Ar path ...
560 95f394e8 2021-10-04 kn .Dl (alias: Cm up )
561 4f331d3a 2020-04-01 stsp Update an existing work tree to a different
562 4f331d3a 2020-04-01 stsp .Ar commit .
563 4f331d3a 2020-04-01 stsp Change existing files in the work tree as necessary to match file contents
564 4f331d3a 2020-04-01 stsp of this commit.
565 4f331d3a 2020-04-01 stsp Preserve any local changes in the work tree and merge them with the
566 4f331d3a 2020-04-01 stsp incoming changes.
568 5036ab18 2020-04-18 stsp Files which already contain merge conflicts will not be updated to avoid
569 5036ab18 2020-04-18 stsp further complications.
570 5036ab18 2020-04-18 stsp Such files will be updated when
571 5036ab18 2020-04-18 stsp .Cm got update
572 5036ab18 2020-04-18 stsp is run again after merge conflicts have been resolved.
573 5036ab18 2020-04-18 stsp If the conflicting changes are no longer needed affected files can be
574 5036ab18 2020-04-18 stsp reverted with
575 5036ab18 2020-04-18 stsp .Cm got revert
576 5036ab18 2020-04-18 stsp before running
577 5036ab18 2020-04-18 stsp .Cm got update
580 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
581 7f838b36 2019-02-08 stsp .Bl -column YXZ description
582 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
583 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
584 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
585 7f838b36 2019-02-08 stsp .It D Ta file was deleted
586 7f838b36 2019-02-08 stsp .It A Ta new file was added
587 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
588 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
589 5036ab18 2020-04-18 stsp .It # Ta file was not updated because it contains merge conflicts
590 3b9f0f87 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
595 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
596 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
597 f2ea84fa 2019-07-27 stsp specified paths.
598 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
599 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
600 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
603 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
604 c4cdcb68 2019-04-03 stsp multiple base commits.
605 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
606 47ec7be7 2019-05-12 stsp .Cm got update
607 47ec7be7 2019-05-12 stsp across the entire work tree.
608 024e9686 2019-05-14 stsp Specifying a
610 024e9686 2019-05-14 stsp is incompatible with the
614 4ed9f614 2019-08-04 stsp .Cm got update
615 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
616 4ed9f614 2019-08-04 stsp If changes have been staged with
617 4ed9f614 2019-08-04 stsp .Cm got stage ,
618 bc3056e3 2019-08-18 stsp these changes must first be committed with
619 4ed9f614 2019-08-04 stsp .Cm got commit
620 4ed9f614 2019-08-04 stsp or unstaged with
621 4ed9f614 2019-08-04 stsp .Cm got unstage .
623 507dc3bb 2018-12-29 stsp The options for
624 507dc3bb 2018-12-29 stsp .Cm got update
625 507dc3bb 2018-12-29 stsp are as follows:
626 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
627 024e9686 2019-05-14 stsp .It Fl b Ar branch
628 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
630 024e9686 2019-05-14 stsp before updating the work tree.
631 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
633 4f331d3a 2020-04-01 stsp As usual, any local changes in the work tree will be preserved.
634 4f331d3a 2020-04-01 stsp This can be useful when switching to a newly created branch in order
635 4f331d3a 2020-04-01 stsp to commit existing local changes to this branch.
637 4f331d3a 2020-04-01 stsp Any local changes must be dealt with separately in order to obtain a
638 4f331d3a 2020-04-01 stsp work tree with pristine file contents corresponding exactly to the specified
639 4f331d3a 2020-04-01 stsp .Ar branch .
640 4f331d3a 2020-04-01 stsp Such changes could first be committed to a different branch with
641 4f331d3a 2020-04-01 stsp .Cm got commit ,
642 4f331d3a 2020-04-01 stsp or could be discarded with
643 4f331d3a 2020-04-01 stsp .Cm got revert .
644 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
645 507dc3bb 2018-12-29 stsp Update the work tree to the specified
646 507dc3bb 2018-12-29 stsp .Ar commit .
647 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
648 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
649 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
650 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
651 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
652 024e9686 2019-05-14 stsp branch will be used.
654 4ad4a1ec 2021-09-13 tracey Silence progress output.
657 ac372b60 2021-09-15 stsp .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Oo Fl S Ar status-codes Oc Op Ar path ...
658 95f394e8 2021-10-04 kn .Dl (alias: Cm st )
659 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
660 6bad629b 2019-02-04 stsp using the following status codes:
661 6bad629b 2019-02-04 stsp .Bl -column YXZ description
662 6bad629b 2019-02-04 stsp .It M Ta modified file
663 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
664 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
665 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
666 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
667 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
668 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
670 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
671 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
673 2a06fe5f 2019-08-24 stsp specified on the command line
678 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
679 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
681 4ed9f614 2019-08-04 stsp If changes have been staged with
682 4ed9f614 2019-08-04 stsp .Cm got stage ,
683 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
684 4ed9f614 2019-08-04 stsp status codes:
685 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
686 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
687 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
688 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
691 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
692 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
693 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
694 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
697 081470ac 2020-08-13 stsp The options for
698 081470ac 2020-08-13 stsp .Cm got status
699 081470ac 2020-08-13 stsp are as follows:
700 081470ac 2020-08-13 stsp .Bl -tag -width Ds
702 f6343036 2021-06-22 stsp Show unversioned files even if they match an ignore pattern.
703 081470ac 2020-08-13 stsp .It Fl s Ar status-codes
704 081470ac 2020-08-13 stsp Only show files with a modification status matching any of the
705 00357e4d 2021-09-14 tracey single-character status codes contained in the
706 00357e4d 2021-09-14 tracey .Ar status-codes
707 00357e4d 2021-09-14 tracey argument.
708 00357e4d 2021-09-14 tracey Any combination of codes from the above list of possible status codes
709 00357e4d 2021-09-14 tracey may be specified.
710 00357e4d 2021-09-14 tracey For staged files, status codes displayed in either column will be matched.
711 b043307b 2021-09-14 stsp Cannot be used together with the
714 00357e4d 2021-09-14 tracey .It Fl S Ar status-codes
715 00357e4d 2021-09-14 tracey Suppress the output of files with a modification status matching any of the
716 081470ac 2020-08-13 stsp single-character status codes contained in the
717 081470ac 2020-08-13 stsp .Ar status-codes
719 081470ac 2020-08-13 stsp Any combination of codes from the above list of possible status codes
720 081470ac 2020-08-13 stsp may be specified.
721 081470ac 2020-08-13 stsp For staged files, status codes displayed in either column will be matched.
722 b043307b 2021-09-14 stsp Cannot be used together with the
727 6841da00 2019-08-08 stsp For compatibility with
730 bd8de430 2019-10-04 stsp .Xr git 1 ,
731 6841da00 2019-08-08 stsp .Cm got status
734 bd8de430 2019-10-04 stsp patterns from
735 6841da00 2019-08-08 stsp .Pa .cvsignore
737 bd8de430 2019-10-04 stsp .Pa .gitignore
738 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
739 bd8de430 2019-10-04 stsp which match these patterns.
740 bd8de430 2019-10-04 stsp As an extension to
742 bd8de430 2019-10-04 stsp matching rules,
743 bd8de430 2019-10-04 stsp .Cm got status
744 bd8de430 2019-10-04 stsp supports consecutive asterisks,
746 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
748 6841da00 2019-08-08 stsp .Xr cvs 1 ,
749 6841da00 2019-08-08 stsp .Cm got status
750 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
752 bd8de430 2019-10-04 stsp .Xr git 1 ,
753 bd8de430 2019-10-04 stsp .Cm got status
754 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
756 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
758 bd8de430 2019-10-04 stsp in a pattern.
759 0208f208 2020-05-05 stsp .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl P Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
760 38e11793 2018-06-13 stsp Display history of a repository.
763 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
764 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
766 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
767 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
768 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
770 38e11793 2018-06-13 stsp The options for
771 38e11793 2018-06-13 stsp .Cm got log
772 38e11793 2018-06-13 stsp are as follows:
773 38e11793 2018-06-13 stsp .Bl -tag -width Ds
775 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
776 1137e0ae 2020-01-27 stsp from other branches.
777 48c8c60d 2020-01-27 stsp By default,
778 48c8c60d 2020-01-27 stsp .Cm got log
779 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
780 38e11793 2018-06-13 stsp .It Fl c Ar commit
781 38e11793 2018-06-13 stsp Start traversing history at the specified
782 38e11793 2018-06-13 stsp .Ar commit .
783 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
784 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
785 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
786 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
787 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
788 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
789 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
790 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
792 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
793 6238ee32 2018-06-13 stsp .It Fl l Ar N
794 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
795 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
796 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
798 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
799 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
801 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
804 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
806 0208f208 2020-05-05 stsp Display the list of file paths changed in each commit, using the following
807 0208f208 2020-05-05 stsp status codes:
808 0208f208 2020-05-05 stsp .Bl -column YXZ description
809 0208f208 2020-05-05 stsp .It M Ta modified file
810 0208f208 2020-05-05 stsp .It D Ta file was deleted
811 0208f208 2020-05-05 stsp .It A Ta new file was added
812 0208f208 2020-05-05 stsp .It m Ta modified file modes (executable bit only)
814 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
815 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
816 6841bf13 2019-11-29 kn regular expression
817 6841bf13 2019-11-29 kn .Ar search-pattern .
818 0208f208 2020-05-05 stsp When used together with
820 0208f208 2020-05-05 stsp then the file paths changed by a commit can be matched as well.
821 6841bf13 2019-11-29 kn Regular expression syntax is documented in
822 6841bf13 2019-11-29 kn .Xr re_format 7 .
823 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
824 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
825 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
826 04ca23f4 2018-07-16 stsp working directory.
827 e9cf2e30 2019-02-05 stsp If this directory is a
829 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
831 dbec59df 2020-04-18 stsp Determine a set of commits to display as usual, but display these commits
832 dbec59df 2020-04-18 stsp in reverse order.
833 d1fe46f9 2020-04-18 stsp .It Fl x Ar commit
834 4e20a648 2021-03-21 jrick Stop traversing commit history immediately after the specified
836 52ab7958 2020-04-18 stsp has been traversed.
837 d1fe46f9 2020-04-18 stsp This option has no effect if the specified
839 d1fe46f9 2020-04-18 stsp is never traversed.
842 64453f7e 2020-11-21 stsp .It Cm diff Oo Fl a Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
843 95f394e8 2021-10-04 kn .Dl (alias: Cm di )
844 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
845 bd81cfb7 2020-04-19 stsp local changes in the work tree.
848 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
850 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
851 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
852 d24820bf 2019-08-11 stsp corresponding objects.
853 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
854 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
855 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
857 c0cc5c62 2018-10-18 stsp The options for
858 c0cc5c62 2018-10-18 stsp .Cm got diff
859 c0cc5c62 2018-10-18 stsp are as follows:
860 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
862 64453f7e 2020-11-21 stsp Treat file contents as ASCII text even if binary data is detected.
863 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
864 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
865 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
866 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
867 b72f483a 2019-02-05 stsp Use the repository at the specified path.
868 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
869 b72f483a 2019-02-05 stsp working directory.
870 b72f483a 2019-02-05 stsp If this directory is a
872 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
874 4ed9f614 2019-08-04 stsp Show changes staged with
875 4ed9f614 2019-08-04 stsp .Cm got stage
876 bd81cfb7 2020-04-19 stsp instead of showing local changes in the work tree.
877 4ed9f614 2019-08-04 stsp This option is only valid when
878 4ed9f614 2019-08-04 stsp .Cm got diff
879 4ed9f614 2019-08-04 stsp is invoked in a work tree.
881 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
884 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
885 95f394e8 2021-10-04 kn .Dl (alias: Cm bl )
886 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
888 1ff8e573 2018-08-02 stsp The options for
889 1ff8e573 2018-08-02 stsp .Cm got blame
890 1ff8e573 2018-08-02 stsp are as follows:
891 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
892 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
893 1ff8e573 2018-08-02 stsp Start traversing history at the specified
894 1ff8e573 2018-08-02 stsp .Ar commit .
895 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
896 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
897 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
898 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
899 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
900 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
901 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
902 1ff8e573 2018-08-02 stsp working directory.
903 0c06baac 2019-02-05 stsp If this directory is a
905 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
908 dfc23429 2019-08-11 stsp .It Cm tree Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl i Oc Oo Fl R Oc Op Ar path
909 95f394e8 2021-10-04 kn .Dl (alias: Cm tr )
910 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
911 5de5890b 2018-10-18 stsp directory path in the repository.
912 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
913 db0c2996 2019-02-10 stsp annotations:
914 db0c2996 2019-02-10 stsp .Bl -column YXZ description
915 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
916 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
917 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
918 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
921 0d6c6ee3 2020-05-20 stsp Symbolic link entries are also annotated with the target path of the link.
925 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
926 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
927 0c849583 2019-02-05 stsp if there is no work tree.
929 5de5890b 2018-10-18 stsp The options for
930 5de5890b 2018-10-18 stsp .Cm got tree
931 5de5890b 2018-10-18 stsp are as follows:
932 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
933 5de5890b 2018-10-18 stsp .It Fl c Ar commit
934 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
935 5de5890b 2018-10-18 stsp .Ar commit .
936 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
937 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
938 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
939 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
940 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
941 5de5890b 2018-10-18 stsp Use the repository at the specified path.
942 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
943 5de5890b 2018-10-18 stsp working directory.
944 0c849583 2019-02-05 stsp If this directory is a
946 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
948 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
950 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
952 e31abbf2 2020-03-22 stsp .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
953 d0eebce4 2019-03-11 stsp Manage references in a repository.
955 e31abbf2 2020-03-22 stsp References may be listed, created, deleted, and changed.
956 e31abbf2 2020-03-22 stsp When creating, deleting, or changing a reference the specified
958 e31abbf2 2020-03-22 stsp must be an absolute reference name, i.e. it must begin with
959 f16e4044 2019-10-09 stsp .Dq refs/ .
961 d0eebce4 2019-03-11 stsp The options for
962 d0eebce4 2019-03-11 stsp .Cm got ref
963 d0eebce4 2019-03-11 stsp are as follows:
964 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
965 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
966 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
967 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
968 d0eebce4 2019-03-11 stsp working directory.
969 d0eebce4 2019-03-11 stsp If this directory is a
971 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
973 b2070a3f 2020-03-22 stsp List references in the repository.
976 b2070a3f 2020-03-22 stsp is specified, list all existing references in the repository.
979 b2070a3f 2020-03-22 stsp is a reference namespace, list all references in this namespace.
980 b2070a3f 2020-03-22 stsp Otherwise, show only the reference with the given
982 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
984 e31abbf2 2020-03-22 stsp .It Fl c Ar object
985 e31abbf2 2020-03-22 stsp Create a reference or change an existing reference.
986 e31abbf2 2020-03-22 stsp The reference with the specified
988 e31abbf2 2020-03-22 stsp will point at the specified
990 e31abbf2 2020-03-22 stsp The expected
992 e31abbf2 2020-03-22 stsp argument is a ID SHA1 hash or an existing reference or tag name which will
993 e31abbf2 2020-03-22 stsp be resolved to the ID of a corresponding commit, tree, tag, or blob object.
994 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
996 e31abbf2 2020-03-22 stsp .It Fl s Ar reference
997 e31abbf2 2020-03-22 stsp Create a symbolic reference, or change an existing symbolic reference.
998 e31abbf2 2020-03-22 stsp The symbolic reference with the specified
1000 e31abbf2 2020-03-22 stsp will point at the specified
1001 e31abbf2 2020-03-22 stsp .Ar reference
1002 e31abbf2 2020-03-22 stsp which must already exist in the repository.
1003 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
1004 d1c1ae5f 2019-08-12 stsp this option is used.
1005 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1008 e31abbf2 2020-03-22 stsp Delete the reference with the specified
1010 e31abbf2 2020-03-22 stsp from the repository.
1011 601aba22 2021-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted references
1012 601aba22 2021-03-21 stsp remain in the repository and may be removed separately with
1013 e6786710 2021-07-03 stsp Git's garbage collector or
1014 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1015 e31abbf2 2020-03-22 stsp Cannot be used together with any other options except
1019 da76fce2 2020-02-24 stsp .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
1020 95f394e8 2021-10-04 kn .Dl (alias: Cm br )
1021 da76fce2 2020-02-24 stsp Create, list, or delete branches.
1023 34d4e04c 2021-02-08 stsp Local branches are managed via references which live in the
1024 4e759de4 2019-06-26 stsp .Dq refs/heads/
1025 4e759de4 2019-06-26 stsp reference namespace.
1027 4e759de4 2019-06-26 stsp .Cm got branch
1028 2f1457c6 2021-08-27 stsp command creates references in this namespace only.
1030 2f1457c6 2021-08-27 stsp When deleting branches the specified
1032 2f1457c6 2021-08-27 stsp is searched in the
1033 2f1457c6 2021-08-27 stsp .Dq refs/heads
1034 2f1457c6 2021-08-27 stsp reference namespace first.
1035 2f1457c6 2021-08-27 stsp If no corresponding branch is found the
1036 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1037 2f1457c6 2021-08-27 stsp namespace will be searched next.
1039 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
1040 ad89fa31 2019-10-04 stsp work tree's current branch.
1044 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
1045 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
1046 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
1047 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
1049 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
1050 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
1051 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
1052 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
1054 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
1055 da76fce2 2020-02-24 stsp .Bl -column YXZ description
1056 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
1057 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
1058 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
1059 da76fce2 2020-02-24 stsp .It D Ta file was deleted
1060 da76fce2 2020-02-24 stsp .It A Ta new file was added
1061 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1062 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
1065 4e759de4 2019-06-26 stsp The options for
1066 4e759de4 2019-06-26 stsp .Cm got branch
1067 4e759de4 2019-06-26 stsp are as follows:
1068 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
1069 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
1070 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
1071 a74f7e83 2019-11-10 stsp .Ar commit .
1072 a74f7e83 2019-11-10 stsp The expected
1073 a74f7e83 2019-11-10 stsp .Ar commit
1074 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
1075 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
1076 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
1077 4e759de4 2019-06-26 stsp Use the repository at the specified path.
1078 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
1079 4e759de4 2019-06-26 stsp working directory.
1080 4e759de4 2019-06-26 stsp If this directory is a
1082 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
1084 34d4e04c 2021-02-08 stsp List all existing branches in the repository, including copies of remote
1085 34d4e04c 2021-02-08 stsp repositories' branches in the
1086 34d4e04c 2021-02-08 stsp .Dq refs/remotes/
1087 34d4e04c 2021-02-08 stsp reference namespace.
1089 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
1090 ba882ee3 2019-07-11 stsp with one the following annotations:
1091 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
1092 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
1093 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
1095 4e759de4 2019-06-26 stsp .It Fl d Ar name
1096 2f1457c6 2021-08-27 stsp Delete the branch with the specified
1099 2f1457c6 2021-08-27 stsp .Dq refs/heads
1101 2f1457c6 2021-08-27 stsp .Dq refs/remotes
1102 2f1457c6 2021-08-27 stsp reference namespace.
1104 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
1105 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
1106 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
1107 e6786710 2021-07-03 stsp Git's garbage collector or
1108 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1110 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
1112 80106605 2020-02-24 stsp .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
1113 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
1115 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
1116 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
1117 8e7bd50a 2019-08-22 stsp reference namespace.
1119 8e7bd50a 2019-08-22 stsp .Cm got tag
1120 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
1121 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
1122 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
1124 80106605 2020-02-24 stsp Attempt to create a tag with the given
1125 8e7bd50a 2019-08-22 stsp .Ar name ,
1126 8e7bd50a 2019-08-22 stsp and make this tag point at the given
1127 8e7bd50a 2019-08-22 stsp .Ar commit .
1128 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
1129 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
1130 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
1132 8e7bd50a 2019-08-22 stsp The options for
1133 8e7bd50a 2019-08-22 stsp .Cm got tag
1134 8e7bd50a 2019-08-22 stsp are as follows:
1135 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
1136 80106605 2020-02-24 stsp .It Fl c Ar commit
1137 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
1138 80106605 2020-02-24 stsp .Ar commit .
1139 80106605 2020-02-24 stsp The expected
1140 80106605 2020-02-24 stsp .Ar commit
1141 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
1142 80106605 2020-02-24 stsp will be resolved to a commit ID.
1143 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1144 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
1145 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
1146 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
1147 8e7bd50a 2019-08-22 stsp Without the
1150 3a62228f 2019-11-08 stsp .Cm got tag
1151 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
1152 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
1153 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
1154 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1155 8e7bd50a 2019-08-22 stsp working directory.
1156 8e7bd50a 2019-08-22 stsp If this directory is a
1158 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1160 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
1161 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
1164 8e7bd50a 2019-08-22 stsp By design, the
1165 8e7bd50a 2019-08-22 stsp .Cm got tag
1166 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
1167 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
1168 8e7bd50a 2019-08-22 stsp .Cm got ref
1169 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
1170 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
1171 8e7bd50a 2019-08-22 stsp another repository.
1172 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1173 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
1174 d00136be 2019-03-26 stsp repository in the next commit.
1175 ff56836b 2021-07-08 stsp By default, files which match a
1176 ff56836b 2021-07-08 stsp .Cm got status
1177 ff56836b 2021-07-08 stsp ignore pattern will not be added.
1179 4e68cba3 2019-11-23 stsp The options for
1180 4e68cba3 2019-11-23 stsp .Cm got add
1181 4e68cba3 2019-11-23 stsp are as follows:
1182 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
1184 4e68cba3 2019-11-23 stsp Permit recursion into directories.
1185 4e68cba3 2019-11-23 stsp If this option is not specified,
1186 4e68cba3 2019-11-23 stsp .Cm got add
1187 4e68cba3 2019-11-23 stsp will refuse to run if a specified
1189 4e68cba3 2019-11-23 stsp is a directory.
1190 022fae89 2019-12-06 tracey .It Fl I
1191 ff56836b 2021-07-08 stsp Add files even if they match a
1192 022fae89 2019-12-06 tracey .Cm got status
1193 022fae89 2019-12-06 tracey ignore pattern.
1196 766841c2 2020-08-13 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1197 95f394e8 2021-10-04 kn .Dl (alias: Cm rm )
1198 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
1199 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
1201 2ec1f75b 2019-03-26 stsp The options for
1202 86d25a1b 2019-07-11 stsp .Cm got remove
1203 2ec1f75b 2019-03-26 stsp are as follows:
1204 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
1206 bd81cfb7 2020-04-19 stsp Perform the operation even if a file contains local modifications.
1207 70e3e7f5 2019-12-13 tracey .It Fl k
1208 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
1209 f2a9dc41 2019-12-13 tracey .It Fl R
1210 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
1211 f2a9dc41 2019-12-13 tracey If this option is not specified,
1212 f2a9dc41 2019-12-13 tracey .Cm got remove
1213 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
1214 f2a9dc41 2019-12-13 tracey .Ar path
1215 f2a9dc41 2019-12-13 tracey is a directory.
1216 766841c2 2020-08-13 stsp .It Fl s Ar status-codes
1217 766841c2 2020-08-13 stsp Only delete files with a modification status matching one of the
1218 766841c2 2020-08-13 stsp single-character status codes contained in the
1219 766841c2 2020-08-13 stsp .Ar status-codes
1221 766841c2 2020-08-13 stsp The following status codes may be specified:
1222 766841c2 2020-08-13 stsp .Bl -column YXZ description
1223 766841c2 2020-08-13 stsp .It M Ta modified file (this implies the
1226 766841c2 2020-08-13 stsp .It ! Ta versioned file expected on disk but missing
1230 dfc23429 2019-08-11 stsp .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1231 95f394e8 2021-10-04 kn .Dl (alias: Cm rv )
1232 bd81cfb7 2020-04-19 stsp Revert any local changes in files at the specified paths in a work tree.
1233 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
1234 1dd86744 2019-08-12 anthony work tree's base commit.
1235 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
1236 a129376b 2019-03-28 stsp .Cm got revert !
1238 e20a8b6f 2019-06-04 stsp If a file was added with
1239 a129376b 2019-03-28 stsp .Cm got add
1240 a129376b 2019-03-28 stsp it will become an unversioned file again.
1241 e20a8b6f 2019-06-04 stsp If a file was deleted with
1242 86d25a1b 2019-07-11 stsp .Cm got remove
1243 a129376b 2019-03-28 stsp it will be restored.
1245 0f6d7415 2019-08-08 stsp The options for
1246 0f6d7415 2019-08-08 stsp .Cm got revert
1247 0f6d7415 2019-08-08 stsp are as follows:
1248 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
1250 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
1251 33aa809d 2019-08-08 stsp changes to revert based on
1253 33aa809d 2019-08-08 stsp (revert change),
1255 33aa809d 2019-08-08 stsp (keep change), and
1257 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1258 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1259 33aa809d 2019-08-08 stsp modified file content can be reverted.
1260 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1261 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
1264 33aa809d 2019-08-08 stsp option, read
1269 33aa809d 2019-08-08 stsp responses line-by-line from the specified
1270 33aa809d 2019-08-08 stsp .Ar response-script
1271 33aa809d 2019-08-08 stsp file instead of prompting interactively.
1273 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1274 0f6d7415 2019-08-08 stsp If this option is not specified,
1275 0f6d7415 2019-08-08 stsp .Cm got revert
1276 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1278 0f6d7415 2019-08-08 stsp is a directory.
1281 28cf319f 2021-01-28 stsp .It Cm commit Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
1282 95f394e8 2021-10-04 kn .Dl (alias: Cm ci )
1283 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1284 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1287 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1288 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1290 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1291 1dd86744 2019-08-12 anthony .Cm got stage ,
1292 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1293 4ed9f614 2019-08-04 stsp have not been staged.
1295 28cf319f 2021-01-28 stsp .Cm got commit
1296 28cf319f 2021-01-28 stsp opens a temporary file in an editor where a log message can be written
1297 28cf319f 2021-01-28 stsp unless the
1299 28cf319f 2021-01-28 stsp option is used
1304 28cf319f 2021-01-28 stsp options are used together.
1306 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1307 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1308 15cd91f7 2019-05-12 stsp .It M Ta modified file
1309 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1310 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1311 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1314 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1315 996d5ccd 2019-08-05 stsp recorded base commit.
1318 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1319 15cd91f7 2019-05-12 stsp multiple base commits.
1320 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1321 47ec7be7 2019-05-12 stsp .Cm got update
1322 47ec7be7 2019-05-12 stsp across the entire work tree.
1325 15cd91f7 2019-05-12 stsp .Cm got commit
1326 15cd91f7 2019-05-12 stsp command requires the
1327 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1328 aba9c984 2019-09-08 stsp environment variable to be set,
1329 257add31 2020-09-09 stsp unless an author has been configured in
1330 257add31 2020-09-09 stsp .Xr got.conf 5
1332 aba9c984 2019-09-08 stsp .Dv user.name
1334 709ae9eb 2019-09-08 stsp .Dv user.email
1335 709ae9eb 2019-09-08 stsp configuration settings can be
1336 aba9c984 2019-09-08 stsp obtained from the repository's
1337 aba9c984 2019-09-08 stsp .Pa .git/config
1338 c9956ddf 2019-09-08 stsp file or from Git's global
1339 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1340 c9956ddf 2019-09-08 stsp configuration file.
1342 74416c47 2019-05-09 stsp The options for
1343 74416c47 2019-05-09 stsp .Cm got commit
1344 74416c47 2019-05-09 stsp are as follows:
1345 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1346 28cf319f 2021-01-28 stsp .It Fl F Ar path
1347 28cf319f 2021-01-28 stsp Use the prepared log message stored in the file found at
1349 28cf319f 2021-01-28 stsp when creating the new commit.
1350 28cf319f 2021-01-28 stsp .Cm got commit
1351 28cf319f 2021-01-28 stsp opens a temporary file in an editor where the prepared log message can be
1352 28cf319f 2021-01-28 stsp reviewed and edited further if needed.
1353 28cf319f 2021-01-28 stsp Cannot be used together with the
1356 28cf319f 2021-01-28 stsp .It Fl m Ar message
1357 28cf319f 2021-01-28 stsp Use the specified log message when creating the new commit.
1358 28cf319f 2021-01-28 stsp Cannot be used together with the
1362 28cf319f 2021-01-28 stsp This option prevents
1363 23594da9 2019-05-13 stsp .Cm got commit
1364 28cf319f 2021-01-28 stsp from opening the commit message in an editor.
1365 28cf319f 2021-01-28 stsp It has no effect unless it is used together with the
1367 28cf319f 2021-01-28 stsp option and is intended for non-interactive use such as scripting.
1369 af358f55 2020-07-23 stsp Allow the addition of symbolic links which point outside of the path space
1370 af358f55 2020-07-23 stsp that is under version control.
1371 af358f55 2020-07-23 stsp By default,
1372 af358f55 2020-07-23 stsp .Cm got commit
1373 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
1374 35213c7c 2020-07-23 stsp As a precaution,
1376 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
1377 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
1378 af358f55 2020-07-23 stsp points outside of the work tree.
1379 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
1380 af358f55 2020-07-23 stsp .Dq make obj
1381 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
1382 af358f55 2020-07-23 stsp version control.
1385 cfce0458 2019-07-28 stsp .Cm got commit
1386 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1387 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1388 916f288c 2019-07-30 stsp .Dq refs/heads/
1389 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1390 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1391 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1392 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1393 cfce0458 2019-07-28 stsp .Cm got update
1394 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1395 cfce0458 2019-07-28 stsp in the repository.
1397 f8a36e22 2021-08-26 stsp .It Cm send Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Ar branch Oc Oo Fl f Oc Oo Fl r Ar repository-path Oc Oo Fl t Ar tag Oc Oo Fl T Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
1398 95f394e8 2021-10-04 kn .Dl (alias: Cm se )
1399 f8a36e22 2021-08-26 stsp Send new changes to a remote repository.
1401 f8a36e22 2021-08-26 stsp .Ar remote-repository
1402 f8a36e22 2021-08-26 stsp is specified,
1403 f8a36e22 2021-08-26 stsp .Dq origin
1404 f8a36e22 2021-08-26 stsp will be used.
1405 f8a36e22 2021-08-26 stsp The remote repository's URL is obtained from the corresponding entry in
1406 f8a36e22 2021-08-26 stsp .Xr got.conf 5
1408 f8a36e22 2021-08-26 stsp .Pa config
1409 f8a36e22 2021-08-26 stsp file of the local repository, as created by
1410 f8a36e22 2021-08-26 stsp .Cm got clone .
1412 f8a36e22 2021-08-26 stsp All objects corresponding to new changes will be written to a temporary
1413 f8a36e22 2021-08-26 stsp pack file which is then uploaded to the server.
1414 f8a36e22 2021-08-26 stsp Upon success, references in the
1415 f8a36e22 2021-08-26 stsp .Dq refs/remotes/
1416 f8a36e22 2021-08-26 stsp reference namespace of the local repository will be updated to point at
1417 f8a36e22 2021-08-26 stsp the commits which have been sent.
1419 f8a36e22 2021-08-26 stsp By default, changes will only be sent if they are based on up-to-date
1420 f8a36e22 2021-08-26 stsp copies of relevant branches in the remote repository.
1421 fd44090b 2021-08-26 stsp If any changes to be sent are based on out-of-date copies or would
1422 fd44090b 2021-08-26 stsp otherwise break linear history of existing branches, new changes must
1423 fd44090b 2021-08-26 stsp be fetched from the server with
1424 f8a36e22 2021-08-26 stsp .Cm got fetch
1425 f8a36e22 2021-08-26 stsp and local branches must be rebased with
1426 f8a36e22 2021-08-26 stsp .Cm got rebase
1428 f8a36e22 2021-08-26 stsp .Cm got send
1429 f8a36e22 2021-08-26 stsp can succeed.
1432 fd44090b 2021-08-26 stsp option can be used to make exceptions to these requirements.
1434 f8a36e22 2021-08-26 stsp The options for
1435 f8a36e22 2021-08-26 stsp .Cm got send
1436 f8a36e22 2021-08-26 stsp are as follows:
1437 f8a36e22 2021-08-26 stsp .Bl -tag -width Ds
1439 f8a36e22 2021-08-26 stsp Send all branches from the local repository's
1440 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1441 f8a36e22 2021-08-26 stsp reference namespace.
1444 f8a36e22 2021-08-26 stsp option is equivalent to listing all branches with multiple
1447 f8a36e22 2021-08-26 stsp Cannot be used together with the
1450 f8a36e22 2021-08-26 stsp .It Fl b Ar branch
1451 f8a36e22 2021-08-26 stsp Send the specified
1452 f8a36e22 2021-08-26 stsp .Ar branch
1453 f8a36e22 2021-08-26 stsp from the local repository's
1454 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1455 f8a36e22 2021-08-26 stsp reference namespace.
1456 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1458 f8a36e22 2021-08-26 stsp If this option is not specified, default to the work tree's current branch
1459 f8a36e22 2021-08-26 stsp if invoked in a work tree, or to the repository's HEAD reference.
1460 f8a36e22 2021-08-26 stsp Cannot be used together with the
1463 f8a36e22 2021-08-26 stsp .It Fl d Ar branch
1464 f8a36e22 2021-08-26 stsp Delete the specified
1465 f8a36e22 2021-08-26 stsp .Ar branch
1466 f8a36e22 2021-08-26 stsp from the remote repository's
1467 f8a36e22 2021-08-26 stsp .Dq refs/heads/
1468 f8a36e22 2021-08-26 stsp reference namespace.
1469 f8a36e22 2021-08-26 stsp This option may be specified multiple times to build a list of branches
1470 f8a36e22 2021-08-26 stsp to delete.
1472 f8a36e22 2021-08-26 stsp Only references are deleted.
1473 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to deleted branches
1474 f8a36e22 2021-08-26 stsp may become subject to deletion by Git's garbage collector running on
1475 f8a36e22 2021-08-26 stsp the server.
1477 f8a36e22 2021-08-26 stsp Requesting deletion of branches results in an error if the server
1478 fd44090b 2021-08-26 stsp does not support this feature or disallows the deletion of branches
1479 fd44090b 2021-08-26 stsp based on its configuration.
1481 fd44090b 2021-08-26 stsp Attempt to force the server to overwrite existing branches or tags
1482 fd44090b 2021-08-26 stsp in the remote repository, even when
1483 fd44090b 2021-08-26 stsp .Cm got fetch
1485 fd44090b 2021-08-26 stsp .Cm got rebase
1486 fd44090b 2021-08-26 stsp would usually be required before changes can be sent.
1487 f8a36e22 2021-08-26 stsp The server may reject forced requests regardless, depending on its
1488 f8a36e22 2021-08-26 stsp configuration.
1490 f8a36e22 2021-08-26 stsp Any commit, tree, tag, and blob objects belonging to overwritten branches
1491 f8a36e22 2021-08-26 stsp or tags may become subject to deletion by Git's garbage collector running
1492 f8a36e22 2021-08-26 stsp on the server.
1495 f8a36e22 2021-08-26 stsp .Dq refs/tags
1496 f8a36e22 2021-08-26 stsp reference namespace is globally shared between all repositories.
1497 f8a36e22 2021-08-26 stsp Use of the
1499 f8a36e22 2021-08-26 stsp option to overwrite tags is discouraged because it can lead to
1500 f8a36e22 2021-08-26 stsp inconsistencies between the tags present in different repositories.
1501 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1502 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1504 f8a36e22 2021-08-26 stsp Use of the
1506 f8a36e22 2021-08-26 stsp option is particularly discouraged if changes being sent are based
1507 f8a36e22 2021-08-26 stsp on an out-of-date copy of a branch in the remote repository.
1508 f8a36e22 2021-08-26 stsp Instead of using the
1510 f8a36e22 2021-08-26 stsp option, new changes should
1511 f8a36e22 2021-08-26 stsp be fetched with
1512 f8a36e22 2021-08-26 stsp .Cm got fetch
1513 f8a36e22 2021-08-26 stsp and local branches should be rebased with
1514 f8a36e22 2021-08-26 stsp .Cm got rebase ,
1515 f8a36e22 2021-08-26 stsp followed by another attempt to send the changes.
1519 f8a36e22 2021-08-26 stsp option should only be needed in situations where the remote repository's
1520 f8a36e22 2021-08-26 stsp copy of a branch or tag is known to be out-of-date and is considered
1521 f8a36e22 2021-08-26 stsp disposable.
1522 f8a36e22 2021-08-26 stsp The risks of creating inconsistencies between different repositories
1523 f8a36e22 2021-08-26 stsp should also be taken into account.
1524 f8a36e22 2021-08-26 stsp .It Fl r Ar repository-path
1525 f8a36e22 2021-08-26 stsp Use the repository at the specified path.
1526 f8a36e22 2021-08-26 stsp If not specified, assume the repository is located at or above the current
1527 f8a36e22 2021-08-26 stsp working directory.
1528 f8a36e22 2021-08-26 stsp If this directory is a
1530 f8a36e22 2021-08-26 stsp work tree, use the repository path associated with this work tree.
1531 f8a36e22 2021-08-26 stsp .It Fl t Ar tag
1532 f8a36e22 2021-08-26 stsp Send the specified
1534 f8a36e22 2021-08-26 stsp from the local repository's
1535 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1536 f8a36e22 2021-08-26 stsp reference namespace, in addition to any branches that are being sent.
1539 f8a36e22 2021-08-26 stsp option may be specified multiple times to build a list of tags to send.
1540 f8a36e22 2021-08-26 stsp No tags will be sent if the
1542 f8a36e22 2021-08-26 stsp option is not used.
1544 f8a36e22 2021-08-26 stsp Raise an error if the specified
1546 f8a36e22 2021-08-26 stsp already exists in the remote repository, unless the
1548 93a300b2 2021-08-26 stsp option is used to overwrite the server's copy of the tag.
1549 f8a36e22 2021-08-26 stsp In general, creating a new tag with a different name is recommended
1550 f8a36e22 2021-08-26 stsp instead of overwriting an existing tag.
1552 f8a36e22 2021-08-26 stsp Cannot be used together with the
1556 f8a36e22 2021-08-26 stsp Attempt to send all tags from the local repository's
1557 f8a36e22 2021-08-26 stsp .Dq refs/tags/
1558 f8a36e22 2021-08-26 stsp reference namespace.
1561 f8a36e22 2021-08-26 stsp option is equivalent to listing all tags with multiple
1564 f8a36e22 2021-08-26 stsp Cannot be used together with the
1568 f8a36e22 2021-08-26 stsp Suppress progress reporting output.
1569 f8a36e22 2021-08-26 stsp The same option will be passed to
1571 f8a36e22 2021-08-26 stsp if applicable.
1573 f8a36e22 2021-08-26 stsp Verbose mode.
1575 f8a36e22 2021-08-26 stsp .Cm got send
1576 f8a36e22 2021-08-26 stsp to print debugging messages to standard error output.
1577 f8a36e22 2021-08-26 stsp The same option will be passed to
1579 f8a36e22 2021-08-26 stsp if applicable.
1580 f8a36e22 2021-08-26 stsp Multiple -v options increase the verbosity.
1581 f8a36e22 2021-08-26 stsp The maximum is 3.
1584 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1585 95f394e8 2021-10-04 kn .Dl (alias: Cm cy )
1586 234035bc 2019-06-01 stsp Merge changes from a single
1587 234035bc 2019-06-01 stsp .Ar commit
1588 234035bc 2019-06-01 stsp into the work tree.
1589 234035bc 2019-06-01 stsp The specified
1590 234035bc 2019-06-01 stsp .Ar commit
1591 a16d97bd 2021-09-02 stsp should be on a different branch than the work tree's base commit.
1592 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1593 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1594 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1596 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1597 234035bc 2019-06-01 stsp .Bl -column YXZ description
1598 234035bc 2019-06-01 stsp .It G Ta file was merged
1599 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1600 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1601 234035bc 2019-06-01 stsp .It D Ta file was deleted
1602 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
1603 234035bc 2019-06-01 stsp .It A Ta new file was added
1604 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1605 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1608 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1609 234035bc 2019-06-01 stsp may be viewed with
1610 234035bc 2019-06-01 stsp .Cm got diff ,
1611 234035bc 2019-06-01 stsp amended manually or with further
1612 234035bc 2019-06-01 stsp .Cm got cherrypick
1614 234035bc 2019-06-01 stsp committed with
1615 234035bc 2019-06-01 stsp .Cm got commit ,
1616 234035bc 2019-06-01 stsp or discarded again with
1617 234035bc 2019-06-01 stsp .Cm got revert .
1619 234035bc 2019-06-01 stsp .Cm got cherrypick
1620 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1621 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1622 234035bc 2019-06-01 stsp to a single base commit with
1623 234035bc 2019-06-01 stsp .Cm got update .
1624 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
1625 234035bc 2019-06-01 stsp conflicts must be resolved first.
1627 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1628 95f394e8 2021-10-04 kn .Dl (alias: Cm bo )
1629 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1630 5ef14e63 2019-06-02 stsp .Ar commit
1631 5ef14e63 2019-06-02 stsp into the work tree.
1632 5ef14e63 2019-06-02 stsp The specified
1633 5ef14e63 2019-06-02 stsp .Ar commit
1634 a16d97bd 2021-09-02 stsp should be on the same branch as the work tree's base commit.
1635 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1636 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1637 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1639 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1640 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1641 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1642 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1643 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1644 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1645 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
1646 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1647 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1648 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1651 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1652 5ef14e63 2019-06-02 stsp which may be viewed with
1653 5ef14e63 2019-06-02 stsp .Cm got diff ,
1654 5ef14e63 2019-06-02 stsp amended manually or with further
1655 778a73c2 2019-07-12 stsp .Cm got backout
1657 5ef14e63 2019-06-02 stsp committed with
1658 5ef14e63 2019-06-02 stsp .Cm got commit ,
1659 5ef14e63 2019-06-02 stsp or discarded again with
1660 5ef14e63 2019-06-02 stsp .Cm got revert .
1662 92228c38 2019-06-02 stsp .Cm got backout
1663 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1664 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1665 92228c38 2019-06-02 stsp to a single base commit with
1666 92228c38 2019-06-02 stsp .Cm got update .
1667 69de9dd4 2021-09-03 stsp If any relevant files already contain merge conflicts, these
1668 92228c38 2019-06-02 stsp conflicts must be resolved first.
1670 643b85bc 2021-07-16 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1671 95f394e8 2021-10-04 kn .Dl (alias: Cm rb )
1672 818c7501 2019-07-11 stsp Rebase commits on the specified
1673 818c7501 2019-07-11 stsp .Ar branch
1674 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1676 818c7501 2019-07-11 stsp .Ar branch
1677 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1678 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1679 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1680 818c7501 2019-07-11 stsp .Ar branch
1681 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1682 f09e2405 2019-07-11 stsp of the specified
1683 818c7501 2019-07-11 stsp .Ar branch
1684 f09e2405 2019-07-11 stsp has been rebased.
1687 2b6826ba 2020-02-24 stsp .Cm got rebase
1688 2b6826ba 2020-02-24 stsp is used as intended, the specified
1689 2b6826ba 2020-02-24 stsp .Ar branch
1690 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1691 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1692 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1693 2b6826ba 2020-02-24 stsp .Cm got update -b
1694 2b6826ba 2020-02-24 stsp before starting the
1695 2b6826ba 2020-02-24 stsp .Cm rebase
1696 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1697 2b6826ba 2020-02-24 stsp a common history with the specified
1698 2b6826ba 2020-02-24 stsp .Ar branch
1699 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1700 c10890ce 2020-02-25 stsp remote repository.
1702 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1703 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1704 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1705 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1706 818c7501 2019-07-11 stsp .Ar branch ,
1707 818c7501 2019-07-11 stsp but with different commit IDs.
1708 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1709 f09e2405 2019-07-11 stsp the new version of the specified
1710 818c7501 2019-07-11 stsp .Ar branch
1711 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1713 1795b260 2021-04-02 kn Old commits in their pre-rebase state are automatically backed up in the
1714 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1715 e600f124 2021-03-21 stsp reference namespace.
1716 e600f124 2021-03-21 stsp As long as these references are not removed older versions of rebased
1717 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1718 e600f124 2021-03-21 stsp .Cm got rebase -l
1720 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1721 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1722 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1724 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1725 818c7501 2019-07-11 stsp using the following status codes:
1726 818c7501 2019-07-11 stsp .Bl -column YXZ description
1727 818c7501 2019-07-11 stsp .It G Ta file was merged
1728 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1729 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1730 818c7501 2019-07-11 stsp .It D Ta file was deleted
1731 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
1732 818c7501 2019-07-11 stsp .It A Ta new file was added
1733 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1734 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1737 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1738 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1739 1fa49072 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
1740 1fa49072 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
1741 1fa49072 2021-09-28 stsp the rebase operation will be interrupted to prevent potentially incomplete
1742 1fa49072 2021-09-28 stsp changes from being committed to the repository without user intervention.
1743 1fa49072 2021-09-28 stsp The work tree may be modified as desired and the rebase operation can be
1744 1fa49072 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
1745 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1746 818c7501 2019-07-11 stsp .Ar branch
1747 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1749 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1750 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1751 f09e2405 2019-07-11 stsp when the rebase operation continues.
1753 818c7501 2019-07-11 stsp .Cm got rebase
1754 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1755 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1756 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1757 818c7501 2019-07-11 stsp .Cm got update .
1758 4ed9f614 2019-08-04 stsp If changes have been staged with
1759 4ed9f614 2019-08-04 stsp .Cm got stage ,
1760 bc3056e3 2019-08-18 stsp these changes must first be committed with
1761 4ed9f614 2019-08-04 stsp .Cm got commit
1762 4ed9f614 2019-08-04 stsp or unstaged with
1763 4ed9f614 2019-08-04 stsp .Cm got unstage .
1764 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1765 f09e2405 2019-07-11 stsp committed with
1766 f09e2405 2019-07-11 stsp .Cm got commit
1767 f09e2405 2019-07-11 stsp or reverted with
1768 f09e2405 2019-07-11 stsp .Cm got revert .
1770 64c6d990 2019-07-11 stsp .Ar branch
1771 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1772 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1775 7d5807f4 2019-07-11 stsp .Cm got update
1777 7d5807f4 2019-07-11 stsp .Cm got commit
1778 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1779 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1780 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1782 818c7501 2019-07-11 stsp The options for
1783 818c7501 2019-07-11 stsp .Cm got rebase
1784 818c7501 2019-07-11 stsp are as follows:
1785 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1787 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1788 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1790 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1791 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1793 e600f124 2021-03-21 stsp Show a list of past rebase operations, represented by references in the
1794 e600f124 2021-03-21 stsp .Dq refs/got/backup/rebase
1795 e600f124 2021-03-21 stsp reference namespace.
1797 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
1798 e600f124 2021-03-21 stsp the object ID of the corresponding post-rebase commit, and
1799 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
1800 e600f124 2021-03-21 stsp Given these object IDs,
1802 e600f124 2021-03-21 stsp .Cm got log
1803 e600f124 2021-03-21 stsp command with the
1807 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
1809 e600f124 2021-03-21 stsp .Cm got branch
1810 e600f124 2021-03-21 stsp command with the
1812 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-rebase state if desired.
1815 e600f124 2021-03-21 stsp .Ar branch
1816 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
1818 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
1820 e600f124 2021-03-21 stsp If this option is used,
1821 e600f124 2021-03-21 stsp .Cm got rebase
1822 e600f124 2021-03-21 stsp does not require a work tree.
1823 e600f124 2021-03-21 stsp None of the other options can be used together with
1826 643b85bc 2021-07-16 stsp Delete backups created by past rebase operations, represented by references
1828 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase
1829 643b85bc 2021-07-16 stsp reference namespace.
1832 643b85bc 2021-07-16 stsp .Ar branch
1833 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
1834 643b85bc 2021-07-16 stsp this branch.
1835 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
1836 643b85bc 2021-07-16 stsp .Dq refs/got/backup/rebase .
1838 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
1839 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
1840 643b85bc 2021-07-16 stsp Git's garbage collector or
1841 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
1843 643b85bc 2021-07-16 stsp If this option is used,
1844 643b85bc 2021-07-16 stsp .Cm got rebase
1845 643b85bc 2021-07-16 stsp does not require a work tree.
1846 643b85bc 2021-07-16 stsp None of the other options can be used together with
1850 b93c7142 2021-10-01 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl e Oc Oo Fl f Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1851 95f394e8 2021-10-04 kn .Dl (alias: Cm he )
1852 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1853 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1855 6e54d307 2020-02-24 stsp Before starting a
1856 6e54d307 2020-02-24 stsp .Cm histedit
1857 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1858 6e54d307 2020-02-24 stsp .Cm got update -b
1859 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1860 6e54d307 2020-02-24 stsp current branch of the work tree.
1861 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1862 6e54d307 2020-02-24 stsp touched by the
1863 6e54d307 2020-02-24 stsp .Cm histedit
1864 6e54d307 2020-02-24 stsp operation.
1866 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1867 6e54d307 2020-02-24 stsp must be set with
1868 6e54d307 2020-02-24 stsp .Cm got update -c
1869 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1870 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1872 6e54d307 2020-02-24 stsp .Cm histedit
1873 6e54d307 2020-02-24 stsp operation.
1875 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1876 0ebf8283 2019-07-24 stsp .Ar histedit script
1877 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1878 46fa4c83 2020-02-24 stsp command line, or generated with the
1884 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1885 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1886 0ebf8283 2019-07-24 stsp whitespace and an argument.
1887 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1888 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1889 0ebf8283 2019-07-24 stsp Lines which begin with the
1891 0ebf8283 2019-07-24 stsp character are ignored entirely.
1893 0ebf8283 2019-07-24 stsp The available commands are as follows:
1894 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1895 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1896 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1897 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1898 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1899 0ebf8283 2019-07-24 stsp listed further below that will be used.
1900 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1901 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1902 0ebf8283 2019-07-24 stsp the commit on the previous line.
1903 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1904 0ebf8283 2019-07-24 stsp log message can be written.
1907 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1908 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1909 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1911 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1912 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1913 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1914 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1915 498a90b7 2019-07-25 stsp switched to it.
1917 1795b260 2021-04-02 kn Old commits in their pre-histedit state are automatically backed up in the
1918 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
1919 e600f124 2021-03-21 stsp reference namespace.
1920 e600f124 2021-03-21 stsp As long as these references are not removed older versions of edited
1921 e600f124 2021-03-21 stsp commits will remain in the repository and can be viewed with the
1922 e600f124 2021-03-21 stsp .Cm got histedit -l
1924 e600f124 2021-03-21 stsp Removal of these references makes objects which become unreachable via
1925 e6786710 2021-07-03 stsp any reference subject to removal by Git's garbage collector or
1926 e6786710 2021-07-03 stsp .Cm gotadmin cleanup .
1928 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1929 0ebf8283 2019-07-24 stsp using the following status codes:
1930 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1931 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1932 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1933 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1934 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1935 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
1936 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1937 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1938 c90c8ce3 2020-07-23 stsp .It ? Ta changes destined for an unversioned file were not merged
1941 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1942 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1943 cd33da48 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
1944 cd33da48 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
1945 cd33da48 2021-09-28 stsp the histedit operation will be interrupted to prevent potentially incomplete
1946 cd33da48 2021-09-28 stsp changes from being committed to the repository without user intervention.
1947 cd33da48 2021-09-28 stsp The work tree may be modified as desired and the histedit operation can be
1948 cd33da48 2021-09-28 stsp continued once the changes present in the work tree are considered complete.
1949 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1950 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1952 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1953 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1954 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1956 0ebf8283 2019-07-24 stsp .Cm got histedit
1957 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1958 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1959 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1960 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1961 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1962 0ebf8283 2019-07-24 stsp to a single base commit with
1963 0ebf8283 2019-07-24 stsp .Cm got update .
1964 4ed9f614 2019-08-04 stsp If changes have been staged with
1965 4ed9f614 2019-08-04 stsp .Cm got stage ,
1966 bc3056e3 2019-08-18 stsp these changes must first be committed with
1967 4ed9f614 2019-08-04 stsp .Cm got commit
1968 4ed9f614 2019-08-04 stsp or unstaged with
1969 4ed9f614 2019-08-04 stsp .Cm got unstage .
1970 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1971 0ebf8283 2019-07-24 stsp committed with
1972 0ebf8283 2019-07-24 stsp .Cm got commit
1973 0ebf8283 2019-07-24 stsp or reverted with
1974 0ebf8283 2019-07-24 stsp .Cm got revert .
1975 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1976 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1979 7ef62c4e 2020-02-24 stsp .Cm got update ,
1980 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1982 65db4ffb 2020-02-24 stsp .Cm got integrate
1983 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1984 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1985 0ebf8283 2019-07-24 stsp .Cm got commit
1986 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1987 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1989 0ebf8283 2019-07-24 stsp The options for
1990 0ebf8283 2019-07-24 stsp .Cm got histedit
1991 0ebf8283 2019-07-24 stsp are as follows:
1992 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1994 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1995 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1997 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1998 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
2000 b93c7142 2021-10-01 stsp Interrupt the histedit operation for editing after merging each commit.
2001 b93c7142 2021-10-01 stsp This option is a quick equivalent to a histedit script which uses the
2003 b93c7142 2021-10-01 stsp command for all commits.
2006 b93c7142 2021-10-01 stsp option can only be used when starting a new histedit operation.
2007 b93c7142 2021-10-01 stsp If this option is used, no other command-line arguments are allowed.
2009 466785b9 2020-12-10 jrick Fold all commits into a single commit.
2010 466785b9 2020-12-10 jrick This option is a quick equivalent to a histedit script which folds all
2011 466785b9 2020-12-10 jrick commits, combining them all into one commit.
2014 2a78779e 2020-12-11 stsp option can only be used when starting a new histedit operation.
2015 466785b9 2020-12-10 jrick If this option is used, no other command-line arguments are allowed.
2016 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
2017 ddbfac99 2020-02-24 stsp Use the specified
2018 ddbfac99 2020-02-24 stsp .Ar histedit-script
2019 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
2020 ddbfac99 2020-02-24 stsp can be written.
2022 083957f4 2020-02-24 stsp Edit log messages only.
2023 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
2024 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
2027 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
2028 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
2030 e600f124 2021-03-21 stsp Show a list of past histedit operations, represented by references in the
2031 e600f124 2021-03-21 stsp .Dq refs/got/backup/histedit
2032 e600f124 2021-03-21 stsp reference namespace.
2034 e600f124 2021-03-21 stsp Display the author, date, and log message of each backed up commit,
2035 e600f124 2021-03-21 stsp the object ID of the corresponding post-histedit commit, and
2036 e600f124 2021-03-21 stsp the object ID of their common ancestor commit.
2037 e600f124 2021-03-21 stsp Given these object IDs,
2039 e600f124 2021-03-21 stsp .Cm got log
2040 e600f124 2021-03-21 stsp command with the
2044 e600f124 2021-03-21 stsp options can be used to examine the history of either version of the branch,
2046 e600f124 2021-03-21 stsp .Cm got branch
2047 e600f124 2021-03-21 stsp command with the
2049 e600f124 2021-03-21 stsp option can be used to create a new branch from a pre-histedit state if desired.
2052 e600f124 2021-03-21 stsp .Ar branch
2053 e600f124 2021-03-21 stsp is specified, only show commits which at some point in time represented this
2055 e600f124 2021-03-21 stsp Otherwise, list all backed up commits for any branches.
2057 e600f124 2021-03-21 stsp If this option is used,
2058 e600f124 2021-03-21 stsp .Cm got histedit
2059 e600f124 2021-03-21 stsp does not require a work tree.
2060 e600f124 2021-03-21 stsp None of the other options can be used together with
2063 643b85bc 2021-07-16 stsp Delete backups created by past histedit operations, represented by references
2065 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit
2066 643b85bc 2021-07-16 stsp reference namespace.
2069 643b85bc 2021-07-16 stsp .Ar branch
2070 643b85bc 2021-07-16 stsp is specified, only delete backups which at some point in time represented
2071 643b85bc 2021-07-16 stsp this branch.
2072 643b85bc 2021-07-16 stsp Otherwise, delete all references found within
2073 643b85bc 2021-07-16 stsp .Dq refs/got/backup/histedit .
2075 643b85bc 2021-07-16 stsp Any commit, tree, tag, and blob objects belonging to deleted backups
2076 643b85bc 2021-07-16 stsp remain in the repository and may be removed separately with
2077 643b85bc 2021-07-16 stsp Git's garbage collector or
2078 643b85bc 2021-07-16 stsp .Cm gotadmin cleanup .
2080 643b85bc 2021-07-16 stsp If this option is used,
2081 643b85bc 2021-07-16 stsp .Cm got histedit
2082 643b85bc 2021-07-16 stsp does not require a work tree.
2083 643b85bc 2021-07-16 stsp None of the other options can be used together with
2087 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
2088 95f394e8 2021-10-04 kn .Dl (alias: Cm ig )
2089 2822a352 2019-10-15 stsp Integrate the specified
2090 2822a352 2019-10-15 stsp .Ar branch
2091 2822a352 2019-10-15 stsp into the work tree's current branch.
2092 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
2093 2822a352 2019-10-15 stsp .Ar branch ,
2094 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
2095 2822a352 2019-10-15 stsp head commit of the integrated
2096 2822a352 2019-10-15 stsp .Ar branch .
2098 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
2099 2822a352 2019-10-15 stsp will be pointing at the same commit.
2100 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
2101 2822a352 2019-10-15 stsp In case the integrated
2102 2822a352 2019-10-15 stsp .Ar branch
2103 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
2104 2822a352 2019-10-15 stsp .Cm got branch -d .
2106 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
2107 2822a352 2019-10-15 stsp .Bl -column YXZ description
2108 2822a352 2019-10-15 stsp .It U Ta file was updated
2109 2822a352 2019-10-15 stsp .It D Ta file was deleted
2110 2822a352 2019-10-15 stsp .It A Ta new file was added
2111 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
2112 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
2115 2822a352 2019-10-15 stsp .Cm got integrate
2116 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
2117 2822a352 2019-10-15 stsp Most importantly, the
2118 2822a352 2019-10-15 stsp .Ar branch
2119 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
2120 2822a352 2019-10-15 stsp .Cm got rebase
2121 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
2122 2822a352 2019-10-15 stsp resolve merge conflicts.
2123 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
2124 2822a352 2019-10-15 stsp to a single base commit with
2125 2822a352 2019-10-15 stsp .Cm got update .
2126 2822a352 2019-10-15 stsp If changes have been staged with
2127 2822a352 2019-10-15 stsp .Cm got stage ,
2128 2822a352 2019-10-15 stsp these changes must first be committed with
2129 2822a352 2019-10-15 stsp .Cm got commit
2130 2822a352 2019-10-15 stsp or unstaged with
2131 2822a352 2019-10-15 stsp .Cm got unstage .
2132 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
2133 2822a352 2019-10-15 stsp committed with
2134 2822a352 2019-10-15 stsp .Cm got commit
2135 2822a352 2019-10-15 stsp or reverted with
2136 2822a352 2019-10-15 stsp .Cm got revert .
2137 088449d3 2021-09-26 stsp .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2138 f259c4c1 2021-09-24 stsp Create a merge commit based on the current branch of the work tree and
2139 f259c4c1 2021-09-24 stsp the specified
2140 f259c4c1 2021-09-24 stsp .Ar branch .
2141 f259c4c1 2021-09-24 stsp If a linear project history is desired, then use of
2142 f259c4c1 2021-09-24 stsp .Cm got rebase
2143 f259c4c1 2021-09-24 stsp should be preferred over
2144 f259c4c1 2021-09-24 stsp .Cm got merge .
2145 f259c4c1 2021-09-24 stsp However, even strictly linear projects may require merge commits in order
2146 4e91ef15 2021-09-26 stsp to merge in new versions of third-party code stored on vendor branches
2147 4e91ef15 2021-09-26 stsp created with
2148 4e91ef15 2021-09-26 stsp .Cm got import .
2150 f259c4c1 2021-09-24 stsp Merge commits are commits based on multiple parent commits.
2151 f259c4c1 2021-09-24 stsp The tip commit of the work tree's current branch, which must be set with
2152 f259c4c1 2021-09-24 stsp .Cm got update -b
2153 f259c4c1 2021-09-24 stsp before starting the
2155 f259c4c1 2021-09-24 stsp operation, will be used as the first parent.
2156 f259c4c1 2021-09-24 stsp The tip commit of the specified
2157 f259c4c1 2021-09-24 stsp .Ar branch
2158 f259c4c1 2021-09-24 stsp will be used as the second parent.
2160 4e91ef15 2021-09-26 stsp No ancestral relationship between the two branches is required.
2161 4e91ef15 2021-09-26 stsp If the two branches have already been merged previously, only new changes
2162 4e91ef15 2021-09-26 stsp will be merged.
2164 f259c4c1 2021-09-24 stsp It is not possible to create merge commits with more than two parents.
2165 f259c4c1 2021-09-24 stsp If more than one branch needs to be merged, then multiple merge commits
2166 f259c4c1 2021-09-24 stsp with two parents each can be created in sequence.
2168 f259c4c1 2021-09-24 stsp While merging changes found on the
2169 f259c4c1 2021-09-24 stsp .Ar branch
2170 f259c4c1 2021-09-24 stsp into the work tree, show the status of each affected file,
2171 f259c4c1 2021-09-24 stsp using the following status codes:
2172 f259c4c1 2021-09-24 stsp .Bl -column YXZ description
2173 f259c4c1 2021-09-24 stsp .It G Ta file was merged
2174 f259c4c1 2021-09-24 stsp .It C Ta file was merged and conflicts occurred during merge
2175 f259c4c1 2021-09-24 stsp .It ! Ta changes destined for a missing file were not merged
2176 f259c4c1 2021-09-24 stsp .It D Ta file was deleted
2177 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2178 f259c4c1 2021-09-24 stsp .It A Ta new file was added
2179 f259c4c1 2021-09-24 stsp .It \(a~ Ta changes destined for a non-regular file were not merged
2180 f259c4c1 2021-09-24 stsp .It ? Ta changes destined for an unversioned file were not merged
2183 f259c4c1 2021-09-24 stsp If merge conflicts occur, the merge operation is interrupted and conflicts
2184 f259c4c1 2021-09-24 stsp must be resolved before the merge operation can continue.
2185 606719cd 2021-09-28 stsp If any files with destined changes are found to be missing or unversioned,
2186 606719cd 2021-09-28 stsp or if files could not be deleted due to differences in deleted content,
2187 f259c4c1 2021-09-24 stsp the merge operation will be interrupted to prevent potentially incomplete
2188 f259c4c1 2021-09-24 stsp changes from being committed to the repository without user intervention.
2189 f259c4c1 2021-09-24 stsp The work tree may be modified as desired and the merge can be continued
2190 f259c4c1 2021-09-24 stsp once the changes present in the work tree are considered complete.
2191 f259c4c1 2021-09-24 stsp Alternatively, the merge operation may be aborted which will leave
2192 f259c4c1 2021-09-24 stsp the work tree's current branch unmodified.
2194 f259c4c1 2021-09-24 stsp If a merge conflict is resolved in a way which renders all merged
2195 f259c4c1 2021-09-24 stsp changes into no-op changes, the merge operation cannot continue
2196 f259c4c1 2021-09-24 stsp and must be aborted.
2198 f259c4c1 2021-09-24 stsp .Cm got merge
2199 f259c4c1 2021-09-24 stsp will refuse to run if certain preconditions are not met.
2200 f259c4c1 2021-09-24 stsp If history of the
2201 f259c4c1 2021-09-24 stsp .Ar branch
2202 f259c4c1 2021-09-24 stsp is based on the work tree's current branch, then no merge commit can
2203 f259c4c1 2021-09-24 stsp be created and
2204 f259c4c1 2021-09-24 stsp .Cm got integrate
2205 f259c4c1 2021-09-24 stsp may be used to integrate the
2206 f259c4c1 2021-09-24 stsp .Ar branch
2208 f259c4c1 2021-09-24 stsp If the work tree is not yet fully updated to the tip commit of its
2209 f259c4c1 2021-09-24 stsp branch, then the work tree must first be updated with
2210 f259c4c1 2021-09-24 stsp .Cm got update .
2211 f259c4c1 2021-09-24 stsp If the work tree contains multiple base commits it must first be updated
2212 f259c4c1 2021-09-24 stsp to a single base commit with
2213 f259c4c1 2021-09-24 stsp .Cm got update .
2214 f259c4c1 2021-09-24 stsp If changes have been staged with
2215 f259c4c1 2021-09-24 stsp .Cm got stage ,
2216 f259c4c1 2021-09-24 stsp these changes must first be committed with
2217 f259c4c1 2021-09-24 stsp .Cm got commit
2218 f259c4c1 2021-09-24 stsp or unstaged with
2219 f259c4c1 2021-09-24 stsp .Cm got unstage .
2220 f259c4c1 2021-09-24 stsp If the work tree contains local changes, these changes must first be
2221 f259c4c1 2021-09-24 stsp committed with
2222 f259c4c1 2021-09-24 stsp .Cm got commit
2223 f259c4c1 2021-09-24 stsp or reverted with
2224 f259c4c1 2021-09-24 stsp .Cm got revert .
2226 f259c4c1 2021-09-24 stsp .Ar branch
2227 f259c4c1 2021-09-24 stsp contains changes to files outside of the work tree's path prefix,
2228 f259c4c1 2021-09-24 stsp the work tree cannot be used to merge this branch.
2231 f259c4c1 2021-09-24 stsp .Cm got update ,
2232 f259c4c1 2021-09-24 stsp .Cm got commit ,
2233 f259c4c1 2021-09-24 stsp .Cm got rebase ,
2234 90e6e620 2021-10-04 kn .Cm got histedit ,
2235 f259c4c1 2021-09-24 stsp .Cm got integrate ,
2237 f259c4c1 2021-09-24 stsp .Cm got stage
2238 f259c4c1 2021-09-24 stsp commands will refuse to run while a merge operation is in progress.
2239 f259c4c1 2021-09-24 stsp Other commands which manipulate the work tree may be used for
2240 f259c4c1 2021-09-24 stsp conflict resolution purposes.
2242 f259c4c1 2021-09-24 stsp The options for
2243 f259c4c1 2021-09-24 stsp .Cm got merge
2244 f259c4c1 2021-09-24 stsp are as follows:
2245 f259c4c1 2021-09-24 stsp .Bl -tag -width Ds
2247 f259c4c1 2021-09-24 stsp Abort an interrupted merge operation.
2248 f259c4c1 2021-09-24 stsp If this option is used, no other command-line arguments are allowed.
2250 f259c4c1 2021-09-24 stsp Continue an interrupted merge operation.
2251 f259c4c1 2021-09-24 stsp If this option is used, no other command-line arguments are allowed.
2253 088449d3 2021-09-26 stsp Merge changes into the work tree as usual but do not create a merge
2254 088449d3 2021-09-26 stsp commit immediately.
2255 088449d3 2021-09-26 stsp The merge result can be adjusted as desired before a merge commit is
2256 088449d3 2021-09-26 stsp created with
2257 088449d3 2021-09-26 stsp .Cm got merge -c .
2258 088449d3 2021-09-26 stsp Alternatively, the merge may be aborted with
2259 088449d3 2021-09-26 stsp .Cm got merge -a .
2262 35213c7c 2020-07-23 stsp .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl S Oc Op Ar path ...
2263 95f394e8 2021-10-04 kn .Dl (alias: Cm sg )
2264 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
2267 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
2268 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
2269 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
2270 4ed9f614 2019-08-04 stsp .Cm got status .
2272 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2273 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
2274 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
2275 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
2276 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
2279 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
2280 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
2281 9d8b19a4 2019-08-04 stsp committed.
2283 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
2284 4ed9f614 2019-08-04 stsp .Cm got commit ,
2285 4ed9f614 2019-08-04 stsp .Cm got status ,
2287 4ed9f614 2019-08-04 stsp .Cm got diff .
2288 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
2289 4ed9f614 2019-08-04 stsp .Cm got commit
2290 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
2291 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
2292 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
2294 4ed9f614 2019-08-04 stsp .Cm got status
2295 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
2297 4ed9f614 2019-08-04 stsp .Cm got diff
2298 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
2299 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
2301 4ed9f614 2019-08-04 stsp .Cm got revert
2302 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
2303 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
2305 4ed9f614 2019-08-04 stsp The options for
2306 4ed9f614 2019-08-04 stsp .Cm got stage
2307 4ed9f614 2019-08-04 stsp are as follows:
2308 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
2310 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
2311 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
2312 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
2313 1dd86744 2019-08-12 anthony among the specified paths.
2314 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
2316 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
2317 dc424a06 2019-08-07 stsp select or reject changes for staging based on
2319 6d23ec10 2019-08-08 stsp (stage change),
2321 6d23ec10 2019-08-08 stsp (reject change), and
2323 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
2324 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
2325 dc424a06 2019-08-07 stsp modified file content can be staged.
2326 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
2327 6d23ec10 2019-08-08 stsp their entirety.
2328 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
2331 3a070a2b 2019-08-07 stsp option, read
2336 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
2337 0e2f5884 2019-08-07 stsp .Ar response-script
2338 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
2340 af358f55 2020-07-23 stsp Allow staging of symbolic links which point outside of the path space
2341 af358f55 2020-07-23 stsp that is under version control.
2342 af358f55 2020-07-23 stsp By default,
2343 af358f55 2020-07-23 stsp .Cm got stage
2344 af358f55 2020-07-23 stsp will reject such symbolic links due to safety concerns.
2345 35213c7c 2020-07-23 stsp As a precaution,
2347 af358f55 2020-07-23 stsp may decide to represent such a symbolic link as a regular file which contains
2348 af358f55 2020-07-23 stsp the link's target path, rather than creating an actual symbolic link which
2349 af358f55 2020-07-23 stsp points outside of the work tree.
2350 af358f55 2020-07-23 stsp Use of this option is discouraged because external mechanisms such as
2351 af358f55 2020-07-23 stsp .Dq make obj
2352 af358f55 2020-07-23 stsp are better suited for managing symbolic links to paths not under
2353 af358f55 2020-07-23 stsp version control.
2356 4ed9f614 2019-08-04 stsp .Cm got stage
2357 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
2358 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
2359 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
2360 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
2361 4ed9f614 2019-08-04 stsp .Cm got update
2362 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
2363 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
2366 4ed9f614 2019-08-04 stsp .Cm got update ,
2367 4ed9f614 2019-08-04 stsp .Cm got rebase ,
2369 4ed9f614 2019-08-04 stsp .Cm got histedit
2370 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
2371 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
2372 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
2373 4ed9f614 2019-08-04 stsp .Cm got unstage
2374 4ed9f614 2019-08-04 stsp before it can be updated with
2375 4ed9f614 2019-08-04 stsp .Cm got update ,
2376 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
2378 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2379 95f394e8 2021-10-04 kn .Dl (alias: Cm ug )
2380 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
2381 4ed9f614 2019-08-04 stsp back into non-staged status.
2384 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
2385 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
2387 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
2388 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
2389 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
2390 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
2391 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
2392 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
2393 f365d762 2021-09-24 stsp .It d Ta file's deletion was prevented by local modifications
2394 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
2397 2e1f37b0 2019-08-08 stsp The options for
2398 2e1f37b0 2019-08-08 stsp .Cm got unstage
2399 2e1f37b0 2019-08-08 stsp are as follows:
2400 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
2402 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
2403 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
2405 2e1f37b0 2019-08-08 stsp (unstage change),
2407 2e1f37b0 2019-08-08 stsp (keep change staged), and
2409 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
2410 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
2411 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
2412 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
2413 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
2416 2e1f37b0 2019-08-08 stsp option, read
2421 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
2422 2e1f37b0 2019-08-08 stsp .Ar response-script
2423 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
2425 5be72254 2019-08-26 stsp .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2426 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
2427 896e9b6f 2019-08-26 stsp text format.
2428 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
2429 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
2430 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
2432 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
2433 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
2434 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
2435 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
2436 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2437 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
2439 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
2441 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
2442 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
2444 01073a5d 2019-08-22 stsp The options for
2445 01073a5d 2019-08-22 stsp .Cm got cat
2446 01073a5d 2019-08-22 stsp are as follows:
2447 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
2448 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
2449 896e9b6f 2019-08-26 stsp Look up paths in the specified
2450 896e9b6f 2019-08-26 stsp .Ar commit .
2451 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
2452 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
2453 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
2454 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
2455 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
2456 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
2457 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
2458 01073a5d 2019-08-22 stsp Use the repository at the specified path.
2459 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
2460 01073a5d 2019-08-22 stsp working directory.
2461 01073a5d 2019-08-22 stsp If this directory is a
2463 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
2465 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
2466 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
2467 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
2469 b2118c49 2020-07-28 stsp .It Cm info Op Ar path ...
2470 b2118c49 2020-07-28 stsp Display meta-data stored in a work tree.
2472 b2118c49 2020-07-28 stsp .Xr got-worktree 5
2473 b2118c49 2020-07-28 stsp for details.
2475 b2118c49 2020-07-28 stsp The work tree to use is resolved implicitly by walking upwards from the
2476 b2118c49 2020-07-28 stsp current working directory.
2478 b2118c49 2020-07-28 stsp If one or more
2480 b2118c49 2020-07-28 stsp arguments are specified, show additional per-file information for tracked
2481 b2118c49 2020-07-28 stsp files located at or within these paths.
2484 b2118c49 2020-07-28 stsp argument corresponds to the work tree's root directory, display information
2485 b2118c49 2020-07-28 stsp for all tracked files.
2487 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
2488 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
2489 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
2490 74416c47 2019-05-09 stsp The author's name and email address for
2491 21a44f98 2019-07-15 stsp .Cm got commit
2493 21a44f98 2019-07-15 stsp .Cm got import ,
2494 74416c47 2019-05-09 stsp for example:
2495 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2498 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
2500 84792843 2019-08-09 stsp attempts to reject
2501 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
2502 84792843 2019-08-09 stsp environment variables with a missing email address.
2504 93a300b2 2021-08-26 stsp .Ev GOT_AUTHOR will be overridden by configuration settings in
2505 50b0790e 2020-09-11 stsp .Xr got.conf 5
2506 50b0790e 2020-09-11 stsp or by Git's
2507 aba9c984 2019-09-08 stsp .Dv user.name
2509 709ae9eb 2019-09-08 stsp .Dv user.email
2510 709ae9eb 2019-09-08 stsp configuration settings in the repository's
2511 aba9c984 2019-09-08 stsp .Pa .git/config
2514 c9956ddf 2019-09-08 stsp .Dv user.name
2516 c9956ddf 2019-09-08 stsp .Dv user.email
2517 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
2518 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
2519 257add31 2020-09-09 stsp configuration file will only be used if neither
2520 257add31 2020-09-09 stsp .Xr got.conf 5
2522 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
2523 257add31 2020-09-09 stsp environment variable provide author information.
2524 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
2525 23594da9 2019-05-13 stsp The editor spawned by
2526 8e7bd50a 2019-08-22 stsp .Cm got commit ,
2527 46215d2a 2020-09-11 stsp .Cm got histedit ,
2528 8e7bd50a 2019-08-22 stsp .Cm got import ,
2530 8e7bd50a 2019-08-22 stsp .Cm got tag .
2531 5b735925 2020-09-15 stsp If not set, the
2533 5b735925 2020-09-15 stsp text editor will be spawned in order to give
2535 5b735925 2020-09-15 stsp the attention it deserves.
2536 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
2537 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
2538 b1ebc001 2019-08-13 stsp .Cm got log .
2539 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
2540 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
2543 257add31 2020-09-09 stsp .Bl -tag -width packed-refs -compact
2544 257add31 2020-09-09 stsp .It Pa got.conf
2545 257add31 2020-09-09 stsp Repository-wide configuration settings for
2547 50b0790e 2020-09-11 stsp If present, a
2548 50b0790e 2020-09-11 stsp .Xr got.conf 5
2549 50b0790e 2020-09-11 stsp configuration file located in the root directory of a Git repository
2550 50b0790e 2020-09-11 stsp supersedes any relevant settings in Git's
2551 257add31 2020-09-09 stsp .Pa config
2554 50b0790e 2020-09-11 stsp .It Pa .got/got.conf
2555 50b0790e 2020-09-11 stsp Worktree-specific configuration settings for
2557 50b0790e 2020-09-11 stsp If present, a
2558 1795b260 2021-04-02 kn .Xr got.conf 5
2559 50b0790e 2020-09-11 stsp configuration file in the
2561 50b0790e 2020-09-11 stsp meta-data directory of a work tree supersedes any relevant settings in
2562 50b0790e 2020-09-11 stsp the repository's
2563 50b0790e 2020-09-11 stsp .Xr got.conf 5
2564 50b0790e 2020-09-11 stsp configuration file and Git's
2565 50b0790e 2020-09-11 stsp .Pa config
2568 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
2569 5c860e29 2018-03-12 stsp .Ex -std got
2570 97925469 2018-03-17 stsp .Sh EXAMPLES
2571 43e4eb1b 2021-08-29 stsp Enable tab-completion of
2573 43e4eb1b 2021-08-29 stsp command names in
2574 43e4eb1b 2021-08-29 stsp .Xr ksh 1 :
2576 e1d27370 2021-09-01 stsp .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2578 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
2581 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
2582 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
2584 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
2585 fa6e0e48 2019-05-23 stsp .Xr git 1 :
2587 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
2588 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
2590 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
2592 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
2593 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
2594 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
2596 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
2597 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2599 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
2601 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
2603 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
2605 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
2607 081470ac 2020-08-13 stsp In a work tree, display files in a potentially problematic state:
2609 081470ac 2020-08-13 stsp .Dl $ got status -s 'C!~?'
2611 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
2613 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
2615 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
2617 4e759de4 2019-06-26 stsp .Dl $ got branch -l
2619 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
2620 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
2621 d83d9d5c 2019-05-13 stsp which is forked off the
2622 d83d9d5c 2019-05-13 stsp .Dq master
2625 7b4f1fcb 2021-01-27 stsp .Dl $ got branch -c master unified-buffer-cache
2627 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
2628 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
2629 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
2631 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
2633 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
2634 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
2636 fa6e0e48 2019-05-23 stsp .Dl $ got commit
2638 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
2639 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
2640 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
2642 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
2644 3d0ac559 2020-04-18 stsp As above, but display changes in the order in which
2645 04e9dcf3 2020-04-18 stsp .Xr patch 1
2646 04e9dcf3 2020-04-18 stsp could apply them in sequence:
2648 04e9dcf3 2020-04-18 stsp .Dl $ got log -p -l 3 -R
2650 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
2652 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
2654 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
2655 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
2656 5b666081 2020-02-24 stsp .Pa sys/uvm :
2658 cf07f22b 2020-07-25 stsp .Dl $ cd sys/uvm && got log\ .
2660 5b666081 2020-02-24 stsp And this command has the same effect:
2662 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
2664 b2118c49 2020-07-28 stsp And this command displays work tree meta-data about all tracked files:
2666 b2118c49 2020-07-28 stsp .Dl $ cd /usr/src
2667 b2118c49 2020-07-28 stsp .Dl $ got info\ . | less
2669 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
2671 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
2672 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
2674 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
2675 e70c17ce 2019-05-22 stsp with a pre-defined log message.
2677 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
2679 bcbc2272 2020-05-20 stsp Alternatively, create a new commit from local changes in a work tree
2680 bcbc2272 2020-05-20 stsp directory with a log message that has been prepared in the file
2681 1795b260 2021-04-02 kn .Pa /tmp/msg :
2683 28cf319f 2021-01-28 stsp .Dl $ got commit -F /tmp/msg
2685 95fc3404 2019-07-15 stsp Update any work tree checked out from the
2686 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
2687 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
2689 95fc3404 2019-07-15 stsp .Dl $ got update
2691 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
2692 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
2693 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
2695 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2696 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
2697 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
2698 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
2700 a099809f 2021-08-27 stsp Fetch new changes on the remote repository's
2701 a099809f 2021-08-27 stsp .Dq master
2702 a099809f 2021-08-27 stsp branch, making them visible on the local repository's
2703 469dd726 2020-03-20 stsp .Dq origin/master
2706 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2707 469dd726 2020-03-20 stsp .Dl $ got fetch
2709 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
2710 469dd726 2020-03-20 stsp .Cm git clone --bare
2712 469dd726 2020-03-20 stsp .Xr git-fetch 1
2713 469dd726 2020-03-20 stsp command must be used instead:
2715 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
2716 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
2718 469dd726 2020-03-20 stsp Rebase the local
2719 469dd726 2020-03-20 stsp .Dq master
2720 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
2721 469dd726 2020-03-20 stsp .Dq origin/master
2724 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
2725 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
2726 469dd726 2020-03-20 stsp .Dl $ got rebase master
2728 fa6e0e48 2019-05-23 stsp Rebase the
2729 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
2730 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
2731 fa6e0e48 2019-05-23 stsp .Dq master
2734 818c7501 2019-07-11 stsp .Dl $ got update -b master
2735 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
2737 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
2738 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
2739 1dd86744 2019-08-12 anthony .Ox Ns 's
2740 1dd86744 2019-08-12 anthony CVS tree:
2742 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2744 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
2745 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
2748 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
2749 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
2750 0ebf8283 2019-07-24 stsp .Dl $ got histedit
2752 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
2753 469dd726 2020-03-20 stsp .Cm git clone --bare
2754 7848a0e1 2020-03-19 stsp instead of
2755 7848a0e1 2020-03-19 stsp .Cm got clone ,
2757 ff2cf171 2019-07-28 stsp .Dq refspec
2758 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
2760 ff2cf171 2019-07-28 stsp .Dq refs/remotes
2761 ff2cf171 2019-07-28 stsp namespace of the local repository.
2762 1795b260 2021-04-02 kn This can be achieved by setting Git's
2763 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
2764 ff2cf171 2019-07-28 stsp configuration variable to the value
2765 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
2767 ff2cf171 2019-07-28 stsp .Cm git config
2770 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2771 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2773 469dd726 2020-03-20 stsp Additionally, the
2774 469dd726 2020-03-20 stsp .Dq mirror
2775 469dd726 2020-03-20 stsp option must be disabled:
2777 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
2778 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
2780 ff2cf171 2019-07-28 stsp Alternatively, the following
2781 469dd726 2020-03-20 stsp .Xr git-fetch 1
2782 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
2783 ff2cf171 2019-07-28 stsp .Pa config
2786 91c82228 2021-04-18 stsp .Dl [remote \&"origin\&"]
2787 ff2cf171 2019-07-28 stsp .Dl url = ...
2788 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2789 469dd726 2020-03-20 stsp .Dl mirror = false
2791 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
2792 ff2cf171 2019-07-28 stsp .Dq refs/heads
2793 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
2794 ff2cf171 2019-07-28 stsp .Cm got checkout
2795 ff2cf171 2019-07-28 stsp and, if needed, created with
2796 ff2cf171 2019-07-28 stsp .Cm got branch .
2797 ff2cf171 2019-07-28 stsp Branches in the
2798 a099809f 2021-08-27 stsp .Dq refs/remotes/origin
2799 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
2800 ff2cf171 2019-07-28 stsp repository with
2801 469dd726 2020-03-20 stsp .Cm got fetch
2803 469dd726 2020-03-20 stsp .Xr git-fetch 1
2804 a099809f 2021-08-27 stsp without extra command line arguments.
2805 a099809f 2021-08-27 stsp Newly fetched changes can be examined with
2806 a099809f 2021-08-27 stsp .Cm got log .
2808 a099809f 2021-08-27 stsp Display changes on the remote repository's version of the
2809 ff2cf171 2019-07-28 stsp .Dq master
2810 a099809f 2021-08-27 stsp branch, as of the last time
2811 a099809f 2021-08-27 stsp .Cm got fetch
2814 a099809f 2021-08-27 stsp .Dl $ got log -c origin/master | less
2816 a099809f 2021-08-27 stsp As shown here, most commands accept abbreviated reference names such as
2817 ff2cf171 2019-07-28 stsp .Dq origin/master
2818 a099809f 2021-08-27 stsp instead of
2819 a099809f 2021-08-27 stsp .Dq refs/remotes/origin/master .
2820 a099809f 2021-08-27 stsp The latter is only needed in case of ambiguity.
2822 a099809f 2021-08-27 stsp .Cm got rebase
2823 a099809f 2021-08-27 stsp must be used to merge changes which are visible on the
2824 a099809f 2021-08-27 stsp .Dq origin/master
2825 a099809f 2021-08-27 stsp branch into the
2826 a099809f 2021-08-27 stsp .Dq master
2828 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
2830 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
2831 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
2833 a099809f 2021-08-27 stsp In order to make changes committed to the
2834 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2835 a099809f 2021-08-27 stsp visible on the
2836 a099809f 2021-08-27 stsp .Dq master
2837 a099809f 2021-08-27 stsp branch, the
2838 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2839 a099809f 2021-08-27 stsp branch must first be rebased onto the
2840 a099809f 2021-08-27 stsp .Dq master
2843 a099809f 2021-08-27 stsp .Dl $ got update -b master
2844 a099809f 2021-08-27 stsp .Dl $ got rebase unified-buffer-cache
2846 a099809f 2021-08-27 stsp Changes on the
2847 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2848 a099809f 2021-08-27 stsp branch can now be made visible on the
2849 a099809f 2021-08-27 stsp .Dq master
2850 a099809f 2021-08-27 stsp branch with
2851 a099809f 2021-08-27 stsp .Cm got integrate .
2852 a099809f 2021-08-27 stsp Because the rebase operation switched the work tree to the
2853 a099809f 2021-08-27 stsp .Dq unified-buffer-cache
2854 a099809f 2021-08-27 stsp branch the work tree must be switched back to the
2855 a099809f 2021-08-27 stsp .Dq master
2856 a099809f 2021-08-27 stsp branch first:
2858 a099809f 2021-08-27 stsp .Dl $ got update -b master
2859 a099809f 2021-08-27 stsp .Dl $ got integrate unified-buffer-cache
2862 083957f4 2020-02-24 stsp .Dq master
2863 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
2865 083957f4 2020-02-24 stsp by other developers and any other important new information:
2867 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
2868 083957f4 2020-02-24 stsp .Dl $ got histedit -m
2870 a099809f 2021-08-27 stsp If the remote repository offers write access local changes on the
2871 ff2cf171 2019-07-28 stsp .Dq master
2872 a099809f 2021-08-27 stsp branch can be sent to the remote repository with
2873 90e6e620 2021-10-04 kn .Cm got send .
2875 a099809f 2021-08-27 stsp .Cm got send
2876 a099809f 2021-08-27 stsp can be run without further arguments.
2877 a099809f 2021-08-27 stsp The arguments shown here match defaults, provided the work tree's
2878 a099809f 2021-08-27 stsp current branch is the
2879 a099809f 2021-08-27 stsp .Dq master
2882 a099809f 2021-08-27 stsp .Dl $ got send -b master origin
2884 a099809f 2021-08-27 stsp If the remote repository requires the HTTPS protocol the
2885 a099809f 2021-08-27 stsp .Xr git-push 1
2886 a099809f 2021-08-27 stsp command must be used instead:
2888 a099809f 2021-08-27 stsp .Dl $ cd /var/git/src.git
2889 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
2890 5c860e29 2018-03-12 stsp .Sh SEE ALSO
2891 0a79feb1 2021-04-10 stsp .Xr gotadmin 1 ,
2892 2312fc47 2019-07-15 stsp .Xr tog 1 ,
2893 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
2894 257add31 2020-09-09 stsp .Xr got-worktree 5 ,
2895 257add31 2020-09-09 stsp .Xr got.conf 5
2896 1a208aaf 2018-04-01 stsp .Sh AUTHORS
2897 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
2898 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2899 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2900 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2901 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2903 cc63216e 2020-12-26 stsp is a work-in-progress and some features remain to be implemented.
2905 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2907 cc63216e 2020-12-26 stsp to perform some tasks.
2908 cc63216e 2020-12-26 stsp In particular:
2909 cc63216e 2020-12-26 stsp .Bl -bullet
2911 cc63216e 2020-12-26 stsp Reading from remote repositories over HTTP or HTTPS protocols requires
2912 cc63216e 2020-12-26 stsp .Xr git-clone 1
2914 cc63216e 2020-12-26 stsp .Xr git-fetch 1 .
2916 a099809f 2021-08-27 stsp Writing to remote repositories over HTTP or HTTPS protocols requires
2917 cc63216e 2020-12-26 stsp .Xr git-push 1 .
2919 fa161f0b 2021-09-28 stsp The creation of merge commits with more than two parent commits requires
2920 cc63216e 2020-12-26 stsp .Xr git-merge 1 .
2922 cc63216e 2020-12-26 stsp In situations where files or directories were moved around
2924 cc63216e 2020-12-26 stsp will not automatically merge changes to new locations and
2926 cc63216e 2020-12-26 stsp will usually produce better results.
