2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
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.
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.
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 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
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
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
77 .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
79 Create an initial commit in a repository from the file hierarchy
82 The created commit will not have any parent commits, i.e. it will be a
84 Also create a new reference which provides a branch name for the newly
86 Show the path of each imported file to indicate progress.
92 environment variable to be set,
93 unless an author has been configured in
99 configuration settings can be obtained from the repository's
101 file or from Git's global
112 instead of creating the default branch
114 Use of this option is required if the
116 branch already exists.
118 Use the specified log message when creating the new commit.
123 opens a temporary file in an editor where a log message can be written.
124 .It Fl r Ar repository-path
125 Use the repository at the specified path.
126 If not specified, assume the repository is located at or above the current
129 Ignore files or directories with a name which matches the specified
131 This option may be specified multiple times to build a list of ignore patterns.
134 follows the globbing rules documented in
138 .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
140 Clone a Git repository at the specified
146 is specified the directory name will be derived from the name of the
149 will refuse to run if the
155 specifies a protocol scheme, a server hostname, an optional port number
156 separated from the hostname by a colon, and a path to the repository on
158 .Lk scheme://hostname:port/path/to/repository
160 The following protocol schemes are supported:
161 .Bl -tag -width git+ssh
163 The Git protocol as implemented by the
166 Use of this protocol is discouraged since it supports neither authentication
169 The Git protocol wrapped in an authenticated and encrypted
172 With this protocol the hostname may contain an embedded username for
177 Short alias for git+ssh.
180 Objects in the cloned repository are stored in a pack file which is downloaded
182 This pack file will then be indexed to facilitate access to the objects stored
184 If any objects in the pack file are stored in deltified form, all deltas will
185 be fully resolved in order to compute the ID of such objects.
186 This can take some time.
187 More details about the pack file format are documented in
188 .Xr git-repository 5 .
191 creates a remote repository entry in the
195 files of the cloned repository to store the
201 arguments for future use by
211 Fetch all branches from the remote repository's
213 reference namespace and set
214 .Cm fetch-all-branches
215 in the cloned repository's
217 file for future use by
219 If this option is not specified, a branch resolved via the remote
220 repository's HEAD reference will be fetched.
221 Cannot be used together with the
227 from the remote repository's
230 This option may be specified multiple times to build a list of branches
232 If the branch corresponding to the remote repository's HEAD reference is not
233 in this list, the cloned repository's HEAD reference will be set to the first
234 branch which was fetched.
235 If this option is not specified, a branch resolved via the remote
236 repository's HEAD reference will be fetched.
237 Cannot be used together with the
241 List branches and tags available for fetching from the remote repository
242 and exit immediately.
243 Cannot be used together with any of the other options except
248 Create the cloned repository as a mirror of the original repository.
249 This is useful if the cloned repository will not be used to store
250 locally created commits.
256 files will be set up with the
258 option enabled, such that
262 will write incoming changes directly to branches in the
264 reference namespace, rather than to branches in the
267 This avoids the usual requirement of having to run
271 in order to make incoming changes appear on branches in the
274 But maintaining custom changes in the cloned repository becomes difficult
275 since such changes will be at risk of being discarded whenever incoming
278 Suppress progress reporting output.
279 The same option will be passed to
286 to print debugging messages to standard error output.
287 This option will be passed to
290 Multiple -v options increase the verbosity.
292 .It Fl R Ar reference
293 In addition to the branches and tags that will be fetched, fetch an arbitrary
295 from the remote repository's
298 This option may be specified multiple times to build a list of additional
302 may either be a path to a specific reference, or a reference namespace
303 which will cause all references in this namespace to be fetched.
305 Each reference will be mapped into the cloned repository's
307 namespace, unless the
309 option is used to mirror references directly into the cloned repository's
314 will refuse to fetch references from the remote repository's
321 .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
323 Fetch new changes from a remote repository.
325 .Ar remote-repository
329 The remote repository's URL is obtained from the corresponding entry in
333 file of the local repository, as created by
336 New changes will be stored in a separate pack file downloaded from the server.
337 Optionally, separate pack files stored in the repository can be combined with
340 By default, branch references in the
342 reference namespace will be updated to point at the newly fetched commits.
345 command can then be used to make new changes visible on branches in the
347 namespace, merging incoming changes with the changes on those branches
350 If the repository was created as a mirror with
352 then all branches in the
354 namespace will be updated directly to match the corresponding branches in
355 the remote repository.
356 If those branches contained local commits, these commits will no longer be
357 reachable via a reference and will therefore be at risk of being discarded
358 by Git's garbage collector or
359 .Cm gotadmin cleanup .
360 Maintaining custom changes in a mirror repository is therefore discouraged.
362 In any case, references in the
364 namespace will always be fetched and mapped directly to local references
365 in the same namespace.
372 Fetch all branches from the remote repository's
375 This option can be enabled by default for specific repositories in
377 If this option is not specified, a branch resolved via the remote
378 repository's HEAD reference will be fetched.
379 Cannot be used together with the
385 from the remote repository's
388 This option may be specified multiple times to build a list of branches
390 If this option is not specified, a branch resolved via the remote
391 repository's HEAD reference will be fetched.
392 Cannot be used together with the
396 Delete branches and tags from the local repository which are no longer
397 present in the remote repository.
398 Only references are deleted.
399 Any commit, tree, tag, and blob objects belonging to deleted branches or
400 tags remain in the repository and may be removed separately with
401 Git's garbage collector or
402 .Cm gotadmin cleanup .
404 List branches and tags available for fetching from the remote repository
405 and exit immediately.
406 Cannot be used together with any of the other options except
412 Allow existing references in the
414 namespace to be updated if they have changed on the server.
415 If not specified, only new tag references will be created.
416 .It Fl r Ar repository-path
417 Use the repository at the specified path.
418 If not specified, assume the repository is located at or above the current
420 If this directory is a
422 work tree, use the repository path associated with this work tree.
424 Suppress progress reporting output.
425 The same option will be passed to
432 to print debugging messages to standard error output.
433 The same option will be passed to
436 Multiple -v options increase the verbosity.
438 .It Fl R Ar reference
439 In addition to the branches and tags that will be fetched, fetch an arbitrary
441 from the remote repository's
444 This option may be specified multiple times to build a list of additional
448 may either be a path to a specific reference, or a reference namespace
449 which will cause all references in this namespace to be fetched.
451 Each reference will be mapped into the local repository's
453 namespace, unless the local repository was created as a mirror with
455 in which case references will be mapped directly into the local repository's
459 Once a reference has been fetched, a branch based on it can be created with
464 will refuse to fetch references from the remote repository's
470 Delete all references which correspond to a particular
471 .Ar remote-repository
472 instead of fetching new changes.
473 This can be useful when a remote repository is being removed from
479 .Ar remote-repository
480 argument is mandatory and no other options except
487 Only references are deleted.
488 Any commit, tree, tag, and blob objects fetched from a remote repository
489 will generally be stored in pack files and may be removed separately with
491 and Git's garbage collector.
494 .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
496 Copy files from a repository into a new work tree.
497 Show the status of each affected file, using the following status codes:
498 .Bl -column YXZ description
499 .It A Ta new file was added
500 .It E Ta file already exists in work tree's meta-data
505 is not specified, either use the last component of
506 .Ar repository path ,
509 was specified use the last component of
517 Proceed with the checkout operation even if the directory at
520 Existing files will be left intact.
522 Check out files from a commit on the specified
524 If this option is not specified, a branch resolved via the repository's HEAD
525 reference will be used.
527 Check out files from the specified
529 on the selected branch.
530 The expected argument is a commit ID SHA1 hash or an existing reference
531 or tag name which will be resolved to a commit ID.
532 An abbreviated hash argument will be expanded to a full SHA1 hash
533 automatically, provided the abbreviation is unique.
534 If this option is not specified, the most recent commit on the selected
539 is not contained in the selected branch, a different branch which contains
540 this commit must be specified with the
543 If no such branch is known a new branch must be created for this
549 Checking out work trees with an unknown branch is intentionally not supported.
550 .It Fl p Ar path-prefix
551 Restrict the work tree to a subset of the repository's tree hierarchy.
552 Only files beneath the specified
556 Silence progress output.
559 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl q Oc Op Ar path ...
561 Update an existing work tree to a different
563 Change existing files in the work tree as necessary to match file contents
565 Preserve any local changes in the work tree and merge them with the
568 Files which already contain merge conflicts will not be updated to avoid
569 further complications.
570 Such files will be updated when
572 is run again after merge conflicts have been resolved.
573 If the conflicting changes are no longer needed affected files can be
580 Show the status of each affected file, using the following status codes:
581 .Bl -column YXZ description
582 .It U Ta file was updated and contained no local changes
583 .It G Ta file was updated and local changes were merged cleanly
584 .It C Ta file was updated and conflicts occurred during merge
585 .It D Ta file was deleted
586 .It A Ta new file was added
587 .It \(a~ Ta versioned file is obstructed by a non-regular file
588 .It ! Ta a missing versioned file was restored
589 .It # Ta file was not updated because it contains merge conflicts
590 .It ? Ta changes destined for an unversioned file were not merged
595 is specified, update the entire work tree.
596 Otherwise, restrict the update operation to files at or within the
598 Each path is required to exist in the update operation's target commit.
599 Files in the work tree outside specified paths will remain unchanged and
600 will retain their previously recorded base commit.
603 commands may refuse to run while the work tree contains files from
604 multiple base commits.
605 The base commit of such a work tree can be made consistent by running
607 across the entire work tree.
610 is incompatible with the
615 cannot update paths with staged changes.
616 If changes have been staged with
618 these changes must first be committed with
628 Switch the work tree's branch reference to the specified
630 before updating the work tree.
631 This option requires that all paths in the work tree are updated.
633 As usual, any local changes in the work tree will be preserved.
634 This can be useful when switching to a newly created branch in order
635 to commit existing local changes to this branch.
637 Any local changes must be dealt with separately in order to obtain a
638 work tree with pristine file contents corresponding exactly to the specified
640 Such changes could first be committed to a different branch with
642 or could be discarded with
645 Update the work tree to the specified
647 The expected argument is a commit ID SHA1 hash or an existing reference
648 or tag name which will be resolved to a commit ID.
649 An abbreviated hash argument will be expanded to a full SHA1 hash
650 automatically, provided the abbreviation is unique.
651 If this option is not specified, the most recent commit on the work tree's
654 Silence progress output.
657 .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Oo Fl S Ar status-codes Oc Op Ar path ...
659 Show the current modification status of files in a work tree,
660 using the following status codes:
661 .Bl -column YXZ description
662 .It M Ta modified file
663 .It A Ta file scheduled for addition in next commit
664 .It D Ta file scheduled for deletion in next commit
665 .It C Ta modified or added file which contains merge conflicts
666 .It ! Ta versioned file was expected on disk but is missing
667 .It \(a~ Ta versioned file is obstructed by a non-regular file
668 .It ? Ta unversioned item not tracked by
670 .It m Ta modified file modes (executable bit only)
671 .It N Ta non-existent
673 specified on the command line
678 is specified, show modifications in the entire work tree.
679 Otherwise, show modifications at or within the specified paths.
681 If changes have been staged with
683 staged changes are shown in the second output column, using the following
685 .Bl -column YXZ description
686 .It M Ta file modification is staged
687 .It A Ta file addition is staged
688 .It D Ta file deletion is staged
691 Changes created on top of staged changes are indicated in the first column:
692 .Bl -column YXZ description
693 .It MM Ta file was modified after earlier changes have been staged
694 .It MA Ta file was modified after having been staged for addition
702 Show unversioned files even if they match an ignore pattern.
703 .It Fl s Ar status-codes
704 Only show files with a modification status matching any of the
705 single-character status codes contained in the
708 Any combination of codes from the above list of possible status codes
710 For staged files, status codes displayed in either column will be matched.
711 Cannot be used together with the
714 .It Fl S Ar status-codes
715 Suppress the output of files with a modification status matching any of the
716 single-character status codes contained in the
719 Any combination of codes from the above list of possible status codes
721 For staged files, status codes displayed in either column will be matched.
722 Cannot be used together with the
727 For compatibility with
738 files in each traversed directory and will not display unversioned files
739 which match these patterns.
744 supports consecutive asterisks,
746 which will match an arbitrary amount of directories.
750 only supports a single ignore pattern per line.
754 does not support negated ignore patterns prefixed with
756 and gives no special significance to the location of path component separators,
759 .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 Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
760 Display history of a repository.
763 is specified, show only commits which modified this path.
764 If invoked in a work tree, the
766 is interpreted relative to the current working directory,
767 and the work tree's path prefix is implicitly prepended.
768 Otherwise, the path is interpreted relative to the repository root.
775 Display individual commits which were merged into the current branch
779 shows the linear history of the current branch only.
781 Start traversing history at the specified
783 The expected argument is a commit ID SHA1 hash or an existing reference
784 or tag name which will be resolved to a commit ID.
785 An abbreviated hash argument will be expanded to a full SHA1 hash
786 automatically, provided the abbreviation is unique.
787 If this option is not specified, default to the work tree's current branch
788 if invoked in a work tree, or to the repository's HEAD reference.
790 Set the number of context lines shown in diffs with
792 By default, 3 lines of context are shown.
794 Limit history traversal to a given number of commits.
795 If this option is not specified, a default limit value of zero is used,
796 which is treated as an unbounded limit.
798 .Ev GOT_LOG_DEFAULT_LIMIT
799 environment variable may be set to change this default value.
801 Display the patch of modifications made in each commit.
804 is specified, only show the patch of modifications at or within this path.
806 Display the list of file paths changed in each commit, using the following
808 .Bl -column YXZ description
809 .It M Ta modified file
810 .It D Ta file was deleted
811 .It A Ta new file was added
812 .It m Ta modified file modes (executable bit only)
814 .It Fl s Ar search-pattern
815 If specified, show only commits with a log message matched by the extended
818 When used together with
820 then the file paths changed by a commit can be matched as well.
821 Regular expression syntax is documented in
823 .It Fl r Ar repository-path
824 Use the repository at the specified path.
825 If not specified, assume the repository is located at or above the current
827 If this directory is a
829 work tree, use the repository path associated with this work tree.
831 Determine a set of commits to display as usual, but display these commits
834 Stop traversing commit history immediately after the specified
837 This option has no effect if the specified
842 .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 ...
844 When invoked within a work tree without any arguments, display all
845 local changes in the work tree.
848 arguments are specified, only show changes within the specified paths.
850 If two arguments are provided, treat each argument as a reference, a tag
851 name, or an object ID SHA1 hash, and display differences between the
852 corresponding objects.
853 Both objects must be of the same type (blobs, trees, or commits).
854 An abbreviated hash argument will be expanded to a full SHA1 hash
855 automatically, provided the abbreviation is unique.
856 If none of these interpretations produce a valid result or if the
861 is running in a work tree, attempt to interpret the two arguments as paths.
868 Treat file contents as ASCII text even if binary data is detected.
870 Show differences between commits in the repository.
871 This options may be used up to two times.
872 When used only once, show differences between the specified
874 and its first parent commit.
875 When used twice, show differences between the two specified commits.
877 The expected argument is a commit ID SHA1 hash or an existing reference
878 or tag name which will be resolved to a commit ID.
879 An abbreviated hash argument will be expanded to a full SHA1 hash
880 automatically, provided the abbreviation is unique.
884 option is used, all non-option arguments will be interpreted as paths.
887 arguments are provided, only show differences for the specified paths.
889 Cannot be used together with the
894 Set the number of context lines shown in the diff.
895 By default, 3 lines of context are shown.
896 .It Fl r Ar repository-path
897 Use the repository at the specified path.
898 If not specified, assume the repository is located at or above the current
900 If this directory is a
902 work tree, use the repository path associated with this work tree.
904 Show changes staged with
906 instead of showing local changes in the work tree.
907 This option is only valid when
909 is invoked in a work tree.
911 Interpret all arguments as paths only.
912 This option can be used to resolve ambiguity in cases where paths
913 look like tag names, reference names, or object IDs.
914 This option is only valid when
916 is invoked in a work tree.
918 Ignore whitespace-only changes.
921 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
923 Display line-by-line history of a file at the specified path.
930 Start traversing history at the specified
932 The expected argument is a commit ID SHA1 hash or an existing reference
933 or tag name which will be resolved to a commit ID.
934 An abbreviated hash argument will be expanded to a full SHA1 hash
935 automatically, provided the abbreviation is unique.
936 .It Fl r Ar repository-path
937 Use the repository at the specified path.
938 If not specified, assume the repository is located at or above the current
940 If this directory is a
942 work tree, use the repository path associated with this work tree.
945 .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
947 Display a listing of files and directories at the specified
948 directory path in the repository.
949 Entries shown in this listing may carry one of the following trailing
951 .Bl -column YXZ description
952 .It @ Ta entry is a symbolic link
953 .It / Ta entry is a directory
954 .It * Ta entry is an executable file
955 .It $ Ta entry is a Git submodule
958 Symbolic link entries are also annotated with the target path of the link.
962 is specified, list the repository path corresponding to the current
963 directory of the work tree, or the root directory of the repository
964 if there is no work tree.
971 List files and directories as they appear in the specified
973 The expected argument is a commit ID SHA1 hash or an existing reference
974 or tag name which will be resolved to a commit ID.
975 An abbreviated hash argument will be expanded to a full SHA1 hash
976 automatically, provided the abbreviation is unique.
977 .It Fl r Ar repository-path
978 Use the repository at the specified path.
979 If not specified, assume the repository is located at or above the current
981 If this directory is a
983 work tree, use the repository path associated with this work tree.
985 Show object IDs of files (blob objects) and directories (tree objects).
987 Recurse into sub-directories in the repository.
989 .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
990 Manage references in a repository.
992 References may be listed, created, deleted, and changed.
993 When creating, deleting, or changing a reference the specified
995 must be an absolute reference name, i.e. it must begin with
1002 .It Fl r Ar repository-path
1003 Use the repository at the specified path.
1004 If not specified, assume the repository is located at or above the current
1006 If this directory is a
1008 work tree, use the repository path associated with this work tree.
1010 List references in the repository.
1013 is specified, list all existing references in the repository.
1016 is a reference namespace, list all references in this namespace.
1017 Otherwise, show only the reference with the given
1019 Cannot be used together with any other options except
1024 Sort listed references by modification time (most recently modified first)
1025 instead of sorting by lexicographical order.
1026 Use of this option requires the
1028 option to be used as well.
1030 Create a reference or change an existing reference.
1031 The reference with the specified
1033 will point at the specified
1037 argument is a ID SHA1 hash or an existing reference or tag name which will
1038 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1039 Cannot be used together with any other options except
1041 .It Fl s Ar reference
1042 Create a symbolic reference, or change an existing symbolic reference.
1043 The symbolic reference with the specified
1045 will point at the specified
1047 which must already exist in the repository.
1048 Care should be taken not to create loops between references when
1049 this option is used.
1050 Cannot be used together with any other options except
1053 Delete the reference with the specified
1055 from the repository.
1056 Any commit, tree, tag, and blob objects belonging to deleted references
1057 remain in the repository and may be removed separately with
1058 Git's garbage collector or
1059 .Cm gotadmin cleanup .
1060 Cannot be used together with any other options except
1064 .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
1066 Create, list, or delete branches.
1068 Local branches are managed via references which live in the
1070 reference namespace.
1073 command creates references in this namespace only.
1075 When deleting branches the specified
1079 reference namespace first.
1080 If no corresponding branch is found the
1082 namespace will be searched next.
1084 If invoked in a work tree without any arguments, print the name of the
1085 work tree's current branch.
1089 argument is passed, attempt to create a branch reference with the given name.
1090 By default the new branch reference will point at the latest commit on the
1091 work tree's current branch if invoked in a work tree, and otherwise to a commit
1092 resolved via the repository's HEAD reference.
1094 If invoked in a work tree, once the branch was created successfully
1095 switch the work tree's head reference to the newly created branch and
1096 update files across the entire work tree, just like
1097 .Cm got update -b Ar name
1099 Show the status of each affected file, using the following status codes:
1100 .Bl -column YXZ description
1101 .It U Ta file was updated and contained no local changes
1102 .It G Ta file was updated and local changes were merged cleanly
1103 .It C Ta file was updated and conflicts occurred during merge
1104 .It D Ta file was deleted
1105 .It A Ta new file was added
1106 .It \(a~ Ta versioned file is obstructed by a non-regular file
1107 .It ! Ta a missing versioned file was restored
1115 Make a newly created branch reference point at the specified
1119 argument is a commit ID SHA1 hash or an existing reference
1120 or tag name which will be resolved to a commit ID.
1121 .It Fl r Ar repository-path
1122 Use the repository at the specified path.
1123 If not specified, assume the repository is located at or above the current
1125 If this directory is a
1127 work tree, use the repository path associated with this work tree.
1129 List all existing branches in the repository, including copies of remote
1130 repositories' branches in the
1132 reference namespace.
1134 If invoked in a work tree, the work tree's current branch is shown
1135 with one the following annotations:
1136 .Bl -column YXZ description
1137 .It * Ta work tree's base commit matches the branch tip
1138 .It \(a~ Ta work tree's base commit is out-of-date
1141 Sort listed branches by modification time (most recently modified first)
1142 instead of sorting by lexicographical order.
1145 reference namespace are listed before branches in
1148 Use of this option requires the
1150 option to be used as well.
1152 Delete the branch with the specified
1158 reference namespace.
1160 Only the branch reference is deleted.
1161 Any commit, tree, and blob objects belonging to the branch
1162 remain in the repository and may be removed separately with
1163 Git's garbage collector or
1164 .Cm gotadmin cleanup .
1166 Do not switch and update the work tree after creating a new branch.
1168 .It Cm tag Oo Fl c Ar commit Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name
1169 Manage tags in a repository.
1171 Tags are managed via references which live in the
1173 reference namespace.
1176 command operates on references in this namespace only.
1177 References in this namespace point at tag objects which contain a pointer
1178 to another object, a tag message, as well as author and timestamp information.
1180 Attempt to create a tag with the given
1182 and make this tag point at the given
1184 If no commit is specified, default to the latest commit on the work tree's
1185 current branch if invoked in a work tree, and to a commit resolved via
1186 the repository's HEAD reference otherwise.
1193 Make the newly created tag reference point at the specified
1197 argument is a commit ID SHA1 hash or an existing reference or tag name which
1198 will be resolved to a commit ID.
1199 An abbreviated hash argument will be expanded to a full SHA1 hash
1200 automatically, provided the abbreviation is unique.
1202 Use the specified tag message when creating the new tag.
1207 opens a temporary file in an editor where a tag message can be written.
1208 .It Fl r Ar repository-path
1209 Use the repository at the specified path.
1210 If not specified, assume the repository is located at or above the current
1212 If this directory is a
1214 work tree, use the repository path associated with this work tree.
1216 List all existing tags in the repository instead of creating a new tag.
1217 If this option is used, no other command-line arguments are allowed.
1222 command will not delete tags or change existing tags.
1223 If a tag must be deleted, the
1225 command may be used to delete a tag's reference.
1226 This should only be done if the tag has not already been copied to
1228 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1229 Schedule unversioned files in a work tree for addition to the
1230 repository in the next commit.
1231 By default, files which match a
1233 ignore pattern will not be added.
1240 Permit recursion into directories.
1241 If this option is not specified,
1243 will refuse to run if a specified
1247 Add files even if they match a
1252 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1254 Remove versioned files from a work tree and schedule them for deletion
1255 from the repository in the next commit.
1262 Perform the operation even if a file contains local modifications,
1263 and do not raise an error if a specified
1265 does not exist on disk.
1267 Keep affected files on disk.
1269 Permit recursion into directories.
1270 If this option is not specified,
1272 will refuse to run if a specified
1275 .It Fl s Ar status-codes
1276 Only delete files with a modification status matching one of the
1277 single-character status codes contained in the
1280 The following status codes may be specified:
1281 .Bl -column YXZ description
1282 .It M Ta modified file (this implies the
1285 .It ! Ta versioned file expected on disk but missing
1289 .It Cm patch Op Ar patchfile
1293 .Pq or standard input
1294 and record the state of the affected files afterwards.
1297 must be an unified diff.
1300 contains more than one patch,
1303 will try to apply them all.
1305 Show the status of each affected file, using the following status codes:
1306 .Bl -column XYZ description
1307 .It M Ta modified file
1308 .It D Ta deleted file
1312 If a change does not match at its exact line number,
1315 applies it somewhere else in the file if it can find a good spot before
1318 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1320 Revert any local changes in files at the specified paths in a work tree.
1321 File contents will be overwritten with those contained in the
1322 work tree's base commit.
1323 There is no way to bring discarded changes back after
1326 If a file was added with
1328 it will become an unversioned file again.
1329 If a file was deleted with
1331 it will be restored.
1338 Instead of reverting all changes in files, interactively select or reject
1339 changes to revert based on
1345 (quit reverting this file) responses.
1346 If a file is in modified status, individual patches derived from the
1347 modified file content can be reverted.
1348 Files in added or deleted status may only be reverted in their entirety.
1349 .It Fl F Ar response-script
1357 responses line-by-line from the specified
1359 file instead of prompting interactively.
1361 Permit recursion into directories.
1362 If this option is not specified,
1364 will refuse to run if a specified
1369 .It Cm commit Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
1371 Create a new commit in the repository from changes in a work tree
1372 and use this commit as the new base commit for the work tree.
1375 is specified, commit all changes in the work tree.
1376 Otherwise, commit changes at or within the specified paths.
1378 If changes have been explicitly staged for commit with
1380 only commit staged changes and reject any specified paths which
1381 have not been staged.
1384 opens a temporary file in an editor where a log message can be written
1392 options are used together.
1394 Show the status of each affected file, using the following status codes:
1395 .Bl -column YXZ description
1396 .It M Ta modified file
1397 .It D Ta file was deleted
1398 .It A Ta new file was added
1399 .It m Ta modified file modes (executable bit only)
1402 Files which are not part of the new commit will retain their previously
1403 recorded base commit.
1406 commands may refuse to run while the work tree contains files from
1407 multiple base commits.
1408 The base commit of such a work tree can be made consistent by running
1410 across the entire work tree.
1414 command requires the
1416 environment variable to be set,
1417 unless an author has been configured in
1423 configuration settings can be
1424 obtained from the repository's
1426 file or from Git's global
1435 Use the prepared log message stored in the file found at
1437 when creating the new commit.
1439 opens a temporary file in an editor where the prepared log message can be
1440 reviewed and edited further if needed.
1441 Cannot be used together with the
1445 Use the specified log message when creating the new commit.
1446 Cannot be used together with the
1450 This option prevents
1452 from opening the commit message in an editor.
1453 It has no effect unless it is used together with the
1455 option and is intended for non-interactive use such as scripting.
1457 Allow the addition of symbolic links which point outside of the path space
1458 that is under version control.
1461 will reject such symbolic links due to safety concerns.
1464 may decide to represent such a symbolic link as a regular file which contains
1465 the link's target path, rather than creating an actual symbolic link which
1466 points outside of the work tree.
1467 Use of this option is discouraged because external mechanisms such as
1469 are better suited for managing symbolic links to paths not under
1474 will refuse to run if certain preconditions are not met.
1475 If the work tree's current branch is not in the
1477 reference namespace, new commits may not be created on this branch.
1478 Local changes may only be committed if they are based on file content
1479 found in the most recent commit on the work tree's branch.
1480 If a path is found to be out of date,
1482 must be used first in order to merge local changes with changes made
1485 .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
1487 Send new changes to a remote repository.
1489 .Ar remote-repository
1493 The remote repository's URL is obtained from the corresponding entry in
1497 file of the local repository, as created by
1500 All objects corresponding to new changes will be written to a temporary
1501 pack file which is then uploaded to the server.
1502 Upon success, references in the
1504 reference namespace of the local repository will be updated to point at
1505 the commits which have been sent.
1507 By default, changes will only be sent if they are based on up-to-date
1508 copies of relevant branches in the remote repository.
1509 If any changes to be sent are based on out-of-date copies or would
1510 otherwise break linear history of existing branches, new changes must
1511 be fetched from the server with
1513 and local branches must be rebased with
1520 option can be used to make exceptions to these requirements.
1527 Send all branches from the local repository's
1529 reference namespace.
1532 option is equivalent to listing all branches with multiple
1535 Cannot be used together with the
1541 from the local repository's
1543 reference namespace.
1544 This option may be specified multiple times to build a list of branches
1546 If this option is not specified, default to the work tree's current branch
1547 if invoked in a work tree, or to the repository's HEAD reference.
1548 Cannot be used together with the
1552 Delete the specified
1554 from the remote repository's
1556 reference namespace.
1557 This option may be specified multiple times to build a list of branches
1560 Only references are deleted.
1561 Any commit, tree, tag, and blob objects belonging to deleted branches
1562 may become subject to deletion by Git's garbage collector running on
1565 Requesting deletion of branches results in an error if the server
1566 does not support this feature or disallows the deletion of branches
1567 based on its configuration.
1569 Attempt to force the server to overwrite existing branches or tags
1570 in the remote repository, even when
1574 would usually be required before changes can be sent.
1575 The server may reject forced requests regardless, depending on its
1578 Any commit, tree, tag, and blob objects belonging to overwritten branches
1579 or tags may become subject to deletion by Git's garbage collector running
1584 reference namespace is globally shared between all repositories.
1587 option to overwrite tags is discouraged because it can lead to
1588 inconsistencies between the tags present in different repositories.
1589 In general, creating a new tag with a different name is recommended
1590 instead of overwriting an existing tag.
1594 option is particularly discouraged if changes being sent are based
1595 on an out-of-date copy of a branch in the remote repository.
1596 Instead of using the
1598 option, new changes should
1601 and local branches should be rebased with
1603 followed by another attempt to send the changes.
1607 option should only be needed in situations where the remote repository's
1608 copy of a branch or tag is known to be out-of-date and is considered
1610 The risks of creating inconsistencies between different repositories
1611 should also be taken into account.
1612 .It Fl r Ar repository-path
1613 Use the repository at the specified path.
1614 If not specified, assume the repository is located at or above the current
1616 If this directory is a
1618 work tree, use the repository path associated with this work tree.
1622 from the local repository's
1624 reference namespace, in addition to any branches that are being sent.
1627 option may be specified multiple times to build a list of tags to send.
1628 No tags will be sent if the
1632 Raise an error if the specified
1634 already exists in the remote repository, unless the
1636 option is used to overwrite the server's copy of the tag.
1637 In general, creating a new tag with a different name is recommended
1638 instead of overwriting an existing tag.
1640 Cannot be used together with the
1644 Attempt to send all tags from the local repository's
1646 reference namespace.
1649 option is equivalent to listing all tags with multiple
1652 Cannot be used together with the
1656 Suppress progress reporting output.
1657 The same option will be passed to
1664 to print debugging messages to standard error output.
1665 The same option will be passed to
1668 Multiple -v options increase the verbosity.
1672 .It Cm cherrypick Ar commit
1674 Merge changes from a single
1679 should be on a different branch than the work tree's base commit.
1680 The expected argument is a reference or a commit ID SHA1 hash.
1681 An abbreviated hash argument will be expanded to a full SHA1 hash
1682 automatically, provided the abbreviation is unique.
1684 Show the status of each affected file, using the following status codes:
1685 .Bl -column YXZ description
1686 .It G Ta file was merged
1687 .It C Ta file was merged and conflicts occurred during merge
1688 .It ! Ta changes destined for a missing file were not merged
1689 .It D Ta file was deleted
1690 .It d Ta file's deletion was prevented by local modifications
1691 .It A Ta new file was added
1692 .It \(a~ Ta changes destined for a non-regular file were not merged
1693 .It ? Ta changes destined for an unversioned file were not merged
1696 The merged changes will appear as local changes in the work tree, which
1699 amended manually or with further
1704 or discarded again with
1708 will refuse to run if certain preconditions are not met.
1709 If the work tree contains multiple base commits it must first be updated
1710 to a single base commit with
1712 If any relevant files already contain merge conflicts, these
1713 conflicts must be resolved first.
1715 .It Cm backout Ar commit
1717 Reverse-merge changes from a single
1722 should be on the same branch as the work tree's base commit.
1723 The expected argument is a reference or a commit ID SHA1 hash.
1724 An abbreviated hash argument will be expanded to a full SHA1 hash
1725 automatically, provided the abbreviation is unique.
1727 Show the status of each affected file, using the following status codes:
1728 .Bl -column YXZ description
1729 .It G Ta file was merged
1730 .It C Ta file was merged and conflicts occurred during merge
1731 .It ! Ta changes destined for a missing file were not merged
1732 .It D Ta file was deleted
1733 .It d Ta file's deletion was prevented by local modifications
1734 .It A Ta new file was added
1735 .It \(a~ Ta changes destined for a non-regular file were not merged
1736 .It ? Ta changes destined for an unversioned file were not merged
1739 The reverse-merged changes will appear as local changes in the work tree,
1740 which may be viewed with
1742 amended manually or with further
1747 or discarded again with
1751 will refuse to run if certain preconditions are not met.
1752 If the work tree contains multiple base commits it must first be updated
1753 to a single base commit with
1755 If any relevant files already contain merge conflicts, these
1756 conflicts must be resolved first.
1758 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1760 Rebase commits on the specified
1762 onto the tip of the current branch of the work tree.
1765 must share common ancestry with the work tree's current branch.
1766 Rebasing begins with the first descendant commit of the youngest
1767 common ancestor commit shared by the specified
1769 and the work tree's current branch, and stops once the tip commit
1776 is used as intended, the specified
1778 represents a local commit history and may already contain changes
1779 that are not yet visible in any other repositories.
1780 The work tree's current branch, which must be set with
1784 operation, represents a branch from a remote repository which shares
1785 a common history with the specified
1787 but has progressed, and perhaps diverged, due to commits added to the
1790 Rebased commits are accumulated on a temporary branch which the work tree
1791 will remain switched to throughout the entire rebase operation.
1792 Commits on this branch represent the same changes with the same log
1793 messages as their counterparts on the original
1795 but with different commit IDs.
1796 Once rebasing has completed successfully, the temporary branch becomes
1797 the new version of the specified
1799 and the work tree is automatically switched to it.
1801 Old commits in their pre-rebase state are automatically backed up in the
1802 .Dq refs/got/backup/rebase
1803 reference namespace.
1804 As long as these references are not removed older versions of rebased
1805 commits will remain in the repository and can be viewed with the
1808 Removal of these references makes objects which become unreachable via
1809 any reference subject to removal by Git's garbage collector or
1810 .Cm gotadmin cleanup .
1812 While rebasing commits, show the status of each affected file,
1813 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
1825 If merge conflicts occur the rebase operation is interrupted and may
1826 be continued once conflicts have been resolved.
1827 If any files with destined changes are found to be missing or unversioned,
1828 or if files could not be deleted due to differences in deleted content,
1829 the rebase operation will be interrupted to prevent potentially incomplete
1830 changes from being committed to the repository without user intervention.
1831 The work tree may be modified as desired and the rebase operation can be
1832 continued once the changes present in the work tree are considered complete.
1833 Alternatively, the rebase operation may be aborted which will leave
1835 unmodified and the work tree switched back to its original branch.
1837 If a merge conflict is resolved in a way which renders the merged
1838 change into a no-op change, the corresponding commit will be elided
1839 when the rebase operation continues.
1842 will refuse to run if certain preconditions are not met.
1843 If the work tree is not yet fully updated to the tip commit of its
1844 branch then the work tree must first be updated with
1846 If changes have been staged with
1848 these changes must first be committed with
1852 If the work tree contains local changes, these changes must first be
1859 contains changes to files outside of the work tree's path prefix,
1860 the work tree cannot be used to rebase this branch.
1866 commands will refuse to run while a rebase operation is in progress.
1867 Other commands which manipulate the work tree may be used for
1868 conflict resolution purposes.
1872 is already based on the work tree's current branch then no commits
1873 need to be rebased and
1875 will simply switch the work tree to the specified
1877 and update files in the work tree accordingly.
1884 Abort an interrupted rebase operation.
1885 If this option is used, no other command-line arguments are allowed.
1887 Continue an interrupted rebase operation.
1888 If this option is used, no other command-line arguments are allowed.
1890 Show a list of past rebase operations, represented by references in the
1891 .Dq refs/got/backup/rebase
1892 reference namespace.
1894 Display the author, date, and log message of each backed up commit,
1895 the object ID of the corresponding post-rebase commit, and
1896 the object ID of their common ancestor commit.
1897 Given these object IDs,
1904 options can be used to examine the history of either version of the branch,
1909 option can be used to create a new branch from a pre-rebase state if desired.
1913 is specified, only show commits which at some point in time represented this
1915 Otherwise, list all backed up commits for any branches.
1917 If this option is used,
1919 does not require a work tree.
1920 None of the other options can be used together with
1923 Delete backups created by past rebase operations, represented by references
1925 .Dq refs/got/backup/rebase
1926 reference namespace.
1930 is specified, only delete backups which at some point in time represented
1932 Otherwise, delete all references found within
1933 .Dq refs/got/backup/rebase .
1935 Any commit, tree, tag, and blob objects belonging to deleted backups
1936 remain in the repository and may be removed separately with
1937 Git's garbage collector or
1938 .Cm gotadmin cleanup .
1940 If this option is used,
1942 does not require a work tree.
1943 None of the other options can be used together with
1947 .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
1949 Edit commit history between the work tree's current base commit and
1950 the tip commit of the work tree's current branch.
1954 operation the work tree's current branch must be set with
1956 to the branch which should be edited, unless this branch is already the
1957 current branch of the work tree.
1958 The tip of this branch represents the upper bound (inclusive) of commits
1963 Furthermore, the work tree's base commit
1966 to a point in this branch's commit history where editing should begin.
1967 This commit represents the lower bound (non-inclusive) of commits touched
1972 Editing of commit history is controlled via a
1974 which can be written in an editor based on a template, passed on the
1975 command line, or generated with the
1981 The format of the histedit script is line-based.
1982 Each line in the script begins with a command name, followed by
1983 whitespace and an argument.
1984 For most commands, the expected argument is a commit ID SHA1 hash.
1985 Any remaining text on the line is ignored.
1986 Lines which begin with the
1988 character are ignored entirely.
1990 The available commands are as follows:
1991 .Bl -column YXZ pick-commit
1992 .It pick Ar commit Ta Use the specified commit as it is.
1993 .It edit Ar commit Ta Use the specified commit but once changes have been
1994 merged into the work tree interrupt the histedit operation for amending.
1995 .It fold Ar commit Ta Combine the specified commit with the next commit
1996 listed further below that will be used.
1997 .It drop Ar commit Ta Remove this commit from the edited history.
1998 .It mesg Ar log-message Ta Use the specified single-line log message for
1999 the commit on the previous line.
2000 If the log message argument is left empty, open an editor where a new
2001 log message can be written.
2004 Every commit in the history being edited must be mentioned in the script.
2005 Lines may be re-ordered to change the order of commits in the edited history.
2006 No commit may be listed more than once.
2008 Edited commits are accumulated on a temporary branch which the work tree
2009 will remain switched to throughout the entire histedit operation.
2010 Once history editing has completed successfully, the temporary branch becomes
2011 the new version of the work tree's branch and the work tree is automatically
2014 Old commits in their pre-histedit state are automatically backed up in the
2015 .Dq refs/got/backup/histedit
2016 reference namespace.
2017 As long as these references are not removed older versions of edited
2018 commits will remain in the repository and can be viewed with the
2021 Removal of these references makes objects which become unreachable via
2022 any reference subject to removal by Git's garbage collector or
2023 .Cm gotadmin cleanup .
2025 While merging commits, show the status of each affected file,
2026 using the following status codes:
2027 .Bl -column YXZ description
2028 .It G Ta file was merged
2029 .It C Ta file was merged and conflicts occurred during merge
2030 .It ! Ta changes destined for a missing file were not merged
2031 .It D Ta file was deleted
2032 .It d Ta file's deletion was prevented by local modifications
2033 .It A Ta new file was added
2034 .It \(a~ Ta changes destined for a non-regular file were not merged
2035 .It ? Ta changes destined for an unversioned file were not merged
2038 If merge conflicts occur the histedit operation is interrupted and may
2039 be continued once conflicts have been resolved.
2040 If any files with destined changes are found to be missing or unversioned,
2041 or if files could not be deleted due to differences in deleted content,
2042 the histedit operation will be interrupted to prevent potentially incomplete
2043 changes from being committed to the repository without user intervention.
2044 The work tree may be modified as desired and the histedit operation can be
2045 continued once the changes present in the work tree are considered complete.
2046 Alternatively, the histedit operation may be aborted which will leave
2047 the work tree switched back to its original branch.
2049 If a merge conflict is resolved in a way which renders the merged
2050 change into a no-op change, the corresponding commit will be elided
2051 when the histedit operation continues.
2054 will refuse to run if certain preconditions are not met.
2055 If the work tree's current branch is not in the
2057 reference namespace, the history of the branch may not be edited.
2058 If the work tree contains multiple base commits it must first be updated
2059 to a single base commit with
2061 If changes have been staged with
2063 these changes must first be committed with
2067 If the work tree contains local changes, these changes must first be
2072 If the edited history contains changes to files outside of the work tree's
2073 path prefix, the work tree cannot be used to edit the history of this branch.
2080 commands will refuse to run while a histedit operation is in progress.
2081 Other commands which manipulate the work tree may be used, and the
2083 command may be used to commit arbitrary changes to the temporary branch
2084 while the histedit operation is interrupted.
2091 Abort an interrupted histedit operation.
2092 If this option is used, no other command-line arguments are allowed.
2094 Continue an interrupted histedit operation.
2095 If this option is used, no other command-line arguments are allowed.
2097 Interrupt the histedit operation for editing after merging each commit.
2098 This option is a quick equivalent to a histedit script which uses the
2100 command for all commits.
2103 option can only be used when starting a new histedit operation.
2104 If this option is used, no other command-line arguments are allowed.
2106 Fold all commits into a single commit.
2107 This option is a quick equivalent to a histedit script which folds all
2108 commits, combining them all into one commit.
2111 option can only be used when starting a new histedit operation.
2112 If this option is used, no other command-line arguments are allowed.
2113 .It Fl F Ar histedit-script
2116 instead of opening a temporary file in an editor where a histedit script
2119 Edit log messages only.
2120 This option is a quick equivalent to a histedit script which edits
2121 only log messages but otherwise leaves every picked commit as-is.
2124 option can only be used when starting a new histedit operation.
2125 If this option is used, no other command-line arguments are allowed.
2127 Show a list of past histedit operations, represented by references in the
2128 .Dq refs/got/backup/histedit
2129 reference namespace.
2131 Display the author, date, and log message of each backed up commit,
2132 the object ID of the corresponding post-histedit commit, and
2133 the object ID of their common ancestor commit.
2134 Given these object IDs,
2141 options can be used to examine the history of either version of the branch,
2146 option can be used to create a new branch from a pre-histedit state if desired.
2150 is specified, only show commits which at some point in time represented this
2152 Otherwise, list all backed up commits for any branches.
2154 If this option is used,
2156 does not require a work tree.
2157 None of the other options can be used together with
2160 Delete backups created by past histedit operations, represented by references
2162 .Dq refs/got/backup/histedit
2163 reference namespace.
2167 is specified, only delete backups which at some point in time represented
2169 Otherwise, delete all references found within
2170 .Dq refs/got/backup/histedit .
2172 Any commit, tree, tag, and blob objects belonging to deleted backups
2173 remain in the repository and may be removed separately with
2174 Git's garbage collector or
2175 .Cm gotadmin cleanup .
2177 If this option is used,
2179 does not require a work tree.
2180 None of the other options can be used together with
2184 .It Cm integrate Ar branch
2186 Integrate the specified
2188 into the work tree's current branch.
2189 Files in the work tree are updated to match the contents on the integrated
2191 and the reference of the work tree's branch is changed to point at the
2192 head commit of the integrated
2195 Both branches can be considered equivalent after integration since they
2196 will be pointing at the same commit.
2197 Both branches remain available for future work, if desired.
2198 In case the integrated
2200 is no longer needed it may be deleted with
2203 Show the status of each affected file, using the following status codes:
2204 .Bl -column YXZ description
2205 .It U Ta file was updated
2206 .It D Ta file was deleted
2207 .It A Ta new file was added
2208 .It \(a~ Ta versioned file is obstructed by a non-regular file
2209 .It ! Ta a missing versioned file was restored
2213 will refuse to run if certain preconditions are not met.
2214 Most importantly, the
2216 must have been rebased onto the work tree's current branch with
2218 before it can be integrated, in order to linearize commit history and
2219 resolve merge conflicts.
2220 If the work tree contains multiple base commits it must first be updated
2221 to a single base commit with
2223 If changes have been staged with
2225 these changes must first be committed with
2229 If the work tree contains local changes, these changes must first be
2235 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2237 Create a merge commit based on the current branch of the work tree and
2240 If a linear project history is desired, then use of
2242 should be preferred over
2244 However, even strictly linear projects may require merge commits in order
2245 to merge in new versions of third-party code stored on vendor branches
2249 Merge commits are commits based on multiple parent commits.
2250 The tip commit of the work tree's current branch, which must be set with
2254 operation, will be used as the first parent.
2255 The tip commit of the specified
2257 will be used as the second parent.
2259 No ancestral relationship between the two branches is required.
2260 If the two branches have already been merged previously, only new changes
2263 It is not possible to create merge commits with more than two parents.
2264 If more than one branch needs to be merged, then multiple merge commits
2265 with two parents each can be created in sequence.
2267 While merging changes found on the
2269 into the work tree, show the status of each affected file,
2270 using the following status codes:
2271 .Bl -column YXZ description
2272 .It G Ta file was merged
2273 .It C Ta file was merged and conflicts occurred during merge
2274 .It ! Ta changes destined for a missing file were not merged
2275 .It D Ta file was deleted
2276 .It d Ta file's deletion was prevented by local modifications
2277 .It A Ta new file was added
2278 .It \(a~ Ta changes destined for a non-regular file were not merged
2279 .It ? Ta changes destined for an unversioned file were not merged
2282 If merge conflicts occur, the merge operation is interrupted and conflicts
2283 must be resolved before the merge operation can continue.
2284 If any files with destined changes are found to be missing or unversioned,
2285 or if files could not be deleted due to differences in deleted content,
2286 the merge operation will be interrupted to prevent potentially incomplete
2287 changes from being committed to the repository without user intervention.
2288 The work tree may be modified as desired and the merge can be continued
2289 once the changes present in the work tree are considered complete.
2290 Alternatively, the merge operation may be aborted which will leave
2291 the work tree's current branch unmodified.
2293 If a merge conflict is resolved in a way which renders all merged
2294 changes into no-op changes, the merge operation cannot continue
2295 and must be aborted.
2298 will refuse to run if certain preconditions are not met.
2301 is based on the work tree's current branch, then no merge commit can
2304 may be used to integrate the
2307 If the work tree is not yet fully updated to the tip commit of its
2308 branch, then the work tree must first be updated with
2310 If the work tree contains multiple base commits it must first be updated
2311 to a single base commit with
2313 If changes have been staged with
2315 these changes must first be committed with
2319 If the work tree contains local changes, these changes must first be
2326 contains changes to files outside of the work tree's path prefix,
2327 the work tree cannot be used to merge this branch.
2337 commands will refuse to run while a merge operation is in progress.
2338 Other commands which manipulate the work tree may be used for
2339 conflict resolution purposes.
2346 Abort an interrupted merge operation.
2347 If this option is used, no other command-line arguments are allowed.
2349 Continue an interrupted merge operation.
2350 If this option is used, no other command-line arguments are allowed.
2352 Merge changes into the work tree as usual but do not create a merge
2354 The merge result can be adjusted as desired before a merge commit is
2357 Alternatively, the merge may be aborted with
2361 .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 ...
2363 Stage local changes for inclusion in the next commit.
2366 is specified, stage all changes in the work tree.
2367 Otherwise, stage changes at or within the specified paths.
2368 Paths may be staged if they are added, modified, or deleted according to
2371 Show the status of each affected file, using the following status codes:
2372 .Bl -column YXZ description
2373 .It A Ta file addition has been staged
2374 .It M Ta file modification has been staged
2375 .It D Ta file deletion has been staged
2378 Staged file contents are saved in newly created blob objects in the repository.
2379 These blobs will be referred to by tree objects once staged changes have been
2382 Staged changes affect the behaviour of
2387 While paths with staged changes exist, the
2389 command will refuse to commit any paths which do not have staged changes.
2390 Local changes created on top of staged changes can only be committed if
2391 the path is staged again, or if the staged changes are committed first.
2394 command will show both local changes and staged changes.
2397 command is able to display local changes relative to staged changes,
2398 and to display staged changes relative to the repository.
2401 command cannot revert staged changes but may be used to revert
2402 local changes created on top of staged changes.
2409 Instead of staging new changes, list paths which are already staged,
2410 along with the IDs of staged blob objects and stage status codes.
2411 If paths were provided in the command line show the staged paths
2412 among the specified paths.
2413 Otherwise, show all staged paths.
2415 Instead of staging the entire content of a changed file, interactively
2416 select or reject changes for staging based on
2420 (reject change), and
2422 (quit staging this file) responses.
2423 If a file is in modified status, individual patches derived from the
2424 modified file content can be staged.
2425 Files in added or deleted status may only be staged or rejected in
2427 .It Fl F Ar response-script
2435 responses line-by-line from the specified
2437 file instead of prompting interactively.
2439 Allow staging of symbolic links which point outside of the path space
2440 that is under version control.
2443 will reject such symbolic links due to safety concerns.
2446 may decide to represent such a symbolic link as a regular file which contains
2447 the link's target path, rather than creating an actual symbolic link which
2448 points outside of the work tree.
2449 Use of this option is discouraged because external mechanisms such as
2451 are better suited for managing symbolic links to paths not under
2456 will refuse to run if certain preconditions are not met.
2457 If a file contains merge conflicts, these conflicts must be resolved first.
2458 If a file is found to be out of date relative to the head commit on the
2459 work tree's current branch, the file must be updated with
2461 before it can be staged (however, this does not prevent the file from
2462 becoming out-of-date at some point after having been staged).
2469 commands will refuse to run while staged changes exist.
2470 If staged changes cannot be committed because a staged path
2471 is out of date, the path must be unstaged with
2473 before it can be updated with
2475 and may then be staged again if necessary.
2477 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2479 Merge staged changes back into the work tree and put affected paths
2480 back into non-staged status.
2483 is specified, unstage all staged changes across the entire work tree.
2484 Otherwise, unstage changes at or within the specified paths.
2486 Show the status of each affected file, using the following status codes:
2487 .Bl -column YXZ description
2488 .It G Ta file was unstaged
2489 .It C Ta file was unstaged and conflicts occurred during merge
2490 .It ! Ta changes destined for a missing file were not merged
2491 .It D Ta file was staged as deleted and still is deleted
2492 .It d Ta file's deletion was prevented by local modifications
2493 .It \(a~ Ta changes destined for a non-regular file were not merged
2501 Instead of unstaging the entire content of a changed file, interactively
2502 select or reject changes for unstaging based on
2506 (keep change staged), and
2508 (quit unstaging this file) responses.
2509 If a file is staged in modified status, individual patches derived from the
2510 staged file content can be unstaged.
2511 Files staged in added or deleted status may only be unstaged in their entirety.
2512 .It Fl F Ar response-script
2520 responses line-by-line from the specified
2522 file instead of prompting interactively.
2524 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2525 Parse and print contents of objects to standard output in a line-based
2527 Content of commit, tree, and tag objects is printed in a way similar
2528 to the actual content stored in such objects.
2529 Blob object contents are printed as they would appear in files on disk.
2531 Attempt to interpret each argument as a reference, a tag name, or
2532 an object ID SHA1 hash.
2533 References will be resolved to an object ID.
2534 Tag names will resolved to a tag object.
2535 An abbreviated hash argument will be expanded to a full SHA1 hash
2536 automatically, provided the abbreviation is unique.
2538 If none of the above interpretations produce a valid result, or if the
2540 option is used, attempt to interpret the argument as a path which will
2541 be resolved to the ID of an object found at this path in the repository.
2548 Look up paths in the specified
2550 If this option is not used, paths are looked up in the commit resolved
2551 via the repository's HEAD reference.
2552 The expected argument is a commit ID SHA1 hash or an existing reference
2553 or tag name which will be resolved to a commit ID.
2554 An abbreviated hash argument will be expanded to a full SHA1 hash
2555 automatically, provided the abbreviation is unique.
2556 .It Fl r Ar repository-path
2557 Use the repository at the specified path.
2558 If not specified, assume the repository is located at or above the current
2560 If this directory is a
2562 work tree, use the repository path associated with this work tree.
2564 Interpret all arguments as paths only.
2565 This option can be used to resolve ambiguity in cases where paths
2566 look like tag names, reference names, or object IDs.
2568 .It Cm info Op Ar path ...
2569 Display meta-data stored in a work tree.
2574 The work tree to use is resolved implicitly by walking upwards from the
2575 current working directory.
2579 arguments are specified, show additional per-file information for tracked
2580 files located at or within these paths.
2583 argument corresponds to the work tree's root directory, display information
2584 for all tracked files.
2587 .Bl -tag -width GOT_AUTHOR
2589 The author's name and email address for
2594 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2597 may fail to parse commits without an email address in author data,
2601 environment variables with a missing email address.
2603 .Ev GOT_AUTHOR will be overridden by configuration settings in
2609 configuration settings in the repository's
2616 configuration settings contained in Git's global
2618 configuration file will only be used if neither
2622 environment variable provide author information.
2623 .It Ev VISUAL , EDITOR
2624 The editor spawned by
2632 text editor will be spawned in order to give
2634 the attention it deserves.
2635 .It Ev GOT_LOG_DEFAULT_LIMIT
2636 The default limit on the number of commits traversed by
2638 If set to zero, the limit is unbounded.
2639 This variable will be silently ignored if it is set to a non-numeric value.
2642 .Bl -tag -width packed-refs -compact
2644 Repository-wide configuration settings for
2648 configuration file located in the root directory of a Git repository
2649 supersedes any relevant settings in Git's
2653 .It Pa .got/got.conf
2654 Worktree-specific configuration settings for
2658 configuration file in the
2660 meta-data directory of a work tree supersedes any relevant settings in
2663 configuration file and Git's
2670 Enable tab-completion of
2675 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2677 Clone an existing Git repository for use with
2681 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2683 Use of HTTP URLs currently requires
2687 .Dl $ git clone --bare https://github.com/openbsd/src.git
2689 Alternatively, for quick and dirty local testing of
2691 a new Git repository could be created and populated with files,
2692 e.g. from a temporary CVS checkout located at
2695 .Dl $ got init /var/git/src.git
2696 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2698 Check out a work tree from the Git repository to /usr/src:
2700 .Dl $ got checkout /var/git/src.git /usr/src
2702 View local changes in a work tree directory:
2704 .Dl $ got diff | less
2706 In a work tree, display files in a potentially problematic state:
2708 .Dl $ got status -s 'C!~?'
2710 Interactively revert selected local changes in a work tree directory:
2712 .Dl $ got revert -p -R\ .
2714 In a work tree or a git repository directory, list all branch references:
2718 In a work tree or a git repository directory, create a new branch called
2719 .Dq unified-buffer-cache
2720 which is forked off the
2724 .Dl $ got branch -c master unified-buffer-cache
2726 Switch an existing work tree to the branch
2727 .Dq unified-buffer-cache .
2728 Local changes in the work tree will be preserved and merged if necessary:
2730 .Dl $ got update -b unified-buffer-cache
2732 Create a new commit from local changes in a work tree directory.
2733 This new commit will become the head commit of the work tree's current branch:
2737 In a work tree or a git repository directory, view changes committed in
2738 the 3 most recent commits to the work tree's branch, or the branch resolved
2739 via the repository's HEAD reference, respectively:
2741 .Dl $ got log -p -l 3
2743 As above, but display changes in the order in which
2745 could apply them in sequence:
2747 .Dl $ got log -p -l 3 -R
2749 In a work tree or a git repository directory, log the history of a subdirectory:
2751 .Dl $ got log sys/uvm
2753 While operating inside a work tree, paths are specified relative to the current
2754 working directory, so this command will log the subdirectory
2757 .Dl $ cd sys/uvm && got log\ .
2759 And this command has the same effect:
2761 .Dl $ cd sys/dev/usb && got log ../../uvm
2763 And this command displays work tree meta-data about all tracked files:
2766 .Dl $ got info\ . | less
2768 Add new files and remove obsolete files in a work tree directory:
2770 .Dl $ got add sys/uvm/uvm_ubc.c
2771 .Dl $ got remove sys/uvm/uvm_vnode.c
2773 Create a new commit from local changes in a work tree directory
2774 with a pre-defined log message.
2776 .Dl $ got commit -m 'unify the buffer cache'
2778 Alternatively, create a new commit from local changes in a work tree
2779 directory with a log message that has been prepared in the file
2782 .Dl $ got commit -F /tmp/msg
2784 Update any work tree checked out from the
2785 .Dq unified-buffer-cache
2786 branch to the latest commit on this branch:
2790 Roll file content on the unified-buffer-cache branch back by one commit,
2791 and then fetch the rolled-back change into the work tree as a local change
2792 to be amended and perhaps committed again:
2794 .Dl $ got backout unified-buffer-cache
2795 .Dl $ got commit -m 'roll back previous'
2796 .Dl $ # now back out the previous backout :-)
2797 .Dl $ got backout unified-buffer-cache
2799 Fetch new changes on the remote repository's
2801 branch, making them visible on the local repository's
2808 In a repository created with a HTTP URL and
2809 .Cm git clone --bare
2812 command must be used instead:
2814 .Dl $ cd /var/git/src.git
2815 .Dl $ git fetch origin master:refs/remotes/origin/master
2819 branch to merge the new changes that are now visible on the
2824 .Dl $ got update -b origin/master
2825 .Dl $ got rebase master
2828 .Dq unified-buffer-cache
2829 branch on top of the new head commit of the
2833 .Dl $ got update -b master
2834 .Dl $ got rebase unified-buffer-cache
2836 Create a patch from all changes on the unified-buffer-cache branch.
2837 The patch can be mailed out for review and applied to
2841 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2843 Edit the entire commit history of the
2844 .Dq unified-buffer-cache
2847 .Dl $ got update -b unified-buffer-cache
2848 .Dl $ got update -c master
2851 Before working against existing branches in a repository cloned with
2852 .Cm git clone --bare
2857 must be configured to map all references in the remote repository
2860 namespace of the local repository.
2861 This can be achieved by setting Git's
2862 .Pa remote.origin.fetch
2863 configuration variable to the value
2864 .Dq +refs/heads/*:refs/remotes/origin/*
2869 .Dl $ cd /var/git/repo
2870 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2874 option must be disabled:
2876 .Dl $ cd /var/git/repo
2877 .Dl $ git config remote.origin.mirror false
2879 Alternatively, the following
2881 configuration item can be added manually to the Git repository's
2885 .Dl [remote \&"origin\&"]
2887 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2890 This configuration leaves the local repository's
2892 namespace free for use by local branches checked out with
2894 and, if needed, created with
2897 .Dq refs/remotes/origin
2898 namespace can now be updated with incoming changes from the remote
2903 without extra command line arguments.
2904 Newly fetched changes can be examined with
2907 Display changes on the remote repository's version of the
2909 branch, as of the last time
2913 .Dl $ got log -c origin/master | less
2915 As shown here, most commands accept abbreviated reference names such as
2918 .Dq refs/remotes/origin/master .
2919 The latter is only needed in case of ambiguity.
2922 must be used to merge changes which are visible on the
2927 This will also merge local changes, if any, with the incoming changes:
2929 .Dl $ got update -b origin/master
2930 .Dl $ got rebase master
2932 In order to make changes committed to the
2933 .Dq unified-buffer-cache
2937 .Dq unified-buffer-cache
2938 branch must first be rebased onto the
2942 .Dl $ got update -b master
2943 .Dl $ got rebase unified-buffer-cache
2946 .Dq unified-buffer-cache
2947 branch can now be made visible on the
2951 Because the rebase operation switched the work tree to the
2952 .Dq unified-buffer-cache
2953 branch the work tree must be switched back to the
2957 .Dl $ got update -b master
2958 .Dl $ got integrate unified-buffer-cache
2962 branch, log messages for local changes can now be amended with
2964 by other developers and any other important new information:
2966 .Dl $ got update -c origin/master
2967 .Dl $ got histedit -m
2969 If the remote repository offers write access local changes on the
2971 branch can be sent to the remote repository with
2975 can be run without further arguments.
2976 The arguments shown here match defaults, provided the work tree's
2977 current branch is the
2981 .Dl $ got send -b master origin
2983 If the remote repository requires the HTTPS protocol the
2985 command must be used instead:
2987 .Dl $ cd /var/git/src.git
2988 .Dl $ git push origin master
2992 .Xr git-repository 5 ,
2993 .Xr got-worktree 5 ,
2996 .An Stefan Sperling Aq Mt stsp@openbsd.org
2997 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2998 .An Joshua Stein Aq Mt jcs@openbsd.org
2999 .An Ori Bernstein Aq Mt ori@openbsd.org
3002 is a work-in-progress and some features remain to be implemented.
3004 At present, the user has to fall back on
3006 to perform some tasks.
3010 Reading from remote repositories over HTTP or HTTPS protocols requires
3015 Writing to remote repositories over HTTP or HTTPS protocols requires
3018 The creation of merge commits with more than two parent commits requires
3021 In situations where files or directories were moved around
3023 will not automatically merge changes to new locations and
3025 will usually produce better results.
