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 lines in committed patches can be matched.
838 When used together with
840 then the file paths changed by a commit can be matched as well.
841 Regular expression syntax is documented in
843 .It Fl r Ar repository-path
844 Use the repository at the specified path.
845 If not specified, assume the repository is located at or above the current
847 If this directory is a
849 work tree, use the repository path associated with this work tree.
851 Determine a set of commits to display as usual, but display these commits
854 Stop traversing commit history immediately after the specified
857 This option has no effect if the specified
862 .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 ...
864 When invoked within a work tree without any arguments, display all
865 local changes in the work tree.
868 arguments are specified, only show changes within the specified paths.
870 If two arguments are provided, treat each argument as a reference, a tag
871 name, or an object ID SHA1 hash, and display differences between the
872 corresponding objects.
873 Both objects must be of the same type (blobs, trees, or commits).
874 An abbreviated hash argument will be expanded to a full SHA1 hash
875 automatically, provided the abbreviation is unique.
876 If none of these interpretations produce a valid result or if the
881 is running in a work tree, attempt to interpret the two arguments as paths.
888 Treat file contents as ASCII text even if binary data is detected.
890 Show differences between commits in the repository.
891 This options may be used up to two times.
892 When used only once, show differences between the specified
894 and its first parent commit.
895 When used twice, show differences between the two specified commits.
897 The expected argument is a commit ID SHA1 hash or an existing reference
898 or tag name which will be resolved to a commit ID.
899 An abbreviated hash argument will be expanded to a full SHA1 hash
900 automatically, provided the abbreviation is unique.
904 option is used, all non-option arguments will be interpreted as paths.
907 arguments are provided, only show differences for the specified paths.
909 Cannot be used together with the
913 Set the number of context lines shown in the diff.
914 By default, 3 lines of context are shown.
915 .It Fl r Ar repository-path
916 Use the repository at the specified path.
917 If not specified, assume the repository is located at or above the current
919 If this directory is a
921 work tree, use the repository path associated with this work tree.
923 Show changes staged with
925 instead of showing local changes in the work tree.
926 This option is only valid when
928 is invoked in a work tree.
930 Interpret all arguments as paths only.
931 This option can be used to resolve ambiguity in cases where paths
932 look like tag names, reference names, or object IDs.
933 This option is only valid when
935 is invoked in a work tree.
937 Ignore whitespace-only changes.
940 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
942 Display line-by-line history of a file at the specified path.
949 Start traversing history at the specified
951 The expected argument is a commit ID SHA1 hash or an existing reference
952 or tag name which will be resolved to a commit ID.
953 An abbreviated hash argument will be expanded to a full SHA1 hash
954 automatically, provided the abbreviation is unique.
955 .It Fl r Ar repository-path
956 Use the repository at the specified path.
957 If not specified, assume the repository is located at or above the current
959 If this directory is a
961 work tree, use the repository path associated with this work tree.
964 .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
966 Display a listing of files and directories at the specified
967 directory path in the repository.
968 Entries shown in this listing may carry one of the following trailing
970 .Bl -column YXZ description
971 .It @ Ta entry is a symbolic link
972 .It / Ta entry is a directory
973 .It * Ta entry is an executable file
974 .It $ Ta entry is a Git submodule
977 Symbolic link entries are also annotated with the target path of the link.
981 is specified, list the repository path corresponding to the current
982 directory of the work tree, or the root directory of the repository
983 if there is no work tree.
990 List files and directories as they appear in the specified
992 The expected argument is a commit ID SHA1 hash or an existing reference
993 or tag name which will be resolved to a commit ID.
994 An abbreviated hash argument will be expanded to a full SHA1 hash
995 automatically, provided the abbreviation is unique.
996 .It Fl r Ar repository-path
997 Use the repository at the specified path.
998 If not specified, assume the repository is located at or above the current
1000 If this directory is a
1002 work tree, use the repository path associated with this work tree.
1004 Show object IDs of files (blob objects) and directories (tree objects).
1006 Recurse into sub-directories in the repository.
1008 .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
1009 Manage references in a repository.
1011 References may be listed, created, deleted, and changed.
1012 When creating, deleting, or changing a reference the specified
1014 must be an absolute reference name, i.e. it must begin with
1021 .It Fl r Ar repository-path
1022 Use the repository at the specified path.
1023 If not specified, assume the repository is located at or above the current
1025 If this directory is a
1027 work tree, use the repository path associated with this work tree.
1029 List references in the repository.
1032 is specified, list all existing references in the repository.
1035 is a reference namespace, list all references in this namespace.
1036 Otherwise, show only the reference with the given
1038 Cannot be used together with any other options except
1043 Sort listed references by modification time (most recently modified first)
1044 instead of sorting by lexicographical order.
1045 Use of this option requires the
1047 option to be used as well.
1049 Create a reference or change an existing reference.
1050 The reference with the specified
1052 will point at the specified
1056 argument is a ID SHA1 hash or an existing reference or tag name which will
1057 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1058 Cannot be used together with any other options except
1060 .It Fl s Ar reference
1061 Create a symbolic reference, or change an existing symbolic reference.
1062 The symbolic reference with the specified
1064 will point at the specified
1066 which must already exist in the repository.
1067 Care should be taken not to create loops between references when
1068 this option is used.
1069 Cannot be used together with any other options except
1072 Delete the reference with the specified
1074 from the repository.
1075 Any commit, tree, tag, and blob objects belonging to deleted references
1076 remain in the repository and may be removed separately with
1077 Git's garbage collector or
1078 .Cm gotadmin cleanup .
1079 Cannot be used together with any other options except
1083 .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
1085 Create, list, or delete branches.
1087 Local branches are managed via references which live in the
1089 reference namespace.
1092 command creates references in this namespace only.
1094 When deleting branches, the specified
1098 reference namespace first.
1099 If no corresponding branch is found, the
1101 namespace will be searched next.
1103 If invoked in a work tree without any arguments, print the name of the
1104 work tree's current branch.
1108 argument is passed, attempt to create a branch reference with the given name.
1109 By default the new branch reference will point at the latest commit on the
1110 work tree's current branch if invoked in a work tree, and otherwise to a commit
1111 resolved via the repository's HEAD reference.
1113 If invoked in a work tree, once the branch was created successfully
1114 switch the work tree's head reference to the newly created branch and
1115 update files across the entire work tree, just like
1116 .Cm got update -b Ar name
1118 Show the status of each affected file, using the following status codes:
1119 .Bl -column YXZ description
1120 .It U Ta file was updated and contained no local changes
1121 .It G Ta file was updated and local changes were merged cleanly
1122 .It C Ta file was updated and conflicts occurred during merge
1123 .It D Ta file was deleted
1124 .It A Ta new file was added
1125 .It \(a~ Ta versioned file is obstructed by a non-regular file
1126 .It ! Ta a missing versioned file was restored
1134 Make a newly created branch reference point at the specified
1138 argument is a commit ID SHA1 hash or an existing reference
1139 or tag name which will be resolved to a commit ID.
1140 .It Fl r Ar repository-path
1141 Use the repository at the specified path.
1142 If not specified, assume the repository is located at or above the current
1144 If this directory is a
1146 work tree, use the repository path associated with this work tree.
1148 List all existing branches in the repository, including copies of remote
1149 repositories' branches in the
1151 reference namespace.
1153 If invoked in a work tree, the work tree's current branch is shown
1154 with one the following annotations:
1155 .Bl -column YXZ description
1156 .It * Ta work tree's base commit matches the branch tip
1157 .It \(a~ Ta work tree's base commit is out-of-date
1160 Sort listed branches by modification time (most recently modified first)
1161 instead of sorting by lexicographical order.
1164 reference namespace are listed before branches in
1167 Use of this option requires the
1169 option to be used as well.
1171 Delete the branch with the specified
1177 reference namespace.
1179 Only the branch reference is deleted.
1180 Any commit, tree, and blob objects belonging to the branch
1181 remain in the repository and may be removed separately with
1182 Git's garbage collector or
1183 .Cm gotadmin cleanup .
1185 Do not switch and update the work tree after creating a new branch.
1187 .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
1188 Manage tags in a repository.
1190 Tags are managed via references which live in the
1192 reference namespace.
1195 command operates on references in this namespace only.
1196 References in this namespace point at tag objects which contain a pointer
1197 to another object, a tag message, as well as author and timestamp information.
1199 Attempt to create a tag with the given
1201 and make this tag point at the given
1203 If no commit is specified, default to the latest commit on the work tree's
1204 current branch if invoked in a work tree, and to a commit resolved via
1205 the repository's HEAD reference otherwise.
1212 Make the newly created tag reference point at the specified
1216 argument is a commit ID SHA1 hash or an existing reference or tag name which
1217 will be resolved to a commit ID.
1218 An abbreviated hash argument will be expanded to a full SHA1 hash
1219 automatically, provided the abbreviation is unique.
1221 Use the specified tag message when creating the new tag.
1226 opens a temporary file in an editor where a tag message can be written.
1227 .It Fl r Ar repository-path
1228 Use the repository at the specified path.
1229 If not specified, assume the repository is located at or above the current
1231 If this directory is a
1233 work tree, use the repository path associated with this work tree.
1235 List all existing tags in the repository instead of creating a new tag.
1236 If this option is used, no other command-line arguments are allowed.
1241 command will not delete tags or change existing tags.
1242 If a tag must be deleted, the
1244 command may be used to delete a tag's reference.
1245 This should only be done if the tag has not already been copied to
1247 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1248 Schedule unversioned files in a work tree for addition to the
1249 repository in the next commit.
1250 By default, files which match a
1252 ignore pattern will not be added.
1259 Permit recursion into directories.
1260 If this option is not specified,
1262 will refuse to run if a specified
1266 Add files even if they match a
1271 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1273 Remove versioned files from a work tree and schedule them for deletion
1274 from the repository in the next commit.
1281 Perform the operation even if a file contains local modifications,
1282 and do not raise an error if a specified
1284 does not exist on disk.
1286 Keep affected files on disk.
1288 Permit recursion into directories.
1289 If this option is not specified,
1291 will refuse to run if a specified
1294 .It Fl s Ar status-codes
1295 Only delete files with a modification status matching one of the
1296 single-character status codes contained in the
1299 The following status codes may be specified:
1300 .Bl -column YXZ description
1301 .It M Ta modified file (this implies the
1304 .It ! Ta versioned file expected on disk but missing
1308 .It Cm patch Oo Fl n Oc Oo Fl p Ar strip-count Oc Oo Fl R Oc Op Ar patchfile
1312 to files in a work tree.
1313 Files added or removed by a patch will be scheduled for addition or removal in
1316 The patch must be in the unified diff format as produced by
1323 diff when invoked with their
1328 argument is provided, read unified diff data from standard input instead.
1332 contains multiple patches, then attempt to apply each of them in sequence.
1334 Show the status of each affected file, using the following status codes:
1335 .Bl -column XYZ description
1336 .It M Ta file was modified
1337 .It D Ta file was deleted
1338 .It A Ta file was added
1339 .It # Ta failed to patch the file
1342 If a change does not match at its exact line number, attempt to
1343 apply it somewhere else in the file if a good spot can be found.
1344 Otherwise, the patch will fail to apply.
1348 will refuse to apply a patch if certain preconditions are not met.
1349 Files to be deleted must already be under version control, and must
1350 not have been scheduled for deletion already.
1351 Files to be added must not yet be under version control and must not
1352 already be present on disk.
1353 Files to be modified must already be under version control and may not
1354 contain conflict markers.
1356 If an error occurs, the
1358 operation will be aborted.
1359 Any changes made to the work tree up to this point will be left behind.
1360 Such changes can be viewed with
1362 and can be reverted with
1371 Do not make any modifications to the work tree.
1372 This can be used to check whether a patch would apply without issues.
1375 contains diffs that affect the same file multiple times, the results
1376 displayed may be incorrect.
1377 .It Fl p Ar strip-count
1378 Specify the number of leading path components to strip from paths
1387 path prefixes generated by
1389 will be recognized and stripped automatically.
1391 Reverse the patch before applying it.
1394 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1396 Revert any local changes in files at the specified paths in a work tree.
1397 File contents will be overwritten with those contained in the
1398 work tree's base commit.
1399 There is no way to bring discarded changes back after
1402 If a file was added with
1404 it will become an unversioned file again.
1405 If a file was deleted with
1407 it will be restored.
1414 Instead of reverting all changes in files, interactively select or reject
1415 changes to revert based on
1421 (quit reverting this file) responses.
1422 If a file is in modified status, individual patches derived from the
1423 modified file content can be reverted.
1424 Files in added or deleted status may only be reverted in their entirety.
1425 .It Fl F Ar response-script
1433 responses line-by-line from the specified
1435 file instead of prompting interactively.
1437 Permit recursion into directories.
1438 If this option is not specified,
1440 will refuse to run if a specified
1445 .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 ...
1447 Create a new commit in the repository from changes in a work tree
1448 and use this commit as the new base commit for the work tree.
1451 is specified, commit all changes in the work tree.
1452 Otherwise, commit changes at or within the specified paths.
1454 If changes have been explicitly staged for commit with
1456 only commit staged changes and reject any specified paths which
1457 have not been staged.
1460 opens a temporary file in an editor where a log message can be written
1468 options are used together.
1470 Show the status of each affected file, using the following status codes:
1471 .Bl -column YXZ description
1472 .It M Ta modified file
1473 .It D Ta file was deleted
1474 .It A Ta new file was added
1475 .It m Ta modified file modes (executable bit only)
1478 Files which are not part of the new commit will retain their previously
1479 recorded base commit.
1482 commands may refuse to run while the work tree contains files from
1483 multiple base commits.
1484 The base commit of such a work tree can be made consistent by running
1486 across the entire work tree.
1490 command requires the
1492 environment variable to be set,
1493 unless an author has been configured in
1499 configuration settings can be
1500 obtained from the repository's
1502 file or from Git's global
1511 Use the prepared log message stored in the file found at
1513 when creating the new commit.
1515 opens a temporary file in an editor where the prepared log message can be
1516 reviewed and edited further if needed.
1517 Cannot be used together with the
1521 Use the specified log message when creating the new commit.
1522 Cannot be used together with the
1526 This option prevents
1528 from opening the commit message in an editor.
1529 It has no effect unless it is used together with the
1531 option and is intended for non-interactive use such as scripting.
1533 Allow the addition of symbolic links which point outside of the path space
1534 that is under version control.
1537 will reject such symbolic links due to safety concerns.
1540 may decide to represent such a symbolic link as a regular file which contains
1541 the link's target path, rather than creating an actual symbolic link which
1542 points outside of the work tree.
1543 Use of this option is discouraged because external mechanisms such as
1545 are better suited for managing symbolic links to paths not under
1550 will refuse to run if certain preconditions are not met.
1551 If the work tree's current branch is not in the
1553 reference namespace, new commits may not be created on this branch.
1554 Local changes may only be committed if they are based on file content
1555 found in the most recent commit on the work tree's branch.
1556 If a path is found to be out of date,
1558 must be used first in order to merge local changes with changes made
1561 .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
1563 Send new changes to a remote repository.
1565 .Ar remote-repository
1569 The remote repository's URL is obtained from the corresponding entry in
1573 file of the local repository, as created by
1576 All objects corresponding to new changes will be written to a temporary
1577 pack file which is then uploaded to the server.
1578 Upon success, references in the
1580 reference namespace of the local repository will be updated to point at
1581 the commits which have been sent.
1583 By default, changes will only be sent if they are based on up-to-date
1584 copies of relevant branches in the remote repository.
1585 If any changes to be sent are based on out-of-date copies or would
1586 otherwise break linear history of existing branches, new changes must
1587 be fetched from the server with
1589 and local branches must be rebased with
1596 option can be used to make exceptions to these requirements.
1603 Send all branches from the local repository's
1605 reference namespace.
1608 option is equivalent to listing all branches with multiple
1611 Cannot be used together with the
1617 from the local repository's
1619 reference namespace.
1620 This option may be specified multiple times to build a list of branches
1622 If this option is not specified, default to the work tree's current branch
1623 if invoked in a work tree, or to the repository's HEAD reference.
1624 Cannot be used together with the
1628 Delete the specified
1630 from the remote repository's
1632 reference namespace.
1633 This option may be specified multiple times to build a list of branches
1636 Only references are deleted.
1637 Any commit, tree, tag, and blob objects belonging to deleted branches
1638 may become subject to deletion by Git's garbage collector running on
1641 Requesting deletion of branches results in an error if the server
1642 does not support this feature or disallows the deletion of branches
1643 based on its configuration.
1645 Attempt to force the server to overwrite existing branches or tags
1646 in the remote repository, even when
1650 would usually be required before changes can be sent.
1651 The server may reject forced requests regardless, depending on its
1654 Any commit, tree, tag, and blob objects belonging to overwritten branches
1655 or tags may become subject to deletion by Git's garbage collector running
1660 reference namespace is globally shared between all repositories.
1663 option to overwrite tags is discouraged because it can lead to
1664 inconsistencies between the tags present in different repositories.
1665 In general, creating a new tag with a different name is recommended
1666 instead of overwriting an existing tag.
1670 option is particularly discouraged if changes being sent are based
1671 on an out-of-date copy of a branch in the remote repository.
1672 Instead of using the
1674 option, new changes should
1677 and local branches should be rebased with
1679 followed by another attempt to send the changes.
1683 option should only be needed in situations where the remote repository's
1684 copy of a branch or tag is known to be out-of-date and is considered
1686 The risks of creating inconsistencies between different repositories
1687 should also be taken into account.
1688 .It Fl r Ar repository-path
1689 Use the repository at the specified path.
1690 If not specified, assume the repository is located at or above the current
1692 If this directory is a
1694 work tree, use the repository path associated with this work tree.
1698 from the local repository's
1700 reference namespace, in addition to any branches that are being sent.
1703 option may be specified multiple times to build a list of tags to send.
1704 No tags will be sent if the
1708 Raise an error if the specified
1710 already exists in the remote repository, unless the
1712 option is used to overwrite the server's copy of the tag.
1713 In general, creating a new tag with a different name is recommended
1714 instead of overwriting an existing tag.
1716 Cannot be used together with the
1720 Attempt to send all tags from the local repository's
1722 reference namespace.
1725 option is equivalent to listing all tags with multiple
1728 Cannot be used together with the
1732 Suppress progress reporting output.
1733 The same option will be passed to
1740 to print debugging messages to standard error output.
1741 The same option will be passed to
1744 Multiple -v options increase the verbosity.
1748 .It Cm cherrypick Ar commit
1750 Merge changes from a single
1755 should be on a different branch than the work tree's base commit.
1756 The expected argument is a reference or a commit ID SHA1 hash.
1757 An abbreviated hash argument will be expanded to a full SHA1 hash
1758 automatically, provided the abbreviation is unique.
1760 Show the status of each affected file, using the following status codes:
1761 .Bl -column YXZ description
1762 .It G Ta file was merged
1763 .It C Ta file was merged and conflicts occurred during merge
1764 .It ! Ta changes destined for a missing file were not merged
1765 .It D Ta file was deleted
1766 .It d Ta file's deletion was prevented by local modifications
1767 .It A Ta new file was added
1768 .It \(a~ Ta changes destined for a non-regular file were not merged
1769 .It ? Ta changes destined for an unversioned file were not merged
1772 The merged changes will appear as local changes in the work tree, which
1775 amended manually or with further
1780 or discarded again with
1784 will refuse to run if certain preconditions are not met.
1785 If the work tree contains multiple base commits, it must first be updated
1786 to a single base commit with
1788 If any relevant files already contain merge conflicts, these
1789 conflicts must be resolved first.
1791 .It Cm backout Ar commit
1793 Reverse-merge changes from a single
1798 should be on the same branch as the work tree's base commit.
1799 The expected argument is a reference or a commit ID SHA1 hash.
1800 An abbreviated hash argument will be expanded to a full SHA1 hash
1801 automatically, provided the abbreviation is unique.
1803 Show the status of each affected file, using the following status codes:
1804 .Bl -column YXZ description
1805 .It G Ta file was merged
1806 .It C Ta file was merged and conflicts occurred during merge
1807 .It ! Ta changes destined for a missing file were not merged
1808 .It D Ta file was deleted
1809 .It d Ta file's deletion was prevented by local modifications
1810 .It A Ta new file was added
1811 .It \(a~ Ta changes destined for a non-regular file were not merged
1812 .It ? Ta changes destined for an unversioned file were not merged
1815 The reverse-merged changes will appear as local changes in the work tree,
1816 which may be viewed with
1818 amended manually or with further
1823 or discarded again with
1827 will refuse to run if certain preconditions are not met.
1828 If the work tree contains multiple base commits, it must first be updated
1829 to a single base commit with
1831 If any relevant files already contain merge conflicts, these
1832 conflicts must be resolved first.
1834 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1836 Rebase commits on the specified
1838 onto the tip of the current branch of the work tree.
1841 must share common ancestry with the work tree's current branch.
1842 Rebasing begins with the first descendant commit of the youngest
1843 common ancestor commit shared by the specified
1845 and the work tree's current branch, and stops once the tip commit
1852 is used as intended, the specified
1854 represents a local commit history and may already contain changes
1855 that are not yet visible in any other repositories.
1856 The work tree's current branch, which must be set with
1860 operation, represents a branch from a remote repository which shares
1861 a common history with the specified
1863 but has progressed, and perhaps diverged, due to commits added to the
1866 Rebased commits are accumulated on a temporary branch which the work tree
1867 will remain switched to throughout the entire rebase operation.
1868 Commits on this branch represent the same changes with the same log
1869 messages as their counterparts on the original
1871 but with different commit IDs.
1872 Once rebasing has completed successfully, the temporary branch becomes
1873 the new version of the specified
1875 and the work tree is automatically switched to it.
1877 Old commits in their pre-rebase state are automatically backed up in the
1878 .Dq refs/got/backup/rebase
1879 reference namespace.
1880 As long as these references are not removed older versions of rebased
1881 commits will remain in the repository and can be viewed with the
1884 Removal of these references makes objects which become unreachable via
1885 any reference subject to removal by Git's garbage collector or
1886 .Cm gotadmin cleanup .
1888 While rebasing commits, show the status of each affected file,
1889 using the following status codes:
1890 .Bl -column YXZ description
1891 .It G Ta file was merged
1892 .It C Ta file was merged and conflicts occurred during merge
1893 .It ! Ta changes destined for a missing file were not merged
1894 .It D Ta file was deleted
1895 .It d Ta file's deletion was prevented by local modifications
1896 .It A Ta new file was added
1897 .It \(a~ Ta changes destined for a non-regular file were not merged
1898 .It ? Ta changes destined for an unversioned file were not merged
1901 If merge conflicts occur, the rebase operation is interrupted and may
1902 be continued once conflicts have been resolved.
1903 If any files with destined changes are found to be missing or unversioned,
1904 or if files could not be deleted due to differences in deleted content,
1905 the rebase operation will be interrupted to prevent potentially incomplete
1906 changes from being committed to the repository without user intervention.
1907 The work tree may be modified as desired and the rebase operation can be
1908 continued once the changes present in the work tree are considered complete.
1909 Alternatively, the rebase operation may be aborted which will leave
1911 unmodified and the work tree switched back to its original branch.
1913 If a merge conflict is resolved in a way which renders the merged
1914 change into a no-op change, the corresponding commit will be elided
1915 when the rebase operation continues.
1918 will refuse to run if certain preconditions are not met.
1919 If the work tree is not yet fully updated to the tip commit of its
1920 branch, then the work tree must first be updated with
1922 If changes have been staged with
1924 these changes must first be committed with
1928 If the work tree contains local changes, these changes must first be
1935 contains changes to files outside of the work tree's path prefix,
1936 the work tree cannot be used to rebase this branch.
1942 commands will refuse to run while a rebase operation is in progress.
1943 Other commands which manipulate the work tree may be used for
1944 conflict resolution purposes.
1948 is already based on the work tree's current branch, then no commits
1949 need to be rebased and
1951 will simply switch the work tree to the specified
1953 and update files in the work tree accordingly.
1960 Abort an interrupted rebase operation.
1961 If this option is used, no other command-line arguments are allowed.
1963 Continue an interrupted rebase operation.
1964 If this option is used, no other command-line arguments are allowed.
1966 Show a list of past rebase operations, represented by references in the
1967 .Dq refs/got/backup/rebase
1968 reference namespace.
1970 Display the author, date, and log message of each backed up commit,
1971 the object ID of the corresponding post-rebase commit, and
1972 the object ID of their common ancestor commit.
1973 Given these object IDs,
1980 options can be used to examine the history of either version of the branch,
1985 option can be used to create a new branch from a pre-rebase state if desired.
1989 is specified, only show commits which at some point in time represented this
1991 Otherwise, list all backed up commits for any branches.
1993 If this option is used,
1995 does not require a work tree.
1996 None of the other options can be used together with
1999 Delete backups created by past rebase operations, represented by references
2001 .Dq refs/got/backup/rebase
2002 reference namespace.
2006 is specified, only delete backups which at some point in time represented
2008 Otherwise, delete all references found within
2009 .Dq refs/got/backup/rebase .
2011 Any commit, tree, tag, and blob objects belonging to deleted backups
2012 remain in the repository and may be removed separately with
2013 Git's garbage collector or
2014 .Cm gotadmin cleanup .
2016 If this option is used,
2018 does not require a work tree.
2019 None of the other options can be used together with
2023 .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
2025 Edit commit history between the work tree's current base commit and
2026 the tip commit of the work tree's current branch.
2030 operation, the work tree's current branch must be set with
2032 to the branch which should be edited, unless this branch is already the
2033 current branch of the work tree.
2034 The tip of this branch represents the upper bound (inclusive) of commits
2039 Furthermore, the work tree's base commit
2042 to a point in this branch's commit history where editing should begin.
2043 This commit represents the lower bound (non-inclusive) of commits touched
2048 Editing of commit history is controlled via a
2050 which can be written in an editor based on a template, passed on the
2051 command line, or generated with the
2057 The format of the histedit script is line-based.
2058 Each line in the script begins with a command name, followed by
2059 whitespace and an argument.
2060 For most commands, the expected argument is a commit ID SHA1 hash.
2061 Any remaining text on the line is ignored.
2062 Lines which begin with the
2064 character are ignored entirely.
2066 The available commands are as follows:
2067 .Bl -column YXZ pick-commit
2068 .It pick Ar commit Ta Use the specified commit as it is.
2069 .It edit Ar commit Ta Use the specified commit but once changes have been
2070 merged into the work tree interrupt the histedit operation for amending.
2071 .It fold Ar commit Ta Combine the specified commit with the next commit
2072 listed further below that will be used.
2073 .It drop Ar commit Ta Remove this commit from the edited history.
2074 .It mesg Ar log-message Ta Use the specified single-line log message for
2075 the commit on the previous line.
2076 If the log message argument is left empty, open an editor where a new
2077 log message can be written.
2080 Every commit in the history being edited must be mentioned in the script.
2081 Lines may be re-ordered to change the order of commits in the edited history.
2082 No commit may be listed more than once.
2084 Edited commits are accumulated on a temporary branch which the work tree
2085 will remain switched to throughout the entire histedit operation.
2086 Once history editing has completed successfully, the temporary branch becomes
2087 the new version of the work tree's branch and the work tree is automatically
2090 Old commits in their pre-histedit state are automatically backed up in the
2091 .Dq refs/got/backup/histedit
2092 reference namespace.
2093 As long as these references are not removed older versions of edited
2094 commits will remain in the repository and can be viewed with the
2097 Removal of these references makes objects which become unreachable via
2098 any reference subject to removal by Git's garbage collector or
2099 .Cm gotadmin cleanup .
2101 While merging commits, show the status of each affected file,
2102 using the following status codes:
2103 .Bl -column YXZ description
2104 .It G Ta file was merged
2105 .It C Ta file was merged and conflicts occurred during merge
2106 .It ! Ta changes destined for a missing file were not merged
2107 .It D Ta file was deleted
2108 .It d Ta file's deletion was prevented by local modifications
2109 .It A Ta new file was added
2110 .It \(a~ Ta changes destined for a non-regular file were not merged
2111 .It ? Ta changes destined for an unversioned file were not merged
2114 If merge conflicts occur, the histedit operation is interrupted and may
2115 be continued once conflicts have been resolved.
2116 If any files with destined changes are found to be missing or unversioned,
2117 or if files could not be deleted due to differences in deleted content,
2118 the histedit operation will be interrupted to prevent potentially incomplete
2119 changes from being committed to the repository without user intervention.
2120 The work tree may be modified as desired and the histedit operation can be
2121 continued once the changes present in the work tree are considered complete.
2122 Alternatively, the histedit operation may be aborted which will leave
2123 the work tree switched back to its original branch.
2125 If a merge conflict is resolved in a way which renders the merged
2126 change into a no-op change, the corresponding commit will be elided
2127 when the histedit operation continues.
2130 will refuse to run if certain preconditions are not met.
2131 If the work tree's current branch is not in the
2133 reference namespace, the history of the branch may not be edited.
2134 If the work tree contains multiple base commits, it must first be updated
2135 to a single base commit with
2137 If changes have been staged with
2139 these changes must first be committed with
2143 If the work tree contains local changes, these changes must first be
2148 If the edited history contains changes to files outside of the work tree's
2149 path prefix, the work tree cannot be used to edit the history of this branch.
2156 commands will refuse to run while a histedit operation is in progress.
2157 Other commands which manipulate the work tree may be used, and the
2159 command may be used to commit arbitrary changes to the temporary branch
2160 while the histedit operation is interrupted.
2167 Abort an interrupted histedit operation.
2168 If this option is used, no other command-line arguments are allowed.
2170 Continue an interrupted histedit operation.
2171 If this option is used, no other command-line arguments are allowed.
2173 Interrupt the histedit operation for editing after merging each commit.
2174 This option is a quick equivalent to a histedit script which uses the
2176 command for all commits.
2179 option can only be used when starting a new histedit operation.
2180 If this option is used, no other command-line arguments are allowed.
2182 Fold all commits into a single commit.
2183 This option is a quick equivalent to a histedit script which folds all
2184 commits, combining them all into one commit.
2187 option can only be used when starting a new histedit operation.
2188 If this option is used, no other command-line arguments are allowed.
2189 .It Fl F Ar histedit-script
2192 instead of opening a temporary file in an editor where a histedit script
2195 Edit log messages only.
2196 This option is a quick equivalent to a histedit script which edits
2197 only log messages but otherwise leaves every picked commit as-is.
2200 option can only be used when starting a new histedit operation.
2201 If this option is used, no other command-line arguments are allowed.
2203 Show a list of past histedit operations, represented by references in the
2204 .Dq refs/got/backup/histedit
2205 reference namespace.
2207 Display the author, date, and log message of each backed up commit,
2208 the object ID of the corresponding post-histedit commit, and
2209 the object ID of their common ancestor commit.
2210 Given these object IDs,
2217 options can be used to examine the history of either version of the branch,
2222 option can be used to create a new branch from a pre-histedit state if desired.
2226 is specified, only show commits which at some point in time represented this
2228 Otherwise, list all backed up commits for any branches.
2230 If this option is used,
2232 does not require a work tree.
2233 None of the other options can be used together with
2236 Delete backups created by past histedit operations, represented by references
2238 .Dq refs/got/backup/histedit
2239 reference namespace.
2243 is specified, only delete backups which at some point in time represented
2245 Otherwise, delete all references found within
2246 .Dq refs/got/backup/histedit .
2248 Any commit, tree, tag, and blob objects belonging to deleted backups
2249 remain in the repository and may be removed separately with
2250 Git's garbage collector or
2251 .Cm gotadmin cleanup .
2253 If this option is used,
2255 does not require a work tree.
2256 None of the other options can be used together with
2260 .It Cm integrate Ar branch
2262 Integrate the specified
2264 into the work tree's current branch.
2265 Files in the work tree are updated to match the contents on the integrated
2267 and the reference of the work tree's branch is changed to point at the
2268 head commit of the integrated
2271 Both branches can be considered equivalent after integration since they
2272 will be pointing at the same commit.
2273 Both branches remain available for future work, if desired.
2274 In case the integrated
2276 is no longer needed it may be deleted with
2279 Show the status of each affected file, using the following status codes:
2280 .Bl -column YXZ description
2281 .It U Ta file was updated
2282 .It D Ta file was deleted
2283 .It A Ta new file was added
2284 .It \(a~ Ta versioned file is obstructed by a non-regular file
2285 .It ! Ta a missing versioned file was restored
2289 will refuse to run if certain preconditions are not met.
2290 Most importantly, the
2292 must have been rebased onto the work tree's current branch with
2294 before it can be integrated, in order to linearize commit history and
2295 resolve merge conflicts.
2296 If the work tree contains multiple base commits, it must first be updated
2297 to a single base commit with
2299 If changes have been staged with
2301 these changes must first be committed with
2305 If the work tree contains local changes, these changes must first be
2311 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2313 Create a merge commit based on the current branch of the work tree and
2316 If a linear project history is desired, then use of
2318 should be preferred over
2320 However, even strictly linear projects may require merge commits in order
2321 to merge in new versions of third-party code stored on vendor branches
2325 Merge commits are commits based on multiple parent commits.
2326 The tip commit of the work tree's current branch, which must be set with
2330 operation, will be used as the first parent.
2331 The tip commit of the specified
2333 will be used as the second parent.
2335 No ancestral relationship between the two branches is required.
2336 If the two branches have already been merged previously, only new changes
2339 It is not possible to create merge commits with more than two parents.
2340 If more than one branch needs to be merged, then multiple merge commits
2341 with two parents each can be created in sequence.
2343 While merging changes found on the
2345 into the work tree, show the status of each affected file,
2346 using the following status codes:
2347 .Bl -column YXZ description
2348 .It G Ta file was merged
2349 .It C Ta file was merged and conflicts occurred during merge
2350 .It ! Ta changes destined for a missing file were not merged
2351 .It D Ta file was deleted
2352 .It d Ta file's deletion was prevented by local modifications
2353 .It A Ta new file was added
2354 .It \(a~ Ta changes destined for a non-regular file were not merged
2355 .It ? Ta changes destined for an unversioned file were not merged
2358 If merge conflicts occur, the merge operation is interrupted and conflicts
2359 must be resolved before the merge operation can continue.
2360 If any files with destined changes are found to be missing or unversioned,
2361 or if files could not be deleted due to differences in deleted content,
2362 the merge operation will be interrupted to prevent potentially incomplete
2363 changes from being committed to the repository without user intervention.
2364 The work tree may be modified as desired and the merge can be continued
2365 once the changes present in the work tree are considered complete.
2366 Alternatively, the merge operation may be aborted which will leave
2367 the work tree's current branch unmodified.
2369 If a merge conflict is resolved in a way which renders all merged
2370 changes into no-op changes, the merge operation cannot continue
2371 and must be aborted.
2374 will refuse to run if certain preconditions are not met.
2377 is based on the work tree's current branch, then no merge commit can
2380 may be used to integrate the
2383 If the work tree is not yet fully updated to the tip commit of its
2384 branch, then the work tree must first be updated with
2386 If the work tree contains multiple base commits, it must first be updated
2387 to a single base commit with
2389 If changes have been staged with
2391 these changes must first be committed with
2395 If the work tree contains local changes, these changes must first be
2402 contains changes to files outside of the work tree's path prefix,
2403 the work tree cannot be used to merge this branch.
2413 commands will refuse to run while a merge operation is in progress.
2414 Other commands which manipulate the work tree may be used for
2415 conflict resolution purposes.
2422 Abort an interrupted merge operation.
2423 If this option is used, no other command-line arguments are allowed.
2425 Continue an interrupted merge operation.
2426 If this option is used, no other command-line arguments are allowed.
2428 Merge changes into the work tree as usual but do not create a merge
2430 The merge result can be adjusted as desired before a merge commit is
2433 Alternatively, the merge may be aborted with
2437 .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 ...
2439 Stage local changes for inclusion in the next commit.
2442 is specified, stage all changes in the work tree.
2443 Otherwise, stage changes at or within the specified paths.
2444 Paths may be staged if they are added, modified, or deleted according to
2447 Show the status of each affected file, using the following status codes:
2448 .Bl -column YXZ description
2449 .It A Ta file addition has been staged
2450 .It M Ta file modification has been staged
2451 .It D Ta file deletion has been staged
2454 Staged file contents are saved in newly created blob objects in the repository.
2455 These blobs will be referred to by tree objects once staged changes have been
2458 Staged changes affect the behaviour of
2463 While paths with staged changes exist, the
2465 command will refuse to commit any paths which do not have staged changes.
2466 Local changes created on top of staged changes can only be committed if
2467 the path is staged again, or if the staged changes are committed first.
2470 command will show both local changes and staged changes.
2473 command is able to display local changes relative to staged changes,
2474 and to display staged changes relative to the repository.
2477 command cannot revert staged changes but may be used to revert
2478 local changes created on top of staged changes.
2485 Instead of staging new changes, list paths which are already staged,
2486 along with the IDs of staged blob objects and stage status codes.
2487 If paths were provided on the command line, show the staged paths
2488 among the specified paths.
2489 Otherwise, show all staged paths.
2491 Instead of staging the entire content of a changed file, interactively
2492 select or reject changes for staging based on
2496 (reject change), and
2498 (quit staging this file) responses.
2499 If a file is in modified status, individual patches derived from the
2500 modified file content can be staged.
2501 Files in added or deleted status may only be staged or rejected in
2503 .It Fl F Ar response-script
2511 responses line-by-line from the specified
2513 file instead of prompting interactively.
2515 Allow staging of symbolic links which point outside of the path space
2516 that is under version control.
2519 will reject such symbolic links due to safety concerns.
2522 may decide to represent such a symbolic link as a regular file which contains
2523 the link's target path, rather than creating an actual symbolic link which
2524 points outside of the work tree.
2525 Use of this option is discouraged because external mechanisms such as
2527 are better suited for managing symbolic links to paths not under
2532 will refuse to run if certain preconditions are not met.
2533 If a file contains merge conflicts, these conflicts must be resolved first.
2534 If a file is found to be out of date relative to the head commit on the
2535 work tree's current branch, the file must be updated with
2537 before it can be staged (however, this does not prevent the file from
2538 becoming out-of-date at some point after having been staged).
2545 commands will refuse to run while staged changes exist.
2546 If staged changes cannot be committed because a staged path
2547 is out of date, the path must be unstaged with
2549 before it can be updated with
2551 and may then be staged again if necessary.
2553 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2555 Merge staged changes back into the work tree and put affected paths
2556 back into non-staged status.
2559 is specified, unstage all staged changes across the entire work tree.
2560 Otherwise, unstage changes at or within the specified paths.
2562 Show the status of each affected file, using the following status codes:
2563 .Bl -column YXZ description
2564 .It G Ta file was unstaged
2565 .It C Ta file was unstaged and conflicts occurred during merge
2566 .It ! Ta changes destined for a missing file were not merged
2567 .It D Ta file was staged as deleted and still is deleted
2568 .It d Ta file's deletion was prevented by local modifications
2569 .It \(a~ Ta changes destined for a non-regular file were not merged
2577 Instead of unstaging the entire content of a changed file, interactively
2578 select or reject changes for unstaging based on
2582 (keep change staged), and
2584 (quit unstaging this file) responses.
2585 If a file is staged in modified status, individual patches derived from the
2586 staged file content can be unstaged.
2587 Files staged in added or deleted status may only be unstaged in their entirety.
2588 .It Fl F Ar response-script
2596 responses line-by-line from the specified
2598 file instead of prompting interactively.
2600 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2601 Parse and print contents of objects to standard output in a line-based
2603 Content of commit, tree, and tag objects is printed in a way similar
2604 to the actual content stored in such objects.
2605 Blob object contents are printed as they would appear in files on disk.
2607 Attempt to interpret each argument as a reference, a tag name, or
2608 an object ID SHA1 hash.
2609 References will be resolved to an object ID.
2610 Tag names will resolved to a tag object.
2611 An abbreviated hash argument will be expanded to a full SHA1 hash
2612 automatically, provided the abbreviation is unique.
2614 If none of the above interpretations produce a valid result, or if the
2616 option is used, attempt to interpret the argument as a path which will
2617 be resolved to the ID of an object found at this path in the repository.
2624 Look up paths in the specified
2626 If this option is not used, paths are looked up in the commit resolved
2627 via the repository's HEAD reference.
2628 The expected argument is a commit ID SHA1 hash or an existing reference
2629 or tag name which will be resolved to a commit ID.
2630 An abbreviated hash argument will be expanded to a full SHA1 hash
2631 automatically, provided the abbreviation is unique.
2632 .It Fl r Ar repository-path
2633 Use the repository at the specified path.
2634 If not specified, assume the repository is located at or above the current
2636 If this directory is a
2638 work tree, use the repository path associated with this work tree.
2640 Interpret all arguments as paths only.
2641 This option can be used to resolve ambiguity in cases where paths
2642 look like tag names, reference names, or object IDs.
2644 .It Cm info Op Ar path ...
2645 Display meta-data stored in a work tree.
2650 The work tree to use is resolved implicitly by walking upwards from the
2651 current working directory.
2655 arguments are specified, show additional per-file information for tracked
2656 files located at or within these paths.
2659 argument corresponds to the work tree's root directory, display information
2660 for all tracked files.
2663 .Bl -tag -width GOT_AUTHOR
2665 The author's name and email address for
2670 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2673 may fail to parse commits without an email address in author data,
2677 environment variables with a missing email address.
2679 .Ev GOT_AUTHOR will be overridden by configuration settings in
2685 configuration settings in the repository's
2692 configuration settings contained in Git's global
2694 configuration file will only be used if neither
2698 environment variable provide author information.
2699 .It Ev VISUAL , EDITOR
2700 The editor spawned by
2708 text editor will be spawned in order to give
2710 the attention it deserves.
2711 .It Ev GOT_LOG_DEFAULT_LIMIT
2712 The default limit on the number of commits traversed by
2714 If set to zero, the limit is unbounded.
2715 This variable will be silently ignored if it is set to a non-numeric value.
2718 .Bl -tag -width packed-refs -compact
2720 Repository-wide configuration settings for
2724 configuration file located in the root directory of a Git repository
2725 supersedes any relevant settings in Git's
2729 .It Pa .got/got.conf
2730 Worktree-specific configuration settings for
2734 configuration file in the
2736 meta-data directory of a work tree supersedes any relevant settings in
2739 configuration file and Git's
2746 Enable tab-completion of
2751 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2753 Clone an existing Git repository for use with
2757 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2759 Use of HTTP URLs currently requires
2763 .Dl $ git clone --bare https://github.com/openbsd/src.git
2765 Alternatively, for quick and dirty local testing of
2767 a new Git repository could be created and populated with files,
2768 e.g. from a temporary CVS checkout located at
2771 .Dl $ got init /var/git/src.git
2772 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2774 Check out a work tree from the Git repository to /usr/src:
2776 .Dl $ got checkout /var/git/src.git /usr/src
2778 View local changes in a work tree directory:
2780 .Dl $ got diff | less
2782 In a work tree, display files in a potentially problematic state:
2784 .Dl $ got status -s 'C!~?'
2786 Interactively revert selected local changes in a work tree directory:
2788 .Dl $ got revert -p -R\ .
2790 In a work tree or a git repository directory, list all branch references:
2794 In a work tree or a git repository directory, create a new branch called
2795 .Dq unified-buffer-cache
2796 which is forked off the
2800 .Dl $ got branch -c master unified-buffer-cache
2802 Switch an existing work tree to the branch
2803 .Dq unified-buffer-cache .
2804 Local changes in the work tree will be preserved and merged if necessary:
2806 .Dl $ got update -b unified-buffer-cache
2808 Create a new commit from local changes in a work tree directory.
2809 This new commit will become the head commit of the work tree's current branch:
2813 In a work tree or a git repository directory, view changes committed in
2814 the 3 most recent commits to the work tree's branch, or the branch resolved
2815 via the repository's HEAD reference, respectively:
2817 .Dl $ got log -p -l 3
2819 As above, but display changes in the order in which
2821 could apply them in sequence:
2823 .Dl $ got log -p -l 3 -R
2825 In a work tree or a git repository directory, log the history of a subdirectory:
2827 .Dl $ got log sys/uvm
2829 While operating inside a work tree, paths are specified relative to the current
2830 working directory, so this command will log the subdirectory
2833 .Dl $ cd sys/uvm && got log\ .
2835 And this command has the same effect:
2837 .Dl $ cd sys/dev/usb && got log ../../uvm
2839 And this command displays work tree meta-data about all tracked files:
2842 .Dl $ got info\ . | less
2844 Add new files and remove obsolete files in a work tree directory:
2846 .Dl $ got add sys/uvm/uvm_ubc.c
2847 .Dl $ got remove sys/uvm/uvm_vnode.c
2849 Create a new commit from local changes in a work tree directory
2850 with a pre-defined log message.
2852 .Dl $ got commit -m 'unify the buffer cache'
2854 Alternatively, create a new commit from local changes in a work tree
2855 directory with a log message that has been prepared in the file
2858 .Dl $ got commit -F /tmp/msg
2860 Update any work tree checked out from the
2861 .Dq unified-buffer-cache
2862 branch to the latest commit on this branch:
2866 Roll file content on the unified-buffer-cache branch back by one commit,
2867 and then fetch the rolled-back change into the work tree as a local change
2868 to be amended and perhaps committed again:
2870 .Dl $ got backout unified-buffer-cache
2871 .Dl $ got commit -m 'roll back previous'
2872 .Dl $ # now back out the previous backout :-)
2873 .Dl $ got backout unified-buffer-cache
2875 Fetch new changes on the remote repository's
2877 branch, making them visible on the local repository's
2884 In a repository created with a HTTP URL and
2885 .Cm git clone --bare
2888 command must be used instead:
2890 .Dl $ cd /var/git/src.git
2891 .Dl $ git fetch origin master:refs/remotes/origin/master
2895 branch to merge the new changes that are now visible on the
2900 .Dl $ got update -b origin/master
2901 .Dl $ got rebase master
2904 .Dq unified-buffer-cache
2905 branch on top of the new head commit of the
2909 .Dl $ got update -b master
2910 .Dl $ got rebase unified-buffer-cache
2912 Create a patch from all changes on the unified-buffer-cache branch.
2913 The patch can be mailed out for review and applied to
2917 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2919 Edit the entire commit history of the
2920 .Dq unified-buffer-cache
2923 .Dl $ got update -b unified-buffer-cache
2924 .Dl $ got update -c master
2927 Before working against existing branches in a repository cloned with
2928 .Cm git clone --bare
2933 must be configured to map all references in the remote repository
2936 namespace of the local repository.
2937 This can be achieved by setting Git's
2938 .Pa remote.origin.fetch
2939 configuration variable to the value
2940 .Dq +refs/heads/*:refs/remotes/origin/*
2945 .Dl $ cd /var/git/repo
2946 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2950 option must be disabled:
2952 .Dl $ cd /var/git/repo
2953 .Dl $ git config remote.origin.mirror false
2955 Alternatively, the following
2957 configuration item can be added manually to the Git repository's
2961 .Dl [remote \&"origin\&"]
2963 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2966 This configuration leaves the local repository's
2968 namespace free for use by local branches checked out with
2970 and, if needed, created with
2973 .Dq refs/remotes/origin
2974 namespace can now be updated with incoming changes from the remote
2979 without extra command line arguments.
2980 Newly fetched changes can be examined with
2983 Display changes on the remote repository's version of the
2985 branch, as of the last time
2989 .Dl $ got log -c origin/master | less
2991 As shown here, most commands accept abbreviated reference names such as
2994 .Dq refs/remotes/origin/master .
2995 The latter is only needed in case of ambiguity.
2998 must be used to merge changes which are visible on the
3003 This will also merge local changes, if any, with the incoming changes:
3005 .Dl $ got update -b origin/master
3006 .Dl $ got rebase master
3008 In order to make changes committed to the
3009 .Dq unified-buffer-cache
3013 .Dq unified-buffer-cache
3014 branch must first be rebased onto the
3018 .Dl $ got update -b master
3019 .Dl $ got rebase unified-buffer-cache
3022 .Dq unified-buffer-cache
3023 branch can now be made visible on the
3027 Because the rebase operation switched the work tree to the
3028 .Dq unified-buffer-cache
3029 branch, the work tree must be switched back to the
3033 .Dl $ got update -b master
3034 .Dl $ got integrate unified-buffer-cache
3038 branch, log messages for local changes can now be amended with
3040 by other developers and any other important new information:
3042 .Dl $ got update -c origin/master
3043 .Dl $ got histedit -m
3045 If the remote repository offers write access, local changes on the
3047 branch can be sent to the remote repository with
3051 can be run without further arguments.
3052 The arguments shown here match defaults, provided the work tree's
3053 current branch is the
3057 .Dl $ got send -b master origin
3059 If the remote repository requires the HTTPS protocol, the
3061 command must be used instead:
3063 .Dl $ cd /var/git/src.git
3064 .Dl $ git push origin master
3068 .Xr git-repository 5 ,
3069 .Xr got-worktree 5 ,
3072 .An Stefan Sperling Aq Mt stsp@openbsd.org
3073 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3074 .An Joshua Stein Aq Mt jcs@openbsd.org
3075 .An Ori Bernstein Aq Mt ori@openbsd.org
3078 is a work-in-progress and some features remain to be implemented.
3080 At present, the user has to fall back on
3082 to perform some tasks.
3086 Reading from remote repositories over HTTP or HTTPS protocols requires
3091 Writing to remote repositories over HTTP or HTTPS protocols requires
3094 The creation of merge commits with more than two parent commits requires
3097 In situations where files or directories were moved around
3099 will not automatically merge changes to new locations and
3101 will usually produce better results.
