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 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
206 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
207 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
208 4ba14133 2020-03-20 stsp Cannot be used together with the
211 4ba14133 2020-03-20 stsp .It Fl b Ar branch
212 4ba14133 2020-03-20 stsp Fetch the specified
214 4ba14133 2020-03-20 stsp from the remote repository.
215 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
217 4ba14133 2020-03-20 stsp If the branch corresponding to the remote repository's HEAD reference is not
218 4ba14133 2020-03-20 stsp in this list, the cloned repository's HEAD reference will be set to the first
219 4ba14133 2020-03-20 stsp branch which was fetched.
220 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
221 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
222 4ba14133 2020-03-20 stsp Cannot be used together with the
226 41b0de12 2020-03-21 stsp List branches and tags available for cloning from the remote repository
227 41b0de12 2020-03-21 stsp and exit immediately.
228 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
231 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
232 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
233 469dd726 2020-03-20 stsp local changes as created by
234 469dd726 2020-03-20 stsp .Cm got commit .
236 469dd726 2020-03-20 stsp The repository's
238 469dd726 2020-03-20 stsp file will be set up with the
240 469dd726 2020-03-20 stsp option enabled, such that
241 469dd726 2020-03-20 stsp .Cm got fetch
243 469dd726 2020-03-20 stsp .Xr git-fetch 1
244 469dd726 2020-03-20 stsp will write incoming changes directly to branches in the
245 469dd726 2020-03-20 stsp .Dq refs/heads/
246 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
247 469dd726 2020-03-20 stsp .Dq refs/remotes/
249 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
250 469dd726 2020-03-20 stsp .Cm got rebase
252 469dd726 2020-03-20 stsp .Cm got fetch
253 469dd726 2020-03-20 stsp in order to make incoming changes appear on branches in the
254 469dd726 2020-03-20 stsp .Dq refs/heads/
256 469dd726 2020-03-20 stsp But maintaining custom branches with local changes in the cloned
257 469dd726 2020-03-20 stsp repository becomes difficult since local changes are at risk of
258 469dd726 2020-03-20 stsp being discarded whenever incoming changes are fetched.
260 2ab43947 2020-03-18 stsp Suppress progress reporting output.
261 2ab43947 2020-03-18 stsp The same option will be passed to
263 2ab43947 2020-03-18 stsp if applicable.
265 2690194b 2020-03-21 stsp Verbose mode.
267 2690194b 2020-03-21 stsp .Cm got clone
268 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
269 2690194b 2020-03-21 stsp This option will be passed to
271 2ab43947 2020-03-18 stsp if applicable.
272 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
273 2ab43947 2020-03-18 stsp The maximum is 3.
276 267fe567 2020-03-18 stsp Short alias for
277 267fe567 2020-03-18 stsp .Cm clone .
278 f21ec2f0 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 q Oc Oo Fl v Oc Op Ar remote-repository
279 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
281 4ba14133 2020-03-20 stsp .Ar remote-repository
282 4ba14133 2020-03-20 stsp is specified,
284 7848a0e1 2020-03-19 stsp will be used.
285 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
287 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
288 7848a0e1 2020-03-19 stsp .Cm got clone .
290 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
291 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
292 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
294 7848a0e1 2020-03-19 stsp Branch references in the
295 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
296 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
298 7848a0e1 2020-03-19 stsp .Cm got rebase
299 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
300 7848a0e1 2020-03-19 stsp .Dq refs/heads/
301 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
303 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
304 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
305 469dd726 2020-03-20 stsp repository, including branches in the
306 469dd726 2020-03-20 stsp .Dq refs/heads/
307 469dd726 2020-03-20 stsp reference namespace.
308 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
309 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
310 175367bd 2020-03-20 stsp by Git's garbage collector.
312 469dd726 2020-03-20 stsp In any case, existing references in the
313 7848a0e1 2020-03-19 stsp .Dq refs/tags/
314 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
315 469dd726 2020-03-20 stsp repository.
317 7848a0e1 2020-03-19 stsp The options for
318 7848a0e1 2020-03-19 stsp .Cm got fetch
319 7848a0e1 2020-03-19 stsp are as follows:
320 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
322 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
323 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
324 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
325 4ba14133 2020-03-20 stsp Cannot be used together with the
328 4ba14133 2020-03-20 stsp .It Fl b Ar branch
329 4ba14133 2020-03-20 stsp Fetch the specified
331 4ba14133 2020-03-20 stsp from the remote repository.
332 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
334 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
335 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
336 4ba14133 2020-03-20 stsp Cannot be used together with the
340 f21ec2f0 2020-03-21 stsp Delete branches and tags from the local repository which are no longer
341 f21ec2f0 2020-03-21 stsp present in the remote repository.
342 f21ec2f0 2020-03-21 stsp Only references are deleted.
343 f21ec2f0 2020-03-21 stsp Any commit, tree, and blob objects belonging to deleted branches or
344 f21ec2f0 2020-03-21 stsp tags remain in the repository and may be removed separately with
345 f21ec2f0 2020-03-21 stsp Git's garbage collector.
347 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
348 41b0de12 2020-03-21 stsp and exit immediately.
349 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
353 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
354 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
355 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
356 7848a0e1 2020-03-19 stsp working directory.
357 7848a0e1 2020-03-19 stsp If this directory is a
359 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
361 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
362 7848a0e1 2020-03-19 stsp The same option will be passed to
364 7848a0e1 2020-03-19 stsp if applicable.
366 2690194b 2020-03-21 stsp Verbose mode.
368 2690194b 2020-03-21 stsp .Cm got fetch
369 2690194b 2020-03-21 stsp to print debugging messages to standard error output.
370 7848a0e1 2020-03-19 stsp The same option will be passed to
372 7848a0e1 2020-03-19 stsp if applicable.
373 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
374 7848a0e1 2020-03-19 stsp The maximum is 3.
377 7848a0e1 2020-03-19 stsp Short alias for
378 7848a0e1 2020-03-19 stsp .Cm fetch .
379 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
380 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
381 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
382 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
383 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
384 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
388 5d7c1dab 2018-04-01 stsp .Ar work tree path
389 c844a238 2019-02-06 stsp is not specified, either use the last component of
390 5d7c1dab 2018-04-01 stsp .Ar repository path ,
392 5d7c1dab 2018-04-01 stsp .Ar path prefix
393 c844a238 2019-02-06 stsp was specified use the last component of
394 5d7c1dab 2018-04-01 stsp .Ar path prefix .
396 38e11793 2018-06-13 stsp The options for
397 38e11793 2018-06-13 stsp .Cm got checkout
398 38e11793 2018-06-13 stsp are as follows:
399 38e11793 2018-06-13 stsp .Bl -tag -width Ds
401 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
402 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
403 bb51a5b4 2020-01-13 stsp is not empty.
404 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
405 08573d5b 2019-05-14 stsp .It Fl b Ar branch
406 3c575567 2019-07-28 stsp Check out files from a commit on the specified
407 08573d5b 2019-05-14 stsp .Ar branch .
408 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
409 08573d5b 2019-05-14 stsp reference will be used.
410 8069f636 2019-01-12 stsp .It Fl c Ar commit
411 8069f636 2019-01-12 stsp Check out files from the specified
413 3c575567 2019-07-28 stsp on the selected branch.
414 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
415 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
416 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
417 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
418 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
419 08573d5b 2019-05-14 stsp branch will be used.
421 4b6c9460 2020-03-05 stsp If the specified
423 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
424 4b6c9460 2020-03-05 stsp this commit must be specified with the
427 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
428 4b6c9460 2020-03-05 stsp commit with
429 4b6c9460 2020-03-05 stsp .Cm got branch
431 4b6c9460 2020-03-05 stsp .Cm got checkout
432 4b6c9460 2020-03-05 stsp can be used.
433 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
434 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
435 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
436 38e11793 2018-06-13 stsp Only files beneath the specified
437 38e11793 2018-06-13 stsp .Ar path-prefix
438 38e11793 2018-06-13 stsp will be checked out.
441 97b3a7be 2019-07-09 stsp Short alias for
442 97b3a7be 2019-07-09 stsp .Cm checkout .
443 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
444 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
445 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
446 7f838b36 2019-02-08 stsp .Bl -column YXZ description
447 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
448 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
449 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
450 7f838b36 2019-02-08 stsp .It D Ta file was deleted
451 7f838b36 2019-02-08 stsp .It A Ta new file was added
452 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
453 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
458 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
459 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
460 f2ea84fa 2019-07-27 stsp specified paths.
461 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
462 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
463 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
466 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
467 c4cdcb68 2019-04-03 stsp multiple base commits.
468 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
469 47ec7be7 2019-05-12 stsp .Cm got update
470 47ec7be7 2019-05-12 stsp across the entire work tree.
471 024e9686 2019-05-14 stsp Specifying a
473 024e9686 2019-05-14 stsp is incompatible with the
477 4ed9f614 2019-08-04 stsp .Cm got update
478 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
479 4ed9f614 2019-08-04 stsp If changes have been staged with
480 4ed9f614 2019-08-04 stsp .Cm got stage ,
481 bc3056e3 2019-08-18 stsp these changes must first be committed with
482 4ed9f614 2019-08-04 stsp .Cm got commit
483 4ed9f614 2019-08-04 stsp or unstaged with
484 4ed9f614 2019-08-04 stsp .Cm got unstage .
486 507dc3bb 2018-12-29 stsp The options for
487 507dc3bb 2018-12-29 stsp .Cm got update
488 507dc3bb 2018-12-29 stsp are as follows:
489 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
490 024e9686 2019-05-14 stsp .It Fl b Ar branch
491 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
493 024e9686 2019-05-14 stsp before updating the work tree.
494 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
495 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
496 507dc3bb 2018-12-29 stsp Update the work tree to the specified
497 507dc3bb 2018-12-29 stsp .Ar commit .
498 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
499 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
500 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
501 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
502 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
503 024e9686 2019-05-14 stsp branch will be used.
506 97b3a7be 2019-07-09 stsp Short alias for
507 97b3a7be 2019-07-09 stsp .Cm update .
508 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
509 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
510 6bad629b 2019-02-04 stsp using the following status codes:
511 6bad629b 2019-02-04 stsp .Bl -column YXZ description
512 6bad629b 2019-02-04 stsp .It M Ta modified file
513 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
514 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
515 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
516 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
517 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
518 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
520 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
521 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
523 2a06fe5f 2019-08-24 stsp specified on the command line
528 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
529 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
531 4ed9f614 2019-08-04 stsp If changes have been staged with
532 4ed9f614 2019-08-04 stsp .Cm got stage ,
533 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
534 4ed9f614 2019-08-04 stsp status codes:
535 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
536 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
537 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
538 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
541 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
542 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
543 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
544 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
547 6841da00 2019-08-08 stsp For compatibility with
550 bd8de430 2019-10-04 stsp .Xr git 1 ,
551 6841da00 2019-08-08 stsp .Cm got status
554 bd8de430 2019-10-04 stsp patterns from
555 6841da00 2019-08-08 stsp .Pa .cvsignore
557 bd8de430 2019-10-04 stsp .Pa .gitignore
558 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
559 bd8de430 2019-10-04 stsp which match these patterns.
560 bd8de430 2019-10-04 stsp As an extension to
562 bd8de430 2019-10-04 stsp matching rules,
563 bd8de430 2019-10-04 stsp .Cm got status
564 bd8de430 2019-10-04 stsp supports consecutive asterisks,
566 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
568 6841da00 2019-08-08 stsp .Xr cvs 1 ,
569 6841da00 2019-08-08 stsp .Cm got status
570 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
572 bd8de430 2019-10-04 stsp .Xr git 1 ,
573 bd8de430 2019-10-04 stsp .Cm got status
574 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
576 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
578 bd8de430 2019-10-04 stsp in a pattern.
580 97b3a7be 2019-07-09 stsp Short alias for
581 97b3a7be 2019-07-09 stsp .Cm status .
582 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
583 38e11793 2018-06-13 stsp Display history of a repository.
586 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
587 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
589 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
590 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
591 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
593 38e11793 2018-06-13 stsp The options for
594 38e11793 2018-06-13 stsp .Cm got log
595 38e11793 2018-06-13 stsp are as follows:
596 38e11793 2018-06-13 stsp .Bl -tag -width Ds
598 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
599 1137e0ae 2020-01-27 stsp from other branches.
600 48c8c60d 2020-01-27 stsp By default,
601 48c8c60d 2020-01-27 stsp .Cm got log
602 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
603 38e11793 2018-06-13 stsp .It Fl c Ar commit
604 38e11793 2018-06-13 stsp Start traversing history at the specified
605 38e11793 2018-06-13 stsp .Ar commit .
606 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
607 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
608 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
609 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
610 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
611 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
612 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
613 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
615 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
616 6238ee32 2018-06-13 stsp .It Fl l Ar N
617 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
618 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
619 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
621 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
622 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
624 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
627 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
628 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
629 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
630 6841bf13 2019-11-29 kn regular expression
631 6841bf13 2019-11-29 kn .Ar search-pattern .
632 6841bf13 2019-11-29 kn Regular expression syntax is documented in
633 6841bf13 2019-11-29 kn .Xr re_format 7 .
634 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
635 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
636 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
637 04ca23f4 2018-07-16 stsp working directory.
638 e9cf2e30 2019-02-05 stsp If this directory is a
640 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
642 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
643 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
644 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
647 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
649 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
650 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
651 d24820bf 2019-08-11 stsp corresponding objects.
652 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
653 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
654 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
656 c0cc5c62 2018-10-18 stsp The options for
657 c0cc5c62 2018-10-18 stsp .Cm got diff
658 c0cc5c62 2018-10-18 stsp are as follows:
659 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
660 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
661 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
662 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
663 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
664 b72f483a 2019-02-05 stsp Use the repository at the specified path.
665 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
666 b72f483a 2019-02-05 stsp working directory.
667 b72f483a 2019-02-05 stsp If this directory is a
669 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
671 4ed9f614 2019-08-04 stsp Show changes staged with
672 4ed9f614 2019-08-04 stsp .Cm got stage
673 4ed9f614 2019-08-04 stsp instead of showing local changes.
674 4ed9f614 2019-08-04 stsp This option is only valid when
675 4ed9f614 2019-08-04 stsp .Cm got diff
676 4ed9f614 2019-08-04 stsp is invoked in a work tree.
678 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
681 bc26cce8 2019-08-04 stsp Short alias for
683 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
684 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
686 1ff8e573 2018-08-02 stsp The options for
687 1ff8e573 2018-08-02 stsp .Cm got blame
688 1ff8e573 2018-08-02 stsp are as follows:
689 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
690 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
691 1ff8e573 2018-08-02 stsp Start traversing history at the specified
692 1ff8e573 2018-08-02 stsp .Ar commit .
693 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
694 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
695 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
696 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
697 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
698 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
699 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
700 1ff8e573 2018-08-02 stsp working directory.
701 0c06baac 2019-02-05 stsp If this directory is a
703 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
706 bc26cce8 2019-08-04 stsp Short alias for
707 bc26cce8 2019-08-04 stsp .Cm blame .
708 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
709 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
710 5de5890b 2018-10-18 stsp directory path in the repository.
711 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
712 db0c2996 2019-02-10 stsp annotations:
713 db0c2996 2019-02-10 stsp .Bl -column YXZ description
714 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
715 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
716 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
717 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
722 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
723 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
724 0c849583 2019-02-05 stsp if there is no work tree.
726 5de5890b 2018-10-18 stsp The options for
727 5de5890b 2018-10-18 stsp .Cm got tree
728 5de5890b 2018-10-18 stsp are as follows:
729 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
730 5de5890b 2018-10-18 stsp .It Fl c Ar commit
731 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
732 5de5890b 2018-10-18 stsp .Ar commit .
733 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
734 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
735 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
736 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
737 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
738 5de5890b 2018-10-18 stsp Use the repository at the specified path.
739 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
740 5de5890b 2018-10-18 stsp working directory.
741 0c849583 2019-02-05 stsp If this directory is a
743 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
745 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
747 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
750 bc26cce8 2019-08-04 stsp Short alias for
752 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
753 d0eebce4 2019-03-11 stsp Manage references in a repository.
755 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
756 d0eebce4 2019-03-11 stsp or update, the reference with the given
758 d0eebce4 2019-03-11 stsp and make it point at the given
759 d83d9d5c 2019-05-13 stsp .Ar target .
760 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
761 f16e4044 2019-10-09 stsp .Dq refs/ .
762 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
763 a54b6686 2019-06-28 stsp will be resolved to an object ID.
764 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
765 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
767 d0eebce4 2019-03-11 stsp The options for
768 d0eebce4 2019-03-11 stsp .Cm got ref
769 d0eebce4 2019-03-11 stsp are as follows:
770 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
771 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
772 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
773 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
774 d0eebce4 2019-03-11 stsp working directory.
775 d0eebce4 2019-03-11 stsp If this directory is a
777 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
779 d0eebce4 2019-03-11 stsp List all existing references in the repository.
780 d0eebce4 2019-03-11 stsp .It Fl d Ar name
781 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
783 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
784 d1c1ae5f 2019-08-12 stsp .Ar target ,
785 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
786 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
787 d1c1ae5f 2019-08-12 stsp this option is used.
789 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
790 da76fce2 2020-02-24 stsp Create, list, or delete branches.
792 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
793 4e759de4 2019-06-26 stsp .Dq refs/heads/
794 4e759de4 2019-06-26 stsp reference namespace.
796 4e759de4 2019-06-26 stsp .Cm got branch
797 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
799 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
800 ad89fa31 2019-10-04 stsp work tree's current branch.
804 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
805 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
806 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
807 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
809 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
810 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
811 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
812 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
814 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
815 da76fce2 2020-02-24 stsp .Bl -column YXZ description
816 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
817 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
818 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
819 da76fce2 2020-02-24 stsp .It D Ta file was deleted
820 da76fce2 2020-02-24 stsp .It A Ta new file was added
821 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
822 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
825 4e759de4 2019-06-26 stsp The options for
826 4e759de4 2019-06-26 stsp .Cm got branch
827 4e759de4 2019-06-26 stsp are as follows:
828 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
829 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
830 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
831 a74f7e83 2019-11-10 stsp .Ar commit .
832 a74f7e83 2019-11-10 stsp The expected
834 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
835 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
836 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
837 4e759de4 2019-06-26 stsp Use the repository at the specified path.
838 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
839 4e759de4 2019-06-26 stsp working directory.
840 4e759de4 2019-06-26 stsp If this directory is a
842 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
844 4e759de4 2019-06-26 stsp List all existing branches in the repository.
845 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
846 ba882ee3 2019-07-11 stsp with one the following annotations:
847 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
848 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
849 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
851 4e759de4 2019-06-26 stsp .It Fl d Ar name
852 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
853 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
854 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
855 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
856 ce33d90e 2019-07-14 stsp Git's garbage collector.
858 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
861 97b3a7be 2019-07-09 stsp Short alias for
862 97b3a7be 2019-07-09 stsp .Cm branch .
863 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
864 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
866 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
867 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
868 8e7bd50a 2019-08-22 stsp reference namespace.
870 8e7bd50a 2019-08-22 stsp .Cm got tag
871 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
872 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
873 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
875 80106605 2020-02-24 stsp Attempt to create a tag with the given
877 8e7bd50a 2019-08-22 stsp and make this tag point at the given
878 8e7bd50a 2019-08-22 stsp .Ar commit .
879 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
880 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
881 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
883 8e7bd50a 2019-08-22 stsp The options for
884 8e7bd50a 2019-08-22 stsp .Cm got tag
885 8e7bd50a 2019-08-22 stsp are as follows:
886 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
887 80106605 2020-02-24 stsp .It Fl c Ar commit
888 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
889 80106605 2020-02-24 stsp .Ar commit .
890 80106605 2020-02-24 stsp The expected
892 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
893 80106605 2020-02-24 stsp will be resolved to a commit ID.
894 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
895 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
896 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
897 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
898 8e7bd50a 2019-08-22 stsp Without the
901 3a62228f 2019-11-08 stsp .Cm got tag
902 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
903 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
904 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
905 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
906 8e7bd50a 2019-08-22 stsp working directory.
907 8e7bd50a 2019-08-22 stsp If this directory is a
909 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
911 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
912 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
915 8e7bd50a 2019-08-22 stsp By design, the
916 8e7bd50a 2019-08-22 stsp .Cm got tag
917 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
918 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
919 8e7bd50a 2019-08-22 stsp .Cm got ref
920 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
921 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
922 8e7bd50a 2019-08-22 stsp another repository.
923 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
924 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
925 d00136be 2019-03-26 stsp repository in the next commit.
927 4e68cba3 2019-11-23 stsp The options for
928 4e68cba3 2019-11-23 stsp .Cm got add
929 4e68cba3 2019-11-23 stsp are as follows:
930 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
932 4e68cba3 2019-11-23 stsp Permit recursion into directories.
933 4e68cba3 2019-11-23 stsp If this option is not specified,
934 4e68cba3 2019-11-23 stsp .Cm got add
935 4e68cba3 2019-11-23 stsp will refuse to run if a specified
937 4e68cba3 2019-11-23 stsp is a directory.
939 022fae89 2019-12-06 tracey With -R, add files even if they match a
940 022fae89 2019-12-06 tracey .Cm got status
941 022fae89 2019-12-06 tracey ignore pattern.
943 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
944 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
945 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
947 2ec1f75b 2019-03-26 stsp The options for
948 86d25a1b 2019-07-11 stsp .Cm got remove
949 2ec1f75b 2019-03-26 stsp are as follows:
950 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
952 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
954 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
956 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
957 f2a9dc41 2019-12-13 tracey If this option is not specified,
958 f2a9dc41 2019-12-13 tracey .Cm got remove
959 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
961 f2a9dc41 2019-12-13 tracey is a directory.
964 648e4ef7 2019-07-09 stsp Short alias for
965 648e4ef7 2019-07-09 stsp .Cm remove .
966 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 ...
967 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
968 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
969 1dd86744 2019-08-12 anthony work tree's base commit.
970 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
971 a129376b 2019-03-28 stsp .Cm got revert !
973 e20a8b6f 2019-06-04 stsp If a file was added with
974 a129376b 2019-03-28 stsp .Cm got add
975 a129376b 2019-03-28 stsp it will become an unversioned file again.
976 e20a8b6f 2019-06-04 stsp If a file was deleted with
977 86d25a1b 2019-07-11 stsp .Cm got remove
978 a129376b 2019-03-28 stsp it will be restored.
980 0f6d7415 2019-08-08 stsp The options for
981 0f6d7415 2019-08-08 stsp .Cm got revert
982 0f6d7415 2019-08-08 stsp are as follows:
983 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
985 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
986 33aa809d 2019-08-08 stsp changes to revert based on
988 33aa809d 2019-08-08 stsp (revert change),
990 33aa809d 2019-08-08 stsp (keep change), and
992 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
993 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
994 33aa809d 2019-08-08 stsp modified file content can be reverted.
995 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
996 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
999 33aa809d 2019-08-08 stsp option, read
1004 33aa809d 2019-08-08 stsp responses line-by-line from the specified
1005 33aa809d 2019-08-08 stsp .Ar response-script
1006 33aa809d 2019-08-08 stsp file instead of prompting interactively.
1008 0f6d7415 2019-08-08 stsp Permit recursion into directories.
1009 0f6d7415 2019-08-08 stsp If this option is not specified,
1010 0f6d7415 2019-08-08 stsp .Cm got revert
1011 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1013 0f6d7415 2019-08-08 stsp is a directory.
1016 97b3a7be 2019-07-09 stsp Short alias for
1017 97b3a7be 2019-07-09 stsp .Cm revert .
1018 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1019 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1020 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1023 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1024 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1026 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1027 1dd86744 2019-08-12 anthony .Cm got stage ,
1028 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1029 4ed9f614 2019-08-04 stsp have not been staged.
1031 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1032 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1033 15cd91f7 2019-05-12 stsp .It M Ta modified file
1034 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1035 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1036 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1039 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1040 996d5ccd 2019-08-05 stsp recorded base commit.
1043 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1044 15cd91f7 2019-05-12 stsp multiple base commits.
1045 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1046 47ec7be7 2019-05-12 stsp .Cm got update
1047 47ec7be7 2019-05-12 stsp across the entire work tree.
1050 15cd91f7 2019-05-12 stsp .Cm got commit
1051 15cd91f7 2019-05-12 stsp command requires the
1052 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1053 aba9c984 2019-09-08 stsp environment variable to be set,
1054 aba9c984 2019-09-08 stsp unless Git's
1055 aba9c984 2019-09-08 stsp .Dv user.name
1057 709ae9eb 2019-09-08 stsp .Dv user.email
1058 709ae9eb 2019-09-08 stsp configuration settings can be
1059 aba9c984 2019-09-08 stsp obtained from the repository's
1060 aba9c984 2019-09-08 stsp .Pa .git/config
1061 c9956ddf 2019-09-08 stsp file or from Git's global
1062 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1063 c9956ddf 2019-09-08 stsp configuration file.
1065 74416c47 2019-05-09 stsp The options for
1066 74416c47 2019-05-09 stsp .Cm got commit
1067 74416c47 2019-05-09 stsp are as follows:
1068 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1069 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1070 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1071 23594da9 2019-05-13 stsp Without the
1074 23594da9 2019-05-13 stsp .Cm got commit
1075 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1078 cfce0458 2019-07-28 stsp .Cm got commit
1079 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1080 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1081 916f288c 2019-07-30 stsp .Dq refs/heads/
1082 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1083 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1084 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1085 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1086 cfce0458 2019-07-28 stsp .Cm got update
1087 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1088 cfce0458 2019-07-28 stsp in the repository.
1090 97b3a7be 2019-07-09 stsp Short alias for
1091 97b3a7be 2019-07-09 stsp .Cm commit .
1092 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1093 234035bc 2019-06-01 stsp Merge changes from a single
1094 234035bc 2019-06-01 stsp .Ar commit
1095 234035bc 2019-06-01 stsp into the work tree.
1096 234035bc 2019-06-01 stsp The specified
1097 234035bc 2019-06-01 stsp .Ar commit
1098 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1099 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1100 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1101 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1103 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1104 234035bc 2019-06-01 stsp .Bl -column YXZ description
1105 234035bc 2019-06-01 stsp .It G Ta file was merged
1106 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1107 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1108 234035bc 2019-06-01 stsp .It D Ta file was deleted
1109 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1110 234035bc 2019-06-01 stsp .It A Ta new file was added
1111 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1114 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1115 234035bc 2019-06-01 stsp may be viewed with
1116 234035bc 2019-06-01 stsp .Cm got diff ,
1117 234035bc 2019-06-01 stsp amended manually or with further
1118 234035bc 2019-06-01 stsp .Cm got cherrypick
1120 234035bc 2019-06-01 stsp committed with
1121 234035bc 2019-06-01 stsp .Cm got commit ,
1122 234035bc 2019-06-01 stsp or discarded again with
1123 234035bc 2019-06-01 stsp .Cm got revert .
1125 234035bc 2019-06-01 stsp .Cm got cherrypick
1126 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1127 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1128 234035bc 2019-06-01 stsp to a single base commit with
1129 234035bc 2019-06-01 stsp .Cm got update .
1130 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1131 234035bc 2019-06-01 stsp conflicts must be resolved first.
1133 97b3a7be 2019-07-09 stsp Short alias for
1134 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1135 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1136 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1137 5ef14e63 2019-06-02 stsp .Ar commit
1138 5ef14e63 2019-06-02 stsp into the work tree.
1139 5ef14e63 2019-06-02 stsp The specified
1140 5ef14e63 2019-06-02 stsp .Ar commit
1141 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1142 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1143 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1144 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1146 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1147 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1148 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1149 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1150 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1151 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1152 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1153 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1154 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1157 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1158 5ef14e63 2019-06-02 stsp which may be viewed with
1159 5ef14e63 2019-06-02 stsp .Cm got diff ,
1160 5ef14e63 2019-06-02 stsp amended manually or with further
1161 778a73c2 2019-07-12 stsp .Cm got backout
1163 5ef14e63 2019-06-02 stsp committed with
1164 5ef14e63 2019-06-02 stsp .Cm got commit ,
1165 5ef14e63 2019-06-02 stsp or discarded again with
1166 5ef14e63 2019-06-02 stsp .Cm got revert .
1168 92228c38 2019-06-02 stsp .Cm got backout
1169 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1170 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1171 92228c38 2019-06-02 stsp to a single base commit with
1172 92228c38 2019-06-02 stsp .Cm got update .
1173 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1174 92228c38 2019-06-02 stsp conflicts must be resolved first.
1176 97b3a7be 2019-07-09 stsp Short alias for
1177 97b3a7be 2019-07-09 stsp .Cm backout .
1178 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1179 818c7501 2019-07-11 stsp Rebase commits on the specified
1180 818c7501 2019-07-11 stsp .Ar branch
1181 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1183 818c7501 2019-07-11 stsp .Ar branch
1184 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1185 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1186 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1187 818c7501 2019-07-11 stsp .Ar branch
1188 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1189 f09e2405 2019-07-11 stsp of the specified
1190 818c7501 2019-07-11 stsp .Ar branch
1191 f09e2405 2019-07-11 stsp has been rebased.
1194 2b6826ba 2020-02-24 stsp .Cm got rebase
1195 2b6826ba 2020-02-24 stsp is used as intended, the specified
1196 2b6826ba 2020-02-24 stsp .Ar branch
1197 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1198 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1199 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1200 2b6826ba 2020-02-24 stsp .Cm got update -b
1201 2b6826ba 2020-02-24 stsp before starting the
1202 2b6826ba 2020-02-24 stsp .Cm rebase
1203 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1204 2b6826ba 2020-02-24 stsp a common history with the specified
1205 2b6826ba 2020-02-24 stsp .Ar branch
1206 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1207 c10890ce 2020-02-25 stsp remote repository.
1209 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1210 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1211 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1212 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1213 818c7501 2019-07-11 stsp .Ar branch ,
1214 818c7501 2019-07-11 stsp but with different commit IDs.
1215 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1216 f09e2405 2019-07-11 stsp the new version of the specified
1217 818c7501 2019-07-11 stsp .Ar branch
1218 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1220 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1221 818c7501 2019-07-11 stsp using the following status codes:
1222 818c7501 2019-07-11 stsp .Bl -column YXZ description
1223 818c7501 2019-07-11 stsp .It G Ta file was merged
1224 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1225 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1226 818c7501 2019-07-11 stsp .It D Ta file was deleted
1227 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1228 818c7501 2019-07-11 stsp .It A Ta new file was added
1229 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1232 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1233 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1234 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1235 818c7501 2019-07-11 stsp .Ar branch
1236 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1238 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1239 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1240 f09e2405 2019-07-11 stsp when the rebase operation continues.
1242 818c7501 2019-07-11 stsp .Cm got rebase
1243 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1244 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1245 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1246 818c7501 2019-07-11 stsp .Cm got update .
1247 4ed9f614 2019-08-04 stsp If changes have been staged with
1248 4ed9f614 2019-08-04 stsp .Cm got stage ,
1249 bc3056e3 2019-08-18 stsp these changes must first be committed with
1250 4ed9f614 2019-08-04 stsp .Cm got commit
1251 4ed9f614 2019-08-04 stsp or unstaged with
1252 4ed9f614 2019-08-04 stsp .Cm got unstage .
1253 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1254 f09e2405 2019-07-11 stsp committed with
1255 f09e2405 2019-07-11 stsp .Cm got commit
1256 f09e2405 2019-07-11 stsp or reverted with
1257 f09e2405 2019-07-11 stsp .Cm got revert .
1259 64c6d990 2019-07-11 stsp .Ar branch
1260 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1261 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1264 7d5807f4 2019-07-11 stsp .Cm got update
1266 7d5807f4 2019-07-11 stsp .Cm got commit
1267 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1268 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1269 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1271 818c7501 2019-07-11 stsp The options for
1272 818c7501 2019-07-11 stsp .Cm got rebase
1273 818c7501 2019-07-11 stsp are as follows:
1274 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1276 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1277 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1279 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1280 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1283 818c7501 2019-07-11 stsp Short alias for
1284 818c7501 2019-07-11 stsp .Cm rebase .
1285 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
1286 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1287 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1289 6e54d307 2020-02-24 stsp Before starting a
1290 6e54d307 2020-02-24 stsp .Cm histedit
1291 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1292 6e54d307 2020-02-24 stsp .Cm got update -b
1293 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1294 6e54d307 2020-02-24 stsp current branch of the work tree.
1295 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1296 6e54d307 2020-02-24 stsp touched by the
1297 6e54d307 2020-02-24 stsp .Cm histedit
1298 6e54d307 2020-02-24 stsp operation.
1300 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1301 6e54d307 2020-02-24 stsp must be set with
1302 6e54d307 2020-02-24 stsp .Cm got update -c
1303 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1304 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1306 6e54d307 2020-02-24 stsp .Cm histedit
1307 6e54d307 2020-02-24 stsp operation.
1309 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1310 0ebf8283 2019-07-24 stsp .Ar histedit script
1311 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1312 46fa4c83 2020-02-24 stsp command line, or generated with the
1314 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1316 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1317 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1318 0ebf8283 2019-07-24 stsp whitespace and an argument.
1319 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1320 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1321 0ebf8283 2019-07-24 stsp Lines which begin with the
1323 0ebf8283 2019-07-24 stsp character are ignored entirely.
1325 0ebf8283 2019-07-24 stsp The available commands are as follows:
1326 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1327 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1328 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1329 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1330 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1331 0ebf8283 2019-07-24 stsp listed further below that will be used.
1332 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1333 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1334 0ebf8283 2019-07-24 stsp the commit on the previous line.
1335 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1336 0ebf8283 2019-07-24 stsp log message can be written.
1339 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1340 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1341 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1343 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1344 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1345 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1346 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1347 498a90b7 2019-07-25 stsp switched to it.
1349 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1350 0ebf8283 2019-07-24 stsp using the following status codes:
1351 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1352 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1353 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1354 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1355 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1356 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1357 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1358 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1361 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1362 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1363 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1364 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1366 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1367 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1368 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1370 0ebf8283 2019-07-24 stsp .Cm got histedit
1371 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1372 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1373 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1374 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1375 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1376 0ebf8283 2019-07-24 stsp to a single base commit with
1377 0ebf8283 2019-07-24 stsp .Cm got update .
1378 4ed9f614 2019-08-04 stsp If changes have been staged with
1379 4ed9f614 2019-08-04 stsp .Cm got stage ,
1380 bc3056e3 2019-08-18 stsp these changes must first be committed with
1381 4ed9f614 2019-08-04 stsp .Cm got commit
1382 4ed9f614 2019-08-04 stsp or unstaged with
1383 4ed9f614 2019-08-04 stsp .Cm got unstage .
1384 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1385 0ebf8283 2019-07-24 stsp committed with
1386 0ebf8283 2019-07-24 stsp .Cm got commit
1387 0ebf8283 2019-07-24 stsp or reverted with
1388 0ebf8283 2019-07-24 stsp .Cm got revert .
1389 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1390 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1393 7ef62c4e 2020-02-24 stsp .Cm got update ,
1394 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1396 65db4ffb 2020-02-24 stsp .Cm got integrate
1397 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1398 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1399 0ebf8283 2019-07-24 stsp .Cm got commit
1400 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1401 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1403 0ebf8283 2019-07-24 stsp The options for
1404 0ebf8283 2019-07-24 stsp .Cm got histedit
1405 0ebf8283 2019-07-24 stsp are as follows:
1406 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1408 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1409 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1411 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1412 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1413 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1414 ddbfac99 2020-02-24 stsp Use the specified
1415 ddbfac99 2020-02-24 stsp .Ar histedit-script
1416 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1417 ddbfac99 2020-02-24 stsp can be written.
1419 083957f4 2020-02-24 stsp Edit log messages only.
1420 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1421 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1424 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1425 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1428 0ebf8283 2019-07-24 stsp Short alias for
1429 0ebf8283 2019-07-24 stsp .Cm histedit .
1430 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1431 2822a352 2019-10-15 stsp Integrate the specified
1432 2822a352 2019-10-15 stsp .Ar branch
1433 2822a352 2019-10-15 stsp into the work tree's current branch.
1434 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1435 2822a352 2019-10-15 stsp .Ar branch ,
1436 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1437 2822a352 2019-10-15 stsp head commit of the integrated
1438 2822a352 2019-10-15 stsp .Ar branch .
1440 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1441 2822a352 2019-10-15 stsp will be pointing at the same commit.
1442 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1443 2822a352 2019-10-15 stsp In case the integrated
1444 2822a352 2019-10-15 stsp .Ar branch
1445 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1446 2822a352 2019-10-15 stsp .Cm got branch -d .
1448 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1449 2822a352 2019-10-15 stsp .Bl -column YXZ description
1450 2822a352 2019-10-15 stsp .It U Ta file was updated
1451 2822a352 2019-10-15 stsp .It D Ta file was deleted
1452 2822a352 2019-10-15 stsp .It A Ta new file was added
1453 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1454 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1457 2822a352 2019-10-15 stsp .Cm got integrate
1458 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1459 2822a352 2019-10-15 stsp Most importantly, the
1460 2822a352 2019-10-15 stsp .Ar branch
1461 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1462 2822a352 2019-10-15 stsp .Cm got rebase
1463 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1464 2822a352 2019-10-15 stsp resolve merge conflicts.
1465 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1466 2822a352 2019-10-15 stsp to a single base commit with
1467 2822a352 2019-10-15 stsp .Cm got update .
1468 2822a352 2019-10-15 stsp If changes have been staged with
1469 2822a352 2019-10-15 stsp .Cm got stage ,
1470 2822a352 2019-10-15 stsp these changes must first be committed with
1471 2822a352 2019-10-15 stsp .Cm got commit
1472 2822a352 2019-10-15 stsp or unstaged with
1473 2822a352 2019-10-15 stsp .Cm got unstage .
1474 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1475 2822a352 2019-10-15 stsp committed with
1476 2822a352 2019-10-15 stsp .Cm got commit
1477 2822a352 2019-10-15 stsp or reverted with
1478 2822a352 2019-10-15 stsp .Cm got revert .
1480 2822a352 2019-10-15 stsp Short alias for
1481 2822a352 2019-10-15 stsp .Cm integrate .
1482 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 ...
1483 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1486 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1487 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1488 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1489 4ed9f614 2019-08-04 stsp .Cm got status .
1491 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1492 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1493 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1494 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1495 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1498 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1499 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1500 9d8b19a4 2019-08-04 stsp committed.
1502 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1503 4ed9f614 2019-08-04 stsp .Cm got commit ,
1504 4ed9f614 2019-08-04 stsp .Cm got status ,
1506 4ed9f614 2019-08-04 stsp .Cm got diff .
1507 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1508 4ed9f614 2019-08-04 stsp .Cm got commit
1509 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1510 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1511 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1513 4ed9f614 2019-08-04 stsp .Cm got status
1514 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1516 4ed9f614 2019-08-04 stsp .Cm got diff
1517 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1518 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1520 4ed9f614 2019-08-04 stsp .Cm got revert
1521 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1522 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1524 4ed9f614 2019-08-04 stsp The options for
1525 4ed9f614 2019-08-04 stsp .Cm got stage
1526 4ed9f614 2019-08-04 stsp are as follows:
1527 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1529 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1530 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1531 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1532 1dd86744 2019-08-12 anthony among the specified paths.
1533 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1535 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1536 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1538 6d23ec10 2019-08-08 stsp (stage change),
1540 6d23ec10 2019-08-08 stsp (reject change), and
1542 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1543 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1544 dc424a06 2019-08-07 stsp modified file content can be staged.
1545 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1546 6d23ec10 2019-08-08 stsp their entirety.
1547 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1550 3a070a2b 2019-08-07 stsp option, read
1555 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1556 0e2f5884 2019-08-07 stsp .Ar response-script
1557 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1560 4ed9f614 2019-08-04 stsp .Cm got stage
1561 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1562 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1563 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1564 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1565 4ed9f614 2019-08-04 stsp .Cm got update
1566 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1567 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1570 4ed9f614 2019-08-04 stsp .Cm got update ,
1571 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1573 4ed9f614 2019-08-04 stsp .Cm got histedit
1574 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1575 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1576 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1577 4ed9f614 2019-08-04 stsp .Cm got unstage
1578 4ed9f614 2019-08-04 stsp before it can be updated with
1579 4ed9f614 2019-08-04 stsp .Cm got update ,
1580 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1582 4ed9f614 2019-08-04 stsp Short alias for
1583 4ed9f614 2019-08-04 stsp .Cm stage .
1584 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1585 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1586 4ed9f614 2019-08-04 stsp back into non-staged status.
1589 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1590 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1592 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1593 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1594 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1595 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1596 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1597 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1598 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1599 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1602 2e1f37b0 2019-08-08 stsp The options for
1603 2e1f37b0 2019-08-08 stsp .Cm got unstage
1604 2e1f37b0 2019-08-08 stsp are as follows:
1605 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1607 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1608 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1610 2e1f37b0 2019-08-08 stsp (unstage change),
1612 2e1f37b0 2019-08-08 stsp (keep change staged), and
1614 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1615 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1616 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1617 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1618 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1621 2e1f37b0 2019-08-08 stsp option, read
1626 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1627 2e1f37b0 2019-08-08 stsp .Ar response-script
1628 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1631 4ed9f614 2019-08-04 stsp Short alias for
1632 4ed9f614 2019-08-04 stsp .Cm unstage .
1633 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 ...
1634 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1635 896e9b6f 2019-08-26 stsp text format.
1636 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1637 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1638 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1640 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1641 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1642 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1643 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1644 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1645 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1647 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1649 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1650 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1652 01073a5d 2019-08-22 stsp The options for
1653 01073a5d 2019-08-22 stsp .Cm got cat
1654 01073a5d 2019-08-22 stsp are as follows:
1655 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1656 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1657 896e9b6f 2019-08-26 stsp Look up paths in the specified
1658 896e9b6f 2019-08-26 stsp .Ar commit .
1659 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1660 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1661 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1662 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1663 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1664 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1665 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1666 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1667 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1668 01073a5d 2019-08-22 stsp working directory.
1669 01073a5d 2019-08-22 stsp If this directory is a
1671 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1673 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1674 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1675 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1678 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1679 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1680 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1681 74416c47 2019-05-09 stsp The author's name and email address for
1682 21a44f98 2019-07-15 stsp .Cm got commit
1684 21a44f98 2019-07-15 stsp .Cm got import ,
1685 74416c47 2019-05-09 stsp for example:
1686 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1689 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1691 84792843 2019-08-09 stsp attempts to reject
1692 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1693 84792843 2019-08-09 stsp environment variables with a missing email address.
1695 c9956ddf 2019-09-08 stsp If present, Git's
1696 aba9c984 2019-09-08 stsp .Dv user.name
1698 709ae9eb 2019-09-08 stsp .Dv user.email
1699 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1700 aba9c984 2019-09-08 stsp .Pa .git/config
1701 aba9c984 2019-09-08 stsp file will override the value of
1702 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1703 c9956ddf 2019-09-08 stsp However, the
1704 c9956ddf 2019-09-08 stsp .Dv user.name
1706 c9956ddf 2019-09-08 stsp .Dv user.email
1707 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1708 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1709 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1710 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1711 c9956ddf 2019-09-08 stsp environment variable is
1714 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1715 23594da9 2019-05-13 stsp The editor spawned by
1716 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1717 8e7bd50a 2019-08-22 stsp .Cm got import ,
1719 8e7bd50a 2019-08-22 stsp .Cm got tag .
1720 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1721 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1722 b1ebc001 2019-08-13 stsp .Cm got log .
1723 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1724 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1726 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1727 5c860e29 2018-03-12 stsp .Ex -std got
1728 97925469 2018-03-17 stsp .Sh EXAMPLES
1729 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1732 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1733 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1735 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1736 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1738 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1739 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1741 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1743 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1744 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1745 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1747 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1748 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1750 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1752 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1754 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1756 e70c17ce 2019-05-22 stsp .Dl $ got status
1757 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1759 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1761 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1763 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1765 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1767 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1768 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1769 d83d9d5c 2019-05-13 stsp which is forked off the
1770 d83d9d5c 2019-05-13 stsp .Dq master
1773 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1775 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1776 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1777 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1779 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1781 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1782 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1784 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1786 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1787 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1788 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1790 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1792 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1794 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1796 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1797 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1798 5b666081 2020-02-24 stsp .Pa sys/uvm :
1800 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1802 5b666081 2020-02-24 stsp And this command has the same effect:
1804 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1806 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1808 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1809 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1811 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1812 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1814 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1816 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1817 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1818 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1820 95fc3404 2019-07-15 stsp .Dl $ got update
1822 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1823 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1824 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1826 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1827 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1828 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1829 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1831 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1832 469dd726 2020-03-20 stsp .Dq origin/master
1835 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1836 469dd726 2020-03-20 stsp .Dl $ got fetch
1838 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1839 469dd726 2020-03-20 stsp .Cm git clone --bare
1841 469dd726 2020-03-20 stsp .Xr git-fetch 1
1842 469dd726 2020-03-20 stsp command must be used instead:
1844 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1845 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1847 469dd726 2020-03-20 stsp Rebase the local
1848 469dd726 2020-03-20 stsp .Dq master
1849 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1850 469dd726 2020-03-20 stsp .Dq origin/master
1853 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1854 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1855 469dd726 2020-03-20 stsp .Dl $ got rebase master
1857 fa6e0e48 2019-05-23 stsp Rebase the
1858 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1859 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1860 fa6e0e48 2019-05-23 stsp .Dq master
1863 818c7501 2019-07-11 stsp .Dl $ got update -b master
1864 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1866 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1867 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1868 1dd86744 2019-08-12 anthony .Ox Ns 's
1869 1dd86744 2019-08-12 anthony CVS tree:
1871 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1873 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1874 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1877 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1878 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1879 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1881 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1882 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1883 bf390dec 2020-03-20 stsp branch back into the
1884 bf390dec 2020-03-20 stsp .Dq master
1885 bf390dec 2020-03-20 stsp branch, the
1886 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1887 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1888 bf390dec 2020-03-20 stsp .Dq master
1891 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1892 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1894 bf390dec 2020-03-20 stsp Changes on the
1895 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1896 bf390dec 2020-03-20 stsp branch can now be made visible on the
1897 bf390dec 2020-03-20 stsp .Dq master
1898 bf390dec 2020-03-20 stsp branch with
1899 bf390dec 2020-03-20 stsp .Cm got integrate .
1900 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1901 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1902 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1903 bf390dec 2020-03-20 stsp .Dq master
1904 bf390dec 2020-03-20 stsp branch before the
1905 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1906 bf390dec 2020-03-20 stsp branch can be integrated into
1907 bf390dec 2020-03-20 stsp .Dq master :
1909 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1910 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1912 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1913 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1914 7b3fde24 2019-07-28 stsp .Cm git push .
1915 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1916 469dd726 2020-03-20 stsp .Cm git clone --bare
1917 7848a0e1 2020-03-19 stsp instead of
1918 7848a0e1 2020-03-19 stsp .Cm got clone ,
1920 ff2cf171 2019-07-28 stsp .Dq refspec
1921 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1923 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1924 ff2cf171 2019-07-28 stsp namespace of the local repository.
1925 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1926 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1927 ff2cf171 2019-07-28 stsp configuration variable to the value
1928 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1930 ff2cf171 2019-07-28 stsp .Cm git config
1933 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1934 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1935 469dd726 2020-03-20 stsp Additionally, the
1936 469dd726 2020-03-20 stsp .Dq mirror
1937 469dd726 2020-03-20 stsp option must be disabled:
1939 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1940 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1942 ff2cf171 2019-07-28 stsp Alternatively, the following
1943 469dd726 2020-03-20 stsp .Xr git-fetch 1
1944 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1945 ff2cf171 2019-07-28 stsp .Pa config
1948 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1949 ff2cf171 2019-07-28 stsp .Dl url = ...
1950 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1951 469dd726 2020-03-20 stsp .Dl mirror = false
1953 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1954 ff2cf171 2019-07-28 stsp .Dq refs/heads
1955 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1956 ff2cf171 2019-07-28 stsp .Cm got checkout
1957 ff2cf171 2019-07-28 stsp and, if needed, created with
1958 ff2cf171 2019-07-28 stsp .Cm got branch .
1960 ff2cf171 2019-07-28 stsp Branches in the
1961 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1962 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1963 ff2cf171 2019-07-28 stsp repository with
1964 469dd726 2020-03-20 stsp .Cm got fetch
1966 469dd726 2020-03-20 stsp .Xr git-fetch 1
1967 469dd726 2020-03-20 stsp without extra command line arguments:
1969 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1970 469dd726 2020-03-20 stsp .Dl $ git fetch
1972 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1973 ff2cf171 2019-07-28 stsp .Dq master
1974 7b0db533 2020-02-04 stsp branch, the
1975 ff2cf171 2019-07-28 stsp .Dq master
1976 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1977 ff2cf171 2019-07-28 stsp .Dq origin/master
1979 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1981 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1982 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1985 083957f4 2020-02-24 stsp .Dq master
1986 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1988 083957f4 2020-02-24 stsp by other developers and any other important new information:
1990 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1991 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1993 7b0db533 2020-02-04 stsp Local changes on the
1994 ff2cf171 2019-07-28 stsp .Dq master
1995 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1996 ff2cf171 2019-07-28 stsp repository with
1997 ff2cf171 2019-07-28 stsp .Cm git push :
1999 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
2000 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
2001 5c860e29 2018-03-12 stsp .Sh SEE ALSO
2002 2312fc47 2019-07-15 stsp .Xr tog 1 ,
2003 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
2004 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
2005 1a208aaf 2018-04-01 stsp .Sh AUTHORS
2006 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
2007 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2008 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2009 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2010 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2012 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
2013 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2015 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
2016 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
