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 89c3c67b 2020-03-20 stsp Objects in the cloned repository are stored in a pack file which is downloaded
181 89c3c67b 2020-03-20 stsp from the server.
182 89c3c67b 2020-03-20 stsp This pack file will then be indexed to facilitate access to the objects stored
184 89c3c67b 2020-03-20 stsp If any objects in the pack file are stored in deltified form, all deltas will
185 89c3c67b 2020-03-20 stsp be fully resolved in order to compute the ID of such objects.
186 89c3c67b 2020-03-20 stsp This can take some time.
188 7848a0e1 2020-03-19 stsp .Cm got clone
189 7848a0e1 2020-03-19 stsp creates a remote repository entry in the
191 7848a0e1 2020-03-19 stsp file of the cloned repository to store the
192 7848a0e1 2020-03-19 stsp .Ar repository-url
193 7848a0e1 2020-03-19 stsp for future use by
194 7848a0e1 2020-03-19 stsp .Cm got fetch
196 7848a0e1 2020-03-19 stsp .Xr git-fetch 1 .
198 2ab43947 2020-03-18 stsp The options for
199 2ab43947 2020-03-18 stsp .Cm got clone
200 2ab43947 2020-03-18 stsp are as follows:
201 2ab43947 2020-03-18 stsp .Bl -tag -width Ds
203 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
204 659e7fbd 2020-03-20 stsp If this option is not specified, a branch resolved via the repository's HEAD
205 659e7fbd 2020-03-20 stsp reference will be fetched.
207 469dd726 2020-03-20 stsp Create the cloned repository as a mirror of the original repository.
208 469dd726 2020-03-20 stsp This is useful if the cloned repository will not be used to store
209 469dd726 2020-03-20 stsp local changes as created by
210 469dd726 2020-03-20 stsp .Cm got commit .
212 469dd726 2020-03-20 stsp The repository's
214 469dd726 2020-03-20 stsp file will be set up with the
216 469dd726 2020-03-20 stsp option enabled, such that
217 469dd726 2020-03-20 stsp .Cm got fetch
219 469dd726 2020-03-20 stsp .Xr git-fetch 1
220 469dd726 2020-03-20 stsp will write incoming changes directly to branches in the
221 469dd726 2020-03-20 stsp .Dq refs/heads/
222 469dd726 2020-03-20 stsp reference namespace, rather than to branches in the
223 469dd726 2020-03-20 stsp .Dq refs/remotes/
225 469dd726 2020-03-20 stsp This avoids the usual requirement of having to run
226 469dd726 2020-03-20 stsp .Cm got rebase
228 469dd726 2020-03-20 stsp .Cm got fetch
229 469dd726 2020-03-20 stsp in order to make incoming changes appear on branches in the
230 469dd726 2020-03-20 stsp .Dq refs/heads/
232 469dd726 2020-03-20 stsp But maintaining custom branches with local changes in the cloned
233 469dd726 2020-03-20 stsp repository becomes difficult since local changes are at risk of
234 469dd726 2020-03-20 stsp being discarded whenever incoming changes are fetched.
236 2ab43947 2020-03-18 stsp Suppress progress reporting output.
237 2ab43947 2020-03-18 stsp The same option will be passed to
239 2ab43947 2020-03-18 stsp if applicable.
241 2ab43947 2020-03-18 stsp Increase the verbosity of progress reporting output.
242 2ab43947 2020-03-18 stsp The same option will be passed to
244 2ab43947 2020-03-18 stsp if applicable.
245 2ab43947 2020-03-18 stsp Multiple -v options increase the verbosity.
246 2ab43947 2020-03-18 stsp The maximum is 3.
249 267fe567 2020-03-18 stsp Short alias for
250 267fe567 2020-03-18 stsp .Cm clone .
251 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
252 7848a0e1 2020-03-19 stsp Fetch new changes from a remote repository.
254 7848a0e1 2020-03-19 stsp .Ar remote-repository-name
255 7848a0e1 2020-03-19 stsp is specified the name
257 7848a0e1 2020-03-19 stsp will be used.
258 7848a0e1 2020-03-19 stsp The remote repository's URL is obtained from the corresponding entry in the
260 7848a0e1 2020-03-19 stsp file of the repository, as created by
261 7848a0e1 2020-03-19 stsp .Cm got clone .
263 89c3c67b 2020-03-20 stsp New changes will be stored in a separate pack file downloaded from the server.
264 89c3c67b 2020-03-20 stsp Optionally, separate pack files stored in the repository can be combined with
265 89c3c67b 2020-03-20 stsp .Xr git-repack 1 .
267 7848a0e1 2020-03-19 stsp Branch references in the
268 7848a0e1 2020-03-19 stsp .Dq refs/remotes/
269 469dd726 2020-03-20 stsp reference namespace will be updated to point at the newly fetched commits,
271 7848a0e1 2020-03-19 stsp .Cm got rebase
272 7848a0e1 2020-03-19 stsp command can then be used to make new changes visible on branches in the
273 7848a0e1 2020-03-19 stsp .Dq refs/heads/
274 469dd726 2020-03-20 stsp reference namespace, merging incoming changes with local changes as necessary.
276 469dd726 2020-03-20 stsp However, if the repository is configured as a mirror then all references will
277 469dd726 2020-03-20 stsp be updated as needed to match the corresponding references in the remote
278 469dd726 2020-03-20 stsp repository, including branches in the
279 469dd726 2020-03-20 stsp .Dq refs/heads/
280 469dd726 2020-03-20 stsp reference namespace.
281 469dd726 2020-03-20 stsp If those branches contained local commits, these will no longer be reachable
282 469dd726 2020-03-20 stsp via a reference and will therefore be at risk of being discarded by Git's
283 469dd726 2020-03-20 stsp garbage collector.
285 469dd726 2020-03-20 stsp In any case, existing references in the
286 7848a0e1 2020-03-19 stsp .Dq refs/tags/
287 469dd726 2020-03-20 stsp namespace will always be changed to match tags contained in the remote
288 469dd726 2020-03-20 stsp repository.
290 7848a0e1 2020-03-19 stsp The options for
291 7848a0e1 2020-03-19 stsp .Cm got fetch
292 7848a0e1 2020-03-19 stsp are as follows:
293 7848a0e1 2020-03-19 stsp .Bl -tag -width Ds
295 659e7fbd 2020-03-20 stsp Fetch all branches from the remote repository.
296 659e7fbd 2020-03-20 stsp If this option is not specified, a branch resolved via the repository's HEAD
297 659e7fbd 2020-03-20 stsp reference will be fetched.
298 7848a0e1 2020-03-19 stsp .It Fl r Ar repository-path
299 7848a0e1 2020-03-19 stsp Use the repository at the specified path.
300 7848a0e1 2020-03-19 stsp If not specified, assume the repository is located at or above the current
301 7848a0e1 2020-03-19 stsp working directory.
302 7848a0e1 2020-03-19 stsp If this directory is a
304 7848a0e1 2020-03-19 stsp work tree, use the repository path associated with this work tree.
306 7848a0e1 2020-03-19 stsp Suppress progress reporting output.
307 7848a0e1 2020-03-19 stsp The same option will be passed to
309 7848a0e1 2020-03-19 stsp if applicable.
311 7848a0e1 2020-03-19 stsp Increase the verbosity of progress reporting output.
312 7848a0e1 2020-03-19 stsp The same option will be passed to
314 7848a0e1 2020-03-19 stsp if applicable.
315 7848a0e1 2020-03-19 stsp Multiple -v options increase the verbosity.
316 7848a0e1 2020-03-19 stsp The maximum is 3.
319 7848a0e1 2020-03-19 stsp Short alias for
320 7848a0e1 2020-03-19 stsp .Cm fetch .
321 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
322 0bb8a95e 2018-03-12 stsp Copy files from a repository into a new work tree.
323 bb51a5b4 2020-01-13 stsp Show the status of each affected file, using the following status codes:
324 bb51a5b4 2020-01-13 stsp .Bl -column YXZ description
325 bb51a5b4 2020-01-13 stsp .It A Ta new file was added
326 bb51a5b4 2020-01-13 stsp .It E Ta file already exists in work tree's meta-data
330 5d7c1dab 2018-04-01 stsp .Ar work tree path
331 c844a238 2019-02-06 stsp is not specified, either use the last component of
332 5d7c1dab 2018-04-01 stsp .Ar repository path ,
334 5d7c1dab 2018-04-01 stsp .Ar path prefix
335 c844a238 2019-02-06 stsp was specified use the last component of
336 5d7c1dab 2018-04-01 stsp .Ar path prefix .
338 38e11793 2018-06-13 stsp The options for
339 38e11793 2018-06-13 stsp .Cm got checkout
340 38e11793 2018-06-13 stsp are as follows:
341 38e11793 2018-06-13 stsp .Bl -tag -width Ds
343 bb51a5b4 2020-01-13 stsp Proceed with the checkout operation even if the directory at
344 bb51a5b4 2020-01-13 stsp .Ar work-tree-path
345 bb51a5b4 2020-01-13 stsp is not empty.
346 bb51a5b4 2020-01-13 stsp Existing files will be left intact.
347 08573d5b 2019-05-14 stsp .It Fl b Ar branch
348 3c575567 2019-07-28 stsp Check out files from a commit on the specified
349 08573d5b 2019-05-14 stsp .Ar branch .
350 08573d5b 2019-05-14 stsp If this option is not specified, a branch resolved via the repository's HEAD
351 08573d5b 2019-05-14 stsp reference will be used.
352 8069f636 2019-01-12 stsp .It Fl c Ar commit
353 8069f636 2019-01-12 stsp Check out files from the specified
355 3c575567 2019-07-28 stsp on the selected branch.
356 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
357 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
358 0e1b0230 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
359 0e1b0230 2019-07-07 stsp automatically, provided the abbreviation is unique.
360 08573d5b 2019-05-14 stsp If this option is not specified, the most recent commit on the selected
361 08573d5b 2019-05-14 stsp branch will be used.
363 4b6c9460 2020-03-05 stsp If the specified
365 4b6c9460 2020-03-05 stsp is not contained in the selected branch, a different branch which contains
366 4b6c9460 2020-03-05 stsp this commit must be specified with the
369 4b6c9460 2020-03-05 stsp If no such branch is known a new branch must be created for this
370 4b6c9460 2020-03-05 stsp commit with
371 4b6c9460 2020-03-05 stsp .Cm got branch
373 4b6c9460 2020-03-05 stsp .Cm got checkout
374 4b6c9460 2020-03-05 stsp can be used.
375 4b6c9460 2020-03-05 stsp Checking out work trees with an unknown branch is intentionally not supported.
376 38e11793 2018-06-13 stsp .It Fl p Ar path-prefix
377 38e11793 2018-06-13 stsp Restrict the work tree to a subset of the repository's tree hierarchy.
378 38e11793 2018-06-13 stsp Only files beneath the specified
379 38e11793 2018-06-13 stsp .Ar path-prefix
380 38e11793 2018-06-13 stsp will be checked out.
383 97b3a7be 2019-07-09 stsp Short alias for
384 97b3a7be 2019-07-09 stsp .Cm checkout .
385 dfc23429 2019-08-11 stsp .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
386 024e9686 2019-05-14 stsp Update an existing work tree to a different commit.
387 7f838b36 2019-02-08 stsp Show the status of each affected file, using the following status codes:
388 7f838b36 2019-02-08 stsp .Bl -column YXZ description
389 7f838b36 2019-02-08 stsp .It U Ta file was updated and contained no local changes
390 7f838b36 2019-02-08 stsp .It G Ta file was updated and local changes were merged cleanly
391 7f838b36 2019-02-08 stsp .It C Ta file was updated and conflicts occurred during merge
392 7f838b36 2019-02-08 stsp .It D Ta file was deleted
393 7f838b36 2019-02-08 stsp .It A Ta new file was added
394 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
395 a378724f 2019-02-10 stsp .It ! Ta a missing versioned file was restored
400 f2ea84fa 2019-07-27 stsp is specified, update the entire work tree.
401 f2ea84fa 2019-07-27 stsp Otherwise, restrict the update operation to files at or within the
402 f2ea84fa 2019-07-27 stsp specified paths.
403 f2ea84fa 2019-07-27 stsp Each path is required to exist in the update operation's target commit.
404 f2ea84fa 2019-07-27 stsp Files in the work tree outside specified paths will remain unchanged and
405 f2ea84fa 2019-07-27 stsp will retain their previously recorded base commit.
408 f2cf8fbb 2019-04-04 stsp commands may refuse to run while the work tree contains files from
409 c4cdcb68 2019-04-03 stsp multiple base commits.
410 f2cf8fbb 2019-04-04 stsp The base commit of such a work tree can be made consistent by running
411 47ec7be7 2019-05-12 stsp .Cm got update
412 47ec7be7 2019-05-12 stsp across the entire work tree.
413 024e9686 2019-05-14 stsp Specifying a
415 024e9686 2019-05-14 stsp is incompatible with the
419 4ed9f614 2019-08-04 stsp .Cm got update
420 4ed9f614 2019-08-04 stsp cannot update paths with staged changes.
421 4ed9f614 2019-08-04 stsp If changes have been staged with
422 4ed9f614 2019-08-04 stsp .Cm got stage ,
423 bc3056e3 2019-08-18 stsp these changes must first be committed with
424 4ed9f614 2019-08-04 stsp .Cm got commit
425 4ed9f614 2019-08-04 stsp or unstaged with
426 4ed9f614 2019-08-04 stsp .Cm got unstage .
428 507dc3bb 2018-12-29 stsp The options for
429 507dc3bb 2018-12-29 stsp .Cm got update
430 507dc3bb 2018-12-29 stsp are as follows:
431 507dc3bb 2018-12-29 stsp .Bl -tag -width Ds
432 024e9686 2019-05-14 stsp .It Fl b Ar branch
433 024e9686 2019-05-14 stsp Switch the work tree's branch reference to the specified
435 024e9686 2019-05-14 stsp before updating the work tree.
436 024e9686 2019-05-14 stsp This option requires that all paths in the work tree are updated.
437 507dc3bb 2018-12-29 stsp .It Fl c Ar commit
438 507dc3bb 2018-12-29 stsp Update the work tree to the specified
439 507dc3bb 2018-12-29 stsp .Ar commit .
440 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
441 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
442 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
443 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
444 024e9686 2019-05-14 stsp If this option is not specified, the most recent commit on the work tree's
445 024e9686 2019-05-14 stsp branch will be used.
448 97b3a7be 2019-07-09 stsp Short alias for
449 97b3a7be 2019-07-09 stsp .Cm update .
450 dfc23429 2019-08-11 stsp .It Cm status Op Ar path ...
451 6cd959e6 2019-03-26 stsp Show the current modification status of files in a work tree,
452 6bad629b 2019-02-04 stsp using the following status codes:
453 6bad629b 2019-02-04 stsp .Bl -column YXZ description
454 6bad629b 2019-02-04 stsp .It M Ta modified file
455 079890a9 2019-03-26 stsp .It A Ta file scheduled for addition in next commit
456 079890a9 2019-03-26 stsp .It D Ta file scheduled for deletion in next commit
457 7154f6ce 2019-03-27 stsp .It C Ta modified or added file which contains merge conflicts
458 6bad629b 2019-02-04 stsp .It ! Ta versioned file was expected on disk but is missing
459 1dd86744 2019-08-12 anthony .It \(a~ Ta versioned file is obstructed by a non-regular file
460 6bad629b 2019-02-04 stsp .It ? Ta unversioned item not tracked by
462 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
463 2a06fe5f 2019-08-24 stsp .It N Ta non-existent
465 2a06fe5f 2019-08-24 stsp specified on the command line
470 72ea6654 2019-07-27 stsp is specified, show modifications in the entire work tree.
471 72ea6654 2019-07-27 stsp Otherwise, show modifications at or within the specified paths.
473 4ed9f614 2019-08-04 stsp If changes have been staged with
474 4ed9f614 2019-08-04 stsp .Cm got stage ,
475 4ed9f614 2019-08-04 stsp staged changes are shown in the second output column, using the following
476 4ed9f614 2019-08-04 stsp status codes:
477 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
478 4ed9f614 2019-08-04 stsp .It M Ta file modification is staged
479 4ed9f614 2019-08-04 stsp .It A Ta file addition is staged
480 4ed9f614 2019-08-04 stsp .It D Ta file deletion is staged
483 95ac67f0 2019-08-08 stsp Changes created on top of staged changes are indicated in the first column:
484 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
485 95ac67f0 2019-08-08 stsp .It MM Ta file was modified after earlier changes have been staged
486 95ac67f0 2019-08-08 stsp .It MA Ta file was modified after having been staged for addition
489 6841da00 2019-08-08 stsp For compatibility with
492 bd8de430 2019-10-04 stsp .Xr git 1 ,
493 6841da00 2019-08-08 stsp .Cm got status
496 bd8de430 2019-10-04 stsp patterns from
497 6841da00 2019-08-08 stsp .Pa .cvsignore
499 bd8de430 2019-10-04 stsp .Pa .gitignore
500 6841da00 2019-08-08 stsp files in each traversed directory and will not display unversioned files
501 bd8de430 2019-10-04 stsp which match these patterns.
502 bd8de430 2019-10-04 stsp As an extension to
504 bd8de430 2019-10-04 stsp matching rules,
505 bd8de430 2019-10-04 stsp .Cm got status
506 bd8de430 2019-10-04 stsp supports consecutive asterisks,
508 bd8de430 2019-10-04 stsp which will match an arbitrary amount of directories.
510 6841da00 2019-08-08 stsp .Xr cvs 1 ,
511 6841da00 2019-08-08 stsp .Cm got status
512 6841da00 2019-08-08 stsp only supports a single ignore pattern per line.
514 bd8de430 2019-10-04 stsp .Xr git 1 ,
515 bd8de430 2019-10-04 stsp .Cm got status
516 bd8de430 2019-10-04 stsp does not support negated ignore patterns prefixed with
518 bd8de430 2019-10-04 stsp and gives no special significance to the location of path component separators,
520 bd8de430 2019-10-04 stsp in a pattern.
522 97b3a7be 2019-07-09 stsp Short alias for
523 97b3a7be 2019-07-09 stsp .Cm status .
524 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
525 38e11793 2018-06-13 stsp Display history of a repository.
528 04ca23f4 2018-07-16 stsp is specified, show only commits which modified this path.
529 dc990cbf 2020-02-22 stsp If invoked in a work tree, the
531 dc990cbf 2020-02-22 stsp is interpreted relative to the current working directory,
532 dc990cbf 2020-02-22 stsp and the work tree's path prefix is implicitly prepended.
533 dc990cbf 2020-02-22 stsp Otherwise, the path is interpreted relative to the repository root.
535 38e11793 2018-06-13 stsp The options for
536 38e11793 2018-06-13 stsp .Cm got log
537 38e11793 2018-06-13 stsp are as follows:
538 38e11793 2018-06-13 stsp .Bl -tag -width Ds
540 1137e0ae 2020-01-27 stsp Display individual commits which were merged into the current branch
541 1137e0ae 2020-01-27 stsp from other branches.
542 48c8c60d 2020-01-27 stsp By default,
543 48c8c60d 2020-01-27 stsp .Cm got log
544 48c8c60d 2020-01-27 stsp shows the linear history of the current branch only.
545 38e11793 2018-06-13 stsp .It Fl c Ar commit
546 38e11793 2018-06-13 stsp Start traversing history at the specified
547 38e11793 2018-06-13 stsp .Ar commit .
548 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
549 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
550 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
551 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
552 1cc14b9f 2019-05-14 stsp If this option is not specified, default to the work tree's current branch
553 1cc14b9f 2019-05-14 stsp if invoked in a work tree, or to the repository's HEAD reference.
554 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
555 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in diffs with
557 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
558 6238ee32 2018-06-13 stsp .It Fl l Ar N
559 6238ee32 2018-06-13 stsp Limit history traversal to a given number of commits.
560 b1ebc001 2019-08-13 stsp If this option is not specified, a default limit value of zero is used,
561 b1ebc001 2019-08-13 stsp which is treated as an unbounded limit.
563 b1ebc001 2019-08-13 stsp .Ev GOT_LOG_DEFAULT_LIMIT
564 b1ebc001 2019-08-13 stsp environment variable may be set to change this default value.
566 6238ee32 2018-06-13 stsp Display the patch of modifications made in each commit.
569 44392932 2019-08-25 stsp is specified, only show the patch of modifications at or within this path.
570 c6390436 2019-11-29 kn .It Fl s Ar search-pattern
571 c6390436 2019-11-29 kn If specified, show only commits with a log message matched by the extended
572 6841bf13 2019-11-29 kn regular expression
573 6841bf13 2019-11-29 kn .Ar search-pattern .
574 6841bf13 2019-11-29 kn Regular expression syntax is documented in
575 6841bf13 2019-11-29 kn .Xr re_format 7 .
576 04ca23f4 2018-07-16 stsp .It Fl r Ar repository-path
577 04ca23f4 2018-07-16 stsp Use the repository at the specified path.
578 04ca23f4 2018-07-16 stsp If not specified, assume the repository is located at or above the current
579 04ca23f4 2018-07-16 stsp working directory.
580 e9cf2e30 2019-02-05 stsp If this directory is a
582 e9cf2e30 2019-02-05 stsp work tree, use the repository path associated with this work tree.
584 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
585 927df6b7 2019-02-10 stsp When invoked within a work tree with less than two arguments, display
586 927df6b7 2019-02-10 stsp uncommitted changes in the work tree.
589 927df6b7 2019-02-10 stsp is specified, only show changes within this path.
591 d24820bf 2019-08-11 stsp If two arguments are provided, treat each argument as a reference, a tag
592 d24820bf 2019-08-11 stsp name, or an object ID SHA1 hash, and display differences between the
593 d24820bf 2019-08-11 stsp corresponding objects.
594 3f8b7d6a 2018-04-01 stsp Both objects must be of the same type (blobs, trees, or commits).
595 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
596 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
598 c0cc5c62 2018-10-18 stsp The options for
599 c0cc5c62 2018-10-18 stsp .Cm got diff
600 c0cc5c62 2018-10-18 stsp are as follows:
601 c0cc5c62 2018-10-18 stsp .Bl -tag -width Ds
602 c0cc5c62 2018-10-18 stsp .It Fl C Ar number
603 c0cc5c62 2018-10-18 stsp Set the number of context lines shown in the diff.
604 c0cc5c62 2018-10-18 stsp By default, 3 lines of context are shown.
605 b72f483a 2019-02-05 stsp .It Fl r Ar repository-path
606 b72f483a 2019-02-05 stsp Use the repository at the specified path.
607 b72f483a 2019-02-05 stsp If not specified, assume the repository is located at or above the current
608 b72f483a 2019-02-05 stsp working directory.
609 b72f483a 2019-02-05 stsp If this directory is a
611 b72f483a 2019-02-05 stsp work tree, use the repository path associated with this work tree.
613 4ed9f614 2019-08-04 stsp Show changes staged with
614 4ed9f614 2019-08-04 stsp .Cm got stage
615 4ed9f614 2019-08-04 stsp instead of showing local changes.
616 4ed9f614 2019-08-04 stsp This option is only valid when
617 4ed9f614 2019-08-04 stsp .Cm got diff
618 4ed9f614 2019-08-04 stsp is invoked in a work tree.
620 63035f9f 2019-10-06 stsp Ignore whitespace-only changes.
623 bc26cce8 2019-08-04 stsp Short alias for
625 dfc23429 2019-08-11 stsp .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
626 1ff8e573 2018-08-02 stsp Display line-by-line history of a file at the specified path.
628 1ff8e573 2018-08-02 stsp The options for
629 1ff8e573 2018-08-02 stsp .Cm got blame
630 1ff8e573 2018-08-02 stsp are as follows:
631 1ff8e573 2018-08-02 stsp .Bl -tag -width Ds
632 1ff8e573 2018-08-02 stsp .It Fl c Ar commit
633 1ff8e573 2018-08-02 stsp Start traversing history at the specified
634 1ff8e573 2018-08-02 stsp .Ar commit .
635 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
636 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
637 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
638 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
639 1ff8e573 2018-08-02 stsp .It Fl r Ar repository-path
640 1ff8e573 2018-08-02 stsp Use the repository at the specified path.
641 1ff8e573 2018-08-02 stsp If not specified, assume the repository is located at or above the current
642 1ff8e573 2018-08-02 stsp working directory.
643 0c06baac 2019-02-05 stsp If this directory is a
645 0c06baac 2019-02-05 stsp work tree, use the repository path associated with this work tree.
648 bc26cce8 2019-08-04 stsp Short alias for
649 bc26cce8 2019-08-04 stsp .Cm blame .
650 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
651 5de5890b 2018-10-18 stsp Display a listing of files and directories at the specified
652 5de5890b 2018-10-18 stsp directory path in the repository.
653 db0c2996 2019-02-10 stsp Entries shown in this listing may carry one of the following trailing
654 db0c2996 2019-02-10 stsp annotations:
655 db0c2996 2019-02-10 stsp .Bl -column YXZ description
656 848d6979 2019-08-12 stsp .It @ Ta entry is a symbolic link
657 db0c2996 2019-02-10 stsp .It / Ta entry is a directory
658 db0c2996 2019-02-10 stsp .It * Ta entry is an executable file
659 63c5ca5d 2019-08-24 stsp .It $ Ta entry is a Git submodule
664 0c849583 2019-02-05 stsp is specified, list the repository path corresponding to the current
665 0c849583 2019-02-05 stsp directory of the work tree, or the root directory of the repository
666 0c849583 2019-02-05 stsp if there is no work tree.
668 5de5890b 2018-10-18 stsp The options for
669 5de5890b 2018-10-18 stsp .Cm got tree
670 5de5890b 2018-10-18 stsp are as follows:
671 5de5890b 2018-10-18 stsp .Bl -tag -width Ds
672 5de5890b 2018-10-18 stsp .It Fl c Ar commit
673 5de5890b 2018-10-18 stsp List files and directories as they appear in the specified
674 5de5890b 2018-10-18 stsp .Ar commit .
675 30837e32 2019-07-25 stsp The expected argument is a commit ID SHA1 hash or an existing reference
676 303e2782 2019-08-09 stsp or tag name which will be resolved to a commit ID.
677 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
678 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
679 5de5890b 2018-10-18 stsp .It Fl r Ar repository-path
680 5de5890b 2018-10-18 stsp Use the repository at the specified path.
681 5de5890b 2018-10-18 stsp If not specified, assume the repository is located at or above the current
682 5de5890b 2018-10-18 stsp working directory.
683 0c849583 2019-02-05 stsp If this directory is a
685 0c849583 2019-02-05 stsp work tree, use the repository path associated with this work tree.
687 5de5890b 2018-10-18 stsp Show object IDs of files (blob objects) and directories (tree objects).
689 0c849583 2019-02-05 stsp Recurse into sub-directories in the repository.
692 bc26cce8 2019-08-04 stsp Short alias for
694 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
695 d0eebce4 2019-03-11 stsp Manage references in a repository.
697 d0eebce4 2019-03-11 stsp If no options are passed, expect two arguments and attempt to create,
698 d0eebce4 2019-03-11 stsp or update, the reference with the given
700 d0eebce4 2019-03-11 stsp and make it point at the given
701 d83d9d5c 2019-05-13 stsp .Ar target .
702 f16e4044 2019-10-09 stsp The name must be an absolute reference name, i.e. it must begin with
703 f16e4044 2019-10-09 stsp .Dq refs/ .
704 a54b6686 2019-06-28 stsp The target may be an object ID SHA1 hash or an existing reference which
705 a54b6686 2019-06-28 stsp will be resolved to an object ID.
706 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
707 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
709 d0eebce4 2019-03-11 stsp The options for
710 d0eebce4 2019-03-11 stsp .Cm got ref
711 d0eebce4 2019-03-11 stsp are as follows:
712 d0eebce4 2019-03-11 stsp .Bl -tag -width Ds
713 d0eebce4 2019-03-11 stsp .It Fl r Ar repository-path
714 d0eebce4 2019-03-11 stsp Use the repository at the specified path.
715 d0eebce4 2019-03-11 stsp If not specified, assume the repository is located at or above the current
716 d0eebce4 2019-03-11 stsp working directory.
717 d0eebce4 2019-03-11 stsp If this directory is a
719 d0eebce4 2019-03-11 stsp work tree, use the repository path associated with this work tree.
721 d0eebce4 2019-03-11 stsp List all existing references in the repository.
722 d0eebce4 2019-03-11 stsp .It Fl d Ar name
723 d0eebce4 2019-03-11 stsp Delete the reference with the specified name from the repository.
725 d1c1ae5f 2019-08-12 stsp Create a symbolic reference pointing at the specified
726 d1c1ae5f 2019-08-12 stsp .Ar target ,
727 d1c1ae5f 2019-08-12 stsp which must be an existing reference.
728 d1c1ae5f 2019-08-12 stsp Care should be taken not to create loops between references when
729 d1c1ae5f 2019-08-12 stsp this option is used.
731 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
732 da76fce2 2020-02-24 stsp Create, list, or delete branches.
734 4e759de4 2019-06-26 stsp Branches are managed via references which live in the
735 4e759de4 2019-06-26 stsp .Dq refs/heads/
736 4e759de4 2019-06-26 stsp reference namespace.
738 4e759de4 2019-06-26 stsp .Cm got branch
739 4e759de4 2019-06-26 stsp command operates on references in this namespace only.
741 ad89fa31 2019-10-04 stsp If invoked in a work tree without any arguments, print the name of the
742 ad89fa31 2019-10-04 stsp work tree's current branch.
746 a74f7e83 2019-11-10 stsp argument is passed, attempt to create a branch reference with the given name.
747 a74f7e83 2019-11-10 stsp By default the new branch reference will point at the latest commit on the
748 a74f7e83 2019-11-10 stsp work tree's current branch if invoked in a work tree, and otherwise to a commit
749 a74f7e83 2019-11-10 stsp resolved via the repository's HEAD reference.
751 da76fce2 2020-02-24 stsp If invoked in a work tree, once the branch was created successfully
752 da76fce2 2020-02-24 stsp switch the work tree's head reference to the newly created branch and
753 da76fce2 2020-02-24 stsp update files across the entire work tree, just like
754 da76fce2 2020-02-24 stsp .Cm got update -b Ar name
756 da76fce2 2020-02-24 stsp Show the status of each affected file, using the following status codes:
757 da76fce2 2020-02-24 stsp .Bl -column YXZ description
758 da76fce2 2020-02-24 stsp .It U Ta file was updated and contained no local changes
759 da76fce2 2020-02-24 stsp .It G Ta file was updated and local changes were merged cleanly
760 da76fce2 2020-02-24 stsp .It C Ta file was updated and conflicts occurred during merge
761 da76fce2 2020-02-24 stsp .It D Ta file was deleted
762 da76fce2 2020-02-24 stsp .It A Ta new file was added
763 da76fce2 2020-02-24 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
764 da76fce2 2020-02-24 stsp .It ! Ta a missing versioned file was restored
767 4e759de4 2019-06-26 stsp The options for
768 4e759de4 2019-06-26 stsp .Cm got branch
769 4e759de4 2019-06-26 stsp are as follows:
770 4e759de4 2019-06-26 stsp .Bl -tag -width Ds
771 a74f7e83 2019-11-10 stsp .It Fl c Ar commit
772 a74f7e83 2019-11-10 stsp Make a newly created branch reference point at the specified
773 a74f7e83 2019-11-10 stsp .Ar commit .
774 a74f7e83 2019-11-10 stsp The expected
776 a74f7e83 2019-11-10 stsp argument is a commit ID SHA1 hash or an existing reference
777 a74f7e83 2019-11-10 stsp or tag name which will be resolved to a commit ID.
778 4e759de4 2019-06-26 stsp .It Fl r Ar repository-path
779 4e759de4 2019-06-26 stsp Use the repository at the specified path.
780 4e759de4 2019-06-26 stsp If not specified, assume the repository is located at or above the current
781 4e759de4 2019-06-26 stsp working directory.
782 4e759de4 2019-06-26 stsp If this directory is a
784 4e759de4 2019-06-26 stsp work tree, use the repository path associated with this work tree.
786 4e759de4 2019-06-26 stsp List all existing branches in the repository.
787 ba882ee3 2019-07-11 stsp If invoked in a work tree, the work tree's current branch is shown
788 ba882ee3 2019-07-11 stsp with one the following annotations:
789 ba882ee3 2019-07-11 stsp .Bl -column YXZ description
790 ba882ee3 2019-07-11 stsp .It * Ta work tree's base commit matches the branch tip
791 1dd86744 2019-08-12 anthony .It \(a~ Ta work tree's base commit is out-of-date
793 4e759de4 2019-06-26 stsp .It Fl d Ar name
794 4e759de4 2019-06-26 stsp Delete the branch with the specified name from the repository.
795 7acfb25b 2019-07-11 stsp Only the branch reference is deleted.
796 7acfb25b 2019-07-11 stsp Any commit, tree, and blob objects belonging to the branch
797 74d012d1 2019-07-11 stsp remain in the repository and may be removed separately with
798 ce33d90e 2019-07-14 stsp Git's garbage collector.
800 da76fce2 2020-02-24 stsp Do not switch and update the work tree after creating a new branch.
803 97b3a7be 2019-07-09 stsp Short alias for
804 97b3a7be 2019-07-09 stsp .Cm branch .
805 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
806 8e7bd50a 2019-08-22 stsp Manage tags in a repository.
808 8e7bd50a 2019-08-22 stsp Tags are managed via references which live in the
809 8e7bd50a 2019-08-22 stsp .Dq refs/tags/
810 8e7bd50a 2019-08-22 stsp reference namespace.
812 8e7bd50a 2019-08-22 stsp .Cm got tag
813 8e7bd50a 2019-08-22 stsp command operates on references in this namespace only.
814 b3cd068e 2019-08-22 stsp References in this namespace point at tag objects which contain a pointer
815 b3cd068e 2019-08-22 stsp to another object, a tag message, as well as author and timestamp information.
817 80106605 2020-02-24 stsp Attempt to create a tag with the given
819 8e7bd50a 2019-08-22 stsp and make this tag point at the given
820 8e7bd50a 2019-08-22 stsp .Ar commit .
821 8e7bd50a 2019-08-22 stsp If no commit is specified, default to the latest commit on the work tree's
822 8e7bd50a 2019-08-22 stsp current branch if invoked in a work tree, and to a commit resolved via
823 8e7bd50a 2019-08-22 stsp the repository's HEAD reference otherwise.
825 8e7bd50a 2019-08-22 stsp The options for
826 8e7bd50a 2019-08-22 stsp .Cm got tag
827 8e7bd50a 2019-08-22 stsp are as follows:
828 8e7bd50a 2019-08-22 stsp .Bl -tag -width Ds
829 80106605 2020-02-24 stsp .It Fl c Ar commit
830 80106605 2020-02-24 stsp Make the newly created tag reference point at the specified
831 80106605 2020-02-24 stsp .Ar commit .
832 80106605 2020-02-24 stsp The expected
834 80106605 2020-02-24 stsp argument is a commit ID SHA1 hash or an existing reference or tag name which
835 80106605 2020-02-24 stsp will be resolved to a commit ID.
836 80106605 2020-02-24 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
837 80106605 2020-02-24 stsp automatically, provided the abbreviation is unique.
838 8e7bd50a 2019-08-22 stsp .It Fl m Ar message
839 80106605 2020-02-24 stsp Use the specified tag message when creating the new tag.
840 8e7bd50a 2019-08-22 stsp Without the
843 3a62228f 2019-11-08 stsp .Cm got tag
844 8e7bd50a 2019-08-22 stsp opens a temporary file in an editor where a tag message can be written.
845 8e7bd50a 2019-08-22 stsp .It Fl r Ar repository-path
846 8e7bd50a 2019-08-22 stsp Use the repository at the specified path.
847 8e7bd50a 2019-08-22 stsp If not specified, assume the repository is located at or above the current
848 8e7bd50a 2019-08-22 stsp working directory.
849 8e7bd50a 2019-08-22 stsp If this directory is a
851 8e7bd50a 2019-08-22 stsp work tree, use the repository path associated with this work tree.
853 8e7bd50a 2019-08-22 stsp List all existing tags in the repository instead of creating a new tag.
854 8e7bd50a 2019-08-22 stsp If this option is used, no other command-line arguments are allowed.
857 8e7bd50a 2019-08-22 stsp By design, the
858 8e7bd50a 2019-08-22 stsp .Cm got tag
859 8e7bd50a 2019-08-22 stsp command will not delete tags or change existing tags.
860 8e7bd50a 2019-08-22 stsp If a tag must be deleted, the
861 8e7bd50a 2019-08-22 stsp .Cm got ref
862 8e7bd50a 2019-08-22 stsp command may be used to delete a tag's reference.
863 8e7bd50a 2019-08-22 stsp This should only be done if the tag has not already been copied to
864 8e7bd50a 2019-08-22 stsp another repository.
865 022fae89 2019-12-06 tracey .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
866 8125ddca 2019-05-11 stsp Schedule unversioned files in a work tree for addition to the
867 d00136be 2019-03-26 stsp repository in the next commit.
869 4e68cba3 2019-11-23 stsp The options for
870 4e68cba3 2019-11-23 stsp .Cm got add
871 4e68cba3 2019-11-23 stsp are as follows:
872 4e68cba3 2019-11-23 stsp .Bl -tag -width Ds
874 4e68cba3 2019-11-23 stsp Permit recursion into directories.
875 4e68cba3 2019-11-23 stsp If this option is not specified,
876 4e68cba3 2019-11-23 stsp .Cm got add
877 4e68cba3 2019-11-23 stsp will refuse to run if a specified
879 4e68cba3 2019-11-23 stsp is a directory.
881 022fae89 2019-12-06 tracey With -R, add files even if they match a
882 022fae89 2019-12-06 tracey .Cm got status
883 022fae89 2019-12-06 tracey ignore pattern.
885 c29c428a 2019-12-16 stsp .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
886 17ed4618 2019-06-02 stsp Remove versioned files from a work tree and schedule them for deletion
887 2ec1f75b 2019-03-26 stsp from the repository in the next commit.
889 2ec1f75b 2019-03-26 stsp The options for
890 86d25a1b 2019-07-11 stsp .Cm got remove
891 2ec1f75b 2019-03-26 stsp are as follows:
892 2ec1f75b 2019-03-26 stsp .Bl -tag -width Ds
894 17ed4618 2019-06-02 stsp Perform the operation even if a file contains uncommitted modifications.
896 70e3e7f5 2019-12-13 tracey Keep affected files on disk.
898 f2a9dc41 2019-12-13 tracey Permit recursion into directories.
899 f2a9dc41 2019-12-13 tracey If this option is not specified,
900 f2a9dc41 2019-12-13 tracey .Cm got remove
901 f2a9dc41 2019-12-13 tracey will refuse to run if a specified
903 f2a9dc41 2019-12-13 tracey is a directory.
906 648e4ef7 2019-07-09 stsp Short alias for
907 648e4ef7 2019-07-09 stsp .Cm remove .
908 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 ...
909 bc3056e3 2019-08-18 stsp Revert any uncommitted changes in files at the specified paths.
910 a129376b 2019-03-28 stsp File contents will be overwritten with those contained in the
911 1dd86744 2019-08-12 anthony work tree's base commit.
912 1dd86744 2019-08-12 anthony There is no way to bring discarded changes back after
913 a129376b 2019-03-28 stsp .Cm got revert !
915 e20a8b6f 2019-06-04 stsp If a file was added with
916 a129376b 2019-03-28 stsp .Cm got add
917 a129376b 2019-03-28 stsp it will become an unversioned file again.
918 e20a8b6f 2019-06-04 stsp If a file was deleted with
919 86d25a1b 2019-07-11 stsp .Cm got remove
920 a129376b 2019-03-28 stsp it will be restored.
922 0f6d7415 2019-08-08 stsp The options for
923 0f6d7415 2019-08-08 stsp .Cm got revert
924 0f6d7415 2019-08-08 stsp are as follows:
925 0f6d7415 2019-08-08 stsp .Bl -tag -width Ds
927 33aa809d 2019-08-08 stsp Instead of reverting all changes in files, interactively select or reject
928 33aa809d 2019-08-08 stsp changes to revert based on
930 33aa809d 2019-08-08 stsp (revert change),
932 33aa809d 2019-08-08 stsp (keep change), and
934 33aa809d 2019-08-08 stsp (quit reverting this file) responses.
935 33aa809d 2019-08-08 stsp If a file is in modified status, individual patches derived from the
936 33aa809d 2019-08-08 stsp modified file content can be reverted.
937 33aa809d 2019-08-08 stsp Files in added or deleted status may only be reverted in their entirety.
938 33aa809d 2019-08-08 stsp .It Fl F Ar response-script
941 33aa809d 2019-08-08 stsp option, read
946 33aa809d 2019-08-08 stsp responses line-by-line from the specified
947 33aa809d 2019-08-08 stsp .Ar response-script
948 33aa809d 2019-08-08 stsp file instead of prompting interactively.
950 0f6d7415 2019-08-08 stsp Permit recursion into directories.
951 0f6d7415 2019-08-08 stsp If this option is not specified,
952 0f6d7415 2019-08-08 stsp .Cm got revert
953 0f6d7415 2019-08-08 stsp will refuse to run if a specified
955 0f6d7415 2019-08-08 stsp is a directory.
958 97b3a7be 2019-07-09 stsp Short alias for
959 97b3a7be 2019-07-09 stsp .Cm revert .
960 dfc23429 2019-08-11 stsp .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
961 4ed9f614 2019-08-04 stsp Create a new commit in the repository from changes in a work tree
962 15cd91f7 2019-05-12 stsp and use this commit as the new base commit for the work tree.
965 4ed9f614 2019-08-04 stsp is specified, commit all changes in the work tree.
966 4ed9f614 2019-08-04 stsp Otherwise, commit changes at or within the specified paths.
968 4ed9f614 2019-08-04 stsp If changes have been explicitly staged for commit with
969 1dd86744 2019-08-12 anthony .Cm got stage ,
970 4ed9f614 2019-08-04 stsp only commit staged changes and reject any specified paths which
971 4ed9f614 2019-08-04 stsp have not been staged.
973 15cd91f7 2019-05-12 stsp Show the status of each affected file, using the following status codes:
974 15cd91f7 2019-05-12 stsp .Bl -column YXZ description
975 15cd91f7 2019-05-12 stsp .It M Ta modified file
976 15cd91f7 2019-05-12 stsp .It D Ta file was deleted
977 15cd91f7 2019-05-12 stsp .It A Ta new file was added
978 1ebedb77 2019-10-19 stsp .It m Ta modified file modes (executable bit only)
981 996d5ccd 2019-08-05 stsp Files which are not part of the new commit will retain their previously
982 996d5ccd 2019-08-05 stsp recorded base commit.
985 15cd91f7 2019-05-12 stsp commands may refuse to run while the work tree contains files from
986 15cd91f7 2019-05-12 stsp multiple base commits.
987 15cd91f7 2019-05-12 stsp The base commit of such a work tree can be made consistent by running
988 47ec7be7 2019-05-12 stsp .Cm got update
989 47ec7be7 2019-05-12 stsp across the entire work tree.
992 15cd91f7 2019-05-12 stsp .Cm got commit
993 15cd91f7 2019-05-12 stsp command requires the
994 74416c47 2019-05-09 stsp .Ev GOT_AUTHOR
995 aba9c984 2019-09-08 stsp environment variable to be set,
996 aba9c984 2019-09-08 stsp unless Git's
997 aba9c984 2019-09-08 stsp .Dv user.name
999 709ae9eb 2019-09-08 stsp .Dv user.email
1000 709ae9eb 2019-09-08 stsp configuration settings can be
1001 aba9c984 2019-09-08 stsp obtained from the repository's
1002 aba9c984 2019-09-08 stsp .Pa .git/config
1003 c9956ddf 2019-09-08 stsp file or from Git's global
1004 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1005 c9956ddf 2019-09-08 stsp configuration file.
1007 74416c47 2019-05-09 stsp The options for
1008 74416c47 2019-05-09 stsp .Cm got commit
1009 74416c47 2019-05-09 stsp are as follows:
1010 74416c47 2019-05-09 stsp .Bl -tag -width Ds
1011 74ff3f23 2019-07-07 stsp .It Fl m Ar message
1012 74416c47 2019-05-09 stsp Use the specified log message when creating the new commit.
1013 23594da9 2019-05-13 stsp Without the
1016 23594da9 2019-05-13 stsp .Cm got commit
1017 23594da9 2019-05-13 stsp opens a temporary file in an editor where a log message can be written.
1020 cfce0458 2019-07-28 stsp .Cm got commit
1021 cfce0458 2019-07-28 stsp will refuse to run if certain preconditions are not met.
1022 916f288c 2019-07-30 stsp If the work tree's current branch is not in the
1023 916f288c 2019-07-30 stsp .Dq refs/heads/
1024 916f288c 2019-07-30 stsp reference namespace, new commits may not be created on this branch.
1025 cfce0458 2019-07-28 stsp Local changes may only be committed if they are based on file content
1026 cfce0458 2019-07-28 stsp found in the most recent commit on the work tree's branch.
1027 cfce0458 2019-07-28 stsp If a path is found to be out of date,
1028 cfce0458 2019-07-28 stsp .Cm got update
1029 cfce0458 2019-07-28 stsp must be used first in order to merge local changes with changes made
1030 cfce0458 2019-07-28 stsp in the repository.
1032 97b3a7be 2019-07-09 stsp Short alias for
1033 97b3a7be 2019-07-09 stsp .Cm commit .
1034 234035bc 2019-06-01 stsp .It Cm cherrypick Ar commit
1035 234035bc 2019-06-01 stsp Merge changes from a single
1036 234035bc 2019-06-01 stsp .Ar commit
1037 234035bc 2019-06-01 stsp into the work tree.
1038 234035bc 2019-06-01 stsp The specified
1039 234035bc 2019-06-01 stsp .Ar commit
1040 234035bc 2019-06-01 stsp must be on a different branch than the work tree's base commit.
1041 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1042 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1043 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1045 234035bc 2019-06-01 stsp Show the status of each affected file, using the following status codes:
1046 234035bc 2019-06-01 stsp .Bl -column YXZ description
1047 234035bc 2019-06-01 stsp .It G Ta file was merged
1048 234035bc 2019-06-01 stsp .It C Ta file was merged and conflicts occurred during merge
1049 234035bc 2019-06-01 stsp .It ! Ta changes destined for a missing file were not merged
1050 234035bc 2019-06-01 stsp .It D Ta file was deleted
1051 2b92fad7 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1052 234035bc 2019-06-01 stsp .It A Ta new file was added
1053 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1056 234035bc 2019-06-01 stsp The merged changes will appear as local changes in the work tree, which
1057 234035bc 2019-06-01 stsp may be viewed with
1058 234035bc 2019-06-01 stsp .Cm got diff ,
1059 234035bc 2019-06-01 stsp amended manually or with further
1060 234035bc 2019-06-01 stsp .Cm got cherrypick
1062 234035bc 2019-06-01 stsp committed with
1063 234035bc 2019-06-01 stsp .Cm got commit ,
1064 234035bc 2019-06-01 stsp or discarded again with
1065 234035bc 2019-06-01 stsp .Cm got revert .
1067 234035bc 2019-06-01 stsp .Cm got cherrypick
1068 234035bc 2019-06-01 stsp will refuse to run if certain preconditions are not met.
1069 234035bc 2019-06-01 stsp If the work tree contains multiple base commits it must first be updated
1070 234035bc 2019-06-01 stsp to a single base commit with
1071 234035bc 2019-06-01 stsp .Cm got update .
1072 234035bc 2019-06-01 stsp If the work tree already contains files with merge conflicts, these
1073 234035bc 2019-06-01 stsp conflicts must be resolved first.
1075 97b3a7be 2019-07-09 stsp Short alias for
1076 97b3a7be 2019-07-09 stsp .Cm cherrypick .
1077 5ef14e63 2019-06-02 stsp .It Cm backout Ar commit
1078 5ef14e63 2019-06-02 stsp Reverse-merge changes from a single
1079 5ef14e63 2019-06-02 stsp .Ar commit
1080 5ef14e63 2019-06-02 stsp into the work tree.
1081 5ef14e63 2019-06-02 stsp The specified
1082 5ef14e63 2019-06-02 stsp .Ar commit
1083 5ef14e63 2019-06-02 stsp must be on the same branch as the work tree's base commit.
1084 a54b6686 2019-06-28 stsp The expected argument is a reference or a commit ID SHA1 hash.
1085 0db75f06 2019-07-07 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1086 0db75f06 2019-07-07 stsp automatically, provided the abbreviation is unique.
1088 5ef14e63 2019-06-02 stsp Show the status of each affected file, using the following status codes:
1089 5ef14e63 2019-06-02 stsp .Bl -column YXZ description
1090 5ef14e63 2019-06-02 stsp .It G Ta file was merged
1091 5ef14e63 2019-06-02 stsp .It C Ta file was merged and conflicts occurred during merge
1092 5ef14e63 2019-06-02 stsp .It ! Ta changes destined for a missing file were not merged
1093 5ef14e63 2019-06-02 stsp .It D Ta file was deleted
1094 5ef14e63 2019-06-02 stsp .It d Ta file's deletion was obstructed by local modifications
1095 5ef14e63 2019-06-02 stsp .It A Ta new file was added
1096 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1099 5ef14e63 2019-06-02 stsp The reverse-merged changes will appear as local changes in the work tree,
1100 5ef14e63 2019-06-02 stsp which may be viewed with
1101 5ef14e63 2019-06-02 stsp .Cm got diff ,
1102 5ef14e63 2019-06-02 stsp amended manually or with further
1103 778a73c2 2019-07-12 stsp .Cm got backout
1105 5ef14e63 2019-06-02 stsp committed with
1106 5ef14e63 2019-06-02 stsp .Cm got commit ,
1107 5ef14e63 2019-06-02 stsp or discarded again with
1108 5ef14e63 2019-06-02 stsp .Cm got revert .
1110 92228c38 2019-06-02 stsp .Cm got backout
1111 92228c38 2019-06-02 stsp will refuse to run if certain preconditions are not met.
1112 92228c38 2019-06-02 stsp If the work tree contains multiple base commits it must first be updated
1113 92228c38 2019-06-02 stsp to a single base commit with
1114 92228c38 2019-06-02 stsp .Cm got update .
1115 92228c38 2019-06-02 stsp If the work tree already contains files with merge conflicts, these
1116 92228c38 2019-06-02 stsp conflicts must be resolved first.
1118 97b3a7be 2019-07-09 stsp Short alias for
1119 97b3a7be 2019-07-09 stsp .Cm backout .
1120 dfc23429 2019-08-11 stsp .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1121 818c7501 2019-07-11 stsp Rebase commits on the specified
1122 818c7501 2019-07-11 stsp .Ar branch
1123 818c7501 2019-07-11 stsp onto the tip of the current branch of the work tree.
1125 818c7501 2019-07-11 stsp .Ar branch
1126 818c7501 2019-07-11 stsp must share common ancestry with the work tree's current branch.
1127 bc3056e3 2019-08-18 stsp Rebasing begins with the first descendant commit of the youngest
1128 f09e2405 2019-07-11 stsp common ancestor commit shared by the specified
1129 818c7501 2019-07-11 stsp .Ar branch
1130 818c7501 2019-07-11 stsp and the work tree's current branch, and stops once the tip commit
1131 f09e2405 2019-07-11 stsp of the specified
1132 818c7501 2019-07-11 stsp .Ar branch
1133 f09e2405 2019-07-11 stsp has been rebased.
1136 2b6826ba 2020-02-24 stsp .Cm got rebase
1137 2b6826ba 2020-02-24 stsp is used as intended, the specified
1138 2b6826ba 2020-02-24 stsp .Ar branch
1139 c10890ce 2020-02-25 stsp represents a local commit history and may already contain changes
1140 c10890ce 2020-02-25 stsp that are not yet visible in any other repositories.
1141 2b6826ba 2020-02-24 stsp The work tree's current branch, which must be set with
1142 2b6826ba 2020-02-24 stsp .Cm got update -b
1143 2b6826ba 2020-02-24 stsp before starting the
1144 2b6826ba 2020-02-24 stsp .Cm rebase
1145 2b6826ba 2020-02-24 stsp operation, represents a branch from a remote repository which shares
1146 2b6826ba 2020-02-24 stsp a common history with the specified
1147 2b6826ba 2020-02-24 stsp .Ar branch
1148 c10890ce 2020-02-25 stsp but has progressed, and perhaps diverged, due to commits added to the
1149 c10890ce 2020-02-25 stsp remote repository.
1151 c6b4581b 2019-07-28 stsp Rebased commits are accumulated on a temporary branch which the work tree
1152 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire rebase operation.
1153 c6b4581b 2019-07-28 stsp Commits on this branch represent the same changes with the same log
1154 c6b4581b 2019-07-28 stsp messages as their counterparts on the original
1155 818c7501 2019-07-11 stsp .Ar branch ,
1156 818c7501 2019-07-11 stsp but with different commit IDs.
1157 818c7501 2019-07-11 stsp Once rebasing has completed successfully, the temporary branch becomes
1158 f09e2405 2019-07-11 stsp the new version of the specified
1159 818c7501 2019-07-11 stsp .Ar branch
1160 818c7501 2019-07-11 stsp and the work tree is automatically switched to it.
1162 818c7501 2019-07-11 stsp While rebasing commits, show the status of each affected file,
1163 818c7501 2019-07-11 stsp using the following status codes:
1164 818c7501 2019-07-11 stsp .Bl -column YXZ description
1165 818c7501 2019-07-11 stsp .It G Ta file was merged
1166 818c7501 2019-07-11 stsp .It C Ta file was merged and conflicts occurred during merge
1167 818c7501 2019-07-11 stsp .It ! Ta changes destined for a missing file were not merged
1168 818c7501 2019-07-11 stsp .It D Ta file was deleted
1169 818c7501 2019-07-11 stsp .It d Ta file's deletion was obstructed by local modifications
1170 818c7501 2019-07-11 stsp .It A Ta new file was added
1171 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1174 f09e2405 2019-07-11 stsp If merge conflicts occur the rebase operation is interrupted and may
1175 f09e2405 2019-07-11 stsp be continued once conflicts have been resolved.
1176 818c7501 2019-07-11 stsp Alternatively, the rebase operation may be aborted which will leave
1177 818c7501 2019-07-11 stsp .Ar branch
1178 818c7501 2019-07-11 stsp unmodified and the work tree switched back to its original branch.
1180 ff0d2220 2019-07-11 stsp If a merge conflict is resolved in a way which renders the merged
1181 f09e2405 2019-07-11 stsp change into a no-op change, the corresponding commit will be elided
1182 f09e2405 2019-07-11 stsp when the rebase operation continues.
1184 818c7501 2019-07-11 stsp .Cm got rebase
1185 818c7501 2019-07-11 stsp will refuse to run if certain preconditions are not met.
1186 a85446b2 2020-01-04 stsp If the work tree is not yet fully updated to the tip commit of its
1187 a85446b2 2020-01-04 stsp branch then the work tree must first be updated with
1188 818c7501 2019-07-11 stsp .Cm got update .
1189 4ed9f614 2019-08-04 stsp If changes have been staged with
1190 4ed9f614 2019-08-04 stsp .Cm got stage ,
1191 bc3056e3 2019-08-18 stsp these changes must first be committed with
1192 4ed9f614 2019-08-04 stsp .Cm got commit
1193 4ed9f614 2019-08-04 stsp or unstaged with
1194 4ed9f614 2019-08-04 stsp .Cm got unstage .
1195 f09e2405 2019-07-11 stsp If the work tree contains local changes, these changes must first be
1196 f09e2405 2019-07-11 stsp committed with
1197 f09e2405 2019-07-11 stsp .Cm got commit
1198 f09e2405 2019-07-11 stsp or reverted with
1199 f09e2405 2019-07-11 stsp .Cm got revert .
1201 64c6d990 2019-07-11 stsp .Ar branch
1202 64c6d990 2019-07-11 stsp contains changes to files outside of the work tree's path prefix,
1203 64c6d990 2019-07-11 stsp the work tree cannot be used to rebase this branch.
1206 7d5807f4 2019-07-11 stsp .Cm got update
1208 7d5807f4 2019-07-11 stsp .Cm got commit
1209 7d5807f4 2019-07-11 stsp commands will refuse to run while a rebase operation is in progress.
1210 7d5807f4 2019-07-11 stsp Other commands which manipulate the work tree may be used for
1211 7d5807f4 2019-07-11 stsp conflict resolution purposes.
1213 818c7501 2019-07-11 stsp The options for
1214 818c7501 2019-07-11 stsp .Cm got rebase
1215 818c7501 2019-07-11 stsp are as follows:
1216 818c7501 2019-07-11 stsp .Bl -tag -width Ds
1218 818c7501 2019-07-11 stsp Abort an interrupted rebase operation.
1219 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1221 06067b48 2019-07-11 stsp Continue an interrupted rebase operation.
1222 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1225 818c7501 2019-07-11 stsp Short alias for
1226 818c7501 2019-07-11 stsp .Cm rebase .
1227 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
1228 0ebf8283 2019-07-24 stsp Edit commit history between the work tree's current base commit and
1229 0ebf8283 2019-07-24 stsp the tip commit of the work tree's current branch.
1231 6e54d307 2020-02-24 stsp Before starting a
1232 6e54d307 2020-02-24 stsp .Cm histedit
1233 6e54d307 2020-02-24 stsp operation the work tree's current branch must be set with
1234 6e54d307 2020-02-24 stsp .Cm got update -b
1235 6e54d307 2020-02-24 stsp to the branch which should be edited, unless this branch is already the
1236 6e54d307 2020-02-24 stsp current branch of the work tree.
1237 6e54d307 2020-02-24 stsp The tip of this branch represents the upper bound (inclusive) of commits
1238 6e54d307 2020-02-24 stsp touched by the
1239 6e54d307 2020-02-24 stsp .Cm histedit
1240 6e54d307 2020-02-24 stsp operation.
1242 6e54d307 2020-02-24 stsp Furthermore, the work tree's base commit
1243 6e54d307 2020-02-24 stsp must be set with
1244 6e54d307 2020-02-24 stsp .Cm got update -c
1245 6e54d307 2020-02-24 stsp to a point in this branch's commit history where editing should begin.
1246 6e54d307 2020-02-24 stsp This commit represents the lower bound (non-inclusive) of commits touched
1248 6e54d307 2020-02-24 stsp .Cm histedit
1249 6e54d307 2020-02-24 stsp operation.
1251 0ebf8283 2019-07-24 stsp Editing of commit history is controlled via a
1252 0ebf8283 2019-07-24 stsp .Ar histedit script
1253 46fa4c83 2020-02-24 stsp which can be written in an editor based on a template, passed on the
1254 46fa4c83 2020-02-24 stsp command line, or generated with the
1256 083957f4 2020-02-24 stsp option if only log messages need to be edited.
1258 0ebf8283 2019-07-24 stsp The format of the histedit script is line-based.
1259 0ebf8283 2019-07-24 stsp Each line in the script begins with a command name, followed by
1260 0ebf8283 2019-07-24 stsp whitespace and an argument.
1261 0ebf8283 2019-07-24 stsp For most commands, the expected argument is a commit ID SHA1 hash.
1262 0ebf8283 2019-07-24 stsp Any remaining text on the line is ignored.
1263 0ebf8283 2019-07-24 stsp Lines which begin with the
1265 0ebf8283 2019-07-24 stsp character are ignored entirely.
1267 0ebf8283 2019-07-24 stsp The available commands are as follows:
1268 0ebf8283 2019-07-24 stsp .Bl -column YXZ pick-commit
1269 0ebf8283 2019-07-24 stsp .It pick Ar commit Ta Use the specified commit as it is.
1270 a698f62e 2019-07-25 stsp .It edit Ar commit Ta Use the specified commit but once changes have been
1271 0ebf8283 2019-07-24 stsp merged into the work tree interrupt the histedit operation for amending.
1272 0ebf8283 2019-07-24 stsp .It fold Ar commit Ta Combine the specified commit with the next commit
1273 0ebf8283 2019-07-24 stsp listed further below that will be used.
1274 0ebf8283 2019-07-24 stsp .It drop Ar commit Ta Remove this commit from the edited history.
1275 0ebf8283 2019-07-24 stsp .It mesg Ar log-message Ta Use the specified single-line log message for
1276 0ebf8283 2019-07-24 stsp the commit on the previous line.
1277 0ebf8283 2019-07-24 stsp If the log message argument is left empty, open an editor where a new
1278 0ebf8283 2019-07-24 stsp log message can be written.
1281 ba67992e 2019-07-25 stsp Every commit in the history being edited must be mentioned in the script.
1282 0ebf8283 2019-07-24 stsp Lines may be re-ordered to change the order of commits in the edited history.
1283 5b87815e 2020-03-05 stsp No commit may be listed more than once.
1285 c6b4581b 2019-07-28 stsp Edited commits are accumulated on a temporary branch which the work tree
1286 c6b4581b 2019-07-28 stsp will remain switched to throughout the entire histedit operation.
1287 0ebf8283 2019-07-24 stsp Once history editing has completed successfully, the temporary branch becomes
1288 498a90b7 2019-07-25 stsp the new version of the work tree's branch and the work tree is automatically
1289 498a90b7 2019-07-25 stsp switched to it.
1291 0ebf8283 2019-07-24 stsp While merging commits, show the status of each affected file,
1292 0ebf8283 2019-07-24 stsp using the following status codes:
1293 0ebf8283 2019-07-24 stsp .Bl -column YXZ description
1294 0ebf8283 2019-07-24 stsp .It G Ta file was merged
1295 0ebf8283 2019-07-24 stsp .It C Ta file was merged and conflicts occurred during merge
1296 0ebf8283 2019-07-24 stsp .It ! Ta changes destined for a missing file were not merged
1297 0ebf8283 2019-07-24 stsp .It D Ta file was deleted
1298 0ebf8283 2019-07-24 stsp .It d Ta file's deletion was obstructed by local modifications
1299 0ebf8283 2019-07-24 stsp .It A Ta new file was added
1300 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1303 0ebf8283 2019-07-24 stsp If merge conflicts occur the histedit operation is interrupted and may
1304 0ebf8283 2019-07-24 stsp be continued once conflicts have been resolved.
1305 0ebf8283 2019-07-24 stsp Alternatively, the histedit operation may be aborted which will leave
1306 0ebf8283 2019-07-24 stsp the work tree switched back to its original branch.
1308 0ebf8283 2019-07-24 stsp If a merge conflict is resolved in a way which renders the merged
1309 0ebf8283 2019-07-24 stsp change into a no-op change, the corresponding commit will be elided
1310 0ebf8283 2019-07-24 stsp when the histedit operation continues.
1312 0ebf8283 2019-07-24 stsp .Cm got histedit
1313 0ebf8283 2019-07-24 stsp will refuse to run if certain preconditions are not met.
1314 c7d20a3f 2019-07-30 stsp If the work tree's current branch is not in the
1315 c7d20a3f 2019-07-30 stsp .Dq refs/heads/
1316 c7d20a3f 2019-07-30 stsp reference namespace, the history of the branch may not be edited.
1317 0ebf8283 2019-07-24 stsp If the work tree contains multiple base commits it must first be updated
1318 0ebf8283 2019-07-24 stsp to a single base commit with
1319 0ebf8283 2019-07-24 stsp .Cm got update .
1320 4ed9f614 2019-08-04 stsp If changes have been staged with
1321 4ed9f614 2019-08-04 stsp .Cm got stage ,
1322 bc3056e3 2019-08-18 stsp these changes must first be committed with
1323 4ed9f614 2019-08-04 stsp .Cm got commit
1324 4ed9f614 2019-08-04 stsp or unstaged with
1325 4ed9f614 2019-08-04 stsp .Cm got unstage .
1326 0ebf8283 2019-07-24 stsp If the work tree contains local changes, these changes must first be
1327 0ebf8283 2019-07-24 stsp committed with
1328 0ebf8283 2019-07-24 stsp .Cm got commit
1329 0ebf8283 2019-07-24 stsp or reverted with
1330 0ebf8283 2019-07-24 stsp .Cm got revert .
1331 0ebf8283 2019-07-24 stsp If the edited history contains changes to files outside of the work tree's
1332 0ebf8283 2019-07-24 stsp path prefix, the work tree cannot be used to edit the history of this branch.
1335 7ef62c4e 2020-02-24 stsp .Cm got update ,
1336 7ef62c4e 2020-02-24 stsp .Cm got rebase ,
1338 65db4ffb 2020-02-24 stsp .Cm got integrate
1339 65db4ffb 2020-02-24 stsp commands will refuse to run while a histedit operation is in progress.
1340 a698f62e 2019-07-25 stsp Other commands which manipulate the work tree may be used, and the
1341 0ebf8283 2019-07-24 stsp .Cm got commit
1342 a698f62e 2019-07-25 stsp command may be used to commit arbitrary changes to the temporary branch
1343 a698f62e 2019-07-25 stsp while the histedit operation is interrupted.
1345 0ebf8283 2019-07-24 stsp The options for
1346 0ebf8283 2019-07-24 stsp .Cm got histedit
1347 0ebf8283 2019-07-24 stsp are as follows:
1348 0ebf8283 2019-07-24 stsp .Bl -tag -width Ds
1350 0ebf8283 2019-07-24 stsp Abort an interrupted histedit operation.
1351 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1353 0ebf8283 2019-07-24 stsp Continue an interrupted histedit operation.
1354 c478f6d8 2019-08-08 stsp If this option is used, no other command-line arguments are allowed.
1355 ddbfac99 2020-02-24 stsp .It Fl F Ar histedit-script
1356 ddbfac99 2020-02-24 stsp Use the specified
1357 ddbfac99 2020-02-24 stsp .Ar histedit-script
1358 ddbfac99 2020-02-24 stsp instead of opening a temporary file in an editor where a histedit script
1359 ddbfac99 2020-02-24 stsp can be written.
1361 083957f4 2020-02-24 stsp Edit log messages only.
1362 083957f4 2020-02-24 stsp This option is a quick equivalent to a histedit script which edits
1363 2bdefe56 2020-02-24 tracey only log messages but otherwise leaves every picked commit as-is.
1366 083957f4 2020-02-24 stsp option can only be used when starting a new histedit operation.
1367 083957f4 2020-02-24 stsp If this option is used, no other command-line arguments are allowed.
1370 0ebf8283 2019-07-24 stsp Short alias for
1371 0ebf8283 2019-07-24 stsp .Cm histedit .
1372 2822a352 2019-10-15 stsp .It Cm integrate Ar branch
1373 2822a352 2019-10-15 stsp Integrate the specified
1374 2822a352 2019-10-15 stsp .Ar branch
1375 2822a352 2019-10-15 stsp into the work tree's current branch.
1376 2822a352 2019-10-15 stsp Files in the work tree are updated to match the contents on the integrated
1377 2822a352 2019-10-15 stsp .Ar branch ,
1378 2822a352 2019-10-15 stsp and the reference of the work tree's branch is changed to point at the
1379 2822a352 2019-10-15 stsp head commit of the integrated
1380 2822a352 2019-10-15 stsp .Ar branch .
1382 2822a352 2019-10-15 stsp Both branches can be considered equivalent after integration since they
1383 2822a352 2019-10-15 stsp will be pointing at the same commit.
1384 2822a352 2019-10-15 stsp Both branches remain available for future work, if desired.
1385 2822a352 2019-10-15 stsp In case the integrated
1386 2822a352 2019-10-15 stsp .Ar branch
1387 2822a352 2019-10-15 stsp is no longer needed it may be deleted with
1388 2822a352 2019-10-15 stsp .Cm got branch -d .
1390 2822a352 2019-10-15 stsp Show the status of each affected file, using the following status codes:
1391 2822a352 2019-10-15 stsp .Bl -column YXZ description
1392 2822a352 2019-10-15 stsp .It U Ta file was updated
1393 2822a352 2019-10-15 stsp .It D Ta file was deleted
1394 2822a352 2019-10-15 stsp .It A Ta new file was added
1395 2822a352 2019-10-15 stsp .It \(a~ Ta versioned file is obstructed by a non-regular file
1396 2822a352 2019-10-15 stsp .It ! Ta a missing versioned file was restored
1399 2822a352 2019-10-15 stsp .Cm got integrate
1400 2822a352 2019-10-15 stsp will refuse to run if certain preconditions are not met.
1401 2822a352 2019-10-15 stsp Most importantly, the
1402 2822a352 2019-10-15 stsp .Ar branch
1403 2822a352 2019-10-15 stsp must have been rebased onto the work tree's current branch with
1404 2822a352 2019-10-15 stsp .Cm got rebase
1405 2822a352 2019-10-15 stsp before it can be integrated, in order to linearize commit history and
1406 2822a352 2019-10-15 stsp resolve merge conflicts.
1407 2822a352 2019-10-15 stsp If the work tree contains multiple base commits it must first be updated
1408 2822a352 2019-10-15 stsp to a single base commit with
1409 2822a352 2019-10-15 stsp .Cm got update .
1410 2822a352 2019-10-15 stsp If changes have been staged with
1411 2822a352 2019-10-15 stsp .Cm got stage ,
1412 2822a352 2019-10-15 stsp these changes must first be committed with
1413 2822a352 2019-10-15 stsp .Cm got commit
1414 2822a352 2019-10-15 stsp or unstaged with
1415 2822a352 2019-10-15 stsp .Cm got unstage .
1416 2822a352 2019-10-15 stsp If the work tree contains local changes, these changes must first be
1417 2822a352 2019-10-15 stsp committed with
1418 2822a352 2019-10-15 stsp .Cm got commit
1419 2822a352 2019-10-15 stsp or reverted with
1420 2822a352 2019-10-15 stsp .Cm got revert .
1422 2822a352 2019-10-15 stsp Short alias for
1423 2822a352 2019-10-15 stsp .Cm integrate .
1424 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 ...
1425 2db2652d 2019-08-07 stsp Stage local changes for inclusion in the next commit.
1428 2db2652d 2019-08-07 stsp is specified, stage all changes in the work tree.
1429 2db2652d 2019-08-07 stsp Otherwise, stage changes at or within the specified paths.
1430 4ed9f614 2019-08-04 stsp Paths may be staged if they are added, modified, or deleted according to
1431 4ed9f614 2019-08-04 stsp .Cm got status .
1433 9d8b19a4 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1434 9d8b19a4 2019-08-04 stsp .Bl -column YXZ description
1435 9d8b19a4 2019-08-04 stsp .It A Ta file addition has been staged
1436 9d8b19a4 2019-08-04 stsp .It M Ta file modification has been staged
1437 9d8b19a4 2019-08-04 stsp .It D Ta file deletion has been staged
1440 9d8b19a4 2019-08-04 stsp Staged file contents are saved in newly created blob objects in the repository.
1441 52c8d4ac 2019-08-04 stsp These blobs will be referred to by tree objects once staged changes have been
1442 9d8b19a4 2019-08-04 stsp committed.
1444 890ea719 2019-08-04 stsp Staged changes affect the behaviour of
1445 4ed9f614 2019-08-04 stsp .Cm got commit ,
1446 4ed9f614 2019-08-04 stsp .Cm got status ,
1448 4ed9f614 2019-08-04 stsp .Cm got diff .
1449 4ed9f614 2019-08-04 stsp While paths with staged changes exist, the
1450 4ed9f614 2019-08-04 stsp .Cm got commit
1451 4ed9f614 2019-08-04 stsp command will refuse to commit any paths which do not have staged changes.
1452 4ed9f614 2019-08-04 stsp Local changes created on top of staged changes can only be committed if
1453 4ed9f614 2019-08-04 stsp the path is staged again, or if the staged changes are committed first.
1455 4ed9f614 2019-08-04 stsp .Cm got status
1456 4ed9f614 2019-08-04 stsp command will show both local changes and staged changes.
1458 4ed9f614 2019-08-04 stsp .Cm got diff
1459 ecf14362 2019-08-04 stsp command is able to display local changes relative to staged changes,
1460 ecf14362 2019-08-04 stsp and to display staged changes relative to the repository.
1462 4ed9f614 2019-08-04 stsp .Cm got revert
1463 4ed9f614 2019-08-04 stsp command cannot revert staged changes but may be used to revert
1464 4f2494e6 2019-08-08 stsp local changes created on top of staged changes.
1466 4ed9f614 2019-08-04 stsp The options for
1467 4ed9f614 2019-08-04 stsp .Cm got stage
1468 4ed9f614 2019-08-04 stsp are as follows:
1469 4ed9f614 2019-08-04 stsp .Bl -tag -width Ds
1471 4ed9f614 2019-08-04 stsp Instead of staging new changes, list paths which are already staged,
1472 9d8b19a4 2019-08-04 stsp along with the IDs of staged blob objects and stage status codes.
1473 9d8b19a4 2019-08-04 stsp If paths were provided in the command line show the staged paths
1474 1dd86744 2019-08-12 anthony among the specified paths.
1475 1dd86744 2019-08-12 anthony Otherwise, show all staged paths.
1477 dc424a06 2019-08-07 stsp Instead of staging the entire content of a changed file, interactively
1478 dc424a06 2019-08-07 stsp select or reject changes for staging based on
1480 6d23ec10 2019-08-08 stsp (stage change),
1482 6d23ec10 2019-08-08 stsp (reject change), and
1484 6d23ec10 2019-08-08 stsp (quit staging this file) responses.
1485 dc424a06 2019-08-07 stsp If a file is in modified status, individual patches derived from the
1486 dc424a06 2019-08-07 stsp modified file content can be staged.
1487 6d23ec10 2019-08-08 stsp Files in added or deleted status may only be staged or rejected in
1488 6d23ec10 2019-08-08 stsp their entirety.
1489 3a070a2b 2019-08-07 stsp .It Fl F Ar response-script
1492 3a070a2b 2019-08-07 stsp option, read
1497 0e2f5884 2019-08-07 stsp responses line-by-line from the specified
1498 0e2f5884 2019-08-07 stsp .Ar response-script
1499 0e2f5884 2019-08-07 stsp file instead of prompting interactively.
1502 4ed9f614 2019-08-04 stsp .Cm got stage
1503 4ed9f614 2019-08-04 stsp will refuse to run if certain preconditions are not met.
1504 4ed9f614 2019-08-04 stsp If a file contains merge conflicts, these conflicts must be resolved first.
1505 4ed9f614 2019-08-04 stsp If a file is found to be out of date relative to the head commit on the
1506 4ed9f614 2019-08-04 stsp work tree's current branch, the file must be updated with
1507 4ed9f614 2019-08-04 stsp .Cm got update
1508 4ed9f614 2019-08-04 stsp before it can be staged (however, this does not prevent the file from
1509 4ed9f614 2019-08-04 stsp becoming out-of-date at some point after having been staged).
1512 4ed9f614 2019-08-04 stsp .Cm got update ,
1513 4ed9f614 2019-08-04 stsp .Cm got rebase ,
1515 4ed9f614 2019-08-04 stsp .Cm got histedit
1516 4ed9f614 2019-08-04 stsp commands will refuse to run while staged changes exist.
1517 4ed9f614 2019-08-04 stsp If staged changes cannot be committed because a staged path
1518 4ed9f614 2019-08-04 stsp is out of date, the path must be unstaged with
1519 4ed9f614 2019-08-04 stsp .Cm got unstage
1520 4ed9f614 2019-08-04 stsp before it can be updated with
1521 4ed9f614 2019-08-04 stsp .Cm got update ,
1522 4ed9f614 2019-08-04 stsp and may then be staged again if necessary.
1524 4ed9f614 2019-08-04 stsp Short alias for
1525 4ed9f614 2019-08-04 stsp .Cm stage .
1526 dfc23429 2019-08-11 stsp .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1527 4ed9f614 2019-08-04 stsp Merge staged changes back into the work tree and put affected paths
1528 4ed9f614 2019-08-04 stsp back into non-staged status.
1531 4ed9f614 2019-08-04 stsp is specified, unstage all staged changes across the entire work tree.
1532 2db2652d 2019-08-07 stsp Otherwise, unstage changes at or within the specified paths.
1534 4ed9f614 2019-08-04 stsp Show the status of each affected file, using the following status codes:
1535 4ed9f614 2019-08-04 stsp .Bl -column YXZ description
1536 4ed9f614 2019-08-04 stsp .It G Ta file was unstaged
1537 4ed9f614 2019-08-04 stsp .It C Ta file was unstaged and conflicts occurred during merge
1538 4ed9f614 2019-08-04 stsp .It ! Ta changes destined for a missing file were not merged
1539 4ed9f614 2019-08-04 stsp .It D Ta file was staged as deleted and still is deleted
1540 4ed9f614 2019-08-04 stsp .It d Ta file's deletion was obstructed by local modifications
1541 1dd86744 2019-08-12 anthony .It \(a~ Ta changes destined for a non-regular file were not merged
1544 2e1f37b0 2019-08-08 stsp The options for
1545 2e1f37b0 2019-08-08 stsp .Cm got unstage
1546 2e1f37b0 2019-08-08 stsp are as follows:
1547 2e1f37b0 2019-08-08 stsp .Bl -tag -width Ds
1549 2e1f37b0 2019-08-08 stsp Instead of unstaging the entire content of a changed file, interactively
1550 2e1f37b0 2019-08-08 stsp select or reject changes for unstaging based on
1552 2e1f37b0 2019-08-08 stsp (unstage change),
1554 2e1f37b0 2019-08-08 stsp (keep change staged), and
1556 2e1f37b0 2019-08-08 stsp (quit unstaging this file) responses.
1557 2e1f37b0 2019-08-08 stsp If a file is staged in modified status, individual patches derived from the
1558 2e1f37b0 2019-08-08 stsp staged file content can be unstaged.
1559 2e1f37b0 2019-08-08 stsp Files staged in added or deleted status may only be unstaged in their entirety.
1560 2e1f37b0 2019-08-08 stsp .It Fl F Ar response-script
1563 2e1f37b0 2019-08-08 stsp option, read
1568 2e1f37b0 2019-08-08 stsp responses line-by-line from the specified
1569 2e1f37b0 2019-08-08 stsp .Ar response-script
1570 2e1f37b0 2019-08-08 stsp file instead of prompting interactively.
1573 4ed9f614 2019-08-04 stsp Short alias for
1574 4ed9f614 2019-08-04 stsp .Cm unstage .
1575 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 ...
1576 896e9b6f 2019-08-26 stsp Parse and print contents of objects to standard output in a line-based
1577 896e9b6f 2019-08-26 stsp text format.
1578 896e9b6f 2019-08-26 stsp Content of commit, tree, and tag objects is printed in a way similar
1579 896e9b6f 2019-08-26 stsp to the actual content stored in such objects.
1580 896e9b6f 2019-08-26 stsp Blob object contents are printed as they would appear in files on disk.
1582 896e9b6f 2019-08-26 stsp Attempt to interpret each argument as a reference, a tag name, or
1583 896e9b6f 2019-08-26 stsp an object ID SHA1 hash.
1584 01073a5d 2019-08-22 stsp References will be resolved to an object ID.
1585 01073a5d 2019-08-22 stsp Tag names will resolved to a tag object.
1586 01073a5d 2019-08-22 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1587 01073a5d 2019-08-22 stsp automatically, provided the abbreviation is unique.
1589 896e9b6f 2019-08-26 stsp If none of the above interpretations produce a valid result, or if the
1591 896e9b6f 2019-08-26 stsp option is used, attempt to interpret the argument as a path which will
1592 896e9b6f 2019-08-26 stsp be resolved to the ID of an object found at this path in the repository.
1594 01073a5d 2019-08-22 stsp The options for
1595 01073a5d 2019-08-22 stsp .Cm got cat
1596 01073a5d 2019-08-22 stsp are as follows:
1597 01073a5d 2019-08-22 stsp .Bl -tag -width Ds
1598 896e9b6f 2019-08-26 stsp .It Fl c Ar commit
1599 896e9b6f 2019-08-26 stsp Look up paths in the specified
1600 896e9b6f 2019-08-26 stsp .Ar commit .
1601 896e9b6f 2019-08-26 stsp If this option is not used, paths are looked up in the commit resolved
1602 896e9b6f 2019-08-26 stsp via the repository's HEAD reference.
1603 896e9b6f 2019-08-26 stsp The expected argument is a commit ID SHA1 hash or an existing reference
1604 896e9b6f 2019-08-26 stsp or tag name which will be resolved to a commit ID.
1605 896e9b6f 2019-08-26 stsp An abbreviated hash argument will be expanded to a full SHA1 hash
1606 896e9b6f 2019-08-26 stsp automatically, provided the abbreviation is unique.
1607 01073a5d 2019-08-22 stsp .It Fl r Ar repository-path
1608 01073a5d 2019-08-22 stsp Use the repository at the specified path.
1609 01073a5d 2019-08-22 stsp If not specified, assume the repository is located at or above the current
1610 01073a5d 2019-08-22 stsp working directory.
1611 01073a5d 2019-08-22 stsp If this directory is a
1613 01073a5d 2019-08-22 stsp work tree, use the repository path associated with this work tree.
1615 896e9b6f 2019-08-26 stsp Interpret all arguments as paths only.
1616 896e9b6f 2019-08-26 stsp This option can be used to resolve ambiguity in cases where paths
1617 896e9b6f 2019-08-26 stsp look like tag names, reference names, or object IDs.
1620 74416c47 2019-05-09 stsp .Sh ENVIRONMENT
1621 74416c47 2019-05-09 stsp .Bl -tag -width GOT_AUTHOR
1622 74416c47 2019-05-09 stsp .It Ev GOT_AUTHOR
1623 74416c47 2019-05-09 stsp The author's name and email address for
1624 21a44f98 2019-07-15 stsp .Cm got commit
1626 21a44f98 2019-07-15 stsp .Cm got import ,
1627 74416c47 2019-05-09 stsp for example:
1628 aba9c984 2019-09-08 stsp .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1631 84792843 2019-08-09 stsp may fail to parse commits without an email address in author data,
1633 84792843 2019-08-09 stsp attempts to reject
1634 0e444aba 2019-08-08 stsp .Ev GOT_AUTHOR
1635 84792843 2019-08-09 stsp environment variables with a missing email address.
1637 c9956ddf 2019-09-08 stsp If present, Git's
1638 aba9c984 2019-09-08 stsp .Dv user.name
1640 709ae9eb 2019-09-08 stsp .Dv user.email
1641 709ae9eb 2019-09-08 stsp configuration settings in the repository's
1642 aba9c984 2019-09-08 stsp .Pa .git/config
1643 aba9c984 2019-09-08 stsp file will override the value of
1644 aba9c984 2019-09-08 stsp .Ev GOT_AUTHOR .
1645 c9956ddf 2019-09-08 stsp However, the
1646 c9956ddf 2019-09-08 stsp .Dv user.name
1648 c9956ddf 2019-09-08 stsp .Dv user.email
1649 c9956ddf 2019-09-08 stsp configuration settings contained in Git's global
1650 c9956ddf 2019-09-08 stsp .Pa ~/.gitconfig
1651 c9956ddf 2019-09-08 stsp configuration file will be used only if the
1652 c9956ddf 2019-09-08 stsp .Ev GOT_AUTHOR
1653 c9956ddf 2019-09-08 stsp environment variable is
1656 1dd86744 2019-08-12 anthony .It Ev VISUAL , EDITOR
1657 23594da9 2019-05-13 stsp The editor spawned by
1658 8e7bd50a 2019-08-22 stsp .Cm got commit ,
1659 8e7bd50a 2019-08-22 stsp .Cm got import ,
1661 8e7bd50a 2019-08-22 stsp .Cm got tag .
1662 b1ebc001 2019-08-13 stsp .It Ev GOT_LOG_DEFAULT_LIMIT
1663 b1ebc001 2019-08-13 stsp The default limit on the number of commits traversed by
1664 b1ebc001 2019-08-13 stsp .Cm got log .
1665 b1ebc001 2019-08-13 stsp If set to zero, the limit is unbounded.
1666 b1ebc001 2019-08-13 stsp This variable will be silently ignored if it is set to a non-numeric value.
1667 858b0dfb 2020-03-20 stsp .It Ev GOT_FETCH_DEBUG
1668 858b0dfb 2020-03-20 stsp Enables protocol tracing on standard error output during
1669 858b0dfb 2020-03-20 stsp .Cm got clone
1671 858b0dfb 2020-03-20 stsp .Cm got fetch .
1673 5c860e29 2018-03-12 stsp .Sh EXIT STATUS
1674 5c860e29 2018-03-12 stsp .Ex -std got
1675 97925469 2018-03-17 stsp .Sh EXAMPLES
1676 fa6e0e48 2019-05-23 stsp Clone an existing Git repository for use with
1679 fd039d72 2020-03-18 stsp .Dl $ cd /var/git/
1680 fd039d72 2020-03-18 stsp .Dl $ got clone ssh://git@github.com/openbsd/src.git
1682 fd039d72 2020-03-18 stsp Use of HTTP URLs currently requires
1683 fa6e0e48 2019-05-23 stsp .Xr git 1 :
1685 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/
1686 fa6e0e48 2019-05-23 stsp .Dl $ git clone --bare https://github.com/openbsd/src.git
1688 3ce1b845 2019-07-15 stsp Alternatively, for quick and dirty local testing of
1690 3ce1b845 2019-07-15 stsp a new Git repository could be created and populated with files,
1691 3ce1b845 2019-07-15 stsp e.g. from a temporary CVS checkout located at
1692 3ce1b845 2019-07-15 stsp .Pa /tmp/src :
1694 3ce1b845 2019-07-15 stsp .Dl $ got init /var/git/src.git
1695 2930ef13 2019-07-15 stsp .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1697 3ce1b845 2019-07-15 stsp Check out a work tree from the Git repository to /usr/src:
1699 fa6e0e48 2019-05-23 stsp .Dl $ got checkout /var/git/src.git /usr/src
1701 e70c17ce 2019-05-22 stsp View local changes in a work tree directory:
1703 e70c17ce 2019-05-22 stsp .Dl $ got status
1704 e70c17ce 2019-05-22 stsp .Dl $ got diff | less
1706 33aa809d 2019-08-08 stsp Interactively revert selected local changes in a work tree directory:
1708 33aa809d 2019-08-08 stsp .Dl $ got revert -p -R\ .
1710 e70c17ce 2019-05-22 stsp In a work tree or a git repository directory, list all branch references:
1712 4e759de4 2019-06-26 stsp .Dl $ got branch -l
1714 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, create a new branch called
1715 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache
1716 d83d9d5c 2019-05-13 stsp which is forked off the
1717 d83d9d5c 2019-05-13 stsp .Dq master
1720 4e759de4 2019-06-26 stsp .Dl $ got branch unified-buffer-cache master
1722 e70c17ce 2019-05-22 stsp Switch an existing work tree to the branch
1723 e70c17ce 2019-05-22 stsp .Dq unified-buffer-cache .
1724 e70c17ce 2019-05-22 stsp Local changes in the work tree will be preserved and merged if necessary:
1726 e70c17ce 2019-05-22 stsp .Dl $ got update -b unified-buffer-cache
1728 fa6e0e48 2019-05-23 stsp Create a new commit from local changes in a work tree directory.
1729 fa6e0e48 2019-05-23 stsp This new commit will become the head commit of the work tree's current branch:
1731 fa6e0e48 2019-05-23 stsp .Dl $ got commit
1733 fa6e0e48 2019-05-23 stsp In a work tree or a git repository directory, view changes committed in
1734 fa6e0e48 2019-05-23 stsp the 3 most recent commits to the work tree's branch, or the branch resolved
1735 fa6e0e48 2019-05-23 stsp via the repository's HEAD reference, respectively:
1737 48c8c60d 2020-01-27 stsp .Dl $ got log -p -l 3
1739 5b666081 2020-02-24 stsp In a work tree or a git repository directory, log the history of a subdirectory:
1741 5b666081 2020-02-24 stsp .Dl $ got log sys/uvm
1743 5b666081 2020-02-24 stsp While operating inside a work tree, paths are specified relative to the current
1744 5b666081 2020-02-24 stsp working directory, so this command will log the subdirectory
1745 5b666081 2020-02-24 stsp .Pa sys/uvm :
1747 5b666081 2020-02-24 stsp .Dl $ cd sys/uvm && got log '.'
1749 5b666081 2020-02-24 stsp And this command has the same effect:
1751 5b666081 2020-02-24 stsp .Dl $ cd sys/dev/usb && got log ../../uvm
1753 e70c17ce 2019-05-22 stsp Add new files and remove obsolete files in a work tree directory:
1755 fa6e0e48 2019-05-23 stsp .Dl $ got add sys/uvm/uvm_ubc.c
1756 86d25a1b 2019-07-11 stsp .Dl $ got remove sys/uvm/uvm_vnode.c
1758 e70c17ce 2019-05-22 stsp Create a new commit from local changes in a work tree directory
1759 e70c17ce 2019-05-22 stsp with a pre-defined log message.
1761 e70c17ce 2019-05-22 stsp .Dl $ got commit -m 'unify the buffer cache'
1763 95fc3404 2019-07-15 stsp Update any work tree checked out from the
1764 95fc3404 2019-07-15 stsp .Dq unified-buffer-cache
1765 95fc3404 2019-07-15 stsp branch to the latest commit on this branch:
1767 95fc3404 2019-07-15 stsp .Dl $ got update
1769 c991308a 2019-07-15 stsp Roll file content on the unified-buffer-cache branch back by one commit,
1770 c991308a 2019-07-15 stsp and then fetch the rolled-back change into the work tree as a local change
1771 ac90e726 2019-07-15 stsp to be amended and perhaps committed again:
1773 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1774 ac90e726 2019-07-15 stsp .Dl $ got commit -m 'roll back previous'
1775 59d52b88 2019-07-15 stsp .Dl $ # now back out the previous backout :-)
1776 ac90e726 2019-07-15 stsp .Dl $ got backout unified-buffer-cache
1778 469dd726 2020-03-20 stsp Fetch new upstream commits into the local repository's
1779 469dd726 2020-03-20 stsp .Dq origin/master
1782 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1783 469dd726 2020-03-20 stsp .Dl $ got fetch
1785 469dd726 2020-03-20 stsp In a repository created with a HTTP URL and
1786 469dd726 2020-03-20 stsp .Cm git clone --bare
1788 469dd726 2020-03-20 stsp .Xr git-fetch 1
1789 469dd726 2020-03-20 stsp command must be used instead:
1791 fa6e0e48 2019-05-23 stsp .Dl $ cd /var/git/src.git
1792 469dd726 2020-03-20 stsp .Dl $ git fetch origin master:refs/remotes/origin/master
1794 469dd726 2020-03-20 stsp Rebase the local
1795 469dd726 2020-03-20 stsp .Dq master
1796 469dd726 2020-03-20 stsp branch to merge the new changes that are now visible on the
1797 469dd726 2020-03-20 stsp .Dq origin/master
1800 469dd726 2020-03-20 stsp .Dl $ cd /usr/src
1801 469dd726 2020-03-20 stsp .Dl $ got update -b origin/master
1802 469dd726 2020-03-20 stsp .Dl $ got rebase master
1804 fa6e0e48 2019-05-23 stsp Rebase the
1805 fa6e0e48 2019-05-23 stsp .Dq unified-buffer-cache
1806 fa6e0e48 2019-05-23 stsp branch on top of the new head commit of the
1807 fa6e0e48 2019-05-23 stsp .Dq master
1810 818c7501 2019-07-11 stsp .Dl $ got update -b master
1811 818c7501 2019-07-11 stsp .Dl $ got rebase unified-buffer-cache
1813 7d7ffedb 2019-07-14 stsp Create a patch from all changes on the unified-buffer-cache branch.
1814 1dd86744 2019-08-12 anthony The patch can be mailed out for review and applied to
1815 1dd86744 2019-08-12 anthony .Ox Ns 's
1816 1dd86744 2019-08-12 anthony CVS tree:
1818 7d7ffedb 2019-07-14 stsp .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1820 0ebf8283 2019-07-24 stsp Edit the entire commit history of the
1821 0ebf8283 2019-07-24 stsp .Dq unified-buffer-cache
1824 0ebf8283 2019-07-24 stsp .Dl $ got update -b unified-buffer-cache
1825 0ebf8283 2019-07-24 stsp .Dl $ got update -c master
1826 0ebf8283 2019-07-24 stsp .Dl $ got histedit
1828 bf390dec 2020-03-20 stsp In order to merge changes committed to the
1829 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1830 bf390dec 2020-03-20 stsp branch back into the
1831 bf390dec 2020-03-20 stsp .Dq master
1832 bf390dec 2020-03-20 stsp branch, the
1833 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1834 bf390dec 2020-03-20 stsp branch must first be rebased onto the
1835 bf390dec 2020-03-20 stsp .Dq master
1838 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1839 bf390dec 2020-03-20 stsp .Dl $ got rebase unified-buffer-cache
1841 bf390dec 2020-03-20 stsp Changes on the
1842 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1843 bf390dec 2020-03-20 stsp branch can now be made visible on the
1844 bf390dec 2020-03-20 stsp .Dq master
1845 bf390dec 2020-03-20 stsp branch with
1846 bf390dec 2020-03-20 stsp .Cm got integrate .
1847 bf390dec 2020-03-20 stsp Because the rebase operation switched the work tree to the
1848 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1849 bf390dec 2020-03-20 stsp branch, the work tree must be switched back to the
1850 bf390dec 2020-03-20 stsp .Dq master
1851 bf390dec 2020-03-20 stsp branch before the
1852 bf390dec 2020-03-20 stsp .Dq unified-buffer-cache
1853 bf390dec 2020-03-20 stsp branch can be integrated into
1854 bf390dec 2020-03-20 stsp .Dq master :
1856 bf390dec 2020-03-20 stsp .Dl $ got update -b master
1857 bf390dec 2020-03-20 stsp .Dl $ got integrate unified-buffer-cache
1859 469dd726 2020-03-20 stsp Additional steps may be necessary if local changes need to be pushed back
1860 7b3fde24 2019-07-28 stsp to the remote repository, which currently requires
1861 7b3fde24 2019-07-28 stsp .Cm git push .
1862 ff2cf171 2019-07-28 stsp Before working against existing branches in a repository cloned with
1863 469dd726 2020-03-20 stsp .Cm git clone --bare
1864 7848a0e1 2020-03-19 stsp instead of
1865 7848a0e1 2020-03-19 stsp .Cm got clone ,
1867 ff2cf171 2019-07-28 stsp .Dq refspec
1868 ff2cf171 2019-07-28 stsp must be configured to map all references in the remote repository
1870 ff2cf171 2019-07-28 stsp .Dq refs/remotes
1871 ff2cf171 2019-07-28 stsp namespace of the local repository.
1872 ff2cf171 2019-07-28 stsp This can achieved by setting Git's
1873 ff2cf171 2019-07-28 stsp .Pa remote.origin.fetch
1874 ff2cf171 2019-07-28 stsp configuration variable to the value
1875 ff2cf171 2019-07-28 stsp .Dq +refs/heads/*:refs/remotes/origin/*
1877 ff2cf171 2019-07-28 stsp .Cm git config
1880 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1881 ff2cf171 2019-07-28 stsp .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1882 469dd726 2020-03-20 stsp Additionally, the
1883 469dd726 2020-03-20 stsp .Dq mirror
1884 469dd726 2020-03-20 stsp option must be disabled:
1886 469dd726 2020-03-20 stsp .Dl $ cd /var/git/repo
1887 469dd726 2020-03-20 stsp .Dl $ git config remote.origin.mirror false
1889 ff2cf171 2019-07-28 stsp Alternatively, the following
1890 469dd726 2020-03-20 stsp .Xr git-fetch 1
1891 ff2cf171 2019-07-28 stsp configuration item can be added manually to the Git repository's
1892 ff2cf171 2019-07-28 stsp .Pa config
1895 ff2cf171 2019-07-28 stsp .Dl [remote "origin"]
1896 ff2cf171 2019-07-28 stsp .Dl url = ...
1897 ff2cf171 2019-07-28 stsp .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1898 469dd726 2020-03-20 stsp .Dl mirror = false
1900 fe307c9b 2019-07-28 stsp This configuration leaves the local repository's
1901 ff2cf171 2019-07-28 stsp .Dq refs/heads
1902 ff2cf171 2019-07-28 stsp namespace free for use by local branches checked out with
1903 ff2cf171 2019-07-28 stsp .Cm got checkout
1904 ff2cf171 2019-07-28 stsp and, if needed, created with
1905 ff2cf171 2019-07-28 stsp .Cm got branch .
1907 ff2cf171 2019-07-28 stsp Branches in the
1908 ff2cf171 2019-07-28 stsp .Dq remotes/origin
1909 469dd726 2020-03-20 stsp namespace can now be updated with incoming changes from the remote
1910 ff2cf171 2019-07-28 stsp repository with
1911 469dd726 2020-03-20 stsp .Cm got fetch
1913 469dd726 2020-03-20 stsp .Xr git-fetch 1
1914 469dd726 2020-03-20 stsp without extra command line arguments:
1916 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1917 469dd726 2020-03-20 stsp .Dl $ git fetch
1919 7b0db533 2020-02-04 stsp To make changes fetched from the remote repository appear on the
1920 ff2cf171 2019-07-28 stsp .Dq master
1921 7b0db533 2020-02-04 stsp branch, the
1922 ff2cf171 2019-07-28 stsp .Dq master
1923 ff2cf171 2019-07-28 stsp branch must be rebased onto the
1924 ff2cf171 2019-07-28 stsp .Dq origin/master
1926 7b0db533 2020-02-04 stsp This will also merge local changes, if any, with the incoming changes:
1928 ff2cf171 2019-07-28 stsp .Dl $ got update -b origin/master
1929 ff2cf171 2019-07-28 stsp .Dl $ got rebase master
1932 083957f4 2020-02-24 stsp .Dq master
1933 083957f4 2020-02-24 stsp branch, log messages for local changes can now be amended with
1935 083957f4 2020-02-24 stsp by other developers and any other important new information:
1937 083957f4 2020-02-24 stsp .Dl $ got update -c origin/master
1938 083957f4 2020-02-24 stsp .Dl $ got histedit -m
1940 7b0db533 2020-02-04 stsp Local changes on the
1941 ff2cf171 2019-07-28 stsp .Dq master
1942 ff2cf171 2019-07-28 stsp branch can then be pushed to the remote
1943 ff2cf171 2019-07-28 stsp repository with
1944 ff2cf171 2019-07-28 stsp .Cm git push :
1946 ff2cf171 2019-07-28 stsp .Dl $ cd /var/git/repo
1947 ff2cf171 2019-07-28 stsp .Dl $ git push origin master
1948 5c860e29 2018-03-12 stsp .Sh SEE ALSO
1949 2312fc47 2019-07-15 stsp .Xr tog 1 ,
1950 2312fc47 2019-07-15 stsp .Xr git-repository 5 ,
1951 285dc8a4 2018-03-13 stsp .Xr got-worktree 5
1952 1a208aaf 2018-04-01 stsp .Sh AUTHORS
1953 1a208aaf 2018-04-01 stsp .An Stefan Sperling Aq Mt stsp@openbsd.org
1954 1a208aaf 2018-04-01 stsp .An Martin Pieuchot Aq Mt mpi@openbsd.org
1955 bc3056e3 2019-08-18 stsp .An Joshua Stein Aq Mt jcs@openbsd.org
1956 83b416ed 2020-03-18 stsp .An Ori Bernstein Aq Mt ori@openbsd.org
1957 fa6e0e48 2019-05-23 stsp .Sh CAVEATS
1959 fa6e0e48 2019-05-23 stsp is a work-in-progress and many commands remain to be implemented.
1960 fa6e0e48 2019-05-23 stsp At present, the user has to fall back on
1962 ff2cf171 2019-07-28 stsp to perform many tasks, in particular tasks related to repository
1963 ff2cf171 2019-07-28 stsp administration and tasks which require a network connection.
