Blob


1 .\"
2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd $Mdocdate$
18 .Dt GOT 1
19 .Os
20 .Sh NAME
21 .Nm got
22 .Nd Game of Trees
23 .Sh SYNOPSIS
24 .Nm
25 .Ar command
26 .Op Fl h
27 .Op Ar arg ...
28 .Sh DESCRIPTION
29 .Nm
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
34 .Pp
35 .Nm
36 is a
37 .Dq distributed
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
40 at any time.
41 .Pp
42 Files managed by
43 .Nm
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
46 .Em work tree
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
49 .Xr got-worktree 5 .
50 .Pp
51 .Nm
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
55 .It Fl h
56 Display usage information and exit immediately.
57 .It Fl V , -version
58 Display program version and exit immediately.
59 .El
60 .Pp
61 The commands for
62 .Nm
63 are as follows:
64 .Bl -tag -width checkout
65 .Tg im
66 .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
67 .Dl Pq alias: Cm im
68 Create an initial commit in a repository from the file hierarchy
69 within the specified
70 .Ar directory .
71 The created commit will not have any parent commits, i.e. it will be a
72 root commit.
73 Also create a new reference which provides a branch name for the newly
74 created commit.
75 Show the path of each imported file to indicate progress.
76 .Pp
77 The
78 .Cm got import
79 command requires the
80 .Ev GOT_AUTHOR
81 environment variable to be set,
82 unless an author has been configured in
83 .Xr got.conf 5
84 or Git's
85 .Dv user.name
86 and
87 .Dv user.email
88 configuration settings can be obtained from the repository's
89 .Pa .git/config
90 file or from Git's global
91 .Pa ~/.gitconfig
92 configuration file.
93 .Pp
94 The options for
95 .Cm got import
96 are as follows:
97 .Bl -tag -width Ds
98 .It Fl b Ar branch
99 Create the specified
100 .Ar branch
101 instead of creating the default branch
102 .Dq main .
103 Use of this option is required if the
104 .Dq main
105 branch already exists.
106 .It Fl m Ar message
107 Use the specified log message when creating the new commit.
108 Without the
109 .Fl m
110 option,
111 .Cm got import
112 opens a temporary file in an editor where a log message can be written.
113 .It Fl r Ar repository-path
114 Use the repository at the specified path.
115 If not specified, assume the repository is located at or above the current
116 working directory.
117 .It Fl I Ar pattern
118 Ignore files or directories with a name which matches the specified
119 .Ar pattern .
120 This option may be specified multiple times to build a list of ignore patterns.
121 The
122 .Ar pattern
123 follows the globbing rules documented in
124 .Xr glob 7 .
125 .El
126 .Tg cl
127 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
128 .Dl Pq alias: Cm cl
129 Clone a Git repository at the specified
130 .Ar repository-URL
131 into the specified
132 .Ar directory .
133 If no
134 .Ar directory
135 is specified, the directory name will be derived from the name of the
136 cloned repository.
137 .Cm got clone
138 will refuse to run if the
139 .Ar directory
140 already exists.
141 .Pp
142 The
143 .Ar repository-URL
144 specifies a protocol scheme, a server hostname, an optional port number
145 separated from the hostname by a colon, and a path to the repository on
146 the server:
147 .Lk scheme://hostname:port/path/to/repository
148 .Pp
149 The following protocol schemes are supported:
150 .Bl -tag -width git+ssh
151 .It git
152 The Git protocol as implemented by the
153 .Xr git-daemon 1
154 server.
155 Use of this protocol is discouraged since it supports neither authentication
156 nor encryption.
157 .It git+ssh
158 The Git protocol wrapped in an authenticated and encrypted
159 .Xr ssh 1
160 tunnel.
161 With this protocol the hostname may contain an embedded username for
162 .Xr ssh 1
163 to use:
164 .Mt user@hostname
165 .It ssh
166 Short alias for git+ssh.
167 .El
168 .Pp
169 Objects in the cloned repository are stored in a pack file which is downloaded
170 from the server.
171 This pack file will then be indexed to facilitate access to the objects stored
172 within.
173 If any objects in the pack file are stored in deltified form, all deltas will
174 be fully resolved in order to compute the ID of such objects.
175 This can take some time.
176 More details about the pack file format are documented in
177 .Xr git-repository 5 .
178 .Pp
179 .Cm got clone
180 creates a remote repository entry in the
181 .Xr got.conf 5
182 and
183 .Pa config
184 files of the cloned repository to store the
185 .Ar repository-url
186 and any
187 .Ar branch
188 or
189 .Ar reference
190 arguments for future use by
191 .Cm got fetch
192 or
193 .Xr git-fetch 1 .
194 .Pp
195 The options for
196 .Cm got clone
197 are as follows:
198 .Bl -tag -width Ds
199 .It Fl a
200 Fetch all branches from the remote repository's
201 .Dq refs/heads/
202 reference namespace and set
203 .Cm fetch_all_branches
204 in the cloned repository's
205 .Xr got.conf 5
206 file for future use by
207 .Cm got fetch .
208 If this option is not specified, a branch resolved via the remote
209 repository's HEAD reference will be fetched.
210 Cannot be used together with the
211 .Fl b
212 option.
213 .It Fl b Ar branch
214 Fetch the specified
215 .Ar branch
216 from the remote repository's
217 .Dq refs/heads/
218 reference namespace.
219 This option may be specified multiple times to build a list of branches
220 to fetch.
221 If the branch corresponding to the remote repository's HEAD reference is not
222 in this list, the cloned repository's HEAD reference will be set to the first
223 branch which was fetched.
224 If this option is not specified, a branch resolved via the remote
225 repository's HEAD reference will be fetched.
226 Cannot be used together with the
227 .Fl a
228 option.
229 .It Fl l
230 List branches and tags available for fetching from the remote repository
231 and exit immediately.
232 Cannot be used together with any of the other options except
233 .Fl q
234 and
235 .Fl v .
236 .It Fl m
237 Create the cloned repository as a mirror of the original repository.
238 This is useful if the cloned repository will not be used to store
239 locally created commits.
240 .Pp
241 The repository's
242 .Xr got.conf 5
243 and
244 .Pa config
245 files will be set up with the
246 .Dq mirror
247 option enabled, such that
248 .Cm got fetch
249 or
250 .Xr git-fetch 1
251 will write incoming changes directly to branches in the
252 .Dq refs/heads/
253 reference namespace, rather than to branches in the
254 .Dq refs/remotes/
255 namespace.
256 This avoids the usual requirement of having to run
257 .Cm got rebase
258 after
259 .Cm got fetch
260 in order to make incoming changes appear on branches in the
261 .Dq refs/heads/
262 namespace.
263 But maintaining custom changes in the cloned repository becomes difficult
264 since such changes will be at risk of being discarded whenever incoming
265 changes are fetched.
266 .It Fl q
267 Suppress progress reporting output.
268 The same option will be passed to
269 .Xr ssh 1
270 if applicable.
271 .It Fl v
272 Verbose mode.
273 Causes
274 .Cm got clone
275 to print debugging messages to standard error output.
276 This option will be passed to
277 .Xr ssh 1
278 if applicable.
279 Multiple -v options increase the verbosity.
280 The maximum is 3.
281 .It Fl R Ar reference
282 In addition to the branches and tags that will be fetched, fetch an arbitrary
283 .Ar reference
284 from the remote repository's
285 .Dq refs/
286 namespace.
287 This option may be specified multiple times to build a list of additional
288 references to fetch.
289 The specified
290 .Ar reference
291 may either be a path to a specific reference, or a reference namespace
292 which will cause all references in this namespace to be fetched.
293 .Pp
294 Each reference will be mapped into the cloned repository's
295 .Dq refs/remotes/
296 namespace, unless the
297 .Fl m
298 option is used to mirror references directly into the cloned repository's
299 .Dq refs/
300 namespace.
301 .Pp
302 .Cm got clone
303 will refuse to fetch references from the remote repository's
304 .Dq refs/remotes/
305 or
306 .Dq refs/got/
307 namespace.
308 .El
309 .Tg fe
310 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Oo Fl X Oc Op Ar remote-repository
311 .Dl Pq alias: Cm fe
312 Fetch new changes from a remote repository.
313 If no
314 .Ar remote-repository
315 is specified,
316 .Dq origin
317 will be used.
318 The remote repository's URL is obtained from the corresponding entry in
319 .Xr got.conf 5
320 or Git's
321 .Pa config
322 file of the local repository, as created by
323 .Cm got clone .
324 .Pp
325 New changes will be stored in a separate pack file downloaded from the server.
326 Optionally, separate pack files stored in the repository can be combined with
327 .Xr git-repack 1 .
328 .Pp
329 By default, branch references in the
330 .Dq refs/remotes/
331 reference namespace will be updated to point at the newly fetched commits.
332 The
333 .Cm got rebase
334 command can then be used to make new changes visible on branches in the
335 .Dq refs/heads/
336 namespace, merging incoming changes with the changes on those branches
337 as necessary.
338 .Pp
339 If the repository was created as a mirror with
340 .Cm got clone -m ,
341 then all branches in the
342 .Dq refs/heads/
343 namespace will be updated directly to match the corresponding branches in
344 the remote repository.
345 If those branches contained local commits, these commits will no longer be
346 reachable via a reference and will therefore be at risk of being discarded
347 by Git's garbage collector or
348 .Cm gotadmin cleanup .
349 Maintaining custom changes in a mirror repository is therefore discouraged.
350 .Pp
351 In any case, references in the
352 .Dq refs/tags/
353 namespace will always be fetched and mapped directly to local references
354 in the same namespace.
355 .Pp
356 The options for
357 .Cm got fetch
358 are as follows:
359 .Bl -tag -width Ds
360 .It Fl a
361 Fetch all branches from the remote repository's
362 .Dq refs/heads/
363 reference namespace.
364 This option can be enabled by default for specific repositories in
365 .Xr got.conf 5 .
366 If this option is not specified, a branch resolved via the remote
367 repository's HEAD reference will be fetched.
368 Cannot be used together with the
369 .Fl b
370 option.
371 .It Fl b Ar branch
372 Fetch the specified
373 .Ar branch
374 from the remote repository's
375 .Dq refs/heads/
376 reference namespace.
377 This option may be specified multiple times to build a list of branches
378 to fetch.
379 If this option is not specified, a branch resolved via the remote
380 repository's HEAD reference will be fetched.
381 Cannot be used together with the
382 .Fl a
383 option.
384 .It Fl d
385 Delete branches and tags from the local repository which are no longer
386 present in the remote repository.
387 Only references are deleted.
388 Any commit, tree, tag, and blob objects belonging to deleted branches or
389 tags remain in the repository and may be removed separately with
390 Git's garbage collector or
391 .Cm gotadmin cleanup .
392 .It Fl l
393 List branches and tags available for fetching from the remote repository
394 and exit immediately.
395 Cannot be used together with any of the other options except
396 .Fl v ,
397 .Fl q ,
398 and
399 .Fl r .
400 .It Fl t
401 Allow existing references in the
402 .Dq refs/tags
403 namespace to be updated if they have changed on the server.
404 If not specified, only new tag references will be created.
405 .It Fl r Ar repository-path
406 Use the repository at the specified path.
407 If not specified, assume the repository is located at or above the current
408 working directory.
409 If this directory is a
410 .Nm
411 work tree, use the repository path associated with this work tree.
412 .It Fl q
413 Suppress progress reporting output.
414 The same option will be passed to
415 .Xr ssh 1
416 if applicable.
417 .It Fl v
418 Verbose mode.
419 Causes
420 .Cm got fetch
421 to print debugging messages to standard error output.
422 The same option will be passed to
423 .Xr ssh 1
424 if applicable.
425 Multiple -v options increase the verbosity.
426 The maximum is 3.
427 .It Fl R Ar reference
428 In addition to the branches and tags that will be fetched, fetch an arbitrary
429 .Ar reference
430 from the remote repository's
431 .Dq refs/
432 namespace.
433 This option may be specified multiple times to build a list of additional
434 references to fetch.
435 The specified
436 .Ar reference
437 may either be a path to a specific reference, or a reference namespace
438 which will cause all references in this namespace to be fetched.
439 .Pp
440 Each reference will be mapped into the local repository's
441 .Dq refs/remotes/
442 namespace, unless the local repository was created as a mirror with
443 .Cm got clone -m
444 in which case references will be mapped directly into the local repository's
445 .Dq refs/
446 namespace.
447 .Pp
448 Once a reference has been fetched, a branch based on it can be created with
449 .Cm got branch
450 if needed.
451 .Pp
452 .Cm got fetch
453 will refuse to fetch references from the remote repository's
454 .Dq refs/remotes/
455 or
456 .Dq refs/got/
457 namespace.
458 .It Fl X
459 Delete all references which correspond to a particular
460 .Ar remote-repository
461 instead of fetching new changes.
462 This can be useful when a remote repository is being removed from
463 .Xr got.conf 5 .
464 .Pp
465 With
466 .Fl X ,
467 the
468 .Ar remote-repository
469 argument is mandatory and no other options except
470 .Fl r ,
471 .Fl v ,
472 and
473 .Fl q
474 are allowed.
475 .Pp
476 Only references are deleted.
477 Any commit, tree, tag, and blob objects fetched from a remote repository
478 will generally be stored in pack files and may be removed separately with
479 .Xr git-repack 1
480 and Git's garbage collector.
481 .El
482 .Tg co
483 .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 Oo Fl q Oc Ar repository-path Op Ar work-tree-path
484 .Dl Pq alias: Cm co
485 Copy files from a repository into a new work tree.
486 Show the status of each affected file, using the following status codes:
487 .Bl -column YXZ description
488 .It A Ta new file was added
489 .It E Ta file already exists in work tree's meta-data
490 .El
491 .Pp
492 If the
493 .Ar work tree path
494 is not specified, either use the last component of
495 .Ar repository path ,
496 or if a
497 .Ar path prefix
498 was specified use the last component of
499 .Ar path prefix .
500 .Pp
501 The options for
502 .Cm got checkout
503 are as follows:
504 .Bl -tag -width Ds
505 .It Fl E
506 Proceed with the checkout operation even if the directory at
507 .Ar work-tree-path
508 is not empty.
509 Existing files will be left intact.
510 .It Fl b Ar branch
511 Check out files from a commit on the specified
512 .Ar branch .
513 If this option is not specified, a branch resolved via the repository's HEAD
514 reference will be used.
515 .It Fl c Ar commit
516 Check out files from the specified
517 .Ar commit
518 on the selected branch.
519 The expected argument is a commit ID SHA1 hash or an existing reference
520 or tag name which will be resolved to a commit ID.
521 An abbreviated hash argument will be expanded to a full SHA1 hash
522 automatically, provided the abbreviation is unique.
523 If this option is not specified, the most recent commit on the selected
524 branch will be used.
525 .Pp
526 If the specified
527 .Ar commit
528 is not contained in the selected branch, a different branch which contains
529 this commit must be specified with the
530 .Fl b
531 option.
532 If no such branch is known, a new branch must be created for this
533 commit with
534 .Cm got branch
535 before
536 .Cm got checkout
537 can be used.
538 Checking out work trees with an unknown branch is intentionally not supported.
539 .It Fl p Ar path-prefix
540 Restrict the work tree to a subset of the repository's tree hierarchy.
541 Only files beneath the specified
542 .Ar path-prefix
543 will be checked out.
544 .It Fl q
545 Silence progress output.
546 .El
547 .Tg up
548 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl q Oc Op Ar path ...
549 .Dl Pq alias: Cm up
550 Update an existing work tree to a different
551 .Ar commit .
552 Change existing files in the work tree as necessary to match file contents
553 of this commit.
554 Preserve any local changes in the work tree and merge them with the
555 incoming changes.
556 .Pp
557 Files which already contain merge conflicts will not be updated to avoid
558 further complications.
559 Such files will be updated when
560 .Cm got update
561 is run again after merge conflicts have been resolved.
562 If the conflicting changes are no longer needed, affected files can be
563 reverted with
564 .Cm got revert
565 before running
566 .Cm got update
567 again.
568 .Pp
569 Show the status of each affected file, using the following status codes:
570 .Bl -column YXZ description
571 .It U Ta file was updated and contained no local changes
572 .It G Ta file was updated and local changes were merged cleanly
573 .It C Ta file was updated and conflicts occurred during merge
574 .It D Ta file was deleted
575 .It A Ta new file was added
576 .It \(a~ Ta versioned file is obstructed by a non-regular file
577 .It ! Ta a missing versioned file was restored
578 .It # Ta file was not updated because it contains merge conflicts
579 .It ? Ta changes destined for an unversioned file were not merged
580 .El
581 .Pp
582 If no
583 .Ar path
584 is specified, update the entire work tree.
585 Otherwise, restrict the update operation to files at or within the
586 specified paths.
587 Each path is required to exist in the update operation's target commit.
588 Files in the work tree outside specified paths will remain unchanged and
589 will retain their previously recorded base commit.
590 Some
591 .Nm
592 commands may refuse to run while the work tree contains files from
593 multiple base commits.
594 The base commit of such a work tree can be made consistent by running
595 .Cm got update
596 across the entire work tree.
597 Specifying a
598 .Ar path
599 is incompatible with the
600 .Fl b
601 option.
602 .Pp
603 .Cm got update
604 cannot update paths with staged changes.
605 If changes have been staged with
606 .Cm got stage ,
607 these changes must first be committed with
608 .Cm got commit
609 or unstaged with
610 .Cm got unstage .
611 .Pp
612 The options for
613 .Cm got update
614 are as follows:
615 .Bl -tag -width Ds
616 .It Fl b Ar branch
617 Switch the work tree's branch reference to the specified
618 .Ar branch
619 before updating the work tree.
620 This option requires that all paths in the work tree are updated.
621 .Pp
622 As usual, any local changes in the work tree will be preserved.
623 This can be useful when switching to a newly created branch in order
624 to commit existing local changes to this branch.
625 .Pp
626 Any local changes must be dealt with separately in order to obtain a
627 work tree with pristine file contents corresponding exactly to the specified
628 .Ar branch .
629 Such changes could first be committed to a different branch with
630 .Cm got commit ,
631 or could be discarded with
632 .Cm got revert .
633 .It Fl c Ar commit
634 Update the work tree to the specified
635 .Ar commit .
636 The expected argument is a commit ID SHA1 hash or an existing reference
637 or tag name which will be resolved to a commit ID.
638 An abbreviated hash argument will be expanded to a full SHA1 hash
639 automatically, provided the abbreviation is unique.
640 If this option is not specified, the most recent commit on the work tree's
641 branch will be used.
642 .It Fl q
643 Silence progress output.
644 .El
645 .Tg st
646 .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Oo Fl S Ar status-codes Oc Op Ar path ...
647 .Dl Pq alias: Cm st
648 Show the current modification status of files in a work tree,
649 using the following status codes:
650 .Bl -column YXZ description
651 .It M Ta modified file
652 .It A Ta file scheduled for addition in next commit
653 .It D Ta file scheduled for deletion in next commit
654 .It C Ta modified or added file which contains merge conflicts
655 .It ! Ta versioned file was expected on disk but is missing
656 .It \(a~ Ta versioned file is obstructed by a non-regular file
657 .It ? Ta unversioned item not tracked by
658 .Nm
659 .It m Ta modified file modes (executable bit only)
660 .It N Ta non-existent
661 .Ar path
662 specified on the command line
663 .El
664 .Pp
665 If no
666 .Ar path
667 is specified, show modifications in the entire work tree.
668 Otherwise, show modifications at or within the specified paths.
669 .Pp
670 If changes have been staged with
671 .Cm got stage ,
672 staged changes are shown in the second output column, using the following
673 status codes:
674 .Bl -column YXZ description
675 .It M Ta file modification is staged
676 .It A Ta file addition is staged
677 .It D Ta file deletion is staged
678 .El
679 .Pp
680 Changes created on top of staged changes are indicated in the first column:
681 .Bl -column YXZ description
682 .It MM Ta file was modified after earlier changes have been staged
683 .It MA Ta file was modified after having been staged for addition
684 .El
685 .Pp
686 The options for
687 .Cm got status
688 are as follows:
689 .Bl -tag -width Ds
690 .It Fl I
691 Show unversioned files even if they match an ignore pattern.
692 .It Fl s Ar status-codes
693 Only show files with a modification status matching any of the
694 single-character status codes contained in the
695 .Ar status-codes
696 argument.
697 Any combination of codes from the above list of possible status codes
698 may be specified.
699 For staged files, status codes displayed in either column will be matched.
700 Cannot be used together with the
701 .Fl S
702 option.
703 .It Fl S Ar status-codes
704 Suppress the output of files with a modification status matching any of the
705 single-character status codes contained in the
706 .Ar status-codes
707 argument.
708 Any combination of codes from the above list of possible status codes
709 may be specified.
710 For staged files, status codes displayed in either column will be matched.
711 Cannot be used together with the
712 .Fl s
713 option.
714 .El
715 .Pp
716 For compatibility with
717 .Xr cvs 1
718 and
719 .Xr git 1 ,
720 .Cm got status
721 reads
722 .Xr glob 7
723 patterns from
724 .Pa .cvsignore
725 and
726 .Pa .gitignore
727 files in each traversed directory and will not display unversioned files
728 which match these patterns.
729 As an extension to
730 .Xr glob 7
731 matching rules,
732 .Cm got status
733 supports consecutive asterisks,
734 .Dq ** ,
735 which will match an arbitrary amount of directories.
736 Unlike
737 .Xr cvs 1 ,
738 .Cm got status
739 only supports a single ignore pattern per line.
740 Unlike
741 .Xr git 1 ,
742 .Cm got status
743 does not support negated ignore patterns prefixed with
744 .Dq \&! ,
745 and gives no special significance to the location of path component separators,
746 .Dq / ,
747 in a pattern.
748 .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 P Oc Oo Fl s Oc Oo Fl S Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
749 Display history of a repository.
750 If a
751 .Ar path
752 is specified, show only commits which modified this path.
753 If invoked in a work tree, the
754 .Ar path
755 is interpreted relative to the current working directory,
756 and the work tree's path prefix is implicitly prepended.
757 Otherwise, the path is interpreted relative to the repository root.
758 .Pp
759 The options for
760 .Cm got log
761 are as follows:
762 .Bl -tag -width Ds
763 .It Fl b
764 Display individual commits which were merged into the current branch
765 from other branches.
766 By default,
767 .Cm got log
768 shows the linear history of the current branch only.
769 .It Fl c Ar commit
770 Start traversing history at the specified
771 .Ar commit .
772 The expected argument is a commit ID SHA1 hash or an existing reference
773 or tag name which will be resolved to a commit ID.
774 An abbreviated hash argument will be expanded to a full SHA1 hash
775 automatically, provided the abbreviation is unique.
776 If this option is not specified, default to the work tree's current branch
777 if invoked in a work tree, or to the repository's HEAD reference.
778 .It Fl C Ar number
779 Set the number of context lines shown in diffs with
780 .Fl p .
781 By default, 3 lines of context are shown.
782 .It Fl l Ar N
783 Limit history traversal to a given number of commits.
784 If this option is not specified, a default limit value of zero is used,
785 which is treated as an unbounded limit.
786 The
787 .Ev GOT_LOG_DEFAULT_LIMIT
788 environment variable may be set to change this default value.
789 .It Fl p
790 Display the patch of modifications made in each commit.
791 If a
792 .Ar path
793 is specified, only show the patch of modifications at or within this path.
794 Cannot be used with the
795 .Fl s
796 option.
797 .It Fl P
798 Display the list of file paths changed in each commit, using the following
799 status codes:
800 .Bl -column YXZ description
801 .It M Ta modified file
802 .It D Ta file was deleted
803 .It A Ta new file was added
804 .It m Ta modified file modes (executable bit only)
805 .El
806 .Pp
807 Cannot be used with the
808 .Fl s
809 option.
810 .It Fl s
811 Display a short one-line summary of each commit, instead of the default
812 history format.
813 Cannot be used together with the
814 .Fl p
815 or
816 .Fl P
817 option.
818 .It Fl S Ar search-pattern
819 If specified, show only commits with a log message, author name,
820 committer name, or ID SHA1 hash matched by the extended regular
821 expression
822 .Ar search-pattern .
823 Lines in committed patches will be matched if
824 .Fl p
825 is specified.
826 File paths changed by a commit will be matched if
827 .Fl P
828 is specified.
829 Regular expression syntax is documented in
830 .Xr re_format 7 .
831 .It Fl r Ar repository-path
832 Use the repository at the specified path.
833 If not specified, assume the repository is located at or above the current
834 working directory.
835 If this directory is a
836 .Nm
837 work tree, use the repository path associated with this work tree.
838 .It Fl R
839 Determine a set of commits to display as usual, but display these commits
840 in reverse order.
841 .It Fl x Ar commit
842 Stop traversing commit history immediately after the specified
843 .Ar commit
844 has been traversed.
845 This option has no effect if the specified
846 .Ar commit
847 is never traversed.
848 .El
849 .Tg di
850 .It Cm diff Oo Fl a Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl P Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path ...
851 .Dl Pq alias: Cm di
852 When invoked within a work tree without any arguments, display all
853 local changes in the work tree.
854 If one or more
855 .Ar path
856 arguments are specified, only show changes within the specified paths.
857 .Pp
858 If two arguments are provided, treat each argument as a reference, a tag
859 name, or an object ID SHA1 hash, and display differences between the
860 corresponding objects.
861 Both objects must be of the same type (blobs, trees, or commits).
862 An abbreviated hash argument will be expanded to a full SHA1 hash
863 automatically, provided the abbreviation is unique.
864 If none of these interpretations produce a valid result or if the
865 .Fl P
866 option is used,
867 and if
868 .Cm got diff
869 is running in a work tree, attempt to interpret the two arguments as paths.
870 .Pp
871 The options for
872 .Cm got diff
873 are as follows:
874 .Bl -tag -width Ds
875 .It Fl a
876 Treat file contents as ASCII text even if binary data is detected.
877 .It Fl c Ar commit
878 Show differences between commits in the repository.
879 This options may be used up to two times.
880 When used only once, show differences between the specified
881 .Ar commit
882 and its first parent commit.
883 When used twice, show differences between the two specified commits.
884 .Pp
885 The expected argument is a commit ID SHA1 hash or an existing reference
886 or tag name which will be resolved to a commit ID.
887 An abbreviated hash argument will be expanded to a full SHA1 hash
888 automatically, provided the abbreviation is unique.
889 .Pp
890 If the
891 .Fl c
892 option is used, all non-option arguments will be interpreted as paths.
893 If one or more such
894 .Ar path
895 arguments are provided, only show differences for the specified paths.
896 .Pp
897 Cannot be used together with the
898 .Fl P
899 option.
900 .It Fl C Ar number
901 Set the number of context lines shown in the diff.
902 By default, 3 lines of context are shown.
903 .It Fl r Ar repository-path
904 Use the repository at the specified path.
905 If not specified, assume the repository is located at or above the current
906 working directory.
907 If this directory is a
908 .Nm
909 work tree, use the repository path associated with this work tree.
910 .It Fl s
911 Show changes staged with
912 .Cm got stage
913 instead of showing local changes in the work tree.
914 This option is only valid when
915 .Cm got diff
916 is invoked in a work tree.
917 .It Fl P
918 Interpret all arguments as paths only.
919 This option can be used to resolve ambiguity in cases where paths
920 look like tag names, reference names, or object IDs.
921 This option is only valid when
922 .Cm got diff
923 is invoked in a work tree.
924 .It Fl w
925 Ignore whitespace-only changes.
926 .El
927 .Tg bl
928 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
929 .Dl Pq alias: Cm bl
930 Display line-by-line history of a file at the specified path.
931 .Pp
932 The options for
933 .Cm got blame
934 are as follows:
935 .Bl -tag -width Ds
936 .It Fl c Ar commit
937 Start traversing history at the specified
938 .Ar commit .
939 The expected argument is a commit ID SHA1 hash or an existing reference
940 or tag name which will be resolved to a commit ID.
941 An abbreviated hash argument will be expanded to a full SHA1 hash
942 automatically, provided the abbreviation is unique.
943 .It Fl r Ar repository-path
944 Use the repository at the specified path.
945 If not specified, assume the repository is located at or above the current
946 working directory.
947 If this directory is a
948 .Nm
949 work tree, use the repository path associated with this work tree.
950 .El
951 .Tg tr
952 .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
953 .Dl Pq alias: Cm tr
954 Display a listing of files and directories at the specified
955 directory path in the repository.
956 Entries shown in this listing may carry one of the following trailing
957 annotations:
958 .Bl -column YXZ description
959 .It @ Ta entry is a symbolic link
960 .It / Ta entry is a directory
961 .It * Ta entry is an executable file
962 .It $ Ta entry is a Git submodule
963 .El
964 .Pp
965 Symbolic link entries are also annotated with the target path of the link.
966 .Pp
967 If no
968 .Ar path
969 is specified, list the repository path corresponding to the current
970 directory of the work tree, or the root directory of the repository
971 if there is no work tree.
972 .Pp
973 The options for
974 .Cm got tree
975 are as follows:
976 .Bl -tag -width Ds
977 .It Fl c Ar commit
978 List files and directories as they appear in the specified
979 .Ar commit .
980 The expected argument is a commit ID SHA1 hash or an existing reference
981 or tag name which will be resolved to a commit ID.
982 An abbreviated hash argument will be expanded to a full SHA1 hash
983 automatically, provided the abbreviation is unique.
984 .It Fl r Ar repository-path
985 Use the repository at the specified path.
986 If not specified, assume the repository is located at or above the current
987 working directory.
988 If this directory is a
989 .Nm
990 work tree, use the repository path associated with this work tree.
991 .It Fl i
992 Show object IDs of files (blob objects) and directories (tree objects).
993 .It Fl R
994 Recurse into sub-directories in the repository.
995 .El
996 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl t Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
997 Manage references in a repository.
998 .Pp
999 References may be listed, created, deleted, and changed.
1000 When creating, deleting, or changing a reference the specified
1001 .Ar name
1002 must be an absolute reference name, i.e. it must begin with
1003 .Dq refs/ .
1004 .Pp
1005 The options for
1006 .Cm got ref
1007 are as follows:
1008 .Bl -tag -width Ds
1009 .It Fl r Ar repository-path
1010 Use the repository at the specified path.
1011 If not specified, assume the repository is located at or above the current
1012 working directory.
1013 If this directory is a
1014 .Nm
1015 work tree, use the repository path associated with this work tree.
1016 .It Fl l
1017 List references in the repository.
1018 If no
1019 .Ar name
1020 is specified, list all existing references in the repository.
1022 .Ar name
1023 is a reference namespace, list all references in this namespace.
1024 Otherwise, show only the reference with the given
1025 .Ar name .
1026 Cannot be used together with any other options except
1027 .Fl r
1028 and
1029 .Fl t .
1030 .It Fl t
1031 Sort listed references by modification time (most recently modified first)
1032 instead of sorting by lexicographical order.
1033 Use of this option requires the
1034 .Fl l
1035 option to be used as well.
1036 .It Fl c Ar object
1037 Create a reference or change an existing reference.
1038 The reference with the specified
1039 .Ar name
1040 will point at the specified
1041 .Ar object .
1042 The expected
1043 .Ar object
1044 argument is a ID SHA1 hash or an existing reference or tag name which will
1045 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1046 Cannot be used together with any other options except
1047 .Fl r .
1048 .It Fl s Ar reference
1049 Create a symbolic reference, or change an existing symbolic reference.
1050 The symbolic reference with the specified
1051 .Ar name
1052 will point at the specified
1053 .Ar reference
1054 which must already exist in the repository.
1055 Care should be taken not to create loops between references when
1056 this option is used.
1057 Cannot be used together with any other options except
1058 .Fl r .
1059 .It Fl d
1060 Delete the reference with the specified
1061 .Ar name
1062 from the repository.
1063 Any commit, tree, tag, and blob objects belonging to deleted references
1064 remain in the repository and may be removed separately with
1065 Git's garbage collector or
1066 .Cm gotadmin cleanup .
1067 Cannot be used together with any other options except
1068 .Fl r .
1069 .El
1070 .Tg br
1071 .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl t Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
1072 .Dl Pq alias: Cm br
1073 Create, list, or delete branches.
1074 .Pp
1075 Local branches are managed via references which live in the
1076 .Dq refs/heads/
1077 reference namespace.
1078 The
1079 .Cm got branch
1080 command creates references in this namespace only.
1081 .Pp
1082 When deleting branches, the specified
1083 .Ar name
1084 is searched in the
1085 .Dq refs/heads
1086 reference namespace first.
1087 If no corresponding branch is found, the
1088 .Dq refs/remotes
1089 namespace will be searched next.
1090 .Pp
1091 If invoked in a work tree without any arguments, print the name of the
1092 work tree's current branch.
1093 .Pp
1094 If a
1095 .Ar name
1096 argument is passed, attempt to create a branch reference with the given name.
1097 By default the new branch reference will point at the latest commit on the
1098 work tree's current branch if invoked in a work tree, and otherwise to a commit
1099 resolved via the repository's HEAD reference.
1100 .Pp
1101 If invoked in a work tree, once the branch was created successfully
1102 switch the work tree's head reference to the newly created branch and
1103 update files across the entire work tree, just like
1104 .Cm got update -b Ar name
1105 would do.
1106 Show the status of each affected file, using the following status codes:
1107 .Bl -column YXZ description
1108 .It U Ta file was updated and contained no local changes
1109 .It G Ta file was updated and local changes were merged cleanly
1110 .It C Ta file was updated and conflicts occurred during merge
1111 .It D Ta file was deleted
1112 .It A Ta new file was added
1113 .It \(a~ Ta versioned file is obstructed by a non-regular file
1114 .It ! Ta a missing versioned file was restored
1115 .El
1116 .Pp
1117 The options for
1118 .Cm got branch
1119 are as follows:
1120 .Bl -tag -width Ds
1121 .It Fl c Ar commit
1122 Make a newly created branch reference point at the specified
1123 .Ar commit .
1124 The expected
1125 .Ar commit
1126 argument is a commit ID SHA1 hash or an existing reference
1127 or tag name which will be resolved to a commit ID.
1128 .It Fl r Ar repository-path
1129 Use the repository at the specified path.
1130 If not specified, assume the repository is located at or above the current
1131 working directory.
1132 If this directory is a
1133 .Nm
1134 work tree, use the repository path associated with this work tree.
1135 .It Fl l
1136 List all existing branches in the repository, including copies of remote
1137 repositories' branches in the
1138 .Dq refs/remotes/
1139 reference namespace.
1140 .Pp
1141 If invoked in a work tree, the work tree's current branch is shown
1142 with one the following annotations:
1143 .Bl -column YXZ description
1144 .It * Ta work tree's base commit matches the branch tip
1145 .It \(a~ Ta work tree's base commit is out-of-date
1146 .El
1147 .It Fl t
1148 Sort listed branches by modification time (most recently modified first)
1149 instead of sorting by lexicographical order.
1150 Branches in the
1151 .Dq refs/heads/
1152 reference namespace are listed before branches in
1153 .Dq refs/remotes/
1154 regardless.
1155 Use of this option requires the
1156 .Fl l
1157 option to be used as well.
1158 .It Fl d Ar name
1159 Delete the branch with the specified
1160 .Ar name
1161 from the
1162 .Dq refs/heads
1164 .Dq refs/remotes
1165 reference namespace.
1166 .Pp
1167 Only the branch reference is deleted.
1168 Any commit, tree, and blob objects belonging to the branch
1169 remain in the repository and may be removed separately with
1170 Git's garbage collector or
1171 .Cm gotadmin cleanup .
1172 .It Fl n
1173 Do not switch and update the work tree after creating a new branch.
1174 .El
1175 .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 Oo Fl s Ar signer-id Oc Oo Fl v Oc Oo Fl V Oc Ar name
1176 Manage tags in a repository.
1177 .Pp
1178 Tags are managed via references which live in the
1179 .Dq refs/tags/
1180 reference namespace.
1181 The
1182 .Cm got tag
1183 command operates on references in this namespace only.
1184 References in this namespace point at tag objects which contain a pointer
1185 to another object, a tag message, as well as author and timestamp information.
1186 .Pp
1187 Attempt to create a tag with the given
1188 .Ar name ,
1189 and make this tag point at the given
1190 .Ar commit .
1191 If no commit is specified, default to the latest commit on the work tree's
1192 current branch if invoked in a work tree, and to a commit resolved via
1193 the repository's HEAD reference otherwise.
1194 .Pp
1195 The options for
1196 .Cm got tag
1197 are as follows:
1198 .Bl -tag -width Ds
1199 .It Fl c Ar commit
1200 Make the newly created tag reference point at the specified
1201 .Ar commit .
1202 The expected
1203 .Ar commit
1204 argument is a commit ID SHA1 hash or an existing reference or tag name which
1205 will be resolved to a commit ID.
1206 An abbreviated hash argument will be expanded to a full SHA1 hash
1207 automatically, provided the abbreviation is unique.
1208 .It Fl m Ar message
1209 Use the specified tag message when creating the new tag.
1210 Without the
1211 .Fl m
1212 option,
1213 .Cm got tag
1214 opens a temporary file in an editor where a tag message can be written.
1215 .It Fl r Ar repository-path
1216 Use the repository at the specified path.
1217 If not specified, assume the repository is located at or above the current
1218 working directory.
1219 If this directory is a
1220 .Nm
1221 work tree, use the repository path associated with this work tree.
1222 .It Fl l
1223 List all existing tags in the repository instead of creating a new tag.
1224 If a
1225 .Ar name
1226 argument is passed, show only the tag with the given
1227 .Ar name .
1228 .It Fl s Ar signer-id
1229 While creating a new tag, sign this tag with the identity given in
1230 .Ar signer-id .
1231 .Pp
1232 For SSH-based signatures,
1233 .Ar signer-id
1234 is the path to a file which may refer to either a private SSH key,
1235 or a public SSH key with the private half available via
1236 .Xr ssh-agent 1 .
1237 .Cm got tag
1238 will sign the tag object by invoking
1239 .Xr ssh-keygen 1
1240 with the
1241 .Fl Y Ar sign
1242 command, using the signature namespace
1243 .Dq git
1244 for compatibility with
1245 .Xr git 1 .
1246 .It Fl v
1247 Verbose mode.
1248 During SSH signature creation and verification this option will be passed to
1249 .Xr ssh-keygen 1 .
1250 Multiple -v options increase the verbosity.
1251 The maximum is 3.
1252 .It Fl V
1253 Verify tag object signatures.
1254 If a
1255 .Ar name
1256 is specified, show and verify the tag object with the provided name.
1257 Otherwise, list all tag objects and verify signatures where present.
1258 .Pp
1259 .Cm got tag
1260 verifies SSH-based signatures by invoking
1261 .Xr ssh-keygen 1
1262 with the options
1263 .Fl Y Ar verify Fl f Ar allowed_signers .
1264 A path to the
1265 .Ar allowed_signers
1266 file must be set in
1267 .Xr got.conf 5 ,
1268 otherwise verification is impossible.
1269 .El
1270 .Pp
1271 By design, the
1272 .Cm got tag
1273 command will not delete tags or change existing tags.
1274 If a tag must be deleted, the
1275 .Cm got ref
1276 command may be used to delete a tag's reference.
1277 This should only be done if the tag has not already been copied to
1278 another repository.
1279 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1280 Schedule unversioned files in a work tree for addition to the
1281 repository in the next commit.
1282 By default, files which match a
1283 .Cm got status
1284 ignore pattern will not be added.
1285 .Pp
1286 The options for
1287 .Cm got add
1288 are as follows:
1289 .Bl -tag -width Ds
1290 .It Fl R
1291 Permit recursion into directories.
1292 If this option is not specified,
1293 .Cm got add
1294 will refuse to run if a specified
1295 .Ar path
1296 is a directory.
1297 .It Fl I
1298 Add files even if they match a
1299 .Cm got status
1300 ignore pattern.
1301 .El
1302 .Tg rm
1303 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1304 .Dl Pq alias: Cm rm
1305 Remove versioned files from a work tree and schedule them for deletion
1306 from the repository in the next commit.
1307 .Pp
1308 The options for
1309 .Cm got remove
1310 are as follows:
1311 .Bl -tag -width Ds
1312 .It Fl f
1313 Perform the operation even if a file contains local modifications,
1314 and do not raise an error if a specified
1315 .Ar path
1316 does not exist on disk.
1317 .It Fl k
1318 Keep affected files on disk.
1319 .It Fl R
1320 Permit recursion into directories.
1321 If this option is not specified,
1322 .Cm got remove
1323 will refuse to run if a specified
1324 .Ar path
1325 is a directory.
1326 .It Fl s Ar status-codes
1327 Only delete files with a modification status matching one of the
1328 single-character status codes contained in the
1329 .Ar status-codes
1330 argument.
1331 The following status codes may be specified:
1332 .Bl -column YXZ description
1333 .It M Ta modified file (this implies the
1334 .Fl f
1335 option)
1336 .It ! Ta versioned file expected on disk but missing
1337 .El
1338 .El
1339 .Tg pa
1340 .It Cm patch Oo Fl c Ar commit Oc Oo Fl n Oc Oo Fl p Ar strip-count Oc Oo Fl R Oc Op Ar patchfile
1341 .Dl Pq alias: Cm pa
1342 Apply changes from
1343 .Ar patchfile
1344 to files in a work tree.
1345 Files added or removed by a patch will be scheduled for addition or removal in
1346 the work tree.
1347 .Pp
1348 The patch must be in the unified diff format as produced by
1349 .Cm got diff ,
1350 .Xr git-diff 1 ,
1351 or by
1352 .Xr diff 1
1353 and
1354 .Xr cvs 1
1355 diff when invoked with their
1356 .Fl u
1357 options.
1358 If no
1359 .Ar patchfile
1360 argument is provided, read unified diff data from standard input instead.
1361 .Pp
1362 If the
1363 .Ar patchfile
1364 contains multiple patches, then attempt to apply each of them in sequence.
1365 .Pp
1366 Show the status of each affected file, using the following status codes:
1367 .Bl -column XYZ description
1368 .It M Ta file was modified
1369 .It G Ta file was merged using a merge-base found in the repository
1370 .It C Ta file was merged and conflicts occurred during merge
1371 .It D Ta file was deleted
1372 .It A Ta file was added
1373 .It # Ta failed to patch the file
1374 .El
1375 .Pp
1376 If a change does not match at its exact line number, attempt to
1377 apply it somewhere else in the file if a good spot can be found.
1378 Otherwise, the patch will fail to apply.
1379 .Pp
1380 .Nm
1381 .Cm patch
1382 will refuse to apply a patch if certain preconditions are not met.
1383 Files to be deleted must already be under version control, and must
1384 not have been scheduled for deletion already.
1385 Files to be added must not yet be under version control and must not
1386 already be present on disk.
1387 Files to be modified must already be under version control and may not
1388 contain conflict markers.
1389 .Pp
1390 If an error occurs, the
1391 .Cm patch
1392 operation will be aborted.
1393 Any changes made to the work tree up to this point will be left behind.
1394 Such changes can be viewed with
1395 .Cm got diff
1396 and can be reverted with
1397 .Cm got revert
1398 if needed.
1399 .Pp
1400 The options for
1401 .Cm got patch
1402 are as follows:
1403 .Bl -tag -width Ds
1404 .It Fl c Ar commit
1405 Use files found in in the specified
1406 .Ar commit
1407 as a merge base for 3-way merges, overriding the meta-data in
1408 .Ar patchfile
1409 .Pq if any .
1410 In case no merge-base is available for a file
1411 .Cm got patch
1412 will attempt to apply the changes without doing a 3-way merge.
1413 .It Fl n
1414 Do not make any modifications to the work tree.
1415 This can be used to check whether a patch would apply without issues.
1416 If the
1417 .Ar patchfile
1418 contains diffs that affect the same file multiple times, the results
1419 displayed may be incorrect.
1420 .It Fl p Ar strip-count
1421 Specify the number of leading path components to strip from paths
1422 parsed from
1423 .Ar patchfile .
1424 If the
1425 .Fl p
1426 option is not used,
1427 .Sq a/
1428 and
1429 .Sq b/
1430 path prefixes generated by
1431 .Xr git-diff 1
1432 will be recognized and stripped automatically.
1433 .It Fl R
1434 Reverse the patch before applying it.
1435 .El
1436 .Tg rv
1437 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1438 .Dl Pq alias: Cm rv
1439 Revert any local changes in files at the specified paths in a work tree.
1440 File contents will be overwritten with those contained in the
1441 work tree's base commit.
1442 There is no way to bring discarded changes back after
1443 .Cm got revert !
1444 .Pp
1445 If a file was added with
1446 .Cm got add ,
1447 it will become an unversioned file again.
1448 If a file was deleted with
1449 .Cm got remove ,
1450 it will be restored.
1451 .Pp
1452 The options for
1453 .Cm got revert
1454 are as follows:
1455 .Bl -tag -width Ds
1456 .It Fl p
1457 Instead of reverting all changes in files, interactively select or reject
1458 changes to revert based on
1459 .Dq y
1460 (revert change),
1461 .Dq n
1462 (keep change), and
1463 .Dq q
1464 (quit reverting this file) responses.
1465 If a file is in modified status, individual patches derived from the
1466 modified file content can be reverted.
1467 Files in added or deleted status may only be reverted in their entirety.
1468 .It Fl F Ar response-script
1469 With the
1470 .Fl p
1471 option, read
1472 .Dq y ,
1473 .Dq n ,
1474 and
1475 .Dq q
1476 responses line-by-line from the specified
1477 .Ar response-script
1478 file instead of prompting interactively.
1479 .It Fl R
1480 Permit recursion into directories.
1481 If this option is not specified,
1482 .Cm got revert
1483 will refuse to run if a specified
1484 .Ar path
1485 is a directory.
1486 .El
1487 .Tg ci
1488 .It Cm commit Oo Fl A Ar author Oc Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
1489 .Dl Pq alias: Cm ci
1490 Create a new commit in the repository from changes in a work tree
1491 and use this commit as the new base commit for the work tree.
1492 If no
1493 .Ar path
1494 is specified, commit all changes in the work tree.
1495 Otherwise, commit changes at or within the specified paths.
1496 .Pp
1497 If changes have been explicitly staged for commit with
1498 .Cm got stage ,
1499 only commit staged changes and reject any specified paths which
1500 have not been staged.
1501 .Pp
1502 .Cm got commit
1503 opens a temporary file in an editor where a log message can be written
1504 unless the
1505 .Fl m
1506 option is used
1507 or the
1508 .Fl F
1509 and
1510 .Fl N
1511 options are used together.
1512 .Pp
1513 Show the status of each affected file, using the following status codes:
1514 .Bl -column YXZ description
1515 .It M Ta modified file
1516 .It D Ta file was deleted
1517 .It A Ta new file was added
1518 .It m Ta modified file modes (executable bit only)
1519 .El
1520 .Pp
1521 Files which are not part of the new commit will retain their previously
1522 recorded base commit.
1523 Some
1524 .Nm
1525 commands may refuse to run while the work tree contains files from
1526 multiple base commits.
1527 The base commit of such a work tree can be made consistent by running
1528 .Cm got update
1529 across the entire work tree.
1530 .Pp
1531 The
1532 .Cm got commit
1533 command requires the
1534 .Ev GOT_AUTHOR
1535 environment variable to be set,
1536 unless an author has been configured in
1537 .Xr got.conf 5
1538 or Git's
1539 .Dv user.name
1540 and
1541 .Dv user.email
1542 configuration settings can be
1543 obtained from the repository's
1544 .Pa .git/config
1545 file or from Git's global
1546 .Pa ~/.gitconfig
1547 configuration file.
1548 .Pp
1549 The options for
1550 .Cm got commit
1551 are as follows:
1552 .Bl -tag -width Ds
1553 .It Fl A Ar author
1554 Set author information in the newly created commit to
1555 .Ar author .
1556 This is useful when committing changes which were written by someone
1557 else.
1558 The
1559 .Ar author
1560 argument must use the same format as the
1561 .Ev GOT_AUTHOR
1562 environment variable.
1563 .Pp
1564 In addition to storing author information, the newly created commit
1565 object will retain
1566 .Dq committer
1567 information which is obtained, as usual, from the
1568 .Ev GOT_AUTHOR
1569 environment variable, or
1570 .Xr got.conf 5 ,
1571 or Git configuration settings.
1572 .It Fl F Ar path
1573 Use the prepared log message stored in the file found at
1574 .Ar path
1575 when creating the new commit.
1576 .Cm got commit
1577 opens a temporary file in an editor where the prepared log message can be
1578 reviewed and edited further if needed.
1579 Cannot be used together with the
1580 .Fl m
1581 option.
1582 .It Fl m Ar message
1583 Use the specified log message when creating the new commit.
1584 Cannot be used together with the
1585 .Fl F
1586 option.
1587 .It Fl N
1588 This option prevents
1589 .Cm got commit
1590 from opening the commit message in an editor.
1591 It has no effect unless it is used together with the
1592 .Fl F
1593 option and is intended for non-interactive use such as scripting.
1594 .It Fl S
1595 Allow the addition of symbolic links which point outside of the path space
1596 that is under version control.
1597 By default,
1598 .Cm got commit
1599 will reject such symbolic links due to safety concerns.
1600 As a precaution,
1601 .Nm
1602 may decide to represent such a symbolic link as a regular file which contains
1603 the link's target path, rather than creating an actual symbolic link which
1604 points outside of the work tree.
1605 Use of this option is discouraged because external mechanisms such as
1606 .Dq make obj
1607 are better suited for managing symbolic links to paths not under
1608 version control.
1609 .El
1610 .Pp
1611 .Cm got commit
1612 will refuse to run if certain preconditions are not met.
1613 If the work tree's current branch is not in the
1614 .Dq refs/heads/
1615 reference namespace, new commits may not be created on this branch.
1616 Local changes may only be committed if they are based on file content
1617 found in the most recent commit on the work tree's branch.
1618 If a path is found to be out of date,
1619 .Cm got update
1620 must be used first in order to merge local changes with changes made
1621 in the repository.
1622 .Tg se
1623 .It Cm send Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Ar branch Oc Oo Fl f Oc Oo Fl r Ar repository-path Oc Oo Fl t Ar tag Oc Oo Fl T Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
1624 .Dl Pq alias: Cm se
1625 Send new changes to a remote repository.
1626 If no
1627 .Ar remote-repository
1628 is specified,
1629 .Dq origin
1630 will be used.
1631 The remote repository's URL is obtained from the corresponding entry in
1632 .Xr got.conf 5
1633 or Git's
1634 .Pa config
1635 file of the local repository, as created by
1636 .Cm got clone .
1637 .Pp
1638 All objects corresponding to new changes will be written to a temporary
1639 pack file which is then uploaded to the server.
1640 Upon success, references in the
1641 .Dq refs/remotes/
1642 reference namespace of the local repository will be updated to point at
1643 the commits which have been sent.
1644 .Pp
1645 By default, changes will only be sent if they are based on up-to-date
1646 copies of relevant branches in the remote repository.
1647 If any changes to be sent are based on out-of-date copies or would
1648 otherwise break linear history of existing branches, new changes must
1649 be fetched from the server with
1650 .Cm got fetch
1651 and local branches must be rebased with
1652 .Cm got rebase
1653 before
1654 .Cm got send
1655 can succeed.
1656 The
1657 .Fl f
1658 option can be used to make exceptions to these requirements.
1659 .Pp
1660 The options for
1661 .Cm got send
1662 are as follows:
1663 .Bl -tag -width Ds
1664 .It Fl a
1665 Send all branches from the local repository's
1666 .Dq refs/heads/
1667 reference namespace.
1668 The
1669 .Fl a
1670 option is equivalent to listing all branches with multiple
1671 .Fl b
1672 options.
1673 Cannot be used together with the
1674 .Fl b
1675 option.
1676 .It Fl b Ar branch
1677 Send the specified
1678 .Ar branch
1679 from the local repository's
1680 .Dq refs/heads/
1681 reference namespace.
1682 This option may be specified multiple times to build a list of branches
1683 to send.
1684 If this option is not specified, default to the work tree's current branch
1685 if invoked in a work tree, or to the repository's HEAD reference.
1686 Cannot be used together with the
1687 .Fl a
1688 option.
1689 .It Fl d Ar branch
1690 Delete the specified
1691 .Ar branch
1692 from the remote repository's
1693 .Dq refs/heads/
1694 reference namespace.
1695 This option may be specified multiple times to build a list of branches
1696 to delete.
1697 .Pp
1698 Only references are deleted.
1699 Any commit, tree, tag, and blob objects belonging to deleted branches
1700 may become subject to deletion by Git's garbage collector running on
1701 the server.
1702 .Pp
1703 Requesting deletion of branches results in an error if the server
1704 does not support this feature or disallows the deletion of branches
1705 based on its configuration.
1706 .It Fl f
1707 Attempt to force the server to overwrite existing branches or tags
1708 in the remote repository, even when
1709 .Cm got fetch
1710 and
1711 .Cm got rebase
1712 would usually be required before changes can be sent.
1713 The server may reject forced requests regardless, depending on its
1714 configuration.
1715 .Pp
1716 Any commit, tree, tag, and blob objects belonging to overwritten branches
1717 or tags may become subject to deletion by Git's garbage collector running
1718 on the server.
1719 .Pp
1720 The
1721 .Dq refs/tags
1722 reference namespace is globally shared between all repositories.
1723 Use of the
1724 .Fl f
1725 option to overwrite tags is discouraged because it can lead to
1726 inconsistencies between the tags present in different repositories.
1727 In general, creating a new tag with a different name is recommended
1728 instead of overwriting an existing tag.
1729 .Pp
1730 Use of the
1731 .Fl f
1732 option is particularly discouraged if changes being sent are based
1733 on an out-of-date copy of a branch in the remote repository.
1734 Instead of using the
1735 .Fl f
1736 option, new changes should
1737 be fetched with
1738 .Cm got fetch
1739 and local branches should be rebased with
1740 .Cm got rebase ,
1741 followed by another attempt to send the changes.
1742 .Pp
1743 The
1744 .Fl f
1745 option should only be needed in situations where the remote repository's
1746 copy of a branch or tag is known to be out-of-date and is considered
1747 disposable.
1748 The risks of creating inconsistencies between different repositories
1749 should also be taken into account.
1750 .It Fl r Ar repository-path
1751 Use the repository at the specified path.
1752 If not specified, assume the repository is located at or above the current
1753 working directory.
1754 If this directory is a
1755 .Nm
1756 work tree, use the repository path associated with this work tree.
1757 .It Fl t Ar tag
1758 Send the specified
1759 .Ar tag
1760 from the local repository's
1761 .Dq refs/tags/
1762 reference namespace, in addition to any branches that are being sent.
1763 The
1764 .Fl t
1765 option may be specified multiple times to build a list of tags to send.
1766 No tags will be sent if the
1767 .Fl t
1768 option is not used.
1769 .Pp
1770 Raise an error if the specified
1771 .Ar tag
1772 already exists in the remote repository, unless the
1773 .Fl f
1774 option is used to overwrite the server's copy of the tag.
1775 In general, creating a new tag with a different name is recommended
1776 instead of overwriting an existing tag.
1777 .Pp
1778 Cannot be used together with the
1779 .Fl T
1780 option.
1781 .It Fl T
1782 Attempt to send all tags from the local repository's
1783 .Dq refs/tags/
1784 reference namespace.
1785 The
1786 .Fl T
1787 option is equivalent to listing all tags with multiple
1788 .Fl t
1789 options.
1790 Cannot be used together with the
1791 .Fl t
1792 option.
1793 .It Fl q
1794 Suppress progress reporting output.
1795 The same option will be passed to
1796 .Xr ssh 1
1797 if applicable.
1798 .It Fl v
1799 Verbose mode.
1800 Causes
1801 .Cm got send
1802 to print debugging messages to standard error output.
1803 The same option will be passed to
1804 .Xr ssh 1
1805 if applicable.
1806 Multiple -v options increase the verbosity.
1807 The maximum is 3.
1808 .El
1809 .Tg cy
1810 .It Cm cherrypick Ar commit
1811 .Dl Pq alias: Cm cy
1812 Merge changes from a single
1813 .Ar commit
1814 into the work tree.
1815 The specified
1816 .Ar commit
1817 should be on a different branch than the work tree's base commit.
1818 The expected argument is a reference or a commit ID SHA1 hash.
1819 An abbreviated hash argument will be expanded to a full SHA1 hash
1820 automatically, provided the abbreviation is unique.
1821 .Pp
1822 Show the status of each affected file, using the following status codes:
1823 .Bl -column YXZ description
1824 .It G Ta file was merged
1825 .It C Ta file was merged and conflicts occurred during merge
1826 .It ! Ta changes destined for a missing file were not merged
1827 .It D Ta file was deleted
1828 .It d Ta file's deletion was prevented by local modifications
1829 .It A Ta new file was added
1830 .It \(a~ Ta changes destined for a non-regular file were not merged
1831 .It ? Ta changes destined for an unversioned file were not merged
1832 .El
1833 .Pp
1834 The merged changes will appear as local changes in the work tree, which
1835 may be viewed with
1836 .Cm got diff ,
1837 amended manually or with further
1838 .Cm got cherrypick
1839 commands,
1840 committed with
1841 .Cm got commit ,
1842 or discarded again with
1843 .Cm got revert .
1844 .Pp
1845 .Cm got cherrypick
1846 will refuse to run if certain preconditions are not met.
1847 If the work tree contains multiple base commits, it must first be updated
1848 to a single base commit with
1849 .Cm got update .
1850 If any relevant files already contain merge conflicts, these
1851 conflicts must be resolved first.
1852 .Tg bo
1853 .It Cm backout Ar commit
1854 .Dl Pq alias: Cm bo
1855 Reverse-merge changes from a single
1856 .Ar commit
1857 into the work tree.
1858 The specified
1859 .Ar commit
1860 should be on the same branch as the work tree's base commit.
1861 The expected argument is a reference or a commit ID SHA1 hash.
1862 An abbreviated hash argument will be expanded to a full SHA1 hash
1863 automatically, provided the abbreviation is unique.
1864 .Pp
1865 Show the status of each affected file, using the following status codes:
1866 .Bl -column YXZ description
1867 .It G Ta file was merged
1868 .It C Ta file was merged and conflicts occurred during merge
1869 .It ! Ta changes destined for a missing file were not merged
1870 .It D Ta file was deleted
1871 .It d Ta file's deletion was prevented by local modifications
1872 .It A Ta new file was added
1873 .It \(a~ Ta changes destined for a non-regular file were not merged
1874 .It ? Ta changes destined for an unversioned file were not merged
1875 .El
1876 .Pp
1877 The reverse-merged changes will appear as local changes in the work tree,
1878 which may be viewed with
1879 .Cm got diff ,
1880 amended manually or with further
1881 .Cm got backout
1882 commands,
1883 committed with
1884 .Cm got commit ,
1885 or discarded again with
1886 .Cm got revert .
1887 .Pp
1888 .Cm got backout
1889 will refuse to run if certain preconditions are not met.
1890 If the work tree contains multiple base commits, it must first be updated
1891 to a single base commit with
1892 .Cm got update .
1893 If any relevant files already contain merge conflicts, these
1894 conflicts must be resolved first.
1895 .Tg rb
1896 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1897 .Dl Pq alias: Cm rb
1898 Rebase commits on the specified
1899 .Ar branch
1900 onto the tip of the current branch of the work tree.
1901 The
1902 .Ar branch
1903 must share common ancestry with the work tree's current branch.
1904 Rebasing begins with the first descendant commit of the youngest
1905 common ancestor commit shared by the specified
1906 .Ar branch
1907 and the work tree's current branch, and stops once the tip commit
1908 of the specified
1909 .Ar branch
1910 has been rebased.
1911 .Pp
1912 When
1913 .Cm got rebase
1914 is used as intended, the specified
1915 .Ar branch
1916 represents a local commit history and may already contain changes
1917 that are not yet visible in any other repositories.
1918 The work tree's current branch, which must be set with
1919 .Cm got update -b
1920 before starting the
1921 .Cm rebase
1922 operation, represents a branch from a remote repository which shares
1923 a common history with the specified
1924 .Ar branch
1925 but has progressed, and perhaps diverged, due to commits added to the
1926 remote repository.
1927 .Pp
1928 Rebased commits are accumulated on a temporary branch which the work tree
1929 will remain switched to throughout the entire rebase operation.
1930 Commits on this branch represent the same changes with the same log
1931 messages as their counterparts on the original
1932 .Ar branch ,
1933 but with different commit IDs.
1934 Once rebasing has completed successfully, the temporary branch becomes
1935 the new version of the specified
1936 .Ar branch
1937 and the work tree is automatically switched to it.
1938 If author information is available via the
1939 .Ev GOT_AUTHOR
1940 environment variable,
1941 .Xr got.conf 5
1942 or Git's
1943 .Dv user.name
1944 and
1945 .Dv user.email
1946 configuration settings, this author information will be used to identify
1947 the
1948 .Dq committer
1949 of rebased commits.
1950 .Pp
1951 Old commits in their pre-rebase state are automatically backed up in the
1952 .Dq refs/got/backup/rebase
1953 reference namespace.
1954 As long as these references are not removed older versions of rebased
1955 commits will remain in the repository and can be viewed with the
1956 .Cm got rebase -l
1957 command.
1958 Removal of these references makes objects which become unreachable via
1959 any reference subject to removal by Git's garbage collector or
1960 .Cm gotadmin cleanup .
1961 .Pp
1962 While rebasing commits, show the status of each affected file,
1963 using the following status codes:
1964 .Bl -column YXZ description
1965 .It G Ta file was merged
1966 .It C Ta file was merged and conflicts occurred during merge
1967 .It ! Ta changes destined for a missing file were not merged
1968 .It D Ta file was deleted
1969 .It d Ta file's deletion was prevented by local modifications
1970 .It A Ta new file was added
1971 .It \(a~ Ta changes destined for a non-regular file were not merged
1972 .It ? Ta changes destined for an unversioned file were not merged
1973 .El
1974 .Pp
1975 If merge conflicts occur, the rebase operation is interrupted and may
1976 be continued once conflicts have been resolved.
1977 If any files with destined changes are found to be missing or unversioned,
1978 or if files could not be deleted due to differences in deleted content,
1979 the rebase operation will be interrupted to prevent potentially incomplete
1980 changes from being committed to the repository without user intervention.
1981 The work tree may be modified as desired and the rebase operation can be
1982 continued once the changes present in the work tree are considered complete.
1983 Alternatively, the rebase operation may be aborted which will leave
1984 .Ar branch
1985 unmodified and the work tree switched back to its original branch.
1986 .Pp
1987 If a merge conflict is resolved in a way which renders the merged
1988 change into a no-op change, the corresponding commit will be elided
1989 when the rebase operation continues.
1990 .Pp
1991 .Cm got rebase
1992 will refuse to run if certain preconditions are not met.
1993 If the work tree is not yet fully updated to the tip commit of its
1994 branch, then the work tree must first be updated with
1995 .Cm got update .
1996 If changes have been staged with
1997 .Cm got stage ,
1998 these changes must first be committed with
1999 .Cm got commit
2000 or unstaged with
2001 .Cm got unstage .
2002 If the work tree contains local changes, these changes must first be
2003 committed with
2004 .Cm got commit
2005 or reverted with
2006 .Cm got revert .
2007 If the
2008 .Ar branch
2009 contains changes to files outside of the work tree's path prefix,
2010 the work tree cannot be used to rebase this branch.
2011 .Pp
2012 The
2013 .Cm got update
2014 and
2015 .Cm got commit
2016 commands will refuse to run while a rebase operation is in progress.
2017 Other commands which manipulate the work tree may be used for
2018 conflict resolution purposes.
2019 .Pp
2020 If the specified
2021 .Ar branch
2022 is already based on the work tree's current branch, then no commits
2023 need to be rebased and
2024 .Cm got rebase
2025 will simply switch the work tree to the specified
2026 .Ar branch
2027 and update files in the work tree accordingly.
2028 .Pp
2029 The options for
2030 .Cm got rebase
2031 are as follows:
2032 .Bl -tag -width Ds
2033 .It Fl a
2034 Abort an interrupted rebase operation.
2035 If this option is used, no other command-line arguments are allowed.
2036 .It Fl c
2037 Continue an interrupted rebase operation.
2038 If this option is used, no other command-line arguments are allowed.
2039 .It Fl l
2040 Show a list of past rebase operations, represented by references in the
2041 .Dq refs/got/backup/rebase
2042 reference namespace.
2043 .Pp
2044 Display the author, date, and log message of each backed up commit,
2045 the object ID of the corresponding post-rebase commit, and
2046 the object ID of their common ancestor commit.
2047 Given these object IDs,
2048 the
2049 .Cm got log
2050 command with the
2051 .Fl c
2052 and
2053 .Fl x
2054 options can be used to examine the history of either version of the branch,
2055 and the
2056 .Cm got branch
2057 command with the
2058 .Fl c
2059 option can be used to create a new branch from a pre-rebase state if desired.
2060 .Pp
2061 If a
2062 .Ar branch
2063 is specified, only show commits which at some point in time represented this
2064 branch.
2065 Otherwise, list all backed up commits for any branches.
2066 .Pp
2067 If this option is used,
2068 .Cm got rebase
2069 does not require a work tree.
2070 None of the other options can be used together with
2071 .Fl l .
2072 .It Fl X
2073 Delete backups created by past rebase operations, represented by references
2074 in the
2075 .Dq refs/got/backup/rebase
2076 reference namespace.
2077 .Pp
2078 If a
2079 .Ar branch
2080 is specified, only delete backups which at some point in time represented
2081 this branch.
2082 Otherwise, delete all references found within
2083 .Dq refs/got/backup/rebase .
2084 .Pp
2085 Any commit, tree, tag, and blob objects belonging to deleted backups
2086 remain in the repository and may be removed separately with
2087 Git's garbage collector or
2088 .Cm gotadmin cleanup .
2089 .Pp
2090 If this option is used,
2091 .Cm got rebase
2092 does not require a work tree.
2093 None of the other options can be used together with
2094 .Fl X .
2095 .El
2096 .Tg he
2097 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl e Oc Oo Fl f Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
2098 .Dl Pq alias: Cm he
2099 Edit commit history between the work tree's current base commit and
2100 the tip commit of the work tree's current branch.
2101 .Pp
2102 The
2103 .Cm got histedit
2104 command requires the
2105 .Ev GOT_AUTHOR
2106 environment variable to be set,
2107 unless an author has been configured in
2108 .Xr got.conf 5
2109 or Git's
2110 .Dv user.name
2111 and
2112 .Dv user.email
2113 configuration settings can be obtained from the repository's
2114 .Pa .git/config
2115 file or from Git's global
2116 .Pa ~/.gitconfig
2117 configuration file.
2118 .Pp
2119 Before starting a
2120 .Cm histedit
2121 operation, the work tree's current branch must be set with
2122 .Cm got update -b
2123 to the branch which should be edited, unless this branch is already the
2124 current branch of the work tree.
2125 The tip of this branch represents the upper bound (inclusive) of commits
2126 touched by the
2127 .Cm histedit
2128 operation.
2129 .Pp
2130 Furthermore, the work tree's base commit
2131 must be set with
2132 .Cm got update -c
2133 to a point in this branch's commit history where editing should begin.
2134 This commit represents the lower bound (non-inclusive) of commits touched
2135 by the
2136 .Cm histedit
2137 operation.
2138 .Pp
2139 Editing of commit history is controlled via a
2140 .Ar histedit script
2141 which can be written in an editor based on a template, passed on the
2142 command line, or generated with the
2143 .Fl f
2145 .Fl m
2146 options.
2147 .Pp
2148 The format of the histedit script is line-based.
2149 Each line in the script begins with a command name, followed by
2150 whitespace and an argument.
2151 For most commands, the expected argument is a commit ID SHA1 hash.
2152 Any remaining text on the line is ignored.
2153 Lines which begin with the
2154 .Sq #
2155 character are ignored entirely.
2156 .Pp
2157 The available histedit script commands are as follows:
2158 .Bl -column YXZ pick-commit
2159 .It Cm pick Ar commit Ta Use the specified commit as it is.
2160 .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2161 merged into the work tree interrupt the histedit operation for amending.
2162 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2163 listed further below that will be used.
2164 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2165 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2166 a preceding
2167 .Cm pick
2169 .Cm edit
2170 command on the previous line of the histedit script.
2171 The optional
2172 .Ar log-message
2173 argument provides a new single-line log message to use.
2174 If the
2175 .Ar log-message
2176 argument is omitted, open an editor where a new log message can be written.
2177 .El
2178 .Pp
2179 Every commit in the history being edited must be mentioned in the script.
2180 Lines may be re-ordered to change the order of commits in the edited history.
2181 No commit may be listed more than once.
2182 .Pp
2183 Edited commits are accumulated on a temporary branch which the work tree
2184 will remain switched to throughout the entire histedit operation.
2185 Once history editing has completed successfully, the temporary branch becomes
2186 the new version of the work tree's branch and the work tree is automatically
2187 switched to it.
2188 .Pp
2189 Old commits in their pre-histedit state are automatically backed up in the
2190 .Dq refs/got/backup/histedit
2191 reference namespace.
2192 As long as these references are not removed older versions of edited
2193 commits will remain in the repository and can be viewed with the
2194 .Cm got histedit -l
2195 command.
2196 Removal of these references makes objects which become unreachable via
2197 any reference subject to removal by Git's garbage collector or
2198 .Cm gotadmin cleanup .
2199 .Pp
2200 While merging commits, show the status of each affected file,
2201 using the following status codes:
2202 .Bl -column YXZ description
2203 .It G Ta file was merged
2204 .It C Ta file was merged and conflicts occurred during merge
2205 .It ! Ta changes destined for a missing file were not merged
2206 .It D Ta file was deleted
2207 .It d Ta file's deletion was prevented by local modifications
2208 .It A Ta new file was added
2209 .It \(a~ Ta changes destined for a non-regular file were not merged
2210 .It ? Ta changes destined for an unversioned file were not merged
2211 .El
2212 .Pp
2213 If merge conflicts occur, the histedit operation is interrupted and may
2214 be continued once conflicts have been resolved.
2215 If any files with destined changes are found to be missing or unversioned,
2216 or if files could not be deleted due to differences in deleted content,
2217 the histedit operation will be interrupted to prevent potentially incomplete
2218 changes from being committed to the repository without user intervention.
2219 The work tree may be modified as desired and the histedit operation can be
2220 continued once the changes present in the work tree are considered complete.
2221 Alternatively, the histedit operation may be aborted which will leave
2222 the work tree switched back to its original branch.
2223 .Pp
2224 If a merge conflict is resolved in a way which renders the merged
2225 change into a no-op change, the corresponding commit will be elided
2226 when the histedit operation continues.
2227 .Pp
2228 .Cm got histedit
2229 will refuse to run if certain preconditions are not met.
2230 If the work tree's current branch is not in the
2231 .Dq refs/heads/
2232 reference namespace, the history of the branch may not be edited.
2233 If the work tree contains multiple base commits, it must first be updated
2234 to a single base commit with
2235 .Cm got update .
2236 If changes have been staged with
2237 .Cm got stage ,
2238 these changes must first be committed with
2239 .Cm got commit
2240 or unstaged with
2241 .Cm got unstage .
2242 If the work tree contains local changes, these changes must first be
2243 committed with
2244 .Cm got commit
2245 or reverted with
2246 .Cm got revert .
2247 If the edited history contains changes to files outside of the work tree's
2248 path prefix, the work tree cannot be used to edit the history of this branch.
2249 .Pp
2250 The
2251 .Cm got update ,
2252 .Cm got rebase ,
2253 and
2254 .Cm got integrate
2255 commands will refuse to run while a histedit operation is in progress.
2256 Other commands which manipulate the work tree may be used, and the
2257 .Cm got commit
2258 command may be used to commit arbitrary changes to the temporary branch
2259 while the histedit operation is interrupted.
2260 .Pp
2261 The options for
2262 .Cm got histedit
2263 are as follows:
2264 .Bl -tag -width Ds
2265 .It Fl a
2266 Abort an interrupted histedit operation.
2267 If this option is used, no other command-line arguments are allowed.
2268 .It Fl c
2269 Continue an interrupted histedit operation.
2270 If this option is used, no other command-line arguments are allowed.
2271 .It Fl e
2272 Interrupt the histedit operation for editing after merging each commit.
2273 This option is a quick equivalent to a histedit script which uses the
2274 .Cm edit
2275 command for all commits.
2276 The
2277 .Fl e
2278 option can only be used when starting a new histedit operation.
2279 If this option is used, no other command-line arguments are allowed.
2280 .It Fl f
2281 Fold all commits into a single commit.
2282 This option is a quick equivalent to a histedit script which folds all
2283 commits, combining them all into one commit.
2284 The
2285 .Fl f
2286 option can only be used when starting a new histedit operation.
2287 If this option is used, no other command-line arguments are allowed.
2288 .It Fl F Ar histedit-script
2289 Use the specified
2290 .Ar histedit-script
2291 instead of opening a temporary file in an editor where a histedit script
2292 can be written.
2293 .It Fl m
2294 Edit log messages only.
2295 This option is a quick equivalent to a histedit script which edits
2296 only log messages but otherwise leaves every picked commit as-is.
2297 The
2298 .Fl m
2299 option can only be used when starting a new histedit operation.
2300 If this option is used, no other command-line arguments are allowed.
2301 .It Fl l
2302 Show a list of past histedit operations, represented by references in the
2303 .Dq refs/got/backup/histedit
2304 reference namespace.
2305 .Pp
2306 Display the author, date, and log message of each backed up commit,
2307 the object ID of the corresponding post-histedit commit, and
2308 the object ID of their common ancestor commit.
2309 Given these object IDs,
2310 the
2311 .Cm got log
2312 command with the
2313 .Fl c
2314 and
2315 .Fl x
2316 options can be used to examine the history of either version of the branch,
2317 and the
2318 .Cm got branch
2319 command with the
2320 .Fl c
2321 option can be used to create a new branch from a pre-histedit state if desired.
2322 .Pp
2323 If a
2324 .Ar branch
2325 is specified, only show commits which at some point in time represented this
2326 branch.
2327 Otherwise, list all backed up commits for any branches.
2328 .Pp
2329 If this option is used,
2330 .Cm got histedit
2331 does not require a work tree.
2332 None of the other options can be used together with
2333 .Fl l .
2334 .It Fl X
2335 Delete backups created by past histedit operations, represented by references
2336 in the
2337 .Dq refs/got/backup/histedit
2338 reference namespace.
2339 .Pp
2340 If a
2341 .Ar branch
2342 is specified, only delete backups which at some point in time represented
2343 this branch.
2344 Otherwise, delete all references found within
2345 .Dq refs/got/backup/histedit .
2346 .Pp
2347 Any commit, tree, tag, and blob objects belonging to deleted backups
2348 remain in the repository and may be removed separately with
2349 Git's garbage collector or
2350 .Cm gotadmin cleanup .
2351 .Pp
2352 If this option is used,
2353 .Cm got histedit
2354 does not require a work tree.
2355 None of the other options can be used together with
2356 .Fl X .
2357 .El
2358 .Tg ig
2359 .It Cm integrate Ar branch
2360 .Dl Pq alias: Cm ig
2361 Integrate the specified
2362 .Ar branch
2363 into the work tree's current branch.
2364 Files in the work tree are updated to match the contents on the integrated
2365 .Ar branch ,
2366 and the reference of the work tree's branch is changed to point at the
2367 head commit of the integrated
2368 .Ar branch .
2369 .Pp
2370 Both branches can be considered equivalent after integration since they
2371 will be pointing at the same commit.
2372 Both branches remain available for future work, if desired.
2373 In case the integrated
2374 .Ar branch
2375 is no longer needed it may be deleted with
2376 .Cm got branch -d .
2377 .Pp
2378 Show the status of each affected file, using the following status codes:
2379 .Bl -column YXZ description
2380 .It U Ta file was updated
2381 .It D Ta file was deleted
2382 .It A Ta new file was added
2383 .It \(a~ Ta versioned file is obstructed by a non-regular file
2384 .It ! Ta a missing versioned file was restored
2385 .El
2386 .Pp
2387 .Cm got integrate
2388 will refuse to run if certain preconditions are not met.
2389 Most importantly, the
2390 .Ar branch
2391 must have been rebased onto the work tree's current branch with
2392 .Cm got rebase
2393 before it can be integrated, in order to linearize commit history and
2394 resolve merge conflicts.
2395 If the work tree contains multiple base commits, it must first be updated
2396 to a single base commit with
2397 .Cm got update .
2398 If changes have been staged with
2399 .Cm got stage ,
2400 these changes must first be committed with
2401 .Cm got commit
2402 or unstaged with
2403 .Cm got unstage .
2404 If the work tree contains local changes, these changes must first be
2405 committed with
2406 .Cm got commit
2407 or reverted with
2408 .Cm got revert .
2409 .Tg mg
2410 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2411 .Dl Pq alias: Cm mg
2412 Create a merge commit based on the current branch of the work tree and
2413 the specified
2414 .Ar branch .
2415 If a linear project history is desired, then use of
2416 .Cm got rebase
2417 should be preferred over
2418 .Cm got merge .
2419 However, even strictly linear projects may require merge commits in order
2420 to merge in new versions of third-party code stored on vendor branches
2421 created with
2422 .Cm got import .
2423 .Pp
2424 Merge commits are commits based on multiple parent commits.
2425 The tip commit of the work tree's current branch, which must be set with
2426 .Cm got update -b
2427 before starting the
2428 .Cm merge
2429 operation, will be used as the first parent.
2430 The tip commit of the specified
2431 .Ar branch
2432 will be used as the second parent.
2433 .Pp
2434 No ancestral relationship between the two branches is required.
2435 If the two branches have already been merged previously, only new changes
2436 will be merged.
2437 .Pp
2438 It is not possible to create merge commits with more than two parents.
2439 If more than one branch needs to be merged, then multiple merge commits
2440 with two parents each can be created in sequence.
2441 .Pp
2442 While merging changes found on the
2443 .Ar branch
2444 into the work tree, show the status of each affected file,
2445 using the following status codes:
2446 .Bl -column YXZ description
2447 .It G Ta file was merged
2448 .It C Ta file was merged and conflicts occurred during merge
2449 .It ! Ta changes destined for a missing file were not merged
2450 .It D Ta file was deleted
2451 .It d Ta file's deletion was prevented by local modifications
2452 .It A Ta new file was added
2453 .It \(a~ Ta changes destined for a non-regular file were not merged
2454 .It ? Ta changes destined for an unversioned file were not merged
2455 .El
2456 .Pp
2457 If merge conflicts occur, the merge operation is interrupted and conflicts
2458 must be resolved before the merge operation can continue.
2459 If any files with destined changes are found to be missing or unversioned,
2460 or if files could not be deleted due to differences in deleted content,
2461 the merge operation will be interrupted to prevent potentially incomplete
2462 changes from being committed to the repository without user intervention.
2463 The work tree may be modified as desired and the merge can be continued
2464 once the changes present in the work tree are considered complete.
2465 Alternatively, the merge operation may be aborted which will leave
2466 the work tree's current branch unmodified.
2467 .Pp
2468 If a merge conflict is resolved in a way which renders all merged
2469 changes into no-op changes, the merge operation cannot continue
2470 and must be aborted.
2471 .Pp
2472 .Cm got merge
2473 will refuse to run if certain preconditions are not met.
2474 If history of the
2475 .Ar branch
2476 is based on the work tree's current branch, then no merge commit can
2477 be created and
2478 .Cm got integrate
2479 may be used to integrate the
2480 .Ar branch
2481 instead.
2482 If the work tree is not yet fully updated to the tip commit of its
2483 branch, then the work tree must first be updated with
2484 .Cm got update .
2485 If the work tree contains multiple base commits, it must first be updated
2486 to a single base commit with
2487 .Cm got update .
2488 If changes have been staged with
2489 .Cm got stage ,
2490 these changes must first be committed with
2491 .Cm got commit
2492 or unstaged with
2493 .Cm got unstage .
2494 If the work tree contains local changes, these changes must first be
2495 committed with
2496 .Cm got commit
2497 or reverted with
2498 .Cm got revert .
2499 If the
2500 .Ar branch
2501 contains changes to files outside of the work tree's path prefix,
2502 the work tree cannot be used to merge this branch.
2503 .Pp
2504 The
2505 .Cm got update ,
2506 .Cm got commit ,
2507 .Cm got rebase ,
2508 .Cm got histedit ,
2509 .Cm got integrate ,
2510 and
2511 .Cm got stage
2512 commands will refuse to run while a merge operation is in progress.
2513 Other commands which manipulate the work tree may be used for
2514 conflict resolution purposes.
2515 .Pp
2516 The options for
2517 .Cm got merge
2518 are as follows:
2519 .Bl -tag -width Ds
2520 .It Fl a
2521 Abort an interrupted merge operation.
2522 If this option is used, no other command-line arguments are allowed.
2523 .It Fl c
2524 Continue an interrupted merge operation.
2525 If this option is used, no other command-line arguments are allowed.
2526 .It Fl n
2527 Merge changes into the work tree as usual but do not create a merge
2528 commit immediately.
2529 The merge result can be adjusted as desired before a merge commit is
2530 created with
2531 .Cm got merge -c .
2532 Alternatively, the merge may be aborted with
2533 .Cm got merge -a .
2534 .El
2535 .Tg sg
2536 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl S Oc Op Ar path ...
2537 .Dl Pq alias: Cm sg
2538 Stage local changes for inclusion in the next commit.
2539 If no
2540 .Ar path
2541 is specified, stage all changes in the work tree.
2542 Otherwise, stage changes at or within the specified paths.
2543 Paths may be staged if they are added, modified, or deleted according to
2544 .Cm got status .
2545 .Pp
2546 Show the status of each affected file, using the following status codes:
2547 .Bl -column YXZ description
2548 .It A Ta file addition has been staged
2549 .It M Ta file modification has been staged
2550 .It D Ta file deletion has been staged
2551 .El
2552 .Pp
2553 Staged file contents are saved in newly created blob objects in the repository.
2554 These blobs will be referred to by tree objects once staged changes have been
2555 committed.
2556 .Pp
2557 Staged changes affect the behaviour of
2558 .Cm got commit ,
2559 .Cm got status ,
2560 and
2561 .Cm got diff .
2562 While paths with staged changes exist, the
2563 .Cm got commit
2564 command will refuse to commit any paths which do not have staged changes.
2565 Local changes created on top of staged changes can only be committed if
2566 the path is staged again, or if the staged changes are committed first.
2567 The
2568 .Cm got status
2569 command will show both local changes and staged changes.
2570 The
2571 .Cm got diff
2572 command is able to display local changes relative to staged changes,
2573 and to display staged changes relative to the repository.
2574 The
2575 .Cm got revert
2576 command cannot revert staged changes but may be used to revert
2577 local changes created on top of staged changes.
2578 .Pp
2579 The options for
2580 .Cm got stage
2581 are as follows:
2582 .Bl -tag -width Ds
2583 .It Fl l
2584 Instead of staging new changes, list paths which are already staged,
2585 along with the IDs of staged blob objects and stage status codes.
2586 If paths were provided on the command line, show the staged paths
2587 among the specified paths.
2588 Otherwise, show all staged paths.
2589 .It Fl p
2590 Instead of staging the entire content of a changed file, interactively
2591 select or reject changes for staging based on
2592 .Dq y
2593 (stage change),
2594 .Dq n
2595 (reject change), and
2596 .Dq q
2597 (quit staging this file) responses.
2598 If a file is in modified status, individual patches derived from the
2599 modified file content can be staged.
2600 Files in added or deleted status may only be staged or rejected in
2601 their entirety.
2602 .It Fl F Ar response-script
2603 With the
2604 .Fl p
2605 option, read
2606 .Dq y ,
2607 .Dq n ,
2608 and
2609 .Dq q
2610 responses line-by-line from the specified
2611 .Ar response-script
2612 file instead of prompting interactively.
2613 .It Fl S
2614 Allow staging of symbolic links which point outside of the path space
2615 that is under version control.
2616 By default,
2617 .Cm got stage
2618 will reject such symbolic links due to safety concerns.
2619 As a precaution,
2620 .Nm
2621 may decide to represent such a symbolic link as a regular file which contains
2622 the link's target path, rather than creating an actual symbolic link which
2623 points outside of the work tree.
2624 Use of this option is discouraged because external mechanisms such as
2625 .Dq make obj
2626 are better suited for managing symbolic links to paths not under
2627 version control.
2628 .El
2629 .Pp
2630 .Cm got stage
2631 will refuse to run if certain preconditions are not met.
2632 If a file contains merge conflicts, these conflicts must be resolved first.
2633 If a file is found to be out of date relative to the head commit on the
2634 work tree's current branch, the file must be updated with
2635 .Cm got update
2636 before it can be staged (however, this does not prevent the file from
2637 becoming out-of-date at some point after having been staged).
2638 .Pp
2639 The
2640 .Cm got update ,
2641 .Cm got rebase ,
2642 and
2643 .Cm got histedit
2644 commands will refuse to run while staged changes exist.
2645 If staged changes cannot be committed because a staged path
2646 is out of date, the path must be unstaged with
2647 .Cm got unstage
2648 before it can be updated with
2649 .Cm got update ,
2650 and may then be staged again if necessary.
2651 .Tg ug
2652 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2653 .Dl Pq alias: Cm ug
2654 Merge staged changes back into the work tree and put affected paths
2655 back into non-staged status.
2656 If no
2657 .Ar path
2658 is specified, unstage all staged changes across the entire work tree.
2659 Otherwise, unstage changes at or within the specified paths.
2660 .Pp
2661 Show the status of each affected file, using the following status codes:
2662 .Bl -column YXZ description
2663 .It G Ta file was unstaged
2664 .It C Ta file was unstaged and conflicts occurred during merge
2665 .It ! Ta changes destined for a missing file were not merged
2666 .It D Ta file was staged as deleted and still is deleted
2667 .It d Ta file's deletion was prevented by local modifications
2668 .It \(a~ Ta changes destined for a non-regular file were not merged
2669 .El
2670 .Pp
2671 The options for
2672 .Cm got unstage
2673 are as follows:
2674 .Bl -tag -width Ds
2675 .It Fl p
2676 Instead of unstaging the entire content of a changed file, interactively
2677 select or reject changes for unstaging based on
2678 .Dq y
2679 (unstage change),
2680 .Dq n
2681 (keep change staged), and
2682 .Dq q
2683 (quit unstaging this file) responses.
2684 If a file is staged in modified status, individual patches derived from the
2685 staged file content can be unstaged.
2686 Files staged in added or deleted status may only be unstaged in their entirety.
2687 .It Fl F Ar response-script
2688 With the
2689 .Fl p
2690 option, read
2691 .Dq y ,
2692 .Dq n ,
2693 and
2694 .Dq q
2695 responses line-by-line from the specified
2696 .Ar response-script
2697 file instead of prompting interactively.
2698 .El
2699 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2700 Parse and print contents of objects to standard output in a line-based
2701 text format.
2702 Content of commit, tree, and tag objects is printed in a way similar
2703 to the actual content stored in such objects.
2704 Blob object contents are printed as they would appear in files on disk.
2705 .Pp
2706 Attempt to interpret each argument as a reference, a tag name, or
2707 an object ID SHA1 hash.
2708 References will be resolved to an object ID.
2709 Tag names will resolved to a tag object.
2710 An abbreviated hash argument will be expanded to a full SHA1 hash
2711 automatically, provided the abbreviation is unique.
2712 .Pp
2713 If none of the above interpretations produce a valid result, or if the
2714 .Fl P
2715 option is used, attempt to interpret the argument as a path which will
2716 be resolved to the ID of an object found at this path in the repository.
2717 .Pp
2718 The options for
2719 .Cm got cat
2720 are as follows:
2721 .Bl -tag -width Ds
2722 .It Fl c Ar commit
2723 Look up paths in the specified
2724 .Ar commit .
2725 If this option is not used, paths are looked up in the commit resolved
2726 via the repository's HEAD reference.
2727 The expected argument is a commit ID SHA1 hash or an existing reference
2728 or tag name which will be resolved to a commit ID.
2729 An abbreviated hash argument will be expanded to a full SHA1 hash
2730 automatically, provided the abbreviation is unique.
2731 .It Fl r Ar repository-path
2732 Use the repository at the specified path.
2733 If not specified, assume the repository is located at or above the current
2734 working directory.
2735 If this directory is a
2736 .Nm
2737 work tree, use the repository path associated with this work tree.
2738 .It Fl P
2739 Interpret all arguments as paths only.
2740 This option can be used to resolve ambiguity in cases where paths
2741 look like tag names, reference names, or object IDs.
2742 .El
2743 .It Cm info Op Ar path ...
2744 Display meta-data stored in a work tree.
2745 See
2746 .Xr got-worktree 5
2747 for details.
2748 .Pp
2749 The work tree to use is resolved implicitly by walking upwards from the
2750 current working directory.
2751 .Pp
2752 If one or more
2753 .Ar path
2754 arguments are specified, show additional per-file information for tracked
2755 files located at or within these paths.
2756 If a
2757 .Ar path
2758 argument corresponds to the work tree's root directory, display information
2759 for all tracked files.
2760 .El
2761 .Sh ENVIRONMENT
2762 .Bl -tag -width GOT_IGNORE_GITCONFIG
2763 .It Ev GOT_AUTHOR
2764 The author's name and email address, such as
2765 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2766 Used by the
2767 .Cm got commit ,
2768 .Cm got import ,
2769 .Cm got rebase ,
2770 and
2771 .Cm got histedit
2772 commands.
2773 Because
2774 .Xr git 1
2775 may fail to parse commits without an email address in author data,
2776 .Nm
2777 attempts to reject
2778 .Ev GOT_AUTHOR
2779 environment variables with a missing email address.
2780 .Pp
2781 .Ev GOT_AUTHOR will be overridden by configuration settings in
2782 .Xr got.conf 5
2783 or by Git's
2784 .Dv user.name
2785 and
2786 .Dv user.email
2787 configuration settings in the repository's
2788 .Pa .git/config
2789 file.
2790 The
2791 .Dv user.name
2792 and
2793 .Dv user.email
2794 configuration settings contained in Git's global
2795 .Pa ~/.gitconfig
2796 configuration file will only be used if neither
2797 .Xr got.conf 5
2798 nor the
2799 .Ev GOT_AUTHOR
2800 environment variable provide author information.
2801 .It Ev VISUAL , EDITOR
2802 The editor spawned by
2803 .Cm got commit ,
2804 .Cm got histedit ,
2805 .Cm got import ,
2807 .Cm got tag .
2808 If not set, the
2809 .Xr ed 1
2810 text editor will be spawned in order to give
2811 .Xr ed 1
2812 the attention it deserves.
2813 .It Ev GOT_LOG_DEFAULT_LIMIT
2814 The default limit on the number of commits traversed by
2815 .Cm got log .
2816 If set to zero, the limit is unbounded.
2817 This variable will be silently ignored if it is set to a non-numeric value.
2818 .It Ev GOT_IGNORE_GITCONFIG
2819 If this variable is set then any remote repository definitions or author
2820 information found in Git configuration files will be ignored.
2821 .El
2822 .Sh FILES
2823 .Bl -tag -width packed-refs -compact
2824 .It Pa got.conf
2825 Repository-wide configuration settings for
2826 .Nm .
2827 If present, a
2828 .Xr got.conf 5
2829 configuration file located in the root directory of a Git repository
2830 supersedes any relevant settings in Git's
2831 .Pa config
2832 file.
2833 .Pp
2834 .It Pa .got/got.conf
2835 Worktree-specific configuration settings for
2836 .Nm .
2837 If present, a
2838 .Xr got.conf 5
2839 configuration file in the
2840 .Pa .got
2841 meta-data directory of a work tree supersedes any relevant settings in
2842 the repository's
2843 .Xr got.conf 5
2844 configuration file and Git's
2845 .Pa config
2846 file.
2847 .El
2848 .Sh EXIT STATUS
2849 .Ex -std got
2850 .Sh EXAMPLES
2851 Enable tab-completion of
2852 .Nm
2853 command names in
2854 .Xr ksh 1 :
2855 .Pp
2856 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2857 .Pp
2858 Clone an existing Git repository for use with
2859 .Nm .
2860 .Pp
2861 .Dl $ cd /var/git/
2862 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2863 .Pp
2864 Use of HTTP URLs currently requires
2865 .Xr git 1 :
2866 .Pp
2867 .Dl $ cd /var/git/
2868 .Dl $ git clone --bare https://github.com/openbsd/src.git
2869 .Pp
2870 Alternatively, for quick and dirty local testing of
2871 .Nm
2872 a new Git repository could be created and populated with files,
2873 e.g. from a temporary CVS checkout located at
2874 .Pa /tmp/src :
2875 .Pp
2876 .Dl $ gotadmin init /var/git/src.git
2877 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2878 .Pp
2879 Check out a work tree from the Git repository to /usr/src:
2880 .Pp
2881 .Dl $ got checkout /var/git/src.git /usr/src
2882 .Pp
2883 View local changes in a work tree directory:
2884 .Pp
2885 .Dl $ got diff | less
2886 .Pp
2887 In a work tree, display files in a potentially problematic state:
2888 .Pp
2889 .Dl $ got status -s 'C!~?'
2890 .Pp
2891 Interactively revert selected local changes in a work tree directory:
2892 .Pp
2893 .Dl $ got revert -p -R\ .
2894 .Pp
2895 In a work tree or a git repository directory, list all branch references:
2896 .Pp
2897 .Dl $ got branch -l
2898 .Pp
2899 In a work tree or a git repository directory, create a new branch called
2900 .Dq unified-buffer-cache
2901 which is forked off the
2902 .Dq master
2903 branch:
2904 .Pp
2905 .Dl $ got branch -c master unified-buffer-cache
2906 .Pp
2907 Switch an existing work tree to the branch
2908 .Dq unified-buffer-cache .
2909 Local changes in the work tree will be preserved and merged if necessary:
2910 .Pp
2911 .Dl $ got update -b unified-buffer-cache
2912 .Pp
2913 Create a new commit from local changes in a work tree directory.
2914 This new commit will become the head commit of the work tree's current branch:
2915 .Pp
2916 .Dl $ got commit
2917 .Pp
2918 In a work tree or a git repository directory, view changes committed in
2919 the 3 most recent commits to the work tree's branch, or the branch resolved
2920 via the repository's HEAD reference, respectively:
2921 .Pp
2922 .Dl $ got log -p -l 3
2923 .Pp
2924 As above, but display changes in the order in which
2925 .Xr patch 1
2926 could apply them in sequence:
2927 .Pp
2928 .Dl $ got log -p -l 3 -R
2929 .Pp
2930 In a work tree or a git repository directory, log the history of a subdirectory:
2931 .Pp
2932 .Dl $ got log sys/uvm
2933 .Pp
2934 While operating inside a work tree, paths are specified relative to the current
2935 working directory, so this command will log the subdirectory
2936 .Pa sys/uvm :
2937 .Pp
2938 .Dl $ cd sys/uvm && got log\ .
2939 .Pp
2940 And this command has the same effect:
2941 .Pp
2942 .Dl $ cd sys/dev/usb && got log ../../uvm
2943 .Pp
2944 And this command displays work tree meta-data about all tracked files:
2945 .Pp
2946 .Dl $ cd /usr/src
2947 .Dl $ got info\ . | less
2948 .Pp
2949 Add new files and remove obsolete files in a work tree directory:
2950 .Pp
2951 .Dl $ got add sys/uvm/uvm_ubc.c
2952 .Dl $ got remove sys/uvm/uvm_vnode.c
2953 .Pp
2954 Create a new commit from local changes in a work tree directory
2955 with a pre-defined log message.
2956 .Pp
2957 .Dl $ got commit -m 'unify the buffer cache'
2958 .Pp
2959 Alternatively, create a new commit from local changes in a work tree
2960 directory with a log message that has been prepared in the file
2961 .Pa /tmp/msg :
2962 .Pp
2963 .Dl $ got commit -F /tmp/msg
2964 .Pp
2965 Update any work tree checked out from the
2966 .Dq unified-buffer-cache
2967 branch to the latest commit on this branch:
2968 .Pp
2969 .Dl $ got update
2970 .Pp
2971 Roll file content on the unified-buffer-cache branch back by one commit,
2972 and then fetch the rolled-back change into the work tree as a local change
2973 to be amended and perhaps committed again:
2974 .Pp
2975 .Dl $ got backout unified-buffer-cache
2976 .Dl $ got commit -m 'roll back previous'
2977 .Dl $ # now back out the previous backout :-)
2978 .Dl $ got backout unified-buffer-cache
2979 .Pp
2980 Fetch new changes on the remote repository's
2981 .Dq master
2982 branch, making them visible on the local repository's
2983 .Dq origin/master
2984 branch:
2985 .Pp
2986 .Dl $ cd /usr/src
2987 .Dl $ got fetch
2988 .Pp
2989 In a repository created with a HTTP URL and
2990 .Cm git clone --bare
2991 the
2992 .Xr git-fetch 1
2993 command must be used instead:
2994 .Pp
2995 .Dl $ cd /var/git/src.git
2996 .Dl $ git fetch origin master:refs/remotes/origin/master
2997 .Pp
2998 Rebase the local
2999 .Dq master
3000 branch to merge the new changes that are now visible on the
3001 .Dq origin/master
3002 branch:
3003 .Pp
3004 .Dl $ cd /usr/src
3005 .Dl $ got update -b origin/master
3006 .Dl $ got rebase master
3007 .Pp
3008 Rebase the
3009 .Dq unified-buffer-cache
3010 branch on top of the new head commit of the
3011 .Dq master
3012 branch.
3013 .Pp
3014 .Dl $ got update -b master
3015 .Dl $ got rebase unified-buffer-cache
3016 .Pp
3017 Create a patch from all changes on the unified-buffer-cache branch.
3018 The patch can be mailed out for review and applied to
3019 .Ox Ns 's
3020 CVS tree:
3021 .Pp
3022 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
3023 .Pp
3024 Edit the entire commit history of the
3025 .Dq unified-buffer-cache
3026 branch:
3027 .Pp
3028 .Dl $ got update -b unified-buffer-cache
3029 .Dl $ got update -c master
3030 .Dl $ got histedit
3031 .Pp
3032 Before working against existing branches in a repository cloned with
3033 .Cm git clone --bare
3034 instead of
3035 .Cm got clone ,
3036 a Git
3037 .Dq refspec
3038 must be configured to map all references in the remote repository
3039 into the
3040 .Dq refs/remotes
3041 namespace of the local repository.
3042 This can be achieved by setting Git's
3043 .Pa remote.origin.fetch
3044 configuration variable to the value
3045 .Dq +refs/heads/*:refs/remotes/origin/*
3046 with the
3047 .Cm git config
3048 command:
3049 .Pp
3050 .Dl $ cd /var/git/repo
3051 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3052 .Pp
3053 Additionally, the
3054 .Dq mirror
3055 option must be disabled:
3056 .Pp
3057 .Dl $ cd /var/git/repo
3058 .Dl $ git config remote.origin.mirror false
3059 .Pp
3060 Alternatively, the following
3061 .Xr git-fetch 1
3062 configuration item can be added manually to the Git repository's
3063 .Pa config
3064 file:
3065 .Pp
3066 .Dl [remote \&"origin\&"]
3067 .Dl url = ...
3068 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3069 .Dl mirror = false
3070 .Pp
3071 This configuration leaves the local repository's
3072 .Dq refs/heads
3073 namespace free for use by local branches checked out with
3074 .Cm got checkout
3075 and, if needed, created with
3076 .Cm got branch .
3077 Branches in the
3078 .Dq refs/remotes/origin
3079 namespace can now be updated with incoming changes from the remote
3080 repository with
3081 .Cm got fetch
3083 .Xr git-fetch 1
3084 without extra command line arguments.
3085 Newly fetched changes can be examined with
3086 .Cm got log .
3087 .Pp
3088 Display changes on the remote repository's version of the
3089 .Dq master
3090 branch, as of the last time
3091 .Cm got fetch
3092 was run:
3093 .Pp
3094 .Dl $ got log -c origin/master | less
3095 .Pp
3096 As shown here, most commands accept abbreviated reference names such as
3097 .Dq origin/master
3098 instead of
3099 .Dq refs/remotes/origin/master .
3100 The latter is only needed in case of ambiguity.
3101 .Pp
3102 .Cm got rebase
3103 must be used to merge changes which are visible on the
3104 .Dq origin/master
3105 branch into the
3106 .Dq master
3107 branch.
3108 This will also merge local changes, if any, with the incoming changes:
3109 .Pp
3110 .Dl $ got update -b origin/master
3111 .Dl $ got rebase master
3112 .Pp
3113 In order to make changes committed to the
3114 .Dq unified-buffer-cache
3115 visible on the
3116 .Dq master
3117 branch, the
3118 .Dq unified-buffer-cache
3119 branch must first be rebased onto the
3120 .Dq master
3121 branch:
3122 .Pp
3123 .Dl $ got update -b master
3124 .Dl $ got rebase unified-buffer-cache
3125 .Pp
3126 Changes on the
3127 .Dq unified-buffer-cache
3128 branch can now be made visible on the
3129 .Dq master
3130 branch with
3131 .Cm got integrate .
3132 Because the rebase operation switched the work tree to the
3133 .Dq unified-buffer-cache
3134 branch, the work tree must be switched back to the
3135 .Dq master
3136 branch first:
3137 .Pp
3138 .Dl $ got update -b master
3139 .Dl $ got integrate unified-buffer-cache
3140 .Pp
3141 On the
3142 .Dq master
3143 branch, log messages for local changes can now be amended with
3144 .Dq OK
3145 by other developers and any other important new information:
3146 .Pp
3147 .Dl $ got update -c origin/master
3148 .Dl $ got histedit -m
3149 .Pp
3150 If the remote repository offers write access, local changes on the
3151 .Dq master
3152 branch can be sent to the remote repository with
3153 .Cm got send .
3154 Usually,
3155 .Cm got send
3156 can be run without further arguments.
3157 The arguments shown here match defaults, provided the work tree's
3158 current branch is the
3159 .Dq master
3160 branch:
3161 .Pp
3162 .Dl $ got send -b master origin
3163 .Pp
3164 If the remote repository requires the HTTPS protocol, the
3165 .Xr git-push 1
3166 command must be used instead:
3167 .Pp
3168 .Dl $ cd /var/git/src.git
3169 .Dl $ git push origin master
3170 .Pp
3171 When making contributions to projects which use the
3172 .Dq pull request
3173 workflow, SSH protocol repository access needs to be set up first.
3174 Once an account has been created on a Git hosting site it should
3175 be possible to upload a public SSH key for repository access
3176 authentication.
3177 .Pp
3178 The
3179 .Dq pull request
3180 workflow will usually involve two remote repositories.
3181 In the real-life example below, the
3182 .Dq origin
3183 repository was forked from the
3184 .Dq upstream
3185 repository by using the Git hosting site's web interface.
3186 The
3187 .Xr got.conf 5
3188 file in the local repository describes both remote repositories:
3189 .Bd -literal -offset indent
3190 # Jelmers's repository, which accepts pull requests
3191 remote "upstream" {
3192 server git@github.com
3193 protocol ssh
3194 repository "/jelmer/dulwich"
3195 branch { "master" }
3198 # Stefan's fork, used as the default remote repository
3199 remote "origin" {
3200 server git@github.com
3201 protocol ssh
3202 repository "/stspdotname/dulwich"
3203 branch { "master" }
3205 .Ed
3206 .Pp
3207 With this configuration, Stefan can create commits on
3208 .Dq refs/heads/master
3209 and send them to the
3210 .Dq origin
3211 repository by running:
3212 .Pp
3213 .Dl $ got send -b master origin
3214 .Pp
3215 The changes can now be proposed to Jelmer by opening a pull request
3216 via the Git hosting site's web interface.
3217 If Jelmer requests further changes to be made, additional commits
3218 can be created on the
3219 .Dq master
3220 branch and be added to the pull request by running
3221 .Cd got send
3222 again.
3223 .Pp
3224 If Jelmer prefers additional commits to be
3225 .Dq squashed
3226 then the following commands can be used to achieve this:
3227 .Pp
3228 .Dl $ got update -b master
3229 .Dl $ got update -c origin/master
3230 .Dl $ got histedit -f
3231 .Dl $ got send -f -b master origin
3232 .Pp
3233 Once Jelmer has accepted the pull request, Stefan can fetch the
3234 merged changes, and possibly several other new changes, by running:
3235 .Pp
3236 .Dl $ got fetch upstream
3237 .Pp
3238 The merged changes will now be visible under the reference
3239 .Dq refs/remotes/upstream/master .
3240 The local
3241 .Dq master
3242 branch can now be rebased on top of the latest changes
3243 from upstream:
3244 .Pp
3245 .Dl $ got update -b upstream/master
3246 .Dl $ got rebase master
3247 .Pp
3248 As a final step, the forked repository's copy of the master branch needs
3249 to be kept in sync by sending the new changes there:
3250 .Pp
3251 .Dl $ got send -f -b master origin
3252 .Pp
3253 If multiple pull requests need to be managed in parallel, a separate branch
3254 must be created for each pull request with
3255 .Cm got branch .
3256 Each such branch can then be used as above, in place of
3257 .Dq refs/heads/master .
3258 Changes for any accepted pull requests will still appear under
3259 .Dq refs/remotes/upstream/master,
3260 regardless of which branch was used in the forked repository to
3261 create a pull request.
3262 .Sh SEE ALSO
3263 .Xr gotadmin 1 ,
3264 .Xr tog 1 ,
3265 .Xr git-repository 5 ,
3266 .Xr got-worktree 5 ,
3267 .Xr got.conf 5 ,
3268 .Xr gotweb 8
3269 .Sh AUTHORS
3270 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3271 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3272 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3273 .An Josh Rickmar Aq Mt jrick@zettaport.com
3274 .An Joshua Stein Aq Mt jcs@openbsd.org
3275 .An Klemens Nanni Aq Mt kn@openbsd.org
3276 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3277 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3278 .An Omar Polo Aq Mt op@openbsd.org
3279 .An Ori Bernstein Aq Mt ori@openbsd.org
3280 .An Sebastien Marie Aq Mt semarie@openbsd.org
3281 .An Stefan Sperling Aq Mt stsp@openbsd.org
3282 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3283 .An Theo Buehler Aq Mt tb@openbsd.org
3284 .An Thomas Adam Aq Mt thomas@xteddy.org
3285 .An Tracey Emery Aq Mt tracey@traceyemery.net
3286 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3287 .Pp
3288 Parts of
3289 .Nm ,
3290 .Xr tog 1 ,
3291 and
3292 .Xr gotweb 8
3293 were derived from code under copyright by:
3294 .Pp
3295 .An Caldera International
3296 .An Daniel Hartmeier
3297 .An Esben Norby
3298 .An Henning Brauer
3299 .An HÃ¥kan Olsson
3300 .An Ingo Schwarze
3301 .An Jean-Francois Brousseau
3302 .An Joris Vink
3303 .An Jyri J. Virkki
3304 .An Larry Wall
3305 .An Markus Friedl
3306 .An Niall O'Higgins
3307 .An Niklas Hallqvist
3308 .An Ray Lai
3309 .An Ryan McBride
3310 .An Theo de Raadt
3311 .An Todd C. Miller
3312 .An Xavier Santolaria
3313 .Pp
3314 .Nm
3315 contains code contributed to the public domain by
3316 .An Austin Appleby
3317 .Sh CAVEATS
3318 .Nm
3319 is a work-in-progress and some features remain to be implemented.
3320 .Pp
3321 At present, the user has to fall back on
3322 .Xr git 1
3323 to perform some tasks.
3324 In particular:
3325 .Bl -bullet
3326 .It
3327 Reading from remote repositories over HTTP or HTTPS protocols requires
3328 .Xr git-clone 1
3329 and
3330 .Xr git-fetch 1 .
3331 .It
3332 Writing to remote repositories over HTTP or HTTPS protocols requires
3333 .Xr git-push 1 .
3334 .It
3335 The creation of merge commits with more than two parent commits requires
3336 .Xr git-merge 1 .
3337 .It
3338 In situations where files or directories were moved around
3339 .Cm got
3340 will not automatically merge changes to new locations and
3341 .Xr git 1
3342 will usually produce better results.
3343 .El