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 Cannot be used together with the
829 .It Fl S Ar search-pattern
830 If specified, show only commits with a log message, author name,
831 committer name, or ID SHA1 hash matched by the extended regular
834 Lines in committed patches will be matched if
837 File paths changed by a commit will be matched if
840 Regular expression syntax is documented in
842 .It Fl r Ar repository-path
843 Use the repository at the specified path.
844 If not specified, assume the repository is located at or above the current
846 If this directory is a
848 work tree, use the repository path associated with this work tree.
850 Determine a set of commits to display as usual, but display these commits
853 Stop traversing commit history immediately after the specified
856 This option has no effect if the specified
861 .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 ...
863 When invoked within a work tree without any arguments, display all
864 local changes in the work tree.
867 arguments are specified, only show changes within the specified paths.
869 If two arguments are provided, treat each argument as a reference, a tag
870 name, or an object ID SHA1 hash, and display differences between the
871 corresponding objects.
872 Both objects must be of the same type (blobs, trees, or commits).
873 An abbreviated hash argument will be expanded to a full SHA1 hash
874 automatically, provided the abbreviation is unique.
875 If none of these interpretations produce a valid result or if the
880 is running in a work tree, attempt to interpret the two arguments as paths.
887 Treat file contents as ASCII text even if binary data is detected.
889 Show differences between commits in the repository.
890 This options may be used up to two times.
891 When used only once, show differences between the specified
893 and its first parent commit.
894 When used twice, show differences between the two specified commits.
896 The expected argument is a commit ID SHA1 hash or an existing reference
897 or tag name which will be resolved to a commit ID.
898 An abbreviated hash argument will be expanded to a full SHA1 hash
899 automatically, provided the abbreviation is unique.
903 option is used, all non-option arguments will be interpreted as paths.
906 arguments are provided, only show differences for the specified paths.
908 Cannot be used together with the
912 Set the number of context lines shown in the diff.
913 By default, 3 lines of context are shown.
914 .It Fl r Ar repository-path
915 Use the repository at the specified path.
916 If not specified, assume the repository is located at or above the current
918 If this directory is a
920 work tree, use the repository path associated with this work tree.
922 Show changes staged with
924 instead of showing local changes in the work tree.
925 This option is only valid when
927 is invoked in a work tree.
929 Interpret all arguments as paths only.
930 This option can be used to resolve ambiguity in cases where paths
931 look like tag names, reference names, or object IDs.
932 This option is only valid when
934 is invoked in a work tree.
936 Ignore whitespace-only changes.
939 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
941 Display line-by-line history of a file at the specified path.
948 Start traversing history at the specified
950 The expected argument is a commit ID SHA1 hash or an existing reference
951 or tag name which will be resolved to a commit ID.
952 An abbreviated hash argument will be expanded to a full SHA1 hash
953 automatically, provided the abbreviation is unique.
954 .It Fl r Ar repository-path
955 Use the repository at the specified path.
956 If not specified, assume the repository is located at or above the current
958 If this directory is a
960 work tree, use the repository path associated with this work tree.
963 .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
965 Display a listing of files and directories at the specified
966 directory path in the repository.
967 Entries shown in this listing may carry one of the following trailing
969 .Bl -column YXZ description
970 .It @ Ta entry is a symbolic link
971 .It / Ta entry is a directory
972 .It * Ta entry is an executable file
973 .It $ Ta entry is a Git submodule
976 Symbolic link entries are also annotated with the target path of the link.
980 is specified, list the repository path corresponding to the current
981 directory of the work tree, or the root directory of the repository
982 if there is no work tree.
989 List files and directories as they appear in the specified
991 The expected argument is a commit ID SHA1 hash or an existing reference
992 or tag name which will be resolved to a commit ID.
993 An abbreviated hash argument will be expanded to a full SHA1 hash
994 automatically, provided the abbreviation is unique.
995 .It Fl r Ar repository-path
996 Use the repository at the specified path.
997 If not specified, assume the repository is located at or above the current
999 If this directory is a
1001 work tree, use the repository path associated with this work tree.
1003 Show object IDs of files (blob objects) and directories (tree objects).
1005 Recurse into sub-directories in the repository.
1007 .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
1008 Manage references in a repository.
1010 References may be listed, created, deleted, and changed.
1011 When creating, deleting, or changing a reference the specified
1013 must be an absolute reference name, i.e. it must begin with
1020 .It Fl r Ar repository-path
1021 Use the repository at the specified path.
1022 If not specified, assume the repository is located at or above the current
1024 If this directory is a
1026 work tree, use the repository path associated with this work tree.
1028 List references in the repository.
1031 is specified, list all existing references in the repository.
1034 is a reference namespace, list all references in this namespace.
1035 Otherwise, show only the reference with the given
1037 Cannot be used together with any other options except
1042 Sort listed references by modification time (most recently modified first)
1043 instead of sorting by lexicographical order.
1044 Use of this option requires the
1046 option to be used as well.
1048 Create a reference or change an existing reference.
1049 The reference with the specified
1051 will point at the specified
1055 argument is a ID SHA1 hash or an existing reference or tag name which will
1056 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1057 Cannot be used together with any other options except
1059 .It Fl s Ar reference
1060 Create a symbolic reference, or change an existing symbolic reference.
1061 The symbolic reference with the specified
1063 will point at the specified
1065 which must already exist in the repository.
1066 Care should be taken not to create loops between references when
1067 this option is used.
1068 Cannot be used together with any other options except
1071 Delete the reference with the specified
1073 from the repository.
1074 Any commit, tree, tag, and blob objects belonging to deleted references
1075 remain in the repository and may be removed separately with
1076 Git's garbage collector or
1077 .Cm gotadmin cleanup .
1078 Cannot be used together with any other options except
1082 .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
1084 Create, list, or delete branches.
1086 Local branches are managed via references which live in the
1088 reference namespace.
1091 command creates references in this namespace only.
1093 When deleting branches, the specified
1097 reference namespace first.
1098 If no corresponding branch is found, the
1100 namespace will be searched next.
1102 If invoked in a work tree without any arguments, print the name of the
1103 work tree's current branch.
1107 argument is passed, attempt to create a branch reference with the given name.
1108 By default the new branch reference will point at the latest commit on the
1109 work tree's current branch if invoked in a work tree, and otherwise to a commit
1110 resolved via the repository's HEAD reference.
1112 If invoked in a work tree, once the branch was created successfully
1113 switch the work tree's head reference to the newly created branch and
1114 update files across the entire work tree, just like
1115 .Cm got update -b Ar name
1117 Show the status of each affected file, using the following status codes:
1118 .Bl -column YXZ description
1119 .It U Ta file was updated and contained no local changes
1120 .It G Ta file was updated and local changes were merged cleanly
1121 .It C Ta file was updated and conflicts occurred during merge
1122 .It D Ta file was deleted
1123 .It A Ta new file was added
1124 .It \(a~ Ta versioned file is obstructed by a non-regular file
1125 .It ! Ta a missing versioned file was restored
1133 Make a newly created branch reference point at the specified
1137 argument is a commit ID SHA1 hash or an existing reference
1138 or tag name which will be resolved to a commit ID.
1139 .It Fl r Ar repository-path
1140 Use the repository at the specified path.
1141 If not specified, assume the repository is located at or above the current
1143 If this directory is a
1145 work tree, use the repository path associated with this work tree.
1147 List all existing branches in the repository, including copies of remote
1148 repositories' branches in the
1150 reference namespace.
1152 If invoked in a work tree, the work tree's current branch is shown
1153 with one the following annotations:
1154 .Bl -column YXZ description
1155 .It * Ta work tree's base commit matches the branch tip
1156 .It \(a~ Ta work tree's base commit is out-of-date
1159 Sort listed branches by modification time (most recently modified first)
1160 instead of sorting by lexicographical order.
1163 reference namespace are listed before branches in
1166 Use of this option requires the
1168 option to be used as well.
1170 Delete the branch with the specified
1176 reference namespace.
1178 Only the branch reference is deleted.
1179 Any commit, tree, and blob objects belonging to the branch
1180 remain in the repository and may be removed separately with
1181 Git's garbage collector or
1182 .Cm gotadmin cleanup .
1184 Do not switch and update the work tree after creating a new branch.
1186 .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
1187 Manage tags in a repository.
1189 Tags are managed via references which live in the
1191 reference namespace.
1194 command operates on references in this namespace only.
1195 References in this namespace point at tag objects which contain a pointer
1196 to another object, a tag message, as well as author and timestamp information.
1198 Attempt to create a tag with the given
1200 and make this tag point at the given
1202 If no commit is specified, default to the latest commit on the work tree's
1203 current branch if invoked in a work tree, and to a commit resolved via
1204 the repository's HEAD reference otherwise.
1211 Make the newly created tag reference point at the specified
1215 argument is a commit ID SHA1 hash or an existing reference or tag name which
1216 will be resolved to a commit ID.
1217 An abbreviated hash argument will be expanded to a full SHA1 hash
1218 automatically, provided the abbreviation is unique.
1220 Use the specified tag message when creating the new tag.
1225 opens a temporary file in an editor where a tag message can be written.
1226 .It Fl r Ar repository-path
1227 Use the repository at the specified path.
1228 If not specified, assume the repository is located at or above the current
1230 If this directory is a
1232 work tree, use the repository path associated with this work tree.
1234 List all existing tags in the repository instead of creating a new tag.
1235 If this option is used, no other command-line arguments are allowed.
1240 command will not delete tags or change existing tags.
1241 If a tag must be deleted, the
1243 command may be used to delete a tag's reference.
1244 This should only be done if the tag has not already been copied to
1246 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1247 Schedule unversioned files in a work tree for addition to the
1248 repository in the next commit.
1249 By default, files which match a
1251 ignore pattern will not be added.
1258 Permit recursion into directories.
1259 If this option is not specified,
1261 will refuse to run if a specified
1265 Add files even if they match a
1270 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1272 Remove versioned files from a work tree and schedule them for deletion
1273 from the repository in the next commit.
1280 Perform the operation even if a file contains local modifications,
1281 and do not raise an error if a specified
1283 does not exist on disk.
1285 Keep affected files on disk.
1287 Permit recursion into directories.
1288 If this option is not specified,
1290 will refuse to run if a specified
1293 .It Fl s Ar status-codes
1294 Only delete files with a modification status matching one of the
1295 single-character status codes contained in the
1298 The following status codes may be specified:
1299 .Bl -column YXZ description
1300 .It M Ta modified file (this implies the
1303 .It ! Ta versioned file expected on disk but missing
1307 .It Cm patch Oo Fl n Oc Oo Fl p Ar strip-count Oc Oo Fl R Oc Op Ar patchfile
1311 to files in a work tree.
1312 Files added or removed by a patch will be scheduled for addition or removal in
1315 The patch must be in the unified diff format as produced by
1322 diff when invoked with their
1327 argument is provided, read unified diff data from standard input instead.
1331 contains multiple patches, then attempt to apply each of them in sequence.
1333 Show the status of each affected file, using the following status codes:
1334 .Bl -column XYZ description
1335 .It M Ta file was modified
1336 .It D Ta file was deleted
1337 .It A Ta file was added
1338 .It # Ta failed to patch the file
1341 If a change does not match at its exact line number, attempt to
1342 apply it somewhere else in the file if a good spot can be found.
1343 Otherwise, the patch will fail to apply.
1347 will refuse to apply a patch if certain preconditions are not met.
1348 Files to be deleted must already be under version control, and must
1349 not have been scheduled for deletion already.
1350 Files to be added must not yet be under version control and must not
1351 already be present on disk.
1352 Files to be modified must already be under version control and may not
1353 contain conflict markers.
1355 If an error occurs, the
1357 operation will be aborted.
1358 Any changes made to the work tree up to this point will be left behind.
1359 Such changes can be viewed with
1361 and can be reverted with
1370 Do not make any modifications to the work tree.
1371 This can be used to check whether a patch would apply without issues.
1374 contains diffs that affect the same file multiple times, the results
1375 displayed may be incorrect.
1376 .It Fl p Ar strip-count
1377 Specify the number of leading path components to strip from paths
1386 path prefixes generated by
1388 will be recognized and stripped automatically.
1390 Reverse the patch before applying it.
1393 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1395 Revert any local changes in files at the specified paths in a work tree.
1396 File contents will be overwritten with those contained in the
1397 work tree's base commit.
1398 There is no way to bring discarded changes back after
1401 If a file was added with
1403 it will become an unversioned file again.
1404 If a file was deleted with
1406 it will be restored.
1413 Instead of reverting all changes in files, interactively select or reject
1414 changes to revert based on
1420 (quit reverting this file) responses.
1421 If a file is in modified status, individual patches derived from the
1422 modified file content can be reverted.
1423 Files in added or deleted status may only be reverted in their entirety.
1424 .It Fl F Ar response-script
1432 responses line-by-line from the specified
1434 file instead of prompting interactively.
1436 Permit recursion into directories.
1437 If this option is not specified,
1439 will refuse to run if a specified
1444 .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 ...
1446 Create a new commit in the repository from changes in a work tree
1447 and use this commit as the new base commit for the work tree.
1450 is specified, commit all changes in the work tree.
1451 Otherwise, commit changes at or within the specified paths.
1453 If changes have been explicitly staged for commit with
1455 only commit staged changes and reject any specified paths which
1456 have not been staged.
1459 opens a temporary file in an editor where a log message can be written
1467 options are used together.
1469 Show the status of each affected file, using the following status codes:
1470 .Bl -column YXZ description
1471 .It M Ta modified file
1472 .It D Ta file was deleted
1473 .It A Ta new file was added
1474 .It m Ta modified file modes (executable bit only)
1477 Files which are not part of the new commit will retain their previously
1478 recorded base commit.
1481 commands may refuse to run while the work tree contains files from
1482 multiple base commits.
1483 The base commit of such a work tree can be made consistent by running
1485 across the entire work tree.
1489 command requires the
1491 environment variable to be set,
1492 unless an author has been configured in
1498 configuration settings can be
1499 obtained from the repository's
1501 file or from Git's global
1510 Use the prepared log message stored in the file found at
1512 when creating the new commit.
1514 opens a temporary file in an editor where the prepared log message can be
1515 reviewed and edited further if needed.
1516 Cannot be used together with the
1520 Use the specified log message when creating the new commit.
1521 Cannot be used together with the
1525 This option prevents
1527 from opening the commit message in an editor.
1528 It has no effect unless it is used together with the
1530 option and is intended for non-interactive use such as scripting.
1532 Allow the addition of symbolic links which point outside of the path space
1533 that is under version control.
1536 will reject such symbolic links due to safety concerns.
1539 may decide to represent such a symbolic link as a regular file which contains
1540 the link's target path, rather than creating an actual symbolic link which
1541 points outside of the work tree.
1542 Use of this option is discouraged because external mechanisms such as
1544 are better suited for managing symbolic links to paths not under
1549 will refuse to run if certain preconditions are not met.
1550 If the work tree's current branch is not in the
1552 reference namespace, new commits may not be created on this branch.
1553 Local changes may only be committed if they are based on file content
1554 found in the most recent commit on the work tree's branch.
1555 If a path is found to be out of date,
1557 must be used first in order to merge local changes with changes made
1560 .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
1562 Send new changes to a remote repository.
1564 .Ar remote-repository
1568 The remote repository's URL is obtained from the corresponding entry in
1572 file of the local repository, as created by
1575 All objects corresponding to new changes will be written to a temporary
1576 pack file which is then uploaded to the server.
1577 Upon success, references in the
1579 reference namespace of the local repository will be updated to point at
1580 the commits which have been sent.
1582 By default, changes will only be sent if they are based on up-to-date
1583 copies of relevant branches in the remote repository.
1584 If any changes to be sent are based on out-of-date copies or would
1585 otherwise break linear history of existing branches, new changes must
1586 be fetched from the server with
1588 and local branches must be rebased with
1595 option can be used to make exceptions to these requirements.
1602 Send all branches from the local repository's
1604 reference namespace.
1607 option is equivalent to listing all branches with multiple
1610 Cannot be used together with the
1616 from the local repository's
1618 reference namespace.
1619 This option may be specified multiple times to build a list of branches
1621 If this option is not specified, default to the work tree's current branch
1622 if invoked in a work tree, or to the repository's HEAD reference.
1623 Cannot be used together with the
1627 Delete the specified
1629 from the remote repository's
1631 reference namespace.
1632 This option may be specified multiple times to build a list of branches
1635 Only references are deleted.
1636 Any commit, tree, tag, and blob objects belonging to deleted branches
1637 may become subject to deletion by Git's garbage collector running on
1640 Requesting deletion of branches results in an error if the server
1641 does not support this feature or disallows the deletion of branches
1642 based on its configuration.
1644 Attempt to force the server to overwrite existing branches or tags
1645 in the remote repository, even when
1649 would usually be required before changes can be sent.
1650 The server may reject forced requests regardless, depending on its
1653 Any commit, tree, tag, and blob objects belonging to overwritten branches
1654 or tags may become subject to deletion by Git's garbage collector running
1659 reference namespace is globally shared between all repositories.
1662 option to overwrite tags is discouraged because it can lead to
1663 inconsistencies between the tags present in different repositories.
1664 In general, creating a new tag with a different name is recommended
1665 instead of overwriting an existing tag.
1669 option is particularly discouraged if changes being sent are based
1670 on an out-of-date copy of a branch in the remote repository.
1671 Instead of using the
1673 option, new changes should
1676 and local branches should be rebased with
1678 followed by another attempt to send the changes.
1682 option should only be needed in situations where the remote repository's
1683 copy of a branch or tag is known to be out-of-date and is considered
1685 The risks of creating inconsistencies between different repositories
1686 should also be taken into account.
1687 .It Fl r Ar repository-path
1688 Use the repository at the specified path.
1689 If not specified, assume the repository is located at or above the current
1691 If this directory is a
1693 work tree, use the repository path associated with this work tree.
1697 from the local repository's
1699 reference namespace, in addition to any branches that are being sent.
1702 option may be specified multiple times to build a list of tags to send.
1703 No tags will be sent if the
1707 Raise an error if the specified
1709 already exists in the remote repository, unless the
1711 option is used to overwrite the server's copy of the tag.
1712 In general, creating a new tag with a different name is recommended
1713 instead of overwriting an existing tag.
1715 Cannot be used together with the
1719 Attempt to send all tags from the local repository's
1721 reference namespace.
1724 option is equivalent to listing all tags with multiple
1727 Cannot be used together with the
1731 Suppress progress reporting output.
1732 The same option will be passed to
1739 to print debugging messages to standard error output.
1740 The same option will be passed to
1743 Multiple -v options increase the verbosity.
1747 .It Cm cherrypick Ar commit
1749 Merge changes from a single
1754 should be on a different branch than the work tree's base commit.
1755 The expected argument is a reference or a commit ID SHA1 hash.
1756 An abbreviated hash argument will be expanded to a full SHA1 hash
1757 automatically, provided the abbreviation is unique.
1759 Show the status of each affected file, using the following status codes:
1760 .Bl -column YXZ description
1761 .It G Ta file was merged
1762 .It C Ta file was merged and conflicts occurred during merge
1763 .It ! Ta changes destined for a missing file were not merged
1764 .It D Ta file was deleted
1765 .It d Ta file's deletion was prevented by local modifications
1766 .It A Ta new file was added
1767 .It \(a~ Ta changes destined for a non-regular file were not merged
1768 .It ? Ta changes destined for an unversioned file were not merged
1771 The merged changes will appear as local changes in the work tree, which
1774 amended manually or with further
1779 or discarded again with
1783 will refuse to run if certain preconditions are not met.
1784 If the work tree contains multiple base commits, it must first be updated
1785 to a single base commit with
1787 If any relevant files already contain merge conflicts, these
1788 conflicts must be resolved first.
1790 .It Cm backout Ar commit
1792 Reverse-merge changes from a single
1797 should be on the same branch as the work tree's base commit.
1798 The expected argument is a reference or a commit ID SHA1 hash.
1799 An abbreviated hash argument will be expanded to a full SHA1 hash
1800 automatically, provided the abbreviation is unique.
1802 Show the status of each affected file, using the following status codes:
1803 .Bl -column YXZ description
1804 .It G Ta file was merged
1805 .It C Ta file was merged and conflicts occurred during merge
1806 .It ! Ta changes destined for a missing file were not merged
1807 .It D Ta file was deleted
1808 .It d Ta file's deletion was prevented by local modifications
1809 .It A Ta new file was added
1810 .It \(a~ Ta changes destined for a non-regular file were not merged
1811 .It ? Ta changes destined for an unversioned file were not merged
1814 The reverse-merged changes will appear as local changes in the work tree,
1815 which may be viewed with
1817 amended manually or with further
1822 or discarded again with
1826 will refuse to run if certain preconditions are not met.
1827 If the work tree contains multiple base commits, it must first be updated
1828 to a single base commit with
1830 If any relevant files already contain merge conflicts, these
1831 conflicts must be resolved first.
1833 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1835 Rebase commits on the specified
1837 onto the tip of the current branch of the work tree.
1840 must share common ancestry with the work tree's current branch.
1841 Rebasing begins with the first descendant commit of the youngest
1842 common ancestor commit shared by the specified
1844 and the work tree's current branch, and stops once the tip commit
1851 is used as intended, the specified
1853 represents a local commit history and may already contain changes
1854 that are not yet visible in any other repositories.
1855 The work tree's current branch, which must be set with
1859 operation, represents a branch from a remote repository which shares
1860 a common history with the specified
1862 but has progressed, and perhaps diverged, due to commits added to the
1865 Rebased commits are accumulated on a temporary branch which the work tree
1866 will remain switched to throughout the entire rebase operation.
1867 Commits on this branch represent the same changes with the same log
1868 messages as their counterparts on the original
1870 but with different commit IDs.
1871 Once rebasing has completed successfully, the temporary branch becomes
1872 the new version of the specified
1874 and the work tree is automatically switched to it.
1876 Old commits in their pre-rebase state are automatically backed up in the
1877 .Dq refs/got/backup/rebase
1878 reference namespace.
1879 As long as these references are not removed older versions of rebased
1880 commits will remain in the repository and can be viewed with the
1883 Removal of these references makes objects which become unreachable via
1884 any reference subject to removal by Git's garbage collector or
1885 .Cm gotadmin cleanup .
1887 While rebasing commits, show the status of each affected file,
1888 using the following status codes:
1889 .Bl -column YXZ description
1890 .It G Ta file was merged
1891 .It C Ta file was merged and conflicts occurred during merge
1892 .It ! Ta changes destined for a missing file were not merged
1893 .It D Ta file was deleted
1894 .It d Ta file's deletion was prevented by local modifications
1895 .It A Ta new file was added
1896 .It \(a~ Ta changes destined for a non-regular file were not merged
1897 .It ? Ta changes destined for an unversioned file were not merged
1900 If merge conflicts occur, the rebase operation is interrupted and may
1901 be continued once conflicts have been resolved.
1902 If any files with destined changes are found to be missing or unversioned,
1903 or if files could not be deleted due to differences in deleted content,
1904 the rebase operation will be interrupted to prevent potentially incomplete
1905 changes from being committed to the repository without user intervention.
1906 The work tree may be modified as desired and the rebase operation can be
1907 continued once the changes present in the work tree are considered complete.
1908 Alternatively, the rebase operation may be aborted which will leave
1910 unmodified and the work tree switched back to its original branch.
1912 If a merge conflict is resolved in a way which renders the merged
1913 change into a no-op change, the corresponding commit will be elided
1914 when the rebase operation continues.
1917 will refuse to run if certain preconditions are not met.
1918 If the work tree is not yet fully updated to the tip commit of its
1919 branch, then the work tree must first be updated with
1921 If changes have been staged with
1923 these changes must first be committed with
1927 If the work tree contains local changes, these changes must first be
1934 contains changes to files outside of the work tree's path prefix,
1935 the work tree cannot be used to rebase this branch.
1941 commands will refuse to run while a rebase operation is in progress.
1942 Other commands which manipulate the work tree may be used for
1943 conflict resolution purposes.
1947 is already based on the work tree's current branch, then no commits
1948 need to be rebased and
1950 will simply switch the work tree to the specified
1952 and update files in the work tree accordingly.
1959 Abort an interrupted rebase operation.
1960 If this option is used, no other command-line arguments are allowed.
1962 Continue an interrupted rebase operation.
1963 If this option is used, no other command-line arguments are allowed.
1965 Show a list of past rebase operations, represented by references in the
1966 .Dq refs/got/backup/rebase
1967 reference namespace.
1969 Display the author, date, and log message of each backed up commit,
1970 the object ID of the corresponding post-rebase commit, and
1971 the object ID of their common ancestor commit.
1972 Given these object IDs,
1979 options can be used to examine the history of either version of the branch,
1984 option can be used to create a new branch from a pre-rebase state if desired.
1988 is specified, only show commits which at some point in time represented this
1990 Otherwise, list all backed up commits for any branches.
1992 If this option is used,
1994 does not require a work tree.
1995 None of the other options can be used together with
1998 Delete backups created by past rebase operations, represented by references
2000 .Dq refs/got/backup/rebase
2001 reference namespace.
2005 is specified, only delete backups which at some point in time represented
2007 Otherwise, delete all references found within
2008 .Dq refs/got/backup/rebase .
2010 Any commit, tree, tag, and blob objects belonging to deleted backups
2011 remain in the repository and may be removed separately with
2012 Git's garbage collector or
2013 .Cm gotadmin cleanup .
2015 If this option is used,
2017 does not require a work tree.
2018 None of the other options can be used together with
2022 .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
2024 Edit commit history between the work tree's current base commit and
2025 the tip commit of the work tree's current branch.
2029 operation, the work tree's current branch must be set with
2031 to the branch which should be edited, unless this branch is already the
2032 current branch of the work tree.
2033 The tip of this branch represents the upper bound (inclusive) of commits
2038 Furthermore, the work tree's base commit
2041 to a point in this branch's commit history where editing should begin.
2042 This commit represents the lower bound (non-inclusive) of commits touched
2047 Editing of commit history is controlled via a
2049 which can be written in an editor based on a template, passed on the
2050 command line, or generated with the
2056 The format of the histedit script is line-based.
2057 Each line in the script begins with a command name, followed by
2058 whitespace and an argument.
2059 For most commands, the expected argument is a commit ID SHA1 hash.
2060 Any remaining text on the line is ignored.
2061 Lines which begin with the
2063 character are ignored entirely.
2065 The available commands are as follows:
2066 .Bl -column YXZ pick-commit
2067 .It pick Ar commit Ta Use the specified commit as it is.
2068 .It edit Ar commit Ta Use the specified commit but once changes have been
2069 merged into the work tree interrupt the histedit operation for amending.
2070 .It fold Ar commit Ta Combine the specified commit with the next commit
2071 listed further below that will be used.
2072 .It drop Ar commit Ta Remove this commit from the edited history.
2073 .It mesg Ar log-message Ta Use the specified single-line log message for
2074 the commit on the previous line.
2075 If the log message argument is left empty, open an editor where a new
2076 log message can be written.
2079 Every commit in the history being edited must be mentioned in the script.
2080 Lines may be re-ordered to change the order of commits in the edited history.
2081 No commit may be listed more than once.
2083 Edited commits are accumulated on a temporary branch which the work tree
2084 will remain switched to throughout the entire histedit operation.
2085 Once history editing has completed successfully, the temporary branch becomes
2086 the new version of the work tree's branch and the work tree is automatically
2089 Old commits in their pre-histedit state are automatically backed up in the
2090 .Dq refs/got/backup/histedit
2091 reference namespace.
2092 As long as these references are not removed older versions of edited
2093 commits will remain in the repository and can be viewed with the
2096 Removal of these references makes objects which become unreachable via
2097 any reference subject to removal by Git's garbage collector or
2098 .Cm gotadmin cleanup .
2100 While merging commits, show the status of each affected file,
2101 using the following status codes:
2102 .Bl -column YXZ description
2103 .It G Ta file was merged
2104 .It C Ta file was merged and conflicts occurred during merge
2105 .It ! Ta changes destined for a missing file were not merged
2106 .It D Ta file was deleted
2107 .It d Ta file's deletion was prevented by local modifications
2108 .It A Ta new file was added
2109 .It \(a~ Ta changes destined for a non-regular file were not merged
2110 .It ? Ta changes destined for an unversioned file were not merged
2113 If merge conflicts occur, the histedit operation is interrupted and may
2114 be continued once conflicts have been resolved.
2115 If any files with destined changes are found to be missing or unversioned,
2116 or if files could not be deleted due to differences in deleted content,
2117 the histedit operation will be interrupted to prevent potentially incomplete
2118 changes from being committed to the repository without user intervention.
2119 The work tree may be modified as desired and the histedit operation can be
2120 continued once the changes present in the work tree are considered complete.
2121 Alternatively, the histedit operation may be aborted which will leave
2122 the work tree switched back to its original branch.
2124 If a merge conflict is resolved in a way which renders the merged
2125 change into a no-op change, the corresponding commit will be elided
2126 when the histedit operation continues.
2129 will refuse to run if certain preconditions are not met.
2130 If the work tree's current branch is not in the
2132 reference namespace, the history of the branch may not be edited.
2133 If the work tree contains multiple base commits, it must first be updated
2134 to a single base commit with
2136 If changes have been staged with
2138 these changes must first be committed with
2142 If the work tree contains local changes, these changes must first be
2147 If the edited history contains changes to files outside of the work tree's
2148 path prefix, the work tree cannot be used to edit the history of this branch.
2155 commands will refuse to run while a histedit operation is in progress.
2156 Other commands which manipulate the work tree may be used, and the
2158 command may be used to commit arbitrary changes to the temporary branch
2159 while the histedit operation is interrupted.
2166 Abort an interrupted histedit operation.
2167 If this option is used, no other command-line arguments are allowed.
2169 Continue an interrupted histedit operation.
2170 If this option is used, no other command-line arguments are allowed.
2172 Interrupt the histedit operation for editing after merging each commit.
2173 This option is a quick equivalent to a histedit script which uses the
2175 command for all commits.
2178 option can only be used when starting a new histedit operation.
2179 If this option is used, no other command-line arguments are allowed.
2181 Fold all commits into a single commit.
2182 This option is a quick equivalent to a histedit script which folds all
2183 commits, combining them all into one commit.
2186 option can only be used when starting a new histedit operation.
2187 If this option is used, no other command-line arguments are allowed.
2188 .It Fl F Ar histedit-script
2191 instead of opening a temporary file in an editor where a histedit script
2194 Edit log messages only.
2195 This option is a quick equivalent to a histedit script which edits
2196 only log messages but otherwise leaves every picked commit as-is.
2199 option can only be used when starting a new histedit operation.
2200 If this option is used, no other command-line arguments are allowed.
2202 Show a list of past histedit operations, represented by references in the
2203 .Dq refs/got/backup/histedit
2204 reference namespace.
2206 Display the author, date, and log message of each backed up commit,
2207 the object ID of the corresponding post-histedit commit, and
2208 the object ID of their common ancestor commit.
2209 Given these object IDs,
2216 options can be used to examine the history of either version of the branch,
2221 option can be used to create a new branch from a pre-histedit state if desired.
2225 is specified, only show commits which at some point in time represented this
2227 Otherwise, list all backed up commits for any branches.
2229 If this option is used,
2231 does not require a work tree.
2232 None of the other options can be used together with
2235 Delete backups created by past histedit operations, represented by references
2237 .Dq refs/got/backup/histedit
2238 reference namespace.
2242 is specified, only delete backups which at some point in time represented
2244 Otherwise, delete all references found within
2245 .Dq refs/got/backup/histedit .
2247 Any commit, tree, tag, and blob objects belonging to deleted backups
2248 remain in the repository and may be removed separately with
2249 Git's garbage collector or
2250 .Cm gotadmin cleanup .
2252 If this option is used,
2254 does not require a work tree.
2255 None of the other options can be used together with
2259 .It Cm integrate Ar branch
2261 Integrate the specified
2263 into the work tree's current branch.
2264 Files in the work tree are updated to match the contents on the integrated
2266 and the reference of the work tree's branch is changed to point at the
2267 head commit of the integrated
2270 Both branches can be considered equivalent after integration since they
2271 will be pointing at the same commit.
2272 Both branches remain available for future work, if desired.
2273 In case the integrated
2275 is no longer needed it may be deleted with
2278 Show the status of each affected file, using the following status codes:
2279 .Bl -column YXZ description
2280 .It U Ta file was updated
2281 .It D Ta file was deleted
2282 .It A Ta new file was added
2283 .It \(a~ Ta versioned file is obstructed by a non-regular file
2284 .It ! Ta a missing versioned file was restored
2288 will refuse to run if certain preconditions are not met.
2289 Most importantly, the
2291 must have been rebased onto the work tree's current branch with
2293 before it can be integrated, in order to linearize commit history and
2294 resolve merge conflicts.
2295 If the work tree contains multiple base commits, it must first be updated
2296 to a single base commit with
2298 If changes have been staged with
2300 these changes must first be committed with
2304 If the work tree contains local changes, these changes must first be
2310 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2312 Create a merge commit based on the current branch of the work tree and
2315 If a linear project history is desired, then use of
2317 should be preferred over
2319 However, even strictly linear projects may require merge commits in order
2320 to merge in new versions of third-party code stored on vendor branches
2324 Merge commits are commits based on multiple parent commits.
2325 The tip commit of the work tree's current branch, which must be set with
2329 operation, will be used as the first parent.
2330 The tip commit of the specified
2332 will be used as the second parent.
2334 No ancestral relationship between the two branches is required.
2335 If the two branches have already been merged previously, only new changes
2338 It is not possible to create merge commits with more than two parents.
2339 If more than one branch needs to be merged, then multiple merge commits
2340 with two parents each can be created in sequence.
2342 While merging changes found on the
2344 into the work tree, show the status of each affected file,
2345 using the following status codes:
2346 .Bl -column YXZ description
2347 .It G Ta file was merged
2348 .It C Ta file was merged and conflicts occurred during merge
2349 .It ! Ta changes destined for a missing file were not merged
2350 .It D Ta file was deleted
2351 .It d Ta file's deletion was prevented by local modifications
2352 .It A Ta new file was added
2353 .It \(a~ Ta changes destined for a non-regular file were not merged
2354 .It ? Ta changes destined for an unversioned file were not merged
2357 If merge conflicts occur, the merge operation is interrupted and conflicts
2358 must be resolved before the merge operation can continue.
2359 If any files with destined changes are found to be missing or unversioned,
2360 or if files could not be deleted due to differences in deleted content,
2361 the merge operation will be interrupted to prevent potentially incomplete
2362 changes from being committed to the repository without user intervention.
2363 The work tree may be modified as desired and the merge can be continued
2364 once the changes present in the work tree are considered complete.
2365 Alternatively, the merge operation may be aborted which will leave
2366 the work tree's current branch unmodified.
2368 If a merge conflict is resolved in a way which renders all merged
2369 changes into no-op changes, the merge operation cannot continue
2370 and must be aborted.
2373 will refuse to run if certain preconditions are not met.
2376 is based on the work tree's current branch, then no merge commit can
2379 may be used to integrate the
2382 If the work tree is not yet fully updated to the tip commit of its
2383 branch, then the work tree must first be updated with
2385 If the work tree contains multiple base commits, it must first be updated
2386 to a single base commit with
2388 If changes have been staged with
2390 these changes must first be committed with
2394 If the work tree contains local changes, these changes must first be
2401 contains changes to files outside of the work tree's path prefix,
2402 the work tree cannot be used to merge this branch.
2412 commands will refuse to run while a merge operation is in progress.
2413 Other commands which manipulate the work tree may be used for
2414 conflict resolution purposes.
2421 Abort an interrupted merge operation.
2422 If this option is used, no other command-line arguments are allowed.
2424 Continue an interrupted merge operation.
2425 If this option is used, no other command-line arguments are allowed.
2427 Merge changes into the work tree as usual but do not create a merge
2429 The merge result can be adjusted as desired before a merge commit is
2432 Alternatively, the merge may be aborted with
2436 .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 ...
2438 Stage local changes for inclusion in the next commit.
2441 is specified, stage all changes in the work tree.
2442 Otherwise, stage changes at or within the specified paths.
2443 Paths may be staged if they are added, modified, or deleted according to
2446 Show the status of each affected file, using the following status codes:
2447 .Bl -column YXZ description
2448 .It A Ta file addition has been staged
2449 .It M Ta file modification has been staged
2450 .It D Ta file deletion has been staged
2453 Staged file contents are saved in newly created blob objects in the repository.
2454 These blobs will be referred to by tree objects once staged changes have been
2457 Staged changes affect the behaviour of
2462 While paths with staged changes exist, the
2464 command will refuse to commit any paths which do not have staged changes.
2465 Local changes created on top of staged changes can only be committed if
2466 the path is staged again, or if the staged changes are committed first.
2469 command will show both local changes and staged changes.
2472 command is able to display local changes relative to staged changes,
2473 and to display staged changes relative to the repository.
2476 command cannot revert staged changes but may be used to revert
2477 local changes created on top of staged changes.
2484 Instead of staging new changes, list paths which are already staged,
2485 along with the IDs of staged blob objects and stage status codes.
2486 If paths were provided on the command line, show the staged paths
2487 among the specified paths.
2488 Otherwise, show all staged paths.
2490 Instead of staging the entire content of a changed file, interactively
2491 select or reject changes for staging based on
2495 (reject change), and
2497 (quit staging this file) responses.
2498 If a file is in modified status, individual patches derived from the
2499 modified file content can be staged.
2500 Files in added or deleted status may only be staged or rejected in
2502 .It Fl F Ar response-script
2510 responses line-by-line from the specified
2512 file instead of prompting interactively.
2514 Allow staging of symbolic links which point outside of the path space
2515 that is under version control.
2518 will reject such symbolic links due to safety concerns.
2521 may decide to represent such a symbolic link as a regular file which contains
2522 the link's target path, rather than creating an actual symbolic link which
2523 points outside of the work tree.
2524 Use of this option is discouraged because external mechanisms such as
2526 are better suited for managing symbolic links to paths not under
2531 will refuse to run if certain preconditions are not met.
2532 If a file contains merge conflicts, these conflicts must be resolved first.
2533 If a file is found to be out of date relative to the head commit on the
2534 work tree's current branch, the file must be updated with
2536 before it can be staged (however, this does not prevent the file from
2537 becoming out-of-date at some point after having been staged).
2544 commands will refuse to run while staged changes exist.
2545 If staged changes cannot be committed because a staged path
2546 is out of date, the path must be unstaged with
2548 before it can be updated with
2550 and may then be staged again if necessary.
2552 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2554 Merge staged changes back into the work tree and put affected paths
2555 back into non-staged status.
2558 is specified, unstage all staged changes across the entire work tree.
2559 Otherwise, unstage changes at or within the specified paths.
2561 Show the status of each affected file, using the following status codes:
2562 .Bl -column YXZ description
2563 .It G Ta file was unstaged
2564 .It C Ta file was unstaged and conflicts occurred during merge
2565 .It ! Ta changes destined for a missing file were not merged
2566 .It D Ta file was staged as deleted and still is deleted
2567 .It d Ta file's deletion was prevented by local modifications
2568 .It \(a~ Ta changes destined for a non-regular file were not merged
2576 Instead of unstaging the entire content of a changed file, interactively
2577 select or reject changes for unstaging based on
2581 (keep change staged), and
2583 (quit unstaging this file) responses.
2584 If a file is staged in modified status, individual patches derived from the
2585 staged file content can be unstaged.
2586 Files staged in added or deleted status may only be unstaged in their entirety.
2587 .It Fl F Ar response-script
2595 responses line-by-line from the specified
2597 file instead of prompting interactively.
2599 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2600 Parse and print contents of objects to standard output in a line-based
2602 Content of commit, tree, and tag objects is printed in a way similar
2603 to the actual content stored in such objects.
2604 Blob object contents are printed as they would appear in files on disk.
2606 Attempt to interpret each argument as a reference, a tag name, or
2607 an object ID SHA1 hash.
2608 References will be resolved to an object ID.
2609 Tag names will resolved to a tag object.
2610 An abbreviated hash argument will be expanded to a full SHA1 hash
2611 automatically, provided the abbreviation is unique.
2613 If none of the above interpretations produce a valid result, or if the
2615 option is used, attempt to interpret the argument as a path which will
2616 be resolved to the ID of an object found at this path in the repository.
2623 Look up paths in the specified
2625 If this option is not used, paths are looked up in the commit resolved
2626 via the repository's HEAD reference.
2627 The expected argument is a commit ID SHA1 hash or an existing reference
2628 or tag name which will be resolved to a commit ID.
2629 An abbreviated hash argument will be expanded to a full SHA1 hash
2630 automatically, provided the abbreviation is unique.
2631 .It Fl r Ar repository-path
2632 Use the repository at the specified path.
2633 If not specified, assume the repository is located at or above the current
2635 If this directory is a
2637 work tree, use the repository path associated with this work tree.
2639 Interpret all arguments as paths only.
2640 This option can be used to resolve ambiguity in cases where paths
2641 look like tag names, reference names, or object IDs.
2643 .It Cm info Op Ar path ...
2644 Display meta-data stored in a work tree.
2649 The work tree to use is resolved implicitly by walking upwards from the
2650 current working directory.
2654 arguments are specified, show additional per-file information for tracked
2655 files located at or within these paths.
2658 argument corresponds to the work tree's root directory, display information
2659 for all tracked files.
2662 .Bl -tag -width GOT_AUTHOR
2664 The author's name and email address for
2669 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2672 may fail to parse commits without an email address in author data,
2676 environment variables with a missing email address.
2678 .Ev GOT_AUTHOR will be overridden by configuration settings in
2684 configuration settings in the repository's
2691 configuration settings contained in Git's global
2693 configuration file will only be used if neither
2697 environment variable provide author information.
2698 .It Ev VISUAL , EDITOR
2699 The editor spawned by
2707 text editor will be spawned in order to give
2709 the attention it deserves.
2710 .It Ev GOT_LOG_DEFAULT_LIMIT
2711 The default limit on the number of commits traversed by
2713 If set to zero, the limit is unbounded.
2714 This variable will be silently ignored if it is set to a non-numeric value.
2717 .Bl -tag -width packed-refs -compact
2719 Repository-wide configuration settings for
2723 configuration file located in the root directory of a Git repository
2724 supersedes any relevant settings in Git's
2728 .It Pa .got/got.conf
2729 Worktree-specific configuration settings for
2733 configuration file in the
2735 meta-data directory of a work tree supersedes any relevant settings in
2738 configuration file and Git's
2745 Enable tab-completion of
2750 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2752 Clone an existing Git repository for use with
2756 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2758 Use of HTTP URLs currently requires
2762 .Dl $ git clone --bare https://github.com/openbsd/src.git
2764 Alternatively, for quick and dirty local testing of
2766 a new Git repository could be created and populated with files,
2767 e.g. from a temporary CVS checkout located at
2770 .Dl $ got init /var/git/src.git
2771 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2773 Check out a work tree from the Git repository to /usr/src:
2775 .Dl $ got checkout /var/git/src.git /usr/src
2777 View local changes in a work tree directory:
2779 .Dl $ got diff | less
2781 In a work tree, display files in a potentially problematic state:
2783 .Dl $ got status -s 'C!~?'
2785 Interactively revert selected local changes in a work tree directory:
2787 .Dl $ got revert -p -R\ .
2789 In a work tree or a git repository directory, list all branch references:
2793 In a work tree or a git repository directory, create a new branch called
2794 .Dq unified-buffer-cache
2795 which is forked off the
2799 .Dl $ got branch -c master unified-buffer-cache
2801 Switch an existing work tree to the branch
2802 .Dq unified-buffer-cache .
2803 Local changes in the work tree will be preserved and merged if necessary:
2805 .Dl $ got update -b unified-buffer-cache
2807 Create a new commit from local changes in a work tree directory.
2808 This new commit will become the head commit of the work tree's current branch:
2812 In a work tree or a git repository directory, view changes committed in
2813 the 3 most recent commits to the work tree's branch, or the branch resolved
2814 via the repository's HEAD reference, respectively:
2816 .Dl $ got log -p -l 3
2818 As above, but display changes in the order in which
2820 could apply them in sequence:
2822 .Dl $ got log -p -l 3 -R
2824 In a work tree or a git repository directory, log the history of a subdirectory:
2826 .Dl $ got log sys/uvm
2828 While operating inside a work tree, paths are specified relative to the current
2829 working directory, so this command will log the subdirectory
2832 .Dl $ cd sys/uvm && got log\ .
2834 And this command has the same effect:
2836 .Dl $ cd sys/dev/usb && got log ../../uvm
2838 And this command displays work tree meta-data about all tracked files:
2841 .Dl $ got info\ . | less
2843 Add new files and remove obsolete files in a work tree directory:
2845 .Dl $ got add sys/uvm/uvm_ubc.c
2846 .Dl $ got remove sys/uvm/uvm_vnode.c
2848 Create a new commit from local changes in a work tree directory
2849 with a pre-defined log message.
2851 .Dl $ got commit -m 'unify the buffer cache'
2853 Alternatively, create a new commit from local changes in a work tree
2854 directory with a log message that has been prepared in the file
2857 .Dl $ got commit -F /tmp/msg
2859 Update any work tree checked out from the
2860 .Dq unified-buffer-cache
2861 branch to the latest commit on this branch:
2865 Roll file content on the unified-buffer-cache branch back by one commit,
2866 and then fetch the rolled-back change into the work tree as a local change
2867 to be amended and perhaps committed again:
2869 .Dl $ got backout unified-buffer-cache
2870 .Dl $ got commit -m 'roll back previous'
2871 .Dl $ # now back out the previous backout :-)
2872 .Dl $ got backout unified-buffer-cache
2874 Fetch new changes on the remote repository's
2876 branch, making them visible on the local repository's
2883 In a repository created with a HTTP URL and
2884 .Cm git clone --bare
2887 command must be used instead:
2889 .Dl $ cd /var/git/src.git
2890 .Dl $ git fetch origin master:refs/remotes/origin/master
2894 branch to merge the new changes that are now visible on the
2899 .Dl $ got update -b origin/master
2900 .Dl $ got rebase master
2903 .Dq unified-buffer-cache
2904 branch on top of the new head commit of the
2908 .Dl $ got update -b master
2909 .Dl $ got rebase unified-buffer-cache
2911 Create a patch from all changes on the unified-buffer-cache branch.
2912 The patch can be mailed out for review and applied to
2916 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2918 Edit the entire commit history of the
2919 .Dq unified-buffer-cache
2922 .Dl $ got update -b unified-buffer-cache
2923 .Dl $ got update -c master
2926 Before working against existing branches in a repository cloned with
2927 .Cm git clone --bare
2932 must be configured to map all references in the remote repository
2935 namespace of the local repository.
2936 This can be achieved by setting Git's
2937 .Pa remote.origin.fetch
2938 configuration variable to the value
2939 .Dq +refs/heads/*:refs/remotes/origin/*
2944 .Dl $ cd /var/git/repo
2945 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2949 option must be disabled:
2951 .Dl $ cd /var/git/repo
2952 .Dl $ git config remote.origin.mirror false
2954 Alternatively, the following
2956 configuration item can be added manually to the Git repository's
2960 .Dl [remote \&"origin\&"]
2962 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2965 This configuration leaves the local repository's
2967 namespace free for use by local branches checked out with
2969 and, if needed, created with
2972 .Dq refs/remotes/origin
2973 namespace can now be updated with incoming changes from the remote
2978 without extra command line arguments.
2979 Newly fetched changes can be examined with
2982 Display changes on the remote repository's version of the
2984 branch, as of the last time
2988 .Dl $ got log -c origin/master | less
2990 As shown here, most commands accept abbreviated reference names such as
2993 .Dq refs/remotes/origin/master .
2994 The latter is only needed in case of ambiguity.
2997 must be used to merge changes which are visible on the
3002 This will also merge local changes, if any, with the incoming changes:
3004 .Dl $ got update -b origin/master
3005 .Dl $ got rebase master
3007 In order to make changes committed to the
3008 .Dq unified-buffer-cache
3012 .Dq unified-buffer-cache
3013 branch must first be rebased onto the
3017 .Dl $ got update -b master
3018 .Dl $ got rebase unified-buffer-cache
3021 .Dq unified-buffer-cache
3022 branch can now be made visible on the
3026 Because the rebase operation switched the work tree to the
3027 .Dq unified-buffer-cache
3028 branch, the work tree must be switched back to the
3032 .Dl $ got update -b master
3033 .Dl $ got integrate unified-buffer-cache
3037 branch, log messages for local changes can now be amended with
3039 by other developers and any other important new information:
3041 .Dl $ got update -c origin/master
3042 .Dl $ got histedit -m
3044 If the remote repository offers write access, local changes on the
3046 branch can be sent to the remote repository with
3050 can be run without further arguments.
3051 The arguments shown here match defaults, provided the work tree's
3052 current branch is the
3056 .Dl $ got send -b master origin
3058 If the remote repository requires the HTTPS protocol, the
3060 command must be used instead:
3062 .Dl $ cd /var/git/src.git
3063 .Dl $ git push origin master
3067 .Xr git-repository 5 ,
3068 .Xr got-worktree 5 ,
3071 .An Stefan Sperling Aq Mt stsp@openbsd.org
3072 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3073 .An Joshua Stein Aq Mt jcs@openbsd.org
3074 .An Ori Bernstein Aq Mt ori@openbsd.org
3077 is a work-in-progress and some features remain to be implemented.
3079 At present, the user has to fall back on
3081 to perform some tasks.
3085 Reading from remote repositories over HTTP or HTTPS protocols requires
3090 Writing to remote repositories over HTTP or HTTPS protocols requires
3093 The creation of merge commits with more than two parent commits requires
3096 In situations where files or directories were moved around
3098 will not automatically merge changes to new locations and
3100 will usually produce better results.
