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 2ab43947 2020-03-18 stsp .It Cm clone Oo Fl q Oc Oo Fl v Oc Ar repository-URL Op Ar target-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 2ab43947 2020-03-18 stsp .Ar target-directory .
145 2ab43947 2020-03-18 stsp .Ar target-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 2ab43947 2020-03-18 stsp .Ar target-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 2ab43947 2020-03-18 stsp This protocol is discouraged since it supports neither authentication nor
167 2ab43947 2020-03-18 stsp 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 7848a0e1 2020-03-19 stsp .Cm got clone
181 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
183 7848a0e1 2020-03-19 stsp file of the cloned repository to store the
184 7848a0e1 2020-03-19 stsp .Ar repository-url
185 7848a0e1 2020-03-19 stsp for future use by
186 7848a0e1 2020-03-19 stsp .Cm got fetch
188 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
190 2ab43947 2020-03-18 stsp The options for
191 2ab43947 2020-03-18 stsp .Cm got clone
192 2ab43947 2020-03-18 stsp are as follows:
193 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
195 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
196 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
197 469dd726 2020-03-20 stsp local changes as created by
198 469dd726 2020-03-20 stsp .Cm got commit .
200 469dd726 2020-03-20 stsp The repository's
202 469dd726 2020-03-20 stsp file will be set up with the
204 469dd726 2020-03-20 stsp option enabled, such that
205 469dd726 2020-03-20 stsp .Cm got fetch
207 469dd726 2020-03-20 stsp .Xr git-fetch 1
208 469dd726 2020-03-20 stsp will write incoming changes directly to branches in the
209 469dd726 2020-03-20 stsp .Dq refs/heads/
210 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
211 469dd726 2020-03-20 stsp .Dq refs/remotes/
213 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
214 469dd726 2020-03-20 stsp .Cm got rebase
216 469dd726 2020-03-20 stsp .Cm got fetch
217 469dd726 2020-03-20 stsp in order to make incoming changes appear on branches in the
218 469dd726 2020-03-20 stsp .Dq refs/heads/
220 469dd726 2020-03-20 stsp But maintaining custom branches with local changes in the cloned
221 469dd726 2020-03-20 stsp repository becomes difficult since local changes are at risk of
222 469dd726 2020-03-20 stsp being discarded whenever incoming changes are fetched.
224 2ab43947 2020-03-18 stsp Suppress progress reporting output.
225 2ab43947 2020-03-18 stsp The same option will be passed to
227 2ab43947 2020-03-18 stsp if applicable.
229 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
230 2ab43947 2020-03-18 stsp The same option will be passed to
232 2ab43947 2020-03-18 stsp if applicable.
233 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
234 2ab43947 2020-03-18 stsp The maximum is 3.
237 267fe567 2020-03-18 stsp Short alias for
238 267fe567 2020-03-18 stsp .Cm clone .
239 7848a0e1 2020-03-19 stsp .It Cm fetch Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository-name
240 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
242 7848a0e1 2020-03-19 stsp .Ar remote-repository-name
243 7848a0e1 2020-03-19 stsp is specified the name
245 7848a0e1 2020-03-19 stsp will be used.
246 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
248 7848a0e1 2020-03-19 stsp file of the repository, as created by
249 7848a0e1 2020-03-19 stsp .Cm got clone .
251 7848a0e1 2020-03-19 stsp Branch references in the
252 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
253 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
255 7848a0e1 2020-03-19 stsp .Cm got rebase
256 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
257 7848a0e1 2020-03-19 stsp .Dq refs/heads/
258 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
260 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
261 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
262 469dd726 2020-03-20 stsp repository, including branches in the
263 469dd726 2020-03-20 stsp .Dq refs/heads/
264 469dd726 2020-03-20 stsp reference namespace.
265 469dd726 2020-03-20 stsp If those branches contained local commits, these will no longer be reachable
266 469dd726 2020-03-20 stsp via a reference and will therefore be at risk of being discarded by Git's
267 469dd726 2020-03-20 stsp garbage collector.
269 469dd726 2020-03-20 stsp In any case, existing references in the
270 7848a0e1 2020-03-19 stsp .Dq refs/tags/
271 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
272 469dd726 2020-03-20 stsp repository.
274 7848a0e1 2020-03-19 stsp The options for
275 7848a0e1 2020-03-19 stsp .Cm got fetch
276 7848a0e1 2020-03-19 stsp are as follows:
277 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
278 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
279 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
280 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
281 7848a0e1 2020-03-19 stsp working directory.
282 7848a0e1 2020-03-19 stsp If this directory is a
284 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
286 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
287 7848a0e1 2020-03-19 stsp The same option will be passed to
289 7848a0e1 2020-03-19 stsp if applicable.
291 7848a0e1 2020-03-19 stsp Increase the verbosity of progress reporting output.
292 7848a0e1 2020-03-19 stsp The same option will be passed to
294 7848a0e1 2020-03-19 stsp if applicable.
295 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
296 7848a0e1 2020-03-19 stsp The maximum is 3.
299 7848a0e1 2020-03-19 stsp Short alias for
300 7848a0e1 2020-03-19 stsp .Cm fetch .
301 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
302 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
303 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
304 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
305 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
306 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
310 5d7c1dab 2018-04-01 stsp .Ar work tree path
311 c844a238 2019-02-06 stsp is not specified, either use the last component of
312 5d7c1dab 2018-04-01 stsp .Ar repository path ,
314 5d7c1dab 2018-04-01 stsp .Ar path prefix
315 c844a238 2019-02-06 stsp was specified use the last component of
316 5d7c1dab 2018-04-01 stsp .Ar path prefix .
318 38e11793 2018-06-13 stsp The options for
319 38e11793 2018-06-13 stsp .Cm got checkout
320 38e11793 2018-06-13 stsp are as follows:
321 38e11793 2018-06-13 stsp .Bl -tag -width Ds
323 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
324 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
325 bb51a5b4 2020-01-13 stsp is not empty.
326 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
327 08573d5b 2019-05-14 stsp .It Fl b Ar branch
328 3c575567 2019-07-28 stsp Check out files from a commit on the specified
329 08573d5b 2019-05-14 stsp .Ar branch .
330 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
331 08573d5b 2019-05-14 stsp reference will be used.
332 8069f636 2019-01-12 stsp .It Fl c Ar commit
333 8069f636 2019-01-12 stsp Check out files from the specified
335 3c575567 2019-07-28 stsp on the selected branch.
336 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
337 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
338 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
339 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
340 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
341 08573d5b 2019-05-14 stsp branch will be used.
343 4b6c9460 2020-03-05 stsp If the specified
345 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
346 4b6c9460 2020-03-05 stsp this commit must be specified with the
349 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
350 4b6c9460 2020-03-05 stsp commit with
351 4b6c9460 2020-03-05 stsp .Cm got branch
353 4b6c9460 2020-03-05 stsp .Cm got checkout
354 4b6c9460 2020-03-05 stsp can be used.
355 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
356 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
357 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
358 38e11793 2018-06-13 stsp Only files beneath the specified
359 38e11793 2018-06-13 stsp .Ar path-prefix
360 38e11793 2018-06-13 stsp will be checked out.
363 97b3a7be 2019-07-09 stsp Short alias for
364 97b3a7be 2019-07-09 stsp .Cm checkout .
365 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
366 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
367 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
368 7f838b36 2019-02-08 stsp .Bl -column YXZ description
369 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
370 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
371 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
372 7f838b36 2019-02-08 stsp .It D Ta file was deleted
373 7f838b36 2019-02-08 stsp .It A Ta new file was added
374 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
375 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
380 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
381 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
382 f2ea84fa 2019-07-27 stsp specified paths.
383 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
384 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
385 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
388 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
389 c4cdcb68 2019-04-03 stsp multiple base commits.
390 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
391 47ec7be7 2019-05-12 stsp .Cm got update
392 47ec7be7 2019-05-12 stsp across the entire work tree.
393 024e9686 2019-05-14 stsp Specifying a
395 024e9686 2019-05-14 stsp is incompatible with the
399 4ed9f614 2019-08-04 stsp .Cm got update
400 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
401 4ed9f614 2019-08-04 stsp If changes have been staged with
402 4ed9f614 2019-08-04 stsp .Cm got stage ,
403 bc3056e3 2019-08-18 stsp these changes must first be committed with
404 4ed9f614 2019-08-04 stsp .Cm got commit
405 4ed9f614 2019-08-04 stsp or unstaged with
406 4ed9f614 2019-08-04 stsp .Cm got unstage .
408 507dc3bb 2018-12-29 stsp The options for
409 507dc3bb 2018-12-29 stsp .Cm got update
410 507dc3bb 2018-12-29 stsp are as follows:
411 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
412 024e9686 2019-05-14 stsp .It Fl b Ar branch
413 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
415 024e9686 2019-05-14 stsp before updating the work tree.
416 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
417 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
418 507dc3bb 2018-12-29 stsp Update the work tree to the specified
419 507dc3bb 2018-12-29 stsp .Ar commit .
420 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
421 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
422 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
423 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
424 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
425 024e9686 2019-05-14 stsp branch will be used.
428 97b3a7be 2019-07-09 stsp Short alias for
429 97b3a7be 2019-07-09 stsp .Cm update .
430 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
431 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
432 6bad629b 2019-02-04 stsp using the following status codes:
433 6bad629b 2019-02-04 stsp .Bl -column YXZ description
434 6bad629b 2019-02-04 stsp .It M Ta modified file
435 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
436 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
437 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
438 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
439 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
440 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
442 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
443 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
445 2a06fe5f 2019-08-24 stsp specified on the command line
450 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
451 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
453 4ed9f614 2019-08-04 stsp If changes have been staged with
454 4ed9f614 2019-08-04 stsp .Cm got stage ,
455 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
456 4ed9f614 2019-08-04 stsp status codes:
457 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
458 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
459 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
460 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
463 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
464 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
465 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
466 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
469 6841da00 2019-08-08 stsp For compatibility with
472 bd8de430 2019-10-04 stsp .Xr git 1 ,
473 6841da00 2019-08-08 stsp .Cm got status
476 bd8de430 2019-10-04 stsp patterns from
477 6841da00 2019-08-08 stsp .Pa .cvsignore
479 bd8de430 2019-10-04 stsp .Pa .gitignore
480 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
481 bd8de430 2019-10-04 stsp which match these patterns.
482 bd8de430 2019-10-04 stsp As an extension to
484 bd8de430 2019-10-04 stsp matching rules,
485 bd8de430 2019-10-04 stsp .Cm got status
486 bd8de430 2019-10-04 stsp supports consecutive asterisks,
488 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
490 6841da00 2019-08-08 stsp .Xr cvs 1 ,
491 6841da00 2019-08-08 stsp .Cm got status
492 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
494 bd8de430 2019-10-04 stsp .Xr git 1 ,
495 bd8de430 2019-10-04 stsp .Cm got status
496 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
498 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
500 bd8de430 2019-10-04 stsp in a pattern.
502 97b3a7be 2019-07-09 stsp Short alias for
503 97b3a7be 2019-07-09 stsp .Cm status .
504 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
505 38e11793 2018-06-13 stsp Display history of a repository.
508 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
509 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
511 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
512 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
513 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
515 38e11793 2018-06-13 stsp The options for
516 38e11793 2018-06-13 stsp .Cm got log
517 38e11793 2018-06-13 stsp are as follows:
518 38e11793 2018-06-13 stsp .Bl -tag -width Ds
520 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
521 1137e0ae 2020-01-27 stsp from other branches.
522 48c8c60d 2020-01-27 stsp By default,
523 48c8c60d 2020-01-27 stsp .Cm got log
524 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
525 38e11793 2018-06-13 stsp .It Fl c Ar commit
526 38e11793 2018-06-13 stsp Start traversing history at the specified
527 38e11793 2018-06-13 stsp .Ar commit .
528 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
529 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
530 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
531 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
532 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
533 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
534 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
535 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
537 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
538 6238ee32 2018-06-13 stsp .It Fl l Ar N
539 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
540 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
541 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
543 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
544 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
546 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
549 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
550 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
551 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
552 6841bf13 2019-11-29 kn regular expression
553 6841bf13 2019-11-29 kn .Ar search-pattern .
554 6841bf13 2019-11-29 kn Regular expression syntax is documented in
555 6841bf13 2019-11-29 kn .Xr re_format 7 .
556 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
557 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
558 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
559 04ca23f4 2018-07-16 stsp working directory.
560 e9cf2e30 2019-02-05 stsp If this directory is a
562 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
564 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
565 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
566 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
569 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
571 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
572 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
573 d24820bf 2019-08-11 stsp corresponding objects.
574 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
575 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
576 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
578 c0cc5c62 2018-10-18 stsp The options for
579 c0cc5c62 2018-10-18 stsp .Cm got diff
580 c0cc5c62 2018-10-18 stsp are as follows:
581 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
582 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
583 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
584 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
585 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
586 b72f483a 2019-02-05 stsp Use the repository at the specified path.
587 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
588 b72f483a 2019-02-05 stsp working directory.
589 b72f483a 2019-02-05 stsp If this directory is a
591 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
593 4ed9f614 2019-08-04 stsp Show changes staged with
594 4ed9f614 2019-08-04 stsp .Cm got stage
595 4ed9f614 2019-08-04 stsp instead of showing local changes.
596 4ed9f614 2019-08-04 stsp This option is only valid when
597 4ed9f614 2019-08-04 stsp .Cm got diff
598 4ed9f614 2019-08-04 stsp is invoked in a work tree.
600 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
603 bc26cce8 2019-08-04 stsp Short alias for
605 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
606 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
608 1ff8e573 2018-08-02 stsp The options for
609 1ff8e573 2018-08-02 stsp .Cm got blame
610 1ff8e573 2018-08-02 stsp are as follows:
611 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
612 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
613 1ff8e573 2018-08-02 stsp Start traversing history at the specified
614 1ff8e573 2018-08-02 stsp .Ar commit .
615 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
616 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
617 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
618 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
619 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
620 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
621 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
622 1ff8e573 2018-08-02 stsp working directory.
623 0c06baac 2019-02-05 stsp If this directory is a
625 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
628 bc26cce8 2019-08-04 stsp Short alias for
629 bc26cce8 2019-08-04 stsp .Cm blame .
630 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
631 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
632 5de5890b 2018-10-18 stsp directory path in the repository.
633 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
634 db0c2996 2019-02-10 stsp annotations:
635 db0c2996 2019-02-10 stsp .Bl -column YXZ description
636 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
637 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
638 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
639 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
644 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
645 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
646 0c849583 2019-02-05 stsp if there is no work tree.
648 5de5890b 2018-10-18 stsp The options for
649 5de5890b 2018-10-18 stsp .Cm got tree
650 5de5890b 2018-10-18 stsp are as follows:
651 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
652 5de5890b 2018-10-18 stsp .It Fl c Ar commit
653 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
654 5de5890b 2018-10-18 stsp .Ar commit .
655 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
656 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
657 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
658 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
659 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
660 5de5890b 2018-10-18 stsp Use the repository at the specified path.
661 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
662 5de5890b 2018-10-18 stsp working directory.
663 0c849583 2019-02-05 stsp If this directory is a
665 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
667 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
669 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
672 bc26cce8 2019-08-04 stsp Short alias for
674 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
675 d0eebce4 2019-03-11 stsp Manage references in a repository.
677 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
678 d0eebce4 2019-03-11 stsp or update, the reference with the given
680 d0eebce4 2019-03-11 stsp and make it point at the given
681 d83d9d5c 2019-05-13 stsp .Ar target .
682 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
683 f16e4044 2019-10-09 stsp .Dq refs/ .
684 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
685 a54b6686 2019-06-28 stsp will be resolved to an object ID.
686 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
687 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
689 d0eebce4 2019-03-11 stsp The options for
690 d0eebce4 2019-03-11 stsp .Cm got ref
691 d0eebce4 2019-03-11 stsp are as follows:
692 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
693 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
694 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
695 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
696 d0eebce4 2019-03-11 stsp working directory.
697 d0eebce4 2019-03-11 stsp If this directory is a
699 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
701 d0eebce4 2019-03-11 stsp List all existing references in the repository.
702 d0eebce4 2019-03-11 stsp .It Fl d Ar name
703 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
705 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
706 d1c1ae5f 2019-08-12 stsp .Ar target ,
707 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
708 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
709 d1c1ae5f 2019-08-12 stsp this option is used.
711 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
712 da76fce2 2020-02-24 stsp Create, list, or delete branches.
714 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
715 4e759de4 2019-06-26 stsp .Dq refs/heads/
716 4e759de4 2019-06-26 stsp reference namespace.
718 4e759de4 2019-06-26 stsp .Cm got branch
719 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
721 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
722 ad89fa31 2019-10-04 stsp work tree's current branch.
726 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
727 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
728 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
729 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
731 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
732 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
733 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
734 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
736 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
737 da76fce2 2020-02-24 stsp .Bl -column YXZ description
738 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
739 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
740 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
741 da76fce2 2020-02-24 stsp .It D Ta file was deleted
742 da76fce2 2020-02-24 stsp .It A Ta new file was added
743 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
744 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
747 4e759de4 2019-06-26 stsp The options for
748 4e759de4 2019-06-26 stsp .Cm got branch
749 4e759de4 2019-06-26 stsp are as follows:
750 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
751 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
752 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
753 a74f7e83 2019-11-10 stsp .Ar commit .
754 a74f7e83 2019-11-10 stsp The expected
756 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
757 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
758 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
759 4e759de4 2019-06-26 stsp Use the repository at the specified path.
760 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
761 4e759de4 2019-06-26 stsp working directory.
762 4e759de4 2019-06-26 stsp If this directory is a
764 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
766 4e759de4 2019-06-26 stsp List all existing branches in the repository.
767 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
768 ba882ee3 2019-07-11 stsp with one the following annotations:
769 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
770 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
771 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
773 4e759de4 2019-06-26 stsp .It Fl d Ar name
774 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
775 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
776 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
777 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
778 ce33d90e 2019-07-14 stsp Git's garbage collector.
780 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
783 97b3a7be 2019-07-09 stsp Short alias for
784 97b3a7be 2019-07-09 stsp .Cm branch .
785 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
786 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
788 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
789 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
790 8e7bd50a 2019-08-22 stsp reference namespace.
792 8e7bd50a 2019-08-22 stsp .Cm got tag
793 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
794 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
795 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
797 80106605 2020-02-24 stsp Attempt to create a tag with the given
799 8e7bd50a 2019-08-22 stsp and make this tag point at the given
800 8e7bd50a 2019-08-22 stsp .Ar commit .
801 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
802 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
803 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
805 8e7bd50a 2019-08-22 stsp The options for
806 8e7bd50a 2019-08-22 stsp .Cm got tag
807 8e7bd50a 2019-08-22 stsp are as follows:
808 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
809 80106605 2020-02-24 stsp .It Fl c Ar commit
810 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
811 80106605 2020-02-24 stsp .Ar commit .
812 80106605 2020-02-24 stsp The expected
814 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
815 80106605 2020-02-24 stsp will be resolved to a commit ID.
816 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
817 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
818 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
819 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
820 8e7bd50a 2019-08-22 stsp Without the
823 3a62228f 2019-11-08 stsp .Cm got tag
824 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
825 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
826 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
827 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
828 8e7bd50a 2019-08-22 stsp working directory.
829 8e7bd50a 2019-08-22 stsp If this directory is a
831 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
833 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
834 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
837 8e7bd50a 2019-08-22 stsp By design, the
838 8e7bd50a 2019-08-22 stsp .Cm got tag
839 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
840 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
841 8e7bd50a 2019-08-22 stsp .Cm got ref
842 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
843 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
844 8e7bd50a 2019-08-22 stsp another repository.
845 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
846 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
847 d00136be 2019-03-26 stsp repository in the next commit.
849 4e68cba3 2019-11-23 stsp The options for
850 4e68cba3 2019-11-23 stsp .Cm got add
851 4e68cba3 2019-11-23 stsp are as follows:
852 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
854 4e68cba3 2019-11-23 stsp Permit recursion into directories.
855 4e68cba3 2019-11-23 stsp If this option is not specified,
856 4e68cba3 2019-11-23 stsp .Cm got add
857 4e68cba3 2019-11-23 stsp will refuse to run if a specified
859 4e68cba3 2019-11-23 stsp is a directory.
861 022fae89 2019-12-06 tracey With -R, add files even if they match a
862 022fae89 2019-12-06 tracey .Cm got status
863 022fae89 2019-12-06 tracey ignore pattern.
865 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
866 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
867 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
869 2ec1f75b 2019-03-26 stsp The options for
870 86d25a1b 2019-07-11 stsp .Cm got remove
871 2ec1f75b 2019-03-26 stsp are as follows:
872 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
874 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
876 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
878 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
879 f2a9dc41 2019-12-13 tracey If this option is not specified,
880 f2a9dc41 2019-12-13 tracey .Cm got remove
881 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
883 f2a9dc41 2019-12-13 tracey is a directory.
886 648e4ef7 2019-07-09 stsp Short alias for
887 648e4ef7 2019-07-09 stsp .Cm remove .
888 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 ...
889 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
890 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
891 1dd86744 2019-08-12 anthony work tree's base commit.
892 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
893 a129376b 2019-03-28 stsp .Cm got revert !
895 e20a8b6f 2019-06-04 stsp If a file was added with
896 a129376b 2019-03-28 stsp .Cm got add
897 a129376b 2019-03-28 stsp it will become an unversioned file again.
898 e20a8b6f 2019-06-04 stsp If a file was deleted with
899 86d25a1b 2019-07-11 stsp .Cm got remove
900 a129376b 2019-03-28 stsp it will be restored.
902 0f6d7415 2019-08-08 stsp The options for
903 0f6d7415 2019-08-08 stsp .Cm got revert
904 0f6d7415 2019-08-08 stsp are as follows:
905 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
907 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
908 33aa809d 2019-08-08 stsp changes to revert based on
910 33aa809d 2019-08-08 stsp (revert change),
912 33aa809d 2019-08-08 stsp (keep change), and
914 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
915 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
916 33aa809d 2019-08-08 stsp modified file content can be reverted.
917 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
918 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
921 33aa809d 2019-08-08 stsp option, read
926 33aa809d 2019-08-08 stsp responses line-by-line from the specified
927 33aa809d 2019-08-08 stsp .Ar response-script
928 33aa809d 2019-08-08 stsp file instead of prompting interactively.
930 0f6d7415 2019-08-08 stsp Permit recursion into directories.
931 0f6d7415 2019-08-08 stsp If this option is not specified,
932 0f6d7415 2019-08-08 stsp .Cm got revert
933 0f6d7415 2019-08-08 stsp will refuse to run if a specified
935 0f6d7415 2019-08-08 stsp is a directory.
938 97b3a7be 2019-07-09 stsp Short alias for
939 97b3a7be 2019-07-09 stsp .Cm revert .
940 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
941 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
942 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
945 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
946 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
948 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
949 1dd86744 2019-08-12 anthony .Cm got stage ,
950 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
951 4ed9f614 2019-08-04 stsp have not been staged.
953 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
954 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
955 15cd91f7 2019-05-12 stsp .It M Ta modified file
956 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
957 15cd91f7 2019-05-12 stsp .It A Ta new file was added
958 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
961 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
962 996d5ccd 2019-08-05 stsp recorded base commit.
965 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
966 15cd91f7 2019-05-12 stsp multiple base commits.
967 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
968 47ec7be7 2019-05-12 stsp .Cm got update
969 47ec7be7 2019-05-12 stsp across the entire work tree.
972 15cd91f7 2019-05-12 stsp .Cm got commit
973 15cd91f7 2019-05-12 stsp command requires the
974 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
975 aba9c984 2019-09-08 stsp environment variable to be set,
976 aba9c984 2019-09-08 stsp unless Git's
977 aba9c984 2019-09-08 stsp .Dv user.name
979 709ae9eb 2019-09-08 stsp .Dv user.email
980 709ae9eb 2019-09-08 stsp configuration settings can be
981 aba9c984 2019-09-08 stsp obtained from the repository's
982 aba9c984 2019-09-08 stsp .Pa .git/config
983 c9956ddf 2019-09-08 stsp file or from Git's global
984 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
985 c9956ddf 2019-09-08 stsp configuration file.
987 74416c47 2019-05-09 stsp The options for
988 74416c47 2019-05-09 stsp .Cm got commit
989 74416c47 2019-05-09 stsp are as follows:
990 74416c47 2019-05-09 stsp .Bl -tag -width Ds
991 74ff3f23 2019-07-07 stsp .It Fl m Ar message
992 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
993 23594da9 2019-05-13 stsp Without the
996 23594da9 2019-05-13 stsp .Cm got commit
997 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1000 cfce0458 2019-07-28 stsp .Cm got commit
1001 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1002 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1003 916f288c 2019-07-30 stsp .Dq refs/heads/
1004 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1005 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1006 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1007 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1008 cfce0458 2019-07-28 stsp .Cm got update
1009 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1010 cfce0458 2019-07-28 stsp in the repository.
1012 97b3a7be 2019-07-09 stsp Short alias for
1013 97b3a7be 2019-07-09 stsp .Cm commit .
1014 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1015 234035bc 2019-06-01 stsp Merge changes from a single
1016 234035bc 2019-06-01 stsp .Ar commit
1017 234035bc 2019-06-01 stsp into the work tree.
1018 234035bc 2019-06-01 stsp The specified
1019 234035bc 2019-06-01 stsp .Ar commit
1020 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1021 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1022 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1023 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1025 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1026 234035bc 2019-06-01 stsp .Bl -column YXZ description
1027 234035bc 2019-06-01 stsp .It G Ta file was merged
1028 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1029 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1030 234035bc 2019-06-01 stsp .It D Ta file was deleted
1031 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1032 234035bc 2019-06-01 stsp .It A Ta new file was added
1033 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1036 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1037 234035bc 2019-06-01 stsp may be viewed with
1038 234035bc 2019-06-01 stsp .Cm got diff ,
1039 234035bc 2019-06-01 stsp amended manually or with further
1040 234035bc 2019-06-01 stsp .Cm got cherrypick
1042 234035bc 2019-06-01 stsp committed with
1043 234035bc 2019-06-01 stsp .Cm got commit ,
1044 234035bc 2019-06-01 stsp or discarded again with
1045 234035bc 2019-06-01 stsp .Cm got revert .
1047 234035bc 2019-06-01 stsp .Cm got cherrypick
1048 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1049 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1050 234035bc 2019-06-01 stsp to a single base commit with
1051 234035bc 2019-06-01 stsp .Cm got update .
1052 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1053 234035bc 2019-06-01 stsp conflicts must be resolved first.
1055 97b3a7be 2019-07-09 stsp Short alias for
1056 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1057 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1058 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1059 5ef14e63 2019-06-02 stsp .Ar commit
1060 5ef14e63 2019-06-02 stsp into the work tree.
1061 5ef14e63 2019-06-02 stsp The specified
1062 5ef14e63 2019-06-02 stsp .Ar commit
1063 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1064 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1065 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1066 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1068 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1069 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1070 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1071 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1072 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1073 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1074 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1075 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1076 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1079 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1080 5ef14e63 2019-06-02 stsp which may be viewed with
1081 5ef14e63 2019-06-02 stsp .Cm got diff ,
1082 5ef14e63 2019-06-02 stsp amended manually or with further
1083 778a73c2 2019-07-12 stsp .Cm got backout
1085 5ef14e63 2019-06-02 stsp committed with
1086 5ef14e63 2019-06-02 stsp .Cm got commit ,
1087 5ef14e63 2019-06-02 stsp or discarded again with
1088 5ef14e63 2019-06-02 stsp .Cm got revert .
1090 92228c38 2019-06-02 stsp .Cm got backout
1091 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1092 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1093 92228c38 2019-06-02 stsp to a single base commit with
1094 92228c38 2019-06-02 stsp .Cm got update .
1095 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1096 92228c38 2019-06-02 stsp conflicts must be resolved first.
1098 97b3a7be 2019-07-09 stsp Short alias for
1099 97b3a7be 2019-07-09 stsp .Cm backout .
1100 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1101 818c7501 2019-07-11 stsp Rebase commits on the specified
1102 818c7501 2019-07-11 stsp .Ar branch
1103 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1105 818c7501 2019-07-11 stsp .Ar branch
1106 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1107 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1108 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1109 818c7501 2019-07-11 stsp .Ar branch
1110 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1111 f09e2405 2019-07-11 stsp of the specified
1112 818c7501 2019-07-11 stsp .Ar branch
1113 f09e2405 2019-07-11 stsp has been rebased.
1116 2b6826ba 2020-02-24 stsp .Cm got rebase
1117 2b6826ba 2020-02-24 stsp is used as intended, the specified
1118 2b6826ba 2020-02-24 stsp .Ar branch
1119 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1120 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1121 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1122 2b6826ba 2020-02-24 stsp .Cm got update -b
1123 2b6826ba 2020-02-24 stsp before starting the
1124 2b6826ba 2020-02-24 stsp .Cm rebase
1125 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1126 2b6826ba 2020-02-24 stsp a common history with the specified
1127 2b6826ba 2020-02-24 stsp .Ar branch
1128 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1129 c10890ce 2020-02-25 stsp remote repository.
1131 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1132 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1133 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1134 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1135 818c7501 2019-07-11 stsp .Ar branch ,
1136 818c7501 2019-07-11 stsp but with different commit IDs.
1137 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1138 f09e2405 2019-07-11 stsp the new version of the specified
1139 818c7501 2019-07-11 stsp .Ar branch
1140 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1142 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1143 818c7501 2019-07-11 stsp using the following status codes:
1144 818c7501 2019-07-11 stsp .Bl -column YXZ description
1145 818c7501 2019-07-11 stsp .It G Ta file was merged
1146 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1147 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1148 818c7501 2019-07-11 stsp .It D Ta file was deleted
1149 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1150 818c7501 2019-07-11 stsp .It A Ta new file was added
1151 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1154 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1155 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1156 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1157 818c7501 2019-07-11 stsp .Ar branch
1158 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1160 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1161 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1162 f09e2405 2019-07-11 stsp when the rebase operation continues.
1164 818c7501 2019-07-11 stsp .Cm got rebase
1165 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1166 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1167 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1168 818c7501 2019-07-11 stsp .Cm got update .
1169 4ed9f614 2019-08-04 stsp If changes have been staged with
1170 4ed9f614 2019-08-04 stsp .Cm got stage ,
1171 bc3056e3 2019-08-18 stsp these changes must first be committed with
1172 4ed9f614 2019-08-04 stsp .Cm got commit
1173 4ed9f614 2019-08-04 stsp or unstaged with
1174 4ed9f614 2019-08-04 stsp .Cm got unstage .
1175 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1176 f09e2405 2019-07-11 stsp committed with
1177 f09e2405 2019-07-11 stsp .Cm got commit
1178 f09e2405 2019-07-11 stsp or reverted with
1179 f09e2405 2019-07-11 stsp .Cm got revert .
1181 64c6d990 2019-07-11 stsp .Ar branch
1182 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1183 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1186 7d5807f4 2019-07-11 stsp .Cm got update
1188 7d5807f4 2019-07-11 stsp .Cm got commit
1189 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1190 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1191 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1193 818c7501 2019-07-11 stsp The options for
1194 818c7501 2019-07-11 stsp .Cm got rebase
1195 818c7501 2019-07-11 stsp are as follows:
1196 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1198 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1199 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1201 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1202 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1205 818c7501 2019-07-11 stsp Short alias for
1206 818c7501 2019-07-11 stsp .Cm rebase .
1207 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
1208 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1209 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1211 6e54d307 2020-02-24 stsp Before starting a
1212 6e54d307 2020-02-24 stsp .Cm histedit
1213 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1214 6e54d307 2020-02-24 stsp .Cm got update -b
1215 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1216 6e54d307 2020-02-24 stsp current branch of the work tree.
1217 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1218 6e54d307 2020-02-24 stsp touched by the
1219 6e54d307 2020-02-24 stsp .Cm histedit
1220 6e54d307 2020-02-24 stsp operation.
1222 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1223 6e54d307 2020-02-24 stsp must be set with
1224 6e54d307 2020-02-24 stsp .Cm got update -c
1225 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1226 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1228 6e54d307 2020-02-24 stsp .Cm histedit
1229 6e54d307 2020-02-24 stsp operation.
1231 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1232 0ebf8283 2019-07-24 stsp .Ar histedit script
1233 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1234 46fa4c83 2020-02-24 stsp command line, or generated with the
1236 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1238 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1239 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1240 0ebf8283 2019-07-24 stsp whitespace and an argument.
1241 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1242 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1243 0ebf8283 2019-07-24 stsp Lines which begin with the
1245 0ebf8283 2019-07-24 stsp character are ignored entirely.
1247 0ebf8283 2019-07-24 stsp The available commands are as follows:
1248 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1249 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1250 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1251 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1252 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1253 0ebf8283 2019-07-24 stsp listed further below that will be used.
1254 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1255 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1256 0ebf8283 2019-07-24 stsp the commit on the previous line.
1257 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1258 0ebf8283 2019-07-24 stsp log message can be written.
1261 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1262 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1263 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1265 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1266 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1267 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1268 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1269 498a90b7 2019-07-25 stsp switched to it.
1271 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1272 0ebf8283 2019-07-24 stsp using the following status codes:
1273 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1274 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1275 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1276 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1277 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1278 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1279 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1280 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1283 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1284 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1285 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1286 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1288 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1289 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1290 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1292 0ebf8283 2019-07-24 stsp .Cm got histedit
1293 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1294 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1295 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1296 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1297 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1298 0ebf8283 2019-07-24 stsp to a single base commit with
1299 0ebf8283 2019-07-24 stsp .Cm got update .
1300 4ed9f614 2019-08-04 stsp If changes have been staged with
1301 4ed9f614 2019-08-04 stsp .Cm got stage ,
1302 bc3056e3 2019-08-18 stsp these changes must first be committed with
1303 4ed9f614 2019-08-04 stsp .Cm got commit
1304 4ed9f614 2019-08-04 stsp or unstaged with
1305 4ed9f614 2019-08-04 stsp .Cm got unstage .
1306 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1307 0ebf8283 2019-07-24 stsp committed with
1308 0ebf8283 2019-07-24 stsp .Cm got commit
1309 0ebf8283 2019-07-24 stsp or reverted with
1310 0ebf8283 2019-07-24 stsp .Cm got revert .
1311 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1312 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1315 7ef62c4e 2020-02-24 stsp .Cm got update ,
1316 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1318 65db4ffb 2020-02-24 stsp .Cm got integrate
1319 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1320 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1321 0ebf8283 2019-07-24 stsp .Cm got commit
1322 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1323 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1325 0ebf8283 2019-07-24 stsp The options for
1326 0ebf8283 2019-07-24 stsp .Cm got histedit
1327 0ebf8283 2019-07-24 stsp are as follows:
1328 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1330 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1331 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1333 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1334 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1335 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1336 ddbfac99 2020-02-24 stsp Use the specified
1337 ddbfac99 2020-02-24 stsp .Ar histedit-script
1338 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1339 ddbfac99 2020-02-24 stsp can be written.
1341 083957f4 2020-02-24 stsp Edit log messages only.
1342 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1343 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1346 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1347 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1350 0ebf8283 2019-07-24 stsp Short alias for
1351 0ebf8283 2019-07-24 stsp .Cm histedit .
1352 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1353 2822a352 2019-10-15 stsp Integrate the specified
1354 2822a352 2019-10-15 stsp .Ar branch
1355 2822a352 2019-10-15 stsp into the work tree's current branch.
1356 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1357 2822a352 2019-10-15 stsp .Ar branch ,
1358 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1359 2822a352 2019-10-15 stsp head commit of the integrated
1360 2822a352 2019-10-15 stsp .Ar branch .
1362 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1363 2822a352 2019-10-15 stsp will be pointing at the same commit.
1364 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1365 2822a352 2019-10-15 stsp In case the integrated
1366 2822a352 2019-10-15 stsp .Ar branch
1367 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1368 2822a352 2019-10-15 stsp .Cm got branch -d .
1370 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1371 2822a352 2019-10-15 stsp .Bl -column YXZ description
1372 2822a352 2019-10-15 stsp .It U Ta file was updated
1373 2822a352 2019-10-15 stsp .It D Ta file was deleted
1374 2822a352 2019-10-15 stsp .It A Ta new file was added
1375 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1376 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1379 2822a352 2019-10-15 stsp .Cm got integrate
1380 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1381 2822a352 2019-10-15 stsp Most importantly, the
1382 2822a352 2019-10-15 stsp .Ar branch
1383 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1384 2822a352 2019-10-15 stsp .Cm got rebase
1385 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1386 2822a352 2019-10-15 stsp resolve merge conflicts.
1387 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1388 2822a352 2019-10-15 stsp to a single base commit with
1389 2822a352 2019-10-15 stsp .Cm got update .
1390 2822a352 2019-10-15 stsp If changes have been staged with
1391 2822a352 2019-10-15 stsp .Cm got stage ,
1392 2822a352 2019-10-15 stsp these changes must first be committed with
1393 2822a352 2019-10-15 stsp .Cm got commit
1394 2822a352 2019-10-15 stsp or unstaged with
1395 2822a352 2019-10-15 stsp .Cm got unstage .
1396 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1397 2822a352 2019-10-15 stsp committed with
1398 2822a352 2019-10-15 stsp .Cm got commit
1399 2822a352 2019-10-15 stsp or reverted with
1400 2822a352 2019-10-15 stsp .Cm got revert .
1402 2822a352 2019-10-15 stsp Short alias for
1403 2822a352 2019-10-15 stsp .Cm integrate .
1404 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 ...
1405 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1408 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1409 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1410 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1411 4ed9f614 2019-08-04 stsp .Cm got status .
1413 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1414 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1415 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1416 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1417 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1420 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1421 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1422 9d8b19a4 2019-08-04 stsp committed.
1424 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1425 4ed9f614 2019-08-04 stsp .Cm got commit ,
1426 4ed9f614 2019-08-04 stsp .Cm got status ,
1428 4ed9f614 2019-08-04 stsp .Cm got diff .
1429 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1430 4ed9f614 2019-08-04 stsp .Cm got commit
1431 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1432 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1433 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1435 4ed9f614 2019-08-04 stsp .Cm got status
1436 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1438 4ed9f614 2019-08-04 stsp .Cm got diff
1439 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1440 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1442 4ed9f614 2019-08-04 stsp .Cm got revert
1443 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1444 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1446 4ed9f614 2019-08-04 stsp The options for
1447 4ed9f614 2019-08-04 stsp .Cm got stage
1448 4ed9f614 2019-08-04 stsp are as follows:
1449 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1451 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1452 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1453 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1454 1dd86744 2019-08-12 anthony among the specified paths.
1455 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1457 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1458 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1460 6d23ec10 2019-08-08 stsp (stage change),
1462 6d23ec10 2019-08-08 stsp (reject change), and
1464 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1465 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1466 dc424a06 2019-08-07 stsp modified file content can be staged.
1467 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1468 6d23ec10 2019-08-08 stsp their entirety.
1469 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1472 3a070a2b 2019-08-07 stsp option, read
1477 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1478 0e2f5884 2019-08-07 stsp .Ar response-script
1479 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1482 4ed9f614 2019-08-04 stsp .Cm got stage
1483 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1484 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1485 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1486 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1487 4ed9f614 2019-08-04 stsp .Cm got update
1488 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1489 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1492 4ed9f614 2019-08-04 stsp .Cm got update ,
1493 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1495 4ed9f614 2019-08-04 stsp .Cm got histedit
1496 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1497 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1498 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1499 4ed9f614 2019-08-04 stsp .Cm got unstage
1500 4ed9f614 2019-08-04 stsp before it can be updated with
1501 4ed9f614 2019-08-04 stsp .Cm got update ,
1502 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1504 4ed9f614 2019-08-04 stsp Short alias for
1505 4ed9f614 2019-08-04 stsp .Cm stage .
1506 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1507 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1508 4ed9f614 2019-08-04 stsp back into non-staged status.
1511 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1512 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1514 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1515 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1516 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1517 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1518 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1519 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1520 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1521 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1524 2e1f37b0 2019-08-08 stsp The options for
1525 2e1f37b0 2019-08-08 stsp .Cm got unstage
1526 2e1f37b0 2019-08-08 stsp are as follows:
1527 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1529 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1530 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1532 2e1f37b0 2019-08-08 stsp (unstage change),
1534 2e1f37b0 2019-08-08 stsp (keep change staged), and
1536 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1537 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1538 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1539 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1540 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1543 2e1f37b0 2019-08-08 stsp option, read
1548 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1549 2e1f37b0 2019-08-08 stsp .Ar response-script
1550 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1553 4ed9f614 2019-08-04 stsp Short alias for
1554 4ed9f614 2019-08-04 stsp .Cm unstage .
1555 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 ...
1556 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1557 896e9b6f 2019-08-26 stsp text format.
1558 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1559 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1560 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1562 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1563 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1564 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1565 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1566 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1567 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1569 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1571 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1572 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1574 01073a5d 2019-08-22 stsp The options for
1575 01073a5d 2019-08-22 stsp .Cm got cat
1576 01073a5d 2019-08-22 stsp are as follows:
1577 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1578 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1579 896e9b6f 2019-08-26 stsp Look up paths in the specified
1580 896e9b6f 2019-08-26 stsp .Ar commit .
1581 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1582 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1583 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1584 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1585 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1586 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1587 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1588 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1589 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1590 01073a5d 2019-08-22 stsp working directory.
1591 01073a5d 2019-08-22 stsp If this directory is a
1593 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1595 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1596 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1597 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1600 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1601 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1602 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1603 74416c47 2019-05-09 stsp The author's name and email address for
1604 21a44f98 2019-07-15 stsp .Cm got commit
1606 21a44f98 2019-07-15 stsp .Cm got import ,
1607 74416c47 2019-05-09 stsp for example:
1608 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1611 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1613 84792843 2019-08-09 stsp attempts to reject
1614 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1615 84792843 2019-08-09 stsp environment variables with a missing email address.
1617 c9956ddf 2019-09-08 stsp If present, Git's
1618 aba9c984 2019-09-08 stsp .Dv user.name
1620 709ae9eb 2019-09-08 stsp .Dv user.email
1621 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1622 aba9c984 2019-09-08 stsp .Pa .git/config
1623 aba9c984 2019-09-08 stsp file will override the value of
1624 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1625 c9956ddf 2019-09-08 stsp However, the
1626 c9956ddf 2019-09-08 stsp .Dv user.name
1628 c9956ddf 2019-09-08 stsp .Dv user.email
1629 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1630 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1631 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1632 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1633 c9956ddf 2019-09-08 stsp environment variable is
1636 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1637 23594da9 2019-05-13 stsp The editor spawned by
1638 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1639 8e7bd50a 2019-08-22 stsp .Cm got import ,
1641 8e7bd50a 2019-08-22 stsp .Cm got tag .
1642 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1643 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1644 b1ebc001 2019-08-13 stsp .Cm got log .
1645 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1646 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1647 858b0dfb 2020-03-20 stsp .It Ev GOT_FETCH_DEBUG
1648 858b0dfb 2020-03-20 stsp Enables protocol tracing on standard error output during
1649 858b0dfb 2020-03-20 stsp .Cm got clone
1651 858b0dfb 2020-03-20 stsp .Cm got fetch .
1653 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1654 5c860e29 2018-03-12 stsp .Ex -std got
1655 97925469 2018-03-17 stsp .Sh EXAMPLES
1656 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1659 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1660 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1662 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1663 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1665 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1666 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1668 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1670 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1671 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1672 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1674 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1675 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1677 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1679 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1681 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1683 e70c17ce 2019-05-22 stsp .Dl $ got status
1684 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1686 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1688 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1690 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1692 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1694 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1695 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1696 d83d9d5c 2019-05-13 stsp which is forked off the
1697 d83d9d5c 2019-05-13 stsp .Dq master
1700 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1702 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1703 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1704 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1706 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1708 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1709 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1711 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1713 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1714 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1715 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1717 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1719 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1721 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1723 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1724 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1725 5b666081 2020-02-24 stsp .Pa sys/uvm :
1727 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1729 5b666081 2020-02-24 stsp And this command has the same effect:
1731 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1733 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1735 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1736 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1738 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1739 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1741 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1743 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1744 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1745 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1747 95fc3404 2019-07-15 stsp .Dl $ got update
1749 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1750 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1751 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1753 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1754 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1755 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1756 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1758 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1759 469dd726 2020-03-20 stsp .Dq origin/master
1762 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1763 469dd726 2020-03-20 stsp .Dl $ got fetch
1765 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1766 469dd726 2020-03-20 stsp .Cm git clone --bare
1768 469dd726 2020-03-20 stsp .Xr git-fetch 1
1769 469dd726 2020-03-20 stsp command must be used instead:
1771 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1772 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1774 469dd726 2020-03-20 stsp Rebase the local
1775 469dd726 2020-03-20 stsp .Dq master
1776 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1777 469dd726 2020-03-20 stsp .Dq origin/master
1780 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1781 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1782 469dd726 2020-03-20 stsp .Dl $ got rebase master
1784 fa6e0e48 2019-05-23 stsp Rebase the
1785 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1786 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1787 fa6e0e48 2019-05-23 stsp .Dq master
1790 818c7501 2019-07-11 stsp .Dl $ got update -b master
1791 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1793 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1794 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1795 1dd86744 2019-08-12 anthony .Ox Ns 's
1796 1dd86744 2019-08-12 anthony CVS tree:
1798 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1800 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1801 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1804 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1805 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1806 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1808 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1809 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1810 bf390dec 2020-03-20 stsp branch back into the
1811 bf390dec 2020-03-20 stsp .Dq master
1812 bf390dec 2020-03-20 stsp branch, the
1813 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1814 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1815 bf390dec 2020-03-20 stsp .Dq master
1818 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1819 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1821 bf390dec 2020-03-20 stsp Changes on the
1822 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1823 bf390dec 2020-03-20 stsp branch can now be made visible on the
1824 bf390dec 2020-03-20 stsp .Dq master
1825 bf390dec 2020-03-20 stsp branch with
1826 bf390dec 2020-03-20 stsp .Cm got integrate .
1827 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1828 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1829 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1830 bf390dec 2020-03-20 stsp .Dq master
1831 bf390dec 2020-03-20 stsp branch before the
1832 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1833 bf390dec 2020-03-20 stsp branch can be integrated into
1834 bf390dec 2020-03-20 stsp .Dq master :
1836 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1837 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1839 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1840 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1841 7b3fde24 2019-07-28 stsp .Cm git push .
1842 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1843 469dd726 2020-03-20 stsp .Cm git clone --bare
1844 7848a0e1 2020-03-19 stsp instead of
1845 7848a0e1 2020-03-19 stsp .Cm got clone ,
1847 ff2cf171 2019-07-28 stsp .Dq refspec
1848 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1850 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1851 ff2cf171 2019-07-28 stsp namespace of the local repository.
1852 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1853 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1854 ff2cf171 2019-07-28 stsp configuration variable to the value
1855 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1857 ff2cf171 2019-07-28 stsp .Cm git config
1860 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1861 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1862 469dd726 2020-03-20 stsp Additionally, the
1863 469dd726 2020-03-20 stsp .Dq mirror
1864 469dd726 2020-03-20 stsp option must be disabled:
1866 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1867 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1869 ff2cf171 2019-07-28 stsp Alternatively, the following
1870 469dd726 2020-03-20 stsp .Xr git-fetch 1
1871 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1872 ff2cf171 2019-07-28 stsp .Pa config
1875 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1876 ff2cf171 2019-07-28 stsp .Dl url = ...
1877 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1878 469dd726 2020-03-20 stsp .Dl mirror = false
1880 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1881 ff2cf171 2019-07-28 stsp .Dq refs/heads
1882 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1883 ff2cf171 2019-07-28 stsp .Cm got checkout
1884 ff2cf171 2019-07-28 stsp and, if needed, created with
1885 ff2cf171 2019-07-28 stsp .Cm got branch .
1887 ff2cf171 2019-07-28 stsp Branches in the
1888 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1889 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1890 ff2cf171 2019-07-28 stsp repository with
1891 469dd726 2020-03-20 stsp .Cm got fetch
1893 469dd726 2020-03-20 stsp .Xr git-fetch 1
1894 469dd726 2020-03-20 stsp without extra command line arguments:
1896 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1897 469dd726 2020-03-20 stsp .Dl $ git fetch
1899 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1900 ff2cf171 2019-07-28 stsp .Dq master
1901 7b0db533 2020-02-04 stsp branch, the
1902 ff2cf171 2019-07-28 stsp .Dq master
1903 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1904 ff2cf171 2019-07-28 stsp .Dq origin/master
1906 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1908 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1909 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1912 083957f4 2020-02-24 stsp .Dq master
1913 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1915 083957f4 2020-02-24 stsp by other developers and any other important new information:
1917 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1918 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1920 7b0db533 2020-02-04 stsp Local changes on the
1921 ff2cf171 2019-07-28 stsp .Dq master
1922 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1923 ff2cf171 2019-07-28 stsp repository with
1924 ff2cf171 2019-07-28 stsp .Cm git push :
1926 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1927 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1928 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1929 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1930 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1931 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1932 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1933 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1934 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1935 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1936 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
1937 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1939 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1940 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1942 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1943 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
