2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
77 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
79 Create an initial commit in a repository from the file hierarchy
82 The created commit will not have any parent commits, i.e. it will be a
84 Also create a new reference which provides a branch name for the newly
86 Show the path of each imported file to indicate progress.
92 environment variable to be set,
93 unless an author has been configured in
99 configuration settings can be obtained from the repository's
101 file or from Git's global
112 instead of creating the default branch
114 Use of this option is required if the
116 branch already exists.
118 Use the specified log message when creating the new commit.
123 opens a temporary file in an editor where a log message can be written.
124 .It Fl r Ar repository-path
125 Use the repository at the specified path.
126 If not specified, assume the repository is located at or above the current
129 Ignore files or directories with a name which matches the specified
131 This option may be specified multiple times to build a list of ignore patterns.
134 follows the globbing rules documented in
138 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
140 Clone a Git repository at the specified
146 is specified the directory name will be derived from the name of the
149 will refuse to run if the
155 specifies a protocol scheme, a server hostname, an optional port number
156 separated from the hostname by a colon, and a path to the repository on
158 .Lk scheme://hostname:port/path/to/repository
160 The following protocol schemes are supported:
161 .Bl -tag -width git+ssh
163 The Git protocol as implemented by the
166 Use of this protocol is discouraged since it supports neither authentication
169 The Git protocol wrapped in an authenticated and encrypted
172 With this protocol the hostname may contain an embedded username for
177 Short alias for git+ssh.
180 Objects in the cloned repository are stored in a pack file which is downloaded
182 This pack file will then be indexed to facilitate access to the objects stored
184 If any objects in the pack file are stored in deltified form, all deltas will
185 be fully resolved in order to compute the ID of such objects.
186 This can take some time.
187 More details about the pack file format are documented in
188 .Xr git-repository 5 .
191 creates a remote repository entry in the
195 files of the cloned repository to store the
201 arguments for future use by
211 Fetch all branches from the remote repository's
213 reference namespace and set
214 .Cm fetch-all-branches
215 in the cloned repository's
217 file for future use by
219 If this option is not specified, a branch resolved via the remote
220 repository's HEAD reference will be fetched.
221 Cannot be used together with the
227 from the remote repository's
230 This option may be specified multiple times to build a list of branches
232 If the branch corresponding to the remote repository's HEAD reference is not
233 in this list, the cloned repository's HEAD reference will be set to the first
234 branch which was fetched.
235 If this option is not specified, a branch resolved via the remote
236 repository's HEAD reference will be fetched.
237 Cannot be used together with the
241 List branches and tags available for fetching from the remote repository
242 and exit immediately.
243 Cannot be used together with any of the other options except
248 Create the cloned repository as a mirror of the original repository.
249 This is useful if the cloned repository will not be used to store
250 locally created commits.
256 files will be set up with the
258 option enabled, such that
262 will write incoming changes directly to branches in the
264 reference namespace, rather than to branches in the
267 This avoids the usual requirement of having to run
271 in order to make incoming changes appear on branches in the
274 But maintaining custom changes in the cloned repository becomes difficult
275 since such changes will be at risk of being discarded whenever incoming
278 Suppress progress reporting output.
279 The same option will be passed to
286 to print debugging messages to standard error output.
287 This option will be passed to
290 Multiple -v options increase the verbosity.
292 .It Fl R Ar reference
293 In addition to the branches and tags that will be fetched, fetch an arbitrary
295 from the remote repository's
298 This option may be specified multiple times to build a list of additional
302 may either be a path to a specific reference, or a reference namespace
303 which will cause all references in this namespace to be fetched.
305 Each reference will be mapped into the cloned repository's
307 namespace, unless the
309 option is used to mirror references directly into the cloned repository's
314 will refuse to fetch references from the remote repository's
321 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Oo Fl X Oc Op Ar remote-repository
323 Fetch new changes from a remote repository.
325 .Ar remote-repository
329 The remote repository's URL is obtained from the corresponding entry in
333 file of the local repository, as created by
336 New changes will be stored in a separate pack file downloaded from the server.
337 Optionally, separate pack files stored in the repository can be combined with
340 By default, branch references in the
342 reference namespace will be updated to point at the newly fetched commits.
345 command can then be used to make new changes visible on branches in the
347 namespace, merging incoming changes with the changes on those branches
350 If the repository was created as a mirror with
352 then all branches in the
354 namespace will be updated directly to match the corresponding branches in
355 the remote repository.
356 If those branches contained local commits, these commits will no longer be
357 reachable via a reference and will therefore be at risk of being discarded
358 by Git's garbage collector or
359 .Cm gotadmin cleanup .
360 Maintaining custom changes in a mirror repository is therefore discouraged.
362 In any case, references in the
364 namespace will always be fetched and mapped directly to local references
365 in the same namespace.
372 Fetch all branches from the remote repository's
375 This option can be enabled by default for specific repositories in
377 If this option is not specified, a branch resolved via the remote
378 repository's HEAD reference will be fetched.
379 Cannot be used together with the
385 from the remote repository's
388 This option may be specified multiple times to build a list of branches
390 If this option is not specified, a branch resolved via the remote
391 repository's HEAD reference will be fetched.
392 Cannot be used together with the
396 Delete branches and tags from the local repository which are no longer
397 present in the remote repository.
398 Only references are deleted.
399 Any commit, tree, tag, and blob objects belonging to deleted branches or
400 tags remain in the repository and may be removed separately with
401 Git's garbage collector or
402 .Cm gotadmin cleanup .
404 List branches and tags available for fetching from the remote repository
405 and exit immediately.
406 Cannot be used together with any of the other options except
412 Allow existing references in the
414 namespace to be updated if they have changed on the server.
415 If not specified, only new tag references will be created.
416 .It Fl r Ar repository-path
417 Use the repository at the specified path.
418 If not specified, assume the repository is located at or above the current
420 If this directory is a
422 work tree, use the repository path associated with this work tree.
424 Suppress progress reporting output.
425 The same option will be passed to
432 to print debugging messages to standard error output.
433 The same option will be passed to
436 Multiple -v options increase the verbosity.
438 .It Fl R Ar reference
439 In addition to the branches and tags that will be fetched, fetch an arbitrary
441 from the remote repository's
444 This option may be specified multiple times to build a list of additional
448 may either be a path to a specific reference, or a reference namespace
449 which will cause all references in this namespace to be fetched.
451 Each reference will be mapped into the local repository's
453 namespace, unless the local repository was created as a mirror with
455 in which case references will be mapped directly into the local repository's
459 Once a reference has been fetched, a branch based on it can be created with
464 will refuse to fetch references from the remote repository's
470 Delete all references which correspond to a particular
471 .Ar remote-repository
472 instead of fetching new changes.
473 This can be useful when a remote repository is being removed from
479 .Ar remote-repository
480 argument is mandatory and no other options except
487 Only references are deleted.
488 Any commit, tree, tag, and blob objects fetched from a remote repository
489 will generally be stored in pack files and may be removed separately with
491 and Git's garbage collector.
494 .It Cm checkout Oo Fl E Oc Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl p Ar path-prefix Oc Oo Fl q Oc Ar repository-path Op Ar work-tree-path
496 Copy files from a repository into a new work tree.
497 Show the status of each affected file, using the following status codes:
498 .Bl -column YXZ description
499 .It A Ta new file was added
500 .It E Ta file already exists in work tree's meta-data
505 is not specified, either use the last component of
506 .Ar repository path ,
509 was specified use the last component of
517 Proceed with the checkout operation even if the directory at
520 Existing files will be left intact.
522 Check out files from a commit on the specified
524 If this option is not specified, a branch resolved via the repository's HEAD
525 reference will be used.
527 Check out files from the specified
529 on the selected branch.
530 The expected argument is a commit ID SHA1 hash or an existing reference
531 or tag name which will be resolved to a commit ID.
532 An abbreviated hash argument will be expanded to a full SHA1 hash
533 automatically, provided the abbreviation is unique.
534 If this option is not specified, the most recent commit on the selected
539 is not contained in the selected branch, a different branch which contains
540 this commit must be specified with the
543 If no such branch is known a new branch must be created for this
549 Checking out work trees with an unknown branch is intentionally not supported.
550 .It Fl p Ar path-prefix
551 Restrict the work tree to a subset of the repository's tree hierarchy.
552 Only files beneath the specified
556 Silence progress output.
559 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Oo Fl q Oc Op Ar path ...
561 Update an existing work tree to a different
563 Change existing files in the work tree as necessary to match file contents
565 Preserve any local changes in the work tree and merge them with the
568 Files which already contain merge conflicts will not be updated to avoid
569 further complications.
570 Such files will be updated when
572 is run again after merge conflicts have been resolved.
573 If the conflicting changes are no longer needed affected files can be
580 Show the status of each affected file, using the following status codes:
581 .Bl -column YXZ description
582 .It U Ta file was updated and contained no local changes
583 .It G Ta file was updated and local changes were merged cleanly
584 .It C Ta file was updated and conflicts occurred during merge
585 .It D Ta file was deleted
586 .It A Ta new file was added
587 .It \(a~ Ta versioned file is obstructed by a non-regular file
588 .It ! Ta a missing versioned file was restored
589 .It # Ta file was not updated because it contains merge conflicts
590 .It ? Ta changes destined for an unversioned file were not merged
595 is specified, update the entire work tree.
596 Otherwise, restrict the update operation to files at or within the
598 Each path is required to exist in the update operation's target commit.
599 Files in the work tree outside specified paths will remain unchanged and
600 will retain their previously recorded base commit.
603 commands may refuse to run while the work tree contains files from
604 multiple base commits.
605 The base commit of such a work tree can be made consistent by running
607 across the entire work tree.
610 is incompatible with the
615 cannot update paths with staged changes.
616 If changes have been staged with
618 these changes must first be committed with
628 Switch the work tree's branch reference to the specified
630 before updating the work tree.
631 This option requires that all paths in the work tree are updated.
633 As usual, any local changes in the work tree will be preserved.
634 This can be useful when switching to a newly created branch in order
635 to commit existing local changes to this branch.
637 Any local changes must be dealt with separately in order to obtain a
638 work tree with pristine file contents corresponding exactly to the specified
640 Such changes could first be committed to a different branch with
642 or could be discarded with
645 Update the work tree to the specified
647 The expected argument is a commit ID SHA1 hash or an existing reference
648 or tag name which will be resolved to a commit ID.
649 An abbreviated hash argument will be expanded to a full SHA1 hash
650 automatically, provided the abbreviation is unique.
651 If this option is not specified, the most recent commit on the work tree's
654 Silence progress output.
657 .It Cm status Oo Fl I Oc Oo Fl s Ar status-codes Oc Oo Fl S Ar status-codes Oc Op Ar path ...
659 Show the current modification status of files in a work tree,
660 using the following status codes:
661 .Bl -column YXZ description
662 .It M Ta modified file
663 .It A Ta file scheduled for addition in next commit
664 .It D Ta file scheduled for deletion in next commit
665 .It C Ta modified or added file which contains merge conflicts
666 .It ! Ta versioned file was expected on disk but is missing
667 .It \(a~ Ta versioned file is obstructed by a non-regular file
668 .It ? Ta unversioned item not tracked by
670 .It m Ta modified file modes (executable bit only)
671 .It N Ta non-existent
673 specified on the command line
678 is specified, show modifications in the entire work tree.
679 Otherwise, show modifications at or within the specified paths.
681 If changes have been staged with
683 staged changes are shown in the second output column, using the following
685 .Bl -column YXZ description
686 .It M Ta file modification is staged
687 .It A Ta file addition is staged
688 .It D Ta file deletion is staged
691 Changes created on top of staged changes are indicated in the first column:
692 .Bl -column YXZ description
693 .It MM Ta file was modified after earlier changes have been staged
694 .It MA Ta file was modified after having been staged for addition
702 Show unversioned files even if they match an ignore pattern.
703 .It Fl s Ar status-codes
704 Only show files with a modification status matching any of the
705 single-character status codes contained in the
708 Any combination of codes from the above list of possible status codes
710 For staged files, status codes displayed in either column will be matched.
711 Cannot be used together with the
714 .It Fl S Ar status-codes
715 Suppress the output of files with a modification status matching any of the
716 single-character status codes contained in the
719 Any combination of codes from the above list of possible status codes
721 For staged files, status codes displayed in either column will be matched.
722 Cannot be used together with the
727 For compatibility with
738 files in each traversed directory and will not display unversioned files
739 which match these patterns.
744 supports consecutive asterisks,
746 which will match an arbitrary amount of directories.
750 only supports a single ignore pattern per line.
754 does not support negated ignore patterns prefixed with
756 and gives no special significance to the location of path component separators,
759 .It Cm log Oo Fl b Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl P Oc Oo Fl s Ar search-pattern Oc Oo Fl r Ar repository-path Oc Oo Fl R Oc Oo Fl x Ar commit Oc Op Ar path
760 Display history of a repository.
763 is specified, show only commits which modified this path.
764 If invoked in a work tree, the
766 is interpreted relative to the current working directory,
767 and the work tree's path prefix is implicitly prepended.
768 Otherwise, the path is interpreted relative to the repository root.
775 Display individual commits which were merged into the current branch
779 shows the linear history of the current branch only.
781 Start traversing history at the specified
783 The expected argument is a commit ID SHA1 hash or an existing reference
784 or tag name which will be resolved to a commit ID.
785 An abbreviated hash argument will be expanded to a full SHA1 hash
786 automatically, provided the abbreviation is unique.
787 If this option is not specified, default to the work tree's current branch
788 if invoked in a work tree, or to the repository's HEAD reference.
790 Set the number of context lines shown in diffs with
792 By default, 3 lines of context are shown.
794 Limit history traversal to a given number of commits.
795 If this option is not specified, a default limit value of zero is used,
796 which is treated as an unbounded limit.
798 .Ev GOT_LOG_DEFAULT_LIMIT
799 environment variable may be set to change this default value.
801 Display the patch of modifications made in each commit.
804 is specified, only show the patch of modifications at or within this path.
806 Display the list of file paths changed in each commit, using the following
808 .Bl -column YXZ description
809 .It M Ta modified file
810 .It D Ta file was deleted
811 .It A Ta new file was added
812 .It m Ta modified file modes (executable bit only)
814 .It Fl s Ar search-pattern
815 If specified, show only commits with a log message matched by the extended
818 When used together with
820 then the file paths changed by a commit can be matched as well.
821 Regular expression syntax is documented in
823 .It Fl r Ar repository-path
824 Use the repository at the specified path.
825 If not specified, assume the repository is located at or above the current
827 If this directory is a
829 work tree, use the repository path associated with this work tree.
831 Determine a set of commits to display as usual, but display these commits
834 Stop traversing commit history immediately after the specified
837 This option has no effect if the specified
842 .It Cm diff Oo Fl a Oc Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl P Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path ...
844 When invoked within a work tree without any arguments, display all
845 local changes in the work tree.
848 arguments are specified, only show changes within the specified paths.
850 If two arguments are provided, treat each argument as a reference, a tag
851 name, or an object ID SHA1 hash, and display differences between the
852 corresponding objects.
853 Both objects must be of the same type (blobs, trees, or commits).
854 An abbreviated hash argument will be expanded to a full SHA1 hash
855 automatically, provided the abbreviation is unique.
856 If none of these interpretations produce a valid result or if the
861 is running in a work tree, attempt to interpret the two arguments as paths.
868 Treat file contents as ASCII text even if binary data is detected.
870 Show differences between commits in the repository.
871 This options may be used up to two times.
872 When used only once, show differences between the specified
874 and its first parent commit.
875 When used twice, show differences between the two specified commits.
877 The expected argument is a commit ID SHA1 hash or an existing reference
878 or tag name which will be resolved to a commit ID.
879 An abbreviated hash argument will be expanded to a full SHA1 hash
880 automatically, provided the abbreviation is unique.
884 option is used, all non-option arguments will be interpreted as paths.
887 arguments are provided, only show differences for the specified paths.
889 Cannot be used together with the
893 Set the number of context lines shown in the diff.
894 By default, 3 lines of context are shown.
895 .It Fl r Ar repository-path
896 Use the repository at the specified path.
897 If not specified, assume the repository is located at or above the current
899 If this directory is a
901 work tree, use the repository path associated with this work tree.
903 Show changes staged with
905 instead of showing local changes in the work tree.
906 This option is only valid when
908 is invoked in a work tree.
910 Interpret all arguments as paths only.
911 This option can be used to resolve ambiguity in cases where paths
912 look like tag names, reference names, or object IDs.
913 This option is only valid when
915 is invoked in a work tree.
917 Ignore whitespace-only changes.
920 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
922 Display line-by-line history of a file at the specified path.
929 Start traversing history at the specified
931 The expected argument is a commit ID SHA1 hash or an existing reference
932 or tag name which will be resolved to a commit ID.
933 An abbreviated hash argument will be expanded to a full SHA1 hash
934 automatically, provided the abbreviation is unique.
935 .It Fl r Ar repository-path
936 Use the repository at the specified path.
937 If not specified, assume the repository is located at or above the current
939 If this directory is a
941 work tree, use the repository path associated with this work tree.
944 .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
946 Display a listing of files and directories at the specified
947 directory path in the repository.
948 Entries shown in this listing may carry one of the following trailing
950 .Bl -column YXZ description
951 .It @ Ta entry is a symbolic link
952 .It / Ta entry is a directory
953 .It * Ta entry is an executable file
954 .It $ Ta entry is a Git submodule
957 Symbolic link entries are also annotated with the target path of the link.
961 is specified, list the repository path corresponding to the current
962 directory of the work tree, or the root directory of the repository
963 if there is no work tree.
970 List files and directories as they appear in the specified
972 The expected argument is a commit ID SHA1 hash or an existing reference
973 or tag name which will be resolved to a commit ID.
974 An abbreviated hash argument will be expanded to a full SHA1 hash
975 automatically, provided the abbreviation is unique.
976 .It Fl r Ar repository-path
977 Use the repository at the specified path.
978 If not specified, assume the repository is located at or above the current
980 If this directory is a
982 work tree, use the repository path associated with this work tree.
984 Show object IDs of files (blob objects) and directories (tree objects).
986 Recurse into sub-directories in the repository.
988 .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
989 Manage references in a repository.
991 References may be listed, created, deleted, and changed.
992 When creating, deleting, or changing a reference the specified
994 must be an absolute reference name, i.e. it must begin with
1001 .It Fl r Ar repository-path
1002 Use the repository at the specified path.
1003 If not specified, assume the repository is located at or above the current
1005 If this directory is a
1007 work tree, use the repository path associated with this work tree.
1009 List references in the repository.
1012 is specified, list all existing references in the repository.
1015 is a reference namespace, list all references in this namespace.
1016 Otherwise, show only the reference with the given
1018 Cannot be used together with any other options except
1023 Sort listed references by modification time (most recently modified first)
1024 instead of sorting by lexicographical order.
1025 Use of this option requires the
1027 option to be used as well.
1029 Create a reference or change an existing reference.
1030 The reference with the specified
1032 will point at the specified
1036 argument is a ID SHA1 hash or an existing reference or tag name which will
1037 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
1038 Cannot be used together with any other options except
1040 .It Fl s Ar reference
1041 Create a symbolic reference, or change an existing symbolic reference.
1042 The symbolic reference with the specified
1044 will point at the specified
1046 which must already exist in the repository.
1047 Care should be taken not to create loops between references when
1048 this option is used.
1049 Cannot be used together with any other options except
1052 Delete the reference with the specified
1054 from the repository.
1055 Any commit, tree, tag, and blob objects belonging to deleted references
1056 remain in the repository and may be removed separately with
1057 Git's garbage collector or
1058 .Cm gotadmin cleanup .
1059 Cannot be used together with any other options except
1063 .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
1065 Create, list, or delete branches.
1067 Local branches are managed via references which live in the
1069 reference namespace.
1072 command creates references in this namespace only.
1074 When deleting branches the specified
1078 reference namespace first.
1079 If no corresponding branch is found the
1081 namespace will be searched next.
1083 If invoked in a work tree without any arguments, print the name of the
1084 work tree's current branch.
1088 argument is passed, attempt to create a branch reference with the given name.
1089 By default the new branch reference will point at the latest commit on the
1090 work tree's current branch if invoked in a work tree, and otherwise to a commit
1091 resolved via the repository's HEAD reference.
1093 If invoked in a work tree, once the branch was created successfully
1094 switch the work tree's head reference to the newly created branch and
1095 update files across the entire work tree, just like
1096 .Cm got update -b Ar name
1098 Show the status of each affected file, using the following status codes:
1099 .Bl -column YXZ description
1100 .It U Ta file was updated and contained no local changes
1101 .It G Ta file was updated and local changes were merged cleanly
1102 .It C Ta file was updated and conflicts occurred during merge
1103 .It D Ta file was deleted
1104 .It A Ta new file was added
1105 .It \(a~ Ta versioned file is obstructed by a non-regular file
1106 .It ! Ta a missing versioned file was restored
1114 Make a newly created branch reference point at the specified
1118 argument is a commit ID SHA1 hash or an existing reference
1119 or tag name which will be resolved to a commit ID.
1120 .It Fl r Ar repository-path
1121 Use the repository at the specified path.
1122 If not specified, assume the repository is located at or above the current
1124 If this directory is a
1126 work tree, use the repository path associated with this work tree.
1128 List all existing branches in the repository, including copies of remote
1129 repositories' branches in the
1131 reference namespace.
1133 If invoked in a work tree, the work tree's current branch is shown
1134 with one the following annotations:
1135 .Bl -column YXZ description
1136 .It * Ta work tree's base commit matches the branch tip
1137 .It \(a~ Ta work tree's base commit is out-of-date
1140 Sort listed branches by modification time (most recently modified first)
1141 instead of sorting by lexicographical order.
1144 reference namespace are listed before branches in
1147 Use of this option requires the
1149 option to be used as well.
1151 Delete the branch with the specified
1157 reference namespace.
1159 Only the branch reference is deleted.
1160 Any commit, tree, and blob objects belonging to the branch
1161 remain in the repository and may be removed separately with
1162 Git's garbage collector or
1163 .Cm gotadmin cleanup .
1165 Do not switch and update the work tree after creating a new branch.
1167 .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
1168 Manage tags in a repository.
1170 Tags are managed via references which live in the
1172 reference namespace.
1175 command operates on references in this namespace only.
1176 References in this namespace point at tag objects which contain a pointer
1177 to another object, a tag message, as well as author and timestamp information.
1179 Attempt to create a tag with the given
1181 and make this tag point at the given
1183 If no commit is specified, default to the latest commit on the work tree's
1184 current branch if invoked in a work tree, and to a commit resolved via
1185 the repository's HEAD reference otherwise.
1192 Make the newly created tag reference point at the specified
1196 argument is a commit ID SHA1 hash or an existing reference or tag name which
1197 will be resolved to a commit ID.
1198 An abbreviated hash argument will be expanded to a full SHA1 hash
1199 automatically, provided the abbreviation is unique.
1201 Use the specified tag message when creating the new tag.
1206 opens a temporary file in an editor where a tag message can be written.
1207 .It Fl r Ar repository-path
1208 Use the repository at the specified path.
1209 If not specified, assume the repository is located at or above the current
1211 If this directory is a
1213 work tree, use the repository path associated with this work tree.
1215 List all existing tags in the repository instead of creating a new tag.
1216 If this option is used, no other command-line arguments are allowed.
1221 command will not delete tags or change existing tags.
1222 If a tag must be deleted, the
1224 command may be used to delete a tag's reference.
1225 This should only be done if the tag has not already been copied to
1227 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1228 Schedule unversioned files in a work tree for addition to the
1229 repository in the next commit.
1230 By default, files which match a
1232 ignore pattern will not be added.
1239 Permit recursion into directories.
1240 If this option is not specified,
1242 will refuse to run if a specified
1246 Add files even if they match a
1251 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Oo Fl s Ar status-codes Oc Ar path ...
1253 Remove versioned files from a work tree and schedule them for deletion
1254 from the repository in the next commit.
1261 Perform the operation even if a file contains local modifications,
1262 and do not raise an error if a specified
1264 does not exist on disk.
1266 Keep affected files on disk.
1268 Permit recursion into directories.
1269 If this option is not specified,
1271 will refuse to run if a specified
1274 .It Fl s Ar status-codes
1275 Only delete files with a modification status matching one of the
1276 single-character status codes contained in the
1279 The following status codes may be specified:
1280 .Bl -column YXZ description
1281 .It M Ta modified file (this implies the
1284 .It ! Ta versioned file expected on disk but missing
1288 .It Cm patch Op Ar patchfile
1292 .Pq or standard input
1293 that must be a unified diff.
1296 contains more than one patch,
1299 will try to apply each of them in sequence.
1300 Files added or removed by the patch scheduled for addition or removal in
1305 show the status of each affected file, using the following status codes:
1306 .Bl -column XYZ description
1307 .It M Ta modified file
1308 .It D Ta deleted file
1312 If a change does not match at its exact line number,
1315 applies it somewhere else in the file if it can find a good spot before
1320 will refuse to apply a patch if certain preconditions are not met.
1321 Files to be deleted must be present in the work tree and not have been
1322 scheduled for deletion already.
1323 Files to be added must be unknown and not present in the work tree.
1324 Files to be modified must be already present in the the work tree and
1325 not have conflicts or being obstructed.
1327 If an error occurs, the
1329 operation will be aborted.
1330 Any changes made to the work tree up to this point will be left behind.
1331 Such cahnges can be viewed with
1333 and can be reverted with
1337 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1339 Revert any local changes in files at the specified paths in a work tree.
1340 File contents will be overwritten with those contained in the
1341 work tree's base commit.
1342 There is no way to bring discarded changes back after
1345 If a file was added with
1347 it will become an unversioned file again.
1348 If a file was deleted with
1350 it will be restored.
1357 Instead of reverting all changes in files, interactively select or reject
1358 changes to revert based on
1364 (quit reverting this file) responses.
1365 If a file is in modified status, individual patches derived from the
1366 modified file content can be reverted.
1367 Files in added or deleted status may only be reverted in their entirety.
1368 .It Fl F Ar response-script
1376 responses line-by-line from the specified
1378 file instead of prompting interactively.
1380 Permit recursion into directories.
1381 If this option is not specified,
1383 will refuse to run if a specified
1388 .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 ...
1390 Create a new commit in the repository from changes in a work tree
1391 and use this commit as the new base commit for the work tree.
1394 is specified, commit all changes in the work tree.
1395 Otherwise, commit changes at or within the specified paths.
1397 If changes have been explicitly staged for commit with
1399 only commit staged changes and reject any specified paths which
1400 have not been staged.
1403 opens a temporary file in an editor where a log message can be written
1411 options are used together.
1413 Show the status of each affected file, using the following status codes:
1414 .Bl -column YXZ description
1415 .It M Ta modified file
1416 .It D Ta file was deleted
1417 .It A Ta new file was added
1418 .It m Ta modified file modes (executable bit only)
1421 Files which are not part of the new commit will retain their previously
1422 recorded base commit.
1425 commands may refuse to run while the work tree contains files from
1426 multiple base commits.
1427 The base commit of such a work tree can be made consistent by running
1429 across the entire work tree.
1433 command requires the
1435 environment variable to be set,
1436 unless an author has been configured in
1442 configuration settings can be
1443 obtained from the repository's
1445 file or from Git's global
1454 Use the prepared log message stored in the file found at
1456 when creating the new commit.
1458 opens a temporary file in an editor where the prepared log message can be
1459 reviewed and edited further if needed.
1460 Cannot be used together with the
1464 Use the specified log message when creating the new commit.
1465 Cannot be used together with the
1469 This option prevents
1471 from opening the commit message in an editor.
1472 It has no effect unless it is used together with the
1474 option and is intended for non-interactive use such as scripting.
1476 Allow the addition of symbolic links which point outside of the path space
1477 that is under version control.
1480 will reject such symbolic links due to safety concerns.
1483 may decide to represent such a symbolic link as a regular file which contains
1484 the link's target path, rather than creating an actual symbolic link which
1485 points outside of the work tree.
1486 Use of this option is discouraged because external mechanisms such as
1488 are better suited for managing symbolic links to paths not under
1493 will refuse to run if certain preconditions are not met.
1494 If the work tree's current branch is not in the
1496 reference namespace, new commits may not be created on this branch.
1497 Local changes may only be committed if they are based on file content
1498 found in the most recent commit on the work tree's branch.
1499 If a path is found to be out of date,
1501 must be used first in order to merge local changes with changes made
1504 .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
1506 Send new changes to a remote repository.
1508 .Ar remote-repository
1512 The remote repository's URL is obtained from the corresponding entry in
1516 file of the local repository, as created by
1519 All objects corresponding to new changes will be written to a temporary
1520 pack file which is then uploaded to the server.
1521 Upon success, references in the
1523 reference namespace of the local repository will be updated to point at
1524 the commits which have been sent.
1526 By default, changes will only be sent if they are based on up-to-date
1527 copies of relevant branches in the remote repository.
1528 If any changes to be sent are based on out-of-date copies or would
1529 otherwise break linear history of existing branches, new changes must
1530 be fetched from the server with
1532 and local branches must be rebased with
1539 option can be used to make exceptions to these requirements.
1546 Send all branches from the local repository's
1548 reference namespace.
1551 option is equivalent to listing all branches with multiple
1554 Cannot be used together with the
1560 from the local repository's
1562 reference namespace.
1563 This option may be specified multiple times to build a list of branches
1565 If this option is not specified, default to the work tree's current branch
1566 if invoked in a work tree, or to the repository's HEAD reference.
1567 Cannot be used together with the
1571 Delete the specified
1573 from the remote repository's
1575 reference namespace.
1576 This option may be specified multiple times to build a list of branches
1579 Only references are deleted.
1580 Any commit, tree, tag, and blob objects belonging to deleted branches
1581 may become subject to deletion by Git's garbage collector running on
1584 Requesting deletion of branches results in an error if the server
1585 does not support this feature or disallows the deletion of branches
1586 based on its configuration.
1588 Attempt to force the server to overwrite existing branches or tags
1589 in the remote repository, even when
1593 would usually be required before changes can be sent.
1594 The server may reject forced requests regardless, depending on its
1597 Any commit, tree, tag, and blob objects belonging to overwritten branches
1598 or tags may become subject to deletion by Git's garbage collector running
1603 reference namespace is globally shared between all repositories.
1606 option to overwrite tags is discouraged because it can lead to
1607 inconsistencies between the tags present in different repositories.
1608 In general, creating a new tag with a different name is recommended
1609 instead of overwriting an existing tag.
1613 option is particularly discouraged if changes being sent are based
1614 on an out-of-date copy of a branch in the remote repository.
1615 Instead of using the
1617 option, new changes should
1620 and local branches should be rebased with
1622 followed by another attempt to send the changes.
1626 option should only be needed in situations where the remote repository's
1627 copy of a branch or tag is known to be out-of-date and is considered
1629 The risks of creating inconsistencies between different repositories
1630 should also be taken into account.
1631 .It Fl r Ar repository-path
1632 Use the repository at the specified path.
1633 If not specified, assume the repository is located at or above the current
1635 If this directory is a
1637 work tree, use the repository path associated with this work tree.
1641 from the local repository's
1643 reference namespace, in addition to any branches that are being sent.
1646 option may be specified multiple times to build a list of tags to send.
1647 No tags will be sent if the
1651 Raise an error if the specified
1653 already exists in the remote repository, unless the
1655 option is used to overwrite the server's copy of the tag.
1656 In general, creating a new tag with a different name is recommended
1657 instead of overwriting an existing tag.
1659 Cannot be used together with the
1663 Attempt to send all tags from the local repository's
1665 reference namespace.
1668 option is equivalent to listing all tags with multiple
1671 Cannot be used together with the
1675 Suppress progress reporting output.
1676 The same option will be passed to
1683 to print debugging messages to standard error output.
1684 The same option will be passed to
1687 Multiple -v options increase the verbosity.
1691 .It Cm cherrypick Ar commit
1693 Merge changes from a single
1698 should be on a different branch than the work tree's base commit.
1699 The expected argument is a reference or a commit ID SHA1 hash.
1700 An abbreviated hash argument will be expanded to a full SHA1 hash
1701 automatically, provided the abbreviation is unique.
1703 Show the status of each affected file, using the following status codes:
1704 .Bl -column YXZ description
1705 .It G Ta file was merged
1706 .It C Ta file was merged and conflicts occurred during merge
1707 .It ! Ta changes destined for a missing file were not merged
1708 .It D Ta file was deleted
1709 .It d Ta file's deletion was prevented by local modifications
1710 .It A Ta new file was added
1711 .It \(a~ Ta changes destined for a non-regular file were not merged
1712 .It ? Ta changes destined for an unversioned file were not merged
1715 The merged changes will appear as local changes in the work tree, which
1718 amended manually or with further
1723 or discarded again with
1727 will refuse to run if certain preconditions are not met.
1728 If the work tree contains multiple base commits it must first be updated
1729 to a single base commit with
1731 If any relevant files already contain merge conflicts, these
1732 conflicts must be resolved first.
1734 .It Cm backout Ar commit
1736 Reverse-merge changes from a single
1741 should be on the same branch as the work tree's base commit.
1742 The expected argument is a reference or a commit ID SHA1 hash.
1743 An abbreviated hash argument will be expanded to a full SHA1 hash
1744 automatically, provided the abbreviation is unique.
1746 Show the status of each affected file, using the following status codes:
1747 .Bl -column YXZ description
1748 .It G Ta file was merged
1749 .It C Ta file was merged and conflicts occurred during merge
1750 .It ! Ta changes destined for a missing file were not merged
1751 .It D Ta file was deleted
1752 .It d Ta file's deletion was prevented by local modifications
1753 .It A Ta new file was added
1754 .It \(a~ Ta changes destined for a non-regular file were not merged
1755 .It ? Ta changes destined for an unversioned file were not merged
1758 The reverse-merged changes will appear as local changes in the work tree,
1759 which may be viewed with
1761 amended manually or with further
1766 or discarded again with
1770 will refuse to run if certain preconditions are not met.
1771 If the work tree contains multiple base commits it must first be updated
1772 to a single base commit with
1774 If any relevant files already contain merge conflicts, these
1775 conflicts must be resolved first.
1777 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Oo Fl l Oc Oo Fl X Oc Op Ar branch
1779 Rebase commits on the specified
1781 onto the tip of the current branch of the work tree.
1784 must share common ancestry with the work tree's current branch.
1785 Rebasing begins with the first descendant commit of the youngest
1786 common ancestor commit shared by the specified
1788 and the work tree's current branch, and stops once the tip commit
1795 is used as intended, the specified
1797 represents a local commit history and may already contain changes
1798 that are not yet visible in any other repositories.
1799 The work tree's current branch, which must be set with
1803 operation, represents a branch from a remote repository which shares
1804 a common history with the specified
1806 but has progressed, and perhaps diverged, due to commits added to the
1809 Rebased commits are accumulated on a temporary branch which the work tree
1810 will remain switched to throughout the entire rebase operation.
1811 Commits on this branch represent the same changes with the same log
1812 messages as their counterparts on the original
1814 but with different commit IDs.
1815 Once rebasing has completed successfully, the temporary branch becomes
1816 the new version of the specified
1818 and the work tree is automatically switched to it.
1820 Old commits in their pre-rebase state are automatically backed up in the
1821 .Dq refs/got/backup/rebase
1822 reference namespace.
1823 As long as these references are not removed older versions of rebased
1824 commits will remain in the repository and can be viewed with the
1827 Removal of these references makes objects which become unreachable via
1828 any reference subject to removal by Git's garbage collector or
1829 .Cm gotadmin cleanup .
1831 While rebasing commits, show the status of each affected file,
1832 using the following status codes:
1833 .Bl -column YXZ description
1834 .It G Ta file was merged
1835 .It C Ta file was merged and conflicts occurred during merge
1836 .It ! Ta changes destined for a missing file were not merged
1837 .It D Ta file was deleted
1838 .It d Ta file's deletion was prevented by local modifications
1839 .It A Ta new file was added
1840 .It \(a~ Ta changes destined for a non-regular file were not merged
1841 .It ? Ta changes destined for an unversioned file were not merged
1844 If merge conflicts occur the rebase operation is interrupted and may
1845 be continued once conflicts have been resolved.
1846 If any files with destined changes are found to be missing or unversioned,
1847 or if files could not be deleted due to differences in deleted content,
1848 the rebase operation will be interrupted to prevent potentially incomplete
1849 changes from being committed to the repository without user intervention.
1850 The work tree may be modified as desired and the rebase operation can be
1851 continued once the changes present in the work tree are considered complete.
1852 Alternatively, the rebase operation may be aborted which will leave
1854 unmodified and the work tree switched back to its original branch.
1856 If a merge conflict is resolved in a way which renders the merged
1857 change into a no-op change, the corresponding commit will be elided
1858 when the rebase operation continues.
1861 will refuse to run if certain preconditions are not met.
1862 If the work tree is not yet fully updated to the tip commit of its
1863 branch then the work tree must first be updated with
1865 If changes have been staged with
1867 these changes must first be committed with
1871 If the work tree contains local changes, these changes must first be
1878 contains changes to files outside of the work tree's path prefix,
1879 the work tree cannot be used to rebase this branch.
1885 commands will refuse to run while a rebase operation is in progress.
1886 Other commands which manipulate the work tree may be used for
1887 conflict resolution purposes.
1891 is already based on the work tree's current branch then no commits
1892 need to be rebased and
1894 will simply switch the work tree to the specified
1896 and update files in the work tree accordingly.
1903 Abort an interrupted rebase operation.
1904 If this option is used, no other command-line arguments are allowed.
1906 Continue an interrupted rebase operation.
1907 If this option is used, no other command-line arguments are allowed.
1909 Show a list of past rebase operations, represented by references in the
1910 .Dq refs/got/backup/rebase
1911 reference namespace.
1913 Display the author, date, and log message of each backed up commit,
1914 the object ID of the corresponding post-rebase commit, and
1915 the object ID of their common ancestor commit.
1916 Given these object IDs,
1923 options can be used to examine the history of either version of the branch,
1928 option can be used to create a new branch from a pre-rebase state if desired.
1932 is specified, only show commits which at some point in time represented this
1934 Otherwise, list all backed up commits for any branches.
1936 If this option is used,
1938 does not require a work tree.
1939 None of the other options can be used together with
1942 Delete backups created by past rebase operations, represented by references
1944 .Dq refs/got/backup/rebase
1945 reference namespace.
1949 is specified, only delete backups which at some point in time represented
1951 Otherwise, delete all references found within
1952 .Dq refs/got/backup/rebase .
1954 Any commit, tree, tag, and blob objects belonging to deleted backups
1955 remain in the repository and may be removed separately with
1956 Git's garbage collector or
1957 .Cm gotadmin cleanup .
1959 If this option is used,
1961 does not require a work tree.
1962 None of the other options can be used together with
1966 .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
1968 Edit commit history between the work tree's current base commit and
1969 the tip commit of the work tree's current branch.
1973 operation the work tree's current branch must be set with
1975 to the branch which should be edited, unless this branch is already the
1976 current branch of the work tree.
1977 The tip of this branch represents the upper bound (inclusive) of commits
1982 Furthermore, the work tree's base commit
1985 to a point in this branch's commit history where editing should begin.
1986 This commit represents the lower bound (non-inclusive) of commits touched
1991 Editing of commit history is controlled via a
1993 which can be written in an editor based on a template, passed on the
1994 command line, or generated with the
2000 The format of the histedit script is line-based.
2001 Each line in the script begins with a command name, followed by
2002 whitespace and an argument.
2003 For most commands, the expected argument is a commit ID SHA1 hash.
2004 Any remaining text on the line is ignored.
2005 Lines which begin with the
2007 character are ignored entirely.
2009 The available commands are as follows:
2010 .Bl -column YXZ pick-commit
2011 .It pick Ar commit Ta Use the specified commit as it is.
2012 .It edit Ar commit Ta Use the specified commit but once changes have been
2013 merged into the work tree interrupt the histedit operation for amending.
2014 .It fold Ar commit Ta Combine the specified commit with the next commit
2015 listed further below that will be used.
2016 .It drop Ar commit Ta Remove this commit from the edited history.
2017 .It mesg Ar log-message Ta Use the specified single-line log message for
2018 the commit on the previous line.
2019 If the log message argument is left empty, open an editor where a new
2020 log message can be written.
2023 Every commit in the history being edited must be mentioned in the script.
2024 Lines may be re-ordered to change the order of commits in the edited history.
2025 No commit may be listed more than once.
2027 Edited commits are accumulated on a temporary branch which the work tree
2028 will remain switched to throughout the entire histedit operation.
2029 Once history editing has completed successfully, the temporary branch becomes
2030 the new version of the work tree's branch and the work tree is automatically
2033 Old commits in their pre-histedit state are automatically backed up in the
2034 .Dq refs/got/backup/histedit
2035 reference namespace.
2036 As long as these references are not removed older versions of edited
2037 commits will remain in the repository and can be viewed with the
2040 Removal of these references makes objects which become unreachable via
2041 any reference subject to removal by Git's garbage collector or
2042 .Cm gotadmin cleanup .
2044 While merging commits, show the status of each affected file,
2045 using the following status codes:
2046 .Bl -column YXZ description
2047 .It G Ta file was merged
2048 .It C Ta file was merged and conflicts occurred during merge
2049 .It ! Ta changes destined for a missing file were not merged
2050 .It D Ta file was deleted
2051 .It d Ta file's deletion was prevented by local modifications
2052 .It A Ta new file was added
2053 .It \(a~ Ta changes destined for a non-regular file were not merged
2054 .It ? Ta changes destined for an unversioned file were not merged
2057 If merge conflicts occur the histedit operation is interrupted and may
2058 be continued once conflicts have been resolved.
2059 If any files with destined changes are found to be missing or unversioned,
2060 or if files could not be deleted due to differences in deleted content,
2061 the histedit operation will be interrupted to prevent potentially incomplete
2062 changes from being committed to the repository without user intervention.
2063 The work tree may be modified as desired and the histedit operation can be
2064 continued once the changes present in the work tree are considered complete.
2065 Alternatively, the histedit operation may be aborted which will leave
2066 the work tree switched back to its original branch.
2068 If a merge conflict is resolved in a way which renders the merged
2069 change into a no-op change, the corresponding commit will be elided
2070 when the histedit operation continues.
2073 will refuse to run if certain preconditions are not met.
2074 If the work tree's current branch is not in the
2076 reference namespace, the history of the branch may not be edited.
2077 If the work tree contains multiple base commits it must first be updated
2078 to a single base commit with
2080 If changes have been staged with
2082 these changes must first be committed with
2086 If the work tree contains local changes, these changes must first be
2091 If the edited history contains changes to files outside of the work tree's
2092 path prefix, the work tree cannot be used to edit the history of this branch.
2099 commands will refuse to run while a histedit operation is in progress.
2100 Other commands which manipulate the work tree may be used, and the
2102 command may be used to commit arbitrary changes to the temporary branch
2103 while the histedit operation is interrupted.
2110 Abort an interrupted histedit operation.
2111 If this option is used, no other command-line arguments are allowed.
2113 Continue an interrupted histedit operation.
2114 If this option is used, no other command-line arguments are allowed.
2116 Interrupt the histedit operation for editing after merging each commit.
2117 This option is a quick equivalent to a histedit script which uses the
2119 command for all commits.
2122 option can only be used when starting a new histedit operation.
2123 If this option is used, no other command-line arguments are allowed.
2125 Fold all commits into a single commit.
2126 This option is a quick equivalent to a histedit script which folds all
2127 commits, combining them all into one commit.
2130 option can only be used when starting a new histedit operation.
2131 If this option is used, no other command-line arguments are allowed.
2132 .It Fl F Ar histedit-script
2135 instead of opening a temporary file in an editor where a histedit script
2138 Edit log messages only.
2139 This option is a quick equivalent to a histedit script which edits
2140 only log messages but otherwise leaves every picked commit as-is.
2143 option can only be used when starting a new histedit operation.
2144 If this option is used, no other command-line arguments are allowed.
2146 Show a list of past histedit operations, represented by references in the
2147 .Dq refs/got/backup/histedit
2148 reference namespace.
2150 Display the author, date, and log message of each backed up commit,
2151 the object ID of the corresponding post-histedit commit, and
2152 the object ID of their common ancestor commit.
2153 Given these object IDs,
2160 options can be used to examine the history of either version of the branch,
2165 option can be used to create a new branch from a pre-histedit state if desired.
2169 is specified, only show commits which at some point in time represented this
2171 Otherwise, list all backed up commits for any branches.
2173 If this option is used,
2175 does not require a work tree.
2176 None of the other options can be used together with
2179 Delete backups created by past histedit operations, represented by references
2181 .Dq refs/got/backup/histedit
2182 reference namespace.
2186 is specified, only delete backups which at some point in time represented
2188 Otherwise, delete all references found within
2189 .Dq refs/got/backup/histedit .
2191 Any commit, tree, tag, and blob objects belonging to deleted backups
2192 remain in the repository and may be removed separately with
2193 Git's garbage collector or
2194 .Cm gotadmin cleanup .
2196 If this option is used,
2198 does not require a work tree.
2199 None of the other options can be used together with
2203 .It Cm integrate Ar branch
2205 Integrate the specified
2207 into the work tree's current branch.
2208 Files in the work tree are updated to match the contents on the integrated
2210 and the reference of the work tree's branch is changed to point at the
2211 head commit of the integrated
2214 Both branches can be considered equivalent after integration since they
2215 will be pointing at the same commit.
2216 Both branches remain available for future work, if desired.
2217 In case the integrated
2219 is no longer needed it may be deleted with
2222 Show the status of each affected file, using the following status codes:
2223 .Bl -column YXZ description
2224 .It U Ta file was updated
2225 .It D Ta file was deleted
2226 .It A Ta new file was added
2227 .It \(a~ Ta versioned file is obstructed by a non-regular file
2228 .It ! Ta a missing versioned file was restored
2232 will refuse to run if certain preconditions are not met.
2233 Most importantly, the
2235 must have been rebased onto the work tree's current branch with
2237 before it can be integrated, in order to linearize commit history and
2238 resolve merge conflicts.
2239 If the work tree contains multiple base commits it must first be updated
2240 to a single base commit with
2242 If changes have been staged with
2244 these changes must first be committed with
2248 If the work tree contains local changes, these changes must first be
2254 .It Cm merge Oo Fl a Oc Oo Fl c Oc Oo Fl n Oc Op Ar branch
2256 Create a merge commit based on the current branch of the work tree and
2259 If a linear project history is desired, then use of
2261 should be preferred over
2263 However, even strictly linear projects may require merge commits in order
2264 to merge in new versions of third-party code stored on vendor branches
2268 Merge commits are commits based on multiple parent commits.
2269 The tip commit of the work tree's current branch, which must be set with
2273 operation, will be used as the first parent.
2274 The tip commit of the specified
2276 will be used as the second parent.
2278 No ancestral relationship between the two branches is required.
2279 If the two branches have already been merged previously, only new changes
2282 It is not possible to create merge commits with more than two parents.
2283 If more than one branch needs to be merged, then multiple merge commits
2284 with two parents each can be created in sequence.
2286 While merging changes found on the
2288 into the work tree, show the status of each affected file,
2289 using the following status codes:
2290 .Bl -column YXZ description
2291 .It G Ta file was merged
2292 .It C Ta file was merged and conflicts occurred during merge
2293 .It ! Ta changes destined for a missing file were not merged
2294 .It D Ta file was deleted
2295 .It d Ta file's deletion was prevented by local modifications
2296 .It A Ta new file was added
2297 .It \(a~ Ta changes destined for a non-regular file were not merged
2298 .It ? Ta changes destined for an unversioned file were not merged
2301 If merge conflicts occur, the merge operation is interrupted and conflicts
2302 must be resolved before the merge operation can continue.
2303 If any files with destined changes are found to be missing or unversioned,
2304 or if files could not be deleted due to differences in deleted content,
2305 the merge operation will be interrupted to prevent potentially incomplete
2306 changes from being committed to the repository without user intervention.
2307 The work tree may be modified as desired and the merge can be continued
2308 once the changes present in the work tree are considered complete.
2309 Alternatively, the merge operation may be aborted which will leave
2310 the work tree's current branch unmodified.
2312 If a merge conflict is resolved in a way which renders all merged
2313 changes into no-op changes, the merge operation cannot continue
2314 and must be aborted.
2317 will refuse to run if certain preconditions are not met.
2320 is based on the work tree's current branch, then no merge commit can
2323 may be used to integrate the
2326 If the work tree is not yet fully updated to the tip commit of its
2327 branch, then the work tree must first be updated with
2329 If the work tree contains multiple base commits it must first be updated
2330 to a single base commit with
2332 If changes have been staged with
2334 these changes must first be committed with
2338 If the work tree contains local changes, these changes must first be
2345 contains changes to files outside of the work tree's path prefix,
2346 the work tree cannot be used to merge this branch.
2356 commands will refuse to run while a merge operation is in progress.
2357 Other commands which manipulate the work tree may be used for
2358 conflict resolution purposes.
2365 Abort an interrupted merge operation.
2366 If this option is used, no other command-line arguments are allowed.
2368 Continue an interrupted merge operation.
2369 If this option is used, no other command-line arguments are allowed.
2371 Merge changes into the work tree as usual but do not create a merge
2373 The merge result can be adjusted as desired before a merge commit is
2376 Alternatively, the merge may be aborted with
2380 .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 ...
2382 Stage local changes for inclusion in the next commit.
2385 is specified, stage all changes in the work tree.
2386 Otherwise, stage changes at or within the specified paths.
2387 Paths may be staged if they are added, modified, or deleted according to
2390 Show the status of each affected file, using the following status codes:
2391 .Bl -column YXZ description
2392 .It A Ta file addition has been staged
2393 .It M Ta file modification has been staged
2394 .It D Ta file deletion has been staged
2397 Staged file contents are saved in newly created blob objects in the repository.
2398 These blobs will be referred to by tree objects once staged changes have been
2401 Staged changes affect the behaviour of
2406 While paths with staged changes exist, the
2408 command will refuse to commit any paths which do not have staged changes.
2409 Local changes created on top of staged changes can only be committed if
2410 the path is staged again, or if the staged changes are committed first.
2413 command will show both local changes and staged changes.
2416 command is able to display local changes relative to staged changes,
2417 and to display staged changes relative to the repository.
2420 command cannot revert staged changes but may be used to revert
2421 local changes created on top of staged changes.
2428 Instead of staging new changes, list paths which are already staged,
2429 along with the IDs of staged blob objects and stage status codes.
2430 If paths were provided in the command line show the staged paths
2431 among the specified paths.
2432 Otherwise, show all staged paths.
2434 Instead of staging the entire content of a changed file, interactively
2435 select or reject changes for staging based on
2439 (reject change), and
2441 (quit staging this file) responses.
2442 If a file is in modified status, individual patches derived from the
2443 modified file content can be staged.
2444 Files in added or deleted status may only be staged or rejected in
2446 .It Fl F Ar response-script
2454 responses line-by-line from the specified
2456 file instead of prompting interactively.
2458 Allow staging of symbolic links which point outside of the path space
2459 that is under version control.
2462 will reject such symbolic links due to safety concerns.
2465 may decide to represent such a symbolic link as a regular file which contains
2466 the link's target path, rather than creating an actual symbolic link which
2467 points outside of the work tree.
2468 Use of this option is discouraged because external mechanisms such as
2470 are better suited for managing symbolic links to paths not under
2475 will refuse to run if certain preconditions are not met.
2476 If a file contains merge conflicts, these conflicts must be resolved first.
2477 If a file is found to be out of date relative to the head commit on the
2478 work tree's current branch, the file must be updated with
2480 before it can be staged (however, this does not prevent the file from
2481 becoming out-of-date at some point after having been staged).
2488 commands will refuse to run while staged changes exist.
2489 If staged changes cannot be committed because a staged path
2490 is out of date, the path must be unstaged with
2492 before it can be updated with
2494 and may then be staged again if necessary.
2496 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
2498 Merge staged changes back into the work tree and put affected paths
2499 back into non-staged status.
2502 is specified, unstage all staged changes across the entire work tree.
2503 Otherwise, unstage changes at or within the specified paths.
2505 Show the status of each affected file, using the following status codes:
2506 .Bl -column YXZ description
2507 .It G Ta file was unstaged
2508 .It C Ta file was unstaged and conflicts occurred during merge
2509 .It ! Ta changes destined for a missing file were not merged
2510 .It D Ta file was staged as deleted and still is deleted
2511 .It d Ta file's deletion was prevented by local modifications
2512 .It \(a~ Ta changes destined for a non-regular file were not merged
2520 Instead of unstaging the entire content of a changed file, interactively
2521 select or reject changes for unstaging based on
2525 (keep change staged), and
2527 (quit unstaging this file) responses.
2528 If a file is staged in modified status, individual patches derived from the
2529 staged file content can be unstaged.
2530 Files staged in added or deleted status may only be unstaged in their entirety.
2531 .It Fl F Ar response-script
2539 responses line-by-line from the specified
2541 file instead of prompting interactively.
2543 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
2544 Parse and print contents of objects to standard output in a line-based
2546 Content of commit, tree, and tag objects is printed in a way similar
2547 to the actual content stored in such objects.
2548 Blob object contents are printed as they would appear in files on disk.
2550 Attempt to interpret each argument as a reference, a tag name, or
2551 an object ID SHA1 hash.
2552 References will be resolved to an object ID.
2553 Tag names will resolved to a tag object.
2554 An abbreviated hash argument will be expanded to a full SHA1 hash
2555 automatically, provided the abbreviation is unique.
2557 If none of the above interpretations produce a valid result, or if the
2559 option is used, attempt to interpret the argument as a path which will
2560 be resolved to the ID of an object found at this path in the repository.
2567 Look up paths in the specified
2569 If this option is not used, paths are looked up in the commit resolved
2570 via the repository's HEAD reference.
2571 The expected argument is a commit ID SHA1 hash or an existing reference
2572 or tag name which will be resolved to a commit ID.
2573 An abbreviated hash argument will be expanded to a full SHA1 hash
2574 automatically, provided the abbreviation is unique.
2575 .It Fl r Ar repository-path
2576 Use the repository at the specified path.
2577 If not specified, assume the repository is located at or above the current
2579 If this directory is a
2581 work tree, use the repository path associated with this work tree.
2583 Interpret all arguments as paths only.
2584 This option can be used to resolve ambiguity in cases where paths
2585 look like tag names, reference names, or object IDs.
2587 .It Cm info Op Ar path ...
2588 Display meta-data stored in a work tree.
2593 The work tree to use is resolved implicitly by walking upwards from the
2594 current working directory.
2598 arguments are specified, show additional per-file information for tracked
2599 files located at or within these paths.
2602 argument corresponds to the work tree's root directory, display information
2603 for all tracked files.
2606 .Bl -tag -width GOT_AUTHOR
2608 The author's name and email address for
2613 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
2616 may fail to parse commits without an email address in author data,
2620 environment variables with a missing email address.
2622 .Ev GOT_AUTHOR will be overridden by configuration settings in
2628 configuration settings in the repository's
2635 configuration settings contained in Git's global
2637 configuration file will only be used if neither
2641 environment variable provide author information.
2642 .It Ev VISUAL , EDITOR
2643 The editor spawned by
2651 text editor will be spawned in order to give
2653 the attention it deserves.
2654 .It Ev GOT_LOG_DEFAULT_LIMIT
2655 The default limit on the number of commits traversed by
2657 If set to zero, the limit is unbounded.
2658 This variable will be silently ignored if it is set to a non-numeric value.
2661 .Bl -tag -width packed-refs -compact
2663 Repository-wide configuration settings for
2667 configuration file located in the root directory of a Git repository
2668 supersedes any relevant settings in Git's
2672 .It Pa .got/got.conf
2673 Worktree-specific configuration settings for
2677 configuration file in the
2679 meta-data directory of a work tree supersedes any relevant settings in
2682 configuration file and Git's
2689 Enable tab-completion of
2694 .Dl $ set -A complete_got_1 -- $(got -h 2>&1 | sed -n s/commands://p)
2696 Clone an existing Git repository for use with
2700 .Dl $ got clone ssh://git@github.com/openbsd/src.git
2702 Use of HTTP URLs currently requires
2706 .Dl $ git clone --bare https://github.com/openbsd/src.git
2708 Alternatively, for quick and dirty local testing of
2710 a new Git repository could be created and populated with files,
2711 e.g. from a temporary CVS checkout located at
2714 .Dl $ got init /var/git/src.git
2715 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
2717 Check out a work tree from the Git repository to /usr/src:
2719 .Dl $ got checkout /var/git/src.git /usr/src
2721 View local changes in a work tree directory:
2723 .Dl $ got diff | less
2725 In a work tree, display files in a potentially problematic state:
2727 .Dl $ got status -s 'C!~?'
2729 Interactively revert selected local changes in a work tree directory:
2731 .Dl $ got revert -p -R\ .
2733 In a work tree or a git repository directory, list all branch references:
2737 In a work tree or a git repository directory, create a new branch called
2738 .Dq unified-buffer-cache
2739 which is forked off the
2743 .Dl $ got branch -c master unified-buffer-cache
2745 Switch an existing work tree to the branch
2746 .Dq unified-buffer-cache .
2747 Local changes in the work tree will be preserved and merged if necessary:
2749 .Dl $ got update -b unified-buffer-cache
2751 Create a new commit from local changes in a work tree directory.
2752 This new commit will become the head commit of the work tree's current branch:
2756 In a work tree or a git repository directory, view changes committed in
2757 the 3 most recent commits to the work tree's branch, or the branch resolved
2758 via the repository's HEAD reference, respectively:
2760 .Dl $ got log -p -l 3
2762 As above, but display changes in the order in which
2764 could apply them in sequence:
2766 .Dl $ got log -p -l 3 -R
2768 In a work tree or a git repository directory, log the history of a subdirectory:
2770 .Dl $ got log sys/uvm
2772 While operating inside a work tree, paths are specified relative to the current
2773 working directory, so this command will log the subdirectory
2776 .Dl $ cd sys/uvm && got log\ .
2778 And this command has the same effect:
2780 .Dl $ cd sys/dev/usb && got log ../../uvm
2782 And this command displays work tree meta-data about all tracked files:
2785 .Dl $ got info\ . | less
2787 Add new files and remove obsolete files in a work tree directory:
2789 .Dl $ got add sys/uvm/uvm_ubc.c
2790 .Dl $ got remove sys/uvm/uvm_vnode.c
2792 Create a new commit from local changes in a work tree directory
2793 with a pre-defined log message.
2795 .Dl $ got commit -m 'unify the buffer cache'
2797 Alternatively, create a new commit from local changes in a work tree
2798 directory with a log message that has been prepared in the file
2801 .Dl $ got commit -F /tmp/msg
2803 Update any work tree checked out from the
2804 .Dq unified-buffer-cache
2805 branch to the latest commit on this branch:
2809 Roll file content on the unified-buffer-cache branch back by one commit,
2810 and then fetch the rolled-back change into the work tree as a local change
2811 to be amended and perhaps committed again:
2813 .Dl $ got backout unified-buffer-cache
2814 .Dl $ got commit -m 'roll back previous'
2815 .Dl $ # now back out the previous backout :-)
2816 .Dl $ got backout unified-buffer-cache
2818 Fetch new changes on the remote repository's
2820 branch, making them visible on the local repository's
2827 In a repository created with a HTTP URL and
2828 .Cm git clone --bare
2831 command must be used instead:
2833 .Dl $ cd /var/git/src.git
2834 .Dl $ git fetch origin master:refs/remotes/origin/master
2838 branch to merge the new changes that are now visible on the
2843 .Dl $ got update -b origin/master
2844 .Dl $ got rebase master
2847 .Dq unified-buffer-cache
2848 branch on top of the new head commit of the
2852 .Dl $ got update -b master
2853 .Dl $ got rebase unified-buffer-cache
2855 Create a patch from all changes on the unified-buffer-cache branch.
2856 The patch can be mailed out for review and applied to
2860 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2862 Edit the entire commit history of the
2863 .Dq unified-buffer-cache
2866 .Dl $ got update -b unified-buffer-cache
2867 .Dl $ got update -c master
2870 Before working against existing branches in a repository cloned with
2871 .Cm git clone --bare
2876 must be configured to map all references in the remote repository
2879 namespace of the local repository.
2880 This can be achieved by setting Git's
2881 .Pa remote.origin.fetch
2882 configuration variable to the value
2883 .Dq +refs/heads/*:refs/remotes/origin/*
2888 .Dl $ cd /var/git/repo
2889 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2893 option must be disabled:
2895 .Dl $ cd /var/git/repo
2896 .Dl $ git config remote.origin.mirror false
2898 Alternatively, the following
2900 configuration item can be added manually to the Git repository's
2904 .Dl [remote \&"origin\&"]
2906 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2909 This configuration leaves the local repository's
2911 namespace free for use by local branches checked out with
2913 and, if needed, created with
2916 .Dq refs/remotes/origin
2917 namespace can now be updated with incoming changes from the remote
2922 without extra command line arguments.
2923 Newly fetched changes can be examined with
2926 Display changes on the remote repository's version of the
2928 branch, as of the last time
2932 .Dl $ got log -c origin/master | less
2934 As shown here, most commands accept abbreviated reference names such as
2937 .Dq refs/remotes/origin/master .
2938 The latter is only needed in case of ambiguity.
2941 must be used to merge changes which are visible on the
2946 This will also merge local changes, if any, with the incoming changes:
2948 .Dl $ got update -b origin/master
2949 .Dl $ got rebase master
2951 In order to make changes committed to the
2952 .Dq unified-buffer-cache
2956 .Dq unified-buffer-cache
2957 branch must first be rebased onto the
2961 .Dl $ got update -b master
2962 .Dl $ got rebase unified-buffer-cache
2965 .Dq unified-buffer-cache
2966 branch can now be made visible on the
2970 Because the rebase operation switched the work tree to the
2971 .Dq unified-buffer-cache
2972 branch the work tree must be switched back to the
2976 .Dl $ got update -b master
2977 .Dl $ got integrate unified-buffer-cache
2981 branch, log messages for local changes can now be amended with
2983 by other developers and any other important new information:
2985 .Dl $ got update -c origin/master
2986 .Dl $ got histedit -m
2988 If the remote repository offers write access local changes on the
2990 branch can be sent to the remote repository with
2994 can be run without further arguments.
2995 The arguments shown here match defaults, provided the work tree's
2996 current branch is the
3000 .Dl $ got send -b master origin
3002 If the remote repository requires the HTTPS protocol the
3004 command must be used instead:
3006 .Dl $ cd /var/git/src.git
3007 .Dl $ git push origin master
3011 .Xr git-repository 5 ,
3012 .Xr got-worktree 5 ,
3015 .An Stefan Sperling Aq Mt stsp@openbsd.org
3016 .An Martin Pieuchot Aq Mt mpi@openbsd.org
3017 .An Joshua Stein Aq Mt jcs@openbsd.org
3018 .An Ori Bernstein Aq Mt ori@openbsd.org
3021 is a work-in-progress and some features remain to be implemented.
3023 At present, the user has to fall back on
3025 to perform some tasks.
3029 Reading from remote repositories over HTTP or HTTPS protocols requires
3034 Writing to remote repositories over HTTP or HTTPS protocols requires
3037 The creation of merge commits with more than two parent commits requires
3040 In situations where files or directories were moved around
3042 will not automatically merge changes to new locations and
3044 will usually produce better results.
