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 659e7fbd 2020-03-20 stsp .It Cm clone Oo Fl a Oc 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 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
196 659e7fbd 2020-03-20 stsp If this option is not specified, a branch resolved via the repository's HEAD
197 659e7fbd 2020-03-20 stsp reference will be fetched.
199 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
200 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
201 469dd726 2020-03-20 stsp local changes as created by
202 469dd726 2020-03-20 stsp .Cm got commit .
204 469dd726 2020-03-20 stsp The repository's
206 469dd726 2020-03-20 stsp file will be set up with the
208 469dd726 2020-03-20 stsp option enabled, such that
209 469dd726 2020-03-20 stsp .Cm got fetch
211 469dd726 2020-03-20 stsp .Xr git-fetch 1
212 469dd726 2020-03-20 stsp will write incoming changes directly to branches in the
213 469dd726 2020-03-20 stsp .Dq refs/heads/
214 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
215 469dd726 2020-03-20 stsp .Dq refs/remotes/
217 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
218 469dd726 2020-03-20 stsp .Cm got rebase
220 469dd726 2020-03-20 stsp .Cm got fetch
221 469dd726 2020-03-20 stsp in order to make incoming changes appear on branches in the
222 469dd726 2020-03-20 stsp .Dq refs/heads/
224 469dd726 2020-03-20 stsp But maintaining custom branches with local changes in the cloned
225 469dd726 2020-03-20 stsp repository becomes difficult since local changes are at risk of
226 469dd726 2020-03-20 stsp being discarded whenever incoming changes are fetched.
228 2ab43947 2020-03-18 stsp Suppress progress reporting output.
229 2ab43947 2020-03-18 stsp The same option will be passed to
231 2ab43947 2020-03-18 stsp if applicable.
233 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
234 2ab43947 2020-03-18 stsp The same option will be passed to
236 2ab43947 2020-03-18 stsp if applicable.
237 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
238 2ab43947 2020-03-18 stsp The maximum is 3.
241 267fe567 2020-03-18 stsp Short alias for
242 267fe567 2020-03-18 stsp .Cm clone .
243 659e7fbd 2020-03-20 stsp .It Cm fetch Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository-name
244 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
246 7848a0e1 2020-03-19 stsp .Ar remote-repository-name
247 7848a0e1 2020-03-19 stsp is specified the name
249 7848a0e1 2020-03-19 stsp will be used.
250 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
252 7848a0e1 2020-03-19 stsp file of the repository, as created by
253 7848a0e1 2020-03-19 stsp .Cm got clone .
255 7848a0e1 2020-03-19 stsp Branch references in the
256 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
257 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
259 7848a0e1 2020-03-19 stsp .Cm got rebase
260 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
261 7848a0e1 2020-03-19 stsp .Dq refs/heads/
262 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
264 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
265 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
266 469dd726 2020-03-20 stsp repository, including branches in the
267 469dd726 2020-03-20 stsp .Dq refs/heads/
268 469dd726 2020-03-20 stsp reference namespace.
269 469dd726 2020-03-20 stsp If those branches contained local commits, these will no longer be reachable
270 469dd726 2020-03-20 stsp via a reference and will therefore be at risk of being discarded by Git's
271 469dd726 2020-03-20 stsp garbage collector.
273 469dd726 2020-03-20 stsp In any case, existing references in the
274 7848a0e1 2020-03-19 stsp .Dq refs/tags/
275 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
276 469dd726 2020-03-20 stsp repository.
278 7848a0e1 2020-03-19 stsp The options for
279 7848a0e1 2020-03-19 stsp .Cm got fetch
280 7848a0e1 2020-03-19 stsp are as follows:
281 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
283 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
284 659e7fbd 2020-03-20 stsp If this option is not specified, a branch resolved via the repository's HEAD
285 659e7fbd 2020-03-20 stsp reference will be fetched.
286 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
287 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
288 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
289 7848a0e1 2020-03-19 stsp working directory.
290 7848a0e1 2020-03-19 stsp If this directory is a
292 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
294 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
295 7848a0e1 2020-03-19 stsp The same option will be passed to
297 7848a0e1 2020-03-19 stsp if applicable.
299 7848a0e1 2020-03-19 stsp Increase the verbosity of progress reporting output.
300 7848a0e1 2020-03-19 stsp The same option will be passed to
302 7848a0e1 2020-03-19 stsp if applicable.
303 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
304 7848a0e1 2020-03-19 stsp The maximum is 3.
307 7848a0e1 2020-03-19 stsp Short alias for
308 7848a0e1 2020-03-19 stsp .Cm fetch .
309 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
310 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
311 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
312 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
313 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
314 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
318 5d7c1dab 2018-04-01 stsp .Ar work tree path
319 c844a238 2019-02-06 stsp is not specified, either use the last component of
320 5d7c1dab 2018-04-01 stsp .Ar repository path ,
322 5d7c1dab 2018-04-01 stsp .Ar path prefix
323 c844a238 2019-02-06 stsp was specified use the last component of
324 5d7c1dab 2018-04-01 stsp .Ar path prefix .
326 38e11793 2018-06-13 stsp The options for
327 38e11793 2018-06-13 stsp .Cm got checkout
328 38e11793 2018-06-13 stsp are as follows:
329 38e11793 2018-06-13 stsp .Bl -tag -width Ds
331 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
332 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
333 bb51a5b4 2020-01-13 stsp is not empty.
334 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
335 08573d5b 2019-05-14 stsp .It Fl b Ar branch
336 3c575567 2019-07-28 stsp Check out files from a commit on the specified
337 08573d5b 2019-05-14 stsp .Ar branch .
338 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
339 08573d5b 2019-05-14 stsp reference will be used.
340 8069f636 2019-01-12 stsp .It Fl c Ar commit
341 8069f636 2019-01-12 stsp Check out files from the specified
343 3c575567 2019-07-28 stsp on the selected branch.
344 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
345 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
346 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
347 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
348 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
349 08573d5b 2019-05-14 stsp branch will be used.
351 4b6c9460 2020-03-05 stsp If the specified
353 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
354 4b6c9460 2020-03-05 stsp this commit must be specified with the
357 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
358 4b6c9460 2020-03-05 stsp commit with
359 4b6c9460 2020-03-05 stsp .Cm got branch
361 4b6c9460 2020-03-05 stsp .Cm got checkout
362 4b6c9460 2020-03-05 stsp can be used.
363 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
364 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
365 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
366 38e11793 2018-06-13 stsp Only files beneath the specified
367 38e11793 2018-06-13 stsp .Ar path-prefix
368 38e11793 2018-06-13 stsp will be checked out.
371 97b3a7be 2019-07-09 stsp Short alias for
372 97b3a7be 2019-07-09 stsp .Cm checkout .
373 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
374 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
375 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
376 7f838b36 2019-02-08 stsp .Bl -column YXZ description
377 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
378 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
379 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
380 7f838b36 2019-02-08 stsp .It D Ta file was deleted
381 7f838b36 2019-02-08 stsp .It A Ta new file was added
382 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
383 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
388 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
389 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
390 f2ea84fa 2019-07-27 stsp specified paths.
391 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
392 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
393 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
396 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
397 c4cdcb68 2019-04-03 stsp multiple base commits.
398 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
399 47ec7be7 2019-05-12 stsp .Cm got update
400 47ec7be7 2019-05-12 stsp across the entire work tree.
401 024e9686 2019-05-14 stsp Specifying a
403 024e9686 2019-05-14 stsp is incompatible with the
407 4ed9f614 2019-08-04 stsp .Cm got update
408 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
409 4ed9f614 2019-08-04 stsp If changes have been staged with
410 4ed9f614 2019-08-04 stsp .Cm got stage ,
411 bc3056e3 2019-08-18 stsp these changes must first be committed with
412 4ed9f614 2019-08-04 stsp .Cm got commit
413 4ed9f614 2019-08-04 stsp or unstaged with
414 4ed9f614 2019-08-04 stsp .Cm got unstage .
416 507dc3bb 2018-12-29 stsp The options for
417 507dc3bb 2018-12-29 stsp .Cm got update
418 507dc3bb 2018-12-29 stsp are as follows:
419 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
420 024e9686 2019-05-14 stsp .It Fl b Ar branch
421 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
423 024e9686 2019-05-14 stsp before updating the work tree.
424 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
425 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
426 507dc3bb 2018-12-29 stsp Update the work tree to the specified
427 507dc3bb 2018-12-29 stsp .Ar commit .
428 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
429 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
430 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
431 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
432 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
433 024e9686 2019-05-14 stsp branch will be used.
436 97b3a7be 2019-07-09 stsp Short alias for
437 97b3a7be 2019-07-09 stsp .Cm update .
438 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
439 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
440 6bad629b 2019-02-04 stsp using the following status codes:
441 6bad629b 2019-02-04 stsp .Bl -column YXZ description
442 6bad629b 2019-02-04 stsp .It M Ta modified file
443 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
444 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
445 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
446 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
447 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
448 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
450 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
451 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
453 2a06fe5f 2019-08-24 stsp specified on the command line
458 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
459 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
461 4ed9f614 2019-08-04 stsp If changes have been staged with
462 4ed9f614 2019-08-04 stsp .Cm got stage ,
463 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
464 4ed9f614 2019-08-04 stsp status codes:
465 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
466 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
467 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
468 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
471 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
472 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
473 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
474 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
477 6841da00 2019-08-08 stsp For compatibility with
480 bd8de430 2019-10-04 stsp .Xr git 1 ,
481 6841da00 2019-08-08 stsp .Cm got status
484 bd8de430 2019-10-04 stsp patterns from
485 6841da00 2019-08-08 stsp .Pa .cvsignore
487 bd8de430 2019-10-04 stsp .Pa .gitignore
488 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
489 bd8de430 2019-10-04 stsp which match these patterns.
490 bd8de430 2019-10-04 stsp As an extension to
492 bd8de430 2019-10-04 stsp matching rules,
493 bd8de430 2019-10-04 stsp .Cm got status
494 bd8de430 2019-10-04 stsp supports consecutive asterisks,
496 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
498 6841da00 2019-08-08 stsp .Xr cvs 1 ,
499 6841da00 2019-08-08 stsp .Cm got status
500 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
502 bd8de430 2019-10-04 stsp .Xr git 1 ,
503 bd8de430 2019-10-04 stsp .Cm got status
504 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
506 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
508 bd8de430 2019-10-04 stsp in a pattern.
510 97b3a7be 2019-07-09 stsp Short alias for
511 97b3a7be 2019-07-09 stsp .Cm status .
512 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
513 38e11793 2018-06-13 stsp Display history of a repository.
516 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
517 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
519 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
520 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
521 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
523 38e11793 2018-06-13 stsp The options for
524 38e11793 2018-06-13 stsp .Cm got log
525 38e11793 2018-06-13 stsp are as follows:
526 38e11793 2018-06-13 stsp .Bl -tag -width Ds
528 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
529 1137e0ae 2020-01-27 stsp from other branches.
530 48c8c60d 2020-01-27 stsp By default,
531 48c8c60d 2020-01-27 stsp .Cm got log
532 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
533 38e11793 2018-06-13 stsp .It Fl c Ar commit
534 38e11793 2018-06-13 stsp Start traversing history at the specified
535 38e11793 2018-06-13 stsp .Ar commit .
536 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
537 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
538 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
539 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
540 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
541 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
542 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
543 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
545 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
546 6238ee32 2018-06-13 stsp .It Fl l Ar N
547 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
548 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
549 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
551 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
552 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
554 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
557 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
558 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
559 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
560 6841bf13 2019-11-29 kn regular expression
561 6841bf13 2019-11-29 kn .Ar search-pattern .
562 6841bf13 2019-11-29 kn Regular expression syntax is documented in
563 6841bf13 2019-11-29 kn .Xr re_format 7 .
564 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
565 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
566 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
567 04ca23f4 2018-07-16 stsp working directory.
568 e9cf2e30 2019-02-05 stsp If this directory is a
570 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
572 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
573 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
574 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
577 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
579 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
580 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
581 d24820bf 2019-08-11 stsp corresponding objects.
582 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
583 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
584 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
586 c0cc5c62 2018-10-18 stsp The options for
587 c0cc5c62 2018-10-18 stsp .Cm got diff
588 c0cc5c62 2018-10-18 stsp are as follows:
589 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
590 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
591 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
592 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
593 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
594 b72f483a 2019-02-05 stsp Use the repository at the specified path.
595 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
596 b72f483a 2019-02-05 stsp working directory.
597 b72f483a 2019-02-05 stsp If this directory is a
599 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
601 4ed9f614 2019-08-04 stsp Show changes staged with
602 4ed9f614 2019-08-04 stsp .Cm got stage
603 4ed9f614 2019-08-04 stsp instead of showing local changes.
604 4ed9f614 2019-08-04 stsp This option is only valid when
605 4ed9f614 2019-08-04 stsp .Cm got diff
606 4ed9f614 2019-08-04 stsp is invoked in a work tree.
608 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
611 bc26cce8 2019-08-04 stsp Short alias for
613 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
614 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
616 1ff8e573 2018-08-02 stsp The options for
617 1ff8e573 2018-08-02 stsp .Cm got blame
618 1ff8e573 2018-08-02 stsp are as follows:
619 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
620 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
621 1ff8e573 2018-08-02 stsp Start traversing history at the specified
622 1ff8e573 2018-08-02 stsp .Ar commit .
623 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
624 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
625 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
626 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
627 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
628 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
629 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
630 1ff8e573 2018-08-02 stsp working directory.
631 0c06baac 2019-02-05 stsp If this directory is a
633 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
636 bc26cce8 2019-08-04 stsp Short alias for
637 bc26cce8 2019-08-04 stsp .Cm blame .
638 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
639 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
640 5de5890b 2018-10-18 stsp directory path in the repository.
641 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
642 db0c2996 2019-02-10 stsp annotations:
643 db0c2996 2019-02-10 stsp .Bl -column YXZ description
644 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
645 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
646 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
647 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
652 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
653 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
654 0c849583 2019-02-05 stsp if there is no work tree.
656 5de5890b 2018-10-18 stsp The options for
657 5de5890b 2018-10-18 stsp .Cm got tree
658 5de5890b 2018-10-18 stsp are as follows:
659 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
660 5de5890b 2018-10-18 stsp .It Fl c Ar commit
661 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
662 5de5890b 2018-10-18 stsp .Ar commit .
663 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
664 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
665 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
666 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
667 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
668 5de5890b 2018-10-18 stsp Use the repository at the specified path.
669 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
670 5de5890b 2018-10-18 stsp working directory.
671 0c849583 2019-02-05 stsp If this directory is a
673 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
675 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
677 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
680 bc26cce8 2019-08-04 stsp Short alias for
682 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
683 d0eebce4 2019-03-11 stsp Manage references in a repository.
685 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
686 d0eebce4 2019-03-11 stsp or update, the reference with the given
688 d0eebce4 2019-03-11 stsp and make it point at the given
689 d83d9d5c 2019-05-13 stsp .Ar target .
690 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
691 f16e4044 2019-10-09 stsp .Dq refs/ .
692 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
693 a54b6686 2019-06-28 stsp will be resolved to an object ID.
694 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
695 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
697 d0eebce4 2019-03-11 stsp The options for
698 d0eebce4 2019-03-11 stsp .Cm got ref
699 d0eebce4 2019-03-11 stsp are as follows:
700 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
701 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
702 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
703 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
704 d0eebce4 2019-03-11 stsp working directory.
705 d0eebce4 2019-03-11 stsp If this directory is a
707 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
709 d0eebce4 2019-03-11 stsp List all existing references in the repository.
710 d0eebce4 2019-03-11 stsp .It Fl d Ar name
711 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
713 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
714 d1c1ae5f 2019-08-12 stsp .Ar target ,
715 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
716 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
717 d1c1ae5f 2019-08-12 stsp this option is used.
719 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
720 da76fce2 2020-02-24 stsp Create, list, or delete branches.
722 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
723 4e759de4 2019-06-26 stsp .Dq refs/heads/
724 4e759de4 2019-06-26 stsp reference namespace.
726 4e759de4 2019-06-26 stsp .Cm got branch
727 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
729 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
730 ad89fa31 2019-10-04 stsp work tree's current branch.
734 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
735 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
736 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
737 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
739 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
740 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
741 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
742 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
744 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
745 da76fce2 2020-02-24 stsp .Bl -column YXZ description
746 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
747 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
748 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
749 da76fce2 2020-02-24 stsp .It D Ta file was deleted
750 da76fce2 2020-02-24 stsp .It A Ta new file was added
751 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
752 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
755 4e759de4 2019-06-26 stsp The options for
756 4e759de4 2019-06-26 stsp .Cm got branch
757 4e759de4 2019-06-26 stsp are as follows:
758 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
759 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
760 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
761 a74f7e83 2019-11-10 stsp .Ar commit .
762 a74f7e83 2019-11-10 stsp The expected
764 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
765 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
766 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
767 4e759de4 2019-06-26 stsp Use the repository at the specified path.
768 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
769 4e759de4 2019-06-26 stsp working directory.
770 4e759de4 2019-06-26 stsp If this directory is a
772 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
774 4e759de4 2019-06-26 stsp List all existing branches in the repository.
775 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
776 ba882ee3 2019-07-11 stsp with one the following annotations:
777 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
778 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
779 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
781 4e759de4 2019-06-26 stsp .It Fl d Ar name
782 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
783 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
784 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
785 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
786 ce33d90e 2019-07-14 stsp Git's garbage collector.
788 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
791 97b3a7be 2019-07-09 stsp Short alias for
792 97b3a7be 2019-07-09 stsp .Cm branch .
793 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
794 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
796 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
797 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
798 8e7bd50a 2019-08-22 stsp reference namespace.
800 8e7bd50a 2019-08-22 stsp .Cm got tag
801 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
802 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
803 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
805 80106605 2020-02-24 stsp Attempt to create a tag with the given
807 8e7bd50a 2019-08-22 stsp and make this tag point at the given
808 8e7bd50a 2019-08-22 stsp .Ar commit .
809 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
810 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
811 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
813 8e7bd50a 2019-08-22 stsp The options for
814 8e7bd50a 2019-08-22 stsp .Cm got tag
815 8e7bd50a 2019-08-22 stsp are as follows:
816 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
817 80106605 2020-02-24 stsp .It Fl c Ar commit
818 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
819 80106605 2020-02-24 stsp .Ar commit .
820 80106605 2020-02-24 stsp The expected
822 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
823 80106605 2020-02-24 stsp will be resolved to a commit ID.
824 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
825 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
826 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
827 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
828 8e7bd50a 2019-08-22 stsp Without the
831 3a62228f 2019-11-08 stsp .Cm got tag
832 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
833 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
834 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
835 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
836 8e7bd50a 2019-08-22 stsp working directory.
837 8e7bd50a 2019-08-22 stsp If this directory is a
839 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
841 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
842 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
845 8e7bd50a 2019-08-22 stsp By design, the
846 8e7bd50a 2019-08-22 stsp .Cm got tag
847 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
848 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
849 8e7bd50a 2019-08-22 stsp .Cm got ref
850 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
851 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
852 8e7bd50a 2019-08-22 stsp another repository.
853 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
854 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
855 d00136be 2019-03-26 stsp repository in the next commit.
857 4e68cba3 2019-11-23 stsp The options for
858 4e68cba3 2019-11-23 stsp .Cm got add
859 4e68cba3 2019-11-23 stsp are as follows:
860 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
862 4e68cba3 2019-11-23 stsp Permit recursion into directories.
863 4e68cba3 2019-11-23 stsp If this option is not specified,
864 4e68cba3 2019-11-23 stsp .Cm got add
865 4e68cba3 2019-11-23 stsp will refuse to run if a specified
867 4e68cba3 2019-11-23 stsp is a directory.
869 022fae89 2019-12-06 tracey With -R, add files even if they match a
870 022fae89 2019-12-06 tracey .Cm got status
871 022fae89 2019-12-06 tracey ignore pattern.
873 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
874 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
875 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
877 2ec1f75b 2019-03-26 stsp The options for
878 86d25a1b 2019-07-11 stsp .Cm got remove
879 2ec1f75b 2019-03-26 stsp are as follows:
880 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
882 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
884 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
886 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
887 f2a9dc41 2019-12-13 tracey If this option is not specified,
888 f2a9dc41 2019-12-13 tracey .Cm got remove
889 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
891 f2a9dc41 2019-12-13 tracey is a directory.
894 648e4ef7 2019-07-09 stsp Short alias for
895 648e4ef7 2019-07-09 stsp .Cm remove .
896 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 ...
897 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
898 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
899 1dd86744 2019-08-12 anthony work tree's base commit.
900 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
901 a129376b 2019-03-28 stsp .Cm got revert !
903 e20a8b6f 2019-06-04 stsp If a file was added with
904 a129376b 2019-03-28 stsp .Cm got add
905 a129376b 2019-03-28 stsp it will become an unversioned file again.
906 e20a8b6f 2019-06-04 stsp If a file was deleted with
907 86d25a1b 2019-07-11 stsp .Cm got remove
908 a129376b 2019-03-28 stsp it will be restored.
910 0f6d7415 2019-08-08 stsp The options for
911 0f6d7415 2019-08-08 stsp .Cm got revert
912 0f6d7415 2019-08-08 stsp are as follows:
913 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
915 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
916 33aa809d 2019-08-08 stsp changes to revert based on
918 33aa809d 2019-08-08 stsp (revert change),
920 33aa809d 2019-08-08 stsp (keep change), and
922 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
923 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
924 33aa809d 2019-08-08 stsp modified file content can be reverted.
925 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
926 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
929 33aa809d 2019-08-08 stsp option, read
934 33aa809d 2019-08-08 stsp responses line-by-line from the specified
935 33aa809d 2019-08-08 stsp .Ar response-script
936 33aa809d 2019-08-08 stsp file instead of prompting interactively.
938 0f6d7415 2019-08-08 stsp Permit recursion into directories.
939 0f6d7415 2019-08-08 stsp If this option is not specified,
940 0f6d7415 2019-08-08 stsp .Cm got revert
941 0f6d7415 2019-08-08 stsp will refuse to run if a specified
943 0f6d7415 2019-08-08 stsp is a directory.
946 97b3a7be 2019-07-09 stsp Short alias for
947 97b3a7be 2019-07-09 stsp .Cm revert .
948 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
949 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
950 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
953 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
954 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
956 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
957 1dd86744 2019-08-12 anthony .Cm got stage ,
958 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
959 4ed9f614 2019-08-04 stsp have not been staged.
961 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
962 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
963 15cd91f7 2019-05-12 stsp .It M Ta modified file
964 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
965 15cd91f7 2019-05-12 stsp .It A Ta new file was added
966 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
969 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
970 996d5ccd 2019-08-05 stsp recorded base commit.
973 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
974 15cd91f7 2019-05-12 stsp multiple base commits.
975 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
976 47ec7be7 2019-05-12 stsp .Cm got update
977 47ec7be7 2019-05-12 stsp across the entire work tree.
980 15cd91f7 2019-05-12 stsp .Cm got commit
981 15cd91f7 2019-05-12 stsp command requires the
982 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
983 aba9c984 2019-09-08 stsp environment variable to be set,
984 aba9c984 2019-09-08 stsp unless Git's
985 aba9c984 2019-09-08 stsp .Dv user.name
987 709ae9eb 2019-09-08 stsp .Dv user.email
988 709ae9eb 2019-09-08 stsp configuration settings can be
989 aba9c984 2019-09-08 stsp obtained from the repository's
990 aba9c984 2019-09-08 stsp .Pa .git/config
991 c9956ddf 2019-09-08 stsp file or from Git's global
992 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
993 c9956ddf 2019-09-08 stsp configuration file.
995 74416c47 2019-05-09 stsp The options for
996 74416c47 2019-05-09 stsp .Cm got commit
997 74416c47 2019-05-09 stsp are as follows:
998 74416c47 2019-05-09 stsp .Bl -tag -width Ds
999 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1000 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1001 23594da9 2019-05-13 stsp Without the
1004 23594da9 2019-05-13 stsp .Cm got commit
1005 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1008 cfce0458 2019-07-28 stsp .Cm got commit
1009 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1010 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1011 916f288c 2019-07-30 stsp .Dq refs/heads/
1012 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1013 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1014 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1015 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1016 cfce0458 2019-07-28 stsp .Cm got update
1017 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1018 cfce0458 2019-07-28 stsp in the repository.
1020 97b3a7be 2019-07-09 stsp Short alias for
1021 97b3a7be 2019-07-09 stsp .Cm commit .
1022 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1023 234035bc 2019-06-01 stsp Merge changes from a single
1024 234035bc 2019-06-01 stsp .Ar commit
1025 234035bc 2019-06-01 stsp into the work tree.
1026 234035bc 2019-06-01 stsp The specified
1027 234035bc 2019-06-01 stsp .Ar commit
1028 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1029 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1030 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1031 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1033 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1034 234035bc 2019-06-01 stsp .Bl -column YXZ description
1035 234035bc 2019-06-01 stsp .It G Ta file was merged
1036 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1037 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1038 234035bc 2019-06-01 stsp .It D Ta file was deleted
1039 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1040 234035bc 2019-06-01 stsp .It A Ta new file was added
1041 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1044 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1045 234035bc 2019-06-01 stsp may be viewed with
1046 234035bc 2019-06-01 stsp .Cm got diff ,
1047 234035bc 2019-06-01 stsp amended manually or with further
1048 234035bc 2019-06-01 stsp .Cm got cherrypick
1050 234035bc 2019-06-01 stsp committed with
1051 234035bc 2019-06-01 stsp .Cm got commit ,
1052 234035bc 2019-06-01 stsp or discarded again with
1053 234035bc 2019-06-01 stsp .Cm got revert .
1055 234035bc 2019-06-01 stsp .Cm got cherrypick
1056 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1057 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1058 234035bc 2019-06-01 stsp to a single base commit with
1059 234035bc 2019-06-01 stsp .Cm got update .
1060 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1061 234035bc 2019-06-01 stsp conflicts must be resolved first.
1063 97b3a7be 2019-07-09 stsp Short alias for
1064 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1065 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1066 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1067 5ef14e63 2019-06-02 stsp .Ar commit
1068 5ef14e63 2019-06-02 stsp into the work tree.
1069 5ef14e63 2019-06-02 stsp The specified
1070 5ef14e63 2019-06-02 stsp .Ar commit
1071 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1072 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1073 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1074 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1076 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1077 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1078 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1079 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1080 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1081 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1082 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1083 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1084 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1087 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1088 5ef14e63 2019-06-02 stsp which may be viewed with
1089 5ef14e63 2019-06-02 stsp .Cm got diff ,
1090 5ef14e63 2019-06-02 stsp amended manually or with further
1091 778a73c2 2019-07-12 stsp .Cm got backout
1093 5ef14e63 2019-06-02 stsp committed with
1094 5ef14e63 2019-06-02 stsp .Cm got commit ,
1095 5ef14e63 2019-06-02 stsp or discarded again with
1096 5ef14e63 2019-06-02 stsp .Cm got revert .
1098 92228c38 2019-06-02 stsp .Cm got backout
1099 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1100 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1101 92228c38 2019-06-02 stsp to a single base commit with
1102 92228c38 2019-06-02 stsp .Cm got update .
1103 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1104 92228c38 2019-06-02 stsp conflicts must be resolved first.
1106 97b3a7be 2019-07-09 stsp Short alias for
1107 97b3a7be 2019-07-09 stsp .Cm backout .
1108 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1109 818c7501 2019-07-11 stsp Rebase commits on the specified
1110 818c7501 2019-07-11 stsp .Ar branch
1111 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1113 818c7501 2019-07-11 stsp .Ar branch
1114 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1115 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1116 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1117 818c7501 2019-07-11 stsp .Ar branch
1118 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1119 f09e2405 2019-07-11 stsp of the specified
1120 818c7501 2019-07-11 stsp .Ar branch
1121 f09e2405 2019-07-11 stsp has been rebased.
1124 2b6826ba 2020-02-24 stsp .Cm got rebase
1125 2b6826ba 2020-02-24 stsp is used as intended, the specified
1126 2b6826ba 2020-02-24 stsp .Ar branch
1127 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1128 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1129 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1130 2b6826ba 2020-02-24 stsp .Cm got update -b
1131 2b6826ba 2020-02-24 stsp before starting the
1132 2b6826ba 2020-02-24 stsp .Cm rebase
1133 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1134 2b6826ba 2020-02-24 stsp a common history with the specified
1135 2b6826ba 2020-02-24 stsp .Ar branch
1136 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1137 c10890ce 2020-02-25 stsp remote repository.
1139 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1140 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1141 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1142 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1143 818c7501 2019-07-11 stsp .Ar branch ,
1144 818c7501 2019-07-11 stsp but with different commit IDs.
1145 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1146 f09e2405 2019-07-11 stsp the new version of the specified
1147 818c7501 2019-07-11 stsp .Ar branch
1148 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1150 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1151 818c7501 2019-07-11 stsp using the following status codes:
1152 818c7501 2019-07-11 stsp .Bl -column YXZ description
1153 818c7501 2019-07-11 stsp .It G Ta file was merged
1154 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1155 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1156 818c7501 2019-07-11 stsp .It D Ta file was deleted
1157 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1158 818c7501 2019-07-11 stsp .It A Ta new file was added
1159 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1162 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1163 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1164 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1165 818c7501 2019-07-11 stsp .Ar branch
1166 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1168 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1169 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1170 f09e2405 2019-07-11 stsp when the rebase operation continues.
1172 818c7501 2019-07-11 stsp .Cm got rebase
1173 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1174 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1175 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1176 818c7501 2019-07-11 stsp .Cm got update .
1177 4ed9f614 2019-08-04 stsp If changes have been staged with
1178 4ed9f614 2019-08-04 stsp .Cm got stage ,
1179 bc3056e3 2019-08-18 stsp these changes must first be committed with
1180 4ed9f614 2019-08-04 stsp .Cm got commit
1181 4ed9f614 2019-08-04 stsp or unstaged with
1182 4ed9f614 2019-08-04 stsp .Cm got unstage .
1183 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1184 f09e2405 2019-07-11 stsp committed with
1185 f09e2405 2019-07-11 stsp .Cm got commit
1186 f09e2405 2019-07-11 stsp or reverted with
1187 f09e2405 2019-07-11 stsp .Cm got revert .
1189 64c6d990 2019-07-11 stsp .Ar branch
1190 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1191 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1194 7d5807f4 2019-07-11 stsp .Cm got update
1196 7d5807f4 2019-07-11 stsp .Cm got commit
1197 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1198 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1199 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1201 818c7501 2019-07-11 stsp The options for
1202 818c7501 2019-07-11 stsp .Cm got rebase
1203 818c7501 2019-07-11 stsp are as follows:
1204 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1206 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1207 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1209 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1210 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1213 818c7501 2019-07-11 stsp Short alias for
1214 818c7501 2019-07-11 stsp .Cm rebase .
1215 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
1216 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1217 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1219 6e54d307 2020-02-24 stsp Before starting a
1220 6e54d307 2020-02-24 stsp .Cm histedit
1221 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1222 6e54d307 2020-02-24 stsp .Cm got update -b
1223 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1224 6e54d307 2020-02-24 stsp current branch of the work tree.
1225 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1226 6e54d307 2020-02-24 stsp touched by the
1227 6e54d307 2020-02-24 stsp .Cm histedit
1228 6e54d307 2020-02-24 stsp operation.
1230 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1231 6e54d307 2020-02-24 stsp must be set with
1232 6e54d307 2020-02-24 stsp .Cm got update -c
1233 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1234 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1236 6e54d307 2020-02-24 stsp .Cm histedit
1237 6e54d307 2020-02-24 stsp operation.
1239 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1240 0ebf8283 2019-07-24 stsp .Ar histedit script
1241 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1242 46fa4c83 2020-02-24 stsp command line, or generated with the
1244 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1246 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1247 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1248 0ebf8283 2019-07-24 stsp whitespace and an argument.
1249 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1250 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1251 0ebf8283 2019-07-24 stsp Lines which begin with the
1253 0ebf8283 2019-07-24 stsp character are ignored entirely.
1255 0ebf8283 2019-07-24 stsp The available commands are as follows:
1256 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1257 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1258 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1259 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1260 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1261 0ebf8283 2019-07-24 stsp listed further below that will be used.
1262 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1263 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1264 0ebf8283 2019-07-24 stsp the commit on the previous line.
1265 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1266 0ebf8283 2019-07-24 stsp log message can be written.
1269 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1270 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1271 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1273 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1274 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1275 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1276 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1277 498a90b7 2019-07-25 stsp switched to it.
1279 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1280 0ebf8283 2019-07-24 stsp using the following status codes:
1281 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1282 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1283 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1284 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1285 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1286 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1287 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1288 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1291 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1292 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1293 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1294 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1296 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1297 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1298 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1300 0ebf8283 2019-07-24 stsp .Cm got histedit
1301 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1302 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1303 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1304 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1305 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1306 0ebf8283 2019-07-24 stsp to a single base commit with
1307 0ebf8283 2019-07-24 stsp .Cm got update .
1308 4ed9f614 2019-08-04 stsp If changes have been staged with
1309 4ed9f614 2019-08-04 stsp .Cm got stage ,
1310 bc3056e3 2019-08-18 stsp these changes must first be committed with
1311 4ed9f614 2019-08-04 stsp .Cm got commit
1312 4ed9f614 2019-08-04 stsp or unstaged with
1313 4ed9f614 2019-08-04 stsp .Cm got unstage .
1314 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1315 0ebf8283 2019-07-24 stsp committed with
1316 0ebf8283 2019-07-24 stsp .Cm got commit
1317 0ebf8283 2019-07-24 stsp or reverted with
1318 0ebf8283 2019-07-24 stsp .Cm got revert .
1319 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1320 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1323 7ef62c4e 2020-02-24 stsp .Cm got update ,
1324 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1326 65db4ffb 2020-02-24 stsp .Cm got integrate
1327 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1328 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1329 0ebf8283 2019-07-24 stsp .Cm got commit
1330 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1331 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1333 0ebf8283 2019-07-24 stsp The options for
1334 0ebf8283 2019-07-24 stsp .Cm got histedit
1335 0ebf8283 2019-07-24 stsp are as follows:
1336 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1338 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1339 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1341 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1342 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1343 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1344 ddbfac99 2020-02-24 stsp Use the specified
1345 ddbfac99 2020-02-24 stsp .Ar histedit-script
1346 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1347 ddbfac99 2020-02-24 stsp can be written.
1349 083957f4 2020-02-24 stsp Edit log messages only.
1350 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1351 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1354 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1355 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1358 0ebf8283 2019-07-24 stsp Short alias for
1359 0ebf8283 2019-07-24 stsp .Cm histedit .
1360 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1361 2822a352 2019-10-15 stsp Integrate the specified
1362 2822a352 2019-10-15 stsp .Ar branch
1363 2822a352 2019-10-15 stsp into the work tree's current branch.
1364 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1365 2822a352 2019-10-15 stsp .Ar branch ,
1366 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1367 2822a352 2019-10-15 stsp head commit of the integrated
1368 2822a352 2019-10-15 stsp .Ar branch .
1370 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1371 2822a352 2019-10-15 stsp will be pointing at the same commit.
1372 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1373 2822a352 2019-10-15 stsp In case the integrated
1374 2822a352 2019-10-15 stsp .Ar branch
1375 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1376 2822a352 2019-10-15 stsp .Cm got branch -d .
1378 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1379 2822a352 2019-10-15 stsp .Bl -column YXZ description
1380 2822a352 2019-10-15 stsp .It U Ta file was updated
1381 2822a352 2019-10-15 stsp .It D Ta file was deleted
1382 2822a352 2019-10-15 stsp .It A Ta new file was added
1383 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1384 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1387 2822a352 2019-10-15 stsp .Cm got integrate
1388 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1389 2822a352 2019-10-15 stsp Most importantly, the
1390 2822a352 2019-10-15 stsp .Ar branch
1391 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1392 2822a352 2019-10-15 stsp .Cm got rebase
1393 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1394 2822a352 2019-10-15 stsp resolve merge conflicts.
1395 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1396 2822a352 2019-10-15 stsp to a single base commit with
1397 2822a352 2019-10-15 stsp .Cm got update .
1398 2822a352 2019-10-15 stsp If changes have been staged with
1399 2822a352 2019-10-15 stsp .Cm got stage ,
1400 2822a352 2019-10-15 stsp these changes must first be committed with
1401 2822a352 2019-10-15 stsp .Cm got commit
1402 2822a352 2019-10-15 stsp or unstaged with
1403 2822a352 2019-10-15 stsp .Cm got unstage .
1404 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1405 2822a352 2019-10-15 stsp committed with
1406 2822a352 2019-10-15 stsp .Cm got commit
1407 2822a352 2019-10-15 stsp or reverted with
1408 2822a352 2019-10-15 stsp .Cm got revert .
1410 2822a352 2019-10-15 stsp Short alias for
1411 2822a352 2019-10-15 stsp .Cm integrate .
1412 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 ...
1413 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1416 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1417 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1418 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1419 4ed9f614 2019-08-04 stsp .Cm got status .
1421 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1422 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1423 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1424 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1425 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1428 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1429 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1430 9d8b19a4 2019-08-04 stsp committed.
1432 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1433 4ed9f614 2019-08-04 stsp .Cm got commit ,
1434 4ed9f614 2019-08-04 stsp .Cm got status ,
1436 4ed9f614 2019-08-04 stsp .Cm got diff .
1437 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1438 4ed9f614 2019-08-04 stsp .Cm got commit
1439 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1440 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1441 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1443 4ed9f614 2019-08-04 stsp .Cm got status
1444 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1446 4ed9f614 2019-08-04 stsp .Cm got diff
1447 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1448 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1450 4ed9f614 2019-08-04 stsp .Cm got revert
1451 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1452 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1454 4ed9f614 2019-08-04 stsp The options for
1455 4ed9f614 2019-08-04 stsp .Cm got stage
1456 4ed9f614 2019-08-04 stsp are as follows:
1457 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1459 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1460 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1461 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1462 1dd86744 2019-08-12 anthony among the specified paths.
1463 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1465 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1466 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1468 6d23ec10 2019-08-08 stsp (stage change),
1470 6d23ec10 2019-08-08 stsp (reject change), and
1472 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1473 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1474 dc424a06 2019-08-07 stsp modified file content can be staged.
1475 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1476 6d23ec10 2019-08-08 stsp their entirety.
1477 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1480 3a070a2b 2019-08-07 stsp option, read
1485 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1486 0e2f5884 2019-08-07 stsp .Ar response-script
1487 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1490 4ed9f614 2019-08-04 stsp .Cm got stage
1491 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1492 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1493 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1494 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1495 4ed9f614 2019-08-04 stsp .Cm got update
1496 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1497 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1500 4ed9f614 2019-08-04 stsp .Cm got update ,
1501 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1503 4ed9f614 2019-08-04 stsp .Cm got histedit
1504 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1505 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1506 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1507 4ed9f614 2019-08-04 stsp .Cm got unstage
1508 4ed9f614 2019-08-04 stsp before it can be updated with
1509 4ed9f614 2019-08-04 stsp .Cm got update ,
1510 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1512 4ed9f614 2019-08-04 stsp Short alias for
1513 4ed9f614 2019-08-04 stsp .Cm stage .
1514 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1515 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1516 4ed9f614 2019-08-04 stsp back into non-staged status.
1519 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1520 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1522 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1523 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1524 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1525 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1526 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1527 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1528 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1529 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1532 2e1f37b0 2019-08-08 stsp The options for
1533 2e1f37b0 2019-08-08 stsp .Cm got unstage
1534 2e1f37b0 2019-08-08 stsp are as follows:
1535 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1537 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1538 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1540 2e1f37b0 2019-08-08 stsp (unstage change),
1542 2e1f37b0 2019-08-08 stsp (keep change staged), and
1544 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1545 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1546 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1547 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1548 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1551 2e1f37b0 2019-08-08 stsp option, read
1556 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1557 2e1f37b0 2019-08-08 stsp .Ar response-script
1558 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1561 4ed9f614 2019-08-04 stsp Short alias for
1562 4ed9f614 2019-08-04 stsp .Cm unstage .
1563 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 ...
1564 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1565 896e9b6f 2019-08-26 stsp text format.
1566 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1567 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1568 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1570 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1571 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1572 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1573 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1574 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1575 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1577 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1579 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1580 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1582 01073a5d 2019-08-22 stsp The options for
1583 01073a5d 2019-08-22 stsp .Cm got cat
1584 01073a5d 2019-08-22 stsp are as follows:
1585 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1586 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1587 896e9b6f 2019-08-26 stsp Look up paths in the specified
1588 896e9b6f 2019-08-26 stsp .Ar commit .
1589 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1590 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1591 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1592 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1593 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1594 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1595 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1596 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1597 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1598 01073a5d 2019-08-22 stsp working directory.
1599 01073a5d 2019-08-22 stsp If this directory is a
1601 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1603 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1604 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1605 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1608 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1609 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1610 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1611 74416c47 2019-05-09 stsp The author's name and email address for
1612 21a44f98 2019-07-15 stsp .Cm got commit
1614 21a44f98 2019-07-15 stsp .Cm got import ,
1615 74416c47 2019-05-09 stsp for example:
1616 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1619 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1621 84792843 2019-08-09 stsp attempts to reject
1622 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1623 84792843 2019-08-09 stsp environment variables with a missing email address.
1625 c9956ddf 2019-09-08 stsp If present, Git's
1626 aba9c984 2019-09-08 stsp .Dv user.name
1628 709ae9eb 2019-09-08 stsp .Dv user.email
1629 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1630 aba9c984 2019-09-08 stsp .Pa .git/config
1631 aba9c984 2019-09-08 stsp file will override the value of
1632 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1633 c9956ddf 2019-09-08 stsp However, the
1634 c9956ddf 2019-09-08 stsp .Dv user.name
1636 c9956ddf 2019-09-08 stsp .Dv user.email
1637 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1638 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1639 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1640 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1641 c9956ddf 2019-09-08 stsp environment variable is
1644 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1645 23594da9 2019-05-13 stsp The editor spawned by
1646 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1647 8e7bd50a 2019-08-22 stsp .Cm got import ,
1649 8e7bd50a 2019-08-22 stsp .Cm got tag .
1650 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1651 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1652 b1ebc001 2019-08-13 stsp .Cm got log .
1653 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1654 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1655 858b0dfb 2020-03-20 stsp .It Ev GOT_FETCH_DEBUG
1656 858b0dfb 2020-03-20 stsp Enables protocol tracing on standard error output during
1657 858b0dfb 2020-03-20 stsp .Cm got clone
1659 858b0dfb 2020-03-20 stsp .Cm got fetch .
1661 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1662 5c860e29 2018-03-12 stsp .Ex -std got
1663 97925469 2018-03-17 stsp .Sh EXAMPLES
1664 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1667 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1668 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1670 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1671 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1673 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1674 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1676 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1678 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1679 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1680 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1682 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1683 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1685 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1687 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1689 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1691 e70c17ce 2019-05-22 stsp .Dl $ got status
1692 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1694 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1696 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1698 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1700 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1702 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1703 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1704 d83d9d5c 2019-05-13 stsp which is forked off the
1705 d83d9d5c 2019-05-13 stsp .Dq master
1708 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1710 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1711 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1712 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1714 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1716 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1717 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1719 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1721 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1722 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1723 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1725 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1727 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1729 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1731 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1732 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1733 5b666081 2020-02-24 stsp .Pa sys/uvm :
1735 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1737 5b666081 2020-02-24 stsp And this command has the same effect:
1739 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1741 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1743 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1744 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1746 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1747 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1749 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1751 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1752 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1753 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1755 95fc3404 2019-07-15 stsp .Dl $ got update
1757 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1758 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1759 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1761 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1762 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1763 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1764 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1766 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1767 469dd726 2020-03-20 stsp .Dq origin/master
1770 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1771 469dd726 2020-03-20 stsp .Dl $ got fetch
1773 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1774 469dd726 2020-03-20 stsp .Cm git clone --bare
1776 469dd726 2020-03-20 stsp .Xr git-fetch 1
1777 469dd726 2020-03-20 stsp command must be used instead:
1779 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1780 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1782 469dd726 2020-03-20 stsp Rebase the local
1783 469dd726 2020-03-20 stsp .Dq master
1784 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1785 469dd726 2020-03-20 stsp .Dq origin/master
1788 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1789 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1790 469dd726 2020-03-20 stsp .Dl $ got rebase master
1792 fa6e0e48 2019-05-23 stsp Rebase the
1793 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1794 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1795 fa6e0e48 2019-05-23 stsp .Dq master
1798 818c7501 2019-07-11 stsp .Dl $ got update -b master
1799 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1801 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1802 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1803 1dd86744 2019-08-12 anthony .Ox Ns 's
1804 1dd86744 2019-08-12 anthony CVS tree:
1806 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1808 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1809 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1812 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1813 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1814 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1816 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1817 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1818 bf390dec 2020-03-20 stsp branch back into the
1819 bf390dec 2020-03-20 stsp .Dq master
1820 bf390dec 2020-03-20 stsp branch, the
1821 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1822 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1823 bf390dec 2020-03-20 stsp .Dq master
1826 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1827 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1829 bf390dec 2020-03-20 stsp Changes on the
1830 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1831 bf390dec 2020-03-20 stsp branch can now be made visible on the
1832 bf390dec 2020-03-20 stsp .Dq master
1833 bf390dec 2020-03-20 stsp branch with
1834 bf390dec 2020-03-20 stsp .Cm got integrate .
1835 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1836 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1837 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1838 bf390dec 2020-03-20 stsp .Dq master
1839 bf390dec 2020-03-20 stsp branch before the
1840 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1841 bf390dec 2020-03-20 stsp branch can be integrated into
1842 bf390dec 2020-03-20 stsp .Dq master :
1844 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1845 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1847 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1848 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1849 7b3fde24 2019-07-28 stsp .Cm git push .
1850 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1851 469dd726 2020-03-20 stsp .Cm git clone --bare
1852 7848a0e1 2020-03-19 stsp instead of
1853 7848a0e1 2020-03-19 stsp .Cm got clone ,
1855 ff2cf171 2019-07-28 stsp .Dq refspec
1856 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1858 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1859 ff2cf171 2019-07-28 stsp namespace of the local repository.
1860 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1861 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1862 ff2cf171 2019-07-28 stsp configuration variable to the value
1863 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1865 ff2cf171 2019-07-28 stsp .Cm git config
1868 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1869 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1870 469dd726 2020-03-20 stsp Additionally, the
1871 469dd726 2020-03-20 stsp .Dq mirror
1872 469dd726 2020-03-20 stsp option must be disabled:
1874 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1875 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1877 ff2cf171 2019-07-28 stsp Alternatively, the following
1878 469dd726 2020-03-20 stsp .Xr git-fetch 1
1879 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1880 ff2cf171 2019-07-28 stsp .Pa config
1883 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1884 ff2cf171 2019-07-28 stsp .Dl url = ...
1885 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1886 469dd726 2020-03-20 stsp .Dl mirror = false
1888 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1889 ff2cf171 2019-07-28 stsp .Dq refs/heads
1890 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1891 ff2cf171 2019-07-28 stsp .Cm got checkout
1892 ff2cf171 2019-07-28 stsp and, if needed, created with
1893 ff2cf171 2019-07-28 stsp .Cm got branch .
1895 ff2cf171 2019-07-28 stsp Branches in the
1896 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1897 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1898 ff2cf171 2019-07-28 stsp repository with
1899 469dd726 2020-03-20 stsp .Cm got fetch
1901 469dd726 2020-03-20 stsp .Xr git-fetch 1
1902 469dd726 2020-03-20 stsp without extra command line arguments:
1904 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1905 469dd726 2020-03-20 stsp .Dl $ git fetch
1907 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1908 ff2cf171 2019-07-28 stsp .Dq master
1909 7b0db533 2020-02-04 stsp branch, the
1910 ff2cf171 2019-07-28 stsp .Dq master
1911 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1912 ff2cf171 2019-07-28 stsp .Dq origin/master
1914 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1916 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1917 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1920 083957f4 2020-02-24 stsp .Dq master
1921 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1923 083957f4 2020-02-24 stsp by other developers and any other important new information:
1925 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1926 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1928 7b0db533 2020-02-04 stsp Local changes on the
1929 ff2cf171 2019-07-28 stsp .Dq master
1930 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1931 ff2cf171 2019-07-28 stsp repository with
1932 ff2cf171 2019-07-28 stsp .Cm git push :
1934 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1935 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1936 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1937 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1938 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1939 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1940 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1941 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1942 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1943 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1944 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
1945 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1947 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1948 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1950 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1951 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.