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
66 .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
68 Create an initial commit in a repository from the file hierarchy
71 The created commit will not have any parent commits, i.e. it will be a
73 Also create a new reference which provides a branch name for the newly
75 Show the path of each imported file to indicate progress.
81 environment variable to be set,
82 unless an author has been configured in
88 configuration settings can be obtained from the repository's
90 file or from Git's global
101 instead of creating the default branch
103 Use of this option is required if the
105 branch already exists.
107 Use the specified log message when creating the new commit.
112 opens a temporary file in an editor where a log message can be written.
113 .It Fl r Ar repository-path
114 Use the repository at the specified path.
115 If not specified, assume the repository is located at or above the current
118 Ignore files or directories with a name which matches the specified
120 This option may be specified multiple times to build a list of ignore patterns.
123 follows the globbing rules documented in
127 .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
129 Clone a Git repository at the specified
135 is specified, the directory name will be derived from the name of the
138 will refuse to run if the
144 specifies a protocol scheme, a server hostname, an optional port number
145 separated from the hostname by a colon, and a path to the repository on
147 .Lk scheme://hostname:port/path/to/repository
149 The following protocol schemes are supported:
150 .Bl -tag -width git+ssh
152 The Git protocol as implemented by the
155 Use of this protocol is discouraged since it supports neither authentication
158 The Git protocol wrapped in an authenticated and encrypted
161 With this protocol the hostname may contain an embedded username for
166 Short alias for git+ssh.
169 Objects in the cloned repository are stored in a pack file which is downloaded
171 This pack file will then be indexed to facilitate access to the objects stored
173 If any objects in the pack file are stored in deltified form, all deltas will
174 be fully resolved in order to compute the ID of such objects.
175 This can take some time.
176 More details about the pack file format are documented in
177 .Xr git-repository 5 .
180 creates a remote repository entry in the
184 files of the cloned repository to store the
190 arguments for future use by
200 Fetch all branches from the remote repository's
202 reference namespace and set
203 .Cm fetch_all_branches
204 in the cloned repository's
206 file for future use by
208 If this option is not specified, a branch resolved via the remote
209 repository's HEAD reference will be fetched.
210 Cannot be used together with the
216 from the remote repository's
219 This option may be specified multiple times to build a list of branches
221 If the branch corresponding to the remote repository's HEAD reference is not
222 in this list, the cloned repository's HEAD reference will be set to the first
223 branch which was fetched.
224 If this option is not specified, a branch resolved via the remote
225 repository's HEAD reference will be fetched.
226 Cannot be used together with the
230 List branches and tags available for fetching from the remote repository
231 and exit immediately.
232 Cannot be used together with any of the other options except
237 Create the cloned repository as a mirror of the original repository.
238 This is useful if the cloned repository will not be used to store
239 locally created commits.
245 files will be set up with the
247 option enabled, such that
251 will write incoming changes directly to branches in the
253 reference namespace, rather than to branches in the
256 This avoids the usual requirement of having to run
260 in order to make incoming changes appear on branches in the
263 But maintaining custom changes in the cloned repository becomes difficult
264 since such changes will be at risk of being discarded whenever incoming
267 Suppress progress reporting output.
268 The same option will be passed to
275 to print debugging messages to standard error output.
276 This option will be passed to
279 Multiple -v options increase the verbosity.
281 .It Fl R Ar reference
282 In addition to the branches and tags that will be fetched, fetch an arbitrary
284 from the remote repository's
287 This option may be specified multiple times to build a list of additional
291 may either be a path to a specific reference, or a reference namespace
292 which will cause all references in this namespace to be fetched.
294 Each reference will be mapped into the cloned repository's
296 namespace, unless the
298 option is used to mirror references directly into the cloned repository's
303 will refuse to fetch references from the remote repository's
310 .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
312 Fetch new changes from a remote repository.
314 .Ar remote-repository
318 The remote repository's URL is obtained from the corresponding entry in
322 file of the local repository, as created by
325 New changes will be stored in a separate pack file downloaded from the server.
326 Optionally, separate pack files stored in the repository can be combined with
329 By default, branch references in the
331 reference namespace will be updated to point at the newly fetched commits.
334 command can then be used to make new changes visible on branches in the
336 namespace, merging incoming changes with the changes on those branches
339 If the repository was created as a mirror with
341 then all branches in the
343 namespace will be updated directly to match the corresponding branches in
344 the remote repository.
345 If those branches contained local commits, these commits will no longer be
346 reachable via a reference and will therefore be at risk of being discarded
347 by Git's garbage collector or
348 .Cm gotadmin cleanup .
349 Maintaining custom changes in a mirror repository is therefore discouraged.
351 In any case, references in the
353 namespace will always be fetched and mapped directly to local references
354 in the same namespace.
361 Fetch all branches from the remote repository's
364 This option can be enabled by default for specific repositories in
366 If this option is not specified, a branch resolved via the remote
367 repository's HEAD reference will be fetched.
368 Cannot be used together with the
374 from the remote repository's
377 This option may be specified multiple times to build a list of branches
379 If this option is not specified, a branch resolved via the remote
380 repository's HEAD reference will be fetched.
381 Cannot be used together with the
385 Delete branches and tags from the local repository which are no longer
386 present in the remote repository.
387 Only references are deleted.
388 Any commit, tree, tag, and blob objects belonging to deleted branches or
389 tags remain in the repository and may be removed separately with
390 Git's garbage collector or
391 .Cm gotadmin cleanup .
393 List branches and tags available for fetching from the remote repository
394 and exit immediately.
395 Cannot be used together with any of the other options except
401 Allow existing references in the
403 namespace to be updated if they have changed on the server.
404 If not specified, only new tag references will be created.
405 .It Fl r Ar repository-path
406 Use the repository at the specified path.
407 If not specified, assume the repository is located at or above the current
409 If this directory is a
411 work tree, use the repository path associated with this work tree.
413 Suppress progress reporting output.
414 The same option will be passed to
421 to print debugging messages to standard error output.
422 The same option will be passed to
425 Multiple -v options increase the verbosity.
427 .It Fl R Ar reference
428 In addition to the branches and tags that will be fetched, fetch an arbitrary
430 from the remote repository's
433 This option may be specified multiple times to build a list of additional
437 may either be a path to a specific reference, or a reference namespace
438 which will cause all references in this namespace to be fetched.
440 Each reference will be mapped into the local repository's
442 namespace, unless the local repository was created as a mirror with
444 in which case references will be mapped directly into the local repository's
448 Once a reference has been fetched, a branch based on it can be created with
453 will refuse to fetch references from the remote repository's
459 Delete all references which correspond to a particular
460 .Ar remote-repository
461 instead of fetching new changes.
462 This can be useful when a remote repository is being removed from
468 .Ar remote-repository
469 argument is mandatory and no other options except
476 Only references are deleted.
477 Any commit, tree, tag, and blob objects fetched from a remote repository
478 will generally be stored in pack files and may be removed separately with
480 and Git's garbage collector.
483 .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
485 Copy files from a repository into a new work tree.
486 Show the status of each affected file, using the following status codes:
487 .Bl -column YXZ description
488 .It A Ta new file was added
489 .It E Ta file already exists in work tree's meta-data
494 is not specified, either use the last component of
495 .Ar repository path ,
498 was specified use the last component of
506 Proceed with the checkout operation even if the directory at
509 Existing files will be left intact.
511 Check out files from a commit on the specified
513 If this option is not specified, a branch resolved via the repository's HEAD
514 reference will be used.
516 Check out files from the specified
518 on the selected branch.
519 The expected argument is a commit ID SHA1 hash or an existing reference
520 or tag name which will be resolved to a commit ID.
521 An abbreviated hash argument will be expanded to a full SHA1 hash
522 automatically, provided the abbreviation is unique.
523 If this option is not specified, the most recent commit on the selected
528 is not contained in the selected branch, a different branch which contains
529 this commit must be specified with the
532 If no such branch is known, a new branch must be created for this
538 Checking out work trees with an unknown branch is intentionally not supported.
539 .It Fl p Ar path-prefix
540 Restrict the work tree to a subset of the repository's tree hierarchy.
541 Only files beneath the specified
545 Silence progress output.
548 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl q Oc Op Ar path ...
550 Update an existing work tree to a different
552 Change existing files in the work tree as necessary to match file contents
554 Preserve any local changes in the work tree and merge them with the
557 Files which already contain merge conflicts will not be updated to avoid
558 further complications.
559 Such files will be updated when
561 is run again after merge conflicts have been resolved.
562 If the conflicting changes are no longer needed, affected files can be
569 Show the status of each affected file, using the following status codes:
570 .Bl -column YXZ description
571 .It U Ta file was updated and contained no local changes
572 .It G Ta file was updated and local changes were merged cleanly
573 .It C Ta file was updated and conflicts occurred during merge
574 .It D Ta file was deleted
575 .It A Ta new file was added
576 .It \(a~ Ta versioned file is obstructed by a non-regular file
577 .It ! Ta a missing versioned file was restored
578 .It # Ta file was not updated because it contains merge conflicts
579 .It ? Ta changes destined for an unversioned file were not merged
584 is specified, update the entire work tree.
585 Otherwise, restrict the update operation to files at or within the
587 Each path is required to exist in the update operation's target commit.
588 Files in the work tree outside specified paths will remain unchanged and
589 will retain their previously recorded base commit.
592 commands may refuse to run while the work tree contains files from
593 multiple base commits.
594 The base commit of such a work tree can be made consistent by running
596 across the entire work tree.
599 is incompatible with the
604 cannot update paths with staged changes.
605 If changes have been staged with
607 these changes must first be committed with
617 Switch the work tree's branch reference to the specified
619 before updating the work tree.
620 This option requires that all paths in the work tree are updated.
622 As usual, any local changes in the work tree will be preserved.
623 This can be useful when switching to a newly created branch in order
624 to commit existing local changes to this branch.
626 Any local changes must be dealt with separately in order to obtain a
627 work tree with pristine file contents corresponding exactly to the specified
629 Such changes could first be committed to a different branch with
631 or could be discarded with
634 Update the work tree to the specified
636 The expected argument is a commit ID SHA1 hash or an existing reference
637 or tag name which will be resolved to a commit ID.
638 An abbreviated hash argument will be expanded to a full SHA1 hash
639 automatically, provided the abbreviation is unique.
640 If this option is not specified, the most recent commit on the work tree's
643 Silence progress output.
646 .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Oo Fl S Ar status-codes Oc Op Ar path ...
648 Show the current modification status of files in a work tree,
649 using the following status codes:
650 .Bl -column YXZ description
651 .It M Ta modified file
652 .It A Ta file scheduled for addition in next commit
653 .It D Ta file scheduled for deletion in next commit
654 .It C Ta modified or added file which contains merge conflicts
655 .It ! Ta versioned file was expected on disk but is missing
656 .It \(a~ Ta versioned file is obstructed by a non-regular file
657 .It ? Ta unversioned item not tracked by
659 .It m Ta modified file modes (executable bit only)
660 .It N Ta non-existent
662 specified on the command line
667 is specified, show modifications in the entire work tree.
668 Otherwise, show modifications at or within the specified paths.
670 If changes have been staged with
672 staged changes are shown in the second output column, using the following
674 .Bl -column YXZ description
675 .It M Ta file modification is staged
676 .It A Ta file addition is staged
677 .It D Ta file deletion is staged
680 Changes created on top of staged changes are indicated in the first column:
681 .Bl -column YXZ description
682 .It MM Ta file was modified after earlier changes have been staged
683 .It MA Ta file was modified after having been staged for addition
691 Show unversioned files even if they match an ignore pattern.
692 .It Fl s Ar status-codes
693 Only show files with a modification status matching any of the
694 single-character status codes contained in the
697 Any combination of codes from the above list of possible status codes
699 For staged files, status codes displayed in either column will be matched.
700 Cannot be used together with the
703 .It Fl S Ar status-codes
704 Suppress the output of 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
716 For compatibility with
727 files in each traversed directory and will not display unversioned files
728 which match these patterns.
733 supports consecutive asterisks,
735 which will match an arbitrary amount of directories.
739 only supports a single ignore pattern per line.
743 does not support negated ignore patterns prefixed with
745 and gives no special significance to the location of path component separators,
748 .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
749 Display history of a repository.
752 is specified, show only commits which modified this path.
753 If invoked in a work tree, the
755 is interpreted relative to the current working directory,
756 and the work tree's path prefix is implicitly prepended.
757 Otherwise, the path is interpreted relative to the repository root.
764 Display individual commits which were merged into the current branch
768 shows the linear history of the current branch only.
770 Start traversing history at the specified
772 The expected argument is a commit ID SHA1 hash or an existing reference
773 or tag name which will be resolved to a commit ID.
774 An abbreviated hash argument will be expanded to a full SHA1 hash
775 automatically, provided the abbreviation is unique.
776 If this option is not specified, default to the work tree's current branch
777 if invoked in a work tree, or to the repository's HEAD reference.
779 Set the number of context lines shown in diffs with
781 By default, 3 lines of context are shown.
783 Limit history traversal to a given number of commits.
784 If this option is not specified, a default limit value of zero is used,
785 which is treated as an unbounded limit.
787 .Ev GOT_LOG_DEFAULT_LIMIT
788 environment variable may be set to change this default value.
790 Display the patch of modifications made in each commit.
793 is specified, only show the patch of modifications at or within this path.
794 Cannot be used with the
798 Display the list of file paths changed in each commit, using the following
800 .Bl -column YXZ description
801 .It M Ta modified file
802 .It D Ta file was deleted
803 .It A Ta new file was added
804 .It m Ta modified file modes (executable bit only)
807 Cannot be used with the
811 Display a short one-line summary of each commit, instead of the default
813 Cannot be used together with the
818 .It Fl S Ar search-pattern
819 If specified, show only commits with a log message, author name,
820 committer name, or ID SHA1 hash matched by the extended regular
823 Lines in committed patches will be matched if
826 File paths changed by a commit will be matched if
829 Regular expression syntax is documented in
831 .It Fl r Ar repository-path
832 Use the repository at the specified path.
833 If not specified, assume the repository is located at or above the current
835 If this directory is a
837 work tree, use the repository path associated with this work tree.
839 Determine a set of commits to display as usual, but display these commits
842 Stop traversing commit history immediately after the specified
845 This option has no effect if the specified
850 .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 ...
852 When invoked within a work tree without any arguments, display all
853 local changes in the work tree.
856 arguments are specified, only show changes within the specified paths.
858 If two arguments are provided, treat each argument as a reference, a tag
859 name, or an object ID SHA1 hash, and display differences between the
860 corresponding objects.
861 Both objects must be of the same type (blobs, trees, or commits).
862 An abbreviated hash argument will be expanded to a full SHA1 hash
863 automatically, provided the abbreviation is unique.
864 If none of these interpretations produce a valid result or if the
869 is running in a work tree, attempt to interpret the two arguments as paths.
876 Treat file contents as ASCII text even if binary data is detected.
878 Show differences between commits in the repository.
879 This options may be used up to two times.
880 When used only once, show differences between the specified
882 and its first parent commit.
883 When used twice, show differences between the two specified commits.
885 The expected argument is a commit ID SHA1 hash or an existing reference
886 or tag name which will be resolved to a commit ID.
887 An abbreviated hash argument will be expanded to a full SHA1 hash
888 automatically, provided the abbreviation is unique.
892 option is used, all non-option arguments will be interpreted as paths.
895 arguments are provided, only show differences for the specified paths.
897 Cannot be used together with the
901 Set the number of context lines shown in the diff.
902 By default, 3 lines of context are shown.
903 .It Fl r Ar repository-path
904 Use the repository at the specified path.
905 If not specified, assume the repository is located at or above the current
907 If this directory is a
909 work tree, use the repository path associated with this work tree.
911 Show changes staged with
913 instead of showing local changes in the work tree.
914 This option is only valid when
916 is invoked in a work tree.
918 Interpret all arguments as paths only.
919 This option can be used to resolve ambiguity in cases where paths
920 look like tag names, reference names, or object IDs.
921 This option is only valid when
923 is invoked in a work tree.
925 Ignore whitespace-only changes.
928 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
930 Display line-by-line history of a file at the specified path.
937 Start traversing history at the specified
939 The expected argument is a commit ID SHA1 hash or an existing reference
940 or tag name which will be resolved to a commit ID.
941 An abbreviated hash argument will be expanded to a full SHA1 hash
942 automatically, provided the abbreviation is unique.
943 .It Fl r Ar repository-path
944 Use the repository at the specified path.
945 If not specified, assume the repository is located at or above the current
947 If this directory is a
949 work tree, use the repository path associated with this work tree.
952 .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
954 Display a listing of files and directories at the specified
955 directory path in the repository.
956 Entries shown in this listing may carry one of the following trailing
958 .Bl -column YXZ description
959 .It @ Ta entry is a symbolic link
960 .It / Ta entry is a directory
961 .It * Ta entry is an executable file
962 .It $ Ta entry is a Git submodule
965 Symbolic link entries are also annotated with the target path of the link.
969 is specified, list the repository path corresponding to the current
970 directory of the work tree, or the root directory of the repository
971 if there is no work tree.
978 List files and directories as they appear in the specified
980 The expected argument is a commit ID SHA1 hash or an existing reference
981 or tag name which will be resolved to a commit ID.
982 An abbreviated hash argument will be expanded to a full SHA1 hash
983 automatically, provided the abbreviation is unique.
984 .It Fl r Ar repository-path
985 Use the repository at the specified path.
986 If not specified, assume the repository is located at or above the current
988 If this directory is a
990 work tree, use the repository path associated with this work tree.
992 Show object IDs of files (blob objects) and directories (tree objects).
994 Recurse into sub-directories in the repository.
996 .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
997 Manage references in a repository.
999 References may be listed, created, deleted, and changed.
1000 When creating, deleting, or changing a reference the specified
1002 must be an absolute reference name, i.e. it must begin with
1009 .It Fl r Ar repository-path
1010 Use the repository at the specified path.
1011 If not specified, assume the repository is located at or above the current
1013 If this directory is a
1015 work tree, use the repository path associated with this work tree.
1017 List references in the repository.
1020 is specified, list all existing references in the repository.
1023 is a reference namespace, list all references in this namespace.
1024 Otherwise, show only the reference with the given
1026 Cannot be used together with any other options except
1031 Sort listed references by modification time (most recently modified first)
1032 instead of sorting by lexicographical order.
1033 Use of this option requires the
1035 option to be used as well.
1037 Create a reference or change an existing reference.
1038 The reference with the specified
1040 will point at the specified
1044 argument is a ID SHA1 hash or an existing reference or tag name which will
1045 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1046 Cannot be used together with any other options except
1048 .It Fl s Ar reference
1049 Create a symbolic reference, or change an existing symbolic reference.
1050 The symbolic reference with the specified
1052 will point at the specified
1054 which must already exist in the repository.
1055 Care should be taken not to create loops between references when
1056 this option is used.
1057 Cannot be used together with any other options except
1060 Delete the reference with the specified
1062 from the repository.
1063 Any commit, tree, tag, and blob objects belonging to deleted references
1064 remain in the repository and may be removed separately with
1065 Git's garbage collector or
1066 .Cm gotadmin cleanup .
1067 Cannot be used together with any other options except
1071 .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
1073 Create, list, or delete branches.
1075 Local branches are managed via references which live in the
1077 reference namespace.
1080 command creates references in this namespace only.
1082 When deleting branches, the specified
1086 reference namespace first.
1087 If no corresponding branch is found, the
1089 namespace will be searched next.
1091 If invoked in a work tree without any arguments, print the name of the
1092 work tree's current branch.
1096 argument is passed, attempt to create a branch reference with the given name.
1097 By default the new branch reference will point at the latest commit on the
1098 work tree's current branch if invoked in a work tree, and otherwise to a commit
1099 resolved via the repository's HEAD reference.
1101 If invoked in a work tree, once the branch was created successfully
1102 switch the work tree's head reference to the newly created branch and
1103 update files across the entire work tree, just like
1104 .Cm got update -b Ar name
1106 Show the status of each affected file, using the following status codes:
1107 .Bl -column YXZ description
1108 .It U Ta file was updated and contained no local changes
1109 .It G Ta file was updated and local changes were merged cleanly
1110 .It C Ta file was updated and conflicts occurred during merge
1111 .It D Ta file was deleted
1112 .It A Ta new file was added
1113 .It \(a~ Ta versioned file is obstructed by a non-regular file
1114 .It ! Ta a missing versioned file was restored
1122 Make a newly created branch reference point at the specified
1126 argument is a commit ID SHA1 hash or an existing reference
1127 or tag name which will be resolved to a commit ID.
1128 .It Fl r Ar repository-path
1129 Use the repository at the specified path.
1130 If not specified, assume the repository is located at or above the current
1132 If this directory is a
1134 work tree, use the repository path associated with this work tree.
1136 List all existing branches in the repository, including copies of remote
1137 repositories' branches in the
1139 reference namespace.
1141 If invoked in a work tree, the work tree's current branch is shown
1142 with one the following annotations:
1143 .Bl -column YXZ description
1144 .It * Ta work tree's base commit matches the branch tip
1145 .It \(a~ Ta work tree's base commit is out-of-date
1148 Sort listed branches by modification time (most recently modified first)
1149 instead of sorting by lexicographical order.
1152 reference namespace are listed before branches in
1155 Use of this option requires the
1157 option to be used as well.
1159 Delete the branch with the specified
1165 reference namespace.
1167 Only the branch reference is deleted.
1168 Any commit, tree, and blob objects belonging to the branch
1169 remain in the repository and may be removed separately with
1170 Git's garbage collector or
1171 .Cm gotadmin cleanup .
1173 Do not switch and update the work tree after creating a new branch.
1175 .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 Oo Fl s Ar signer-id Oc Oo Fl v Oc Oo Fl V Oc Ar name
1176 Manage tags in a repository.
1178 Tags are managed via references which live in the
1180 reference namespace.
1183 command operates on references in this namespace only.
1184 References in this namespace point at tag objects which contain a pointer
1185 to another object, a tag message, as well as author and timestamp information.
1187 Attempt to create a tag with the given
1189 and make this tag point at the given
1191 If no commit is specified, default to the latest commit on the work tree's
1192 current branch if invoked in a work tree, and to a commit resolved via
1193 the repository's HEAD reference otherwise.
1200 Make the newly created tag reference point at the specified
1204 argument is a commit ID SHA1 hash or an existing reference or tag name which
1205 will be resolved to a commit ID.
1206 An abbreviated hash argument will be expanded to a full SHA1 hash
1207 automatically, provided the abbreviation is unique.
1209 Use the specified tag message when creating the new tag.
1214 opens a temporary file in an editor where a tag message can be written.
1215 .It Fl r Ar repository-path
1216 Use the repository at the specified path.
1217 If not specified, assume the repository is located at or above the current
1219 If this directory is a
1221 work tree, use the repository path associated with this work tree.
1223 List all existing tags in the repository instead of creating a new tag.
1226 argument is passed, show only the tag with the given
1228 .It Fl s Ar signer-id
1229 While creating a new tag, sign this tag with the identity given in
1232 For SSH-based signatures,
1234 is the path to a file which may refer to either a private SSH key,
1235 or a public SSH key with the private half available via
1238 will sign the tag object by invoking
1242 command, using the signature namespace
1244 for compatibility with
1248 During SSH signature creation and verification this option will be passed to
1250 Multiple -v options increase the verbosity.
1253 Verify tag object signatures.
1256 is specified, show and verify the tag object with the provided name.
1257 Otherwise, list all tag objects and verify signatures where present.
1260 verifies SSH-based signatures by invoking
1263 .Fl Y Ar verify Fl f Ar allowed_signers .
1268 otherwise verification is impossible.
1273 command will not delete tags or change existing tags.
1274 If a tag must be deleted, the
1276 command may be used to delete a tag's reference.
1277 This should only be done if the tag has not already been copied to
1279 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1280 Schedule unversioned files in a work tree for addition to the
1281 repository in the next commit.
1282 By default, files which match a
1284 ignore pattern will not be added.
1291 Permit recursion into directories.
1292 If this option is not specified,
1294 will refuse to run if a specified
1298 Add files even if they match a
1303 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1305 Remove versioned files from a work tree and schedule them for deletion
1306 from the repository in the next commit.
1313 Perform the operation even if a file contains local modifications,
1314 and do not raise an error if a specified
1316 does not exist on disk.
1318 Keep affected files on disk.
1320 Permit recursion into directories.
1321 If this option is not specified,
1323 will refuse to run if a specified
1326 .It Fl s Ar status-codes
1327 Only delete files with a modification status matching one of the
1328 single-character status codes contained in the
1331 The following status codes may be specified:
1332 .Bl -column YXZ description
1333 .It M Ta modified file (this implies the
1336 .It ! Ta versioned file expected on disk but missing
1340 .It Cm patch Oo Fl n Oc Oo Fl p Ar strip-count Oc Oo Fl R Oc Op Ar patchfile
1344 to files in a work tree.
1345 Files added or removed by a patch will be scheduled for addition or removal in
1348 The patch must be in the unified diff format as produced by
1355 diff when invoked with their
1360 argument is provided, read unified diff data from standard input instead.
1364 contains multiple patches, then attempt to apply each of them in sequence.
1366 Show the status of each affected file, using the following status codes:
1367 .Bl -column XYZ description
1368 .It M Ta file was modified
1369 .It G Ta file was merged using a merge-base found in the repository
1370 .It C Ta file was merged and conflicts occurred during merge
1371 .It D Ta file was deleted
1372 .It A Ta file was added
1373 .It # Ta failed to patch the file
1376 If a change does not match at its exact line number, attempt to
1377 apply it somewhere else in the file if a good spot can be found.
1378 Otherwise, the patch will fail to apply.
1382 will refuse to apply a patch if certain preconditions are not met.
1383 Files to be deleted must already be under version control, and must
1384 not have been scheduled for deletion already.
1385 Files to be added must not yet be under version control and must not
1386 already be present on disk.
1387 Files to be modified must already be under version control and may not
1388 contain conflict markers.
1390 If an error occurs, the
1392 operation will be aborted.
1393 Any changes made to the work tree up to this point will be left behind.
1394 Such changes can be viewed with
1396 and can be reverted with
1405 Do not make any modifications to the work tree.
1406 This can be used to check whether a patch would apply without issues.
1409 contains diffs that affect the same file multiple times, the results
1410 displayed may be incorrect.
1411 .It Fl p Ar strip-count
1412 Specify the number of leading path components to strip from paths
1421 path prefixes generated by
1423 will be recognized and stripped automatically.
1425 Reverse the patch before applying it.
1428 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1430 Revert any local changes in files at the specified paths in a work tree.
1431 File contents will be overwritten with those contained in the
1432 work tree's base commit.
1433 There is no way to bring discarded changes back after
1436 If a file was added with
1438 it will become an unversioned file again.
1439 If a file was deleted with
1441 it will be restored.
1448 Instead of reverting all changes in files, interactively select or reject
1449 changes to revert based on
1455 (quit reverting this file) responses.
1456 If a file is in modified status, individual patches derived from the
1457 modified file content can be reverted.
1458 Files in added or deleted status may only be reverted in their entirety.
1459 .It Fl F Ar response-script
1467 responses line-by-line from the specified
1469 file instead of prompting interactively.
1471 Permit recursion into directories.
1472 If this option is not specified,
1474 will refuse to run if a specified
1479 .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 ...
1481 Create a new commit in the repository from changes in a work tree
1482 and use this commit as the new base commit for the work tree.
1485 is specified, commit all changes in the work tree.
1486 Otherwise, commit changes at or within the specified paths.
1488 If changes have been explicitly staged for commit with
1490 only commit staged changes and reject any specified paths which
1491 have not been staged.
1494 opens a temporary file in an editor where a log message can be written
1502 options are used together.
1504 Show the status of each affected file, using the following status codes:
1505 .Bl -column YXZ description
1506 .It M Ta modified file
1507 .It D Ta file was deleted
1508 .It A Ta new file was added
1509 .It m Ta modified file modes (executable bit only)
1512 Files which are not part of the new commit will retain their previously
1513 recorded base commit.
1516 commands may refuse to run while the work tree contains files from
1517 multiple base commits.
1518 The base commit of such a work tree can be made consistent by running
1520 across the entire work tree.
1524 command requires the
1526 environment variable to be set,
1527 unless an author has been configured in
1533 configuration settings can be
1534 obtained from the repository's
1536 file or from Git's global
1545 Use the prepared log message stored in the file found at
1547 when creating the new commit.
1549 opens a temporary file in an editor where the prepared log message can be
1550 reviewed and edited further if needed.
1551 Cannot be used together with the
1555 Use the specified log message when creating the new commit.
1556 Cannot be used together with the
1560 This option prevents
1562 from opening the commit message in an editor.
1563 It has no effect unless it is used together with the
1565 option and is intended for non-interactive use such as scripting.
1567 Allow the addition of symbolic links which point outside of the path space
1568 that is under version control.
1571 will reject such symbolic links due to safety concerns.
1574 may decide to represent such a symbolic link as a regular file which contains
1575 the link's target path, rather than creating an actual symbolic link which
1576 points outside of the work tree.
1577 Use of this option is discouraged because external mechanisms such as
1579 are better suited for managing symbolic links to paths not under
1584 will refuse to run if certain preconditions are not met.
1585 If the work tree's current branch is not in the
1587 reference namespace, new commits may not be created on this branch.
1588 Local changes may only be committed if they are based on file content
1589 found in the most recent commit on the work tree's branch.
1590 If a path is found to be out of date,
1592 must be used first in order to merge local changes with changes made
1595 .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
1597 Send new changes to a remote repository.
1599 .Ar remote-repository
1603 The remote repository's URL is obtained from the corresponding entry in
1607 file of the local repository, as created by
1610 All objects corresponding to new changes will be written to a temporary
1611 pack file which is then uploaded to the server.
1612 Upon success, references in the
1614 reference namespace of the local repository will be updated to point at
1615 the commits which have been sent.
1617 By default, changes will only be sent if they are based on up-to-date
1618 copies of relevant branches in the remote repository.
1619 If any changes to be sent are based on out-of-date copies or would
1620 otherwise break linear history of existing branches, new changes must
1621 be fetched from the server with
1623 and local branches must be rebased with
1630 option can be used to make exceptions to these requirements.
1637 Send all branches from the local repository's
1639 reference namespace.
1642 option is equivalent to listing all branches with multiple
1645 Cannot be used together with the
1651 from the local repository's
1653 reference namespace.
1654 This option may be specified multiple times to build a list of branches
1656 If this option is not specified, default to the work tree's current branch
1657 if invoked in a work tree, or to the repository's HEAD reference.
1658 Cannot be used together with the
1662 Delete the specified
1664 from the remote repository's
1666 reference namespace.
1667 This option may be specified multiple times to build a list of branches
1670 Only references are deleted.
1671 Any commit, tree, tag, and blob objects belonging to deleted branches
1672 may become subject to deletion by Git's garbage collector running on
1675 Requesting deletion of branches results in an error if the server
1676 does not support this feature or disallows the deletion of branches
1677 based on its configuration.
1679 Attempt to force the server to overwrite existing branches or tags
1680 in the remote repository, even when
1684 would usually be required before changes can be sent.
1685 The server may reject forced requests regardless, depending on its
1688 Any commit, tree, tag, and blob objects belonging to overwritten branches
1689 or tags may become subject to deletion by Git's garbage collector running
1694 reference namespace is globally shared between all repositories.
1697 option to overwrite tags is discouraged because it can lead to
1698 inconsistencies between the tags present in different repositories.
1699 In general, creating a new tag with a different name is recommended
1700 instead of overwriting an existing tag.
1704 option is particularly discouraged if changes being sent are based
1705 on an out-of-date copy of a branch in the remote repository.
1706 Instead of using the
1708 option, new changes should
1711 and local branches should be rebased with
1713 followed by another attempt to send the changes.
1717 option should only be needed in situations where the remote repository's
1718 copy of a branch or tag is known to be out-of-date and is considered
1720 The risks of creating inconsistencies between different repositories
1721 should also be taken into account.
1722 .It Fl r Ar repository-path
1723 Use the repository at the specified path.
1724 If not specified, assume the repository is located at or above the current
1726 If this directory is a
1728 work tree, use the repository path associated with this work tree.
1732 from the local repository's
1734 reference namespace, in addition to any branches that are being sent.
1737 option may be specified multiple times to build a list of tags to send.
1738 No tags will be sent if the
1742 Raise an error if the specified
1744 already exists in the remote repository, unless the
1746 option is used to overwrite the server's copy of the tag.
1747 In general, creating a new tag with a different name is recommended
1748 instead of overwriting an existing tag.
1750 Cannot be used together with the
1754 Attempt to send all tags from the local repository's
1756 reference namespace.
1759 option is equivalent to listing all tags with multiple
1762 Cannot be used together with the
1766 Suppress progress reporting output.
1767 The same option will be passed to
1774 to print debugging messages to standard error output.
1775 The same option will be passed to
1778 Multiple -v options increase the verbosity.
1782 .It Cm cherrypick Ar commit
1784 Merge changes from a single
1789 should be on a different branch than the work tree's base commit.
1790 The expected argument is a reference or a commit ID SHA1 hash.
1791 An abbreviated hash argument will be expanded to a full SHA1 hash
1792 automatically, provided the abbreviation is unique.
1794 Show the status of each affected file, using the following status codes:
1795 .Bl -column YXZ description
1796 .It G Ta file was merged
1797 .It C Ta file was merged and conflicts occurred during merge
1798 .It ! Ta changes destined for a missing file were not merged
1799 .It D Ta file was deleted
1800 .It d Ta file's deletion was prevented by local modifications
1801 .It A Ta new file was added
1802 .It \(a~ Ta changes destined for a non-regular file were not merged
1803 .It ? Ta changes destined for an unversioned file were not merged
1806 The merged changes will appear as local changes in the work tree, which
1809 amended manually or with further
1814 or discarded again with
1818 will refuse to run if certain preconditions are not met.
1819 If the work tree contains multiple base commits, it must first be updated
1820 to a single base commit with
1822 If any relevant files already contain merge conflicts, these
1823 conflicts must be resolved first.
1825 .It Cm backout Ar commit
1827 Reverse-merge changes from a single
1832 should be on the same branch as the work tree's base commit.
1833 The expected argument is a reference or a commit ID SHA1 hash.
1834 An abbreviated hash argument will be expanded to a full SHA1 hash
1835 automatically, provided the abbreviation is unique.
1837 Show the status of each affected file, using the following status codes:
1838 .Bl -column YXZ description
1839 .It G Ta file was merged
1840 .It C Ta file was merged and conflicts occurred during merge
1841 .It ! Ta changes destined for a missing file were not merged
1842 .It D Ta file was deleted
1843 .It d Ta file's deletion was prevented by local modifications
1844 .It A Ta new file was added
1845 .It \(a~ Ta changes destined for a non-regular file were not merged
1846 .It ? Ta changes destined for an unversioned file were not merged
1849 The reverse-merged changes will appear as local changes in the work tree,
1850 which may be viewed with
1852 amended manually or with further
1857 or discarded again with
1861 will refuse to run if certain preconditions are not met.
1862 If the work tree contains multiple base commits, it must first be updated
1863 to a single base commit with
1865 If any relevant files already contain merge conflicts, these
1866 conflicts must be resolved first.
1868 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1870 Rebase commits on the specified
1872 onto the tip of the current branch of the work tree.
1875 must share common ancestry with the work tree's current branch.
1876 Rebasing begins with the first descendant commit of the youngest
1877 common ancestor commit shared by the specified
1879 and the work tree's current branch, and stops once the tip commit
1886 is used as intended, the specified
1888 represents a local commit history and may already contain changes
1889 that are not yet visible in any other repositories.
1890 The work tree's current branch, which must be set with
1894 operation, represents a branch from a remote repository which shares
1895 a common history with the specified
1897 but has progressed, and perhaps diverged, due to commits added to the
1900 Rebased commits are accumulated on a temporary branch which the work tree
1901 will remain switched to throughout the entire rebase operation.
1902 Commits on this branch represent the same changes with the same log
1903 messages as their counterparts on the original
1905 but with different commit IDs.
1906 Once rebasing has completed successfully, the temporary branch becomes
1907 the new version of the specified
1909 and the work tree is automatically switched to it.
1911 Old commits in their pre-rebase state are automatically backed up in the
1912 .Dq refs/got/backup/rebase
1913 reference namespace.
1914 As long as these references are not removed older versions of rebased
1915 commits will remain in the repository and can be viewed with the
1918 Removal of these references makes objects which become unreachable via
1919 any reference subject to removal by Git's garbage collector or
1920 .Cm gotadmin cleanup .
1922 While rebasing commits, show the status of each affected file,
1923 using the following status codes:
1924 .Bl -column YXZ description
1925 .It G Ta file was merged
1926 .It C Ta file was merged and conflicts occurred during merge
1927 .It ! Ta changes destined for a missing file were not merged
1928 .It D Ta file was deleted
1929 .It d Ta file's deletion was prevented by local modifications
1930 .It A Ta new file was added
1931 .It \(a~ Ta changes destined for a non-regular file were not merged
1932 .It ? Ta changes destined for an unversioned file were not merged
1935 If merge conflicts occur, the rebase operation is interrupted and may
1936 be continued once conflicts have been resolved.
1937 If any files with destined changes are found to be missing or unversioned,
1938 or if files could not be deleted due to differences in deleted content,
1939 the rebase operation will be interrupted to prevent potentially incomplete
1940 changes from being committed to the repository without user intervention.
1941 The work tree may be modified as desired and the rebase operation can be
1942 continued once the changes present in the work tree are considered complete.
1943 Alternatively, the rebase operation may be aborted which will leave
1945 unmodified and the work tree switched back to its original branch.
1947 If a merge conflict is resolved in a way which renders the merged
1948 change into a no-op change, the corresponding commit will be elided
1949 when the rebase operation continues.
1952 will refuse to run if certain preconditions are not met.
1953 If the work tree is not yet fully updated to the tip commit of its
1954 branch, then the work tree must first be updated with
1956 If changes have been staged with
1958 these changes must first be committed with
1962 If the work tree contains local changes, these changes must first be
1969 contains changes to files outside of the work tree's path prefix,
1970 the work tree cannot be used to rebase this branch.
1976 commands will refuse to run while a rebase operation is in progress.
1977 Other commands which manipulate the work tree may be used for
1978 conflict resolution purposes.
1982 is already based on the work tree's current branch, then no commits
1983 need to be rebased and
1985 will simply switch the work tree to the specified
1987 and update files in the work tree accordingly.
1994 Abort an interrupted rebase operation.
1995 If this option is used, no other command-line arguments are allowed.
1997 Continue an interrupted rebase operation.
1998 If this option is used, no other command-line arguments are allowed.
2000 Show a list of past rebase operations, represented by references in the
2001 .Dq refs/got/backup/rebase
2002 reference namespace.
2004 Display the author, date, and log message of each backed up commit,
2005 the object ID of the corresponding post-rebase commit, and
2006 the object ID of their common ancestor commit.
2007 Given these object IDs,
2014 options can be used to examine the history of either version of the branch,
2019 option can be used to create a new branch from a pre-rebase state if desired.
2023 is specified, only show commits which at some point in time represented this
2025 Otherwise, list all backed up commits for any branches.
2027 If this option is used,
2029 does not require a work tree.
2030 None of the other options can be used together with
2033 Delete backups created by past rebase operations, represented by references
2035 .Dq refs/got/backup/rebase
2036 reference namespace.
2040 is specified, only delete backups which at some point in time represented
2042 Otherwise, delete all references found within
2043 .Dq refs/got/backup/rebase .
2045 Any commit, tree, tag, and blob objects belonging to deleted backups
2046 remain in the repository and may be removed separately with
2047 Git's garbage collector or
2048 .Cm gotadmin cleanup .
2050 If this option is used,
2052 does not require a work tree.
2053 None of the other options can be used together with
2057 .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
2059 Edit commit history between the work tree's current base commit and
2060 the tip commit of the work tree's current branch.
2064 operation, the work tree's current branch must be set with
2066 to the branch which should be edited, unless this branch is already the
2067 current branch of the work tree.
2068 The tip of this branch represents the upper bound (inclusive) of commits
2073 Furthermore, the work tree's base commit
2076 to a point in this branch's commit history where editing should begin.
2077 This commit represents the lower bound (non-inclusive) of commits touched
2082 Editing of commit history is controlled via a
2084 which can be written in an editor based on a template, passed on the
2085 command line, or generated with the
2091 The format of the histedit script is line-based.
2092 Each line in the script begins with a command name, followed by
2093 whitespace and an argument.
2094 For most commands, the expected argument is a commit ID SHA1 hash.
2095 Any remaining text on the line is ignored.
2096 Lines which begin with the
2098 character are ignored entirely.
2100 The available commands are as follows:
2101 .Bl -column YXZ pick-commit
2102 .It pick Ar commit Ta Use the specified commit as it is.
2103 .It edit Ar commit Ta Use the specified commit but once changes have been
2104 merged into the work tree interrupt the histedit operation for amending.
2105 .It fold Ar commit Ta Combine the specified commit with the next commit
2106 listed further below that will be used.
2107 .It drop Ar commit Ta Remove this commit from the edited history.
2108 .It mesg Oo Ar log-message Oc Ta Create a new log message for the commit
2109 listed on the previous line of the histedit script.
2112 argument provides a new single-line log message to use.
2115 argument is omitted, open an editor where a new log message can be written.
2116 Can only be used immediately after a pick or edit command.
2119 Every commit in the history being edited must be mentioned in the script.
2120 Lines may be re-ordered to change the order of commits in the edited history.
2121 No commit may be listed more than once.
2123 Edited commits are accumulated on a temporary branch which the work tree
2124 will remain switched to throughout the entire histedit operation.
2125 Once history editing has completed successfully, the temporary branch becomes
2126 the new version of the work tree's branch and the work tree is automatically
2129 Old commits in their pre-histedit state are automatically backed up in the
2130 .Dq refs/got/backup/histedit
2131 reference namespace.
2132 As long as these references are not removed older versions of edited
2133 commits will remain in the repository and can be viewed with the
2136 Removal of these references makes objects which become unreachable via
2137 any reference subject to removal by Git's garbage collector or
2138 .Cm gotadmin cleanup .
2140 While merging commits, show the status of each affected file,
2141 using the following status codes:
2142 .Bl -column YXZ description
2143 .It G Ta file was merged
2144 .It C Ta file was merged and conflicts occurred during merge
2145 .It ! Ta changes destined for a missing file were not merged
2146 .It D Ta file was deleted
2147 .It d Ta file's deletion was prevented by local modifications
2148 .It A Ta new file was added
2149 .It \(a~ Ta changes destined for a non-regular file were not merged
2150 .It ? Ta changes destined for an unversioned file were not merged
2153 If merge conflicts occur, the histedit operation is interrupted and may
2154 be continued once conflicts have been resolved.
2155 If any files with destined changes are found to be missing or unversioned,
2156 or if files could not be deleted due to differences in deleted content,
2157 the histedit operation will be interrupted to prevent potentially incomplete
2158 changes from being committed to the repository without user intervention.
2159 The work tree may be modified as desired and the histedit operation can be
2160 continued once the changes present in the work tree are considered complete.
2161 Alternatively, the histedit operation may be aborted which will leave
2162 the work tree switched back to its original branch.
2164 If a merge conflict is resolved in a way which renders the merged
2165 change into a no-op change, the corresponding commit will be elided
2166 when the histedit operation continues.
2169 will refuse to run if certain preconditions are not met.
2170 If the work tree's current branch is not in the
2172 reference namespace, the history of the branch may not be edited.
2173 If the work tree contains multiple base commits, it must first be updated
2174 to a single base commit with
2176 If changes have been staged with
2178 these changes must first be committed with
2182 If the work tree contains local changes, these changes must first be
2187 If the edited history contains changes to files outside of the work tree's
2188 path prefix, the work tree cannot be used to edit the history of this branch.
2195 commands will refuse to run while a histedit operation is in progress.
2196 Other commands which manipulate the work tree may be used, and the
2198 command may be used to commit arbitrary changes to the temporary branch
2199 while the histedit operation is interrupted.
2206 Abort an interrupted histedit operation.
2207 If this option is used, no other command-line arguments are allowed.
2209 Continue an interrupted histedit operation.
2210 If this option is used, no other command-line arguments are allowed.
2212 Interrupt the histedit operation for editing after merging each commit.
2213 This option is a quick equivalent to a histedit script which uses the
2215 command for all commits.
2218 option can only be used when starting a new histedit operation.
2219 If this option is used, no other command-line arguments are allowed.
2221 Fold all commits into a single commit.
2222 This option is a quick equivalent to a histedit script which folds all
2223 commits, combining them all into one commit.
2226 option can only be used when starting a new histedit operation.
2227 If this option is used, no other command-line arguments are allowed.
2228 .It Fl F Ar histedit-script
2231 instead of opening a temporary file in an editor where a histedit script
2234 Edit log messages only.
2235 This option is a quick equivalent to a histedit script which edits
2236 only log messages but otherwise leaves every picked commit as-is.
2239 option can only be used when starting a new histedit operation.
2240 If this option is used, no other command-line arguments are allowed.
2242 Show a list of past histedit operations, represented by references in the
2243 .Dq refs/got/backup/histedit
2244 reference namespace.
2246 Display the author, date, and log message of each backed up commit,
2247 the object ID of the corresponding post-histedit commit, and
2248 the object ID of their common ancestor commit.
2249 Given these object IDs,
2256 options can be used to examine the history of either version of the branch,
2261 option can be used to create a new branch from a pre-histedit state if desired.
2265 is specified, only show commits which at some point in time represented this
2267 Otherwise, list all backed up commits for any branches.
2269 If this option is used,
2271 does not require a work tree.
2272 None of the other options can be used together with
2275 Delete backups created by past histedit operations, represented by references
2277 .Dq refs/got/backup/histedit
2278 reference namespace.
2282 is specified, only delete backups which at some point in time represented
2284 Otherwise, delete all references found within
2285 .Dq refs/got/backup/histedit .
2287 Any commit, tree, tag, and blob objects belonging to deleted backups
2288 remain in the repository and may be removed separately with
2289 Git's garbage collector or
2290 .Cm gotadmin cleanup .
2292 If this option is used,
2294 does not require a work tree.
2295 None of the other options can be used together with
2299 .It Cm integrate Ar branch
2301 Integrate the specified
2303 into the work tree's current branch.
2304 Files in the work tree are updated to match the contents on the integrated
2306 and the reference of the work tree's branch is changed to point at the
2307 head commit of the integrated
2310 Both branches can be considered equivalent after integration since they
2311 will be pointing at the same commit.
2312 Both branches remain available for future work, if desired.
2313 In case the integrated
2315 is no longer needed it may be deleted with
2318 Show the status of each affected file, using the following status codes:
2319 .Bl -column YXZ description
2320 .It U Ta file was updated
2321 .It D Ta file was deleted
2322 .It A Ta new file was added
2323 .It \(a~ Ta versioned file is obstructed by a non-regular file
2324 .It ! Ta a missing versioned file was restored
2328 will refuse to run if certain preconditions are not met.
2329 Most importantly, the
2331 must have been rebased onto the work tree's current branch with
2333 before it can be integrated, in order to linearize commit history and
2334 resolve merge conflicts.
2335 If the work tree contains multiple base commits, it must first be updated
2336 to a single base commit with
2338 If changes have been staged with
2340 these changes must first be committed with
2344 If the work tree contains local changes, these changes must first be
2350 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2352 Create a merge commit based on the current branch of the work tree and
2355 If a linear project history is desired, then use of
2357 should be preferred over
2359 However, even strictly linear projects may require merge commits in order
2360 to merge in new versions of third-party code stored on vendor branches
2364 Merge commits are commits based on multiple parent commits.
2365 The tip commit of the work tree's current branch, which must be set with
2369 operation, will be used as the first parent.
2370 The tip commit of the specified
2372 will be used as the second parent.
2374 No ancestral relationship between the two branches is required.
2375 If the two branches have already been merged previously, only new changes
2378 It is not possible to create merge commits with more than two parents.
2379 If more than one branch needs to be merged, then multiple merge commits
2380 with two parents each can be created in sequence.
2382 While merging changes found on the
2384 into the work tree, show the status of each affected file,
2385 using the following status codes:
2386 .Bl -column YXZ description
2387 .It G Ta file was merged
2388 .It C Ta file was merged and conflicts occurred during merge
2389 .It ! Ta changes destined for a missing file were not merged
2390 .It D Ta file was deleted
2391 .It d Ta file's deletion was prevented by local modifications
2392 .It A Ta new file was added
2393 .It \(a~ Ta changes destined for a non-regular file were not merged
2394 .It ? Ta changes destined for an unversioned file were not merged
2397 If merge conflicts occur, the merge operation is interrupted and conflicts
2398 must be resolved before the merge operation can continue.
2399 If any files with destined changes are found to be missing or unversioned,
2400 or if files could not be deleted due to differences in deleted content,
2401 the merge operation will be interrupted to prevent potentially incomplete
2402 changes from being committed to the repository without user intervention.
2403 The work tree may be modified as desired and the merge can be continued
2404 once the changes present in the work tree are considered complete.
2405 Alternatively, the merge operation may be aborted which will leave
2406 the work tree's current branch unmodified.
2408 If a merge conflict is resolved in a way which renders all merged
2409 changes into no-op changes, the merge operation cannot continue
2410 and must be aborted.
2413 will refuse to run if certain preconditions are not met.
2416 is based on the work tree's current branch, then no merge commit can
2419 may be used to integrate the
2422 If the work tree is not yet fully updated to the tip commit of its
2423 branch, then the work tree must first be updated with
2425 If the work tree contains multiple base commits, it must first be updated
2426 to a single base commit with
2428 If changes have been staged with
2430 these changes must first be committed with
2434 If the work tree contains local changes, these changes must first be
2441 contains changes to files outside of the work tree's path prefix,
2442 the work tree cannot be used to merge this branch.
2452 commands will refuse to run while a merge operation is in progress.
2453 Other commands which manipulate the work tree may be used for
2454 conflict resolution purposes.
2461 Abort an interrupted merge operation.
2462 If this option is used, no other command-line arguments are allowed.
2464 Continue an interrupted merge operation.
2465 If this option is used, no other command-line arguments are allowed.
2467 Merge changes into the work tree as usual but do not create a merge
2469 The merge result can be adjusted as desired before a merge commit is
2472 Alternatively, the merge may be aborted with
2476 .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 ...
2478 Stage local changes for inclusion in the next commit.
2481 is specified, stage all changes in the work tree.
2482 Otherwise, stage changes at or within the specified paths.
2483 Paths may be staged if they are added, modified, or deleted according to
2486 Show the status of each affected file, using the following status codes:
2487 .Bl -column YXZ description
2488 .It A Ta file addition has been staged
2489 .It M Ta file modification has been staged
2490 .It D Ta file deletion has been staged
2493 Staged file contents are saved in newly created blob objects in the repository.
2494 These blobs will be referred to by tree objects once staged changes have been
2497 Staged changes affect the behaviour of
2502 While paths with staged changes exist, the
2504 command will refuse to commit any paths which do not have staged changes.
2505 Local changes created on top of staged changes can only be committed if
2506 the path is staged again, or if the staged changes are committed first.
2509 command will show both local changes and staged changes.
2512 command is able to display local changes relative to staged changes,
2513 and to display staged changes relative to the repository.
2516 command cannot revert staged changes but may be used to revert
2517 local changes created on top of staged changes.
2524 Instead of staging new changes, list paths which are already staged,
2525 along with the IDs of staged blob objects and stage status codes.
2526 If paths were provided on the command line, show the staged paths
2527 among the specified paths.
2528 Otherwise, show all staged paths.
2530 Instead of staging the entire content of a changed file, interactively
2531 select or reject changes for staging based on
2535 (reject change), and
2537 (quit staging this file) responses.
2538 If a file is in modified status, individual patches derived from the
2539 modified file content can be staged.
2540 Files in added or deleted status may only be staged or rejected in
2542 .It Fl F Ar response-script
2550 responses line-by-line from the specified
2552 file instead of prompting interactively.
2554 Allow staging of symbolic links which point outside of the path space
2555 that is under version control.
2558 will reject such symbolic links due to safety concerns.
2561 may decide to represent such a symbolic link as a regular file which contains
2562 the link's target path, rather than creating an actual symbolic link which
2563 points outside of the work tree.
2564 Use of this option is discouraged because external mechanisms such as
2566 are better suited for managing symbolic links to paths not under
2571 will refuse to run if certain preconditions are not met.
2572 If a file contains merge conflicts, these conflicts must be resolved first.
2573 If a file is found to be out of date relative to the head commit on the
2574 work tree's current branch, the file must be updated with
2576 before it can be staged (however, this does not prevent the file from
2577 becoming out-of-date at some point after having been staged).
2584 commands will refuse to run while staged changes exist.
2585 If staged changes cannot be committed because a staged path
2586 is out of date, the path must be unstaged with
2588 before it can be updated with
2590 and may then be staged again if necessary.
2592 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2594 Merge staged changes back into the work tree and put affected paths
2595 back into non-staged status.
2598 is specified, unstage all staged changes across the entire work tree.
2599 Otherwise, unstage changes at or within the specified paths.
2601 Show the status of each affected file, using the following status codes:
2602 .Bl -column YXZ description
2603 .It G Ta file was unstaged
2604 .It C Ta file was unstaged and conflicts occurred during merge
2605 .It ! Ta changes destined for a missing file were not merged
2606 .It D Ta file was staged as deleted and still is deleted
2607 .It d Ta file's deletion was prevented by local modifications
2608 .It \(a~ Ta changes destined for a non-regular file were not merged
2616 Instead of unstaging the entire content of a changed file, interactively
2617 select or reject changes for unstaging based on
2621 (keep change staged), and
2623 (quit unstaging this file) responses.
2624 If a file is staged in modified status, individual patches derived from the
2625 staged file content can be unstaged.
2626 Files staged in added or deleted status may only be unstaged in their entirety.
2627 .It Fl F Ar response-script
2635 responses line-by-line from the specified
2637 file instead of prompting interactively.
2639 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2640 Parse and print contents of objects to standard output in a line-based
2642 Content of commit, tree, and tag objects is printed in a way similar
2643 to the actual content stored in such objects.
2644 Blob object contents are printed as they would appear in files on disk.
2646 Attempt to interpret each argument as a reference, a tag name, or
2647 an object ID SHA1 hash.
2648 References will be resolved to an object ID.
2649 Tag names will resolved to a tag object.
2650 An abbreviated hash argument will be expanded to a full SHA1 hash
2651 automatically, provided the abbreviation is unique.
2653 If none of the above interpretations produce a valid result, or if the
2655 option is used, attempt to interpret the argument as a path which will
2656 be resolved to the ID of an object found at this path in the repository.
2663 Look up paths in the specified
2665 If this option is not used, paths are looked up in the commit resolved
2666 via the repository's HEAD reference.
2667 The expected argument is a commit ID SHA1 hash or an existing reference
2668 or tag name which will be resolved to a commit ID.
2669 An abbreviated hash argument will be expanded to a full SHA1 hash
2670 automatically, provided the abbreviation is unique.
2671 .It Fl r Ar repository-path
2672 Use the repository at the specified path.
2673 If not specified, assume the repository is located at or above the current
2675 If this directory is a
2677 work tree, use the repository path associated with this work tree.
2679 Interpret all arguments as paths only.
2680 This option can be used to resolve ambiguity in cases where paths
2681 look like tag names, reference names, or object IDs.
2683 .It Cm info Op Ar path ...
2684 Display meta-data stored in a work tree.
2689 The work tree to use is resolved implicitly by walking upwards from the
2690 current working directory.
2694 arguments are specified, show additional per-file information for tracked
2695 files located at or within these paths.
2698 argument corresponds to the work tree's root directory, display information
2699 for all tracked files.
2702 .Bl -tag -width GOT_AUTHOR
2704 The author's name and email address for
2709 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2712 may fail to parse commits without an email address in author data,
2716 environment variables with a missing email address.
2718 .Ev GOT_AUTHOR will be overridden by configuration settings in
2724 configuration settings in the repository's
2731 configuration settings contained in Git's global
2733 configuration file will only be used if neither
2737 environment variable provide author information.
2738 .It Ev VISUAL , EDITOR
2739 The editor spawned by
2747 text editor will be spawned in order to give
2749 the attention it deserves.
2750 .It Ev GOT_LOG_DEFAULT_LIMIT
2751 The default limit on the number of commits traversed by
2753 If set to zero, the limit is unbounded.
2754 This variable will be silently ignored if it is set to a non-numeric value.
2757 .Bl -tag -width packed-refs -compact
2759 Repository-wide configuration settings for
2763 configuration file located in the root directory of a Git repository
2764 supersedes any relevant settings in Git's
2768 .It Pa .got/got.conf
2769 Worktree-specific configuration settings for
2773 configuration file in the
2775 meta-data directory of a work tree supersedes any relevant settings in
2778 configuration file and Git's
2785 Enable tab-completion of
2790 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2792 Clone an existing Git repository for use with
2796 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2798 Use of HTTP URLs currently requires
2802 .Dl $ git clone --bare https://github.com/openbsd/src.git
2804 Alternatively, for quick and dirty local testing of
2806 a new Git repository could be created and populated with files,
2807 e.g. from a temporary CVS checkout located at
2810 .Dl $ gotadmin init /var/git/src.git
2811 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2813 Check out a work tree from the Git repository to /usr/src:
2815 .Dl $ got checkout /var/git/src.git /usr/src
2817 View local changes in a work tree directory:
2819 .Dl $ got diff | less
2821 In a work tree, display files in a potentially problematic state:
2823 .Dl $ got status -s 'C!~?'
2825 Interactively revert selected local changes in a work tree directory:
2827 .Dl $ got revert -p -R\ .
2829 In a work tree or a git repository directory, list all branch references:
2833 In a work tree or a git repository directory, create a new branch called
2834 .Dq unified-buffer-cache
2835 which is forked off the
2839 .Dl $ got branch -c master unified-buffer-cache
2841 Switch an existing work tree to the branch
2842 .Dq unified-buffer-cache .
2843 Local changes in the work tree will be preserved and merged if necessary:
2845 .Dl $ got update -b unified-buffer-cache
2847 Create a new commit from local changes in a work tree directory.
2848 This new commit will become the head commit of the work tree's current branch:
2852 In a work tree or a git repository directory, view changes committed in
2853 the 3 most recent commits to the work tree's branch, or the branch resolved
2854 via the repository's HEAD reference, respectively:
2856 .Dl $ got log -p -l 3
2858 As above, but display changes in the order in which
2860 could apply them in sequence:
2862 .Dl $ got log -p -l 3 -R
2864 In a work tree or a git repository directory, log the history of a subdirectory:
2866 .Dl $ got log sys/uvm
2868 While operating inside a work tree, paths are specified relative to the current
2869 working directory, so this command will log the subdirectory
2872 .Dl $ cd sys/uvm && got log\ .
2874 And this command has the same effect:
2876 .Dl $ cd sys/dev/usb && got log ../../uvm
2878 And this command displays work tree meta-data about all tracked files:
2881 .Dl $ got info\ . | less
2883 Add new files and remove obsolete files in a work tree directory:
2885 .Dl $ got add sys/uvm/uvm_ubc.c
2886 .Dl $ got remove sys/uvm/uvm_vnode.c
2888 Create a new commit from local changes in a work tree directory
2889 with a pre-defined log message.
2891 .Dl $ got commit -m 'unify the buffer cache'
2893 Alternatively, create a new commit from local changes in a work tree
2894 directory with a log message that has been prepared in the file
2897 .Dl $ got commit -F /tmp/msg
2899 Update any work tree checked out from the
2900 .Dq unified-buffer-cache
2901 branch to the latest commit on this branch:
2905 Roll file content on the unified-buffer-cache branch back by one commit,
2906 and then fetch the rolled-back change into the work tree as a local change
2907 to be amended and perhaps committed again:
2909 .Dl $ got backout unified-buffer-cache
2910 .Dl $ got commit -m 'roll back previous'
2911 .Dl $ # now back out the previous backout :-)
2912 .Dl $ got backout unified-buffer-cache
2914 Fetch new changes on the remote repository's
2916 branch, making them visible on the local repository's
2923 In a repository created with a HTTP URL and
2924 .Cm git clone --bare
2927 command must be used instead:
2929 .Dl $ cd /var/git/src.git
2930 .Dl $ git fetch origin master:refs/remotes/origin/master
2934 branch to merge the new changes that are now visible on the
2939 .Dl $ got update -b origin/master
2940 .Dl $ got rebase master
2943 .Dq unified-buffer-cache
2944 branch on top of the new head commit of the
2948 .Dl $ got update -b master
2949 .Dl $ got rebase unified-buffer-cache
2951 Create a patch from all changes on the unified-buffer-cache branch.
2952 The patch can be mailed out for review and applied to
2956 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2958 Edit the entire commit history of the
2959 .Dq unified-buffer-cache
2962 .Dl $ got update -b unified-buffer-cache
2963 .Dl $ got update -c master
2966 Before working against existing branches in a repository cloned with
2967 .Cm git clone --bare
2972 must be configured to map all references in the remote repository
2975 namespace of the local repository.
2976 This can be achieved by setting Git's
2977 .Pa remote.origin.fetch
2978 configuration variable to the value
2979 .Dq +refs/heads/*:refs/remotes/origin/*
2984 .Dl $ cd /var/git/repo
2985 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2989 option must be disabled:
2991 .Dl $ cd /var/git/repo
2992 .Dl $ git config remote.origin.mirror false
2994 Alternatively, the following
2996 configuration item can be added manually to the Git repository's
3000 .Dl [remote \&"origin\&"]
3002 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
3005 This configuration leaves the local repository's
3007 namespace free for use by local branches checked out with
3009 and, if needed, created with
3012 .Dq refs/remotes/origin
3013 namespace can now be updated with incoming changes from the remote
3018 without extra command line arguments.
3019 Newly fetched changes can be examined with
3022 Display changes on the remote repository's version of the
3024 branch, as of the last time
3028 .Dl $ got log -c origin/master | less
3030 As shown here, most commands accept abbreviated reference names such as
3033 .Dq refs/remotes/origin/master .
3034 The latter is only needed in case of ambiguity.
3037 must be used to merge changes which are visible on the
3042 This will also merge local changes, if any, with the incoming changes:
3044 .Dl $ got update -b origin/master
3045 .Dl $ got rebase master
3047 In order to make changes committed to the
3048 .Dq unified-buffer-cache
3052 .Dq unified-buffer-cache
3053 branch must first be rebased onto the
3057 .Dl $ got update -b master
3058 .Dl $ got rebase unified-buffer-cache
3061 .Dq unified-buffer-cache
3062 branch can now be made visible on the
3066 Because the rebase operation switched the work tree to the
3067 .Dq unified-buffer-cache
3068 branch, the work tree must be switched back to the
3072 .Dl $ got update -b master
3073 .Dl $ got integrate unified-buffer-cache
3077 branch, log messages for local changes can now be amended with
3079 by other developers and any other important new information:
3081 .Dl $ got update -c origin/master
3082 .Dl $ got histedit -m
3084 If the remote repository offers write access, local changes on the
3086 branch can be sent to the remote repository with
3090 can be run without further arguments.
3091 The arguments shown here match defaults, provided the work tree's
3092 current branch is the
3096 .Dl $ got send -b master origin
3098 If the remote repository requires the HTTPS protocol, the
3100 command must be used instead:
3102 .Dl $ cd /var/git/src.git
3103 .Dl $ git push origin master
3107 .Xr git-repository 5 ,
3108 .Xr got-worktree 5 ,
3112 .An Anthony J. Bentley Aq Mt bentley@openbsd.org
3113 .An Christian Weisgerber Aq Mt naddy@openbsd.org
3114 .An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
3115 .An Josh Rickmar Aq Mt jrick@zettaport.com
3116 .An Joshua Stein Aq Mt jcs@openbsd.org
3117 .An Klemens Nanni Aq Mt kn@openbsd.org
3118 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3119 .An Neels Hofmeyr Aq Mt neels@hofmeyr.de
3120 .An Omar Polo Aq Mt op@openbsd.org
3121 .An Ori Bernstein Aq Mt ori@openbsd.org
3122 .An Sebastien Marie Aq Mt semarie@openbsd.org
3123 .An Stefan Sperling Aq Mt stsp@openbsd.org
3124 .An Steven McDonald Aq Mt steven@steven-mcdonald.id.au
3125 .An Theo Buehler Aq Mt tb@openbsd.org
3126 .An Thomas Adam Aq Mt thomas@xteddy.org
3127 .An Tracey Emery Aq Mt tracey@traceyemery.net
3128 .An Yang Zhong Aq Mt yzhong@freebsdfoundation.org
3135 were derived from code under copyright by:
3137 .An Caldera International Inc.
3138 .An Daniel Hartmeier
3143 .An Jean-Francois Brousseau
3149 .An Niklas Hallqvist
3154 .An Xavier Santolaria
3157 contains code contributed to the public domain by
3161 is a work-in-progress and some features remain to be implemented.
3163 At present, the user has to fall back on
3165 to perform some tasks.
3169 Reading from remote repositories over HTTP or HTTPS protocols requires
3174 Writing to remote repositories over HTTP or HTTPS protocols requires
3177 The creation of merge commits with more than two parent commits requires
3180 In situations where files or directories were moved around
3182 will not automatically merge changes to new locations and
3184 will usually produce better results.
