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 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 n
1405 Do not make any modifications to the work tree.
1406 This can be used to check whether a patch would apply without issues.
1407 If the
1408 .Ar patchfile
1409 contains diffs that affect the same file multiple times, the results
1410 displayed may be incorrect.
1411 .It Fl p Ar strip-count
1412 Specify the number of leading path components to strip from paths
1413 parsed from
1414 .Ar patchfile .
1415 If the
1416 .Fl p
1417 option is not used,
1418 .Sq a/
1419 and
1420 .Sq b/
1421 path prefixes generated by
1422 .Xr git-diff 1
1423 will be recognized and stripped automatically.
1424 .It Fl R
1425 Reverse the patch before applying it.
1426 .El
1427 .Tg rv
1428 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1429 .Dl Pq alias: Cm rv
1430 Revert any local changes in files at the specified paths in a work tree.
1431 File contents will be overwritten with those contained in the
1432 work tree's base commit.
1433 There is no way to bring discarded changes back after
1434 .Cm got revert !
1435 .Pp
1436 If a file was added with
1437 .Cm got add ,
1438 it will become an unversioned file again.
1439 If a file was deleted with
1440 .Cm got remove ,
1441 it will be restored.
1442 .Pp
1443 The options for
1444 .Cm got revert
1445 are as follows:
1446 .Bl -tag -width Ds
1447 .It Fl p
1448 Instead of reverting all changes in files, interactively select or reject
1449 changes to revert based on
1450 .Dq y
1451 (revert change),
1452 .Dq n
1453 (keep change), and
1454 .Dq q
1455 (quit reverting this file) responses.
1456 If a file is in modified status, individual patches derived from the
1457 modified file content can be reverted.
1458 Files in added or deleted status may only be reverted in their entirety.
1459 .It Fl F Ar response-script
1460 With the
1461 .Fl p
1462 option, read
1463 .Dq y ,
1464 .Dq n ,
1465 and
1466 .Dq q
1467 responses line-by-line from the specified
1468 .Ar response-script
1469 file instead of prompting interactively.
1470 .It Fl R
1471 Permit recursion into directories.
1472 If this option is not specified,
1473 .Cm got revert
1474 will refuse to run if a specified
1475 .Ar path
1476 is a directory.
1477 .El
1478 .Tg ci
1479 .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 ...
1480 .Dl Pq alias: Cm ci
1481 Create a new commit in the repository from changes in a work tree
1482 and use this commit as the new base commit for the work tree.
1483 If no
1484 .Ar path
1485 is specified, commit all changes in the work tree.
1486 Otherwise, commit changes at or within the specified paths.
1487 .Pp
1488 If changes have been explicitly staged for commit with
1489 .Cm got stage ,
1490 only commit staged changes and reject any specified paths which
1491 have not been staged.
1492 .Pp
1493 .Cm got commit
1494 opens a temporary file in an editor where a log message can be written
1495 unless the
1496 .Fl m
1497 option is used
1498 or the
1499 .Fl F
1500 and
1501 .Fl N
1502 options are used together.
1503 .Pp
1504 Show the status of each affected file, using the following status codes:
1505 .Bl -column YXZ description
1506 .It M Ta modified file
1507 .It D Ta file was deleted
1508 .It A Ta new file was added
1509 .It m Ta modified file modes (executable bit only)
1510 .El
1511 .Pp
1512 Files which are not part of the new commit will retain their previously
1513 recorded base commit.
1514 Some
1515 .Nm
1516 commands may refuse to run while the work tree contains files from
1517 multiple base commits.
1518 The base commit of such a work tree can be made consistent by running
1519 .Cm got update
1520 across the entire work tree.
1521 .Pp
1522 The
1523 .Cm got commit
1524 command requires the
1525 .Ev GOT_AUTHOR
1526 environment variable to be set,
1527 unless an author has been configured in
1528 .Xr got.conf 5
1529 or Git's
1530 .Dv user.name
1531 and
1532 .Dv user.email
1533 configuration settings can be
1534 obtained from the repository's
1535 .Pa .git/config
1536 file or from Git's global
1537 .Pa ~/.gitconfig
1538 configuration file.
1539 .Pp
1540 The options for
1541 .Cm got commit
1542 are as follows:
1543 .Bl -tag -width Ds
1544 .It Fl A Ar author
1545 Set author information in the newly created commit to
1546 .Ar author .
1547 This is useful when committing changes which were written by someone
1548 else.
1549 The
1550 .Ar author
1551 argument must use the same format as the
1552 .Ev GOT_AUTHOR
1553 environment variable.
1554 .Pp
1555 In addition to storing author information, the newly created commit
1556 object will retain
1557 .Dq committer
1558 information which is obtained, as usual, from the
1559 .Ev GOT_AUTHOR
1560 environment variable, or
1561 .Xr got.conf 5 ,
1562 or Git configuration settings.
1563 .It Fl F Ar path
1564 Use the prepared log message stored in the file found at
1565 .Ar path
1566 when creating the new commit.
1567 .Cm got commit
1568 opens a temporary file in an editor where the prepared log message can be
1569 reviewed and edited further if needed.
1570 Cannot be used together with the
1571 .Fl m
1572 option.
1573 .It Fl m Ar message
1574 Use the specified log message when creating the new commit.
1575 Cannot be used together with the
1576 .Fl F
1577 option.
1578 .It Fl N
1579 This option prevents
1580 .Cm got commit
1581 from opening the commit message in an editor.
1582 It has no effect unless it is used together with the
1583 .Fl F
1584 option and is intended for non-interactive use such as scripting.
1585 .It Fl S
1586 Allow the addition of symbolic links which point outside of the path space
1587 that is under version control.
1588 By default,
1589 .Cm got commit
1590 will reject such symbolic links due to safety concerns.
1591 As a precaution,
1592 .Nm
1593 may decide to represent such a symbolic link as a regular file which contains
1594 the link's target path, rather than creating an actual symbolic link which
1595 points outside of the work tree.
1596 Use of this option is discouraged because external mechanisms such as
1597 .Dq make obj
1598 are better suited for managing symbolic links to paths not under
1599 version control.
1600 .El
1601 .Pp
1602 .Cm got commit
1603 will refuse to run if certain preconditions are not met.
1604 If the work tree's current branch is not in the
1605 .Dq refs/heads/
1606 reference namespace, new commits may not be created on this branch.
1607 Local changes may only be committed if they are based on file content
1608 found in the most recent commit on the work tree's branch.
1609 If a path is found to be out of date,
1610 .Cm got update
1611 must be used first in order to merge local changes with changes made
1612 in the repository.
1613 .Tg se
1614 .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
1615 .Dl Pq alias: Cm se
1616 Send new changes to a remote repository.
1617 If no
1618 .Ar remote-repository
1619 is specified,
1620 .Dq origin
1621 will be used.
1622 The remote repository's URL is obtained from the corresponding entry in
1623 .Xr got.conf 5
1624 or Git's
1625 .Pa config
1626 file of the local repository, as created by
1627 .Cm got clone .
1628 .Pp
1629 All objects corresponding to new changes will be written to a temporary
1630 pack file which is then uploaded to the server.
1631 Upon success, references in the
1632 .Dq refs/remotes/
1633 reference namespace of the local repository will be updated to point at
1634 the commits which have been sent.
1635 .Pp
1636 By default, changes will only be sent if they are based on up-to-date
1637 copies of relevant branches in the remote repository.
1638 If any changes to be sent are based on out-of-date copies or would
1639 otherwise break linear history of existing branches, new changes must
1640 be fetched from the server with
1641 .Cm got fetch
1642 and local branches must be rebased with
1643 .Cm got rebase
1644 before
1645 .Cm got send
1646 can succeed.
1647 The
1648 .Fl f
1649 option can be used to make exceptions to these requirements.
1650 .Pp
1651 The options for
1652 .Cm got send
1653 are as follows:
1654 .Bl -tag -width Ds
1655 .It Fl a
1656 Send all branches from the local repository's
1657 .Dq refs/heads/
1658 reference namespace.
1659 The
1660 .Fl a
1661 option is equivalent to listing all branches with multiple
1662 .Fl b
1663 options.
1664 Cannot be used together with the
1665 .Fl b
1666 option.
1667 .It Fl b Ar branch
1668 Send the specified
1669 .Ar branch
1670 from the local repository's
1671 .Dq refs/heads/
1672 reference namespace.
1673 This option may be specified multiple times to build a list of branches
1674 to send.
1675 If this option is not specified, default to the work tree's current branch
1676 if invoked in a work tree, or to the repository's HEAD reference.
1677 Cannot be used together with the
1678 .Fl a
1679 option.
1680 .It Fl d Ar branch
1681 Delete the specified
1682 .Ar branch
1683 from the remote repository's
1684 .Dq refs/heads/
1685 reference namespace.
1686 This option may be specified multiple times to build a list of branches
1687 to delete.
1688 .Pp
1689 Only references are deleted.
1690 Any commit, tree, tag, and blob objects belonging to deleted branches
1691 may become subject to deletion by Git's garbage collector running on
1692 the server.
1693 .Pp
1694 Requesting deletion of branches results in an error if the server
1695 does not support this feature or disallows the deletion of branches
1696 based on its configuration.
1697 .It Fl f
1698 Attempt to force the server to overwrite existing branches or tags
1699 in the remote repository, even when
1700 .Cm got fetch
1701 and
1702 .Cm got rebase
1703 would usually be required before changes can be sent.
1704 The server may reject forced requests regardless, depending on its
1705 configuration.
1706 .Pp
1707 Any commit, tree, tag, and blob objects belonging to overwritten branches
1708 or tags may become subject to deletion by Git's garbage collector running
1709 on the server.
1710 .Pp
1711 The
1712 .Dq refs/tags
1713 reference namespace is globally shared between all repositories.
1714 Use of the
1715 .Fl f
1716 option to overwrite tags is discouraged because it can lead to
1717 inconsistencies between the tags present in different repositories.
1718 In general, creating a new tag with a different name is recommended
1719 instead of overwriting an existing tag.
1720 .Pp
1721 Use of the
1722 .Fl f
1723 option is particularly discouraged if changes being sent are based
1724 on an out-of-date copy of a branch in the remote repository.
1725 Instead of using the
1726 .Fl f
1727 option, new changes should
1728 be fetched with
1729 .Cm got fetch
1730 and local branches should be rebased with
1731 .Cm got rebase ,
1732 followed by another attempt to send the changes.
1733 .Pp
1734 The
1735 .Fl f
1736 option should only be needed in situations where the remote repository's
1737 copy of a branch or tag is known to be out-of-date and is considered
1738 disposable.
1739 The risks of creating inconsistencies between different repositories
1740 should also be taken into account.
1741 .It Fl r Ar repository-path
1742 Use the repository at the specified path.
1743 If not specified, assume the repository is located at or above the current
1744 working directory.
1745 If this directory is a
1746 .Nm
1747 work tree, use the repository path associated with this work tree.
1748 .It Fl t Ar tag
1749 Send the specified
1750 .Ar tag
1751 from the local repository's
1752 .Dq refs/tags/
1753 reference namespace, in addition to any branches that are being sent.
1754 The
1755 .Fl t
1756 option may be specified multiple times to build a list of tags to send.
1757 No tags will be sent if the
1758 .Fl t
1759 option is not used.
1760 .Pp
1761 Raise an error if the specified
1762 .Ar tag
1763 already exists in the remote repository, unless the
1764 .Fl f
1765 option is used to overwrite the server's copy of the tag.
1766 In general, creating a new tag with a different name is recommended
1767 instead of overwriting an existing tag.
1768 .Pp
1769 Cannot be used together with the
1770 .Fl T
1771 option.
1772 .It Fl T
1773 Attempt to send all tags from the local repository's
1774 .Dq refs/tags/
1775 reference namespace.
1776 The
1777 .Fl T
1778 option is equivalent to listing all tags with multiple
1779 .Fl t
1780 options.
1781 Cannot be used together with the
1782 .Fl t
1783 option.
1784 .It Fl q
1785 Suppress progress reporting output.
1786 The same option will be passed to
1787 .Xr ssh 1
1788 if applicable.
1789 .It Fl v
1790 Verbose mode.
1791 Causes
1792 .Cm got send
1793 to print debugging messages to standard error output.
1794 The same option will be passed to
1795 .Xr ssh 1
1796 if applicable.
1797 Multiple -v options increase the verbosity.
1798 The maximum is 3.
1799 .El
1800 .Tg cy
1801 .It Cm cherrypick Ar commit
1802 .Dl Pq alias: Cm cy
1803 Merge changes from a single
1804 .Ar commit
1805 into the work tree.
1806 The specified
1807 .Ar commit
1808 should be on a different branch than the work tree's base commit.
1809 The expected argument is a reference or a commit ID SHA1 hash.
1810 An abbreviated hash argument will be expanded to a full SHA1 hash
1811 automatically, provided the abbreviation is unique.
1812 .Pp
1813 Show the status of each affected file, using the following status codes:
1814 .Bl -column YXZ description
1815 .It G Ta file was merged
1816 .It C Ta file was merged and conflicts occurred during merge
1817 .It ! Ta changes destined for a missing file were not merged
1818 .It D Ta file was deleted
1819 .It d Ta file's deletion was prevented by local modifications
1820 .It A Ta new file was added
1821 .It \(a~ Ta changes destined for a non-regular file were not merged
1822 .It ? Ta changes destined for an unversioned file were not merged
1823 .El
1824 .Pp
1825 The merged changes will appear as local changes in the work tree, which
1826 may be viewed with
1827 .Cm got diff ,
1828 amended manually or with further
1829 .Cm got cherrypick
1830 commands,
1831 committed with
1832 .Cm got commit ,
1833 or discarded again with
1834 .Cm got revert .
1835 .Pp
1836 .Cm got cherrypick
1837 will refuse to run if certain preconditions are not met.
1838 If the work tree contains multiple base commits, it must first be updated
1839 to a single base commit with
1840 .Cm got update .
1841 If any relevant files already contain merge conflicts, these
1842 conflicts must be resolved first.
1843 .Tg bo
1844 .It Cm backout Ar commit
1845 .Dl Pq alias: Cm bo
1846 Reverse-merge changes from a single
1847 .Ar commit
1848 into the work tree.
1849 The specified
1850 .Ar commit
1851 should be on the same branch as the work tree's base commit.
1852 The expected argument is a reference or a commit ID SHA1 hash.
1853 An abbreviated hash argument will be expanded to a full SHA1 hash
1854 automatically, provided the abbreviation is unique.
1855 .Pp
1856 Show the status of each affected file, using the following status codes:
1857 .Bl -column YXZ description
1858 .It G Ta file was merged
1859 .It C Ta file was merged and conflicts occurred during merge
1860 .It ! Ta changes destined for a missing file were not merged
1861 .It D Ta file was deleted
1862 .It d Ta file's deletion was prevented by local modifications
1863 .It A Ta new file was added
1864 .It \(a~ Ta changes destined for a non-regular file were not merged
1865 .It ? Ta changes destined for an unversioned file were not merged
1866 .El
1867 .Pp
1868 The reverse-merged changes will appear as local changes in the work tree,
1869 which may be viewed with
1870 .Cm got diff ,
1871 amended manually or with further
1872 .Cm got backout
1873 commands,
1874 committed with
1875 .Cm got commit ,
1876 or discarded again with
1877 .Cm got revert .
1878 .Pp
1879 .Cm got backout
1880 will refuse to run if certain preconditions are not met.
1881 If the work tree contains multiple base commits, it must first be updated
1882 to a single base commit with
1883 .Cm got update .
1884 If any relevant files already contain merge conflicts, these
1885 conflicts must be resolved first.
1886 .Tg rb
1887 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1888 .Dl Pq alias: Cm rb
1889 Rebase commits on the specified
1890 .Ar branch
1891 onto the tip of the current branch of the work tree.
1892 The
1893 .Ar branch
1894 must share common ancestry with the work tree's current branch.
1895 Rebasing begins with the first descendant commit of the youngest
1896 common ancestor commit shared by the specified
1897 .Ar branch
1898 and the work tree's current branch, and stops once the tip commit
1899 of the specified
1900 .Ar branch
1901 has been rebased.
1902 .Pp
1903 When
1904 .Cm got rebase
1905 is used as intended, the specified
1906 .Ar branch
1907 represents a local commit history and may already contain changes
1908 that are not yet visible in any other repositories.
1909 The work tree's current branch, which must be set with
1910 .Cm got update -b
1911 before starting the
1912 .Cm rebase
1913 operation, represents a branch from a remote repository which shares
1914 a common history with the specified
1915 .Ar branch
1916 but has progressed, and perhaps diverged, due to commits added to the
1917 remote repository.
1918 .Pp
1919 Rebased commits are accumulated on a temporary branch which the work tree
1920 will remain switched to throughout the entire rebase operation.
1921 Commits on this branch represent the same changes with the same log
1922 messages as their counterparts on the original
1923 .Ar branch ,
1924 but with different commit IDs.
1925 Once rebasing has completed successfully, the temporary branch becomes
1926 the new version of the specified
1927 .Ar branch
1928 and the work tree is automatically switched to it.
1929 .Pp
1930 Old commits in their pre-rebase state are automatically backed up in the
1931 .Dq refs/got/backup/rebase
1932 reference namespace.
1933 As long as these references are not removed older versions of rebased
1934 commits will remain in the repository and can be viewed with the
1935 .Cm got rebase -l
1936 command.
1937 Removal of these references makes objects which become unreachable via
1938 any reference subject to removal by Git's garbage collector or
1939 .Cm gotadmin cleanup .
1940 .Pp
1941 While rebasing commits, show the status of each affected file,
1942 using the following status codes:
1943 .Bl -column YXZ description
1944 .It G Ta file was merged
1945 .It C Ta file was merged and conflicts occurred during merge
1946 .It ! Ta changes destined for a missing file were not merged
1947 .It D Ta file was deleted
1948 .It d Ta file's deletion was prevented by local modifications
1949 .It A Ta new file was added
1950 .It \(a~ Ta changes destined for a non-regular file were not merged
1951 .It ? Ta changes destined for an unversioned file were not merged
1952 .El
1953 .Pp
1954 If merge conflicts occur, the rebase operation is interrupted and may
1955 be continued once conflicts have been resolved.
1956 If any files with destined changes are found to be missing or unversioned,
1957 or if files could not be deleted due to differences in deleted content,
1958 the rebase operation will be interrupted to prevent potentially incomplete
1959 changes from being committed to the repository without user intervention.
1960 The work tree may be modified as desired and the rebase operation can be
1961 continued once the changes present in the work tree are considered complete.
1962 Alternatively, the rebase operation may be aborted which will leave
1963 .Ar branch
1964 unmodified and the work tree switched back to its original branch.
1965 .Pp
1966 If a merge conflict is resolved in a way which renders the merged
1967 change into a no-op change, the corresponding commit will be elided
1968 when the rebase operation continues.
1969 .Pp
1970 .Cm got rebase
1971 will refuse to run if certain preconditions are not met.
1972 If the work tree is not yet fully updated to the tip commit of its
1973 branch, then the work tree must first be updated with
1974 .Cm got update .
1975 If changes have been staged with
1976 .Cm got stage ,
1977 these changes must first be committed with
1978 .Cm got commit
1979 or unstaged with
1980 .Cm got unstage .
1981 If the work tree contains local changes, these changes must first be
1982 committed with
1983 .Cm got commit
1984 or reverted with
1985 .Cm got revert .
1986 If the
1987 .Ar branch
1988 contains changes to files outside of the work tree's path prefix,
1989 the work tree cannot be used to rebase this branch.
1990 .Pp
1991 The
1992 .Cm got update
1993 and
1994 .Cm got commit
1995 commands will refuse to run while a rebase operation is in progress.
1996 Other commands which manipulate the work tree may be used for
1997 conflict resolution purposes.
1998 .Pp
1999 If the specified
2000 .Ar branch
2001 is already based on the work tree's current branch, then no commits
2002 need to be rebased and
2003 .Cm got rebase
2004 will simply switch the work tree to the specified
2005 .Ar branch
2006 and update files in the work tree accordingly.
2007 .Pp
2008 The options for
2009 .Cm got rebase
2010 are as follows:
2011 .Bl -tag -width Ds
2012 .It Fl a
2013 Abort an interrupted rebase operation.
2014 If this option is used, no other command-line arguments are allowed.
2015 .It Fl c
2016 Continue an interrupted rebase operation.
2017 If this option is used, no other command-line arguments are allowed.
2018 .It Fl l
2019 Show a list of past rebase operations, represented by references in the
2020 .Dq refs/got/backup/rebase
2021 reference namespace.
2022 .Pp
2023 Display the author, date, and log message of each backed up commit,
2024 the object ID of the corresponding post-rebase commit, and
2025 the object ID of their common ancestor commit.
2026 Given these object IDs,
2027 the
2028 .Cm got log
2029 command with the
2030 .Fl c
2031 and
2032 .Fl x
2033 options can be used to examine the history of either version of the branch,
2034 and the
2035 .Cm got branch
2036 command with the
2037 .Fl c
2038 option can be used to create a new branch from a pre-rebase state if desired.
2039 .Pp
2040 If a
2041 .Ar branch
2042 is specified, only show commits which at some point in time represented this
2043 branch.
2044 Otherwise, list all backed up commits for any branches.
2045 .Pp
2046 If this option is used,
2047 .Cm got rebase
2048 does not require a work tree.
2049 None of the other options can be used together with
2050 .Fl l .
2051 .It Fl X
2052 Delete backups created by past rebase operations, represented by references
2053 in the
2054 .Dq refs/got/backup/rebase
2055 reference namespace.
2056 .Pp
2057 If a
2058 .Ar branch
2059 is specified, only delete backups which at some point in time represented
2060 this branch.
2061 Otherwise, delete all references found within
2062 .Dq refs/got/backup/rebase .
2063 .Pp
2064 Any commit, tree, tag, and blob objects belonging to deleted backups
2065 remain in the repository and may be removed separately with
2066 Git's garbage collector or
2067 .Cm gotadmin cleanup .
2068 .Pp
2069 If this option is used,
2070 .Cm got rebase
2071 does not require a work tree.
2072 None of the other options can be used together with
2073 .Fl X .
2074 .El
2075 .Tg he
2076 .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
2077 .Dl Pq alias: Cm he
2078 Edit commit history between the work tree's current base commit and
2079 the tip commit of the work tree's current branch.
2080 .Pp
2081 Before starting a
2082 .Cm histedit
2083 operation, the work tree's current branch must be set with
2084 .Cm got update -b
2085 to the branch which should be edited, unless this branch is already the
2086 current branch of the work tree.
2087 The tip of this branch represents the upper bound (inclusive) of commits
2088 touched by the
2089 .Cm histedit
2090 operation.
2091 .Pp
2092 Furthermore, the work tree's base commit
2093 must be set with
2094 .Cm got update -c
2095 to a point in this branch's commit history where editing should begin.
2096 This commit represents the lower bound (non-inclusive) of commits touched
2097 by the
2098 .Cm histedit
2099 operation.
2100 .Pp
2101 Editing of commit history is controlled via a
2102 .Ar histedit script
2103 which can be written in an editor based on a template, passed on the
2104 command line, or generated with the
2105 .Fl f
2107 .Fl m
2108 options.
2109 .Pp
2110 The format of the histedit script is line-based.
2111 Each line in the script begins with a command name, followed by
2112 whitespace and an argument.
2113 For most commands, the expected argument is a commit ID SHA1 hash.
2114 Any remaining text on the line is ignored.
2115 Lines which begin with the
2116 .Sq #
2117 character are ignored entirely.
2118 .Pp
2119 The available histedit script commands are as follows:
2120 .Bl -column YXZ pick-commit
2121 .It Cm pick Ar commit Ta Use the specified commit as it is.
2122 .It Cm edit Ar commit Ta Use the specified commit but once changes have been
2123 merged into the work tree interrupt the histedit operation for amending.
2124 .It Cm fold Ar commit Ta Combine the specified commit with the next commit
2125 listed further below that will be used.
2126 .It Cm drop Ar commit Ta Remove this commit from the edited history.
2127 .It Cm mesg Oo Ar log-message Oc Ta Create a new log message for the commit of
2128 a preceding
2129 .Cm pick
2131 .Cm edit
2132 command on the previous line of the histedit script.
2133 The optional
2134 .Ar log-message
2135 argument provides a new single-line log message to use.
2136 If the
2137 .Ar log-message
2138 argument is omitted, open an editor where a new log message can be written.
2139 .El
2140 .Pp
2141 Every commit in the history being edited must be mentioned in the script.
2142 Lines may be re-ordered to change the order of commits in the edited history.
2143 No commit may be listed more than once.
2144 .Pp
2145 Edited commits are accumulated on a temporary branch which the work tree
2146 will remain switched to throughout the entire histedit operation.
2147 Once history editing has completed successfully, the temporary branch becomes
2148 the new version of the work tree's branch and the work tree is automatically
2149 switched to it.
2150 .Pp
2151 Old commits in their pre-histedit state are automatically backed up in the
2152 .Dq refs/got/backup/histedit
2153 reference namespace.
2154 As long as these references are not removed older versions of edited
2155 commits will remain in the repository and can be viewed with the
2156 .Cm got histedit -l
2157 command.
2158 Removal of these references makes objects which become unreachable via
2159 any reference subject to removal by Git's garbage collector or
2160 .Cm gotadmin cleanup .
2161 .Pp
2162 While merging commits, show the status of each affected file,
2163 using the following status codes:
2164 .Bl -column YXZ description
2165 .It G Ta file was merged
2166 .It C Ta file was merged and conflicts occurred during merge
2167 .It ! Ta changes destined for a missing file were not merged
2168 .It D Ta file was deleted
2169 .It d Ta file's deletion was prevented by local modifications
2170 .It A Ta new file was added
2171 .It \(a~ Ta changes destined for a non-regular file were not merged
2172 .It ? Ta changes destined for an unversioned file were not merged
2173 .El
2174 .Pp
2175 If merge conflicts occur, the histedit operation is interrupted and may
2176 be continued once conflicts have been resolved.
2177 If any files with destined changes are found to be missing or unversioned,
2178 or if files could not be deleted due to differences in deleted content,
2179 the histedit operation will be interrupted to prevent potentially incomplete
2180 changes from being committed to the repository without user intervention.
2181 The work tree may be modified as desired and the histedit operation can be
2182 continued once the changes present in the work tree are considered complete.
2183 Alternatively, the histedit operation may be aborted which will leave
2184 the work tree switched back to its original branch.
2185 .Pp
2186 If a merge conflict is resolved in a way which renders the merged
2187 change into a no-op change, the corresponding commit will be elided
2188 when the histedit operation continues.
2189 .Pp
2190 .Cm got histedit
2191 will refuse to run if certain preconditions are not met.
2192 If the work tree's current branch is not in the
2193 .Dq refs/heads/
2194 reference namespace, the history of the branch may not be edited.
2195 If the work tree contains multiple base commits, it must first be updated
2196 to a single base commit with
2197 .Cm got update .
2198 If changes have been staged with
2199 .Cm got stage ,
2200 these changes must first be committed with
2201 .Cm got commit
2202 or unstaged with
2203 .Cm got unstage .
2204 If the work tree contains local changes, these changes must first be
2205 committed with
2206 .Cm got commit
2207 or reverted with
2208 .Cm got revert .
2209 If the edited history contains changes to files outside of the work tree's
2210 path prefix, the work tree cannot be used to edit the history of this branch.
2211 .Pp
2212 The
2213 .Cm got update ,
2214 .Cm got rebase ,
2215 and
2216 .Cm got integrate
2217 commands will refuse to run while a histedit operation is in progress.
2218 Other commands which manipulate the work tree may be used, and the
2219 .Cm got commit
2220 command may be used to commit arbitrary changes to the temporary branch
2221 while the histedit operation is interrupted.
2222 .Pp
2223 The options for
2224 .Cm got histedit
2225 are as follows:
2226 .Bl -tag -width Ds
2227 .It Fl a
2228 Abort an interrupted histedit operation.
2229 If this option is used, no other command-line arguments are allowed.
2230 .It Fl c
2231 Continue an interrupted histedit operation.
2232 If this option is used, no other command-line arguments are allowed.
2233 .It Fl e
2234 Interrupt the histedit operation for editing after merging each commit.
2235 This option is a quick equivalent to a histedit script which uses the
2236 .Cm edit
2237 command for all commits.
2238 The
2239 .Fl e
2240 option can only be used when starting a new histedit operation.
2241 If this option is used, no other command-line arguments are allowed.
2242 .It Fl f
2243 Fold all commits into a single commit.
2244 This option is a quick equivalent to a histedit script which folds all
2245 commits, combining them all into one commit.
2246 The
2247 .Fl f
2248 option can only be used when starting a new histedit operation.
2249 If this option is used, no other command-line arguments are allowed.
2250 .It Fl F Ar histedit-script
2251 Use the specified
2252 .Ar histedit-script
2253 instead of opening a temporary file in an editor where a histedit script
2254 can be written.
2255 .It Fl m
2256 Edit log messages only.
2257 This option is a quick equivalent to a histedit script which edits
2258 only log messages but otherwise leaves every picked commit as-is.
2259 The
2260 .Fl m
2261 option can only be used when starting a new histedit operation.
2262 If this option is used, no other command-line arguments are allowed.
2263 .It Fl l
2264 Show a list of past histedit operations, represented by references in the
2265 .Dq refs/got/backup/histedit
2266 reference namespace.
2267 .Pp
2268 Display the author, date, and log message of each backed up commit,
2269 the object ID of the corresponding post-histedit commit, and
2270 the object ID of their common ancestor commit.
2271 Given these object IDs,
2272 the
2273 .Cm got log
2274 command with the
2275 .Fl c
2276 and
2277 .Fl x
2278 options can be used to examine the history of either version of the branch,
2279 and the
2280 .Cm got branch
2281 command with the
2282 .Fl c
2283 option can be used to create a new branch from a pre-histedit state if desired.
2284 .Pp
2285 If a
2286 .Ar branch
2287 is specified, only show commits which at some point in time represented this
2288 branch.
2289 Otherwise, list all backed up commits for any branches.
2290 .Pp
2291 If this option is used,
2292 .Cm got histedit
2293 does not require a work tree.
2294 None of the other options can be used together with
2295 .Fl l .
2296 .It Fl X
2297 Delete backups created by past histedit operations, represented by references
2298 in the
2299 .Dq refs/got/backup/histedit
2300 reference namespace.
2301 .Pp
2302 If a
2303 .Ar branch
2304 is specified, only delete backups which at some point in time represented
2305 this branch.
2306 Otherwise, delete all references found within
2307 .Dq refs/got/backup/histedit .
2308 .Pp
2309 Any commit, tree, tag, and blob objects belonging to deleted backups
2310 remain in the repository and may be removed separately with
2311 Git's garbage collector or
2312 .Cm gotadmin cleanup .
2313 .Pp
2314 If this option is used,
2315 .Cm got histedit
2316 does not require a work tree.
2317 None of the other options can be used together with
2318 .Fl X .
2319 .El
2320 .Tg ig
2321 .It Cm integrate Ar branch
2322 .Dl Pq alias: Cm ig
2323 Integrate the specified
2324 .Ar branch
2325 into the work tree's current branch.
2326 Files in the work tree are updated to match the contents on the integrated
2327 .Ar branch ,
2328 and the reference of the work tree's branch is changed to point at the
2329 head commit of the integrated
2330 .Ar branch .
2331 .Pp
2332 Both branches can be considered equivalent after integration since they
2333 will be pointing at the same commit.
2334 Both branches remain available for future work, if desired.
2335 In case the integrated
2336 .Ar branch
2337 is no longer needed it may be deleted with
2338 .Cm got branch -d .
2339 .Pp
2340 Show the status of each affected file, using the following status codes:
2341 .Bl -column YXZ description
2342 .It U Ta file was updated
2343 .It D Ta file was deleted
2344 .It A Ta new file was added
2345 .It \(a~ Ta versioned file is obstructed by a non-regular file
2346 .It ! Ta a missing versioned file was restored
2347 .El
2348 .Pp
2349 .Cm got integrate
2350 will refuse to run if certain preconditions are not met.
2351 Most importantly, the
2352 .Ar branch
2353 must have been rebased onto the work tree's current branch with
2354 .Cm got rebase
2355 before it can be integrated, in order to linearize commit history and
2356 resolve merge conflicts.
2357 If the work tree contains multiple base commits, it must first be updated
2358 to a single base commit with
2359 .Cm got update .
2360 If changes have been staged with
2361 .Cm got stage ,
2362 these changes must first be committed with
2363 .Cm got commit
2364 or unstaged with
2365 .Cm got unstage .
2366 If the work tree contains local changes, these changes must first be
2367 committed with
2368 .Cm got commit
2369 or reverted with
2370 .Cm got revert .
2371 .Tg mg
2372 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2373 .Dl Pq alias: Cm mg
2374 Create a merge commit based on the current branch of the work tree and
2375 the specified
2376 .Ar branch .
2377 If a linear project history is desired, then use of
2378 .Cm got rebase
2379 should be preferred over
2380 .Cm got merge .
2381 However, even strictly linear projects may require merge commits in order
2382 to merge in new versions of third-party code stored on vendor branches
2383 created with
2384 .Cm got import .
2385 .Pp
2386 Merge commits are commits based on multiple parent commits.
2387 The tip commit of the work tree's current branch, which must be set with
2388 .Cm got update -b
2389 before starting the
2390 .Cm merge
2391 operation, will be used as the first parent.
2392 The tip commit of the specified
2393 .Ar branch
2394 will be used as the second parent.
2395 .Pp
2396 No ancestral relationship between the two branches is required.
2397 If the two branches have already been merged previously, only new changes
2398 will be merged.
2399 .Pp
2400 It is not possible to create merge commits with more than two parents.
2401 If more than one branch needs to be merged, then multiple merge commits
2402 with two parents each can be created in sequence.
2403 .Pp
2404 While merging changes found on the
2405 .Ar branch
2406 into the work tree, show the status of each affected file,
2407 using the following status codes:
2408 .Bl -column YXZ description
2409 .It G Ta file was merged
2410 .It C Ta file was merged and conflicts occurred during merge
2411 .It ! Ta changes destined for a missing file were not merged
2412 .It D Ta file was deleted
2413 .It d Ta file's deletion was prevented by local modifications
2414 .It A Ta new file was added
2415 .It \(a~ Ta changes destined for a non-regular file were not merged
2416 .It ? Ta changes destined for an unversioned file were not merged
2417 .El
2418 .Pp
2419 If merge conflicts occur, the merge operation is interrupted and conflicts
2420 must be resolved before the merge operation can continue.
2421 If any files with destined changes are found to be missing or unversioned,
2422 or if files could not be deleted due to differences in deleted content,
2423 the merge operation will be interrupted to prevent potentially incomplete
2424 changes from being committed to the repository without user intervention.
2425 The work tree may be modified as desired and the merge can be continued
2426 once the changes present in the work tree are considered complete.
2427 Alternatively, the merge operation may be aborted which will leave
2428 the work tree's current branch unmodified.
2429 .Pp
2430 If a merge conflict is resolved in a way which renders all merged
2431 changes into no-op changes, the merge operation cannot continue
2432 and must be aborted.
2433 .Pp
2434 .Cm got merge
2435 will refuse to run if certain preconditions are not met.
2436 If history of the
2437 .Ar branch
2438 is based on the work tree's current branch, then no merge commit can
2439 be created and
2440 .Cm got integrate
2441 may be used to integrate the
2442 .Ar branch
2443 instead.
2444 If the work tree is not yet fully updated to the tip commit of its
2445 branch, then the work tree must first be updated with
2446 .Cm got update .
2447 If the work tree contains multiple base commits, it must first be updated
2448 to a single base commit with
2449 .Cm got update .
2450 If changes have been staged with
2451 .Cm got stage ,
2452 these changes must first be committed with
2453 .Cm got commit
2454 or unstaged with
2455 .Cm got unstage .
2456 If the work tree contains local changes, these changes must first be
2457 committed with
2458 .Cm got commit
2459 or reverted with
2460 .Cm got revert .
2461 If the
2462 .Ar branch
2463 contains changes to files outside of the work tree's path prefix,
2464 the work tree cannot be used to merge this branch.
2465 .Pp
2466 The
2467 .Cm got update ,
2468 .Cm got commit ,
2469 .Cm got rebase ,
2470 .Cm got histedit ,
2471 .Cm got integrate ,
2472 and
2473 .Cm got stage
2474 commands will refuse to run while a merge operation is in progress.
2475 Other commands which manipulate the work tree may be used for
2476 conflict resolution purposes.
2477 .Pp
2478 The options for
2479 .Cm got merge
2480 are as follows:
2481 .Bl -tag -width Ds
2482 .It Fl a
2483 Abort an interrupted merge operation.
2484 If this option is used, no other command-line arguments are allowed.
2485 .It Fl c
2486 Continue an interrupted merge operation.
2487 If this option is used, no other command-line arguments are allowed.
2488 .It Fl n
2489 Merge changes into the work tree as usual but do not create a merge
2490 commit immediately.
2491 The merge result can be adjusted as desired before a merge commit is
2492 created with
2493 .Cm got merge -c .
2494 Alternatively, the merge may be aborted with
2495 .Cm got merge -a .
2496 .El
2497 .Tg sg
2498 .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 ...
2499 .Dl Pq alias: Cm sg
2500 Stage local changes for inclusion in the next commit.
2501 If no
2502 .Ar path
2503 is specified, stage all changes in the work tree.
2504 Otherwise, stage changes at or within the specified paths.
2505 Paths may be staged if they are added, modified, or deleted according to
2506 .Cm got status .
2507 .Pp
2508 Show the status of each affected file, using the following status codes:
2509 .Bl -column YXZ description
2510 .It A Ta file addition has been staged
2511 .It M Ta file modification has been staged
2512 .It D Ta file deletion has been staged
2513 .El
2514 .Pp
2515 Staged file contents are saved in newly created blob objects in the repository.
2516 These blobs will be referred to by tree objects once staged changes have been
2517 committed.
2518 .Pp
2519 Staged changes affect the behaviour of
2520 .Cm got commit ,
2521 .Cm got status ,
2522 and
2523 .Cm got diff .
2524 While paths with staged changes exist, the
2525 .Cm got commit
2526 command will refuse to commit any paths which do not have staged changes.
2527 Local changes created on top of staged changes can only be committed if
2528 the path is staged again, or if the staged changes are committed first.
2529 The
2530 .Cm got status
2531 command will show both local changes and staged changes.
2532 The
2533 .Cm got diff
2534 command is able to display local changes relative to staged changes,
2535 and to display staged changes relative to the repository.
2536 The
2537 .Cm got revert
2538 command cannot revert staged changes but may be used to revert
2539 local changes created on top of staged changes.
2540 .Pp
2541 The options for
2542 .Cm got stage
2543 are as follows:
2544 .Bl -tag -width Ds
2545 .It Fl l
2546 Instead of staging new changes, list paths which are already staged,
2547 along with the IDs of staged blob objects and stage status codes.
2548 If paths were provided on the command line, show the staged paths
2549 among the specified paths.
2550 Otherwise, show all staged paths.
2551 .It Fl p
2552 Instead of staging the entire content of a changed file, interactively
2553 select or reject changes for staging based on
2554 .Dq y
2555 (stage change),
2556 .Dq n
2557 (reject change), and
2558 .Dq q
2559 (quit staging this file) responses.
2560 If a file is in modified status, individual patches derived from the
2561 modified file content can be staged.
2562 Files in added or deleted status may only be staged or rejected in
2563 their entirety.
2564 .It Fl F Ar response-script
2565 With the
2566 .Fl p
2567 option, read
2568 .Dq y ,
2569 .Dq n ,
2570 and
2571 .Dq q
2572 responses line-by-line from the specified
2573 .Ar response-script
2574 file instead of prompting interactively.
2575 .It Fl S
2576 Allow staging of symbolic links which point outside of the path space
2577 that is under version control.
2578 By default,
2579 .Cm got stage
2580 will reject such symbolic links due to safety concerns.
2581 As a precaution,
2582 .Nm
2583 may decide to represent such a symbolic link as a regular file which contains
2584 the link's target path, rather than creating an actual symbolic link which
2585 points outside of the work tree.
2586 Use of this option is discouraged because external mechanisms such as
2587 .Dq make obj
2588 are better suited for managing symbolic links to paths not under
2589 version control.
2590 .El
2591 .Pp
2592 .Cm got stage
2593 will refuse to run if certain preconditions are not met.
2594 If a file contains merge conflicts, these conflicts must be resolved first.
2595 If a file is found to be out of date relative to the head commit on the
2596 work tree's current branch, the file must be updated with
2597 .Cm got update
2598 before it can be staged (however, this does not prevent the file from
2599 becoming out-of-date at some point after having been staged).
2600 .Pp
2601 The
2602 .Cm got update ,
2603 .Cm got rebase ,
2604 and
2605 .Cm got histedit
2606 commands will refuse to run while staged changes exist.
2607 If staged changes cannot be committed because a staged path
2608 is out of date, the path must be unstaged with
2609 .Cm got unstage
2610 before it can be updated with
2611 .Cm got update ,
2612 and may then be staged again if necessary.
2613 .Tg ug
2614 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2615 .Dl Pq alias: Cm ug
2616 Merge staged changes back into the work tree and put affected paths
2617 back into non-staged status.
2618 If no
2619 .Ar path
2620 is specified, unstage all staged changes across the entire work tree.
2621 Otherwise, unstage changes at or within the specified paths.
2622 .Pp
2623 Show the status of each affected file, using the following status codes:
2624 .Bl -column YXZ description
2625 .It G Ta file was unstaged
2626 .It C Ta file was unstaged and conflicts occurred during merge
2627 .It ! Ta changes destined for a missing file were not merged
2628 .It D Ta file was staged as deleted and still is deleted
2629 .It d Ta file's deletion was prevented by local modifications
2630 .It \(a~ Ta changes destined for a non-regular file were not merged
2631 .El
2632 .Pp
2633 The options for
2634 .Cm got unstage
2635 are as follows:
2636 .Bl -tag -width Ds
2637 .It Fl p
2638 Instead of unstaging the entire content of a changed file, interactively
2639 select or reject changes for unstaging based on
2640 .Dq y
2641 (unstage change),
2642 .Dq n
2643 (keep change staged), and
2644 .Dq q
2645 (quit unstaging this file) responses.
2646 If a file is staged in modified status, individual patches derived from the
2647 staged file content can be unstaged.
2648 Files staged in added or deleted status may only be unstaged in their entirety.
2649 .It Fl F Ar response-script
2650 With the
2651 .Fl p
2652 option, read
2653 .Dq y ,
2654 .Dq n ,
2655 and
2656 .Dq q
2657 responses line-by-line from the specified
2658 .Ar response-script
2659 file instead of prompting interactively.
2660 .El
2661 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2662 Parse and print contents of objects to standard output in a line-based
2663 text format.
2664 Content of commit, tree, and tag objects is printed in a way similar
2665 to the actual content stored in such objects.
2666 Blob object contents are printed as they would appear in files on disk.
2667 .Pp
2668 Attempt to interpret each argument as a reference, a tag name, or
2669 an object ID SHA1 hash.
2670 References will be resolved to an object ID.
2671 Tag names will resolved to a tag object.
2672 An abbreviated hash argument will be expanded to a full SHA1 hash
2673 automatically, provided the abbreviation is unique.
2674 .Pp
2675 If none of the above interpretations produce a valid result, or if the
2676 .Fl P
2677 option is used, attempt to interpret the argument as a path which will
2678 be resolved to the ID of an object found at this path in the repository.
2679 .Pp
2680 The options for
2681 .Cm got cat
2682 are as follows:
2683 .Bl -tag -width Ds
2684 .It Fl c Ar commit
2685 Look up paths in the specified
2686 .Ar commit .
2687 If this option is not used, paths are looked up in the commit resolved
2688 via the repository's HEAD reference.
2689 The expected argument is a commit ID SHA1 hash or an existing reference
2690 or tag name which will be resolved to a commit ID.
2691 An abbreviated hash argument will be expanded to a full SHA1 hash
2692 automatically, provided the abbreviation is unique.
2693 .It Fl r Ar repository-path
2694 Use the repository at the specified path.
2695 If not specified, assume the repository is located at or above the current
2696 working directory.
2697 If this directory is a
2698 .Nm
2699 work tree, use the repository path associated with this work tree.
2700 .It Fl P
2701 Interpret all arguments as paths only.
2702 This option can be used to resolve ambiguity in cases where paths
2703 look like tag names, reference names, or object IDs.
2704 .El
2705 .It Cm info Op Ar path ...
2706 Display meta-data stored in a work tree.
2707 See
2708 .Xr got-worktree 5
2709 for details.
2710 .Pp
2711 The work tree to use is resolved implicitly by walking upwards from the
2712 current working directory.
2713 .Pp
2714 If one or more
2715 .Ar path
2716 arguments are specified, show additional per-file information for tracked
2717 files located at or within these paths.
2718 If a
2719 .Ar path
2720 argument corresponds to the work tree's root directory, display information
2721 for all tracked files.
2722 .El
2723 .Sh ENVIRONMENT
2724 .Bl -tag -width GOT_AUTHOR
2725 .It Ev GOT_AUTHOR
2726 The author's name and email address for
2727 .Cm got commit
2728 and
2729 .Cm got import ,
2730 for example:
2731 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2732 Because
2733 .Xr git 1
2734 may fail to parse commits without an email address in author data,
2735 .Nm
2736 attempts to reject
2737 .Ev GOT_AUTHOR
2738 environment variables with a missing email address.
2739 .Pp
2740 .Ev GOT_AUTHOR will be overridden by configuration settings in
2741 .Xr got.conf 5
2742 or by Git's
2743 .Dv user.name
2744 and
2745 .Dv user.email
2746 configuration settings in the repository's
2747 .Pa .git/config
2748 file.
2749 The
2750 .Dv user.name
2751 and
2752 .Dv user.email
2753 configuration settings contained in Git's global
2754 .Pa ~/.gitconfig
2755 configuration file will only be used if neither
2756 .Xr got.conf 5
2757 nor the
2758 .Ev GOT_AUTHOR
2759 environment variable provide author information.
2760 .It Ev VISUAL , EDITOR
2761 The editor spawned by
2762 .Cm got commit ,
2763 .Cm got histedit ,
2764 .Cm got import ,
2766 .Cm got tag .
2767 If not set, the
2768 .Xr ed 1
2769 text editor will be spawned in order to give
2770 .Xr ed 1
2771 the attention it deserves.
2772 .It Ev GOT_LOG_DEFAULT_LIMIT
2773 The default limit on the number of commits traversed by
2774 .Cm got log .
2775 If set to zero, the limit is unbounded.
2776 This variable will be silently ignored if it is set to a non-numeric value.
2777 .El
2778 .Sh FILES
2779 .Bl -tag -width packed-refs -compact
2780 .It Pa got.conf
2781 Repository-wide configuration settings for
2782 .Nm .
2783 If present, a
2784 .Xr got.conf 5
2785 configuration file located in the root directory of a Git repository
2786 supersedes any relevant settings in Git's
2787 .Pa config
2788 file.
2789 .Pp
2790 .It Pa .got/got.conf
2791 Worktree-specific configuration settings for
2792 .Nm .
2793 If present, a
2794 .Xr got.conf 5
2795 configuration file in the
2796 .Pa .got
2797 meta-data directory of a work tree supersedes any relevant settings in
2798 the repository's
2799 .Xr got.conf 5
2800 configuration file and Git's
2801 .Pa config
2802 file.
2803 .El
2804 .Sh EXIT STATUS
2805 .Ex -std got
2806 .Sh EXAMPLES
2807 Enable tab-completion of
2808 .Nm
2809 command names in
2810 .Xr ksh 1 :
2811 .Pp
2812 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2813 .Pp
2814 Clone an existing Git repository for use with
2815 .Nm .
2816 .Pp
2817 .Dl $ cd /var/git/
2818 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2819 .Pp
2820 Use of HTTP URLs currently requires
2821 .Xr git 1 :
2822 .Pp
2823 .Dl $ cd /var/git/
2824 .Dl $ git clone --bare https://github.com/openbsd/src.git
2825 .Pp
2826 Alternatively, for quick and dirty local testing of
2827 .Nm
2828 a new Git repository could be created and populated with files,
2829 e.g. from a temporary CVS checkout located at
2830 .Pa /tmp/src :
2831 .Pp
2832 .Dl $ gotadmin init /var/git/src.git
2833 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2834 .Pp
2835 Check out a work tree from the Git repository to /usr/src:
2836 .Pp
2837 .Dl $ got checkout /var/git/src.git /usr/src
2838 .Pp
2839 View local changes in a work tree directory:
2840 .Pp
2841 .Dl $ got diff | less
2842 .Pp
2843 In a work tree, display files in a potentially problematic state:
2844 .Pp
2845 .Dl $ got status -s 'C!~?'
2846 .Pp
2847 Interactively revert selected local changes in a work tree directory:
2848 .Pp
2849 .Dl $ got revert -p -R\ .
2850 .Pp
2851 In a work tree or a git repository directory, list all branch references:
2852 .Pp
2853 .Dl $ got branch -l
2854 .Pp
2855 In a work tree or a git repository directory, create a new branch called
2856 .Dq unified-buffer-cache
2857 which is forked off the
2858 .Dq master
2859 branch:
2860 .Pp
2861 .Dl $ got branch -c master unified-buffer-cache
2862 .Pp
2863 Switch an existing work tree to the branch
2864 .Dq unified-buffer-cache .
2865 Local changes in the work tree will be preserved and merged if necessary:
2866 .Pp
2867 .Dl $ got update -b unified-buffer-cache
2868 .Pp
2869 Create a new commit from local changes in a work tree directory.
2870 This new commit will become the head commit of the work tree's current branch:
2871 .Pp
2872 .Dl $ got commit
2873 .Pp
2874 In a work tree or a git repository directory, view changes committed in
2875 the 3 most recent commits to the work tree's branch, or the branch resolved
2876 via the repository's HEAD reference, respectively:
2877 .Pp
2878 .Dl $ got log -p -l 3
2879 .Pp
2880 As above, but display changes in the order in which
2881 .Xr patch 1
2882 could apply them in sequence:
2883 .Pp
2884 .Dl $ got log -p -l 3 -R
2885 .Pp
2886 In a work tree or a git repository directory, log the history of a subdirectory:
2887 .Pp
2888 .Dl $ got log sys/uvm
2889 .Pp
2890 While operating inside a work tree, paths are specified relative to the current
2891 working directory, so this command will log the subdirectory
2892 .Pa sys/uvm :
2893 .Pp
2894 .Dl $ cd sys/uvm && got log\ .
2895 .Pp
2896 And this command has the same effect:
2897 .Pp
2898 .Dl $ cd sys/dev/usb && got log ../../uvm
2899 .Pp
2900 And this command displays work tree meta-data about all tracked files:
2901 .Pp
2902 .Dl $ cd /usr/src
2903 .Dl $ got info\ . | less
2904 .Pp
2905 Add new files and remove obsolete files in a work tree directory:
2906 .Pp
2907 .Dl $ got add sys/uvm/uvm_ubc.c
2908 .Dl $ got remove sys/uvm/uvm_vnode.c
2909 .Pp
2910 Create a new commit from local changes in a work tree directory
2911 with a pre-defined log message.
2912 .Pp
2913 .Dl $ got commit -m 'unify the buffer cache'
2914 .Pp
2915 Alternatively, create a new commit from local changes in a work tree
2916 directory with a log message that has been prepared in the file
2917 .Pa /tmp/msg :
2918 .Pp
2919 .Dl $ got commit -F /tmp/msg
2920 .Pp
2921 Update any work tree checked out from the
2922 .Dq unified-buffer-cache
2923 branch to the latest commit on this branch:
2924 .Pp
2925 .Dl $ got update
2926 .Pp
2927 Roll file content on the unified-buffer-cache branch back by one commit,
2928 and then fetch the rolled-back change into the work tree as a local change
2929 to be amended and perhaps committed again:
2930 .Pp
2931 .Dl $ got backout unified-buffer-cache
2932 .Dl $ got commit -m 'roll back previous'
2933 .Dl $ # now back out the previous backout :-)
2934 .Dl $ got backout unified-buffer-cache
2935 .Pp
2936 Fetch new changes on the remote repository's
2937 .Dq master
2938 branch, making them visible on the local repository's
2939 .Dq origin/master
2940 branch:
2941 .Pp
2942 .Dl $ cd /usr/src
2943 .Dl $ got fetch
2944 .Pp
2945 In a repository created with a HTTP URL and
2946 .Cm git clone --bare
2947 the
2948 .Xr git-fetch 1
2949 command must be used instead:
2950 .Pp
2951 .Dl $ cd /var/git/src.git
2952 .Dl $ git fetch origin master:refs/remotes/origin/master
2953 .Pp
2954 Rebase the local
2955 .Dq master
2956 branch to merge the new changes that are now visible on the
2957 .Dq origin/master
2958 branch:
2959 .Pp
2960 .Dl $ cd /usr/src
2961 .Dl $ got update -b origin/master
2962 .Dl $ got rebase master
2963 .Pp
2964 Rebase the
2965 .Dq unified-buffer-cache
2966 branch on top of the new head commit of the
2967 .Dq master
2968 branch.
2969 .Pp
2970 .Dl $ got update -b master
2971 .Dl $ got rebase unified-buffer-cache
2972 .Pp
2973 Create a patch from all changes on the unified-buffer-cache branch.
2974 The patch can be mailed out for review and applied to
2975 .Ox Ns 's
2976 CVS tree:
2977 .Pp
2978 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2979 .Pp
2980 Edit the entire commit history of the
2981 .Dq unified-buffer-cache
2982 branch:
2983 .Pp
2984 .Dl $ got update -b unified-buffer-cache
2985 .Dl $ got update -c master
2986 .Dl $ got histedit
2987 .Pp
2988 Before working against existing branches in a repository cloned with
2989 .Cm git clone --bare
2990 instead of
2991 .Cm got clone ,
2992 a Git
2993 .Dq refspec
2994 must be configured to map all references in the remote repository
2995 into the
2996 .Dq refs/remotes
2997 namespace of the local repository.
2998 This can be achieved by setting Git's
2999 .Pa remote.origin.fetch
3000 configuration variable to the value
3001 .Dq +refs/heads/*:refs/remotes/origin/*
3002 with the
3003 .Cm git config
3004 command:
3005 .Pp
3006 .Dl $ cd /var/git/repo
3007 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
3008 .Pp
3009 Additionally, the
3010 .Dq mirror
3011 option must be disabled:
3012 .Pp
3013 .Dl $ cd /var/git/repo
3014 .Dl $ git config remote.origin.mirror false
3015 .Pp
3016 Alternatively, the following
3017 .Xr git-fetch 1
3018 configuration item can be added manually to the Git repository's
3019 .Pa config
3020 file:
3021 .Pp
3022 .Dl [remote \&"origin\&"]
3023 .Dl url = ...
3024 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3025 .Dl mirror = false
3026 .Pp
3027 This configuration leaves the local repository's
3028 .Dq refs/heads
3029 namespace free for use by local branches checked out with
3030 .Cm got checkout
3031 and, if needed, created with
3032 .Cm got branch .
3033 Branches in the
3034 .Dq refs/remotes/origin
3035 namespace can now be updated with incoming changes from the remote
3036 repository with
3037 .Cm got fetch
3039 .Xr git-fetch 1
3040 without extra command line arguments.
3041 Newly fetched changes can be examined with
3042 .Cm got log .
3043 .Pp
3044 Display changes on the remote repository's version of the
3045 .Dq master
3046 branch, as of the last time
3047 .Cm got fetch
3048 was run:
3049 .Pp
3050 .Dl $ got log -c origin/master | less
3051 .Pp
3052 As shown here, most commands accept abbreviated reference names such as
3053 .Dq origin/master
3054 instead of
3055 .Dq refs/remotes/origin/master .
3056 The latter is only needed in case of ambiguity.
3057 .Pp
3058 .Cm got rebase
3059 must be used to merge changes which are visible on the
3060 .Dq origin/master
3061 branch into the
3062 .Dq master
3063 branch.
3064 This will also merge local changes, if any, with the incoming changes:
3065 .Pp
3066 .Dl $ got update -b origin/master
3067 .Dl $ got rebase master
3068 .Pp
3069 In order to make changes committed to the
3070 .Dq unified-buffer-cache
3071 visible on the
3072 .Dq master
3073 branch, the
3074 .Dq unified-buffer-cache
3075 branch must first be rebased onto the
3076 .Dq master
3077 branch:
3078 .Pp
3079 .Dl $ got update -b master
3080 .Dl $ got rebase unified-buffer-cache
3081 .Pp
3082 Changes on the
3083 .Dq unified-buffer-cache
3084 branch can now be made visible on the
3085 .Dq master
3086 branch with
3087 .Cm got integrate .
3088 Because the rebase operation switched the work tree to the
3089 .Dq unified-buffer-cache
3090 branch, the work tree must be switched back to the
3091 .Dq master
3092 branch first:
3093 .Pp
3094 .Dl $ got update -b master
3095 .Dl $ got integrate unified-buffer-cache
3096 .Pp
3097 On the
3098 .Dq master
3099 branch, log messages for local changes can now be amended with
3100 .Dq OK
3101 by other developers and any other important new information:
3102 .Pp
3103 .Dl $ got update -c origin/master
3104 .Dl $ got histedit -m
3105 .Pp
3106 If the remote repository offers write access, local changes on the
3107 .Dq master
3108 branch can be sent to the remote repository with
3109 .Cm got send .
3110 Usually,
3111 .Cm got send
3112 can be run without further arguments.
3113 The arguments shown here match defaults, provided the work tree's
3114 current branch is the
3115 .Dq master
3116 branch:
3117 .Pp
3118 .Dl $ got send -b master origin
3119 .Pp
3120 If the remote repository requires the HTTPS protocol, the
3121 .Xr git-push 1
3122 command must be used instead:
3123 .Pp
3124 .Dl $ cd /var/git/src.git
3125 .Dl $ git push origin master
3126 .Pp
3127 When making contributions to projects which use the
3128 .Dq pull request
3129 workflow, SSH protocol repository access needs to be set up first.
3130 Once an account has been created on a Git hosting site it should
3131 be possible to upload a public SSH key for repository access
3132 authentication.
3133 .Pp
3134 The
3135 .Dq pull request
3136 workflow will usually involve two remote repositories.
3137 In the real-life example below, the
3138 .Dq origin
3139 repository was forked from the
3140 .Dq upstream
3141 repository by using the Git hosting site's web interface.
3142 The
3143 .Xr got.conf 5
3144 file in the local repository describes both remote repositories:
3145 .Bd -literal -offset indent
3146 # Jelmers's repository, which accepts pull requests
3147 remote "upstream" {
3148 server git@github.com
3149 protocol ssh
3150 repository "/jelmer/dulwich"
3151 branch { "master" }
3154 # Stefan's fork, used as the default remote repository
3155 remote "origin" {
3156 server git@github.com
3157 protocol ssh
3158 repository "/stspdotname/dulwich"
3159 branch { "master" }
3161 .Ed
3162 .Pp
3163 With this configuration, Stefan can create commits on
3164 .Dq refs/heads/master
3165 and send them to the
3166 .Dq origin
3167 repository by running:
3168 .Pp
3169 .Dl $ got send -b master origin
3170 .Pp
3171 The changes can now be proposed to Jelmer by opening a pull request
3172 via the Git hosting site's web interface.
3173 If Jelmer requests further changes to be made, additional commits
3174 can be created on the
3175 .Dq master
3176 branch and be added to the pull request by running
3177 .Cd got send
3178 again.
3179 .Pp
3180 If Jelmer prefers additional commits to be
3181 .Dq squashed
3182 then the following commands can be used to achieve this:
3183 .Pp
3184 .Dl $ got update -b master
3185 .Dl $ got update -c origin/master
3186 .Dl $ got histedit -f
3187 .Dl $ got send -f -b master origin
3188 .Pp
3189 Once Jelmer has accepted the pull request, Stefan can fetch the
3190 merged changes, and possibly several other new changes, by running:
3191 .Pp
3192 .Dl $ got fetch upstream
3193 .Pp
3194 The merged changes will now be visible under the reference
3195 .Dq refs/remotes/upstream/master .
3196 The local
3197 .Dq master
3198 branch can now be rebased on top of the latest changes
3199 from upstream:
3200 .Pp
3201 .Dl $ got update -b upstream/master
3202 .Dl $ got rebase master
3203 .Pp
3204 As a final step, the forked repository's copy of the master branch needs
3205 to be kept in sync by sending the new changes there:
3206 .Pp
3207 .Dl $ got send -f -b master origin
3208 .Pp
3209 If multiple pull requests need to be managed in parallel, a separate branch
3210 must be created for each pull request with
3211 .Cm got branch .
3212 Each such branch can then be used as above, in place of
3213 .Dq refs/heads/master .
3214 Changes for any accepted pull requests will still appear under
3215 .Dq refs/remotes/upstream/master,
3216 regardless of which branch was used in the forked repository to
3217 create a pull request.
3218 .Sh SEE ALSO
3219 .Xr gotadmin 1 ,
3220 .Xr tog 1 ,
3221 .Xr git-repository 5 ,
3222 .Xr got-worktree 5 ,
3223 .Xr got.conf 5 ,
3224 .Xr gotweb 8
3225 .Sh AUTHORS
3226 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3227 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3228 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3229 .An Josh Rickmar Aq Mt jrick@zettaport.com
3230 .An Joshua Stein Aq Mt jcs@openbsd.org
3231 .An Klemens Nanni Aq Mt kn@openbsd.org
3232 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3233 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3234 .An Omar Polo Aq Mt op@openbsd.org
3235 .An Ori Bernstein Aq Mt ori@openbsd.org
3236 .An Sebastien Marie Aq Mt semarie@openbsd.org
3237 .An Stefan Sperling Aq Mt stsp@openbsd.org
3238 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3239 .An Theo Buehler Aq Mt tb@openbsd.org
3240 .An Thomas Adam Aq Mt thomas@xteddy.org
3241 .An Tracey Emery Aq Mt tracey@traceyemery.net
3242 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3243 .Pp
3244 Parts of
3245 .Nm ,
3246 .Xr tog 1 ,
3247 and
3248 .Xr gotweb 8
3249 were derived from code under copyright by:
3250 .Pp
3251 .An Caldera International Inc.
3252 .An Daniel Hartmeier
3253 .An Esben Norby
3254 .An Henning Brauer
3255 .An Håkan Olsson
3256 .An Ingo Schwarze
3257 .An Jean-Francois Brousseau
3258 .An Joris Vink
3259 .An Jyri J. Virkki
3260 .An Larry Wall
3261 .An Markus Friedl
3262 .An Niall O'Higgins
3263 .An Niklas Hallqvist
3264 .An Ray Lai
3265 .An Ryan McBride
3266 .An Theo de Raadt
3267 .An Todd C. Miller
3268 .An Xavier Santolaria
3269 .Pp
3270 .Nm
3271 contains code contributed to the public domain by
3272 .An Austin Appleby
3273 .Sh CAVEATS
3274 .Nm
3275 is a work-in-progress and some features remain to be implemented.
3276 .Pp
3277 At present, the user has to fall back on
3278 .Xr git 1
3279 to perform some tasks.
3280 In particular:
3281 .Bl -bullet
3282 .It
3283 Reading from remote repositories over HTTP or HTTPS protocols requires
3284 .Xr git-clone 1
3285 and
3286 .Xr git-fetch 1 .
3287 .It
3288 Writing to remote repositories over HTTP or HTTPS protocols requires
3289 .Xr git-push 1 .
3290 .It
3291 The creation of merge commits with more than two parent commits requires
3292 .Xr git-merge 1 .
3293 .It
3294 In situations where files or directories were moved around
3295 .Cm got
3296 will not automatically merge changes to new locations and
3297 .Xr git 1
3298 will usually produce better results.
3299 .El