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 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.
733 Display the list of file paths changed in each commit, using the following
735 .Bl -column YXZ description
736 .It M Ta modified file
737 .It D Ta file was deleted
738 .It A Ta new file was added
739 .It m Ta modified file modes (executable bit only)
741 .It Fl s Ar search-pattern
742 If specified, show only commits with a log message matched by the extended
745 When used together with
747 then the file paths changed by a commit can be matched as well.
748 Regular expression syntax is documented in
750 .It Fl r Ar repository-path
751 Use the repository at the specified path.
752 If not specified, assume the repository is located at or above the current
754 If this directory is a
756 work tree, use the repository path associated with this work tree.
758 Determine a set of commits to display as usual, but display these commits
761 Stop traversing commit history as soon as the specified
764 This option has no effect if the specified
768 .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
769 When invoked within a work tree with less than two arguments, display
770 local changes in the work tree.
773 is specified, only show changes within this path.
775 If two arguments are provided, treat each argument as a reference, a tag
776 name, or an object ID SHA1 hash, and display differences between the
777 corresponding objects.
778 Both objects must be of the same type (blobs, trees, or commits).
779 An abbreviated hash argument will be expanded to a full SHA1 hash
780 automatically, provided the abbreviation is unique.
787 Set the number of context lines shown in the diff.
788 By default, 3 lines of context are shown.
789 .It Fl r Ar repository-path
790 Use the repository at the specified path.
791 If not specified, assume the repository is located at or above the current
793 If this directory is a
795 work tree, use the repository path associated with this work tree.
797 Show changes staged with
799 instead of showing local changes in the work tree.
800 This option is only valid when
802 is invoked in a work tree.
804 Ignore whitespace-only changes.
809 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
810 Display line-by-line history of a file at the specified path.
817 Start traversing history at the specified
819 The expected argument is a commit ID SHA1 hash or an existing reference
820 or tag name which will be resolved to a commit ID.
821 An abbreviated hash argument will be expanded to a full SHA1 hash
822 automatically, provided the abbreviation is unique.
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.
834 .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
835 Display a listing of files and directories at the specified
836 directory path in the repository.
837 Entries shown in this listing may carry one of the following trailing
839 .Bl -column YXZ description
840 .It @ Ta entry is a symbolic link
841 .It / Ta entry is a directory
842 .It * Ta entry is an executable file
843 .It $ Ta entry is a Git submodule
848 is specified, list the repository path corresponding to the current
849 directory of the work tree, or the root directory of the repository
850 if there is no work tree.
857 List files and directories as they appear in the specified
859 The expected argument is a commit ID SHA1 hash or an existing reference
860 or tag name which will be resolved to a commit ID.
861 An abbreviated hash argument will be expanded to a full SHA1 hash
862 automatically, provided the abbreviation is unique.
863 .It Fl r Ar repository-path
864 Use the repository at the specified path.
865 If not specified, assume the repository is located at or above the current
867 If this directory is a
869 work tree, use the repository path associated with this work tree.
871 Show object IDs of files (blob objects) and directories (tree objects).
873 Recurse into sub-directories in the repository.
878 .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
879 Manage references in a repository.
881 References may be listed, created, deleted, and changed.
882 When creating, deleting, or changing a reference the specified
884 must be an absolute reference name, i.e. it must begin with
891 .It Fl r Ar repository-path
892 Use the repository at the specified path.
893 If not specified, assume the repository is located at or above the current
895 If this directory is a
897 work tree, use the repository path associated with this work tree.
899 List references in the repository.
902 is specified, list all existing references in the repository.
905 is a reference namespace, list all references in this namespace.
906 Otherwise, show only the reference with the given
908 Cannot be used together with any other options except
911 Create a reference or change an existing reference.
912 The reference with the specified
914 will point at the specified
918 argument is a ID SHA1 hash or an existing reference or tag name which will
919 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
920 Cannot be used together with any other options except
922 .It Fl s Ar reference
923 Create a symbolic reference, or change an existing symbolic reference.
924 The symbolic reference with the specified
926 will point at the specified
928 which must already exist in the repository.
929 Care should be taken not to create loops between references when
931 Cannot be used together with any other options except
934 Delete the reference with the specified
937 Cannot be used together with any other options except
940 .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
941 Create, list, or delete branches.
943 Branches are managed via references which live in the
948 command operates on references in this namespace only.
950 If invoked in a work tree without any arguments, print the name of the
951 work tree's current branch.
955 argument is passed, attempt to create a branch reference with the given name.
956 By default the new branch reference will point at the latest commit on the
957 work tree's current branch if invoked in a work tree, and otherwise to a commit
958 resolved via the repository's HEAD reference.
960 If invoked in a work tree, once the branch was created successfully
961 switch the work tree's head reference to the newly created branch and
962 update files across the entire work tree, just like
963 .Cm got update -b Ar name
965 Show the status of each affected file, using the following status codes:
966 .Bl -column YXZ description
967 .It U Ta file was updated and contained no local changes
968 .It G Ta file was updated and local changes were merged cleanly
969 .It C Ta file was updated and conflicts occurred during merge
970 .It D Ta file was deleted
971 .It A Ta new file was added
972 .It \(a~ Ta versioned file is obstructed by a non-regular file
973 .It ! Ta a missing versioned file was restored
981 Make a newly created branch reference point at the specified
985 argument is a commit ID SHA1 hash or an existing reference
986 or tag name which will be resolved to a commit ID.
987 .It Fl r Ar repository-path
988 Use the repository at the specified path.
989 If not specified, assume the repository is located at or above the current
991 If this directory is a
993 work tree, use the repository path associated with this work tree.
995 List all existing branches in the repository.
996 If invoked in a work tree, the work tree's current branch is shown
997 with one the following annotations:
998 .Bl -column YXZ description
999 .It * Ta work tree's base commit matches the branch tip
1000 .It \(a~ Ta work tree's base commit is out-of-date
1003 Delete the branch with the specified name from the repository.
1004 Only the branch reference is deleted.
1005 Any commit, tree, and blob objects belonging to the branch
1006 remain in the repository and may be removed separately with
1007 Git's garbage collector.
1009 Do not switch and update the work tree after creating a new branch.
1014 .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
1015 Manage tags in a repository.
1017 Tags are managed via references which live in the
1019 reference namespace.
1022 command operates on references in this namespace only.
1023 References in this namespace point at tag objects which contain a pointer
1024 to another object, a tag message, as well as author and timestamp information.
1026 Attempt to create a tag with the given
1028 and make this tag point at the given
1030 If no commit is specified, default to the latest commit on the work tree's
1031 current branch if invoked in a work tree, and to a commit resolved via
1032 the repository's HEAD reference otherwise.
1039 Make the newly created tag reference point at the specified
1043 argument is a commit ID SHA1 hash or an existing reference or tag name which
1044 will be resolved to a commit ID.
1045 An abbreviated hash argument will be expanded to a full SHA1 hash
1046 automatically, provided the abbreviation is unique.
1048 Use the specified tag message when creating the new tag.
1053 opens a temporary file in an editor where a tag message can be written.
1054 .It Fl r Ar repository-path
1055 Use the repository at the specified path.
1056 If not specified, assume the repository is located at or above the current
1058 If this directory is a
1060 work tree, use the repository path associated with this work tree.
1062 List all existing tags in the repository instead of creating a new tag.
1063 If this option is used, no other command-line arguments are allowed.
1068 command will not delete tags or change existing tags.
1069 If a tag must be deleted, the
1071 command may be used to delete a tag's reference.
1072 This should only be done if the tag has not already been copied to
1074 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1075 Schedule unversioned files in a work tree for addition to the
1076 repository in the next commit.
1083 Permit recursion into directories.
1084 If this option is not specified,
1086 will refuse to run if a specified
1090 With -R, add files even if they match a
1094 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
1095 Remove versioned files from a work tree and schedule them for deletion
1096 from the repository in the next commit.
1103 Perform the operation even if a file contains local modifications.
1105 Keep affected files on disk.
1107 Permit recursion into directories.
1108 If this option is not specified,
1110 will refuse to run if a specified
1117 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1118 Revert any local changes in files at the specified paths in a work tree.
1119 File contents will be overwritten with those contained in the
1120 work tree's base commit.
1121 There is no way to bring discarded changes back after
1124 If a file was added with
1126 it will become an unversioned file again.
1127 If a file was deleted with
1129 it will be restored.
1136 Instead of reverting all changes in files, interactively select or reject
1137 changes to revert based on
1143 (quit reverting this file) responses.
1144 If a file is in modified status, individual patches derived from the
1145 modified file content can be reverted.
1146 Files in added or deleted status may only be reverted in their entirety.
1147 .It Fl F Ar response-script
1155 responses line-by-line from the specified
1157 file instead of prompting interactively.
1159 Permit recursion into directories.
1160 If this option is not specified,
1162 will refuse to run if a specified
1169 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1170 Create a new commit in the repository from changes in a work tree
1171 and use this commit as the new base commit for the work tree.
1174 is specified, commit all changes in the work tree.
1175 Otherwise, commit changes at or within the specified paths.
1177 If changes have been explicitly staged for commit with
1179 only commit staged changes and reject any specified paths which
1180 have not been staged.
1182 Show the status of each affected file, using the following status codes:
1183 .Bl -column YXZ description
1184 .It M Ta modified file
1185 .It D Ta file was deleted
1186 .It A Ta new file was added
1187 .It m Ta modified file modes (executable bit only)
1190 Files which are not part of the new commit will retain their previously
1191 recorded base commit.
1194 commands may refuse to run while the work tree contains files from
1195 multiple base commits.
1196 The base commit of such a work tree can be made consistent by running
1198 across the entire work tree.
1202 command requires the
1204 environment variable to be set,
1209 configuration settings can be
1210 obtained from the repository's
1212 file or from Git's global
1221 Use the specified log message when creating the new commit.
1226 opens a temporary file in an editor where a log message can be written.
1230 will refuse to run if certain preconditions are not met.
1231 If the work tree's current branch is not in the
1233 reference namespace, new commits may not be created on this branch.
1234 Local changes may only be committed if they are based on file content
1235 found in the most recent commit on the work tree's branch.
1236 If a path is found to be out of date,
1238 must be used first in order to merge local changes with changes made
1243 .It Cm cherrypick Ar commit
1244 Merge changes from a single
1249 must be on a different branch than the work tree's base commit.
1250 The expected argument is a reference or a commit ID SHA1 hash.
1251 An abbreviated hash argument will be expanded to a full SHA1 hash
1252 automatically, provided the abbreviation is unique.
1254 Show the status of each affected file, using the following status codes:
1255 .Bl -column YXZ description
1256 .It G Ta file was merged
1257 .It C Ta file was merged and conflicts occurred during merge
1258 .It ! Ta changes destined for a missing file were not merged
1259 .It D Ta file was deleted
1260 .It d Ta file's deletion was obstructed by local modifications
1261 .It A Ta new file was added
1262 .It \(a~ Ta changes destined for a non-regular file were not merged
1265 The merged changes will appear as local changes in the work tree, which
1268 amended manually or with further
1273 or discarded again with
1277 will refuse to run if certain preconditions are not met.
1278 If the work tree contains multiple base commits it must first be updated
1279 to a single base commit with
1281 If the work tree already contains files with merge conflicts, these
1282 conflicts must be resolved first.
1286 .It Cm backout Ar commit
1287 Reverse-merge changes from a single
1292 must be on the same branch as the work tree's base commit.
1293 The expected argument is a reference or a commit ID SHA1 hash.
1294 An abbreviated hash argument will be expanded to a full SHA1 hash
1295 automatically, provided the abbreviation is unique.
1297 Show the status of each affected file, using the following status codes:
1298 .Bl -column YXZ description
1299 .It G Ta file was merged
1300 .It C Ta file was merged and conflicts occurred during merge
1301 .It ! Ta changes destined for a missing file were not merged
1302 .It D Ta file was deleted
1303 .It d Ta file's deletion was obstructed by local modifications
1304 .It A Ta new file was added
1305 .It \(a~ Ta changes destined for a non-regular file were not merged
1308 The reverse-merged changes will appear as local changes in the work tree,
1309 which may be viewed with
1311 amended manually or with further
1316 or discarded again with
1320 will refuse to run if certain preconditions are not met.
1321 If the work tree contains multiple base commits it must first be updated
1322 to a single base commit with
1324 If the work tree already contains files with merge conflicts, these
1325 conflicts must be resolved first.
1329 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1330 Rebase commits on the specified
1332 onto the tip of the current branch of the work tree.
1335 must share common ancestry with the work tree's current branch.
1336 Rebasing begins with the first descendant commit of the youngest
1337 common ancestor commit shared by the specified
1339 and the work tree's current branch, and stops once the tip commit
1346 is used as intended, the specified
1348 represents a local commit history and may already contain changes
1349 that are not yet visible in any other repositories.
1350 The work tree's current branch, which must be set with
1354 operation, represents a branch from a remote repository which shares
1355 a common history with the specified
1357 but has progressed, and perhaps diverged, due to commits added to the
1360 Rebased commits are accumulated on a temporary branch which the work tree
1361 will remain switched to throughout the entire rebase operation.
1362 Commits on this branch represent the same changes with the same log
1363 messages as their counterparts on the original
1365 but with different commit IDs.
1366 Once rebasing has completed successfully, the temporary branch becomes
1367 the new version of the specified
1369 and the work tree is automatically switched to it.
1371 While rebasing commits, show the status of each affected file,
1372 using the following status codes:
1373 .Bl -column YXZ description
1374 .It G Ta file was merged
1375 .It C Ta file was merged and conflicts occurred during merge
1376 .It ! Ta changes destined for a missing file were not merged
1377 .It D Ta file was deleted
1378 .It d Ta file's deletion was obstructed by local modifications
1379 .It A Ta new file was added
1380 .It \(a~ Ta changes destined for a non-regular file were not merged
1383 If merge conflicts occur the rebase operation is interrupted and may
1384 be continued once conflicts have been resolved.
1385 Alternatively, the rebase operation may be aborted which will leave
1387 unmodified and the work tree switched back to its original branch.
1389 If a merge conflict is resolved in a way which renders the merged
1390 change into a no-op change, the corresponding commit will be elided
1391 when the rebase operation continues.
1394 will refuse to run if certain preconditions are not met.
1395 If the work tree is not yet fully updated to the tip commit of its
1396 branch then the work tree must first be updated with
1398 If changes have been staged with
1400 these changes must first be committed with
1404 If the work tree contains local changes, these changes must first be
1411 contains changes to files outside of the work tree's path prefix,
1412 the work tree cannot be used to rebase this branch.
1418 commands will refuse to run while a rebase operation is in progress.
1419 Other commands which manipulate the work tree may be used for
1420 conflict resolution purposes.
1427 Abort an interrupted rebase operation.
1428 If this option is used, no other command-line arguments are allowed.
1430 Continue an interrupted rebase operation.
1431 If this option is used, no other command-line arguments are allowed.
1436 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1437 Edit commit history between the work tree's current base commit and
1438 the tip commit of the work tree's current branch.
1442 operation the work tree's current branch must be set with
1444 to the branch which should be edited, unless this branch is already the
1445 current branch of the work tree.
1446 The tip of this branch represents the upper bound (inclusive) of commits
1451 Furthermore, the work tree's base commit
1454 to a point in this branch's commit history where editing should begin.
1455 This commit represents the lower bound (non-inclusive) of commits touched
1460 Editing of commit history is controlled via a
1462 which can be written in an editor based on a template, passed on the
1463 command line, or generated with the
1465 option if only log messages need to be edited.
1467 The format of the histedit script is line-based.
1468 Each line in the script begins with a command name, followed by
1469 whitespace and an argument.
1470 For most commands, the expected argument is a commit ID SHA1 hash.
1471 Any remaining text on the line is ignored.
1472 Lines which begin with the
1474 character are ignored entirely.
1476 The available commands are as follows:
1477 .Bl -column YXZ pick-commit
1478 .It pick Ar commit Ta Use the specified commit as it is.
1479 .It edit Ar commit Ta Use the specified commit but once changes have been
1480 merged into the work tree interrupt the histedit operation for amending.
1481 .It fold Ar commit Ta Combine the specified commit with the next commit
1482 listed further below that will be used.
1483 .It drop Ar commit Ta Remove this commit from the edited history.
1484 .It mesg Ar log-message Ta Use the specified single-line log message for
1485 the commit on the previous line.
1486 If the log message argument is left empty, open an editor where a new
1487 log message can be written.
1490 Every commit in the history being edited must be mentioned in the script.
1491 Lines may be re-ordered to change the order of commits in the edited history.
1492 No commit may be listed more than once.
1494 Edited commits are accumulated on a temporary branch which the work tree
1495 will remain switched to throughout the entire histedit operation.
1496 Once history editing has completed successfully, the temporary branch becomes
1497 the new version of the work tree's branch and the work tree is automatically
1500 While merging commits, show the status of each affected file,
1501 using the following status codes:
1502 .Bl -column YXZ description
1503 .It G Ta file was merged
1504 .It C Ta file was merged and conflicts occurred during merge
1505 .It ! Ta changes destined for a missing file were not merged
1506 .It D Ta file was deleted
1507 .It d Ta file's deletion was obstructed by local modifications
1508 .It A Ta new file was added
1509 .It \(a~ Ta changes destined for a non-regular file were not merged
1512 If merge conflicts occur the histedit operation is interrupted and may
1513 be continued once conflicts have been resolved.
1514 Alternatively, the histedit operation may be aborted which will leave
1515 the work tree switched back to its original branch.
1517 If a merge conflict is resolved in a way which renders the merged
1518 change into a no-op change, the corresponding commit will be elided
1519 when the histedit operation continues.
1522 will refuse to run if certain preconditions are not met.
1523 If the work tree's current branch is not in the
1525 reference namespace, the history of the branch may not be edited.
1526 If the work tree contains multiple base commits it must first be updated
1527 to a single base commit with
1529 If changes have been staged with
1531 these changes must first be committed with
1535 If the work tree contains local changes, these changes must first be
1540 If the edited history contains changes to files outside of the work tree's
1541 path prefix, the work tree cannot be used to edit the history of this branch.
1548 commands will refuse to run while a histedit operation is in progress.
1549 Other commands which manipulate the work tree may be used, and the
1551 command may be used to commit arbitrary changes to the temporary branch
1552 while the histedit operation is interrupted.
1559 Abort an interrupted histedit operation.
1560 If this option is used, no other command-line arguments are allowed.
1562 Continue an interrupted histedit operation.
1563 If this option is used, no other command-line arguments are allowed.
1564 .It Fl F Ar histedit-script
1567 instead of opening a temporary file in an editor where a histedit script
1570 Edit log messages only.
1571 This option is a quick equivalent to a histedit script which edits
1572 only log messages but otherwise leaves every picked commit as-is.
1575 option can only be used when starting a new histedit operation.
1576 If this option is used, no other command-line arguments are allowed.
1581 .It Cm integrate Ar branch
1582 Integrate the specified
1584 into the work tree's current branch.
1585 Files in the work tree are updated to match the contents on the integrated
1587 and the reference of the work tree's branch is changed to point at the
1588 head commit of the integrated
1591 Both branches can be considered equivalent after integration since they
1592 will be pointing at the same commit.
1593 Both branches remain available for future work, if desired.
1594 In case the integrated
1596 is no longer needed it may be deleted with
1599 Show the status of each affected file, using the following status codes:
1600 .Bl -column YXZ description
1601 .It U Ta file was updated
1602 .It D Ta file was deleted
1603 .It A Ta new file was added
1604 .It \(a~ Ta versioned file is obstructed by a non-regular file
1605 .It ! Ta a missing versioned file was restored
1609 will refuse to run if certain preconditions are not met.
1610 Most importantly, the
1612 must have been rebased onto the work tree's current branch with
1614 before it can be integrated, in order to linearize commit history and
1615 resolve merge conflicts.
1616 If the work tree contains multiple base commits it must first be updated
1617 to a single base commit with
1619 If changes have been staged with
1621 these changes must first be committed with
1625 If the work tree contains local changes, these changes must first be
1633 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1634 Stage local changes for inclusion in the next commit.
1637 is specified, stage all changes in the work tree.
1638 Otherwise, stage changes at or within the specified paths.
1639 Paths may be staged if they are added, modified, or deleted according to
1642 Show the status of each affected file, using the following status codes:
1643 .Bl -column YXZ description
1644 .It A Ta file addition has been staged
1645 .It M Ta file modification has been staged
1646 .It D Ta file deletion has been staged
1649 Staged file contents are saved in newly created blob objects in the repository.
1650 These blobs will be referred to by tree objects once staged changes have been
1653 Staged changes affect the behaviour of
1658 While paths with staged changes exist, the
1660 command will refuse to commit any paths which do not have staged changes.
1661 Local changes created on top of staged changes can only be committed if
1662 the path is staged again, or if the staged changes are committed first.
1665 command will show both local changes and staged changes.
1668 command is able to display local changes relative to staged changes,
1669 and to display staged changes relative to the repository.
1672 command cannot revert staged changes but may be used to revert
1673 local changes created on top of staged changes.
1680 Instead of staging new changes, list paths which are already staged,
1681 along with the IDs of staged blob objects and stage status codes.
1682 If paths were provided in the command line show the staged paths
1683 among the specified paths.
1684 Otherwise, show all staged paths.
1686 Instead of staging the entire content of a changed file, interactively
1687 select or reject changes for staging based on
1691 (reject change), and
1693 (quit staging this file) responses.
1694 If a file is in modified status, individual patches derived from the
1695 modified file content can be staged.
1696 Files in added or deleted status may only be staged or rejected in
1698 .It Fl F Ar response-script
1706 responses line-by-line from the specified
1708 file instead of prompting interactively.
1712 will refuse to run if certain preconditions are not met.
1713 If a file contains merge conflicts, these conflicts must be resolved first.
1714 If a file is found to be out of date relative to the head commit on the
1715 work tree's current branch, the file must be updated with
1717 before it can be staged (however, this does not prevent the file from
1718 becoming out-of-date at some point after having been staged).
1725 commands will refuse to run while staged changes exist.
1726 If staged changes cannot be committed because a staged path
1727 is out of date, the path must be unstaged with
1729 before it can be updated with
1731 and may then be staged again if necessary.
1735 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1736 Merge staged changes back into the work tree and put affected paths
1737 back into non-staged status.
1740 is specified, unstage all staged changes across the entire work tree.
1741 Otherwise, unstage changes at or within the specified paths.
1743 Show the status of each affected file, using the following status codes:
1744 .Bl -column YXZ description
1745 .It G Ta file was unstaged
1746 .It C Ta file was unstaged and conflicts occurred during merge
1747 .It ! Ta changes destined for a missing file were not merged
1748 .It D Ta file was staged as deleted and still is deleted
1749 .It d Ta file's deletion was obstructed by local modifications
1750 .It \(a~ Ta changes destined for a non-regular file were not merged
1758 Instead of unstaging the entire content of a changed file, interactively
1759 select or reject changes for unstaging based on
1763 (keep change staged), and
1765 (quit unstaging this file) responses.
1766 If a file is staged in modified status, individual patches derived from the
1767 staged file content can be unstaged.
1768 Files staged in added or deleted status may only be unstaged in their entirety.
1769 .It Fl F Ar response-script
1777 responses line-by-line from the specified
1779 file instead of prompting interactively.
1784 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1785 Parse and print contents of objects to standard output in a line-based
1787 Content of commit, tree, and tag objects is printed in a way similar
1788 to the actual content stored in such objects.
1789 Blob object contents are printed as they would appear in files on disk.
1791 Attempt to interpret each argument as a reference, a tag name, or
1792 an object ID SHA1 hash.
1793 References will be resolved to an object ID.
1794 Tag names will resolved to a tag object.
1795 An abbreviated hash argument will be expanded to a full SHA1 hash
1796 automatically, provided the abbreviation is unique.
1798 If none of the above interpretations produce a valid result, or if the
1800 option is used, attempt to interpret the argument as a path which will
1801 be resolved to the ID of an object found at this path in the repository.
1808 Look up paths in the specified
1810 If this option is not used, paths are looked up in the commit resolved
1811 via the repository's HEAD reference.
1812 The expected argument is a commit ID SHA1 hash or an existing reference
1813 or tag name which will be resolved to a commit ID.
1814 An abbreviated hash argument will be expanded to a full SHA1 hash
1815 automatically, provided the abbreviation is unique.
1816 .It Fl r Ar repository-path
1817 Use the repository at the specified path.
1818 If not specified, assume the repository is located at or above the current
1820 If this directory is a
1822 work tree, use the repository path associated with this work tree.
1824 Interpret all arguments as paths only.
1825 This option can be used to resolve ambiguity in cases where paths
1826 look like tag names, reference names, or object IDs.
1830 .Bl -tag -width GOT_AUTHOR
1832 The author's name and email address for
1837 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1840 may fail to parse commits without an email address in author data,
1844 environment variables with a missing email address.
1850 configuration settings in the repository's
1852 file will override the value of
1858 configuration settings contained in Git's global
1860 configuration file will be used only if the
1862 environment variable is
1865 .It Ev VISUAL , EDITOR
1866 The editor spawned by
1871 .It Ev GOT_LOG_DEFAULT_LIMIT
1872 The default limit on the number of commits traversed by
1874 If set to zero, the limit is unbounded.
1875 This variable will be silently ignored if it is set to a non-numeric value.
1880 Clone an existing Git repository for use with
1884 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1886 Use of HTTP URLs currently requires
1890 .Dl $ git clone --bare https://github.com/openbsd/src.git
1892 Alternatively, for quick and dirty local testing of
1894 a new Git repository could be created and populated with files,
1895 e.g. from a temporary CVS checkout located at
1898 .Dl $ got init /var/git/src.git
1899 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1901 Check out a work tree from the Git repository to /usr/src:
1903 .Dl $ got checkout /var/git/src.git /usr/src
1905 View local changes in a work tree directory:
1908 .Dl $ got diff | less
1910 Interactively revert selected local changes in a work tree directory:
1912 .Dl $ got revert -p -R\ .
1914 In a work tree or a git repository directory, list all branch references:
1918 In a work tree or a git repository directory, create a new branch called
1919 .Dq unified-buffer-cache
1920 which is forked off the
1924 .Dl $ got branch unified-buffer-cache master
1926 Switch an existing work tree to the branch
1927 .Dq unified-buffer-cache .
1928 Local changes in the work tree will be preserved and merged if necessary:
1930 .Dl $ got update -b unified-buffer-cache
1932 Create a new commit from local changes in a work tree directory.
1933 This new commit will become the head commit of the work tree's current branch:
1937 In a work tree or a git repository directory, view changes committed in
1938 the 3 most recent commits to the work tree's branch, or the branch resolved
1939 via the repository's HEAD reference, respectively:
1941 .Dl $ got log -p -l 3
1943 As above, but display changes in the order in which
1945 could apply them in sequence:
1947 .Dl $ got log -p -l 3 -R
1949 In a work tree or a git repository directory, log the history of a subdirectory:
1951 .Dl $ got log sys/uvm
1953 While operating inside a work tree, paths are specified relative to the current
1954 working directory, so this command will log the subdirectory
1957 .Dl $ cd sys/uvm && got log '.'
1959 And this command has the same effect:
1961 .Dl $ cd sys/dev/usb && got log ../../uvm
1963 Add new files and remove obsolete files in a work tree directory:
1965 .Dl $ got add sys/uvm/uvm_ubc.c
1966 .Dl $ got remove sys/uvm/uvm_vnode.c
1968 Create a new commit from local changes in a work tree directory
1969 with a pre-defined log message.
1971 .Dl $ got commit -m 'unify the buffer cache'
1973 Update any work tree checked out from the
1974 .Dq unified-buffer-cache
1975 branch to the latest commit on this branch:
1979 Roll file content on the unified-buffer-cache branch back by one commit,
1980 and then fetch the rolled-back change into the work tree as a local change
1981 to be amended and perhaps committed again:
1983 .Dl $ got backout unified-buffer-cache
1984 .Dl $ got commit -m 'roll back previous'
1985 .Dl $ # now back out the previous backout :-)
1986 .Dl $ got backout unified-buffer-cache
1988 Fetch new upstream commits into the local repository's
1995 In a repository created with a HTTP URL and
1996 .Cm git clone --bare
1999 command must be used instead:
2001 .Dl $ cd /var/git/src.git
2002 .Dl $ git fetch origin master:refs/remotes/origin/master
2006 branch to merge the new changes that are now visible on the
2011 .Dl $ got update -b origin/master
2012 .Dl $ got rebase master
2015 .Dq unified-buffer-cache
2016 branch on top of the new head commit of the
2020 .Dl $ got update -b master
2021 .Dl $ got rebase unified-buffer-cache
2023 Create a patch from all changes on the unified-buffer-cache branch.
2024 The patch can be mailed out for review and applied to
2028 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
2030 Edit the entire commit history of the
2031 .Dq unified-buffer-cache
2034 .Dl $ got update -b unified-buffer-cache
2035 .Dl $ got update -c master
2038 In order to merge changes committed to the
2039 .Dq unified-buffer-cache
2040 branch back into the
2043 .Dq unified-buffer-cache
2044 branch must first be rebased onto the
2048 .Dl $ got update -b master
2049 .Dl $ got rebase unified-buffer-cache
2052 .Dq unified-buffer-cache
2053 branch can now be made visible on the
2057 Because the rebase operation switched the work tree to the
2058 .Dq unified-buffer-cache
2059 branch, the work tree must be switched back to the
2062 .Dq unified-buffer-cache
2063 branch can be integrated into
2066 .Dl $ got update -b master
2067 .Dl $ got integrate unified-buffer-cache
2069 Additional steps may be necessary if local changes need to be pushed back
2070 to the remote repository, which currently requires
2072 Before working against existing branches in a repository cloned with
2073 .Cm git clone --bare
2078 must be configured to map all references in the remote repository
2081 namespace of the local repository.
2082 This can achieved by setting Git's
2083 .Pa remote.origin.fetch
2084 configuration variable to the value
2085 .Dq +refs/heads/*:refs/remotes/origin/*
2090 .Dl $ cd /var/git/repo
2091 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2095 option must be disabled:
2097 .Dl $ cd /var/git/repo
2098 .Dl $ git config remote.origin.mirror false
2100 Alternatively, the following
2102 configuration item can be added manually to the Git repository's
2106 .Dl [remote "origin"]
2108 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2111 This configuration leaves the local repository's
2113 namespace free for use by local branches checked out with
2115 and, if needed, created with
2120 namespace can now be updated with incoming changes from the remote
2125 without extra command line arguments:
2127 .Dl $ cd /var/git/repo
2130 To make changes fetched from the remote repository appear on the
2134 branch must be rebased onto the
2137 This will also merge local changes, if any, with the incoming changes:
2139 .Dl $ got update -b origin/master
2140 .Dl $ got rebase master
2144 branch, log messages for local changes can now be amended with
2146 by other developers and any other important new information:
2148 .Dl $ got update -c origin/master
2149 .Dl $ got histedit -m
2151 Local changes on the
2153 branch can then be pushed to the remote
2157 .Dl $ cd /var/git/repo
2158 .Dl $ git push origin master
2161 .Xr git-repository 5 ,
2164 .An Stefan Sperling Aq Mt stsp@openbsd.org
2165 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2166 .An Joshua Stein Aq Mt jcs@openbsd.org
2167 .An Ori Bernstein Aq Mt ori@openbsd.org
2170 is a work-in-progress and many commands remain to be implemented.
2171 At present, the user has to fall back on
2173 to perform many tasks, in particular tasks related to repository
2174 administration and tasks which require a network connection.
