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
79 .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
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .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
193 file of the cloned repository to store the
205 Fetch all branches from the remote repository's
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
235 Create the cloned repository as a mirror of the original repository.
236 This is useful if the cloned repository will not be used to store
237 locally created commits.
241 file will be set up with the
243 option enabled, such that
247 will write incoming changes directly to branches in the
249 reference namespace, rather than to branches in the
252 This avoids the usual requirement of having to run
256 in order to make incoming changes appear on branches in the
259 But maintaining custom changes in the cloned repository becomes difficult
260 since such changes will be at risk of being discarded whenever incoming
263 Suppress progress reporting output.
264 The same option will be passed to
271 to print debugging messages to standard error output.
272 This option will be passed to
275 Multiple -v options increase the verbosity.
277 .It Fl R Ar reference
278 In addition to the branches and tags that will be fetched, fetch an arbitrary
280 from the remote repository's
283 This option may be specified multiple times to build a list of additional
287 may either be a path to a specific reference, or a reference namespace
288 which will cause all references in this namespace to be fetched.
290 Each reference will be mapped into the cloned repository's
292 namespace, unless the
294 option is used to mirror references directly into the cloned repository's
299 will refuse to fetch references from the remote repository's
308 .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 Op Ar remote-repository
309 Fetch new changes from a remote repository.
311 .Ar remote-repository
315 The remote repository's URL is obtained from the corresponding entry in the
317 file of the local repository, as created by
320 New changes will be stored in a separate pack file downloaded from the server.
321 Optionally, separate pack files stored in the repository can be combined with
324 By default, branch references in the
326 reference namespace will be updated to point at the newly fetched commits.
329 command can then be used to make new changes visible on branches in the
331 namespace, merging incoming changes with the changes on those branches
334 If the repository was created as a mirror with
336 then all branches in the
338 namespace will be updated directly to match the corresponding branches in
339 the remote repository.
340 If those branches contained local commits, these commits will no longer be
341 reachable via a reference and will therefore be at risk of being discarded
342 by Git's garbage collector.
343 Maintaining custom changes in a mirror repository is therefore discouraged.
345 In any case, references in the
347 namespace will always be fetched and mapped directly to local references
348 in the same namespace.
355 Fetch all branches from the remote repository's
358 If this option is not specified, a branch resolved via the remote
359 repository's HEAD reference will be fetched.
360 Cannot be used together with the
366 from the remote repository's
369 This option may be specified multiple times to build a list of branches
371 If this option is not specified, a branch resolved via the remote
372 repository's HEAD reference will be fetched.
373 Cannot be used together with the
377 Delete branches and tags from the local repository which are no longer
378 present in the remote repository.
379 Only references are deleted.
380 Any commit, tree, tag, and blob objects belonging to deleted branches or
381 tags remain in the repository and may be removed separately with
382 Git's garbage collector.
384 List branches and tags available for fetching from the remote repository
385 and exit immediately.
386 Cannot be used together with any of the other options except
391 Allow existing references in the
393 namespace to be updated if they have changed on the server.
394 If not specified, only new tag references will be created.
395 .It Fl r Ar repository-path
396 Use the repository at the specified path.
397 If not specified, assume the repository is located at or above the current
399 If this directory is a
401 work tree, use the repository path associated with this work tree.
403 Suppress progress reporting output.
404 The same option will be passed to
411 to print debugging messages to standard error output.
412 The same option will be passed to
415 Multiple -v options increase the verbosity.
417 .It Fl R Ar reference
418 In addition to the branches and tags that will be fetched, fetch an arbitrary
420 from the remote repository's
423 This option may be specified multiple times to build a list of additional
427 may either be a path to a specific reference, or a reference namespace
428 which will cause all references in this namespace to be fetched.
430 Each reference will be mapped into the local repository's
432 namespace, unless the local repository was created as a mirror with
434 in which case references will be mapped directly into the local repository's
438 Once a reference has been fetched, a branch based on it can be created with
443 will refuse to fetch references from the remote repository's
452 .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 Ar repository-path Op Ar work-tree-path
453 Copy files from a repository into a new work tree.
454 Show the status of each affected file, using the following status codes:
455 .Bl -column YXZ description
456 .It A Ta new file was added
457 .It E Ta file already exists in work tree's meta-data
462 is not specified, either use the last component of
463 .Ar repository path ,
466 was specified use the last component of
474 Proceed with the checkout operation even if the directory at
477 Existing files will be left intact.
479 Check out files from a commit on the specified
481 If this option is not specified, a branch resolved via the repository's HEAD
482 reference will be used.
484 Check out files from the specified
486 on the selected branch.
487 The expected argument is a commit ID SHA1 hash or an existing reference
488 or tag name which will be resolved to a commit ID.
489 An abbreviated hash argument will be expanded to a full SHA1 hash
490 automatically, provided the abbreviation is unique.
491 If this option is not specified, the most recent commit on the selected
496 is not contained in the selected branch, a different branch which contains
497 this commit must be specified with the
500 If no such branch is known a new branch must be created for this
506 Checking out work trees with an unknown branch is intentionally not supported.
507 .It Fl p Ar path-prefix
508 Restrict the work tree to a subset of the repository's tree hierarchy.
509 Only files beneath the specified
516 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
517 Update an existing work tree to a different
519 Change existing files in the work tree as necessary to match file contents
521 Preserve any local changes in the work tree and merge them with the
524 Files which already contain merge conflicts will not be updated to avoid
525 further complications.
526 Such files will be updated when
528 is run again after merge conflicts have been resolved.
529 If the conflicting changes are no longer needed affected files can be
536 Show the status of each affected file, using the following status codes:
537 .Bl -column YXZ description
538 .It U Ta file was updated and contained no local changes
539 .It G Ta file was updated and local changes were merged cleanly
540 .It C Ta file was updated and conflicts occurred during merge
541 .It D Ta file was deleted
542 .It A Ta new file was added
543 .It \(a~ Ta versioned file is obstructed by a non-regular file
544 .It ! Ta a missing versioned file was restored
545 .It # Ta file was not updated because it contains merge conflicts
550 is specified, update the entire work tree.
551 Otherwise, restrict the update operation to files at or within the
553 Each path is required to exist in the update operation's target commit.
554 Files in the work tree outside specified paths will remain unchanged and
555 will retain their previously recorded base commit.
558 commands may refuse to run while the work tree contains files from
559 multiple base commits.
560 The base commit of such a work tree can be made consistent by running
562 across the entire work tree.
565 is incompatible with the
570 cannot update paths with staged changes.
571 If changes have been staged with
573 these changes must first be committed with
583 Switch the work tree's branch reference to the specified
585 before updating the work tree.
586 This option requires that all paths in the work tree are updated.
588 As usual, any local changes in the work tree will be preserved.
589 This can be useful when switching to a newly created branch in order
590 to commit existing local changes to this branch.
592 Any local changes must be dealt with separately in order to obtain a
593 work tree with pristine file contents corresponding exactly to the specified
595 Such changes could first be committed to a different branch with
597 or could be discarded with
600 Update the work tree to the specified
602 The expected argument is a commit ID SHA1 hash or an existing reference
603 or tag name which will be resolved to a commit ID.
604 An abbreviated hash argument will be expanded to a full SHA1 hash
605 automatically, provided the abbreviation is unique.
606 If this option is not specified, the most recent commit on the work tree's
612 .It Cm status Op Ar path ...
613 Show the current modification status of files in a work tree,
614 using the following status codes:
615 .Bl -column YXZ description
616 .It M Ta modified file
617 .It A Ta file scheduled for addition in next commit
618 .It D Ta file scheduled for deletion in next commit
619 .It C Ta modified or added file which contains merge conflicts
620 .It ! Ta versioned file was expected on disk but is missing
621 .It \(a~ Ta versioned file is obstructed by a non-regular file
622 .It ? Ta unversioned item not tracked by
624 .It m Ta modified file modes (executable bit only)
625 .It N Ta non-existent
627 specified on the command line
632 is specified, show modifications in the entire work tree.
633 Otherwise, show modifications at or within the specified paths.
635 If changes have been staged with
637 staged changes are shown in the second output column, using the following
639 .Bl -column YXZ description
640 .It M Ta file modification is staged
641 .It A Ta file addition is staged
642 .It D Ta file deletion is staged
645 Changes created on top of staged changes are indicated in the first column:
646 .Bl -column YXZ description
647 .It MM Ta file was modified after earlier changes have been staged
648 .It MA Ta file was modified after having been staged for addition
651 For compatibility with
662 files in each traversed directory and will not display unversioned files
663 which match these patterns.
668 supports consecutive asterisks,
670 which will match an arbitrary amount of directories.
674 only supports a single ignore pattern per line.
678 does not support negated ignore patterns prefixed with
680 and gives no special significance to the location of path component separators,
686 .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 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
687 Display history of a repository.
690 is specified, show only commits which modified this path.
691 If invoked in a work tree, the
693 is interpreted relative to the current working directory,
694 and the work tree's path prefix is implicitly prepended.
695 Otherwise, the path is interpreted relative to the repository root.
702 Display individual commits which were merged into the current branch
706 shows the linear history of the current branch only.
708 Start traversing history at the specified
710 The expected argument is a commit ID SHA1 hash or an existing reference
711 or tag name which will be resolved to a commit ID.
712 An abbreviated hash argument will be expanded to a full SHA1 hash
713 automatically, provided the abbreviation is unique.
714 If this option is not specified, default to the work tree's current branch
715 if invoked in a work tree, or to the repository's HEAD reference.
717 Set the number of context lines shown in diffs with
719 By default, 3 lines of context are shown.
721 Limit history traversal to a given number of commits.
722 If this option is not specified, a default limit value of zero is used,
723 which is treated as an unbounded limit.
725 .Ev GOT_LOG_DEFAULT_LIMIT
726 environment variable may be set to change this default value.
728 Display the patch of modifications made in each commit.
731 is specified, only show the patch of modifications at or within this path.
732 .It Fl s Ar search-pattern
733 If specified, show only commits with a log message matched by the extended
736 Regular expression syntax is documented in
738 .It Fl r Ar repository-path
739 Use the repository at the specified path.
740 If not specified, assume the repository is located at or above the current
742 If this directory is a
744 work tree, use the repository path associated with this work tree.
746 Determine a set of commits to display as usual, but display these commits
749 Stop traversing commit history as soon as the specified
752 This option has no effect if the specified
756 .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Oo Fl w Oc Op Ar object1 Ar object2 | Ar path
757 When invoked within a work tree with less than two arguments, display
758 local changes in the work tree.
761 is specified, only show changes within this path.
763 If two arguments are provided, treat each argument as a reference, a tag
764 name, or an object ID SHA1 hash, and display differences between the
765 corresponding objects.
766 Both objects must be of the same type (blobs, trees, or commits).
767 An abbreviated hash argument will be expanded to a full SHA1 hash
768 automatically, provided the abbreviation is unique.
775 Set the number of context lines shown in the diff.
776 By default, 3 lines of context are shown.
777 .It Fl r Ar repository-path
778 Use the repository at the specified path.
779 If not specified, assume the repository is located at or above the current
781 If this directory is a
783 work tree, use the repository path associated with this work tree.
785 Show changes staged with
787 instead of showing local changes in the work tree.
788 This option is only valid when
790 is invoked in a work tree.
792 Ignore whitespace-only changes.
797 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
798 Display line-by-line history of a file at the specified path.
805 Start traversing history at the specified
807 The expected argument is a commit ID SHA1 hash or an existing reference
808 or tag name which will be resolved to a commit ID.
809 An abbreviated hash argument will be expanded to a full SHA1 hash
810 automatically, provided the abbreviation is unique.
811 .It Fl r Ar repository-path
812 Use the repository at the specified path.
813 If not specified, assume the repository is located at or above the current
815 If this directory is a
817 work tree, use the repository path associated with this work tree.
822 .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
823 Display a listing of files and directories at the specified
824 directory path in the repository.
825 Entries shown in this listing may carry one of the following trailing
827 .Bl -column YXZ description
828 .It @ Ta entry is a symbolic link
829 .It / Ta entry is a directory
830 .It * Ta entry is an executable file
831 .It $ Ta entry is a Git submodule
836 is specified, list the repository path corresponding to the current
837 directory of the work tree, or the root directory of the repository
838 if there is no work tree.
845 List files and directories as they appear in the specified
847 The expected argument is a commit ID SHA1 hash or an existing reference
848 or tag name which will be resolved to a commit ID.
849 An abbreviated hash argument will be expanded to a full SHA1 hash
850 automatically, provided the abbreviation is unique.
851 .It Fl r Ar repository-path
852 Use the repository at the specified path.
853 If not specified, assume the repository is located at or above the current
855 If this directory is a
857 work tree, use the repository path associated with this work tree.
859 Show object IDs of files (blob objects) and directories (tree objects).
861 Recurse into sub-directories in the repository.
866 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
867 Manage references in a repository.
869 References may be listed, created, deleted, and changed.
870 When creating, deleting, or changing a reference the specified
872 must be an absolute reference name, i.e. it must begin with
879 .It Fl r Ar repository-path
880 Use the repository at the specified path.
881 If not specified, assume the repository is located at or above the current
883 If this directory is a
885 work tree, use the repository path associated with this work tree.
887 List references in the repository.
890 is specified, list all existing references in the repository.
893 is a reference namespace, list all references in this namespace.
894 Otherwise, show only the reference with the given
896 Cannot be used together with any other options except
899 Create a reference or change an existing reference.
900 The reference with the specified
902 will point at the specified
906 argument is a ID SHA1 hash or an existing reference or tag name which will
907 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
908 Cannot be used together with any other options except
910 .It Fl s Ar reference
911 Create a symbolic reference, or change an existing symbolic reference.
912 The symbolic reference with the specified
914 will point at the specified
916 which must already exist in the repository.
917 Care should be taken not to create loops between references when
919 Cannot be used together with any other options except
922 Delete the reference with the specified
925 Cannot be used together with any other options except
928 .It Cm branch Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl n Oc Op Ar name
929 Create, list, or delete branches.
931 Branches are managed via references which live in the
936 command operates on references in this namespace only.
938 If invoked in a work tree without any arguments, print the name of the
939 work tree's current branch.
943 argument is passed, attempt to create a branch reference with the given name.
944 By default the new branch reference will point at the latest commit on the
945 work tree's current branch if invoked in a work tree, and otherwise to a commit
946 resolved via the repository's HEAD reference.
948 If invoked in a work tree, once the branch was created successfully
949 switch the work tree's head reference to the newly created branch and
950 update files across the entire work tree, just like
951 .Cm got update -b Ar name
953 Show the status of each affected file, using the following status codes:
954 .Bl -column YXZ description
955 .It U Ta file was updated and contained no local changes
956 .It G Ta file was updated and local changes were merged cleanly
957 .It C Ta file was updated and conflicts occurred during merge
958 .It D Ta file was deleted
959 .It A Ta new file was added
960 .It \(a~ Ta versioned file is obstructed by a non-regular file
961 .It ! Ta a missing versioned file was restored
969 Make a newly created branch reference point at the specified
973 argument is a commit ID SHA1 hash or an existing reference
974 or tag name which will be resolved to a commit ID.
975 .It Fl r Ar repository-path
976 Use the repository at the specified path.
977 If not specified, assume the repository is located at or above the current
979 If this directory is a
981 work tree, use the repository path associated with this work tree.
983 List all existing branches in the repository.
984 If invoked in a work tree, the work tree's current branch is shown
985 with one the following annotations:
986 .Bl -column YXZ description
987 .It * Ta work tree's base commit matches the branch tip
988 .It \(a~ Ta work tree's base commit is out-of-date
991 Delete the branch with the specified name from the repository.
992 Only the branch reference is deleted.
993 Any commit, tree, and blob objects belonging to the branch
994 remain in the repository and may be removed separately with
995 Git's garbage collector.
997 Do not switch and update the work tree after creating a new branch.
1002 .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
1003 Manage tags in a repository.
1005 Tags are managed via references which live in the
1007 reference namespace.
1010 command operates on references in this namespace only.
1011 References in this namespace point at tag objects which contain a pointer
1012 to another object, a tag message, as well as author and timestamp information.
1014 Attempt to create a tag with the given
1016 and make this tag point at the given
1018 If no commit is specified, default to the latest commit on the work tree's
1019 current branch if invoked in a work tree, and to a commit resolved via
1020 the repository's HEAD reference otherwise.
1027 Make the newly created tag reference point at the specified
1031 argument is a commit ID SHA1 hash or an existing reference or tag name which
1032 will be resolved to a commit ID.
1033 An abbreviated hash argument will be expanded to a full SHA1 hash
1034 automatically, provided the abbreviation is unique.
1036 Use the specified tag message when creating the new tag.
1041 opens a temporary file in an editor where a tag message can be written.
1042 .It Fl r Ar repository-path
1043 Use the repository at the specified path.
1044 If not specified, assume the repository is located at or above the current
1046 If this directory is a
1048 work tree, use the repository path associated with this work tree.
1050 List all existing tags in the repository instead of creating a new tag.
1051 If this option is used, no other command-line arguments are allowed.
1056 command will not delete tags or change existing tags.
1057 If a tag must be deleted, the
1059 command may be used to delete a tag's reference.
1060 This should only be done if the tag has not already been copied to
1062 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1063 Schedule unversioned files in a work tree for addition to the
1064 repository in the next commit.
1071 Permit recursion into directories.
1072 If this option is not specified,
1074 will refuse to run if a specified
1078 With -R, add files even if they match a
1082 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
1083 Remove versioned files from a work tree and schedule them for deletion
1084 from the repository in the next commit.
1091 Perform the operation even if a file contains local modifications.
1093 Keep affected files on disk.
1095 Permit recursion into directories.
1096 If this option is not specified,
1098 will refuse to run if a specified
1105 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1106 Revert any local changes in files at the specified paths in a work tree.
1107 File contents will be overwritten with those contained in the
1108 work tree's base commit.
1109 There is no way to bring discarded changes back after
1112 If a file was added with
1114 it will become an unversioned file again.
1115 If a file was deleted with
1117 it will be restored.
1124 Instead of reverting all changes in files, interactively select or reject
1125 changes to revert based on
1131 (quit reverting this file) responses.
1132 If a file is in modified status, individual patches derived from the
1133 modified file content can be reverted.
1134 Files in added or deleted status may only be reverted in their entirety.
1135 .It Fl F Ar response-script
1143 responses line-by-line from the specified
1145 file instead of prompting interactively.
1147 Permit recursion into directories.
1148 If this option is not specified,
1150 will refuse to run if a specified
1157 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1158 Create a new commit in the repository from changes in a work tree
1159 and use this commit as the new base commit for the work tree.
1162 is specified, commit all changes in the work tree.
1163 Otherwise, commit changes at or within the specified paths.
1165 If changes have been explicitly staged for commit with
1167 only commit staged changes and reject any specified paths which
1168 have not been staged.
1170 Show the status of each affected file, using the following status codes:
1171 .Bl -column YXZ description
1172 .It M Ta modified file
1173 .It D Ta file was deleted
1174 .It A Ta new file was added
1175 .It m Ta modified file modes (executable bit only)
1178 Files which are not part of the new commit will retain their previously
1179 recorded base commit.
1182 commands may refuse to run while the work tree contains files from
1183 multiple base commits.
1184 The base commit of such a work tree can be made consistent by running
1186 across the entire work tree.
1190 command requires the
1192 environment variable to be set,
1197 configuration settings can be
1198 obtained from the repository's
1200 file or from Git's global
1209 Use the specified log message when creating the new commit.
1214 opens a temporary file in an editor where a log message can be written.
1218 will refuse to run if certain preconditions are not met.
1219 If the work tree's current branch is not in the
1221 reference namespace, new commits may not be created on this branch.
1222 Local changes may only be committed if they are based on file content
1223 found in the most recent commit on the work tree's branch.
1224 If a path is found to be out of date,
1226 must be used first in order to merge local changes with changes made
1231 .It Cm cherrypick Ar commit
1232 Merge changes from a single
1237 must be on a different branch than the work tree's base commit.
1238 The expected argument is a reference or a commit ID SHA1 hash.
1239 An abbreviated hash argument will be expanded to a full SHA1 hash
1240 automatically, provided the abbreviation is unique.
1242 Show the status of each affected file, using the following status codes:
1243 .Bl -column YXZ description
1244 .It G Ta file was merged
1245 .It C Ta file was merged and conflicts occurred during merge
1246 .It ! Ta changes destined for a missing file were not merged
1247 .It D Ta file was deleted
1248 .It d Ta file's deletion was obstructed by local modifications
1249 .It A Ta new file was added
1250 .It \(a~ Ta changes destined for a non-regular file were not merged
1253 The merged changes will appear as local changes in the work tree, which
1256 amended manually or with further
1261 or discarded again with
1265 will refuse to run if certain preconditions are not met.
1266 If the work tree contains multiple base commits it must first be updated
1267 to a single base commit with
1269 If the work tree already contains files with merge conflicts, these
1270 conflicts must be resolved first.
1274 .It Cm backout Ar commit
1275 Reverse-merge changes from a single
1280 must be on the same branch as the work tree's base commit.
1281 The expected argument is a reference or a commit ID SHA1 hash.
1282 An abbreviated hash argument will be expanded to a full SHA1 hash
1283 automatically, provided the abbreviation is unique.
1285 Show the status of each affected file, using the following status codes:
1286 .Bl -column YXZ description
1287 .It G Ta file was merged
1288 .It C Ta file was merged and conflicts occurred during merge
1289 .It ! Ta changes destined for a missing file were not merged
1290 .It D Ta file was deleted
1291 .It d Ta file's deletion was obstructed by local modifications
1292 .It A Ta new file was added
1293 .It \(a~ Ta changes destined for a non-regular file were not merged
1296 The reverse-merged changes will appear as local changes in the work tree,
1297 which may be viewed with
1299 amended manually or with further
1304 or discarded again with
1308 will refuse to run if certain preconditions are not met.
1309 If the work tree contains multiple base commits it must first be updated
1310 to a single base commit with
1312 If the work tree already contains files with merge conflicts, these
1313 conflicts must be resolved first.
1317 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1318 Rebase commits on the specified
1320 onto the tip of the current branch of the work tree.
1323 must share common ancestry with the work tree's current branch.
1324 Rebasing begins with the first descendant commit of the youngest
1325 common ancestor commit shared by the specified
1327 and the work tree's current branch, and stops once the tip commit
1334 is used as intended, the specified
1336 represents a local commit history and may already contain changes
1337 that are not yet visible in any other repositories.
1338 The work tree's current branch, which must be set with
1342 operation, represents a branch from a remote repository which shares
1343 a common history with the specified
1345 but has progressed, and perhaps diverged, due to commits added to the
1348 Rebased commits are accumulated on a temporary branch which the work tree
1349 will remain switched to throughout the entire rebase operation.
1350 Commits on this branch represent the same changes with the same log
1351 messages as their counterparts on the original
1353 but with different commit IDs.
1354 Once rebasing has completed successfully, the temporary branch becomes
1355 the new version of the specified
1357 and the work tree is automatically switched to it.
1359 While rebasing commits, show the status of each affected file,
1360 using the following status codes:
1361 .Bl -column YXZ description
1362 .It G Ta file was merged
1363 .It C Ta file was merged and conflicts occurred during merge
1364 .It ! Ta changes destined for a missing file were not merged
1365 .It D Ta file was deleted
1366 .It d Ta file's deletion was obstructed by local modifications
1367 .It A Ta new file was added
1368 .It \(a~ Ta changes destined for a non-regular file were not merged
1371 If merge conflicts occur the rebase operation is interrupted and may
1372 be continued once conflicts have been resolved.
1373 Alternatively, the rebase operation may be aborted which will leave
1375 unmodified and the work tree switched back to its original branch.
1377 If a merge conflict is resolved in a way which renders the merged
1378 change into a no-op change, the corresponding commit will be elided
1379 when the rebase operation continues.
1382 will refuse to run if certain preconditions are not met.
1383 If the work tree is not yet fully updated to the tip commit of its
1384 branch then the work tree must first be updated with
1386 If changes have been staged with
1388 these changes must first be committed with
1392 If the work tree contains local changes, these changes must first be
1399 contains changes to files outside of the work tree's path prefix,
1400 the work tree cannot be used to rebase this branch.
1406 commands will refuse to run while a rebase operation is in progress.
1407 Other commands which manipulate the work tree may be used for
1408 conflict resolution purposes.
1415 Abort an interrupted rebase operation.
1416 If this option is used, no other command-line arguments are allowed.
1418 Continue an interrupted rebase operation.
1419 If this option is used, no other command-line arguments are allowed.
1424 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1425 Edit commit history between the work tree's current base commit and
1426 the tip commit of the work tree's current branch.
1430 operation the work tree's current branch must be set with
1432 to the branch which should be edited, unless this branch is already the
1433 current branch of the work tree.
1434 The tip of this branch represents the upper bound (inclusive) of commits
1439 Furthermore, the work tree's base commit
1442 to a point in this branch's commit history where editing should begin.
1443 This commit represents the lower bound (non-inclusive) of commits touched
1448 Editing of commit history is controlled via a
1450 which can be written in an editor based on a template, passed on the
1451 command line, or generated with the
1453 option if only log messages need to be edited.
1455 The format of the histedit script is line-based.
1456 Each line in the script begins with a command name, followed by
1457 whitespace and an argument.
1458 For most commands, the expected argument is a commit ID SHA1 hash.
1459 Any remaining text on the line is ignored.
1460 Lines which begin with the
1462 character are ignored entirely.
1464 The available commands are as follows:
1465 .Bl -column YXZ pick-commit
1466 .It pick Ar commit Ta Use the specified commit as it is.
1467 .It edit Ar commit Ta Use the specified commit but once changes have been
1468 merged into the work tree interrupt the histedit operation for amending.
1469 .It fold Ar commit Ta Combine the specified commit with the next commit
1470 listed further below that will be used.
1471 .It drop Ar commit Ta Remove this commit from the edited history.
1472 .It mesg Ar log-message Ta Use the specified single-line log message for
1473 the commit on the previous line.
1474 If the log message argument is left empty, open an editor where a new
1475 log message can be written.
1478 Every commit in the history being edited must be mentioned in the script.
1479 Lines may be re-ordered to change the order of commits in the edited history.
1480 No commit may be listed more than once.
1482 Edited commits are accumulated on a temporary branch which the work tree
1483 will remain switched to throughout the entire histedit operation.
1484 Once history editing has completed successfully, the temporary branch becomes
1485 the new version of the work tree's branch and the work tree is automatically
1488 While merging commits, show the status of each affected file,
1489 using the following status codes:
1490 .Bl -column YXZ description
1491 .It G Ta file was merged
1492 .It C Ta file was merged and conflicts occurred during merge
1493 .It ! Ta changes destined for a missing file were not merged
1494 .It D Ta file was deleted
1495 .It d Ta file's deletion was obstructed by local modifications
1496 .It A Ta new file was added
1497 .It \(a~ Ta changes destined for a non-regular file were not merged
1500 If merge conflicts occur the histedit operation is interrupted and may
1501 be continued once conflicts have been resolved.
1502 Alternatively, the histedit operation may be aborted which will leave
1503 the work tree switched back to its original branch.
1505 If a merge conflict is resolved in a way which renders the merged
1506 change into a no-op change, the corresponding commit will be elided
1507 when the histedit operation continues.
1510 will refuse to run if certain preconditions are not met.
1511 If the work tree's current branch is not in the
1513 reference namespace, the history of the branch may not be edited.
1514 If the work tree contains multiple base commits it must first be updated
1515 to a single base commit with
1517 If changes have been staged with
1519 these changes must first be committed with
1523 If the work tree contains local changes, these changes must first be
1528 If the edited history contains changes to files outside of the work tree's
1529 path prefix, the work tree cannot be used to edit the history of this branch.
1536 commands will refuse to run while a histedit operation is in progress.
1537 Other commands which manipulate the work tree may be used, and the
1539 command may be used to commit arbitrary changes to the temporary branch
1540 while the histedit operation is interrupted.
1547 Abort an interrupted histedit operation.
1548 If this option is used, no other command-line arguments are allowed.
1550 Continue an interrupted histedit operation.
1551 If this option is used, no other command-line arguments are allowed.
1552 .It Fl F Ar histedit-script
1555 instead of opening a temporary file in an editor where a histedit script
1558 Edit log messages only.
1559 This option is a quick equivalent to a histedit script which edits
1560 only log messages but otherwise leaves every picked commit as-is.
1563 option can only be used when starting a new histedit operation.
1564 If this option is used, no other command-line arguments are allowed.
1569 .It Cm integrate Ar branch
1570 Integrate the specified
1572 into the work tree's current branch.
1573 Files in the work tree are updated to match the contents on the integrated
1575 and the reference of the work tree's branch is changed to point at the
1576 head commit of the integrated
1579 Both branches can be considered equivalent after integration since they
1580 will be pointing at the same commit.
1581 Both branches remain available for future work, if desired.
1582 In case the integrated
1584 is no longer needed it may be deleted with
1587 Show the status of each affected file, using the following status codes:
1588 .Bl -column YXZ description
1589 .It U Ta file was updated
1590 .It D Ta file was deleted
1591 .It A Ta new file was added
1592 .It \(a~ Ta versioned file is obstructed by a non-regular file
1593 .It ! Ta a missing versioned file was restored
1597 will refuse to run if certain preconditions are not met.
1598 Most importantly, the
1600 must have been rebased onto the work tree's current branch with
1602 before it can be integrated, in order to linearize commit history and
1603 resolve merge conflicts.
1604 If the work tree contains multiple base commits it must first be updated
1605 to a single base commit with
1607 If changes have been staged with
1609 these changes must first be committed with
1613 If the work tree contains local changes, these changes must first be
1621 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1622 Stage local changes for inclusion in the next commit.
1625 is specified, stage all changes in the work tree.
1626 Otherwise, stage changes at or within the specified paths.
1627 Paths may be staged if they are added, modified, or deleted according to
1630 Show the status of each affected file, using the following status codes:
1631 .Bl -column YXZ description
1632 .It A Ta file addition has been staged
1633 .It M Ta file modification has been staged
1634 .It D Ta file deletion has been staged
1637 Staged file contents are saved in newly created blob objects in the repository.
1638 These blobs will be referred to by tree objects once staged changes have been
1641 Staged changes affect the behaviour of
1646 While paths with staged changes exist, the
1648 command will refuse to commit any paths which do not have staged changes.
1649 Local changes created on top of staged changes can only be committed if
1650 the path is staged again, or if the staged changes are committed first.
1653 command will show both local changes and staged changes.
1656 command is able to display local changes relative to staged changes,
1657 and to display staged changes relative to the repository.
1660 command cannot revert staged changes but may be used to revert
1661 local changes created on top of staged changes.
1668 Instead of staging new changes, list paths which are already staged,
1669 along with the IDs of staged blob objects and stage status codes.
1670 If paths were provided in the command line show the staged paths
1671 among the specified paths.
1672 Otherwise, show all staged paths.
1674 Instead of staging the entire content of a changed file, interactively
1675 select or reject changes for staging based on
1679 (reject change), and
1681 (quit staging this file) responses.
1682 If a file is in modified status, individual patches derived from the
1683 modified file content can be staged.
1684 Files in added or deleted status may only be staged or rejected in
1686 .It Fl F Ar response-script
1694 responses line-by-line from the specified
1696 file instead of prompting interactively.
1700 will refuse to run if certain preconditions are not met.
1701 If a file contains merge conflicts, these conflicts must be resolved first.
1702 If a file is found to be out of date relative to the head commit on the
1703 work tree's current branch, the file must be updated with
1705 before it can be staged (however, this does not prevent the file from
1706 becoming out-of-date at some point after having been staged).
1713 commands will refuse to run while staged changes exist.
1714 If staged changes cannot be committed because a staged path
1715 is out of date, the path must be unstaged with
1717 before it can be updated with
1719 and may then be staged again if necessary.
1723 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1724 Merge staged changes back into the work tree and put affected paths
1725 back into non-staged status.
1728 is specified, unstage all staged changes across the entire work tree.
1729 Otherwise, unstage changes at or within the specified paths.
1731 Show the status of each affected file, using the following status codes:
1732 .Bl -column YXZ description
1733 .It G Ta file was unstaged
1734 .It C Ta file was unstaged and conflicts occurred during merge
1735 .It ! Ta changes destined for a missing file were not merged
1736 .It D Ta file was staged as deleted and still is deleted
1737 .It d Ta file's deletion was obstructed by local modifications
1738 .It \(a~ Ta changes destined for a non-regular file were not merged
1746 Instead of unstaging the entire content of a changed file, interactively
1747 select or reject changes for unstaging based on
1751 (keep change staged), and
1753 (quit unstaging this file) responses.
1754 If a file is staged in modified status, individual patches derived from the
1755 staged file content can be unstaged.
1756 Files staged in added or deleted status may only be unstaged in their entirety.
1757 .It Fl F Ar response-script
1765 responses line-by-line from the specified
1767 file instead of prompting interactively.
1772 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1773 Parse and print contents of objects to standard output in a line-based
1775 Content of commit, tree, and tag objects is printed in a way similar
1776 to the actual content stored in such objects.
1777 Blob object contents are printed as they would appear in files on disk.
1779 Attempt to interpret each argument as a reference, a tag name, or
1780 an object ID SHA1 hash.
1781 References will be resolved to an object ID.
1782 Tag names will resolved to a tag object.
1783 An abbreviated hash argument will be expanded to a full SHA1 hash
1784 automatically, provided the abbreviation is unique.
1786 If none of the above interpretations produce a valid result, or if the
1788 option is used, attempt to interpret the argument as a path which will
1789 be resolved to the ID of an object found at this path in the repository.
1796 Look up paths in the specified
1798 If this option is not used, paths are looked up in the commit resolved
1799 via the repository's HEAD reference.
1800 The expected argument is a commit ID SHA1 hash or an existing reference
1801 or tag name which will be resolved to a commit ID.
1802 An abbreviated hash argument will be expanded to a full SHA1 hash
1803 automatically, provided the abbreviation is unique.
1804 .It Fl r Ar repository-path
1805 Use the repository at the specified path.
1806 If not specified, assume the repository is located at or above the current
1808 If this directory is a
1810 work tree, use the repository path associated with this work tree.
1812 Interpret all arguments as paths only.
1813 This option can be used to resolve ambiguity in cases where paths
1814 look like tag names, reference names, or object IDs.
1818 .Bl -tag -width GOT_AUTHOR
1820 The author's name and email address for
1825 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1828 may fail to parse commits without an email address in author data,
1832 environment variables with a missing email address.
1838 configuration settings in the repository's
1840 file will override the value of
1846 configuration settings contained in Git's global
1848 configuration file will be used only if the
1850 environment variable is
1853 .It Ev VISUAL , EDITOR
1854 The editor spawned by
1859 .It Ev GOT_LOG_DEFAULT_LIMIT
1860 The default limit on the number of commits traversed by
1862 If set to zero, the limit is unbounded.
1863 This variable will be silently ignored if it is set to a non-numeric value.
1868 Clone an existing Git repository for use with
1872 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1874 Use of HTTP URLs currently requires
1878 .Dl $ git clone --bare https://github.com/openbsd/src.git
1880 Alternatively, for quick and dirty local testing of
1882 a new Git repository could be created and populated with files,
1883 e.g. from a temporary CVS checkout located at
1886 .Dl $ got init /var/git/src.git
1887 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1889 Check out a work tree from the Git repository to /usr/src:
1891 .Dl $ got checkout /var/git/src.git /usr/src
1893 View local changes in a work tree directory:
1896 .Dl $ got diff | less
1898 Interactively revert selected local changes in a work tree directory:
1900 .Dl $ got revert -p -R\ .
1902 In a work tree or a git repository directory, list all branch references:
1906 In a work tree or a git repository directory, create a new branch called
1907 .Dq unified-buffer-cache
1908 which is forked off the
1912 .Dl $ got branch unified-buffer-cache master
1914 Switch an existing work tree to the branch
1915 .Dq unified-buffer-cache .
1916 Local changes in the work tree will be preserved and merged if necessary:
1918 .Dl $ got update -b unified-buffer-cache
1920 Create a new commit from local changes in a work tree directory.
1921 This new commit will become the head commit of the work tree's current branch:
1925 In a work tree or a git repository directory, view changes committed in
1926 the 3 most recent commits to the work tree's branch, or the branch resolved
1927 via the repository's HEAD reference, respectively:
1929 .Dl $ got log -p -l 3
1931 As above, but display changes in the order in which
1933 could apply them in sequence:
1935 .Dl $ got log -p -l 3 -R
1937 In a work tree or a git repository directory, log the history of a subdirectory:
1939 .Dl $ got log sys/uvm
1941 While operating inside a work tree, paths are specified relative to the current
1942 working directory, so this command will log the subdirectory
1945 .Dl $ cd sys/uvm && got log '.'
1947 And this command has the same effect:
1949 .Dl $ cd sys/dev/usb && got log ../../uvm
1951 Add new files and remove obsolete files in a work tree directory:
1953 .Dl $ got add sys/uvm/uvm_ubc.c
1954 .Dl $ got remove sys/uvm/uvm_vnode.c
1956 Create a new commit from local changes in a work tree directory
1957 with a pre-defined log message.
1959 .Dl $ got commit -m 'unify the buffer cache'
1961 Update any work tree checked out from the
1962 .Dq unified-buffer-cache
1963 branch to the latest commit on this branch:
1967 Roll file content on the unified-buffer-cache branch back by one commit,
1968 and then fetch the rolled-back change into the work tree as a local change
1969 to be amended and perhaps committed again:
1971 .Dl $ got backout unified-buffer-cache
1972 .Dl $ got commit -m 'roll back previous'
1973 .Dl $ # now back out the previous backout :-)
1974 .Dl $ got backout unified-buffer-cache
1976 Fetch new upstream commits into the local repository's
1983 In a repository created with a HTTP URL and
1984 .Cm git clone --bare
1987 command must be used instead:
1989 .Dl $ cd /var/git/src.git
1990 .Dl $ git fetch origin master:refs/remotes/origin/master
1994 branch to merge the new changes that are now visible on the
1999 .Dl $ got update -b origin/master
2000 .Dl $ got rebase master
2003 .Dq unified-buffer-cache
2004 branch on top of the new head commit of the
2008 .Dl $ got update -b master
2009 .Dl $ got rebase unified-buffer-cache
2011 Create a patch from all changes on the unified-buffer-cache branch.
2012 The patch can be mailed out for review and applied to
2016 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2018 Edit the entire commit history of the
2019 .Dq unified-buffer-cache
2022 .Dl $ got update -b unified-buffer-cache
2023 .Dl $ got update -c master
2026 In order to merge changes committed to the
2027 .Dq unified-buffer-cache
2028 branch back into the
2031 .Dq unified-buffer-cache
2032 branch must first be rebased onto the
2036 .Dl $ got update -b master
2037 .Dl $ got rebase unified-buffer-cache
2040 .Dq unified-buffer-cache
2041 branch can now be made visible on the
2045 Because the rebase operation switched the work tree to the
2046 .Dq unified-buffer-cache
2047 branch, the work tree must be switched back to the
2050 .Dq unified-buffer-cache
2051 branch can be integrated into
2054 .Dl $ got update -b master
2055 .Dl $ got integrate unified-buffer-cache
2057 Additional steps may be necessary if local changes need to be pushed back
2058 to the remote repository, which currently requires
2060 Before working against existing branches in a repository cloned with
2061 .Cm git clone --bare
2066 must be configured to map all references in the remote repository
2069 namespace of the local repository.
2070 This can achieved by setting Git's
2071 .Pa remote.origin.fetch
2072 configuration variable to the value
2073 .Dq +refs/heads/*:refs/remotes/origin/*
2078 .Dl $ cd /var/git/repo
2079 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2083 option must be disabled:
2085 .Dl $ cd /var/git/repo
2086 .Dl $ git config remote.origin.mirror false
2088 Alternatively, the following
2090 configuration item can be added manually to the Git repository's
2094 .Dl [remote "origin"]
2096 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2099 This configuration leaves the local repository's
2101 namespace free for use by local branches checked out with
2103 and, if needed, created with
2108 namespace can now be updated with incoming changes from the remote
2113 without extra command line arguments:
2115 .Dl $ cd /var/git/repo
2118 To make changes fetched from the remote repository appear on the
2122 branch must be rebased onto the
2125 This will also merge local changes, if any, with the incoming changes:
2127 .Dl $ got update -b origin/master
2128 .Dl $ got rebase master
2132 branch, log messages for local changes can now be amended with
2134 by other developers and any other important new information:
2136 .Dl $ got update -c origin/master
2137 .Dl $ got histedit -m
2139 Local changes on the
2141 branch can then be pushed to the remote
2145 .Dl $ cd /var/git/repo
2146 .Dl $ git push origin master
2149 .Xr git-repository 5 ,
2152 .An Stefan Sperling Aq Mt stsp@openbsd.org
2153 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2154 .An Joshua Stein Aq Mt jcs@openbsd.org
2155 .An Ori Bernstein Aq Mt ori@openbsd.org
2158 is a work-in-progress and many commands remain to be implemented.
2159 At present, the user has to fall back on
2161 to perform many tasks, in particular tasks related to repository
2162 administration and tasks which require a network connection.
