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 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
1022 Create a reference or change an existing reference.
1023 The reference with the specified
1025 will point at the specified
1029 argument is a ID SHA1 hash or an existing reference or tag name which will
1030 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1031 Cannot be used together with any other options except
1033 .It Fl s Ar reference
1034 Create a symbolic reference, or change an existing symbolic reference.
1035 The symbolic reference with the specified
1037 will point at the specified
1039 which must already exist in the repository.
1040 Care should be taken not to create loops between references when
1041 this option is used.
1042 Cannot be used together with any other options except
1045 Delete the reference with the specified
1047 from the repository.
1048 Any commit, tree, tag, and blob objects belonging to deleted references
1049 remain in the repository and may be removed separately with
1050 Git's garbage collector or
1051 .Cm gotadmin cleanup .
1052 Cannot be used together with any other options except
1056 .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
1058 Create, list, or delete branches.
1060 Local branches are managed via references which live in the
1062 reference namespace.
1065 command creates references in this namespace only.
1067 When deleting branches the specified
1071 reference namespace first.
1072 If no corresponding branch is found the
1074 namespace will be searched next.
1076 If invoked in a work tree without any arguments, print the name of the
1077 work tree's current branch.
1081 argument is passed, attempt to create a branch reference with the given name.
1082 By default the new branch reference will point at the latest commit on the
1083 work tree's current branch if invoked in a work tree, and otherwise to a commit
1084 resolved via the repository's HEAD reference.
1086 If invoked in a work tree, once the branch was created successfully
1087 switch the work tree's head reference to the newly created branch and
1088 update files across the entire work tree, just like
1089 .Cm got update -b Ar name
1091 Show the status of each affected file, using the following status codes:
1092 .Bl -column YXZ description
1093 .It U Ta file was updated and contained no local changes
1094 .It G Ta file was updated and local changes were merged cleanly
1095 .It C Ta file was updated and conflicts occurred during merge
1096 .It D Ta file was deleted
1097 .It A Ta new file was added
1098 .It \(a~ Ta versioned file is obstructed by a non-regular file
1099 .It ! Ta a missing versioned file was restored
1107 Make a newly created branch reference point at the specified
1111 argument is a commit ID SHA1 hash or an existing reference
1112 or tag name which will be resolved to a commit ID.
1113 .It Fl r Ar repository-path
1114 Use the repository at the specified path.
1115 If not specified, assume the repository is located at or above the current
1117 If this directory is a
1119 work tree, use the repository path associated with this work tree.
1121 List all existing branches in the repository, including copies of remote
1122 repositories' branches in the
1124 reference namespace.
1126 If invoked in a work tree, the work tree's current branch is shown
1127 with one the following annotations:
1128 .Bl -column YXZ description
1129 .It * Ta work tree's base commit matches the branch tip
1130 .It \(a~ Ta work tree's base commit is out-of-date
1133 Delete the branch with the specified
1139 reference namespace.
1141 Only the branch reference is deleted.
1142 Any commit, tree, and blob objects belonging to the branch
1143 remain in the repository and may be removed separately with
1144 Git's garbage collector or
1145 .Cm gotadmin cleanup .
1147 Do not switch and update the work tree after creating a new branch.
1149 .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
1150 Manage tags in a repository.
1152 Tags are managed via references which live in the
1154 reference namespace.
1157 command operates on references in this namespace only.
1158 References in this namespace point at tag objects which contain a pointer
1159 to another object, a tag message, as well as author and timestamp information.
1161 Attempt to create a tag with the given
1163 and make this tag point at the given
1165 If no commit is specified, default to the latest commit on the work tree's
1166 current branch if invoked in a work tree, and to a commit resolved via
1167 the repository's HEAD reference otherwise.
1174 Make the newly created tag reference point at the specified
1178 argument is a commit ID SHA1 hash or an existing reference or tag name which
1179 will be resolved to a commit ID.
1180 An abbreviated hash argument will be expanded to a full SHA1 hash
1181 automatically, provided the abbreviation is unique.
1183 Use the specified tag message when creating the new tag.
1188 opens a temporary file in an editor where a tag message can be written.
1189 .It Fl r Ar repository-path
1190 Use the repository at the specified path.
1191 If not specified, assume the repository is located at or above the current
1193 If this directory is a
1195 work tree, use the repository path associated with this work tree.
1197 List all existing tags in the repository instead of creating a new tag.
1198 If this option is used, no other command-line arguments are allowed.
1203 command will not delete tags or change existing tags.
1204 If a tag must be deleted, the
1206 command may be used to delete a tag's reference.
1207 This should only be done if the tag has not already been copied to
1209 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1210 Schedule unversioned files in a work tree for addition to the
1211 repository in the next commit.
1212 By default, files which match a
1214 ignore pattern will not be added.
1221 Permit recursion into directories.
1222 If this option is not specified,
1224 will refuse to run if a specified
1228 Add files even if they match a
1233 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1235 Remove versioned files from a work tree and schedule them for deletion
1236 from the repository in the next commit.
1243 Perform the operation even if a file contains local modifications.
1245 Keep affected files on disk.
1247 Permit recursion into directories.
1248 If this option is not specified,
1250 will refuse to run if a specified
1253 .It Fl s Ar status-codes
1254 Only delete files with a modification status matching one of the
1255 single-character status codes contained in the
1258 The following status codes may be specified:
1259 .Bl -column YXZ description
1260 .It M Ta modified file (this implies the
1263 .It ! Ta versioned file expected on disk but missing
1267 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1269 Revert any local changes in files at the specified paths in a work tree.
1270 File contents will be overwritten with those contained in the
1271 work tree's base commit.
1272 There is no way to bring discarded changes back after
1275 If a file was added with
1277 it will become an unversioned file again.
1278 If a file was deleted with
1280 it will be restored.
1287 Instead of reverting all changes in files, interactively select or reject
1288 changes to revert based on
1294 (quit reverting this file) responses.
1295 If a file is in modified status, individual patches derived from the
1296 modified file content can be reverted.
1297 Files in added or deleted status may only be reverted in their entirety.
1298 .It Fl F Ar response-script
1306 responses line-by-line from the specified
1308 file instead of prompting interactively.
1310 Permit recursion into directories.
1311 If this option is not specified,
1313 will refuse to run if a specified
1318 .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 ...
1320 Create a new commit in the repository from changes in a work tree
1321 and use this commit as the new base commit for the work tree.
1324 is specified, commit all changes in the work tree.
1325 Otherwise, commit changes at or within the specified paths.
1327 If changes have been explicitly staged for commit with
1329 only commit staged changes and reject any specified paths which
1330 have not been staged.
1333 opens a temporary file in an editor where a log message can be written
1341 options are used together.
1343 Show the status of each affected file, using the following status codes:
1344 .Bl -column YXZ description
1345 .It M Ta modified file
1346 .It D Ta file was deleted
1347 .It A Ta new file was added
1348 .It m Ta modified file modes (executable bit only)
1351 Files which are not part of the new commit will retain their previously
1352 recorded base commit.
1355 commands may refuse to run while the work tree contains files from
1356 multiple base commits.
1357 The base commit of such a work tree can be made consistent by running
1359 across the entire work tree.
1363 command requires the
1365 environment variable to be set,
1366 unless an author has been configured in
1372 configuration settings can be
1373 obtained from the repository's
1375 file or from Git's global
1384 Use the prepared log message stored in the file found at
1386 when creating the new commit.
1388 opens a temporary file in an editor where the prepared log message can be
1389 reviewed and edited further if needed.
1390 Cannot be used together with the
1394 Use the specified log message when creating the new commit.
1395 Cannot be used together with the
1399 This option prevents
1401 from opening the commit message in an editor.
1402 It has no effect unless it is used together with the
1404 option and is intended for non-interactive use such as scripting.
1406 Allow the addition of symbolic links which point outside of the path space
1407 that is under version control.
1410 will reject such symbolic links due to safety concerns.
1413 may decide to represent such a symbolic link as a regular file which contains
1414 the link's target path, rather than creating an actual symbolic link which
1415 points outside of the work tree.
1416 Use of this option is discouraged because external mechanisms such as
1418 are better suited for managing symbolic links to paths not under
1423 will refuse to run if certain preconditions are not met.
1424 If the work tree's current branch is not in the
1426 reference namespace, new commits may not be created on this branch.
1427 Local changes may only be committed if they are based on file content
1428 found in the most recent commit on the work tree's branch.
1429 If a path is found to be out of date,
1431 must be used first in order to merge local changes with changes made
1434 .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
1436 Send new changes to a remote repository.
1438 .Ar remote-repository
1442 The remote repository's URL is obtained from the corresponding entry in
1446 file of the local repository, as created by
1449 All objects corresponding to new changes will be written to a temporary
1450 pack file which is then uploaded to the server.
1451 Upon success, references in the
1453 reference namespace of the local repository will be updated to point at
1454 the commits which have been sent.
1456 By default, changes will only be sent if they are based on up-to-date
1457 copies of relevant branches in the remote repository.
1458 If any changes to be sent are based on out-of-date copies or would
1459 otherwise break linear history of existing branches, new changes must
1460 be fetched from the server with
1462 and local branches must be rebased with
1469 option can be used to make exceptions to these requirements.
1476 Send all branches from the local repository's
1478 reference namespace.
1481 option is equivalent to listing all branches with multiple
1484 Cannot be used together with the
1490 from the local repository's
1492 reference namespace.
1493 This option may be specified multiple times to build a list of branches
1495 If this option is not specified, default to the work tree's current branch
1496 if invoked in a work tree, or to the repository's HEAD reference.
1497 Cannot be used together with the
1501 Delete the specified
1503 from the remote repository's
1505 reference namespace.
1506 This option may be specified multiple times to build a list of branches
1509 Only references are deleted.
1510 Any commit, tree, tag, and blob objects belonging to deleted branches
1511 may become subject to deletion by Git's garbage collector running on
1514 Requesting deletion of branches results in an error if the server
1515 does not support this feature or disallows the deletion of branches
1516 based on its configuration.
1518 Attempt to force the server to overwrite existing branches or tags
1519 in the remote repository, even when
1523 would usually be required before changes can be sent.
1524 The server may reject forced requests regardless, depending on its
1527 Any commit, tree, tag, and blob objects belonging to overwritten branches
1528 or tags may become subject to deletion by Git's garbage collector running
1533 reference namespace is globally shared between all repositories.
1536 option to overwrite tags is discouraged because it can lead to
1537 inconsistencies between the tags present in different repositories.
1538 In general, creating a new tag with a different name is recommended
1539 instead of overwriting an existing tag.
1543 option is particularly discouraged if changes being sent are based
1544 on an out-of-date copy of a branch in the remote repository.
1545 Instead of using the
1547 option, new changes should
1550 and local branches should be rebased with
1552 followed by another attempt to send the changes.
1556 option should only be needed in situations where the remote repository's
1557 copy of a branch or tag is known to be out-of-date and is considered
1559 The risks of creating inconsistencies between different repositories
1560 should also be taken into account.
1561 .It Fl r Ar repository-path
1562 Use the repository at the specified path.
1563 If not specified, assume the repository is located at or above the current
1565 If this directory is a
1567 work tree, use the repository path associated with this work tree.
1571 from the local repository's
1573 reference namespace, in addition to any branches that are being sent.
1576 option may be specified multiple times to build a list of tags to send.
1577 No tags will be sent if the
1581 Raise an error if the specified
1583 already exists in the remote repository, unless the
1585 option is used to overwrite the server's copy of the tag.
1586 In general, creating a new tag with a different name is recommended
1587 instead of overwriting an existing tag.
1589 Cannot be used together with the
1593 Attempt to send all tags from the local repository's
1595 reference namespace.
1598 option is equivalent to listing all tags with multiple
1601 Cannot be used together with the
1605 Suppress progress reporting output.
1606 The same option will be passed to
1613 to print debugging messages to standard error output.
1614 The same option will be passed to
1617 Multiple -v options increase the verbosity.
1621 .It Cm cherrypick Ar commit
1623 Merge changes from a single
1628 should be on a different branch than the work tree's base commit.
1629 The expected argument is a reference or a commit ID SHA1 hash.
1630 An abbreviated hash argument will be expanded to a full SHA1 hash
1631 automatically, provided the abbreviation is unique.
1633 Show the status of each affected file, using the following status codes:
1634 .Bl -column YXZ description
1635 .It G Ta file was merged
1636 .It C Ta file was merged and conflicts occurred during merge
1637 .It ! Ta changes destined for a missing file were not merged
1638 .It D Ta file was deleted
1639 .It d Ta file's deletion was prevented by local modifications
1640 .It A Ta new file was added
1641 .It \(a~ Ta changes destined for a non-regular file were not merged
1642 .It ? Ta changes destined for an unversioned file were not merged
1645 The merged changes will appear as local changes in the work tree, which
1648 amended manually or with further
1653 or discarded again with
1657 will refuse to run if certain preconditions are not met.
1658 If the work tree contains multiple base commits it must first be updated
1659 to a single base commit with
1661 If any relevant files already contain merge conflicts, these
1662 conflicts must be resolved first.
1664 .It Cm backout Ar commit
1666 Reverse-merge changes from a single
1671 should be on the same branch as the work tree's base commit.
1672 The expected argument is a reference or a commit ID SHA1 hash.
1673 An abbreviated hash argument will be expanded to a full SHA1 hash
1674 automatically, provided the abbreviation is unique.
1676 Show the status of each affected file, using the following status codes:
1677 .Bl -column YXZ description
1678 .It G Ta file was merged
1679 .It C Ta file was merged and conflicts occurred during merge
1680 .It ! Ta changes destined for a missing file were not merged
1681 .It D Ta file was deleted
1682 .It d Ta file's deletion was prevented by local modifications
1683 .It A Ta new file was added
1684 .It \(a~ Ta changes destined for a non-regular file were not merged
1685 .It ? Ta changes destined for an unversioned file were not merged
1688 The reverse-merged changes will appear as local changes in the work tree,
1689 which may be viewed with
1691 amended manually or with further
1696 or discarded again with
1700 will refuse to run if certain preconditions are not met.
1701 If the work tree contains multiple base commits it must first be updated
1702 to a single base commit with
1704 If any relevant files already contain merge conflicts, these
1705 conflicts must be resolved first.
1707 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1709 Rebase commits on the specified
1711 onto the tip of the current branch of the work tree.
1714 must share common ancestry with the work tree's current branch.
1715 Rebasing begins with the first descendant commit of the youngest
1716 common ancestor commit shared by the specified
1718 and the work tree's current branch, and stops once the tip commit
1725 is used as intended, the specified
1727 represents a local commit history and may already contain changes
1728 that are not yet visible in any other repositories.
1729 The work tree's current branch, which must be set with
1733 operation, represents a branch from a remote repository which shares
1734 a common history with the specified
1736 but has progressed, and perhaps diverged, due to commits added to the
1739 Rebased commits are accumulated on a temporary branch which the work tree
1740 will remain switched to throughout the entire rebase operation.
1741 Commits on this branch represent the same changes with the same log
1742 messages as their counterparts on the original
1744 but with different commit IDs.
1745 Once rebasing has completed successfully, the temporary branch becomes
1746 the new version of the specified
1748 and the work tree is automatically switched to it.
1750 Old commits in their pre-rebase state are automatically backed up in the
1751 .Dq refs/got/backup/rebase
1752 reference namespace.
1753 As long as these references are not removed older versions of rebased
1754 commits will remain in the repository and can be viewed with the
1757 Removal of these references makes objects which become unreachable via
1758 any reference subject to removal by Git's garbage collector or
1759 .Cm gotadmin cleanup .
1761 While rebasing commits, show the status of each affected file,
1762 using the following status codes:
1763 .Bl -column YXZ description
1764 .It G Ta file was merged
1765 .It C Ta file was merged and conflicts occurred during merge
1766 .It ! Ta changes destined for a missing file were not merged
1767 .It D Ta file was deleted
1768 .It d Ta file's deletion was prevented by local modifications
1769 .It A Ta new file was added
1770 .It \(a~ Ta changes destined for a non-regular file were not merged
1771 .It ? Ta changes destined for an unversioned file were not merged
1774 If merge conflicts occur the rebase operation is interrupted and may
1775 be continued once conflicts have been resolved.
1776 If any files with destined changes are found to be missing or unversioned,
1777 or if files could not be deleted due to differences in deleted content,
1778 the rebase operation will be interrupted to prevent potentially incomplete
1779 changes from being committed to the repository without user intervention.
1780 The work tree may be modified as desired and the rebase operation can be
1781 continued once the changes present in the work tree are considered complete.
1782 Alternatively, the rebase operation may be aborted which will leave
1784 unmodified and the work tree switched back to its original branch.
1786 If a merge conflict is resolved in a way which renders the merged
1787 change into a no-op change, the corresponding commit will be elided
1788 when the rebase operation continues.
1791 will refuse to run if certain preconditions are not met.
1792 If the work tree is not yet fully updated to the tip commit of its
1793 branch then the work tree must first be updated with
1795 If changes have been staged with
1797 these changes must first be committed with
1801 If the work tree contains local changes, these changes must first be
1808 contains changes to files outside of the work tree's path prefix,
1809 the work tree cannot be used to rebase this branch.
1815 commands will refuse to run while a rebase operation is in progress.
1816 Other commands which manipulate the work tree may be used for
1817 conflict resolution purposes.
1821 is already based on the work tree's current branch then no commits
1822 need to be rebased and
1824 will simply switch the work tree to the specified
1826 and update files in the work tree accordingly.
1833 Abort an interrupted rebase operation.
1834 If this option is used, no other command-line arguments are allowed.
1836 Continue an interrupted rebase operation.
1837 If this option is used, no other command-line arguments are allowed.
1839 Show a list of past rebase operations, represented by references in the
1840 .Dq refs/got/backup/rebase
1841 reference namespace.
1843 Display the author, date, and log message of each backed up commit,
1844 the object ID of the corresponding post-rebase commit, and
1845 the object ID of their common ancestor commit.
1846 Given these object IDs,
1853 options can be used to examine the history of either version of the branch,
1858 option can be used to create a new branch from a pre-rebase state if desired.
1862 is specified, only show commits which at some point in time represented this
1864 Otherwise, list all backed up commits for any branches.
1866 If this option is used,
1868 does not require a work tree.
1869 None of the other options can be used together with
1872 Delete backups created by past rebase operations, represented by references
1874 .Dq refs/got/backup/rebase
1875 reference namespace.
1879 is specified, only delete backups which at some point in time represented
1881 Otherwise, delete all references found within
1882 .Dq refs/got/backup/rebase .
1884 Any commit, tree, tag, and blob objects belonging to deleted backups
1885 remain in the repository and may be removed separately with
1886 Git's garbage collector or
1887 .Cm gotadmin cleanup .
1889 If this option is used,
1891 does not require a work tree.
1892 None of the other options can be used together with
1896 .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
1898 Edit commit history between the work tree's current base commit and
1899 the tip commit of the work tree's current branch.
1903 operation the work tree's current branch must be set with
1905 to the branch which should be edited, unless this branch is already the
1906 current branch of the work tree.
1907 The tip of this branch represents the upper bound (inclusive) of commits
1912 Furthermore, the work tree's base commit
1915 to a point in this branch's commit history where editing should begin.
1916 This commit represents the lower bound (non-inclusive) of commits touched
1921 Editing of commit history is controlled via a
1923 which can be written in an editor based on a template, passed on the
1924 command line, or generated with the
1930 The format of the histedit script is line-based.
1931 Each line in the script begins with a command name, followed by
1932 whitespace and an argument.
1933 For most commands, the expected argument is a commit ID SHA1 hash.
1934 Any remaining text on the line is ignored.
1935 Lines which begin with the
1937 character are ignored entirely.
1939 The available commands are as follows:
1940 .Bl -column YXZ pick-commit
1941 .It pick Ar commit Ta Use the specified commit as it is.
1942 .It edit Ar commit Ta Use the specified commit but once changes have been
1943 merged into the work tree interrupt the histedit operation for amending.
1944 .It fold Ar commit Ta Combine the specified commit with the next commit
1945 listed further below that will be used.
1946 .It drop Ar commit Ta Remove this commit from the edited history.
1947 .It mesg Ar log-message Ta Use the specified single-line log message for
1948 the commit on the previous line.
1949 If the log message argument is left empty, open an editor where a new
1950 log message can be written.
1953 Every commit in the history being edited must be mentioned in the script.
1954 Lines may be re-ordered to change the order of commits in the edited history.
1955 No commit may be listed more than once.
1957 Edited commits are accumulated on a temporary branch which the work tree
1958 will remain switched to throughout the entire histedit operation.
1959 Once history editing has completed successfully, the temporary branch becomes
1960 the new version of the work tree's branch and the work tree is automatically
1963 Old commits in their pre-histedit state are automatically backed up in the
1964 .Dq refs/got/backup/histedit
1965 reference namespace.
1966 As long as these references are not removed older versions of edited
1967 commits will remain in the repository and can be viewed with the
1970 Removal of these references makes objects which become unreachable via
1971 any reference subject to removal by Git's garbage collector or
1972 .Cm gotadmin cleanup .
1974 While merging commits, show the status of each affected file,
1975 using the following status codes:
1976 .Bl -column YXZ description
1977 .It G Ta file was merged
1978 .It C Ta file was merged and conflicts occurred during merge
1979 .It ! Ta changes destined for a missing file were not merged
1980 .It D Ta file was deleted
1981 .It d Ta file's deletion was prevented by local modifications
1982 .It A Ta new file was added
1983 .It \(a~ Ta changes destined for a non-regular file were not merged
1984 .It ? Ta changes destined for an unversioned file were not merged
1987 If merge conflicts occur the histedit operation is interrupted and may
1988 be continued once conflicts have been resolved.
1989 If any files with destined changes are found to be missing or unversioned,
1990 or if files could not be deleted due to differences in deleted content,
1991 the histedit operation will be interrupted to prevent potentially incomplete
1992 changes from being committed to the repository without user intervention.
1993 The work tree may be modified as desired and the histedit operation can be
1994 continued once the changes present in the work tree are considered complete.
1995 Alternatively, the histedit operation may be aborted which will leave
1996 the work tree switched back to its original branch.
1998 If a merge conflict is resolved in a way which renders the merged
1999 change into a no-op change, the corresponding commit will be elided
2000 when the histedit operation continues.
2003 will refuse to run if certain preconditions are not met.
2004 If the work tree's current branch is not in the
2006 reference namespace, the history of the branch may not be edited.
2007 If the work tree contains multiple base commits it must first be updated
2008 to a single base commit with
2010 If changes have been staged with
2012 these changes must first be committed with
2016 If the work tree contains local changes, these changes must first be
2021 If the edited history contains changes to files outside of the work tree's
2022 path prefix, the work tree cannot be used to edit the history of this branch.
2029 commands will refuse to run while a histedit operation is in progress.
2030 Other commands which manipulate the work tree may be used, and the
2032 command may be used to commit arbitrary changes to the temporary branch
2033 while the histedit operation is interrupted.
2040 Abort an interrupted histedit operation.
2041 If this option is used, no other command-line arguments are allowed.
2043 Continue an interrupted histedit operation.
2044 If this option is used, no other command-line arguments are allowed.
2046 Interrupt the histedit operation for editing after merging each commit.
2047 This option is a quick equivalent to a histedit script which uses the
2049 command for all commits.
2052 option can only be used when starting a new histedit operation.
2053 If this option is used, no other command-line arguments are allowed.
2055 Fold all commits into a single commit.
2056 This option is a quick equivalent to a histedit script which folds all
2057 commits, combining them all into one commit.
2060 option can only be used when starting a new histedit operation.
2061 If this option is used, no other command-line arguments are allowed.
2062 .It Fl F Ar histedit-script
2065 instead of opening a temporary file in an editor where a histedit script
2068 Edit log messages only.
2069 This option is a quick equivalent to a histedit script which edits
2070 only log messages but otherwise leaves every picked commit as-is.
2073 option can only be used when starting a new histedit operation.
2074 If this option is used, no other command-line arguments are allowed.
2076 Show a list of past histedit operations, represented by references in the
2077 .Dq refs/got/backup/histedit
2078 reference namespace.
2080 Display the author, date, and log message of each backed up commit,
2081 the object ID of the corresponding post-histedit commit, and
2082 the object ID of their common ancestor commit.
2083 Given these object IDs,
2090 options can be used to examine the history of either version of the branch,
2095 option can be used to create a new branch from a pre-histedit state if desired.
2099 is specified, only show commits which at some point in time represented this
2101 Otherwise, list all backed up commits for any branches.
2103 If this option is used,
2105 does not require a work tree.
2106 None of the other options can be used together with
2109 Delete backups created by past histedit operations, represented by references
2111 .Dq refs/got/backup/histedit
2112 reference namespace.
2116 is specified, only delete backups which at some point in time represented
2118 Otherwise, delete all references found within
2119 .Dq refs/got/backup/histedit .
2121 Any commit, tree, tag, and blob objects belonging to deleted backups
2122 remain in the repository and may be removed separately with
2123 Git's garbage collector or
2124 .Cm gotadmin cleanup .
2126 If this option is used,
2128 does not require a work tree.
2129 None of the other options can be used together with
2133 .It Cm integrate Ar branch
2135 Integrate the specified
2137 into the work tree's current branch.
2138 Files in the work tree are updated to match the contents on the integrated
2140 and the reference of the work tree's branch is changed to point at the
2141 head commit of the integrated
2144 Both branches can be considered equivalent after integration since they
2145 will be pointing at the same commit.
2146 Both branches remain available for future work, if desired.
2147 In case the integrated
2149 is no longer needed it may be deleted with
2152 Show the status of each affected file, using the following status codes:
2153 .Bl -column YXZ description
2154 .It U Ta file was updated
2155 .It D Ta file was deleted
2156 .It A Ta new file was added
2157 .It \(a~ Ta versioned file is obstructed by a non-regular file
2158 .It ! Ta a missing versioned file was restored
2162 will refuse to run if certain preconditions are not met.
2163 Most importantly, the
2165 must have been rebased onto the work tree's current branch with
2167 before it can be integrated, in order to linearize commit history and
2168 resolve merge conflicts.
2169 If the work tree contains multiple base commits it must first be updated
2170 to a single base commit with
2172 If changes have been staged with
2174 these changes must first be committed with
2178 If the work tree contains local changes, these changes must first be
2184 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2186 Create a merge commit based on the current branch of the work tree and
2189 If a linear project history is desired, then use of
2191 should be preferred over
2193 However, even strictly linear projects may require merge commits in order
2194 to merge in new versions of third-party code stored on vendor branches
2198 Merge commits are commits based on multiple parent commits.
2199 The tip commit of the work tree's current branch, which must be set with
2203 operation, will be used as the first parent.
2204 The tip commit of the specified
2206 will be used as the second parent.
2208 No ancestral relationship between the two branches is required.
2209 If the two branches have already been merged previously, only new changes
2212 It is not possible to create merge commits with more than two parents.
2213 If more than one branch needs to be merged, then multiple merge commits
2214 with two parents each can be created in sequence.
2216 While merging changes found on the
2218 into the work tree, show the status of each affected file,
2219 using the following status codes:
2220 .Bl -column YXZ description
2221 .It G Ta file was merged
2222 .It C Ta file was merged and conflicts occurred during merge
2223 .It ! Ta changes destined for a missing file were not merged
2224 .It D Ta file was deleted
2225 .It d Ta file's deletion was prevented by local modifications
2226 .It A Ta new file was added
2227 .It \(a~ Ta changes destined for a non-regular file were not merged
2228 .It ? Ta changes destined for an unversioned file were not merged
2231 If merge conflicts occur, the merge operation is interrupted and conflicts
2232 must be resolved before the merge operation can continue.
2233 If any files with destined changes are found to be missing or unversioned,
2234 or if files could not be deleted due to differences in deleted content,
2235 the merge operation will be interrupted to prevent potentially incomplete
2236 changes from being committed to the repository without user intervention.
2237 The work tree may be modified as desired and the merge can be continued
2238 once the changes present in the work tree are considered complete.
2239 Alternatively, the merge operation may be aborted which will leave
2240 the work tree's current branch unmodified.
2242 If a merge conflict is resolved in a way which renders all merged
2243 changes into no-op changes, the merge operation cannot continue
2244 and must be aborted.
2247 will refuse to run if certain preconditions are not met.
2250 is based on the work tree's current branch, then no merge commit can
2253 may be used to integrate the
2256 If the work tree is not yet fully updated to the tip commit of its
2257 branch, then the work tree must first be updated with
2259 If the work tree contains multiple base commits it must first be updated
2260 to a single base commit with
2262 If changes have been staged with
2264 these changes must first be committed with
2268 If the work tree contains local changes, these changes must first be
2275 contains changes to files outside of the work tree's path prefix,
2276 the work tree cannot be used to merge this branch.
2286 commands will refuse to run while a merge operation is in progress.
2287 Other commands which manipulate the work tree may be used for
2288 conflict resolution purposes.
2295 Abort an interrupted merge operation.
2296 If this option is used, no other command-line arguments are allowed.
2298 Continue an interrupted merge operation.
2299 If this option is used, no other command-line arguments are allowed.
2301 Merge changes into the work tree as usual but do not create a merge
2303 The merge result can be adjusted as desired before a merge commit is
2306 Alternatively, the merge may be aborted with
2310 .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 ...
2312 Stage local changes for inclusion in the next commit.
2315 is specified, stage all changes in the work tree.
2316 Otherwise, stage changes at or within the specified paths.
2317 Paths may be staged if they are added, modified, or deleted according to
2320 Show the status of each affected file, using the following status codes:
2321 .Bl -column YXZ description
2322 .It A Ta file addition has been staged
2323 .It M Ta file modification has been staged
2324 .It D Ta file deletion has been staged
2327 Staged file contents are saved in newly created blob objects in the repository.
2328 These blobs will be referred to by tree objects once staged changes have been
2331 Staged changes affect the behaviour of
2336 While paths with staged changes exist, the
2338 command will refuse to commit any paths which do not have staged changes.
2339 Local changes created on top of staged changes can only be committed if
2340 the path is staged again, or if the staged changes are committed first.
2343 command will show both local changes and staged changes.
2346 command is able to display local changes relative to staged changes,
2347 and to display staged changes relative to the repository.
2350 command cannot revert staged changes but may be used to revert
2351 local changes created on top of staged changes.
2358 Instead of staging new changes, list paths which are already staged,
2359 along with the IDs of staged blob objects and stage status codes.
2360 If paths were provided in the command line show the staged paths
2361 among the specified paths.
2362 Otherwise, show all staged paths.
2364 Instead of staging the entire content of a changed file, interactively
2365 select or reject changes for staging based on
2369 (reject change), and
2371 (quit staging this file) responses.
2372 If a file is in modified status, individual patches derived from the
2373 modified file content can be staged.
2374 Files in added or deleted status may only be staged or rejected in
2376 .It Fl F Ar response-script
2384 responses line-by-line from the specified
2386 file instead of prompting interactively.
2388 Allow staging of symbolic links which point outside of the path space
2389 that is under version control.
2392 will reject such symbolic links due to safety concerns.
2395 may decide to represent such a symbolic link as a regular file which contains
2396 the link's target path, rather than creating an actual symbolic link which
2397 points outside of the work tree.
2398 Use of this option is discouraged because external mechanisms such as
2400 are better suited for managing symbolic links to paths not under
2405 will refuse to run if certain preconditions are not met.
2406 If a file contains merge conflicts, these conflicts must be resolved first.
2407 If a file is found to be out of date relative to the head commit on the
2408 work tree's current branch, the file must be updated with
2410 before it can be staged (however, this does not prevent the file from
2411 becoming out-of-date at some point after having been staged).
2418 commands will refuse to run while staged changes exist.
2419 If staged changes cannot be committed because a staged path
2420 is out of date, the path must be unstaged with
2422 before it can be updated with
2424 and may then be staged again if necessary.
2426 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2428 Merge staged changes back into the work tree and put affected paths
2429 back into non-staged status.
2432 is specified, unstage all staged changes across the entire work tree.
2433 Otherwise, unstage changes at or within the specified paths.
2435 Show the status of each affected file, using the following status codes:
2436 .Bl -column YXZ description
2437 .It G Ta file was unstaged
2438 .It C Ta file was unstaged and conflicts occurred during merge
2439 .It ! Ta changes destined for a missing file were not merged
2440 .It D Ta file was staged as deleted and still is deleted
2441 .It d Ta file's deletion was prevented by local modifications
2442 .It \(a~ Ta changes destined for a non-regular file were not merged
2450 Instead of unstaging the entire content of a changed file, interactively
2451 select or reject changes for unstaging based on
2455 (keep change staged), and
2457 (quit unstaging this file) responses.
2458 If a file is staged in modified status, individual patches derived from the
2459 staged file content can be unstaged.
2460 Files staged in added or deleted status may only be unstaged in their entirety.
2461 .It Fl F Ar response-script
2469 responses line-by-line from the specified
2471 file instead of prompting interactively.
2473 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2474 Parse and print contents of objects to standard output in a line-based
2476 Content of commit, tree, and tag objects is printed in a way similar
2477 to the actual content stored in such objects.
2478 Blob object contents are printed as they would appear in files on disk.
2480 Attempt to interpret each argument as a reference, a tag name, or
2481 an object ID SHA1 hash.
2482 References will be resolved to an object ID.
2483 Tag names will resolved to a tag object.
2484 An abbreviated hash argument will be expanded to a full SHA1 hash
2485 automatically, provided the abbreviation is unique.
2487 If none of the above interpretations produce a valid result, or if the
2489 option is used, attempt to interpret the argument as a path which will
2490 be resolved to the ID of an object found at this path in the repository.
2497 Look up paths in the specified
2499 If this option is not used, paths are looked up in the commit resolved
2500 via the repository's HEAD reference.
2501 The expected argument is a commit ID SHA1 hash or an existing reference
2502 or tag name which will be resolved to a commit ID.
2503 An abbreviated hash argument will be expanded to a full SHA1 hash
2504 automatically, provided the abbreviation is unique.
2505 .It Fl r Ar repository-path
2506 Use the repository at the specified path.
2507 If not specified, assume the repository is located at or above the current
2509 If this directory is a
2511 work tree, use the repository path associated with this work tree.
2513 Interpret all arguments as paths only.
2514 This option can be used to resolve ambiguity in cases where paths
2515 look like tag names, reference names, or object IDs.
2517 .It Cm info Op Ar path ...
2518 Display meta-data stored in a work tree.
2523 The work tree to use is resolved implicitly by walking upwards from the
2524 current working directory.
2528 arguments are specified, show additional per-file information for tracked
2529 files located at or within these paths.
2532 argument corresponds to the work tree's root directory, display information
2533 for all tracked files.
2536 .Bl -tag -width GOT_AUTHOR
2538 The author's name and email address for
2543 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2546 may fail to parse commits without an email address in author data,
2550 environment variables with a missing email address.
2552 .Ev GOT_AUTHOR will be overridden by configuration settings in
2558 configuration settings in the repository's
2565 configuration settings contained in Git's global
2567 configuration file will only be used if neither
2571 environment variable provide author information.
2572 .It Ev VISUAL , EDITOR
2573 The editor spawned by
2581 text editor will be spawned in order to give
2583 the attention it deserves.
2584 .It Ev GOT_LOG_DEFAULT_LIMIT
2585 The default limit on the number of commits traversed by
2587 If set to zero, the limit is unbounded.
2588 This variable will be silently ignored if it is set to a non-numeric value.
2591 .Bl -tag -width packed-refs -compact
2593 Repository-wide configuration settings for
2597 configuration file located in the root directory of a Git repository
2598 supersedes any relevant settings in Git's
2602 .It Pa .got/got.conf
2603 Worktree-specific configuration settings for
2607 configuration file in the
2609 meta-data directory of a work tree supersedes any relevant settings in
2612 configuration file and Git's
2619 Enable tab-completion of
2624 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2626 Clone an existing Git repository for use with
2630 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2632 Use of HTTP URLs currently requires
2636 .Dl $ git clone --bare https://github.com/openbsd/src.git
2638 Alternatively, for quick and dirty local testing of
2640 a new Git repository could be created and populated with files,
2641 e.g. from a temporary CVS checkout located at
2644 .Dl $ got init /var/git/src.git
2645 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2647 Check out a work tree from the Git repository to /usr/src:
2649 .Dl $ got checkout /var/git/src.git /usr/src
2651 View local changes in a work tree directory:
2653 .Dl $ got diff | less
2655 In a work tree, display files in a potentially problematic state:
2657 .Dl $ got status -s 'C!~?'
2659 Interactively revert selected local changes in a work tree directory:
2661 .Dl $ got revert -p -R\ .
2663 In a work tree or a git repository directory, list all branch references:
2667 In a work tree or a git repository directory, create a new branch called
2668 .Dq unified-buffer-cache
2669 which is forked off the
2673 .Dl $ got branch -c master unified-buffer-cache
2675 Switch an existing work tree to the branch
2676 .Dq unified-buffer-cache .
2677 Local changes in the work tree will be preserved and merged if necessary:
2679 .Dl $ got update -b unified-buffer-cache
2681 Create a new commit from local changes in a work tree directory.
2682 This new commit will become the head commit of the work tree's current branch:
2686 In a work tree or a git repository directory, view changes committed in
2687 the 3 most recent commits to the work tree's branch, or the branch resolved
2688 via the repository's HEAD reference, respectively:
2690 .Dl $ got log -p -l 3
2692 As above, but display changes in the order in which
2694 could apply them in sequence:
2696 .Dl $ got log -p -l 3 -R
2698 In a work tree or a git repository directory, log the history of a subdirectory:
2700 .Dl $ got log sys/uvm
2702 While operating inside a work tree, paths are specified relative to the current
2703 working directory, so this command will log the subdirectory
2706 .Dl $ cd sys/uvm && got log\ .
2708 And this command has the same effect:
2710 .Dl $ cd sys/dev/usb && got log ../../uvm
2712 And this command displays work tree meta-data about all tracked files:
2715 .Dl $ got info\ . | less
2717 Add new files and remove obsolete files in a work tree directory:
2719 .Dl $ got add sys/uvm/uvm_ubc.c
2720 .Dl $ got remove sys/uvm/uvm_vnode.c
2722 Create a new commit from local changes in a work tree directory
2723 with a pre-defined log message.
2725 .Dl $ got commit -m 'unify the buffer cache'
2727 Alternatively, create a new commit from local changes in a work tree
2728 directory with a log message that has been prepared in the file
2731 .Dl $ got commit -F /tmp/msg
2733 Update any work tree checked out from the
2734 .Dq unified-buffer-cache
2735 branch to the latest commit on this branch:
2739 Roll file content on the unified-buffer-cache branch back by one commit,
2740 and then fetch the rolled-back change into the work tree as a local change
2741 to be amended and perhaps committed again:
2743 .Dl $ got backout unified-buffer-cache
2744 .Dl $ got commit -m 'roll back previous'
2745 .Dl $ # now back out the previous backout :-)
2746 .Dl $ got backout unified-buffer-cache
2748 Fetch new changes on the remote repository's
2750 branch, making them visible on the local repository's
2757 In a repository created with a HTTP URL and
2758 .Cm git clone --bare
2761 command must be used instead:
2763 .Dl $ cd /var/git/src.git
2764 .Dl $ git fetch origin master:refs/remotes/origin/master
2768 branch to merge the new changes that are now visible on the
2773 .Dl $ got update -b origin/master
2774 .Dl $ got rebase master
2777 .Dq unified-buffer-cache
2778 branch on top of the new head commit of the
2782 .Dl $ got update -b master
2783 .Dl $ got rebase unified-buffer-cache
2785 Create a patch from all changes on the unified-buffer-cache branch.
2786 The patch can be mailed out for review and applied to
2790 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2792 Edit the entire commit history of the
2793 .Dq unified-buffer-cache
2796 .Dl $ got update -b unified-buffer-cache
2797 .Dl $ got update -c master
2800 Before working against existing branches in a repository cloned with
2801 .Cm git clone --bare
2806 must be configured to map all references in the remote repository
2809 namespace of the local repository.
2810 This can be achieved by setting Git's
2811 .Pa remote.origin.fetch
2812 configuration variable to the value
2813 .Dq +refs/heads/*:refs/remotes/origin/*
2818 .Dl $ cd /var/git/repo
2819 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2823 option must be disabled:
2825 .Dl $ cd /var/git/repo
2826 .Dl $ git config remote.origin.mirror false
2828 Alternatively, the following
2830 configuration item can be added manually to the Git repository's
2834 .Dl [remote \&"origin\&"]
2836 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2839 This configuration leaves the local repository's
2841 namespace free for use by local branches checked out with
2843 and, if needed, created with
2846 .Dq refs/remotes/origin
2847 namespace can now be updated with incoming changes from the remote
2852 without extra command line arguments.
2853 Newly fetched changes can be examined with
2856 Display changes on the remote repository's version of the
2858 branch, as of the last time
2862 .Dl $ got log -c origin/master | less
2864 As shown here, most commands accept abbreviated reference names such as
2867 .Dq refs/remotes/origin/master .
2868 The latter is only needed in case of ambiguity.
2871 must be used to merge changes which are visible on the
2876 This will also merge local changes, if any, with the incoming changes:
2878 .Dl $ got update -b origin/master
2879 .Dl $ got rebase master
2881 In order to make changes committed to the
2882 .Dq unified-buffer-cache
2886 .Dq unified-buffer-cache
2887 branch must first be rebased onto the
2891 .Dl $ got update -b master
2892 .Dl $ got rebase unified-buffer-cache
2895 .Dq unified-buffer-cache
2896 branch can now be made visible on the
2900 Because the rebase operation switched the work tree to the
2901 .Dq unified-buffer-cache
2902 branch the work tree must be switched back to the
2906 .Dl $ got update -b master
2907 .Dl $ got integrate unified-buffer-cache
2911 branch, log messages for local changes can now be amended with
2913 by other developers and any other important new information:
2915 .Dl $ got update -c origin/master
2916 .Dl $ got histedit -m
2918 If the remote repository offers write access local changes on the
2920 branch can be sent to the remote repository with
2924 can be run without further arguments.
2925 The arguments shown here match defaults, provided the work tree's
2926 current branch is the
2930 .Dl $ got send -b master origin
2932 If the remote repository requires the HTTPS protocol the
2934 command must be used instead:
2936 .Dl $ cd /var/git/src.git
2937 .Dl $ git push origin master
2941 .Xr git-repository 5 ,
2942 .Xr got-worktree 5 ,
2945 .An Stefan Sperling Aq Mt stsp@openbsd.org
2946 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2947 .An Joshua Stein Aq Mt jcs@openbsd.org
2948 .An Ori Bernstein Aq Mt ori@openbsd.org
2951 is a work-in-progress and some features remain to be implemented.
2953 At present, the user has to fall back on
2955 to perform some tasks.
2959 Reading from remote repositories over HTTP or HTTPS protocols requires
2964 Writing to remote repositories over HTTP or HTTPS protocols requires
2967 The creation of merge commits with more than two parent commits requires
2970 In situations where files or directories were moved around
2972 will not automatically merge changes to new locations and
2974 will usually produce better results.
