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 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.
805 Cannot be used with the
809 Display the list of file paths changed in each commit, using the following
811 .Bl -column YXZ description
812 .It M Ta modified file
813 .It D Ta file was deleted
814 .It A Ta new file was added
815 .It m Ta modified file modes (executable bit only)
818 Cannot be used with the
822 Display a short one-line summary of each commit, instead of the default
824 The one-line format prints the beginning of the SHA1 hash of each commit,
825 followed by a space and the first line of the log message.
826 Cannot be used together with the
831 .It Fl S Ar search-pattern
832 If specified, show only commits with a log message matched by the extended
835 When used together with
837 then the file paths changed by a commit can be matched as well.
838 Regular expression syntax is documented in
840 .It Fl r Ar repository-path
841 Use the repository at the specified path.
842 If not specified, assume the repository is located at or above the current
844 If this directory is a
846 work tree, use the repository path associated with this work tree.
848 Determine a set of commits to display as usual, but display these commits
851 Stop traversing commit history immediately after the specified
854 This option has no effect if the specified
859 .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 ...
861 When invoked within a work tree without any arguments, display all
862 local changes in the work tree.
865 arguments are specified, only show changes within the specified paths.
867 If two arguments are provided, treat each argument as a reference, a tag
868 name, or an object ID SHA1 hash, and display differences between the
869 corresponding objects.
870 Both objects must be of the same type (blobs, trees, or commits).
871 An abbreviated hash argument will be expanded to a full SHA1 hash
872 automatically, provided the abbreviation is unique.
873 If none of these interpretations produce a valid result or if the
878 is running in a work tree, attempt to interpret the two arguments as paths.
885 Treat file contents as ASCII text even if binary data is detected.
887 Show differences between commits in the repository.
888 This options may be used up to two times.
889 When used only once, show differences between the specified
891 and its first parent commit.
892 When used twice, show differences between the two specified commits.
894 The expected argument is a commit ID SHA1 hash or an existing reference
895 or tag name which will be resolved to a commit ID.
896 An abbreviated hash argument will be expanded to a full SHA1 hash
897 automatically, provided the abbreviation is unique.
901 option is used, all non-option arguments will be interpreted as paths.
904 arguments are provided, only show differences for the specified paths.
906 Cannot be used together with the
910 Set the number of context lines shown in the diff.
911 By default, 3 lines of context are shown.
912 .It Fl r Ar repository-path
913 Use the repository at the specified path.
914 If not specified, assume the repository is located at or above the current
916 If this directory is a
918 work tree, use the repository path associated with this work tree.
920 Show changes staged with
922 instead of showing local changes in the work tree.
923 This option is only valid when
925 is invoked in a work tree.
927 Interpret all arguments as paths only.
928 This option can be used to resolve ambiguity in cases where paths
929 look like tag names, reference names, or object IDs.
930 This option is only valid when
932 is invoked in a work tree.
934 Ignore whitespace-only changes.
937 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
939 Display line-by-line history of a file at the specified path.
946 Start traversing history at the specified
948 The expected argument is a commit ID SHA1 hash or an existing reference
949 or tag name which will be resolved to a commit ID.
950 An abbreviated hash argument will be expanded to a full SHA1 hash
951 automatically, provided the abbreviation is unique.
952 .It Fl r Ar repository-path
953 Use the repository at the specified path.
954 If not specified, assume the repository is located at or above the current
956 If this directory is a
958 work tree, use the repository path associated with this work tree.
961 .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
963 Display a listing of files and directories at the specified
964 directory path in the repository.
965 Entries shown in this listing may carry one of the following trailing
967 .Bl -column YXZ description
968 .It @ Ta entry is a symbolic link
969 .It / Ta entry is a directory
970 .It * Ta entry is an executable file
971 .It $ Ta entry is a Git submodule
974 Symbolic link entries are also annotated with the target path of the link.
978 is specified, list the repository path corresponding to the current
979 directory of the work tree, or the root directory of the repository
980 if there is no work tree.
987 List files and directories as they appear in the specified
989 The expected argument is a commit ID SHA1 hash or an existing reference
990 or tag name which will be resolved to a commit ID.
991 An abbreviated hash argument will be expanded to a full SHA1 hash
992 automatically, provided the abbreviation is unique.
993 .It Fl r Ar repository-path
994 Use the repository at the specified path.
995 If not specified, assume the repository is located at or above the current
997 If this directory is a
999 work tree, use the repository path associated with this work tree.
1001 Show object IDs of files (blob objects) and directories (tree objects).
1003 Recurse into sub-directories in the repository.
1005 .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
1006 Manage references in a repository.
1008 References may be listed, created, deleted, and changed.
1009 When creating, deleting, or changing a reference the specified
1011 must be an absolute reference name, i.e. it must begin with
1018 .It Fl r Ar repository-path
1019 Use the repository at the specified path.
1020 If not specified, assume the repository is located at or above the current
1022 If this directory is a
1024 work tree, use the repository path associated with this work tree.
1026 List references in the repository.
1029 is specified, list all existing references in the repository.
1032 is a reference namespace, list all references in this namespace.
1033 Otherwise, show only the reference with the given
1035 Cannot be used together with any other options except
1040 Sort listed references by modification time (most recently modified first)
1041 instead of sorting by lexicographical order.
1042 Use of this option requires the
1044 option to be used as well.
1046 Create a reference or change an existing reference.
1047 The reference with the specified
1049 will point at the specified
1053 argument is a ID SHA1 hash or an existing reference or tag name which will
1054 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1055 Cannot be used together with any other options except
1057 .It Fl s Ar reference
1058 Create a symbolic reference, or change an existing symbolic reference.
1059 The symbolic reference with the specified
1061 will point at the specified
1063 which must already exist in the repository.
1064 Care should be taken not to create loops between references when
1065 this option is used.
1066 Cannot be used together with any other options except
1069 Delete the reference with the specified
1071 from the repository.
1072 Any commit, tree, tag, and blob objects belonging to deleted references
1073 remain in the repository and may be removed separately with
1074 Git's garbage collector or
1075 .Cm gotadmin cleanup .
1076 Cannot be used together with any other options except
1080 .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
1082 Create, list, or delete branches.
1084 Local branches are managed via references which live in the
1086 reference namespace.
1089 command creates references in this namespace only.
1091 When deleting branches, the specified
1095 reference namespace first.
1096 If no corresponding branch is found, the
1098 namespace will be searched next.
1100 If invoked in a work tree without any arguments, print the name of the
1101 work tree's current branch.
1105 argument is passed, attempt to create a branch reference with the given name.
1106 By default the new branch reference will point at the latest commit on the
1107 work tree's current branch if invoked in a work tree, and otherwise to a commit
1108 resolved via the repository's HEAD reference.
1110 If invoked in a work tree, once the branch was created successfully
1111 switch the work tree's head reference to the newly created branch and
1112 update files across the entire work tree, just like
1113 .Cm got update -b Ar name
1115 Show the status of each affected file, using the following status codes:
1116 .Bl -column YXZ description
1117 .It U Ta file was updated and contained no local changes
1118 .It G Ta file was updated and local changes were merged cleanly
1119 .It C Ta file was updated and conflicts occurred during merge
1120 .It D Ta file was deleted
1121 .It A Ta new file was added
1122 .It \(a~ Ta versioned file is obstructed by a non-regular file
1123 .It ! Ta a missing versioned file was restored
1131 Make a newly created branch reference point at the specified
1135 argument is a commit ID SHA1 hash or an existing reference
1136 or tag name which will be resolved to a commit ID.
1137 .It Fl r Ar repository-path
1138 Use the repository at the specified path.
1139 If not specified, assume the repository is located at or above the current
1141 If this directory is a
1143 work tree, use the repository path associated with this work tree.
1145 List all existing branches in the repository, including copies of remote
1146 repositories' branches in the
1148 reference namespace.
1150 If invoked in a work tree, the work tree's current branch is shown
1151 with one the following annotations:
1152 .Bl -column YXZ description
1153 .It * Ta work tree's base commit matches the branch tip
1154 .It \(a~ Ta work tree's base commit is out-of-date
1157 Sort listed branches by modification time (most recently modified first)
1158 instead of sorting by lexicographical order.
1161 reference namespace are listed before branches in
1164 Use of this option requires the
1166 option to be used as well.
1168 Delete the branch with the specified
1174 reference namespace.
1176 Only the branch reference is deleted.
1177 Any commit, tree, and blob objects belonging to the branch
1178 remain in the repository and may be removed separately with
1179 Git's garbage collector or
1180 .Cm gotadmin cleanup .
1182 Do not switch and update the work tree after creating a new branch.
1184 .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
1185 Manage tags in a repository.
1187 Tags are managed via references which live in the
1189 reference namespace.
1192 command operates on references in this namespace only.
1193 References in this namespace point at tag objects which contain a pointer
1194 to another object, a tag message, as well as author and timestamp information.
1196 Attempt to create a tag with the given
1198 and make this tag point at the given
1200 If no commit is specified, default to the latest commit on the work tree's
1201 current branch if invoked in a work tree, and to a commit resolved via
1202 the repository's HEAD reference otherwise.
1209 Make the newly created tag reference point at the specified
1213 argument is a commit ID SHA1 hash or an existing reference or tag name which
1214 will be resolved to a commit ID.
1215 An abbreviated hash argument will be expanded to a full SHA1 hash
1216 automatically, provided the abbreviation is unique.
1218 Use the specified tag message when creating the new tag.
1223 opens a temporary file in an editor where a tag message can be written.
1224 .It Fl r Ar repository-path
1225 Use the repository at the specified path.
1226 If not specified, assume the repository is located at or above the current
1228 If this directory is a
1230 work tree, use the repository path associated with this work tree.
1232 List all existing tags in the repository instead of creating a new tag.
1233 If this option is used, no other command-line arguments are allowed.
1238 command will not delete tags or change existing tags.
1239 If a tag must be deleted, the
1241 command may be used to delete a tag's reference.
1242 This should only be done if the tag has not already been copied to
1244 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1245 Schedule unversioned files in a work tree for addition to the
1246 repository in the next commit.
1247 By default, files which match a
1249 ignore pattern will not be added.
1256 Permit recursion into directories.
1257 If this option is not specified,
1259 will refuse to run if a specified
1263 Add files even if they match a
1268 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1270 Remove versioned files from a work tree and schedule them for deletion
1271 from the repository in the next commit.
1278 Perform the operation even if a file contains local modifications,
1279 and do not raise an error if a specified
1281 does not exist on disk.
1283 Keep affected files on disk.
1285 Permit recursion into directories.
1286 If this option is not specified,
1288 will refuse to run if a specified
1291 .It Fl s Ar status-codes
1292 Only delete files with a modification status matching one of the
1293 single-character status codes contained in the
1296 The following status codes may be specified:
1297 .Bl -column YXZ description
1298 .It M Ta modified file (this implies the
1301 .It ! Ta versioned file expected on disk but missing
1305 .It Cm patch Oo Fl n Oc Oo Fl p Ar strip-count Oc Oo Fl R Oc Op Ar patchfile
1309 to files in a work tree.
1310 Files added or removed by a patch will be scheduled for addition or removal in
1313 The patch must be in the unified diff format as produced by
1320 diff when invoked with their
1325 argument is provided, read unified diff data from standard input instead.
1329 contains multiple patches, then attempt to apply each of them in sequence.
1331 Show the status of each affected file, using the following status codes:
1332 .Bl -column XYZ description
1333 .It M Ta file was modified
1334 .It D Ta file was deleted
1335 .It A Ta file was added
1336 .It # Ta failed to patch the file
1339 If a change does not match at its exact line number, attempt to
1340 apply it somewhere else in the file if a good spot can be found.
1341 Otherwise, the patch will fail to apply.
1345 will refuse to apply a patch if certain preconditions are not met.
1346 Files to be deleted must already be under version control, and must
1347 not have been scheduled for deletion already.
1348 Files to be added must not yet be under version control and must not
1349 already be present on disk.
1350 Files to be modified must already be under version control and may not
1351 contain conflict markers.
1353 If an error occurs, the
1355 operation will be aborted.
1356 Any changes made to the work tree up to this point will be left behind.
1357 Such changes can be viewed with
1359 and can be reverted with
1368 Do not make any modifications to the work tree.
1369 This can be used to check whether a patch would apply without issues.
1372 contains diffs that affect the same file multiple times, the results
1373 displayed may be incorrect.
1374 .It Fl p Ar strip-count
1375 Specify the number of leading path components to strip from paths
1384 path prefixes generated by
1386 will be recognized and stripped automatically.
1388 Reverse the patch before applying it.
1391 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1393 Revert any local changes in files at the specified paths in a work tree.
1394 File contents will be overwritten with those contained in the
1395 work tree's base commit.
1396 There is no way to bring discarded changes back after
1399 If a file was added with
1401 it will become an unversioned file again.
1402 If a file was deleted with
1404 it will be restored.
1411 Instead of reverting all changes in files, interactively select or reject
1412 changes to revert based on
1418 (quit reverting this file) responses.
1419 If a file is in modified status, individual patches derived from the
1420 modified file content can be reverted.
1421 Files in added or deleted status may only be reverted in their entirety.
1422 .It Fl F Ar response-script
1430 responses line-by-line from the specified
1432 file instead of prompting interactively.
1434 Permit recursion into directories.
1435 If this option is not specified,
1437 will refuse to run if a specified
1442 .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 ...
1444 Create a new commit in the repository from changes in a work tree
1445 and use this commit as the new base commit for the work tree.
1448 is specified, commit all changes in the work tree.
1449 Otherwise, commit changes at or within the specified paths.
1451 If changes have been explicitly staged for commit with
1453 only commit staged changes and reject any specified paths which
1454 have not been staged.
1457 opens a temporary file in an editor where a log message can be written
1465 options are used together.
1467 Show the status of each affected file, using the following status codes:
1468 .Bl -column YXZ description
1469 .It M Ta modified file
1470 .It D Ta file was deleted
1471 .It A Ta new file was added
1472 .It m Ta modified file modes (executable bit only)
1475 Files which are not part of the new commit will retain their previously
1476 recorded base commit.
1479 commands may refuse to run while the work tree contains files from
1480 multiple base commits.
1481 The base commit of such a work tree can be made consistent by running
1483 across the entire work tree.
1487 command requires the
1489 environment variable to be set,
1490 unless an author has been configured in
1496 configuration settings can be
1497 obtained from the repository's
1499 file or from Git's global
1508 Use the prepared log message stored in the file found at
1510 when creating the new commit.
1512 opens a temporary file in an editor where the prepared log message can be
1513 reviewed and edited further if needed.
1514 Cannot be used together with the
1518 Use the specified log message when creating the new commit.
1519 Cannot be used together with the
1523 This option prevents
1525 from opening the commit message in an editor.
1526 It has no effect unless it is used together with the
1528 option and is intended for non-interactive use such as scripting.
1530 Allow the addition of symbolic links which point outside of the path space
1531 that is under version control.
1534 will reject such symbolic links due to safety concerns.
1537 may decide to represent such a symbolic link as a regular file which contains
1538 the link's target path, rather than creating an actual symbolic link which
1539 points outside of the work tree.
1540 Use of this option is discouraged because external mechanisms such as
1542 are better suited for managing symbolic links to paths not under
1547 will refuse to run if certain preconditions are not met.
1548 If the work tree's current branch is not in the
1550 reference namespace, new commits may not be created on this branch.
1551 Local changes may only be committed if they are based on file content
1552 found in the most recent commit on the work tree's branch.
1553 If a path is found to be out of date,
1555 must be used first in order to merge local changes with changes made
1558 .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
1560 Send new changes to a remote repository.
1562 .Ar remote-repository
1566 The remote repository's URL is obtained from the corresponding entry in
1570 file of the local repository, as created by
1573 All objects corresponding to new changes will be written to a temporary
1574 pack file which is then uploaded to the server.
1575 Upon success, references in the
1577 reference namespace of the local repository will be updated to point at
1578 the commits which have been sent.
1580 By default, changes will only be sent if they are based on up-to-date
1581 copies of relevant branches in the remote repository.
1582 If any changes to be sent are based on out-of-date copies or would
1583 otherwise break linear history of existing branches, new changes must
1584 be fetched from the server with
1586 and local branches must be rebased with
1593 option can be used to make exceptions to these requirements.
1600 Send all branches from the local repository's
1602 reference namespace.
1605 option is equivalent to listing all branches with multiple
1608 Cannot be used together with the
1614 from the local repository's
1616 reference namespace.
1617 This option may be specified multiple times to build a list of branches
1619 If this option is not specified, default to the work tree's current branch
1620 if invoked in a work tree, or to the repository's HEAD reference.
1621 Cannot be used together with the
1625 Delete the specified
1627 from the remote repository's
1629 reference namespace.
1630 This option may be specified multiple times to build a list of branches
1633 Only references are deleted.
1634 Any commit, tree, tag, and blob objects belonging to deleted branches
1635 may become subject to deletion by Git's garbage collector running on
1638 Requesting deletion of branches results in an error if the server
1639 does not support this feature or disallows the deletion of branches
1640 based on its configuration.
1642 Attempt to force the server to overwrite existing branches or tags
1643 in the remote repository, even when
1647 would usually be required before changes can be sent.
1648 The server may reject forced requests regardless, depending on its
1651 Any commit, tree, tag, and blob objects belonging to overwritten branches
1652 or tags may become subject to deletion by Git's garbage collector running
1657 reference namespace is globally shared between all repositories.
1660 option to overwrite tags is discouraged because it can lead to
1661 inconsistencies between the tags present in different repositories.
1662 In general, creating a new tag with a different name is recommended
1663 instead of overwriting an existing tag.
1667 option is particularly discouraged if changes being sent are based
1668 on an out-of-date copy of a branch in the remote repository.
1669 Instead of using the
1671 option, new changes should
1674 and local branches should be rebased with
1676 followed by another attempt to send the changes.
1680 option should only be needed in situations where the remote repository's
1681 copy of a branch or tag is known to be out-of-date and is considered
1683 The risks of creating inconsistencies between different repositories
1684 should also be taken into account.
1685 .It Fl r Ar repository-path
1686 Use the repository at the specified path.
1687 If not specified, assume the repository is located at or above the current
1689 If this directory is a
1691 work tree, use the repository path associated with this work tree.
1695 from the local repository's
1697 reference namespace, in addition to any branches that are being sent.
1700 option may be specified multiple times to build a list of tags to send.
1701 No tags will be sent if the
1705 Raise an error if the specified
1707 already exists in the remote repository, unless the
1709 option is used to overwrite the server's copy of the tag.
1710 In general, creating a new tag with a different name is recommended
1711 instead of overwriting an existing tag.
1713 Cannot be used together with the
1717 Attempt to send all tags from the local repository's
1719 reference namespace.
1722 option is equivalent to listing all tags with multiple
1725 Cannot be used together with the
1729 Suppress progress reporting output.
1730 The same option will be passed to
1737 to print debugging messages to standard error output.
1738 The same option will be passed to
1741 Multiple -v options increase the verbosity.
1745 .It Cm cherrypick Ar commit
1747 Merge changes from a single
1752 should be on a different branch than the work tree's base commit.
1753 The expected argument is a reference or a commit ID SHA1 hash.
1754 An abbreviated hash argument will be expanded to a full SHA1 hash
1755 automatically, provided the abbreviation is unique.
1757 Show the status of each affected file, using the following status codes:
1758 .Bl -column YXZ description
1759 .It G Ta file was merged
1760 .It C Ta file was merged and conflicts occurred during merge
1761 .It ! Ta changes destined for a missing file were not merged
1762 .It D Ta file was deleted
1763 .It d Ta file's deletion was prevented by local modifications
1764 .It A Ta new file was added
1765 .It \(a~ Ta changes destined for a non-regular file were not merged
1766 .It ? Ta changes destined for an unversioned file were not merged
1769 The merged changes will appear as local changes in the work tree, which
1772 amended manually or with further
1777 or discarded again with
1781 will refuse to run if certain preconditions are not met.
1782 If the work tree contains multiple base commits, it must first be updated
1783 to a single base commit with
1785 If any relevant files already contain merge conflicts, these
1786 conflicts must be resolved first.
1788 .It Cm backout Ar commit
1790 Reverse-merge changes from a single
1795 should be on the same branch as the work tree's base commit.
1796 The expected argument is a reference or a commit ID SHA1 hash.
1797 An abbreviated hash argument will be expanded to a full SHA1 hash
1798 automatically, provided the abbreviation is unique.
1800 Show the status of each affected file, using the following status codes:
1801 .Bl -column YXZ description
1802 .It G Ta file was merged
1803 .It C Ta file was merged and conflicts occurred during merge
1804 .It ! Ta changes destined for a missing file were not merged
1805 .It D Ta file was deleted
1806 .It d Ta file's deletion was prevented by local modifications
1807 .It A Ta new file was added
1808 .It \(a~ Ta changes destined for a non-regular file were not merged
1809 .It ? Ta changes destined for an unversioned file were not merged
1812 The reverse-merged changes will appear as local changes in the work tree,
1813 which may be viewed with
1815 amended manually or with further
1820 or discarded again with
1824 will refuse to run if certain preconditions are not met.
1825 If the work tree contains multiple base commits, it must first be updated
1826 to a single base commit with
1828 If any relevant files already contain merge conflicts, these
1829 conflicts must be resolved first.
1831 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1833 Rebase commits on the specified
1835 onto the tip of the current branch of the work tree.
1838 must share common ancestry with the work tree's current branch.
1839 Rebasing begins with the first descendant commit of the youngest
1840 common ancestor commit shared by the specified
1842 and the work tree's current branch, and stops once the tip commit
1849 is used as intended, the specified
1851 represents a local commit history and may already contain changes
1852 that are not yet visible in any other repositories.
1853 The work tree's current branch, which must be set with
1857 operation, represents a branch from a remote repository which shares
1858 a common history with the specified
1860 but has progressed, and perhaps diverged, due to commits added to the
1863 Rebased commits are accumulated on a temporary branch which the work tree
1864 will remain switched to throughout the entire rebase operation.
1865 Commits on this branch represent the same changes with the same log
1866 messages as their counterparts on the original
1868 but with different commit IDs.
1869 Once rebasing has completed successfully, the temporary branch becomes
1870 the new version of the specified
1872 and the work tree is automatically switched to it.
1874 Old commits in their pre-rebase state are automatically backed up in the
1875 .Dq refs/got/backup/rebase
1876 reference namespace.
1877 As long as these references are not removed older versions of rebased
1878 commits will remain in the repository and can be viewed with the
1881 Removal of these references makes objects which become unreachable via
1882 any reference subject to removal by Git's garbage collector or
1883 .Cm gotadmin cleanup .
1885 While rebasing commits, show the status of each affected file,
1886 using the following status codes:
1887 .Bl -column YXZ description
1888 .It G Ta file was merged
1889 .It C Ta file was merged and conflicts occurred during merge
1890 .It ! Ta changes destined for a missing file were not merged
1891 .It D Ta file was deleted
1892 .It d Ta file's deletion was prevented by local modifications
1893 .It A Ta new file was added
1894 .It \(a~ Ta changes destined for a non-regular file were not merged
1895 .It ? Ta changes destined for an unversioned file were not merged
1898 If merge conflicts occur, the rebase operation is interrupted and may
1899 be continued once conflicts have been resolved.
1900 If any files with destined changes are found to be missing or unversioned,
1901 or if files could not be deleted due to differences in deleted content,
1902 the rebase operation will be interrupted to prevent potentially incomplete
1903 changes from being committed to the repository without user intervention.
1904 The work tree may be modified as desired and the rebase operation can be
1905 continued once the changes present in the work tree are considered complete.
1906 Alternatively, the rebase operation may be aborted which will leave
1908 unmodified and the work tree switched back to its original branch.
1910 If a merge conflict is resolved in a way which renders the merged
1911 change into a no-op change, the corresponding commit will be elided
1912 when the rebase operation continues.
1915 will refuse to run if certain preconditions are not met.
1916 If the work tree is not yet fully updated to the tip commit of its
1917 branch, then the work tree must first be updated with
1919 If changes have been staged with
1921 these changes must first be committed with
1925 If the work tree contains local changes, these changes must first be
1932 contains changes to files outside of the work tree's path prefix,
1933 the work tree cannot be used to rebase this branch.
1939 commands will refuse to run while a rebase operation is in progress.
1940 Other commands which manipulate the work tree may be used for
1941 conflict resolution purposes.
1945 is already based on the work tree's current branch, then no commits
1946 need to be rebased and
1948 will simply switch the work tree to the specified
1950 and update files in the work tree accordingly.
1957 Abort an interrupted rebase operation.
1958 If this option is used, no other command-line arguments are allowed.
1960 Continue an interrupted rebase operation.
1961 If this option is used, no other command-line arguments are allowed.
1963 Show a list of past rebase operations, represented by references in the
1964 .Dq refs/got/backup/rebase
1965 reference namespace.
1967 Display the author, date, and log message of each backed up commit,
1968 the object ID of the corresponding post-rebase commit, and
1969 the object ID of their common ancestor commit.
1970 Given these object IDs,
1977 options can be used to examine the history of either version of the branch,
1982 option can be used to create a new branch from a pre-rebase state if desired.
1986 is specified, only show commits which at some point in time represented this
1988 Otherwise, list all backed up commits for any branches.
1990 If this option is used,
1992 does not require a work tree.
1993 None of the other options can be used together with
1996 Delete backups created by past rebase operations, represented by references
1998 .Dq refs/got/backup/rebase
1999 reference namespace.
2003 is specified, only delete backups which at some point in time represented
2005 Otherwise, delete all references found within
2006 .Dq refs/got/backup/rebase .
2008 Any commit, tree, tag, and blob objects belonging to deleted backups
2009 remain in the repository and may be removed separately with
2010 Git's garbage collector or
2011 .Cm gotadmin cleanup .
2013 If this option is used,
2015 does not require a work tree.
2016 None of the other options can be used together with
2020 .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
2022 Edit commit history between the work tree's current base commit and
2023 the tip commit of the work tree's current branch.
2027 operation, the work tree's current branch must be set with
2029 to the branch which should be edited, unless this branch is already the
2030 current branch of the work tree.
2031 The tip of this branch represents the upper bound (inclusive) of commits
2036 Furthermore, the work tree's base commit
2039 to a point in this branch's commit history where editing should begin.
2040 This commit represents the lower bound (non-inclusive) of commits touched
2045 Editing of commit history is controlled via a
2047 which can be written in an editor based on a template, passed on the
2048 command line, or generated with the
2054 The format of the histedit script is line-based.
2055 Each line in the script begins with a command name, followed by
2056 whitespace and an argument.
2057 For most commands, the expected argument is a commit ID SHA1 hash.
2058 Any remaining text on the line is ignored.
2059 Lines which begin with the
2061 character are ignored entirely.
2063 The available commands are as follows:
2064 .Bl -column YXZ pick-commit
2065 .It pick Ar commit Ta Use the specified commit as it is.
2066 .It edit Ar commit Ta Use the specified commit but once changes have been
2067 merged into the work tree interrupt the histedit operation for amending.
2068 .It fold Ar commit Ta Combine the specified commit with the next commit
2069 listed further below that will be used.
2070 .It drop Ar commit Ta Remove this commit from the edited history.
2071 .It mesg Ar log-message Ta Use the specified single-line log message for
2072 the commit on the previous line.
2073 If the log message argument is left empty, open an editor where a new
2074 log message can be written.
2077 Every commit in the history being edited must be mentioned in the script.
2078 Lines may be re-ordered to change the order of commits in the edited history.
2079 No commit may be listed more than once.
2081 Edited commits are accumulated on a temporary branch which the work tree
2082 will remain switched to throughout the entire histedit operation.
2083 Once history editing has completed successfully, the temporary branch becomes
2084 the new version of the work tree's branch and the work tree is automatically
2087 Old commits in their pre-histedit state are automatically backed up in the
2088 .Dq refs/got/backup/histedit
2089 reference namespace.
2090 As long as these references are not removed older versions of edited
2091 commits will remain in the repository and can be viewed with the
2094 Removal of these references makes objects which become unreachable via
2095 any reference subject to removal by Git's garbage collector or
2096 .Cm gotadmin cleanup .
2098 While merging commits, show the status of each affected file,
2099 using the following status codes:
2100 .Bl -column YXZ description
2101 .It G Ta file was merged
2102 .It C Ta file was merged and conflicts occurred during merge
2103 .It ! Ta changes destined for a missing file were not merged
2104 .It D Ta file was deleted
2105 .It d Ta file's deletion was prevented by local modifications
2106 .It A Ta new file was added
2107 .It \(a~ Ta changes destined for a non-regular file were not merged
2108 .It ? Ta changes destined for an unversioned file were not merged
2111 If merge conflicts occur, the histedit operation is interrupted and may
2112 be continued once conflicts have been resolved.
2113 If any files with destined changes are found to be missing or unversioned,
2114 or if files could not be deleted due to differences in deleted content,
2115 the histedit operation will be interrupted to prevent potentially incomplete
2116 changes from being committed to the repository without user intervention.
2117 The work tree may be modified as desired and the histedit operation can be
2118 continued once the changes present in the work tree are considered complete.
2119 Alternatively, the histedit operation may be aborted which will leave
2120 the work tree switched back to its original branch.
2122 If a merge conflict is resolved in a way which renders the merged
2123 change into a no-op change, the corresponding commit will be elided
2124 when the histedit operation continues.
2127 will refuse to run if certain preconditions are not met.
2128 If the work tree's current branch is not in the
2130 reference namespace, the history of the branch may not be edited.
2131 If the work tree contains multiple base commits, it must first be updated
2132 to a single base commit with
2134 If changes have been staged with
2136 these changes must first be committed with
2140 If the work tree contains local changes, these changes must first be
2145 If the edited history contains changes to files outside of the work tree's
2146 path prefix, the work tree cannot be used to edit the history of this branch.
2153 commands will refuse to run while a histedit operation is in progress.
2154 Other commands which manipulate the work tree may be used, and the
2156 command may be used to commit arbitrary changes to the temporary branch
2157 while the histedit operation is interrupted.
2164 Abort an interrupted histedit operation.
2165 If this option is used, no other command-line arguments are allowed.
2167 Continue an interrupted histedit operation.
2168 If this option is used, no other command-line arguments are allowed.
2170 Interrupt the histedit operation for editing after merging each commit.
2171 This option is a quick equivalent to a histedit script which uses the
2173 command for all commits.
2176 option can only be used when starting a new histedit operation.
2177 If this option is used, no other command-line arguments are allowed.
2179 Fold all commits into a single commit.
2180 This option is a quick equivalent to a histedit script which folds all
2181 commits, combining them all into one commit.
2184 option can only be used when starting a new histedit operation.
2185 If this option is used, no other command-line arguments are allowed.
2186 .It Fl F Ar histedit-script
2189 instead of opening a temporary file in an editor where a histedit script
2192 Edit log messages only.
2193 This option is a quick equivalent to a histedit script which edits
2194 only log messages but otherwise leaves every picked commit as-is.
2197 option can only be used when starting a new histedit operation.
2198 If this option is used, no other command-line arguments are allowed.
2200 Show a list of past histedit operations, represented by references in the
2201 .Dq refs/got/backup/histedit
2202 reference namespace.
2204 Display the author, date, and log message of each backed up commit,
2205 the object ID of the corresponding post-histedit commit, and
2206 the object ID of their common ancestor commit.
2207 Given these object IDs,
2214 options can be used to examine the history of either version of the branch,
2219 option can be used to create a new branch from a pre-histedit state if desired.
2223 is specified, only show commits which at some point in time represented this
2225 Otherwise, list all backed up commits for any branches.
2227 If this option is used,
2229 does not require a work tree.
2230 None of the other options can be used together with
2233 Delete backups created by past histedit operations, represented by references
2235 .Dq refs/got/backup/histedit
2236 reference namespace.
2240 is specified, only delete backups which at some point in time represented
2242 Otherwise, delete all references found within
2243 .Dq refs/got/backup/histedit .
2245 Any commit, tree, tag, and blob objects belonging to deleted backups
2246 remain in the repository and may be removed separately with
2247 Git's garbage collector or
2248 .Cm gotadmin cleanup .
2250 If this option is used,
2252 does not require a work tree.
2253 None of the other options can be used together with
2257 .It Cm integrate Ar branch
2259 Integrate the specified
2261 into the work tree's current branch.
2262 Files in the work tree are updated to match the contents on the integrated
2264 and the reference of the work tree's branch is changed to point at the
2265 head commit of the integrated
2268 Both branches can be considered equivalent after integration since they
2269 will be pointing at the same commit.
2270 Both branches remain available for future work, if desired.
2271 In case the integrated
2273 is no longer needed it may be deleted with
2276 Show the status of each affected file, using the following status codes:
2277 .Bl -column YXZ description
2278 .It U Ta file was updated
2279 .It D Ta file was deleted
2280 .It A Ta new file was added
2281 .It \(a~ Ta versioned file is obstructed by a non-regular file
2282 .It ! Ta a missing versioned file was restored
2286 will refuse to run if certain preconditions are not met.
2287 Most importantly, the
2289 must have been rebased onto the work tree's current branch with
2291 before it can be integrated, in order to linearize commit history and
2292 resolve merge conflicts.
2293 If the work tree contains multiple base commits, it must first be updated
2294 to a single base commit with
2296 If changes have been staged with
2298 these changes must first be committed with
2302 If the work tree contains local changes, these changes must first be
2308 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2310 Create a merge commit based on the current branch of the work tree and
2313 If a linear project history is desired, then use of
2315 should be preferred over
2317 However, even strictly linear projects may require merge commits in order
2318 to merge in new versions of third-party code stored on vendor branches
2322 Merge commits are commits based on multiple parent commits.
2323 The tip commit of the work tree's current branch, which must be set with
2327 operation, will be used as the first parent.
2328 The tip commit of the specified
2330 will be used as the second parent.
2332 No ancestral relationship between the two branches is required.
2333 If the two branches have already been merged previously, only new changes
2336 It is not possible to create merge commits with more than two parents.
2337 If more than one branch needs to be merged, then multiple merge commits
2338 with two parents each can be created in sequence.
2340 While merging changes found on the
2342 into the work tree, show the status of each affected file,
2343 using the following status codes:
2344 .Bl -column YXZ description
2345 .It G Ta file was merged
2346 .It C Ta file was merged and conflicts occurred during merge
2347 .It ! Ta changes destined for a missing file were not merged
2348 .It D Ta file was deleted
2349 .It d Ta file's deletion was prevented by local modifications
2350 .It A Ta new file was added
2351 .It \(a~ Ta changes destined for a non-regular file were not merged
2352 .It ? Ta changes destined for an unversioned file were not merged
2355 If merge conflicts occur, the merge operation is interrupted and conflicts
2356 must be resolved before the merge operation can continue.
2357 If any files with destined changes are found to be missing or unversioned,
2358 or if files could not be deleted due to differences in deleted content,
2359 the merge operation will be interrupted to prevent potentially incomplete
2360 changes from being committed to the repository without user intervention.
2361 The work tree may be modified as desired and the merge can be continued
2362 once the changes present in the work tree are considered complete.
2363 Alternatively, the merge operation may be aborted which will leave
2364 the work tree's current branch unmodified.
2366 If a merge conflict is resolved in a way which renders all merged
2367 changes into no-op changes, the merge operation cannot continue
2368 and must be aborted.
2371 will refuse to run if certain preconditions are not met.
2374 is based on the work tree's current branch, then no merge commit can
2377 may be used to integrate the
2380 If the work tree is not yet fully updated to the tip commit of its
2381 branch, then the work tree must first be updated with
2383 If the work tree contains multiple base commits, it must first be updated
2384 to a single base commit with
2386 If changes have been staged with
2388 these changes must first be committed with
2392 If the work tree contains local changes, these changes must first be
2399 contains changes to files outside of the work tree's path prefix,
2400 the work tree cannot be used to merge this branch.
2410 commands will refuse to run while a merge operation is in progress.
2411 Other commands which manipulate the work tree may be used for
2412 conflict resolution purposes.
2419 Abort an interrupted merge operation.
2420 If this option is used, no other command-line arguments are allowed.
2422 Continue an interrupted merge operation.
2423 If this option is used, no other command-line arguments are allowed.
2425 Merge changes into the work tree as usual but do not create a merge
2427 The merge result can be adjusted as desired before a merge commit is
2430 Alternatively, the merge may be aborted with
2434 .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 ...
2436 Stage local changes for inclusion in the next commit.
2439 is specified, stage all changes in the work tree.
2440 Otherwise, stage changes at or within the specified paths.
2441 Paths may be staged if they are added, modified, or deleted according to
2444 Show the status of each affected file, using the following status codes:
2445 .Bl -column YXZ description
2446 .It A Ta file addition has been staged
2447 .It M Ta file modification has been staged
2448 .It D Ta file deletion has been staged
2451 Staged file contents are saved in newly created blob objects in the repository.
2452 These blobs will be referred to by tree objects once staged changes have been
2455 Staged changes affect the behaviour of
2460 While paths with staged changes exist, the
2462 command will refuse to commit any paths which do not have staged changes.
2463 Local changes created on top of staged changes can only be committed if
2464 the path is staged again, or if the staged changes are committed first.
2467 command will show both local changes and staged changes.
2470 command is able to display local changes relative to staged changes,
2471 and to display staged changes relative to the repository.
2474 command cannot revert staged changes but may be used to revert
2475 local changes created on top of staged changes.
2482 Instead of staging new changes, list paths which are already staged,
2483 along with the IDs of staged blob objects and stage status codes.
2484 If paths were provided on the command line, show the staged paths
2485 among the specified paths.
2486 Otherwise, show all staged paths.
2488 Instead of staging the entire content of a changed file, interactively
2489 select or reject changes for staging based on
2493 (reject change), and
2495 (quit staging this file) responses.
2496 If a file is in modified status, individual patches derived from the
2497 modified file content can be staged.
2498 Files in added or deleted status may only be staged or rejected in
2500 .It Fl F Ar response-script
2508 responses line-by-line from the specified
2510 file instead of prompting interactively.
2512 Allow staging of symbolic links which point outside of the path space
2513 that is under version control.
2516 will reject such symbolic links due to safety concerns.
2519 may decide to represent such a symbolic link as a regular file which contains
2520 the link's target path, rather than creating an actual symbolic link which
2521 points outside of the work tree.
2522 Use of this option is discouraged because external mechanisms such as
2524 are better suited for managing symbolic links to paths not under
2529 will refuse to run if certain preconditions are not met.
2530 If a file contains merge conflicts, these conflicts must be resolved first.
2531 If a file is found to be out of date relative to the head commit on the
2532 work tree's current branch, the file must be updated with
2534 before it can be staged (however, this does not prevent the file from
2535 becoming out-of-date at some point after having been staged).
2542 commands will refuse to run while staged changes exist.
2543 If staged changes cannot be committed because a staged path
2544 is out of date, the path must be unstaged with
2546 before it can be updated with
2548 and may then be staged again if necessary.
2550 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2552 Merge staged changes back into the work tree and put affected paths
2553 back into non-staged status.
2556 is specified, unstage all staged changes across the entire work tree.
2557 Otherwise, unstage changes at or within the specified paths.
2559 Show the status of each affected file, using the following status codes:
2560 .Bl -column YXZ description
2561 .It G Ta file was unstaged
2562 .It C Ta file was unstaged and conflicts occurred during merge
2563 .It ! Ta changes destined for a missing file were not merged
2564 .It D Ta file was staged as deleted and still is deleted
2565 .It d Ta file's deletion was prevented by local modifications
2566 .It \(a~ Ta changes destined for a non-regular file were not merged
2574 Instead of unstaging the entire content of a changed file, interactively
2575 select or reject changes for unstaging based on
2579 (keep change staged), and
2581 (quit unstaging this file) responses.
2582 If a file is staged in modified status, individual patches derived from the
2583 staged file content can be unstaged.
2584 Files staged in added or deleted status may only be unstaged in their entirety.
2585 .It Fl F Ar response-script
2593 responses line-by-line from the specified
2595 file instead of prompting interactively.
2597 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2598 Parse and print contents of objects to standard output in a line-based
2600 Content of commit, tree, and tag objects is printed in a way similar
2601 to the actual content stored in such objects.
2602 Blob object contents are printed as they would appear in files on disk.
2604 Attempt to interpret each argument as a reference, a tag name, or
2605 an object ID SHA1 hash.
2606 References will be resolved to an object ID.
2607 Tag names will resolved to a tag object.
2608 An abbreviated hash argument will be expanded to a full SHA1 hash
2609 automatically, provided the abbreviation is unique.
2611 If none of the above interpretations produce a valid result, or if the
2613 option is used, attempt to interpret the argument as a path which will
2614 be resolved to the ID of an object found at this path in the repository.
2621 Look up paths in the specified
2623 If this option is not used, paths are looked up in the commit resolved
2624 via the repository's HEAD reference.
2625 The expected argument is a commit ID SHA1 hash or an existing reference
2626 or tag name which will be resolved to a commit ID.
2627 An abbreviated hash argument will be expanded to a full SHA1 hash
2628 automatically, provided the abbreviation is unique.
2629 .It Fl r Ar repository-path
2630 Use the repository at the specified path.
2631 If not specified, assume the repository is located at or above the current
2633 If this directory is a
2635 work tree, use the repository path associated with this work tree.
2637 Interpret all arguments as paths only.
2638 This option can be used to resolve ambiguity in cases where paths
2639 look like tag names, reference names, or object IDs.
2641 .It Cm info Op Ar path ...
2642 Display meta-data stored in a work tree.
2647 The work tree to use is resolved implicitly by walking upwards from the
2648 current working directory.
2652 arguments are specified, show additional per-file information for tracked
2653 files located at or within these paths.
2656 argument corresponds to the work tree's root directory, display information
2657 for all tracked files.
2660 .Bl -tag -width GOT_AUTHOR
2662 The author's name and email address for
2667 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2670 may fail to parse commits without an email address in author data,
2674 environment variables with a missing email address.
2676 .Ev GOT_AUTHOR will be overridden by configuration settings in
2682 configuration settings in the repository's
2689 configuration settings contained in Git's global
2691 configuration file will only be used if neither
2695 environment variable provide author information.
2696 .It Ev VISUAL , EDITOR
2697 The editor spawned by
2705 text editor will be spawned in order to give
2707 the attention it deserves.
2708 .It Ev GOT_LOG_DEFAULT_LIMIT
2709 The default limit on the number of commits traversed by
2711 If set to zero, the limit is unbounded.
2712 This variable will be silently ignored if it is set to a non-numeric value.
2715 .Bl -tag -width packed-refs -compact
2717 Repository-wide configuration settings for
2721 configuration file located in the root directory of a Git repository
2722 supersedes any relevant settings in Git's
2726 .It Pa .got/got.conf
2727 Worktree-specific configuration settings for
2731 configuration file in the
2733 meta-data directory of a work tree supersedes any relevant settings in
2736 configuration file and Git's
2743 Enable tab-completion of
2748 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2750 Clone an existing Git repository for use with
2754 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2756 Use of HTTP URLs currently requires
2760 .Dl $ git clone --bare https://github.com/openbsd/src.git
2762 Alternatively, for quick and dirty local testing of
2764 a new Git repository could be created and populated with files,
2765 e.g. from a temporary CVS checkout located at
2768 .Dl $ got init /var/git/src.git
2769 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2771 Check out a work tree from the Git repository to /usr/src:
2773 .Dl $ got checkout /var/git/src.git /usr/src
2775 View local changes in a work tree directory:
2777 .Dl $ got diff | less
2779 In a work tree, display files in a potentially problematic state:
2781 .Dl $ got status -s 'C!~?'
2783 Interactively revert selected local changes in a work tree directory:
2785 .Dl $ got revert -p -R\ .
2787 In a work tree or a git repository directory, list all branch references:
2791 In a work tree or a git repository directory, create a new branch called
2792 .Dq unified-buffer-cache
2793 which is forked off the
2797 .Dl $ got branch -c master unified-buffer-cache
2799 Switch an existing work tree to the branch
2800 .Dq unified-buffer-cache .
2801 Local changes in the work tree will be preserved and merged if necessary:
2803 .Dl $ got update -b unified-buffer-cache
2805 Create a new commit from local changes in a work tree directory.
2806 This new commit will become the head commit of the work tree's current branch:
2810 In a work tree or a git repository directory, view changes committed in
2811 the 3 most recent commits to the work tree's branch, or the branch resolved
2812 via the repository's HEAD reference, respectively:
2814 .Dl $ got log -p -l 3
2816 As above, but display changes in the order in which
2818 could apply them in sequence:
2820 .Dl $ got log -p -l 3 -R
2822 In a work tree or a git repository directory, log the history of a subdirectory:
2824 .Dl $ got log sys/uvm
2826 While operating inside a work tree, paths are specified relative to the current
2827 working directory, so this command will log the subdirectory
2830 .Dl $ cd sys/uvm && got log\ .
2832 And this command has the same effect:
2834 .Dl $ cd sys/dev/usb && got log ../../uvm
2836 And this command displays work tree meta-data about all tracked files:
2839 .Dl $ got info\ . | less
2841 Add new files and remove obsolete files in a work tree directory:
2843 .Dl $ got add sys/uvm/uvm_ubc.c
2844 .Dl $ got remove sys/uvm/uvm_vnode.c
2846 Create a new commit from local changes in a work tree directory
2847 with a pre-defined log message.
2849 .Dl $ got commit -m 'unify the buffer cache'
2851 Alternatively, create a new commit from local changes in a work tree
2852 directory with a log message that has been prepared in the file
2855 .Dl $ got commit -F /tmp/msg
2857 Update any work tree checked out from the
2858 .Dq unified-buffer-cache
2859 branch to the latest commit on this branch:
2863 Roll file content on the unified-buffer-cache branch back by one commit,
2864 and then fetch the rolled-back change into the work tree as a local change
2865 to be amended and perhaps committed again:
2867 .Dl $ got backout unified-buffer-cache
2868 .Dl $ got commit -m 'roll back previous'
2869 .Dl $ # now back out the previous backout :-)
2870 .Dl $ got backout unified-buffer-cache
2872 Fetch new changes on the remote repository's
2874 branch, making them visible on the local repository's
2881 In a repository created with a HTTP URL and
2882 .Cm git clone --bare
2885 command must be used instead:
2887 .Dl $ cd /var/git/src.git
2888 .Dl $ git fetch origin master:refs/remotes/origin/master
2892 branch to merge the new changes that are now visible on the
2897 .Dl $ got update -b origin/master
2898 .Dl $ got rebase master
2901 .Dq unified-buffer-cache
2902 branch on top of the new head commit of the
2906 .Dl $ got update -b master
2907 .Dl $ got rebase unified-buffer-cache
2909 Create a patch from all changes on the unified-buffer-cache branch.
2910 The patch can be mailed out for review and applied to
2914 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2916 Edit the entire commit history of the
2917 .Dq unified-buffer-cache
2920 .Dl $ got update -b unified-buffer-cache
2921 .Dl $ got update -c master
2924 Before working against existing branches in a repository cloned with
2925 .Cm git clone --bare
2930 must be configured to map all references in the remote repository
2933 namespace of the local repository.
2934 This can be achieved by setting Git's
2935 .Pa remote.origin.fetch
2936 configuration variable to the value
2937 .Dq +refs/heads/*:refs/remotes/origin/*
2942 .Dl $ cd /var/git/repo
2943 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2947 option must be disabled:
2949 .Dl $ cd /var/git/repo
2950 .Dl $ git config remote.origin.mirror false
2952 Alternatively, the following
2954 configuration item can be added manually to the Git repository's
2958 .Dl [remote \&"origin\&"]
2960 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2963 This configuration leaves the local repository's
2965 namespace free for use by local branches checked out with
2967 and, if needed, created with
2970 .Dq refs/remotes/origin
2971 namespace can now be updated with incoming changes from the remote
2976 without extra command line arguments.
2977 Newly fetched changes can be examined with
2980 Display changes on the remote repository's version of the
2982 branch, as of the last time
2986 .Dl $ got log -c origin/master | less
2988 As shown here, most commands accept abbreviated reference names such as
2991 .Dq refs/remotes/origin/master .
2992 The latter is only needed in case of ambiguity.
2995 must be used to merge changes which are visible on the
3000 This will also merge local changes, if any, with the incoming changes:
3002 .Dl $ got update -b origin/master
3003 .Dl $ got rebase master
3005 In order to make changes committed to the
3006 .Dq unified-buffer-cache
3010 .Dq unified-buffer-cache
3011 branch must first be rebased onto the
3015 .Dl $ got update -b master
3016 .Dl $ got rebase unified-buffer-cache
3019 .Dq unified-buffer-cache
3020 branch can now be made visible on the
3024 Because the rebase operation switched the work tree to the
3025 .Dq unified-buffer-cache
3026 branch, the work tree must be switched back to the
3030 .Dl $ got update -b master
3031 .Dl $ got integrate unified-buffer-cache
3035 branch, log messages for local changes can now be amended with
3037 by other developers and any other important new information:
3039 .Dl $ got update -c origin/master
3040 .Dl $ got histedit -m
3042 If the remote repository offers write access, local changes on the
3044 branch can be sent to the remote repository with
3048 can be run without further arguments.
3049 The arguments shown here match defaults, provided the work tree's
3050 current branch is the
3054 .Dl $ got send -b master origin
3056 If the remote repository requires the HTTPS protocol, the
3058 command must be used instead:
3060 .Dl $ cd /var/git/src.git
3061 .Dl $ git push origin master
3065 .Xr git-repository 5 ,
3066 .Xr got-worktree 5 ,
3069 .An Stefan Sperling Aq Mt stsp@openbsd.org
3070 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3071 .An Joshua Stein Aq Mt jcs@openbsd.org
3072 .An Ori Bernstein Aq Mt ori@openbsd.org
3075 is a work-in-progress and some features remain to be implemented.
3077 At present, the user has to fall back on
3079 to perform some tasks.
3083 Reading from remote repositories over HTTP or HTTPS protocols requires
3088 Writing to remote repositories over HTTP or HTTPS protocols requires
3091 The creation of merge commits with more than two parent commits requires
3094 In situations where files or directories were moved around
3096 will not automatically merge changes to new locations and
3098 will usually produce better results.
