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 83cd27f8 2020-01-13 stsp .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 bc26cce8 2019-08-04 stsp Short alias for
79 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
80 3ce1b845 2019-07-15 stsp Create an initial commit in a repository from the file hierarchy
81 3ce1b845 2019-07-15 stsp within the specified
82 3ce1b845 2019-07-15 stsp .Ar directory .
83 3ce1b845 2019-07-15 stsp The created commit will not have any parent commits, i.e. it will be a
84 3ce1b845 2019-07-15 stsp root commit.
85 3ce1b845 2019-07-15 stsp Also create a new reference which provides a branch name for the newly
86 3ce1b845 2019-07-15 stsp created commit.
87 21a44f98 2019-07-15 stsp Show the path of each imported file to indicate progress.
90 21a44f98 2019-07-15 stsp .Cm got import
91 21a44f98 2019-07-15 stsp command requires the
92 21a44f98 2019-07-15 stsp .Ev GOT_AUTHOR
93 aba9c984 2019-09-08 stsp environment variable to be set,
94 aba9c984 2019-09-08 stsp unless Git's
95 aba9c984 2019-09-08 stsp .Dv user.name
97 709ae9eb 2019-09-08 stsp .Dv user.email
98 709ae9eb 2019-09-08 stsp configuration settings can be obtained from the repository's
99 aba9c984 2019-09-08 stsp .Pa .git/config
100 c9956ddf 2019-09-08 stsp file or from Git's global
101 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
102 c9956ddf 2019-09-08 stsp configuration file.
104 3ce1b845 2019-07-15 stsp The options for
105 3ce1b845 2019-07-15 stsp .Cm got import
106 3ce1b845 2019-07-15 stsp are as follows:
107 3ce1b845 2019-07-15 stsp .Bl -tag -width Ds
108 3ce1b845 2019-07-15 stsp .It Fl b Ar branch
109 3ce1b845 2019-07-15 stsp Create the specified
111 3ce1b845 2019-07-15 stsp instead of creating the default branch
113 3ce1b845 2019-07-15 stsp Use of this option is required if the
115 3ce1b845 2019-07-15 stsp branch already exists.
116 3ce1b845 2019-07-15 stsp .It Fl m Ar message
117 3ce1b845 2019-07-15 stsp Use the specified log message when creating the new commit.
118 3ce1b845 2019-07-15 stsp Without the
121 3ce1b845 2019-07-15 stsp .Cm got import
122 3ce1b845 2019-07-15 stsp opens a temporary file in an editor where a log message can be written.
123 3ce1b845 2019-07-15 stsp .It Fl r Ar repository-path
124 3ce1b845 2019-07-15 stsp Use the repository at the specified path.
125 3ce1b845 2019-07-15 stsp If not specified, assume the repository is located at or above the current
126 3ce1b845 2019-07-15 stsp working directory.
127 3ce1b845 2019-07-15 stsp .It Fl I Ar pattern
128 3ce1b845 2019-07-15 stsp Ignore files or directories with a name which matches the specified
129 3ce1b845 2019-07-15 stsp .Ar pattern .
130 3ce1b845 2019-07-15 stsp This option may be specified multiple times to build a list of ignore patterns.
132 3ce1b845 2019-07-15 stsp .Ar pattern
133 3ce1b845 2019-07-15 stsp follows the globbing rules documented in
134 3ce1b845 2019-07-15 stsp .Xr glob 7 .
137 bc26cce8 2019-08-04 stsp Short alias for
138 bc26cce8 2019-08-04 stsp .Cm import .
139 41b0de12 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 Ar repository-URL Op Ar directory
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
193 7848a0e1 2020-03-19 stsp file of the cloned repository to store the
194 7848a0e1 2020-03-19 stsp .Ar repository-url
195 7848a0e1 2020-03-19 stsp for future use by
196 7848a0e1 2020-03-19 stsp .Cm got fetch
198 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
200 2ab43947 2020-03-18 stsp The options for
201 2ab43947 2020-03-18 stsp .Cm got clone
202 2ab43947 2020-03-18 stsp are as follows:
203 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
205 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
206 1d4b192f 2020-03-21 stsp .Dq refs/heads/
207 1d4b192f 2020-03-21 stsp reference namespace.
208 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
209 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
210 4ba14133 2020-03-20 stsp Cannot be used together with the
213 4ba14133 2020-03-20 stsp .It Fl b Ar branch
214 4ba14133 2020-03-20 stsp Fetch the specified
216 1d4b192f 2020-03-21 stsp from the remote repository's
217 1d4b192f 2020-03-21 stsp .Dq refs/heads/
218 1d4b192f 2020-03-21 stsp reference namespace.
219 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
221 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
222 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
223 4ba14133 2020-03-20 stsp branch which was fetched.
224 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
225 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
226 4ba14133 2020-03-20 stsp Cannot be used together with the
230 41b0de12 2020-03-21 stsp List branches and tags available for cloning from the remote repository
231 41b0de12 2020-03-21 stsp and exit immediately.
232 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
235 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
236 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
237 469dd726 2020-03-20 stsp local changes as created by
238 469dd726 2020-03-20 stsp .Cm got commit .
240 469dd726 2020-03-20 stsp The repository's
242 469dd726 2020-03-20 stsp file will be set up with the
244 469dd726 2020-03-20 stsp option enabled, such that
245 469dd726 2020-03-20 stsp .Cm got fetch
247 469dd726 2020-03-20 stsp .Xr git-fetch 1
248 498ef124 2020-03-21 stsp will write incoming changes directly to local branches in the
249 469dd726 2020-03-20 stsp .Dq refs/heads/
250 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
251 469dd726 2020-03-20 stsp .Dq refs/remotes/
253 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
254 469dd726 2020-03-20 stsp .Cm got rebase
256 469dd726 2020-03-20 stsp .Cm got fetch
257 498ef124 2020-03-21 stsp in order to make incoming changes appear on local branches.
258 498ef124 2020-03-21 stsp But maintaining local changes in the cloned repository becomes difficult
259 498ef124 2020-03-21 stsp since local changes will be at risk of being discarded whenever incoming
260 498ef124 2020-03-21 stsp changes are fetched.
262 2ab43947 2020-03-18 stsp Suppress progress reporting output.
263 2ab43947 2020-03-18 stsp The same option will be passed to
265 2ab43947 2020-03-18 stsp if applicable.
267 2690194b 2020-03-21 stsp Verbose mode.
269 2690194b 2020-03-21 stsp .Cm got clone
270 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
271 2690194b 2020-03-21 stsp This option will be passed to
273 2ab43947 2020-03-18 stsp if applicable.
274 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
275 2ab43947 2020-03-18 stsp The maximum is 3.
278 267fe567 2020-03-18 stsp Short alias for
279 267fe567 2020-03-18 stsp .Cm clone .
280 db6d8ad8 2020-03-21 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 Op Ar remote-repository
281 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
283 4ba14133 2020-03-20 stsp .Ar remote-repository
284 4ba14133 2020-03-20 stsp is specified,
286 7848a0e1 2020-03-19 stsp will be used.
287 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
289 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
290 7848a0e1 2020-03-19 stsp .Cm got clone .
292 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
293 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
294 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
296 498ef124 2020-03-21 stsp By default, branch references in the
297 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
298 498ef124 2020-03-21 stsp reference namespace will be updated to point at the newly fetched commits.
300 498ef124 2020-03-21 stsp .Cm got rebase
301 498ef124 2020-03-21 stsp command can then be used to make new changes visible on local branches in the
302 7848a0e1 2020-03-19 stsp .Dq refs/heads/
303 498ef124 2020-03-21 stsp namespace, merging incoming changes with local changes as necessary.
305 498ef124 2020-03-21 stsp If the repository was created as a mirror with
306 498ef124 2020-03-21 stsp .Cm got clone -m
307 498ef124 2020-03-21 stsp then all branches in the
308 469dd726 2020-03-20 stsp .Dq refs/heads/
309 498ef124 2020-03-21 stsp namespace will be updated directly to match the corresponding branches in
310 498ef124 2020-03-21 stsp the remote repository.
311 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
312 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
313 175367bd 2020-03-20 stsp by Git's garbage collector.
314 498ef124 2020-03-21 stsp Maintaining local changes in a mirror repository is therefore discouraged.
316 db6d8ad8 2020-03-21 stsp In any case, references in the
317 7848a0e1 2020-03-19 stsp .Dq refs/tags/
318 db6d8ad8 2020-03-21 stsp namespace will always be fetched and mapped directly to local references
319 db6d8ad8 2020-03-21 stsp in the same namespace.
321 7848a0e1 2020-03-19 stsp The options for
322 7848a0e1 2020-03-19 stsp .Cm got fetch
323 7848a0e1 2020-03-19 stsp are as follows:
324 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
326 1d4b192f 2020-03-21 stsp Fetch all branches from the remote repository's
327 1d4b192f 2020-03-21 stsp .Dq refs/heads/
328 1d4b192f 2020-03-21 stsp reference namespace.
329 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
330 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
331 4ba14133 2020-03-20 stsp Cannot be used together with the
334 4ba14133 2020-03-20 stsp .It Fl b Ar branch
335 4ba14133 2020-03-20 stsp Fetch the specified
337 1d4b192f 2020-03-21 stsp from the remote repository's
338 1d4b192f 2020-03-21 stsp .Dq refs/heads/
339 1d4b192f 2020-03-21 stsp reference namespace.
340 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
342 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
343 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
344 4ba14133 2020-03-20 stsp Cannot be used together with the
348 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
349 f21ec2f0 2020-03-21 stsp present in the remote repository.
350 f21ec2f0 2020-03-21 stsp Only references are deleted.
351 239821eb 2020-03-21 stsp Any commit, tree, tag, and blob objects belonging to deleted branches or
352 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
353 f21ec2f0 2020-03-21 stsp Git's garbage collector.
355 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
356 41b0de12 2020-03-21 stsp and exit immediately.
357 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
362 db6d8ad8 2020-03-21 stsp Allow existing references in the
363 db6d8ad8 2020-03-21 stsp .Dq refs/tags
364 db6d8ad8 2020-03-21 stsp namespace to be updated if they have changed on the server.
365 db6d8ad8 2020-03-21 stsp If not specified, only new tag references will be created.
366 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
367 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
368 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
369 7848a0e1 2020-03-19 stsp working directory.
370 7848a0e1 2020-03-19 stsp If this directory is a
372 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
374 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
375 7848a0e1 2020-03-19 stsp The same option will be passed to
377 7848a0e1 2020-03-19 stsp if applicable.
379 2690194b 2020-03-21 stsp Verbose mode.
381 2690194b 2020-03-21 stsp .Cm got fetch
382 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
383 7848a0e1 2020-03-19 stsp The same option will be passed to
385 7848a0e1 2020-03-19 stsp if applicable.
386 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
387 7848a0e1 2020-03-19 stsp The maximum is 3.
390 7848a0e1 2020-03-19 stsp Short alias for
391 7848a0e1 2020-03-19 stsp .Cm fetch .
392 74daf7cb 2020-01-27 stsp .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 Ar repository-path Op Ar work-tree-path
393 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
394 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
395 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
396 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
397 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
401 5d7c1dab 2018-04-01 stsp .Ar work tree path
402 c844a238 2019-02-06 stsp is not specified, either use the last component of
403 5d7c1dab 2018-04-01 stsp .Ar repository path ,
405 5d7c1dab 2018-04-01 stsp .Ar path prefix
406 c844a238 2019-02-06 stsp was specified use the last component of
407 5d7c1dab 2018-04-01 stsp .Ar path prefix .
409 38e11793 2018-06-13 stsp The options for
410 38e11793 2018-06-13 stsp .Cm got checkout
411 38e11793 2018-06-13 stsp are as follows:
412 38e11793 2018-06-13 stsp .Bl -tag -width Ds
414 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
415 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
416 bb51a5b4 2020-01-13 stsp is not empty.
417 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
418 08573d5b 2019-05-14 stsp .It Fl b Ar branch
419 3c575567 2019-07-28 stsp Check out files from a commit on the specified
420 08573d5b 2019-05-14 stsp .Ar branch .
421 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
422 08573d5b 2019-05-14 stsp reference will be used.
423 8069f636 2019-01-12 stsp .It Fl c Ar commit
424 8069f636 2019-01-12 stsp Check out files from the specified
426 3c575567 2019-07-28 stsp on the selected branch.
427 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
428 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
429 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
430 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
431 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
432 08573d5b 2019-05-14 stsp branch will be used.
434 4b6c9460 2020-03-05 stsp If the specified
436 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
437 4b6c9460 2020-03-05 stsp this commit must be specified with the
440 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
441 4b6c9460 2020-03-05 stsp commit with
442 4b6c9460 2020-03-05 stsp .Cm got branch
444 4b6c9460 2020-03-05 stsp .Cm got checkout
445 4b6c9460 2020-03-05 stsp can be used.
446 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
447 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
448 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
449 38e11793 2018-06-13 stsp Only files beneath the specified
450 38e11793 2018-06-13 stsp .Ar path-prefix
451 38e11793 2018-06-13 stsp will be checked out.
454 97b3a7be 2019-07-09 stsp Short alias for
455 97b3a7be 2019-07-09 stsp .Cm checkout .
456 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
457 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
458 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
459 7f838b36 2019-02-08 stsp .Bl -column YXZ description
460 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
461 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
462 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
463 7f838b36 2019-02-08 stsp .It D Ta file was deleted
464 7f838b36 2019-02-08 stsp .It A Ta new file was added
465 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
466 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
471 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
472 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
473 f2ea84fa 2019-07-27 stsp specified paths.
474 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
475 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
476 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
479 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
480 c4cdcb68 2019-04-03 stsp multiple base commits.
481 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
482 47ec7be7 2019-05-12 stsp .Cm got update
483 47ec7be7 2019-05-12 stsp across the entire work tree.
484 024e9686 2019-05-14 stsp Specifying a
486 024e9686 2019-05-14 stsp is incompatible with the
490 4ed9f614 2019-08-04 stsp .Cm got update
491 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
492 4ed9f614 2019-08-04 stsp If changes have been staged with
493 4ed9f614 2019-08-04 stsp .Cm got stage ,
494 bc3056e3 2019-08-18 stsp these changes must first be committed with
495 4ed9f614 2019-08-04 stsp .Cm got commit
496 4ed9f614 2019-08-04 stsp or unstaged with
497 4ed9f614 2019-08-04 stsp .Cm got unstage .
499 507dc3bb 2018-12-29 stsp The options for
500 507dc3bb 2018-12-29 stsp .Cm got update
501 507dc3bb 2018-12-29 stsp are as follows:
502 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
503 024e9686 2019-05-14 stsp .It Fl b Ar branch
504 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
506 024e9686 2019-05-14 stsp before updating the work tree.
507 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
508 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
509 507dc3bb 2018-12-29 stsp Update the work tree to the specified
510 507dc3bb 2018-12-29 stsp .Ar commit .
511 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
512 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
513 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
514 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
515 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
516 024e9686 2019-05-14 stsp branch will be used.
519 97b3a7be 2019-07-09 stsp Short alias for
520 97b3a7be 2019-07-09 stsp .Cm update .
521 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
522 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
523 6bad629b 2019-02-04 stsp using the following status codes:
524 6bad629b 2019-02-04 stsp .Bl -column YXZ description
525 6bad629b 2019-02-04 stsp .It M Ta modified file
526 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
527 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
528 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
529 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
530 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
531 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
533 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
534 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
536 2a06fe5f 2019-08-24 stsp specified on the command line
541 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
542 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
544 4ed9f614 2019-08-04 stsp If changes have been staged with
545 4ed9f614 2019-08-04 stsp .Cm got stage ,
546 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
547 4ed9f614 2019-08-04 stsp status codes:
548 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
549 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
550 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
551 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
554 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
555 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
556 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
557 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
560 6841da00 2019-08-08 stsp For compatibility with
563 bd8de430 2019-10-04 stsp .Xr git 1 ,
564 6841da00 2019-08-08 stsp .Cm got status
567 bd8de430 2019-10-04 stsp patterns from
568 6841da00 2019-08-08 stsp .Pa .cvsignore
570 bd8de430 2019-10-04 stsp .Pa .gitignore
571 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
572 bd8de430 2019-10-04 stsp which match these patterns.
573 bd8de430 2019-10-04 stsp As an extension to
575 bd8de430 2019-10-04 stsp matching rules,
576 bd8de430 2019-10-04 stsp .Cm got status
577 bd8de430 2019-10-04 stsp supports consecutive asterisks,
579 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
581 6841da00 2019-08-08 stsp .Xr cvs 1 ,
582 6841da00 2019-08-08 stsp .Cm got status
583 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
585 bd8de430 2019-10-04 stsp .Xr git 1 ,
586 bd8de430 2019-10-04 stsp .Cm got status
587 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
589 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
591 bd8de430 2019-10-04 stsp in a pattern.
593 97b3a7be 2019-07-09 stsp Short alias for
594 97b3a7be 2019-07-09 stsp .Cm status .
595 48c8c60d 2020-01-27 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 s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Op Ar path
596 38e11793 2018-06-13 stsp Display history of a repository.
599 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
600 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
602 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
603 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
604 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
606 38e11793 2018-06-13 stsp The options for
607 38e11793 2018-06-13 stsp .Cm got log
608 38e11793 2018-06-13 stsp are as follows:
609 38e11793 2018-06-13 stsp .Bl -tag -width Ds
611 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
612 1137e0ae 2020-01-27 stsp from other branches.
613 48c8c60d 2020-01-27 stsp By default,
614 48c8c60d 2020-01-27 stsp .Cm got log
615 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
616 38e11793 2018-06-13 stsp .It Fl c Ar commit
617 38e11793 2018-06-13 stsp Start traversing history at the specified
618 38e11793 2018-06-13 stsp .Ar commit .
619 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
620 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
621 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
622 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
623 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
624 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
625 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
626 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
628 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
629 6238ee32 2018-06-13 stsp .It Fl l Ar N
630 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
631 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
632 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
634 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
635 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
637 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
640 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
641 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
642 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
643 6841bf13 2019-11-29 kn regular expression
644 6841bf13 2019-11-29 kn .Ar search-pattern .
645 6841bf13 2019-11-29 kn Regular expression syntax is documented in
646 6841bf13 2019-11-29 kn .Xr re_format 7 .
647 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
648 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
649 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
650 04ca23f4 2018-07-16 stsp working directory.
651 e9cf2e30 2019-02-05 stsp If this directory is a
653 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
655 63035f9f 2019-10-06 stsp .It Cm diff 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
656 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
657 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
660 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
662 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
663 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
664 d24820bf 2019-08-11 stsp corresponding objects.
665 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
666 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
667 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
669 c0cc5c62 2018-10-18 stsp The options for
670 c0cc5c62 2018-10-18 stsp .Cm got diff
671 c0cc5c62 2018-10-18 stsp are as follows:
672 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
673 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
674 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
675 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
676 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
677 b72f483a 2019-02-05 stsp Use the repository at the specified path.
678 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
679 b72f483a 2019-02-05 stsp working directory.
680 b72f483a 2019-02-05 stsp If this directory is a
682 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
684 4ed9f614 2019-08-04 stsp Show changes staged with
685 4ed9f614 2019-08-04 stsp .Cm got stage
686 4ed9f614 2019-08-04 stsp instead of showing local changes.
687 4ed9f614 2019-08-04 stsp This option is only valid when
688 4ed9f614 2019-08-04 stsp .Cm got diff
689 4ed9f614 2019-08-04 stsp is invoked in a work tree.
691 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
694 bc26cce8 2019-08-04 stsp Short alias for
696 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
697 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
699 1ff8e573 2018-08-02 stsp The options for
700 1ff8e573 2018-08-02 stsp .Cm got blame
701 1ff8e573 2018-08-02 stsp are as follows:
702 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
703 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
704 1ff8e573 2018-08-02 stsp Start traversing history at the specified
705 1ff8e573 2018-08-02 stsp .Ar commit .
706 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
707 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
708 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
709 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
710 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
711 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
712 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
713 1ff8e573 2018-08-02 stsp working directory.
714 0c06baac 2019-02-05 stsp If this directory is a
716 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
719 bc26cce8 2019-08-04 stsp Short alias for
720 bc26cce8 2019-08-04 stsp .Cm blame .
721 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
722 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
723 5de5890b 2018-10-18 stsp directory path in the repository.
724 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
725 db0c2996 2019-02-10 stsp annotations:
726 db0c2996 2019-02-10 stsp .Bl -column YXZ description
727 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
728 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
729 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
730 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
735 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
736 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
737 0c849583 2019-02-05 stsp if there is no work tree.
739 5de5890b 2018-10-18 stsp The options for
740 5de5890b 2018-10-18 stsp .Cm got tree
741 5de5890b 2018-10-18 stsp are as follows:
742 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
743 5de5890b 2018-10-18 stsp .It Fl c Ar commit
744 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
745 5de5890b 2018-10-18 stsp .Ar commit .
746 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
747 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
748 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
749 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
750 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
751 5de5890b 2018-10-18 stsp Use the repository at the specified path.
752 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
753 5de5890b 2018-10-18 stsp working directory.
754 0c849583 2019-02-05 stsp If this directory is a
756 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
758 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
760 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
763 bc26cce8 2019-08-04 stsp Short alias for
765 c55aa27e 2019-08-12 stsp .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl s Oc Op Ar name Ar target
766 d0eebce4 2019-03-11 stsp Manage references in a repository.
768 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
769 d0eebce4 2019-03-11 stsp or update, the reference with the given
771 d0eebce4 2019-03-11 stsp and make it point at the given
772 d83d9d5c 2019-05-13 stsp .Ar target .
773 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
774 f16e4044 2019-10-09 stsp .Dq refs/ .
775 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
776 a54b6686 2019-06-28 stsp will be resolved to an object ID.
777 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
778 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
780 d0eebce4 2019-03-11 stsp The options for
781 d0eebce4 2019-03-11 stsp .Cm got ref
782 d0eebce4 2019-03-11 stsp are as follows:
783 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
784 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
785 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
786 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
787 d0eebce4 2019-03-11 stsp working directory.
788 d0eebce4 2019-03-11 stsp If this directory is a
790 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
792 d0eebce4 2019-03-11 stsp List all existing references in the repository.
793 d0eebce4 2019-03-11 stsp .It Fl d Ar name
794 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
796 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
797 d1c1ae5f 2019-08-12 stsp .Ar target ,
798 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
799 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
800 d1c1ae5f 2019-08-12 stsp this option is used.
802 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
803 da76fce2 2020-02-24 stsp Create, list, or delete branches.
805 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
806 4e759de4 2019-06-26 stsp .Dq refs/heads/
807 4e759de4 2019-06-26 stsp reference namespace.
809 4e759de4 2019-06-26 stsp .Cm got branch
810 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
812 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
813 ad89fa31 2019-10-04 stsp work tree's current branch.
817 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
818 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
819 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
820 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
822 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
823 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
824 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
825 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
827 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
828 da76fce2 2020-02-24 stsp .Bl -column YXZ description
829 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
830 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
831 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
832 da76fce2 2020-02-24 stsp .It D Ta file was deleted
833 da76fce2 2020-02-24 stsp .It A Ta new file was added
834 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
835 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
838 4e759de4 2019-06-26 stsp The options for
839 4e759de4 2019-06-26 stsp .Cm got branch
840 4e759de4 2019-06-26 stsp are as follows:
841 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
842 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
843 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
844 a74f7e83 2019-11-10 stsp .Ar commit .
845 a74f7e83 2019-11-10 stsp The expected
847 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
848 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
849 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
850 4e759de4 2019-06-26 stsp Use the repository at the specified path.
851 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
852 4e759de4 2019-06-26 stsp working directory.
853 4e759de4 2019-06-26 stsp If this directory is a
855 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
857 4e759de4 2019-06-26 stsp List all existing branches in the repository.
858 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
859 ba882ee3 2019-07-11 stsp with one the following annotations:
860 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
861 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
862 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
864 4e759de4 2019-06-26 stsp .It Fl d Ar name
865 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
866 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
867 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
868 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
869 ce33d90e 2019-07-14 stsp Git's garbage collector.
871 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
874 97b3a7be 2019-07-09 stsp Short alias for
875 97b3a7be 2019-07-09 stsp .Cm branch .
876 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
877 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
879 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
880 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
881 8e7bd50a 2019-08-22 stsp reference namespace.
883 8e7bd50a 2019-08-22 stsp .Cm got tag
884 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
885 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
886 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
888 80106605 2020-02-24 stsp Attempt to create a tag with the given
890 8e7bd50a 2019-08-22 stsp and make this tag point at the given
891 8e7bd50a 2019-08-22 stsp .Ar commit .
892 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
893 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
894 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
896 8e7bd50a 2019-08-22 stsp The options for
897 8e7bd50a 2019-08-22 stsp .Cm got tag
898 8e7bd50a 2019-08-22 stsp are as follows:
899 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
900 80106605 2020-02-24 stsp .It Fl c Ar commit
901 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
902 80106605 2020-02-24 stsp .Ar commit .
903 80106605 2020-02-24 stsp The expected
905 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
906 80106605 2020-02-24 stsp will be resolved to a commit ID.
907 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
908 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
909 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
910 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
911 8e7bd50a 2019-08-22 stsp Without the
914 3a62228f 2019-11-08 stsp .Cm got tag
915 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
916 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
917 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
918 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
919 8e7bd50a 2019-08-22 stsp working directory.
920 8e7bd50a 2019-08-22 stsp If this directory is a
922 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
924 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
925 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
928 8e7bd50a 2019-08-22 stsp By design, the
929 8e7bd50a 2019-08-22 stsp .Cm got tag
930 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
931 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
932 8e7bd50a 2019-08-22 stsp .Cm got ref
933 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
934 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
935 8e7bd50a 2019-08-22 stsp another repository.
936 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
937 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
938 d00136be 2019-03-26 stsp repository in the next commit.
940 4e68cba3 2019-11-23 stsp The options for
941 4e68cba3 2019-11-23 stsp .Cm got add
942 4e68cba3 2019-11-23 stsp are as follows:
943 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
945 4e68cba3 2019-11-23 stsp Permit recursion into directories.
946 4e68cba3 2019-11-23 stsp If this option is not specified,
947 4e68cba3 2019-11-23 stsp .Cm got add
948 4e68cba3 2019-11-23 stsp will refuse to run if a specified
950 4e68cba3 2019-11-23 stsp is a directory.
952 022fae89 2019-12-06 tracey With -R, add files even if they match a
953 022fae89 2019-12-06 tracey .Cm got status
954 022fae89 2019-12-06 tracey ignore pattern.
956 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
957 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
958 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
960 2ec1f75b 2019-03-26 stsp The options for
961 86d25a1b 2019-07-11 stsp .Cm got remove
962 2ec1f75b 2019-03-26 stsp are as follows:
963 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
965 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
967 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
969 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
970 f2a9dc41 2019-12-13 tracey If this option is not specified,
971 f2a9dc41 2019-12-13 tracey .Cm got remove
972 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
974 f2a9dc41 2019-12-13 tracey is a directory.
977 648e4ef7 2019-07-09 stsp Short alias for
978 648e4ef7 2019-07-09 stsp .Cm remove .
979 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 ...
980 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
981 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
982 1dd86744 2019-08-12 anthony work tree's base commit.
983 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
984 a129376b 2019-03-28 stsp .Cm got revert !
986 e20a8b6f 2019-06-04 stsp If a file was added with
987 a129376b 2019-03-28 stsp .Cm got add
988 a129376b 2019-03-28 stsp it will become an unversioned file again.
989 e20a8b6f 2019-06-04 stsp If a file was deleted with
990 86d25a1b 2019-07-11 stsp .Cm got remove
991 a129376b 2019-03-28 stsp it will be restored.
993 0f6d7415 2019-08-08 stsp The options for
994 0f6d7415 2019-08-08 stsp .Cm got revert
995 0f6d7415 2019-08-08 stsp are as follows:
996 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
998 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
999 33aa809d 2019-08-08 stsp changes to revert based on
1001 33aa809d 2019-08-08 stsp (revert change),
1003 33aa809d 2019-08-08 stsp (keep change), and
1005 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
1006 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
1007 33aa809d 2019-08-08 stsp modified file content can be reverted.
1008 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
1009 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
1012 33aa809d 2019-08-08 stsp option, read
1017 33aa809d 2019-08-08 stsp responses line-by-line from the specified
1018 33aa809d 2019-08-08 stsp .Ar response-script
1019 33aa809d 2019-08-08 stsp file instead of prompting interactively.
1021 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1022 0f6d7415 2019-08-08 stsp If this option is not specified,
1023 0f6d7415 2019-08-08 stsp .Cm got revert
1024 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1026 0f6d7415 2019-08-08 stsp is a directory.
1029 97b3a7be 2019-07-09 stsp Short alias for
1030 97b3a7be 2019-07-09 stsp .Cm revert .
1031 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1032 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1033 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1036 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1037 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1039 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1040 1dd86744 2019-08-12 anthony .Cm got stage ,
1041 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1042 4ed9f614 2019-08-04 stsp have not been staged.
1044 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1045 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1046 15cd91f7 2019-05-12 stsp .It M Ta modified file
1047 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1048 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1049 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1052 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1053 996d5ccd 2019-08-05 stsp recorded base commit.
1056 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1057 15cd91f7 2019-05-12 stsp multiple base commits.
1058 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1059 47ec7be7 2019-05-12 stsp .Cm got update
1060 47ec7be7 2019-05-12 stsp across the entire work tree.
1063 15cd91f7 2019-05-12 stsp .Cm got commit
1064 15cd91f7 2019-05-12 stsp command requires the
1065 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1066 aba9c984 2019-09-08 stsp environment variable to be set,
1067 aba9c984 2019-09-08 stsp unless Git's
1068 aba9c984 2019-09-08 stsp .Dv user.name
1070 709ae9eb 2019-09-08 stsp .Dv user.email
1071 709ae9eb 2019-09-08 stsp configuration settings can be
1072 aba9c984 2019-09-08 stsp obtained from the repository's
1073 aba9c984 2019-09-08 stsp .Pa .git/config
1074 c9956ddf 2019-09-08 stsp file or from Git's global
1075 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1076 c9956ddf 2019-09-08 stsp configuration file.
1078 74416c47 2019-05-09 stsp The options for
1079 74416c47 2019-05-09 stsp .Cm got commit
1080 74416c47 2019-05-09 stsp are as follows:
1081 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1082 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1083 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1084 23594da9 2019-05-13 stsp Without the
1087 23594da9 2019-05-13 stsp .Cm got commit
1088 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1091 cfce0458 2019-07-28 stsp .Cm got commit
1092 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1093 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1094 916f288c 2019-07-30 stsp .Dq refs/heads/
1095 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1096 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1097 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1098 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1099 cfce0458 2019-07-28 stsp .Cm got update
1100 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1101 cfce0458 2019-07-28 stsp in the repository.
1103 97b3a7be 2019-07-09 stsp Short alias for
1104 97b3a7be 2019-07-09 stsp .Cm commit .
1105 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1106 234035bc 2019-06-01 stsp Merge changes from a single
1107 234035bc 2019-06-01 stsp .Ar commit
1108 234035bc 2019-06-01 stsp into the work tree.
1109 234035bc 2019-06-01 stsp The specified
1110 234035bc 2019-06-01 stsp .Ar commit
1111 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1112 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1113 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1114 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1116 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1117 234035bc 2019-06-01 stsp .Bl -column YXZ description
1118 234035bc 2019-06-01 stsp .It G Ta file was merged
1119 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1120 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1121 234035bc 2019-06-01 stsp .It D Ta file was deleted
1122 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1123 234035bc 2019-06-01 stsp .It A Ta new file was added
1124 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1127 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1128 234035bc 2019-06-01 stsp may be viewed with
1129 234035bc 2019-06-01 stsp .Cm got diff ,
1130 234035bc 2019-06-01 stsp amended manually or with further
1131 234035bc 2019-06-01 stsp .Cm got cherrypick
1133 234035bc 2019-06-01 stsp committed with
1134 234035bc 2019-06-01 stsp .Cm got commit ,
1135 234035bc 2019-06-01 stsp or discarded again with
1136 234035bc 2019-06-01 stsp .Cm got revert .
1138 234035bc 2019-06-01 stsp .Cm got cherrypick
1139 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1140 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1141 234035bc 2019-06-01 stsp to a single base commit with
1142 234035bc 2019-06-01 stsp .Cm got update .
1143 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1144 234035bc 2019-06-01 stsp conflicts must be resolved first.
1146 97b3a7be 2019-07-09 stsp Short alias for
1147 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1148 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1149 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1150 5ef14e63 2019-06-02 stsp .Ar commit
1151 5ef14e63 2019-06-02 stsp into the work tree.
1152 5ef14e63 2019-06-02 stsp The specified
1153 5ef14e63 2019-06-02 stsp .Ar commit
1154 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1155 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1156 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1157 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1159 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1160 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1161 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1162 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1163 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1164 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1165 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1166 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1167 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1170 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1171 5ef14e63 2019-06-02 stsp which may be viewed with
1172 5ef14e63 2019-06-02 stsp .Cm got diff ,
1173 5ef14e63 2019-06-02 stsp amended manually or with further
1174 778a73c2 2019-07-12 stsp .Cm got backout
1176 5ef14e63 2019-06-02 stsp committed with
1177 5ef14e63 2019-06-02 stsp .Cm got commit ,
1178 5ef14e63 2019-06-02 stsp or discarded again with
1179 5ef14e63 2019-06-02 stsp .Cm got revert .
1181 92228c38 2019-06-02 stsp .Cm got backout
1182 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1183 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1184 92228c38 2019-06-02 stsp to a single base commit with
1185 92228c38 2019-06-02 stsp .Cm got update .
1186 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1187 92228c38 2019-06-02 stsp conflicts must be resolved first.
1189 97b3a7be 2019-07-09 stsp Short alias for
1190 97b3a7be 2019-07-09 stsp .Cm backout .
1191 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1192 818c7501 2019-07-11 stsp Rebase commits on the specified
1193 818c7501 2019-07-11 stsp .Ar branch
1194 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1196 818c7501 2019-07-11 stsp .Ar branch
1197 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1198 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1199 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1200 818c7501 2019-07-11 stsp .Ar branch
1201 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1202 f09e2405 2019-07-11 stsp of the specified
1203 818c7501 2019-07-11 stsp .Ar branch
1204 f09e2405 2019-07-11 stsp has been rebased.
1207 2b6826ba 2020-02-24 stsp .Cm got rebase
1208 2b6826ba 2020-02-24 stsp is used as intended, the specified
1209 2b6826ba 2020-02-24 stsp .Ar branch
1210 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1211 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1212 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1213 2b6826ba 2020-02-24 stsp .Cm got update -b
1214 2b6826ba 2020-02-24 stsp before starting the
1215 2b6826ba 2020-02-24 stsp .Cm rebase
1216 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1217 2b6826ba 2020-02-24 stsp a common history with the specified
1218 2b6826ba 2020-02-24 stsp .Ar branch
1219 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1220 c10890ce 2020-02-25 stsp remote repository.
1222 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1223 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1224 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1225 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1226 818c7501 2019-07-11 stsp .Ar branch ,
1227 818c7501 2019-07-11 stsp but with different commit IDs.
1228 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1229 f09e2405 2019-07-11 stsp the new version of the specified
1230 818c7501 2019-07-11 stsp .Ar branch
1231 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1233 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1234 818c7501 2019-07-11 stsp using the following status codes:
1235 818c7501 2019-07-11 stsp .Bl -column YXZ description
1236 818c7501 2019-07-11 stsp .It G Ta file was merged
1237 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1238 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1239 818c7501 2019-07-11 stsp .It D Ta file was deleted
1240 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1241 818c7501 2019-07-11 stsp .It A Ta new file was added
1242 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1245 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1246 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1247 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1248 818c7501 2019-07-11 stsp .Ar branch
1249 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1251 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1252 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1253 f09e2405 2019-07-11 stsp when the rebase operation continues.
1255 818c7501 2019-07-11 stsp .Cm got rebase
1256 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1257 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1258 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1259 818c7501 2019-07-11 stsp .Cm got update .
1260 4ed9f614 2019-08-04 stsp If changes have been staged with
1261 4ed9f614 2019-08-04 stsp .Cm got stage ,
1262 bc3056e3 2019-08-18 stsp these changes must first be committed with
1263 4ed9f614 2019-08-04 stsp .Cm got commit
1264 4ed9f614 2019-08-04 stsp or unstaged with
1265 4ed9f614 2019-08-04 stsp .Cm got unstage .
1266 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1267 f09e2405 2019-07-11 stsp committed with
1268 f09e2405 2019-07-11 stsp .Cm got commit
1269 f09e2405 2019-07-11 stsp or reverted with
1270 f09e2405 2019-07-11 stsp .Cm got revert .
1272 64c6d990 2019-07-11 stsp .Ar branch
1273 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1274 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1277 7d5807f4 2019-07-11 stsp .Cm got update
1279 7d5807f4 2019-07-11 stsp .Cm got commit
1280 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1281 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1282 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1284 818c7501 2019-07-11 stsp The options for
1285 818c7501 2019-07-11 stsp .Cm got rebase
1286 818c7501 2019-07-11 stsp are as follows:
1287 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1289 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1290 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1292 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1293 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1296 818c7501 2019-07-11 stsp Short alias for
1297 818c7501 2019-07-11 stsp .Cm rebase .
1298 083957f4 2020-02-24 stsp .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1299 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1300 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1302 6e54d307 2020-02-24 stsp Before starting a
1303 6e54d307 2020-02-24 stsp .Cm histedit
1304 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1305 6e54d307 2020-02-24 stsp .Cm got update -b
1306 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1307 6e54d307 2020-02-24 stsp current branch of the work tree.
1308 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1309 6e54d307 2020-02-24 stsp touched by the
1310 6e54d307 2020-02-24 stsp .Cm histedit
1311 6e54d307 2020-02-24 stsp operation.
1313 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1314 6e54d307 2020-02-24 stsp must be set with
1315 6e54d307 2020-02-24 stsp .Cm got update -c
1316 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1317 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1319 6e54d307 2020-02-24 stsp .Cm histedit
1320 6e54d307 2020-02-24 stsp operation.
1322 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1323 0ebf8283 2019-07-24 stsp .Ar histedit script
1324 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1325 46fa4c83 2020-02-24 stsp command line, or generated with the
1327 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1329 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1330 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1331 0ebf8283 2019-07-24 stsp whitespace and an argument.
1332 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1333 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1334 0ebf8283 2019-07-24 stsp Lines which begin with the
1336 0ebf8283 2019-07-24 stsp character are ignored entirely.
1338 0ebf8283 2019-07-24 stsp The available commands are as follows:
1339 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1340 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1341 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1342 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1343 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1344 0ebf8283 2019-07-24 stsp listed further below that will be used.
1345 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1346 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1347 0ebf8283 2019-07-24 stsp the commit on the previous line.
1348 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1349 0ebf8283 2019-07-24 stsp log message can be written.
1352 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1353 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1354 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1356 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1357 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1358 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1359 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1360 498a90b7 2019-07-25 stsp switched to it.
1362 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1363 0ebf8283 2019-07-24 stsp using the following status codes:
1364 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1365 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1366 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1367 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1368 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1369 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1370 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1371 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1374 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1375 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1376 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1377 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1379 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1380 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1381 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1383 0ebf8283 2019-07-24 stsp .Cm got histedit
1384 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1385 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1386 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1387 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1388 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1389 0ebf8283 2019-07-24 stsp to a single base commit with
1390 0ebf8283 2019-07-24 stsp .Cm got update .
1391 4ed9f614 2019-08-04 stsp If changes have been staged with
1392 4ed9f614 2019-08-04 stsp .Cm got stage ,
1393 bc3056e3 2019-08-18 stsp these changes must first be committed with
1394 4ed9f614 2019-08-04 stsp .Cm got commit
1395 4ed9f614 2019-08-04 stsp or unstaged with
1396 4ed9f614 2019-08-04 stsp .Cm got unstage .
1397 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1398 0ebf8283 2019-07-24 stsp committed with
1399 0ebf8283 2019-07-24 stsp .Cm got commit
1400 0ebf8283 2019-07-24 stsp or reverted with
1401 0ebf8283 2019-07-24 stsp .Cm got revert .
1402 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1403 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1406 7ef62c4e 2020-02-24 stsp .Cm got update ,
1407 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1409 65db4ffb 2020-02-24 stsp .Cm got integrate
1410 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1411 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1412 0ebf8283 2019-07-24 stsp .Cm got commit
1413 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1414 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1416 0ebf8283 2019-07-24 stsp The options for
1417 0ebf8283 2019-07-24 stsp .Cm got histedit
1418 0ebf8283 2019-07-24 stsp are as follows:
1419 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1421 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1422 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1424 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1425 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1426 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1427 ddbfac99 2020-02-24 stsp Use the specified
1428 ddbfac99 2020-02-24 stsp .Ar histedit-script
1429 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1430 ddbfac99 2020-02-24 stsp can be written.
1432 083957f4 2020-02-24 stsp Edit log messages only.
1433 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1434 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1437 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1438 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1441 0ebf8283 2019-07-24 stsp Short alias for
1442 0ebf8283 2019-07-24 stsp .Cm histedit .
1443 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1444 2822a352 2019-10-15 stsp Integrate the specified
1445 2822a352 2019-10-15 stsp .Ar branch
1446 2822a352 2019-10-15 stsp into the work tree's current branch.
1447 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1448 2822a352 2019-10-15 stsp .Ar branch ,
1449 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1450 2822a352 2019-10-15 stsp head commit of the integrated
1451 2822a352 2019-10-15 stsp .Ar branch .
1453 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1454 2822a352 2019-10-15 stsp will be pointing at the same commit.
1455 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1456 2822a352 2019-10-15 stsp In case the integrated
1457 2822a352 2019-10-15 stsp .Ar branch
1458 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1459 2822a352 2019-10-15 stsp .Cm got branch -d .
1461 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1462 2822a352 2019-10-15 stsp .Bl -column YXZ description
1463 2822a352 2019-10-15 stsp .It U Ta file was updated
1464 2822a352 2019-10-15 stsp .It D Ta file was deleted
1465 2822a352 2019-10-15 stsp .It A Ta new file was added
1466 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1467 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1470 2822a352 2019-10-15 stsp .Cm got integrate
1471 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1472 2822a352 2019-10-15 stsp Most importantly, the
1473 2822a352 2019-10-15 stsp .Ar branch
1474 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1475 2822a352 2019-10-15 stsp .Cm got rebase
1476 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1477 2822a352 2019-10-15 stsp resolve merge conflicts.
1478 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1479 2822a352 2019-10-15 stsp to a single base commit with
1480 2822a352 2019-10-15 stsp .Cm got update .
1481 2822a352 2019-10-15 stsp If changes have been staged with
1482 2822a352 2019-10-15 stsp .Cm got stage ,
1483 2822a352 2019-10-15 stsp these changes must first be committed with
1484 2822a352 2019-10-15 stsp .Cm got commit
1485 2822a352 2019-10-15 stsp or unstaged with
1486 2822a352 2019-10-15 stsp .Cm got unstage .
1487 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1488 2822a352 2019-10-15 stsp committed with
1489 2822a352 2019-10-15 stsp .Cm got commit
1490 2822a352 2019-10-15 stsp or reverted with
1491 2822a352 2019-10-15 stsp .Cm got revert .
1493 2822a352 2019-10-15 stsp Short alias for
1494 2822a352 2019-10-15 stsp .Cm integrate .
1495 dfc23429 2019-08-11 stsp .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1496 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1499 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1500 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1501 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1502 4ed9f614 2019-08-04 stsp .Cm got status .
1504 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1505 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1506 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1507 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1508 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1511 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1512 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1513 9d8b19a4 2019-08-04 stsp committed.
1515 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1516 4ed9f614 2019-08-04 stsp .Cm got commit ,
1517 4ed9f614 2019-08-04 stsp .Cm got status ,
1519 4ed9f614 2019-08-04 stsp .Cm got diff .
1520 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1521 4ed9f614 2019-08-04 stsp .Cm got commit
1522 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1523 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1524 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1526 4ed9f614 2019-08-04 stsp .Cm got status
1527 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1529 4ed9f614 2019-08-04 stsp .Cm got diff
1530 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1531 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1533 4ed9f614 2019-08-04 stsp .Cm got revert
1534 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1535 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1537 4ed9f614 2019-08-04 stsp The options for
1538 4ed9f614 2019-08-04 stsp .Cm got stage
1539 4ed9f614 2019-08-04 stsp are as follows:
1540 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1542 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1543 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1544 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1545 1dd86744 2019-08-12 anthony among the specified paths.
1546 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1548 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1549 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1551 6d23ec10 2019-08-08 stsp (stage change),
1553 6d23ec10 2019-08-08 stsp (reject change), and
1555 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1556 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1557 dc424a06 2019-08-07 stsp modified file content can be staged.
1558 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1559 6d23ec10 2019-08-08 stsp their entirety.
1560 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1563 3a070a2b 2019-08-07 stsp option, read
1568 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1569 0e2f5884 2019-08-07 stsp .Ar response-script
1570 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1573 4ed9f614 2019-08-04 stsp .Cm got stage
1574 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1575 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1576 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1577 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1578 4ed9f614 2019-08-04 stsp .Cm got update
1579 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1580 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1583 4ed9f614 2019-08-04 stsp .Cm got update ,
1584 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1586 4ed9f614 2019-08-04 stsp .Cm got histedit
1587 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1588 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1589 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1590 4ed9f614 2019-08-04 stsp .Cm got unstage
1591 4ed9f614 2019-08-04 stsp before it can be updated with
1592 4ed9f614 2019-08-04 stsp .Cm got update ,
1593 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1595 4ed9f614 2019-08-04 stsp Short alias for
1596 4ed9f614 2019-08-04 stsp .Cm stage .
1597 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1598 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1599 4ed9f614 2019-08-04 stsp back into non-staged status.
1602 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1603 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1605 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1606 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1607 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1608 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1609 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1610 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1611 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1612 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1615 2e1f37b0 2019-08-08 stsp The options for
1616 2e1f37b0 2019-08-08 stsp .Cm got unstage
1617 2e1f37b0 2019-08-08 stsp are as follows:
1618 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1620 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1621 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1623 2e1f37b0 2019-08-08 stsp (unstage change),
1625 2e1f37b0 2019-08-08 stsp (keep change staged), and
1627 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1628 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1629 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1630 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1631 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1634 2e1f37b0 2019-08-08 stsp option, read
1639 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1640 2e1f37b0 2019-08-08 stsp .Ar response-script
1641 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1644 4ed9f614 2019-08-04 stsp Short alias for
1645 4ed9f614 2019-08-04 stsp .Cm unstage .
1646 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 ...
1647 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1648 896e9b6f 2019-08-26 stsp text format.
1649 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1650 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1651 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1653 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1654 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1655 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1656 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1657 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1658 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1660 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1662 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1663 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1665 01073a5d 2019-08-22 stsp The options for
1666 01073a5d 2019-08-22 stsp .Cm got cat
1667 01073a5d 2019-08-22 stsp are as follows:
1668 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1669 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1670 896e9b6f 2019-08-26 stsp Look up paths in the specified
1671 896e9b6f 2019-08-26 stsp .Ar commit .
1672 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1673 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1674 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1675 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1676 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1677 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1678 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1679 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1680 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1681 01073a5d 2019-08-22 stsp working directory.
1682 01073a5d 2019-08-22 stsp If this directory is a
1684 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1686 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1687 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1688 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1691 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1692 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1693 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1694 74416c47 2019-05-09 stsp The author's name and email address for
1695 21a44f98 2019-07-15 stsp .Cm got commit
1697 21a44f98 2019-07-15 stsp .Cm got import ,
1698 74416c47 2019-05-09 stsp for example:
1699 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1702 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1704 84792843 2019-08-09 stsp attempts to reject
1705 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1706 84792843 2019-08-09 stsp environment variables with a missing email address.
1708 c9956ddf 2019-09-08 stsp If present, Git's
1709 aba9c984 2019-09-08 stsp .Dv user.name
1711 709ae9eb 2019-09-08 stsp .Dv user.email
1712 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1713 aba9c984 2019-09-08 stsp .Pa .git/config
1714 aba9c984 2019-09-08 stsp file will override the value of
1715 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1716 c9956ddf 2019-09-08 stsp However, the
1717 c9956ddf 2019-09-08 stsp .Dv user.name
1719 c9956ddf 2019-09-08 stsp .Dv user.email
1720 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1721 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1722 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1723 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1724 c9956ddf 2019-09-08 stsp environment variable is
1727 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1728 23594da9 2019-05-13 stsp The editor spawned by
1729 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1730 8e7bd50a 2019-08-22 stsp .Cm got import ,
1732 8e7bd50a 2019-08-22 stsp .Cm got tag .
1733 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1734 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1735 b1ebc001 2019-08-13 stsp .Cm got log .
1736 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1737 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1739 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1740 5c860e29 2018-03-12 stsp .Ex -std got
1741 97925469 2018-03-17 stsp .Sh EXAMPLES
1742 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1745 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1746 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1748 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1749 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1751 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1752 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1754 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1756 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1757 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1758 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1760 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1761 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1763 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1765 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1767 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1769 e70c17ce 2019-05-22 stsp .Dl $ got status
1770 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1772 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1774 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1776 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1778 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1780 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1781 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1782 d83d9d5c 2019-05-13 stsp which is forked off the
1783 d83d9d5c 2019-05-13 stsp .Dq master
1786 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1788 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1789 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1790 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1792 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1794 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1795 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1797 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1799 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1800 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1801 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1803 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1805 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1807 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1809 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1810 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1811 5b666081 2020-02-24 stsp .Pa sys/uvm :
1813 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1815 5b666081 2020-02-24 stsp And this command has the same effect:
1817 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1819 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1821 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1822 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1824 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1825 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1827 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1829 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1830 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1831 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1833 95fc3404 2019-07-15 stsp .Dl $ got update
1835 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1836 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1837 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1839 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1840 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1841 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1842 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1844 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1845 469dd726 2020-03-20 stsp .Dq origin/master
1848 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1849 469dd726 2020-03-20 stsp .Dl $ got fetch
1851 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1852 469dd726 2020-03-20 stsp .Cm git clone --bare
1854 469dd726 2020-03-20 stsp .Xr git-fetch 1
1855 469dd726 2020-03-20 stsp command must be used instead:
1857 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1858 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1860 469dd726 2020-03-20 stsp Rebase the local
1861 469dd726 2020-03-20 stsp .Dq master
1862 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1863 469dd726 2020-03-20 stsp .Dq origin/master
1866 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1867 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1868 469dd726 2020-03-20 stsp .Dl $ got rebase master
1870 fa6e0e48 2019-05-23 stsp Rebase the
1871 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1872 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1873 fa6e0e48 2019-05-23 stsp .Dq master
1876 818c7501 2019-07-11 stsp .Dl $ got update -b master
1877 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1879 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1880 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1881 1dd86744 2019-08-12 anthony .Ox Ns 's
1882 1dd86744 2019-08-12 anthony CVS tree:
1884 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1886 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1887 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1890 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1891 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1892 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1894 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1895 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1896 bf390dec 2020-03-20 stsp branch back into the
1897 bf390dec 2020-03-20 stsp .Dq master
1898 bf390dec 2020-03-20 stsp branch, the
1899 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1900 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1901 bf390dec 2020-03-20 stsp .Dq master
1904 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1905 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1907 bf390dec 2020-03-20 stsp Changes on the
1908 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1909 bf390dec 2020-03-20 stsp branch can now be made visible on the
1910 bf390dec 2020-03-20 stsp .Dq master
1911 bf390dec 2020-03-20 stsp branch with
1912 bf390dec 2020-03-20 stsp .Cm got integrate .
1913 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1914 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1915 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1916 bf390dec 2020-03-20 stsp .Dq master
1917 bf390dec 2020-03-20 stsp branch before the
1918 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1919 bf390dec 2020-03-20 stsp branch can be integrated into
1920 bf390dec 2020-03-20 stsp .Dq master :
1922 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1923 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1925 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1926 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1927 7b3fde24 2019-07-28 stsp .Cm git push .
1928 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1929 469dd726 2020-03-20 stsp .Cm git clone --bare
1930 7848a0e1 2020-03-19 stsp instead of
1931 7848a0e1 2020-03-19 stsp .Cm got clone ,
1933 ff2cf171 2019-07-28 stsp .Dq refspec
1934 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1936 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1937 ff2cf171 2019-07-28 stsp namespace of the local repository.
1938 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1939 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1940 ff2cf171 2019-07-28 stsp configuration variable to the value
1941 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1943 ff2cf171 2019-07-28 stsp .Cm git config
1946 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1947 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1948 469dd726 2020-03-20 stsp Additionally, the
1949 469dd726 2020-03-20 stsp .Dq mirror
1950 469dd726 2020-03-20 stsp option must be disabled:
1952 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1953 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1955 ff2cf171 2019-07-28 stsp Alternatively, the following
1956 469dd726 2020-03-20 stsp .Xr git-fetch 1
1957 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1958 ff2cf171 2019-07-28 stsp .Pa config
1961 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1962 ff2cf171 2019-07-28 stsp .Dl url = ...
1963 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1964 469dd726 2020-03-20 stsp .Dl mirror = false
1966 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1967 ff2cf171 2019-07-28 stsp .Dq refs/heads
1968 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1969 ff2cf171 2019-07-28 stsp .Cm got checkout
1970 ff2cf171 2019-07-28 stsp and, if needed, created with
1971 ff2cf171 2019-07-28 stsp .Cm got branch .
1973 ff2cf171 2019-07-28 stsp Branches in the
1974 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1975 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1976 ff2cf171 2019-07-28 stsp repository with
1977 469dd726 2020-03-20 stsp .Cm got fetch
1979 469dd726 2020-03-20 stsp .Xr git-fetch 1
1980 469dd726 2020-03-20 stsp without extra command line arguments:
1982 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1983 469dd726 2020-03-20 stsp .Dl $ git fetch
1985 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1986 ff2cf171 2019-07-28 stsp .Dq master
1987 7b0db533 2020-02-04 stsp branch, the
1988 ff2cf171 2019-07-28 stsp .Dq master
1989 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1990 ff2cf171 2019-07-28 stsp .Dq origin/master
1992 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1994 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1995 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1998 083957f4 2020-02-24 stsp .Dq master
1999 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
2001 083957f4 2020-02-24 stsp by other developers and any other important new information:
2003 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
2004 083957f4 2020-02-24 stsp .Dl $ got histedit -m
2006 7b0db533 2020-02-04 stsp Local changes on the
2007 ff2cf171 2019-07-28 stsp .Dq master
2008 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
2009 ff2cf171 2019-07-28 stsp repository with
2010 ff2cf171 2019-07-28 stsp .Cm git push :
2012 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2013 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
2014 5c860e29 2018-03-12 stsp .Sh SEE ALSO
2015 2312fc47 2019-07-15 stsp .Xr tog 1 ,
2016 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
2017 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
2018 1a208aaf 2018-04-01 stsp .Sh AUTHORS
2019 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
2020 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2021 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2022 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2023 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2025 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
2026 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2028 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
2029 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
