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 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
266 2ab43947 2020-03-18 stsp The same option will be passed to
268 2ab43947 2020-03-18 stsp if applicable.
269 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
270 2ab43947 2020-03-18 stsp The maximum is 3.
273 267fe567 2020-03-18 stsp Short alias for
274 267fe567 2020-03-18 stsp .Cm clone .
275 41b0de12 2020-03-21 stsp .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
276 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
278 4ba14133 2020-03-20 stsp .Ar remote-repository
279 4ba14133 2020-03-20 stsp is specified,
281 7848a0e1 2020-03-19 stsp will be used.
282 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
284 f8ab0c60 2020-03-20 stsp file of the local repository, as created by
285 7848a0e1 2020-03-19 stsp .Cm got clone .
287 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
288 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
289 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
291 7848a0e1 2020-03-19 stsp Branch references in the
292 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
293 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
295 7848a0e1 2020-03-19 stsp .Cm got rebase
296 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
297 7848a0e1 2020-03-19 stsp .Dq refs/heads/
298 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
300 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
301 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
302 469dd726 2020-03-20 stsp repository, including branches in the
303 469dd726 2020-03-20 stsp .Dq refs/heads/
304 469dd726 2020-03-20 stsp reference namespace.
305 175367bd 2020-03-20 stsp If those branches contained local commits, these commits will no longer be
306 175367bd 2020-03-20 stsp reachable via a reference and will therefore be at risk of being discarded
307 175367bd 2020-03-20 stsp by Git's garbage collector.
309 469dd726 2020-03-20 stsp In any case, existing references in the
310 7848a0e1 2020-03-19 stsp .Dq refs/tags/
311 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
312 469dd726 2020-03-20 stsp repository.
314 7848a0e1 2020-03-19 stsp The options for
315 7848a0e1 2020-03-19 stsp .Cm got fetch
316 7848a0e1 2020-03-19 stsp are as follows:
317 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
319 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
320 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
321 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
322 4ba14133 2020-03-20 stsp Cannot be used together with the
325 4ba14133 2020-03-20 stsp .It Fl b Ar branch
326 4ba14133 2020-03-20 stsp Fetch the specified
328 4ba14133 2020-03-20 stsp from the remote repository.
329 4ba14133 2020-03-20 stsp This option may be specified multiple times to build a list of branches
331 4ba14133 2020-03-20 stsp If this option is not specified, a branch resolved via the remote
332 4ba14133 2020-03-20 stsp repository's HEAD reference will be fetched.
333 4ba14133 2020-03-20 stsp Cannot be used together with the
337 41b0de12 2020-03-21 stsp List branches and tags available for fetching from the remote repository
338 41b0de12 2020-03-21 stsp and exit immediately.
339 41b0de12 2020-03-21 stsp Cannot be used together with any of the other options except
343 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
344 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
345 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
346 7848a0e1 2020-03-19 stsp working directory.
347 7848a0e1 2020-03-19 stsp If this directory is a
349 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
351 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
352 7848a0e1 2020-03-19 stsp The same option will be passed to
354 7848a0e1 2020-03-19 stsp if applicable.
356 7848a0e1 2020-03-19 stsp Increase the verbosity of progress reporting output.
357 7848a0e1 2020-03-19 stsp The same option will be passed to
359 7848a0e1 2020-03-19 stsp if applicable.
360 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
361 7848a0e1 2020-03-19 stsp The maximum is 3.
364 7848a0e1 2020-03-19 stsp Short alias for
365 7848a0e1 2020-03-19 stsp .Cm fetch .
366 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
367 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
368 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
369 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
370 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
371 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
375 5d7c1dab 2018-04-01 stsp .Ar work tree path
376 c844a238 2019-02-06 stsp is not specified, either use the last component of
377 5d7c1dab 2018-04-01 stsp .Ar repository path ,
379 5d7c1dab 2018-04-01 stsp .Ar path prefix
380 c844a238 2019-02-06 stsp was specified use the last component of
381 5d7c1dab 2018-04-01 stsp .Ar path prefix .
383 38e11793 2018-06-13 stsp The options for
384 38e11793 2018-06-13 stsp .Cm got checkout
385 38e11793 2018-06-13 stsp are as follows:
386 38e11793 2018-06-13 stsp .Bl -tag -width Ds
388 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
389 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
390 bb51a5b4 2020-01-13 stsp is not empty.
391 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
392 08573d5b 2019-05-14 stsp .It Fl b Ar branch
393 3c575567 2019-07-28 stsp Check out files from a commit on the specified
394 08573d5b 2019-05-14 stsp .Ar branch .
395 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
396 08573d5b 2019-05-14 stsp reference will be used.
397 8069f636 2019-01-12 stsp .It Fl c Ar commit
398 8069f636 2019-01-12 stsp Check out files from the specified
400 3c575567 2019-07-28 stsp on the selected branch.
401 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
402 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
403 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
404 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
405 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
406 08573d5b 2019-05-14 stsp branch will be used.
408 4b6c9460 2020-03-05 stsp If the specified
410 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
411 4b6c9460 2020-03-05 stsp this commit must be specified with the
414 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
415 4b6c9460 2020-03-05 stsp commit with
416 4b6c9460 2020-03-05 stsp .Cm got branch
418 4b6c9460 2020-03-05 stsp .Cm got checkout
419 4b6c9460 2020-03-05 stsp can be used.
420 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
421 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
422 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
423 38e11793 2018-06-13 stsp Only files beneath the specified
424 38e11793 2018-06-13 stsp .Ar path-prefix
425 38e11793 2018-06-13 stsp will be checked out.
428 97b3a7be 2019-07-09 stsp Short alias for
429 97b3a7be 2019-07-09 stsp .Cm checkout .
430 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
431 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
432 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
433 7f838b36 2019-02-08 stsp .Bl -column YXZ description
434 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
435 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
436 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
437 7f838b36 2019-02-08 stsp .It D Ta file was deleted
438 7f838b36 2019-02-08 stsp .It A Ta new file was added
439 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
440 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
445 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
446 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
447 f2ea84fa 2019-07-27 stsp specified paths.
448 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
449 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
450 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
453 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
454 c4cdcb68 2019-04-03 stsp multiple base commits.
455 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
456 47ec7be7 2019-05-12 stsp .Cm got update
457 47ec7be7 2019-05-12 stsp across the entire work tree.
458 024e9686 2019-05-14 stsp Specifying a
460 024e9686 2019-05-14 stsp is incompatible with the
464 4ed9f614 2019-08-04 stsp .Cm got update
465 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
466 4ed9f614 2019-08-04 stsp If changes have been staged with
467 4ed9f614 2019-08-04 stsp .Cm got stage ,
468 bc3056e3 2019-08-18 stsp these changes must first be committed with
469 4ed9f614 2019-08-04 stsp .Cm got commit
470 4ed9f614 2019-08-04 stsp or unstaged with
471 4ed9f614 2019-08-04 stsp .Cm got unstage .
473 507dc3bb 2018-12-29 stsp The options for
474 507dc3bb 2018-12-29 stsp .Cm got update
475 507dc3bb 2018-12-29 stsp are as follows:
476 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
477 024e9686 2019-05-14 stsp .It Fl b Ar branch
478 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
480 024e9686 2019-05-14 stsp before updating the work tree.
481 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
482 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
483 507dc3bb 2018-12-29 stsp Update the work tree to the specified
484 507dc3bb 2018-12-29 stsp .Ar commit .
485 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
486 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
487 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
488 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
489 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
490 024e9686 2019-05-14 stsp branch will be used.
493 97b3a7be 2019-07-09 stsp Short alias for
494 97b3a7be 2019-07-09 stsp .Cm update .
495 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
496 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
497 6bad629b 2019-02-04 stsp using the following status codes:
498 6bad629b 2019-02-04 stsp .Bl -column YXZ description
499 6bad629b 2019-02-04 stsp .It M Ta modified file
500 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
501 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
502 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
503 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
504 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
505 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
507 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
508 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
510 2a06fe5f 2019-08-24 stsp specified on the command line
515 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
516 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
518 4ed9f614 2019-08-04 stsp If changes have been staged with
519 4ed9f614 2019-08-04 stsp .Cm got stage ,
520 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
521 4ed9f614 2019-08-04 stsp status codes:
522 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
523 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
524 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
525 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
528 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
529 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
530 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
531 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
534 6841da00 2019-08-08 stsp For compatibility with
537 bd8de430 2019-10-04 stsp .Xr git 1 ,
538 6841da00 2019-08-08 stsp .Cm got status
541 bd8de430 2019-10-04 stsp patterns from
542 6841da00 2019-08-08 stsp .Pa .cvsignore
544 bd8de430 2019-10-04 stsp .Pa .gitignore
545 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
546 bd8de430 2019-10-04 stsp which match these patterns.
547 bd8de430 2019-10-04 stsp As an extension to
549 bd8de430 2019-10-04 stsp matching rules,
550 bd8de430 2019-10-04 stsp .Cm got status
551 bd8de430 2019-10-04 stsp supports consecutive asterisks,
553 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
555 6841da00 2019-08-08 stsp .Xr cvs 1 ,
556 6841da00 2019-08-08 stsp .Cm got status
557 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
559 bd8de430 2019-10-04 stsp .Xr git 1 ,
560 bd8de430 2019-10-04 stsp .Cm got status
561 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
563 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
565 bd8de430 2019-10-04 stsp in a pattern.
567 97b3a7be 2019-07-09 stsp Short alias for
568 97b3a7be 2019-07-09 stsp .Cm status .
569 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
570 38e11793 2018-06-13 stsp Display history of a repository.
573 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
574 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
576 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
577 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
578 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
580 38e11793 2018-06-13 stsp The options for
581 38e11793 2018-06-13 stsp .Cm got log
582 38e11793 2018-06-13 stsp are as follows:
583 38e11793 2018-06-13 stsp .Bl -tag -width Ds
585 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
586 1137e0ae 2020-01-27 stsp from other branches.
587 48c8c60d 2020-01-27 stsp By default,
588 48c8c60d 2020-01-27 stsp .Cm got log
589 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
590 38e11793 2018-06-13 stsp .It Fl c Ar commit
591 38e11793 2018-06-13 stsp Start traversing history at the specified
592 38e11793 2018-06-13 stsp .Ar commit .
593 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
594 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
595 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
596 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
597 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
598 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
599 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
600 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
602 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
603 6238ee32 2018-06-13 stsp .It Fl l Ar N
604 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
605 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
606 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
608 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
609 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
611 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
614 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
615 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
616 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
617 6841bf13 2019-11-29 kn regular expression
618 6841bf13 2019-11-29 kn .Ar search-pattern .
619 6841bf13 2019-11-29 kn Regular expression syntax is documented in
620 6841bf13 2019-11-29 kn .Xr re_format 7 .
621 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
622 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
623 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
624 04ca23f4 2018-07-16 stsp working directory.
625 e9cf2e30 2019-02-05 stsp If this directory is a
627 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
629 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
630 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
631 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
634 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
636 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
637 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
638 d24820bf 2019-08-11 stsp corresponding objects.
639 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
640 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
641 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
643 c0cc5c62 2018-10-18 stsp The options for
644 c0cc5c62 2018-10-18 stsp .Cm got diff
645 c0cc5c62 2018-10-18 stsp are as follows:
646 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
647 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
648 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
649 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
650 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
651 b72f483a 2019-02-05 stsp Use the repository at the specified path.
652 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
653 b72f483a 2019-02-05 stsp working directory.
654 b72f483a 2019-02-05 stsp If this directory is a
656 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
658 4ed9f614 2019-08-04 stsp Show changes staged with
659 4ed9f614 2019-08-04 stsp .Cm got stage
660 4ed9f614 2019-08-04 stsp instead of showing local changes.
661 4ed9f614 2019-08-04 stsp This option is only valid when
662 4ed9f614 2019-08-04 stsp .Cm got diff
663 4ed9f614 2019-08-04 stsp is invoked in a work tree.
665 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
668 bc26cce8 2019-08-04 stsp Short alias for
670 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
671 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
673 1ff8e573 2018-08-02 stsp The options for
674 1ff8e573 2018-08-02 stsp .Cm got blame
675 1ff8e573 2018-08-02 stsp are as follows:
676 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
677 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
678 1ff8e573 2018-08-02 stsp Start traversing history at the specified
679 1ff8e573 2018-08-02 stsp .Ar commit .
680 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
681 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
682 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
683 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
684 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
685 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
686 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
687 1ff8e573 2018-08-02 stsp working directory.
688 0c06baac 2019-02-05 stsp If this directory is a
690 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
693 bc26cce8 2019-08-04 stsp Short alias for
694 bc26cce8 2019-08-04 stsp .Cm blame .
695 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
696 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
697 5de5890b 2018-10-18 stsp directory path in the repository.
698 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
699 db0c2996 2019-02-10 stsp annotations:
700 db0c2996 2019-02-10 stsp .Bl -column YXZ description
701 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
702 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
703 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
704 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
709 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
710 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
711 0c849583 2019-02-05 stsp if there is no work tree.
713 5de5890b 2018-10-18 stsp The options for
714 5de5890b 2018-10-18 stsp .Cm got tree
715 5de5890b 2018-10-18 stsp are as follows:
716 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
717 5de5890b 2018-10-18 stsp .It Fl c Ar commit
718 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
719 5de5890b 2018-10-18 stsp .Ar commit .
720 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
721 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
722 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
723 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
724 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
725 5de5890b 2018-10-18 stsp Use the repository at the specified path.
726 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
727 5de5890b 2018-10-18 stsp working directory.
728 0c849583 2019-02-05 stsp If this directory is a
730 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
732 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
734 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
737 bc26cce8 2019-08-04 stsp Short alias for
739 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
740 d0eebce4 2019-03-11 stsp Manage references in a repository.
742 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
743 d0eebce4 2019-03-11 stsp or update, the reference with the given
745 d0eebce4 2019-03-11 stsp and make it point at the given
746 d83d9d5c 2019-05-13 stsp .Ar target .
747 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
748 f16e4044 2019-10-09 stsp .Dq refs/ .
749 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
750 a54b6686 2019-06-28 stsp will be resolved to an object ID.
751 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
752 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
754 d0eebce4 2019-03-11 stsp The options for
755 d0eebce4 2019-03-11 stsp .Cm got ref
756 d0eebce4 2019-03-11 stsp are as follows:
757 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
758 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
759 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
760 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
761 d0eebce4 2019-03-11 stsp working directory.
762 d0eebce4 2019-03-11 stsp If this directory is a
764 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
766 d0eebce4 2019-03-11 stsp List all existing references in the repository.
767 d0eebce4 2019-03-11 stsp .It Fl d Ar name
768 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
770 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
771 d1c1ae5f 2019-08-12 stsp .Ar target ,
772 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
773 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
774 d1c1ae5f 2019-08-12 stsp this option is used.
776 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
777 da76fce2 2020-02-24 stsp Create, list, or delete branches.
779 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
780 4e759de4 2019-06-26 stsp .Dq refs/heads/
781 4e759de4 2019-06-26 stsp reference namespace.
783 4e759de4 2019-06-26 stsp .Cm got branch
784 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
786 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
787 ad89fa31 2019-10-04 stsp work tree's current branch.
791 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
792 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
793 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
794 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
796 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
797 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
798 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
799 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
801 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
802 da76fce2 2020-02-24 stsp .Bl -column YXZ description
803 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
804 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
805 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
806 da76fce2 2020-02-24 stsp .It D Ta file was deleted
807 da76fce2 2020-02-24 stsp .It A Ta new file was added
808 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
809 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
812 4e759de4 2019-06-26 stsp The options for
813 4e759de4 2019-06-26 stsp .Cm got branch
814 4e759de4 2019-06-26 stsp are as follows:
815 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
816 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
817 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
818 a74f7e83 2019-11-10 stsp .Ar commit .
819 a74f7e83 2019-11-10 stsp The expected
821 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
822 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
823 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
824 4e759de4 2019-06-26 stsp Use the repository at the specified path.
825 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
826 4e759de4 2019-06-26 stsp working directory.
827 4e759de4 2019-06-26 stsp If this directory is a
829 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
831 4e759de4 2019-06-26 stsp List all existing branches in the repository.
832 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
833 ba882ee3 2019-07-11 stsp with one the following annotations:
834 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
835 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
836 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
838 4e759de4 2019-06-26 stsp .It Fl d Ar name
839 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
840 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
841 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
842 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
843 ce33d90e 2019-07-14 stsp Git's garbage collector.
845 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
848 97b3a7be 2019-07-09 stsp Short alias for
849 97b3a7be 2019-07-09 stsp .Cm branch .
850 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
851 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
853 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
854 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
855 8e7bd50a 2019-08-22 stsp reference namespace.
857 8e7bd50a 2019-08-22 stsp .Cm got tag
858 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
859 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
860 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
862 80106605 2020-02-24 stsp Attempt to create a tag with the given
864 8e7bd50a 2019-08-22 stsp and make this tag point at the given
865 8e7bd50a 2019-08-22 stsp .Ar commit .
866 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
867 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
868 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
870 8e7bd50a 2019-08-22 stsp The options for
871 8e7bd50a 2019-08-22 stsp .Cm got tag
872 8e7bd50a 2019-08-22 stsp are as follows:
873 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
874 80106605 2020-02-24 stsp .It Fl c Ar commit
875 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
876 80106605 2020-02-24 stsp .Ar commit .
877 80106605 2020-02-24 stsp The expected
879 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
880 80106605 2020-02-24 stsp will be resolved to a commit ID.
881 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
882 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
883 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
884 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
885 8e7bd50a 2019-08-22 stsp Without the
888 3a62228f 2019-11-08 stsp .Cm got tag
889 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
890 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
891 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
892 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
893 8e7bd50a 2019-08-22 stsp working directory.
894 8e7bd50a 2019-08-22 stsp If this directory is a
896 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
898 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
899 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
902 8e7bd50a 2019-08-22 stsp By design, the
903 8e7bd50a 2019-08-22 stsp .Cm got tag
904 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
905 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
906 8e7bd50a 2019-08-22 stsp .Cm got ref
907 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
908 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
909 8e7bd50a 2019-08-22 stsp another repository.
910 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
911 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
912 d00136be 2019-03-26 stsp repository in the next commit.
914 4e68cba3 2019-11-23 stsp The options for
915 4e68cba3 2019-11-23 stsp .Cm got add
916 4e68cba3 2019-11-23 stsp are as follows:
917 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
919 4e68cba3 2019-11-23 stsp Permit recursion into directories.
920 4e68cba3 2019-11-23 stsp If this option is not specified,
921 4e68cba3 2019-11-23 stsp .Cm got add
922 4e68cba3 2019-11-23 stsp will refuse to run if a specified
924 4e68cba3 2019-11-23 stsp is a directory.
926 022fae89 2019-12-06 tracey With -R, add files even if they match a
927 022fae89 2019-12-06 tracey .Cm got status
928 022fae89 2019-12-06 tracey ignore pattern.
930 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
931 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
932 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
934 2ec1f75b 2019-03-26 stsp The options for
935 86d25a1b 2019-07-11 stsp .Cm got remove
936 2ec1f75b 2019-03-26 stsp are as follows:
937 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
939 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
941 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
943 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
944 f2a9dc41 2019-12-13 tracey If this option is not specified,
945 f2a9dc41 2019-12-13 tracey .Cm got remove
946 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
948 f2a9dc41 2019-12-13 tracey is a directory.
951 648e4ef7 2019-07-09 stsp Short alias for
952 648e4ef7 2019-07-09 stsp .Cm remove .
953 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 ...
954 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
955 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
956 1dd86744 2019-08-12 anthony work tree's base commit.
957 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
958 a129376b 2019-03-28 stsp .Cm got revert !
960 e20a8b6f 2019-06-04 stsp If a file was added with
961 a129376b 2019-03-28 stsp .Cm got add
962 a129376b 2019-03-28 stsp it will become an unversioned file again.
963 e20a8b6f 2019-06-04 stsp If a file was deleted with
964 86d25a1b 2019-07-11 stsp .Cm got remove
965 a129376b 2019-03-28 stsp it will be restored.
967 0f6d7415 2019-08-08 stsp The options for
968 0f6d7415 2019-08-08 stsp .Cm got revert
969 0f6d7415 2019-08-08 stsp are as follows:
970 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
972 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
973 33aa809d 2019-08-08 stsp changes to revert based on
975 33aa809d 2019-08-08 stsp (revert change),
977 33aa809d 2019-08-08 stsp (keep change), and
979 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
980 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
981 33aa809d 2019-08-08 stsp modified file content can be reverted.
982 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
983 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
986 33aa809d 2019-08-08 stsp option, read
991 33aa809d 2019-08-08 stsp responses line-by-line from the specified
992 33aa809d 2019-08-08 stsp .Ar response-script
993 33aa809d 2019-08-08 stsp file instead of prompting interactively.
995 0f6d7415 2019-08-08 stsp Permit recursion into directories.
996 0f6d7415 2019-08-08 stsp If this option is not specified,
997 0f6d7415 2019-08-08 stsp .Cm got revert
998 0f6d7415 2019-08-08 stsp will refuse to run if a specified
1000 0f6d7415 2019-08-08 stsp is a directory.
1003 97b3a7be 2019-07-09 stsp Short alias for
1004 97b3a7be 2019-07-09 stsp .Cm revert .
1005 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1006 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
1007 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
1010 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
1011 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
1013 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
1014 1dd86744 2019-08-12 anthony .Cm got stage ,
1015 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
1016 4ed9f614 2019-08-04 stsp have not been staged.
1018 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
1019 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
1020 15cd91f7 2019-05-12 stsp .It M Ta modified file
1021 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
1022 15cd91f7 2019-05-12 stsp .It A Ta new file was added
1023 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
1026 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
1027 996d5ccd 2019-08-05 stsp recorded base commit.
1030 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
1031 15cd91f7 2019-05-12 stsp multiple base commits.
1032 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
1033 47ec7be7 2019-05-12 stsp .Cm got update
1034 47ec7be7 2019-05-12 stsp across the entire work tree.
1037 15cd91f7 2019-05-12 stsp .Cm got commit
1038 15cd91f7 2019-05-12 stsp command requires the
1039 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
1040 aba9c984 2019-09-08 stsp environment variable to be set,
1041 aba9c984 2019-09-08 stsp unless Git's
1042 aba9c984 2019-09-08 stsp .Dv user.name
1044 709ae9eb 2019-09-08 stsp .Dv user.email
1045 709ae9eb 2019-09-08 stsp configuration settings can be
1046 aba9c984 2019-09-08 stsp obtained from the repository's
1047 aba9c984 2019-09-08 stsp .Pa .git/config
1048 c9956ddf 2019-09-08 stsp file or from Git's global
1049 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1050 c9956ddf 2019-09-08 stsp configuration file.
1052 74416c47 2019-05-09 stsp The options for
1053 74416c47 2019-05-09 stsp .Cm got commit
1054 74416c47 2019-05-09 stsp are as follows:
1055 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1056 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1057 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1058 23594da9 2019-05-13 stsp Without the
1061 23594da9 2019-05-13 stsp .Cm got commit
1062 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1065 cfce0458 2019-07-28 stsp .Cm got commit
1066 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1067 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1068 916f288c 2019-07-30 stsp .Dq refs/heads/
1069 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1070 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1071 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1072 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1073 cfce0458 2019-07-28 stsp .Cm got update
1074 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1075 cfce0458 2019-07-28 stsp in the repository.
1077 97b3a7be 2019-07-09 stsp Short alias for
1078 97b3a7be 2019-07-09 stsp .Cm commit .
1079 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1080 234035bc 2019-06-01 stsp Merge changes from a single
1081 234035bc 2019-06-01 stsp .Ar commit
1082 234035bc 2019-06-01 stsp into the work tree.
1083 234035bc 2019-06-01 stsp The specified
1084 234035bc 2019-06-01 stsp .Ar commit
1085 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1086 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1087 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1088 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1090 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1091 234035bc 2019-06-01 stsp .Bl -column YXZ description
1092 234035bc 2019-06-01 stsp .It G Ta file was merged
1093 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1094 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1095 234035bc 2019-06-01 stsp .It D Ta file was deleted
1096 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1097 234035bc 2019-06-01 stsp .It A Ta new file was added
1098 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1101 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1102 234035bc 2019-06-01 stsp may be viewed with
1103 234035bc 2019-06-01 stsp .Cm got diff ,
1104 234035bc 2019-06-01 stsp amended manually or with further
1105 234035bc 2019-06-01 stsp .Cm got cherrypick
1107 234035bc 2019-06-01 stsp committed with
1108 234035bc 2019-06-01 stsp .Cm got commit ,
1109 234035bc 2019-06-01 stsp or discarded again with
1110 234035bc 2019-06-01 stsp .Cm got revert .
1112 234035bc 2019-06-01 stsp .Cm got cherrypick
1113 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1114 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1115 234035bc 2019-06-01 stsp to a single base commit with
1116 234035bc 2019-06-01 stsp .Cm got update .
1117 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1118 234035bc 2019-06-01 stsp conflicts must be resolved first.
1120 97b3a7be 2019-07-09 stsp Short alias for
1121 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1122 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1123 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1124 5ef14e63 2019-06-02 stsp .Ar commit
1125 5ef14e63 2019-06-02 stsp into the work tree.
1126 5ef14e63 2019-06-02 stsp The specified
1127 5ef14e63 2019-06-02 stsp .Ar commit
1128 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1129 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1130 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1131 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1133 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1134 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1135 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1136 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1137 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1138 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1139 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1140 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1141 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1144 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1145 5ef14e63 2019-06-02 stsp which may be viewed with
1146 5ef14e63 2019-06-02 stsp .Cm got diff ,
1147 5ef14e63 2019-06-02 stsp amended manually or with further
1148 778a73c2 2019-07-12 stsp .Cm got backout
1150 5ef14e63 2019-06-02 stsp committed with
1151 5ef14e63 2019-06-02 stsp .Cm got commit ,
1152 5ef14e63 2019-06-02 stsp or discarded again with
1153 5ef14e63 2019-06-02 stsp .Cm got revert .
1155 92228c38 2019-06-02 stsp .Cm got backout
1156 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1157 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1158 92228c38 2019-06-02 stsp to a single base commit with
1159 92228c38 2019-06-02 stsp .Cm got update .
1160 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1161 92228c38 2019-06-02 stsp conflicts must be resolved first.
1163 97b3a7be 2019-07-09 stsp Short alias for
1164 97b3a7be 2019-07-09 stsp .Cm backout .
1165 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1166 818c7501 2019-07-11 stsp Rebase commits on the specified
1167 818c7501 2019-07-11 stsp .Ar branch
1168 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1170 818c7501 2019-07-11 stsp .Ar branch
1171 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1172 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1173 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1174 818c7501 2019-07-11 stsp .Ar branch
1175 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1176 f09e2405 2019-07-11 stsp of the specified
1177 818c7501 2019-07-11 stsp .Ar branch
1178 f09e2405 2019-07-11 stsp has been rebased.
1181 2b6826ba 2020-02-24 stsp .Cm got rebase
1182 2b6826ba 2020-02-24 stsp is used as intended, the specified
1183 2b6826ba 2020-02-24 stsp .Ar branch
1184 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1185 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1186 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1187 2b6826ba 2020-02-24 stsp .Cm got update -b
1188 2b6826ba 2020-02-24 stsp before starting the
1189 2b6826ba 2020-02-24 stsp .Cm rebase
1190 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1191 2b6826ba 2020-02-24 stsp a common history with the specified
1192 2b6826ba 2020-02-24 stsp .Ar branch
1193 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1194 c10890ce 2020-02-25 stsp remote repository.
1196 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1197 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1198 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1199 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1200 818c7501 2019-07-11 stsp .Ar branch ,
1201 818c7501 2019-07-11 stsp but with different commit IDs.
1202 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1203 f09e2405 2019-07-11 stsp the new version of the specified
1204 818c7501 2019-07-11 stsp .Ar branch
1205 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1207 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1208 818c7501 2019-07-11 stsp using the following status codes:
1209 818c7501 2019-07-11 stsp .Bl -column YXZ description
1210 818c7501 2019-07-11 stsp .It G Ta file was merged
1211 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1212 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1213 818c7501 2019-07-11 stsp .It D Ta file was deleted
1214 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1215 818c7501 2019-07-11 stsp .It A Ta new file was added
1216 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1219 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1220 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1221 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1222 818c7501 2019-07-11 stsp .Ar branch
1223 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1225 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1226 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1227 f09e2405 2019-07-11 stsp when the rebase operation continues.
1229 818c7501 2019-07-11 stsp .Cm got rebase
1230 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1231 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1232 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1233 818c7501 2019-07-11 stsp .Cm got update .
1234 4ed9f614 2019-08-04 stsp If changes have been staged with
1235 4ed9f614 2019-08-04 stsp .Cm got stage ,
1236 bc3056e3 2019-08-18 stsp these changes must first be committed with
1237 4ed9f614 2019-08-04 stsp .Cm got commit
1238 4ed9f614 2019-08-04 stsp or unstaged with
1239 4ed9f614 2019-08-04 stsp .Cm got unstage .
1240 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1241 f09e2405 2019-07-11 stsp committed with
1242 f09e2405 2019-07-11 stsp .Cm got commit
1243 f09e2405 2019-07-11 stsp or reverted with
1244 f09e2405 2019-07-11 stsp .Cm got revert .
1246 64c6d990 2019-07-11 stsp .Ar branch
1247 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1248 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1251 7d5807f4 2019-07-11 stsp .Cm got update
1253 7d5807f4 2019-07-11 stsp .Cm got commit
1254 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1255 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1256 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1258 818c7501 2019-07-11 stsp The options for
1259 818c7501 2019-07-11 stsp .Cm got rebase
1260 818c7501 2019-07-11 stsp are as follows:
1261 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1263 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1264 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1266 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1267 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1270 818c7501 2019-07-11 stsp Short alias for
1271 818c7501 2019-07-11 stsp .Cm rebase .
1272 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
1273 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1274 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1276 6e54d307 2020-02-24 stsp Before starting a
1277 6e54d307 2020-02-24 stsp .Cm histedit
1278 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1279 6e54d307 2020-02-24 stsp .Cm got update -b
1280 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1281 6e54d307 2020-02-24 stsp current branch of the work tree.
1282 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1283 6e54d307 2020-02-24 stsp touched by the
1284 6e54d307 2020-02-24 stsp .Cm histedit
1285 6e54d307 2020-02-24 stsp operation.
1287 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1288 6e54d307 2020-02-24 stsp must be set with
1289 6e54d307 2020-02-24 stsp .Cm got update -c
1290 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1291 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1293 6e54d307 2020-02-24 stsp .Cm histedit
1294 6e54d307 2020-02-24 stsp operation.
1296 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1297 0ebf8283 2019-07-24 stsp .Ar histedit script
1298 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1299 46fa4c83 2020-02-24 stsp command line, or generated with the
1301 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1303 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1304 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1305 0ebf8283 2019-07-24 stsp whitespace and an argument.
1306 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1307 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1308 0ebf8283 2019-07-24 stsp Lines which begin with the
1310 0ebf8283 2019-07-24 stsp character are ignored entirely.
1312 0ebf8283 2019-07-24 stsp The available commands are as follows:
1313 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1314 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1315 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1316 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1317 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1318 0ebf8283 2019-07-24 stsp listed further below that will be used.
1319 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1320 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1321 0ebf8283 2019-07-24 stsp the commit on the previous line.
1322 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1323 0ebf8283 2019-07-24 stsp log message can be written.
1326 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1327 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1328 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1330 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1331 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1332 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1333 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1334 498a90b7 2019-07-25 stsp switched to it.
1336 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1337 0ebf8283 2019-07-24 stsp using the following status codes:
1338 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1339 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1340 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1341 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1342 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1343 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1344 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1345 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1348 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1349 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1350 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1351 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1353 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1354 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1355 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1357 0ebf8283 2019-07-24 stsp .Cm got histedit
1358 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1359 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1360 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1361 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1362 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1363 0ebf8283 2019-07-24 stsp to a single base commit with
1364 0ebf8283 2019-07-24 stsp .Cm got update .
1365 4ed9f614 2019-08-04 stsp If changes have been staged with
1366 4ed9f614 2019-08-04 stsp .Cm got stage ,
1367 bc3056e3 2019-08-18 stsp these changes must first be committed with
1368 4ed9f614 2019-08-04 stsp .Cm got commit
1369 4ed9f614 2019-08-04 stsp or unstaged with
1370 4ed9f614 2019-08-04 stsp .Cm got unstage .
1371 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1372 0ebf8283 2019-07-24 stsp committed with
1373 0ebf8283 2019-07-24 stsp .Cm got commit
1374 0ebf8283 2019-07-24 stsp or reverted with
1375 0ebf8283 2019-07-24 stsp .Cm got revert .
1376 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1377 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1380 7ef62c4e 2020-02-24 stsp .Cm got update ,
1381 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1383 65db4ffb 2020-02-24 stsp .Cm got integrate
1384 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1385 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1386 0ebf8283 2019-07-24 stsp .Cm got commit
1387 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1388 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1390 0ebf8283 2019-07-24 stsp The options for
1391 0ebf8283 2019-07-24 stsp .Cm got histedit
1392 0ebf8283 2019-07-24 stsp are as follows:
1393 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1395 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1396 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1398 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1399 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1400 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1401 ddbfac99 2020-02-24 stsp Use the specified
1402 ddbfac99 2020-02-24 stsp .Ar histedit-script
1403 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1404 ddbfac99 2020-02-24 stsp can be written.
1406 083957f4 2020-02-24 stsp Edit log messages only.
1407 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1408 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1411 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1412 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1415 0ebf8283 2019-07-24 stsp Short alias for
1416 0ebf8283 2019-07-24 stsp .Cm histedit .
1417 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1418 2822a352 2019-10-15 stsp Integrate the specified
1419 2822a352 2019-10-15 stsp .Ar branch
1420 2822a352 2019-10-15 stsp into the work tree's current branch.
1421 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1422 2822a352 2019-10-15 stsp .Ar branch ,
1423 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1424 2822a352 2019-10-15 stsp head commit of the integrated
1425 2822a352 2019-10-15 stsp .Ar branch .
1427 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1428 2822a352 2019-10-15 stsp will be pointing at the same commit.
1429 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1430 2822a352 2019-10-15 stsp In case the integrated
1431 2822a352 2019-10-15 stsp .Ar branch
1432 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1433 2822a352 2019-10-15 stsp .Cm got branch -d .
1435 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1436 2822a352 2019-10-15 stsp .Bl -column YXZ description
1437 2822a352 2019-10-15 stsp .It U Ta file was updated
1438 2822a352 2019-10-15 stsp .It D Ta file was deleted
1439 2822a352 2019-10-15 stsp .It A Ta new file was added
1440 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1441 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1444 2822a352 2019-10-15 stsp .Cm got integrate
1445 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1446 2822a352 2019-10-15 stsp Most importantly, the
1447 2822a352 2019-10-15 stsp .Ar branch
1448 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1449 2822a352 2019-10-15 stsp .Cm got rebase
1450 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1451 2822a352 2019-10-15 stsp resolve merge conflicts.
1452 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1453 2822a352 2019-10-15 stsp to a single base commit with
1454 2822a352 2019-10-15 stsp .Cm got update .
1455 2822a352 2019-10-15 stsp If changes have been staged with
1456 2822a352 2019-10-15 stsp .Cm got stage ,
1457 2822a352 2019-10-15 stsp these changes must first be committed with
1458 2822a352 2019-10-15 stsp .Cm got commit
1459 2822a352 2019-10-15 stsp or unstaged with
1460 2822a352 2019-10-15 stsp .Cm got unstage .
1461 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1462 2822a352 2019-10-15 stsp committed with
1463 2822a352 2019-10-15 stsp .Cm got commit
1464 2822a352 2019-10-15 stsp or reverted with
1465 2822a352 2019-10-15 stsp .Cm got revert .
1467 2822a352 2019-10-15 stsp Short alias for
1468 2822a352 2019-10-15 stsp .Cm integrate .
1469 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 ...
1470 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1473 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1474 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1475 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1476 4ed9f614 2019-08-04 stsp .Cm got status .
1478 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1479 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1480 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1481 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1482 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1485 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1486 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1487 9d8b19a4 2019-08-04 stsp committed.
1489 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1490 4ed9f614 2019-08-04 stsp .Cm got commit ,
1491 4ed9f614 2019-08-04 stsp .Cm got status ,
1493 4ed9f614 2019-08-04 stsp .Cm got diff .
1494 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1495 4ed9f614 2019-08-04 stsp .Cm got commit
1496 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1497 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1498 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1500 4ed9f614 2019-08-04 stsp .Cm got status
1501 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1503 4ed9f614 2019-08-04 stsp .Cm got diff
1504 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1505 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1507 4ed9f614 2019-08-04 stsp .Cm got revert
1508 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1509 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1511 4ed9f614 2019-08-04 stsp The options for
1512 4ed9f614 2019-08-04 stsp .Cm got stage
1513 4ed9f614 2019-08-04 stsp are as follows:
1514 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1516 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1517 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1518 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1519 1dd86744 2019-08-12 anthony among the specified paths.
1520 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1522 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1523 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1525 6d23ec10 2019-08-08 stsp (stage change),
1527 6d23ec10 2019-08-08 stsp (reject change), and
1529 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1530 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1531 dc424a06 2019-08-07 stsp modified file content can be staged.
1532 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1533 6d23ec10 2019-08-08 stsp their entirety.
1534 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1537 3a070a2b 2019-08-07 stsp option, read
1542 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1543 0e2f5884 2019-08-07 stsp .Ar response-script
1544 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1547 4ed9f614 2019-08-04 stsp .Cm got stage
1548 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1549 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1550 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1551 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1552 4ed9f614 2019-08-04 stsp .Cm got update
1553 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1554 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1557 4ed9f614 2019-08-04 stsp .Cm got update ,
1558 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1560 4ed9f614 2019-08-04 stsp .Cm got histedit
1561 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1562 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1563 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1564 4ed9f614 2019-08-04 stsp .Cm got unstage
1565 4ed9f614 2019-08-04 stsp before it can be updated with
1566 4ed9f614 2019-08-04 stsp .Cm got update ,
1567 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1569 4ed9f614 2019-08-04 stsp Short alias for
1570 4ed9f614 2019-08-04 stsp .Cm stage .
1571 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1572 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1573 4ed9f614 2019-08-04 stsp back into non-staged status.
1576 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1577 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1579 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1580 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1581 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1582 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1583 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1584 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1585 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1586 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1589 2e1f37b0 2019-08-08 stsp The options for
1590 2e1f37b0 2019-08-08 stsp .Cm got unstage
1591 2e1f37b0 2019-08-08 stsp are as follows:
1592 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1594 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1595 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1597 2e1f37b0 2019-08-08 stsp (unstage change),
1599 2e1f37b0 2019-08-08 stsp (keep change staged), and
1601 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1602 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1603 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1604 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1605 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1608 2e1f37b0 2019-08-08 stsp option, read
1613 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1614 2e1f37b0 2019-08-08 stsp .Ar response-script
1615 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1618 4ed9f614 2019-08-04 stsp Short alias for
1619 4ed9f614 2019-08-04 stsp .Cm unstage .
1620 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 ...
1621 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1622 896e9b6f 2019-08-26 stsp text format.
1623 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1624 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1625 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1627 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1628 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1629 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1630 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1631 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1632 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1634 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1636 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1637 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1639 01073a5d 2019-08-22 stsp The options for
1640 01073a5d 2019-08-22 stsp .Cm got cat
1641 01073a5d 2019-08-22 stsp are as follows:
1642 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1643 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1644 896e9b6f 2019-08-26 stsp Look up paths in the specified
1645 896e9b6f 2019-08-26 stsp .Ar commit .
1646 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1647 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1648 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1649 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1650 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1651 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1652 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1653 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1654 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1655 01073a5d 2019-08-22 stsp working directory.
1656 01073a5d 2019-08-22 stsp If this directory is a
1658 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1660 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1661 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1662 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1665 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1666 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1667 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1668 74416c47 2019-05-09 stsp The author's name and email address for
1669 21a44f98 2019-07-15 stsp .Cm got commit
1671 21a44f98 2019-07-15 stsp .Cm got import ,
1672 74416c47 2019-05-09 stsp for example:
1673 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1676 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1678 84792843 2019-08-09 stsp attempts to reject
1679 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1680 84792843 2019-08-09 stsp environment variables with a missing email address.
1682 c9956ddf 2019-09-08 stsp If present, Git's
1683 aba9c984 2019-09-08 stsp .Dv user.name
1685 709ae9eb 2019-09-08 stsp .Dv user.email
1686 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1687 aba9c984 2019-09-08 stsp .Pa .git/config
1688 aba9c984 2019-09-08 stsp file will override the value of
1689 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1690 c9956ddf 2019-09-08 stsp However, the
1691 c9956ddf 2019-09-08 stsp .Dv user.name
1693 c9956ddf 2019-09-08 stsp .Dv user.email
1694 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1695 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1696 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1697 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1698 c9956ddf 2019-09-08 stsp environment variable is
1701 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1702 23594da9 2019-05-13 stsp The editor spawned by
1703 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1704 8e7bd50a 2019-08-22 stsp .Cm got import ,
1706 8e7bd50a 2019-08-22 stsp .Cm got tag .
1707 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1708 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1709 b1ebc001 2019-08-13 stsp .Cm got log .
1710 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1711 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1712 858b0dfb 2020-03-20 stsp .It Ev GOT_FETCH_DEBUG
1713 858b0dfb 2020-03-20 stsp Enables protocol tracing on standard error output during
1714 858b0dfb 2020-03-20 stsp .Cm got clone
1716 858b0dfb 2020-03-20 stsp .Cm got fetch .
1718 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1719 5c860e29 2018-03-12 stsp .Ex -std got
1720 97925469 2018-03-17 stsp .Sh EXAMPLES
1721 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1724 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1725 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1727 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1728 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1730 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1731 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1733 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1735 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1736 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1737 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1739 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1740 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1742 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1744 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1746 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1748 e70c17ce 2019-05-22 stsp .Dl $ got status
1749 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1751 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1753 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1755 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1757 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1759 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1760 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1761 d83d9d5c 2019-05-13 stsp which is forked off the
1762 d83d9d5c 2019-05-13 stsp .Dq master
1765 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1767 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1768 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1769 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1771 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1773 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1774 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1776 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1778 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1779 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1780 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1782 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1784 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1786 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1788 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1789 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1790 5b666081 2020-02-24 stsp .Pa sys/uvm :
1792 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1794 5b666081 2020-02-24 stsp And this command has the same effect:
1796 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1798 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1800 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1801 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1803 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1804 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1806 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1808 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1809 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1810 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1812 95fc3404 2019-07-15 stsp .Dl $ got update
1814 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1815 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1816 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1818 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1819 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1820 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1821 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1823 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1824 469dd726 2020-03-20 stsp .Dq origin/master
1827 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1828 469dd726 2020-03-20 stsp .Dl $ got fetch
1830 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1831 469dd726 2020-03-20 stsp .Cm git clone --bare
1833 469dd726 2020-03-20 stsp .Xr git-fetch 1
1834 469dd726 2020-03-20 stsp command must be used instead:
1836 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1837 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1839 469dd726 2020-03-20 stsp Rebase the local
1840 469dd726 2020-03-20 stsp .Dq master
1841 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1842 469dd726 2020-03-20 stsp .Dq origin/master
1845 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1846 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1847 469dd726 2020-03-20 stsp .Dl $ got rebase master
1849 fa6e0e48 2019-05-23 stsp Rebase the
1850 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1851 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1852 fa6e0e48 2019-05-23 stsp .Dq master
1855 818c7501 2019-07-11 stsp .Dl $ got update -b master
1856 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1858 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1859 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1860 1dd86744 2019-08-12 anthony .Ox Ns 's
1861 1dd86744 2019-08-12 anthony CVS tree:
1863 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1865 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1866 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1869 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1870 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1871 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1873 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1874 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1875 bf390dec 2020-03-20 stsp branch back into the
1876 bf390dec 2020-03-20 stsp .Dq master
1877 bf390dec 2020-03-20 stsp branch, the
1878 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1879 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1880 bf390dec 2020-03-20 stsp .Dq master
1883 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1884 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1886 bf390dec 2020-03-20 stsp Changes on the
1887 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1888 bf390dec 2020-03-20 stsp branch can now be made visible on the
1889 bf390dec 2020-03-20 stsp .Dq master
1890 bf390dec 2020-03-20 stsp branch with
1891 bf390dec 2020-03-20 stsp .Cm got integrate .
1892 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1893 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1894 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1895 bf390dec 2020-03-20 stsp .Dq master
1896 bf390dec 2020-03-20 stsp branch before the
1897 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1898 bf390dec 2020-03-20 stsp branch can be integrated into
1899 bf390dec 2020-03-20 stsp .Dq master :
1901 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1902 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1904 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1905 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1906 7b3fde24 2019-07-28 stsp .Cm git push .
1907 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1908 469dd726 2020-03-20 stsp .Cm git clone --bare
1909 7848a0e1 2020-03-19 stsp instead of
1910 7848a0e1 2020-03-19 stsp .Cm got clone ,
1912 ff2cf171 2019-07-28 stsp .Dq refspec
1913 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1915 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1916 ff2cf171 2019-07-28 stsp namespace of the local repository.
1917 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1918 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1919 ff2cf171 2019-07-28 stsp configuration variable to the value
1920 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1922 ff2cf171 2019-07-28 stsp .Cm git config
1925 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1926 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1927 469dd726 2020-03-20 stsp Additionally, the
1928 469dd726 2020-03-20 stsp .Dq mirror
1929 469dd726 2020-03-20 stsp option must be disabled:
1931 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1932 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1934 ff2cf171 2019-07-28 stsp Alternatively, the following
1935 469dd726 2020-03-20 stsp .Xr git-fetch 1
1936 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1937 ff2cf171 2019-07-28 stsp .Pa config
1940 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1941 ff2cf171 2019-07-28 stsp .Dl url = ...
1942 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1943 469dd726 2020-03-20 stsp .Dl mirror = false
1945 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1946 ff2cf171 2019-07-28 stsp .Dq refs/heads
1947 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1948 ff2cf171 2019-07-28 stsp .Cm got checkout
1949 ff2cf171 2019-07-28 stsp and, if needed, created with
1950 ff2cf171 2019-07-28 stsp .Cm got branch .
1952 ff2cf171 2019-07-28 stsp Branches in the
1953 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1954 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1955 ff2cf171 2019-07-28 stsp repository with
1956 469dd726 2020-03-20 stsp .Cm got fetch
1958 469dd726 2020-03-20 stsp .Xr git-fetch 1
1959 469dd726 2020-03-20 stsp without extra command line arguments:
1961 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1962 469dd726 2020-03-20 stsp .Dl $ git fetch
1964 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1965 ff2cf171 2019-07-28 stsp .Dq master
1966 7b0db533 2020-02-04 stsp branch, the
1967 ff2cf171 2019-07-28 stsp .Dq master
1968 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1969 ff2cf171 2019-07-28 stsp .Dq origin/master
1971 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1973 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1974 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1977 083957f4 2020-02-24 stsp .Dq master
1978 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1980 083957f4 2020-02-24 stsp by other developers and any other important new information:
1982 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1983 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1985 7b0db533 2020-02-04 stsp Local changes on the
1986 ff2cf171 2019-07-28 stsp .Dq master
1987 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1988 ff2cf171 2019-07-28 stsp repository with
1989 ff2cf171 2019-07-28 stsp .Cm git push :
1991 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1992 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1993 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1994 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1995 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1996 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1997 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1998 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1999 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
2000 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
2001 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
2002 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
2004 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
2005 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
2007 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
2008 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
