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 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.
206 If this option is not specified, a branch resolved via the remote
207 repository's HEAD reference will be fetched.
208 Cannot be used together with the
214 from the remote repository.
215 This option may be specified multiple times to build a list of branches
217 If the branch corresponding to the remote repository's HEAD reference is not
218 in this list, the cloned repository's HEAD reference will be set to the first
219 branch which was fetched.
220 If this option is not specified, a branch resolved via the remote
221 repository's HEAD reference will be fetched.
222 Cannot be used together with the
226 List branches and tags available for cloning from the remote repository
227 and exit immediately.
228 Cannot be used together with any of the other options except
231 Create the cloned repository as a mirror of the original repository.
232 This is useful if the cloned repository will not be used to store
233 local changes as created by
238 file will be set up with the
240 option enabled, such that
244 will write incoming changes directly to branches in the
246 reference namespace, rather than to branches in the
249 This avoids the usual requirement of having to run
253 in order to make incoming changes appear on branches in the
256 But maintaining custom branches with local changes in the cloned
257 repository becomes difficult since local changes are at risk of
258 being discarded whenever incoming changes are fetched.
260 Suppress progress reporting output.
261 The same option will be passed to
265 Increase the verbosity of progress reporting output.
266 The same option will be passed to
269 Multiple -v options increase the verbosity.
275 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
276 Fetch new changes from a remote repository.
278 .Ar remote-repository
282 The remote repository's URL is obtained from the corresponding entry in the
284 file of the local repository, as created by
287 New changes will be stored in a separate pack file downloaded from the server.
288 Optionally, separate pack files stored in the repository can be combined with
291 Branch references in the
293 reference namespace will be updated to point at the newly fetched commits,
296 command can then be used to make new changes visible on branches in the
298 reference namespace, merging incoming changes with local changes as necessary.
300 However, if the repository is configured as a mirror then all references will
301 be updated as needed to match the corresponding references in the remote
302 repository, including branches in the
305 If those branches contained local commits, these commits will no longer be
306 reachable via a reference and will therefore be at risk of being discarded
307 by Git's garbage collector.
309 In any case, existing references in the
311 namespace will always be changed to match tags contained in the remote
319 Fetch all branches from the remote repository.
320 If this option is not specified, a branch resolved via the remote
321 repository's HEAD reference will be fetched.
322 Cannot be used together with the
328 from the remote repository.
329 This option may be specified multiple times to build a list of branches
331 If this option is not specified, a branch resolved via the remote
332 repository's HEAD reference will be fetched.
333 Cannot be used together with the
337 List branches and tags available for fetching from the remote repository
338 and exit immediately.
339 Cannot be used together with any of the other options except
343 .It Fl r Ar repository-path
344 Use the repository at the specified path.
345 If not specified, assume the repository is located at or above the current
347 If this directory is a
349 work tree, use the repository path associated with this work tree.
351 Suppress progress reporting output.
352 The same option will be passed to
356 Increase the verbosity of progress reporting output.
357 The same option will be passed to
360 Multiple -v options increase the verbosity.
366 .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
367 Copy files from a repository into a new work tree.
368 Show the status of each affected file, using the following status codes:
369 .Bl -column YXZ description
370 .It A Ta new file was added
371 .It E Ta file already exists in work tree's meta-data
376 is not specified, either use the last component of
377 .Ar repository path ,
380 was specified use the last component of
388 Proceed with the checkout operation even if the directory at
391 Existing files will be left intact.
393 Check out files from a commit on the specified
395 If this option is not specified, a branch resolved via the repository's HEAD
396 reference will be used.
398 Check out files from the specified
400 on the selected branch.
401 The expected argument is a commit ID SHA1 hash or an existing reference
402 or tag name which will be resolved to a commit ID.
403 An abbreviated hash argument will be expanded to a full SHA1 hash
404 automatically, provided the abbreviation is unique.
405 If this option is not specified, the most recent commit on the selected
410 is not contained in the selected branch, a different branch which contains
411 this commit must be specified with the
414 If no such branch is known a new branch must be created for this
420 Checking out work trees with an unknown branch is intentionally not supported.
421 .It Fl p Ar path-prefix
422 Restrict the work tree to a subset of the repository's tree hierarchy.
423 Only files beneath the specified
430 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
431 Update an existing work tree to a different commit.
432 Show the status of each affected file, using the following status codes:
433 .Bl -column YXZ description
434 .It U Ta file was updated and contained no local changes
435 .It G Ta file was updated and local changes were merged cleanly
436 .It C Ta file was updated and conflicts occurred during merge
437 .It D Ta file was deleted
438 .It A Ta new file was added
439 .It \(a~ Ta versioned file is obstructed by a non-regular file
440 .It ! Ta a missing versioned file was restored
445 is specified, update the entire work tree.
446 Otherwise, restrict the update operation to files at or within the
448 Each path is required to exist in the update operation's target commit.
449 Files in the work tree outside specified paths will remain unchanged and
450 will retain their previously recorded base commit.
453 commands may refuse to run while the work tree contains files from
454 multiple base commits.
455 The base commit of such a work tree can be made consistent by running
457 across the entire work tree.
460 is incompatible with the
465 cannot update paths with staged changes.
466 If changes have been staged with
468 these changes must first be committed with
478 Switch the work tree's branch reference to the specified
480 before updating the work tree.
481 This option requires that all paths in the work tree are updated.
483 Update the work tree to the specified
485 The expected argument is a commit ID SHA1 hash or an existing reference
486 or tag name which will be resolved to a commit ID.
487 An abbreviated hash argument will be expanded to a full SHA1 hash
488 automatically, provided the abbreviation is unique.
489 If this option is not specified, the most recent commit on the work tree's
495 .It Cm status Op Ar path ...
496 Show the current modification status of files in a work tree,
497 using the following status codes:
498 .Bl -column YXZ description
499 .It M Ta modified file
500 .It A Ta file scheduled for addition in next commit
501 .It D Ta file scheduled for deletion in next commit
502 .It C Ta modified or added file which contains merge conflicts
503 .It ! Ta versioned file was expected on disk but is missing
504 .It \(a~ Ta versioned file is obstructed by a non-regular file
505 .It ? Ta unversioned item not tracked by
507 .It m Ta modified file modes (executable bit only)
508 .It N Ta non-existent
510 specified on the command line
515 is specified, show modifications in the entire work tree.
516 Otherwise, show modifications at or within the specified paths.
518 If changes have been staged with
520 staged changes are shown in the second output column, using the following
522 .Bl -column YXZ description
523 .It M Ta file modification is staged
524 .It A Ta file addition is staged
525 .It D Ta file deletion is staged
528 Changes created on top of staged changes are indicated in the first column:
529 .Bl -column YXZ description
530 .It MM Ta file was modified after earlier changes have been staged
531 .It MA Ta file was modified after having been staged for addition
534 For compatibility with
545 files in each traversed directory and will not display unversioned files
546 which match these patterns.
551 supports consecutive asterisks,
553 which will match an arbitrary amount of directories.
557 only supports a single ignore pattern per line.
561 does not support negated ignore patterns prefixed with
563 and gives no special significance to the location of path component separators,
569 .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 Op Ar path
570 Display history of a repository.
573 is specified, show only commits which modified this path.
574 If invoked in a work tree, the
576 is interpreted relative to the current working directory,
577 and the work tree's path prefix is implicitly prepended.
578 Otherwise, the path is interpreted relative to the repository root.
585 Display individual commits which were merged into the current branch
589 shows the linear history of the current branch only.
591 Start traversing history at the specified
593 The expected argument is a commit ID SHA1 hash or an existing reference
594 or tag name which will be resolved to a commit ID.
595 An abbreviated hash argument will be expanded to a full SHA1 hash
596 automatically, provided the abbreviation is unique.
597 If this option is not specified, default to the work tree's current branch
598 if invoked in a work tree, or to the repository's HEAD reference.
600 Set the number of context lines shown in diffs with
602 By default, 3 lines of context are shown.
604 Limit history traversal to a given number of commits.
605 If this option is not specified, a default limit value of zero is used,
606 which is treated as an unbounded limit.
608 .Ev GOT_LOG_DEFAULT_LIMIT
609 environment variable may be set to change this default value.
611 Display the patch of modifications made in each commit.
614 is specified, only show the patch of modifications at or within this path.
615 .It Fl s Ar search-pattern
616 If specified, show only commits with a log message matched by the extended
619 Regular expression syntax is documented in
621 .It Fl r Ar repository-path
622 Use the repository at the specified path.
623 If not specified, assume the repository is located at or above the current
625 If this directory is a
627 work tree, use the repository path associated with this work tree.
629 .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
630 When invoked within a work tree with less than two arguments, display
631 uncommitted changes in the work tree.
634 is specified, only show changes within this path.
636 If two arguments are provided, treat each argument as a reference, a tag
637 name, or an object ID SHA1 hash, and display differences between the
638 corresponding objects.
639 Both objects must be of the same type (blobs, trees, or commits).
640 An abbreviated hash argument will be expanded to a full SHA1 hash
641 automatically, provided the abbreviation is unique.
648 Set the number of context lines shown in the diff.
649 By default, 3 lines of context are shown.
650 .It Fl r Ar repository-path
651 Use the repository at the specified path.
652 If not specified, assume the repository is located at or above the current
654 If this directory is a
656 work tree, use the repository path associated with this work tree.
658 Show changes staged with
660 instead of showing local changes.
661 This option is only valid when
663 is invoked in a work tree.
665 Ignore whitespace-only changes.
670 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
671 Display line-by-line history of a file at the specified path.
678 Start traversing history at the specified
680 The expected argument is a commit ID SHA1 hash or an existing reference
681 or tag name which will be resolved to a commit ID.
682 An abbreviated hash argument will be expanded to a full SHA1 hash
683 automatically, provided the abbreviation is unique.
684 .It Fl r Ar repository-path
685 Use the repository at the specified path.
686 If not specified, assume the repository is located at or above the current
688 If this directory is a
690 work tree, use the repository path associated with this work tree.
695 .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
696 Display a listing of files and directories at the specified
697 directory path in the repository.
698 Entries shown in this listing may carry one of the following trailing
700 .Bl -column YXZ description
701 .It @ Ta entry is a symbolic link
702 .It / Ta entry is a directory
703 .It * Ta entry is an executable file
704 .It $ Ta entry is a Git submodule
709 is specified, list the repository path corresponding to the current
710 directory of the work tree, or the root directory of the repository
711 if there is no work tree.
718 List files and directories as they appear in the specified
720 The expected argument is a commit ID SHA1 hash or an existing reference
721 or tag name which will be resolved to a commit ID.
722 An abbreviated hash argument will be expanded to a full SHA1 hash
723 automatically, provided the abbreviation is unique.
724 .It Fl r Ar repository-path
725 Use the repository at the specified path.
726 If not specified, assume the repository is located at or above the current
728 If this directory is a
730 work tree, use the repository path associated with this work tree.
732 Show object IDs of files (blob objects) and directories (tree objects).
734 Recurse into sub-directories in the repository.
739 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Oo Fl s Oc Op Ar name Ar target
740 Manage references in a repository.
742 If no options are passed, expect two arguments and attempt to create,
743 or update, the reference with the given
745 and make it point at the given
747 The name must be an absolute reference name, i.e. it must begin with
749 The target may be an object ID SHA1 hash or an existing reference which
750 will be resolved to an object ID.
751 An abbreviated hash argument will be expanded to a full SHA1 hash
752 automatically, provided the abbreviation is unique.
758 .It Fl r Ar repository-path
759 Use the repository at the specified path.
760 If not specified, assume the repository is located at or above the current
762 If this directory is a
764 work tree, use the repository path associated with this work tree.
766 List all existing references in the repository.
768 Delete the reference with the specified name from the repository.
770 Create a symbolic reference pointing at the specified
772 which must be an existing reference.
773 Care should be taken not to create loops between references when
776 .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
777 Create, list, or delete branches.
779 Branches are managed via references which live in the
784 command operates on references in this namespace only.
786 If invoked in a work tree without any arguments, print the name of the
787 work tree's current branch.
791 argument is passed, attempt to create a branch reference with the given name.
792 By default the new branch reference will point at the latest commit on the
793 work tree's current branch if invoked in a work tree, and otherwise to a commit
794 resolved via the repository's HEAD reference.
796 If invoked in a work tree, once the branch was created successfully
797 switch the work tree's head reference to the newly created branch and
798 update files across the entire work tree, just like
799 .Cm got update -b Ar name
801 Show the status of each affected file, using the following status codes:
802 .Bl -column YXZ description
803 .It U Ta file was updated and contained no local changes
804 .It G Ta file was updated and local changes were merged cleanly
805 .It C Ta file was updated and conflicts occurred during merge
806 .It D Ta file was deleted
807 .It A Ta new file was added
808 .It \(a~ Ta versioned file is obstructed by a non-regular file
809 .It ! Ta a missing versioned file was restored
817 Make a newly created branch reference point at the specified
821 argument is a commit ID SHA1 hash or an existing reference
822 or tag name which will be resolved to a commit ID.
823 .It Fl r Ar repository-path
824 Use the repository at the specified path.
825 If not specified, assume the repository is located at or above the current
827 If this directory is a
829 work tree, use the repository path associated with this work tree.
831 List all existing branches in the repository.
832 If invoked in a work tree, the work tree's current branch is shown
833 with one the following annotations:
834 .Bl -column YXZ description
835 .It * Ta work tree's base commit matches the branch tip
836 .It \(a~ Ta work tree's base commit is out-of-date
839 Delete the branch with the specified name from the repository.
840 Only the branch reference is deleted.
841 Any commit, tree, and blob objects belonging to the branch
842 remain in the repository and may be removed separately with
843 Git's garbage collector.
845 Do not switch and update the work tree after creating a new branch.
850 .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
851 Manage tags in a repository.
853 Tags are managed via references which live in the
858 command operates on references in this namespace only.
859 References in this namespace point at tag objects which contain a pointer
860 to another object, a tag message, as well as author and timestamp information.
862 Attempt to create a tag with the given
864 and make this tag point at the given
866 If no commit is specified, default to the latest commit on the work tree's
867 current branch if invoked in a work tree, and to a commit resolved via
868 the repository's HEAD reference otherwise.
875 Make the newly created tag reference point at the specified
879 argument is a commit ID SHA1 hash or an existing reference or tag name which
880 will be resolved to a commit ID.
881 An abbreviated hash argument will be expanded to a full SHA1 hash
882 automatically, provided the abbreviation is unique.
884 Use the specified tag message when creating the new tag.
889 opens a temporary file in an editor where a tag message can be written.
890 .It Fl r Ar repository-path
891 Use the repository at the specified path.
892 If not specified, assume the repository is located at or above the current
894 If this directory is a
896 work tree, use the repository path associated with this work tree.
898 List all existing tags in the repository instead of creating a new tag.
899 If this option is used, no other command-line arguments are allowed.
904 command will not delete tags or change existing tags.
905 If a tag must be deleted, the
907 command may be used to delete a tag's reference.
908 This should only be done if the tag has not already been copied to
910 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
911 Schedule unversioned files in a work tree for addition to the
912 repository in the next commit.
919 Permit recursion into directories.
920 If this option is not specified,
922 will refuse to run if a specified
926 With -R, add files even if they match a
930 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
931 Remove versioned files from a work tree and schedule them for deletion
932 from the repository in the next commit.
939 Perform the operation even if a file contains uncommitted modifications.
941 Keep affected files on disk.
943 Permit recursion into directories.
944 If this option is not specified,
946 will refuse to run if a specified
953 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
954 Revert any uncommitted changes in files at the specified paths.
955 File contents will be overwritten with those contained in the
956 work tree's base commit.
957 There is no way to bring discarded changes back after
960 If a file was added with
962 it will become an unversioned file again.
963 If a file was deleted with
972 Instead of reverting all changes in files, interactively select or reject
973 changes to revert based on
979 (quit reverting this file) responses.
980 If a file is in modified status, individual patches derived from the
981 modified file content can be reverted.
982 Files in added or deleted status may only be reverted in their entirety.
983 .It Fl F Ar response-script
991 responses line-by-line from the specified
993 file instead of prompting interactively.
995 Permit recursion into directories.
996 If this option is not specified,
998 will refuse to run if a specified
1005 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1006 Create a new commit in the repository from changes in a work tree
1007 and use this commit as the new base commit for the work tree.
1010 is specified, commit all changes in the work tree.
1011 Otherwise, commit changes at or within the specified paths.
1013 If changes have been explicitly staged for commit with
1015 only commit staged changes and reject any specified paths which
1016 have not been staged.
1018 Show the status of each affected file, using the following status codes:
1019 .Bl -column YXZ description
1020 .It M Ta modified file
1021 .It D Ta file was deleted
1022 .It A Ta new file was added
1023 .It m Ta modified file modes (executable bit only)
1026 Files which are not part of the new commit will retain their previously
1027 recorded base commit.
1030 commands may refuse to run while the work tree contains files from
1031 multiple base commits.
1032 The base commit of such a work tree can be made consistent by running
1034 across the entire work tree.
1038 command requires the
1040 environment variable to be set,
1045 configuration settings can be
1046 obtained from the repository's
1048 file or from Git's global
1057 Use the specified log message when creating the new commit.
1062 opens a temporary file in an editor where a log message can be written.
1066 will refuse to run if certain preconditions are not met.
1067 If the work tree's current branch is not in the
1069 reference namespace, new commits may not be created on this branch.
1070 Local changes may only be committed if they are based on file content
1071 found in the most recent commit on the work tree's branch.
1072 If a path is found to be out of date,
1074 must be used first in order to merge local changes with changes made
1079 .It Cm cherrypick Ar commit
1080 Merge changes from a single
1085 must be on a different branch than the work tree's base commit.
1086 The expected argument is a reference or a commit ID SHA1 hash.
1087 An abbreviated hash argument will be expanded to a full SHA1 hash
1088 automatically, provided the abbreviation is unique.
1090 Show the status of each affected file, using the following status codes:
1091 .Bl -column YXZ description
1092 .It G Ta file was merged
1093 .It C Ta file was merged and conflicts occurred during merge
1094 .It ! Ta changes destined for a missing file were not merged
1095 .It D Ta file was deleted
1096 .It d Ta file's deletion was obstructed by local modifications
1097 .It A Ta new file was added
1098 .It \(a~ Ta changes destined for a non-regular file were not merged
1101 The merged changes will appear as local changes in the work tree, which
1104 amended manually or with further
1109 or discarded again with
1113 will refuse to run if certain preconditions are not met.
1114 If the work tree contains multiple base commits it must first be updated
1115 to a single base commit with
1117 If the work tree already contains files with merge conflicts, these
1118 conflicts must be resolved first.
1122 .It Cm backout Ar commit
1123 Reverse-merge changes from a single
1128 must be on the same branch as the work tree's base commit.
1129 The expected argument is a reference or a commit ID SHA1 hash.
1130 An abbreviated hash argument will be expanded to a full SHA1 hash
1131 automatically, provided the abbreviation is unique.
1133 Show the status of each affected file, using the following status codes:
1134 .Bl -column YXZ description
1135 .It G Ta file was merged
1136 .It C Ta file was merged and conflicts occurred during merge
1137 .It ! Ta changes destined for a missing file were not merged
1138 .It D Ta file was deleted
1139 .It d Ta file's deletion was obstructed by local modifications
1140 .It A Ta new file was added
1141 .It \(a~ Ta changes destined for a non-regular file were not merged
1144 The reverse-merged changes will appear as local changes in the work tree,
1145 which may be viewed with
1147 amended manually or with further
1152 or discarded again with
1156 will refuse to run if certain preconditions are not met.
1157 If the work tree contains multiple base commits it must first be updated
1158 to a single base commit with
1160 If the work tree already contains files with merge conflicts, these
1161 conflicts must be resolved first.
1165 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1166 Rebase commits on the specified
1168 onto the tip of the current branch of the work tree.
1171 must share common ancestry with the work tree's current branch.
1172 Rebasing begins with the first descendant commit of the youngest
1173 common ancestor commit shared by the specified
1175 and the work tree's current branch, and stops once the tip commit
1182 is used as intended, the specified
1184 represents a local commit history and may already contain changes
1185 that are not yet visible in any other repositories.
1186 The work tree's current branch, which must be set with
1190 operation, represents a branch from a remote repository which shares
1191 a common history with the specified
1193 but has progressed, and perhaps diverged, due to commits added to the
1196 Rebased commits are accumulated on a temporary branch which the work tree
1197 will remain switched to throughout the entire rebase operation.
1198 Commits on this branch represent the same changes with the same log
1199 messages as their counterparts on the original
1201 but with different commit IDs.
1202 Once rebasing has completed successfully, the temporary branch becomes
1203 the new version of the specified
1205 and the work tree is automatically switched to it.
1207 While rebasing commits, show the status of each affected file,
1208 using the following status codes:
1209 .Bl -column YXZ description
1210 .It G Ta file was merged
1211 .It C Ta file was merged and conflicts occurred during merge
1212 .It ! Ta changes destined for a missing file were not merged
1213 .It D Ta file was deleted
1214 .It d Ta file's deletion was obstructed by local modifications
1215 .It A Ta new file was added
1216 .It \(a~ Ta changes destined for a non-regular file were not merged
1219 If merge conflicts occur the rebase operation is interrupted and may
1220 be continued once conflicts have been resolved.
1221 Alternatively, the rebase operation may be aborted which will leave
1223 unmodified and the work tree switched back to its original branch.
1225 If a merge conflict is resolved in a way which renders the merged
1226 change into a no-op change, the corresponding commit will be elided
1227 when the rebase operation continues.
1230 will refuse to run if certain preconditions are not met.
1231 If the work tree is not yet fully updated to the tip commit of its
1232 branch then the work tree must first be updated with
1234 If changes have been staged with
1236 these changes must first be committed with
1240 If the work tree contains local changes, these changes must first be
1247 contains changes to files outside of the work tree's path prefix,
1248 the work tree cannot be used to rebase this branch.
1254 commands will refuse to run while a rebase operation is in progress.
1255 Other commands which manipulate the work tree may be used for
1256 conflict resolution purposes.
1263 Abort an interrupted rebase operation.
1264 If this option is used, no other command-line arguments are allowed.
1266 Continue an interrupted rebase operation.
1267 If this option is used, no other command-line arguments are allowed.
1272 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1273 Edit commit history between the work tree's current base commit and
1274 the tip commit of the work tree's current branch.
1278 operation the work tree's current branch must be set with
1280 to the branch which should be edited, unless this branch is already the
1281 current branch of the work tree.
1282 The tip of this branch represents the upper bound (inclusive) of commits
1287 Furthermore, the work tree's base commit
1290 to a point in this branch's commit history where editing should begin.
1291 This commit represents the lower bound (non-inclusive) of commits touched
1296 Editing of commit history is controlled via a
1298 which can be written in an editor based on a template, passed on the
1299 command line, or generated with the
1301 option if only log messages need to be edited.
1303 The format of the histedit script is line-based.
1304 Each line in the script begins with a command name, followed by
1305 whitespace and an argument.
1306 For most commands, the expected argument is a commit ID SHA1 hash.
1307 Any remaining text on the line is ignored.
1308 Lines which begin with the
1310 character are ignored entirely.
1312 The available commands are as follows:
1313 .Bl -column YXZ pick-commit
1314 .It pick Ar commit Ta Use the specified commit as it is.
1315 .It edit Ar commit Ta Use the specified commit but once changes have been
1316 merged into the work tree interrupt the histedit operation for amending.
1317 .It fold Ar commit Ta Combine the specified commit with the next commit
1318 listed further below that will be used.
1319 .It drop Ar commit Ta Remove this commit from the edited history.
1320 .It mesg Ar log-message Ta Use the specified single-line log message for
1321 the commit on the previous line.
1322 If the log message argument is left empty, open an editor where a new
1323 log message can be written.
1326 Every commit in the history being edited must be mentioned in the script.
1327 Lines may be re-ordered to change the order of commits in the edited history.
1328 No commit may be listed more than once.
1330 Edited commits are accumulated on a temporary branch which the work tree
1331 will remain switched to throughout the entire histedit operation.
1332 Once history editing has completed successfully, the temporary branch becomes
1333 the new version of the work tree's branch and the work tree is automatically
1336 While merging commits, show the status of each affected file,
1337 using the following status codes:
1338 .Bl -column YXZ description
1339 .It G Ta file was merged
1340 .It C Ta file was merged and conflicts occurred during merge
1341 .It ! Ta changes destined for a missing file were not merged
1342 .It D Ta file was deleted
1343 .It d Ta file's deletion was obstructed by local modifications
1344 .It A Ta new file was added
1345 .It \(a~ Ta changes destined for a non-regular file were not merged
1348 If merge conflicts occur the histedit operation is interrupted and may
1349 be continued once conflicts have been resolved.
1350 Alternatively, the histedit operation may be aborted which will leave
1351 the work tree switched back to its original branch.
1353 If a merge conflict is resolved in a way which renders the merged
1354 change into a no-op change, the corresponding commit will be elided
1355 when the histedit operation continues.
1358 will refuse to run if certain preconditions are not met.
1359 If the work tree's current branch is not in the
1361 reference namespace, the history of the branch may not be edited.
1362 If the work tree contains multiple base commits it must first be updated
1363 to a single base commit with
1365 If changes have been staged with
1367 these changes must first be committed with
1371 If the work tree contains local changes, these changes must first be
1376 If the edited history contains changes to files outside of the work tree's
1377 path prefix, the work tree cannot be used to edit the history of this branch.
1384 commands will refuse to run while a histedit operation is in progress.
1385 Other commands which manipulate the work tree may be used, and the
1387 command may be used to commit arbitrary changes to the temporary branch
1388 while the histedit operation is interrupted.
1395 Abort an interrupted histedit operation.
1396 If this option is used, no other command-line arguments are allowed.
1398 Continue an interrupted histedit operation.
1399 If this option is used, no other command-line arguments are allowed.
1400 .It Fl F Ar histedit-script
1403 instead of opening a temporary file in an editor where a histedit script
1406 Edit log messages only.
1407 This option is a quick equivalent to a histedit script which edits
1408 only log messages but otherwise leaves every picked commit as-is.
1411 option can only be used when starting a new histedit operation.
1412 If this option is used, no other command-line arguments are allowed.
1417 .It Cm integrate Ar branch
1418 Integrate the specified
1420 into the work tree's current branch.
1421 Files in the work tree are updated to match the contents on the integrated
1423 and the reference of the work tree's branch is changed to point at the
1424 head commit of the integrated
1427 Both branches can be considered equivalent after integration since they
1428 will be pointing at the same commit.
1429 Both branches remain available for future work, if desired.
1430 In case the integrated
1432 is no longer needed it may be deleted with
1435 Show the status of each affected file, using the following status codes:
1436 .Bl -column YXZ description
1437 .It U Ta file was updated
1438 .It D Ta file was deleted
1439 .It A Ta new file was added
1440 .It \(a~ Ta versioned file is obstructed by a non-regular file
1441 .It ! Ta a missing versioned file was restored
1445 will refuse to run if certain preconditions are not met.
1446 Most importantly, the
1448 must have been rebased onto the work tree's current branch with
1450 before it can be integrated, in order to linearize commit history and
1451 resolve merge conflicts.
1452 If the work tree contains multiple base commits it must first be updated
1453 to a single base commit with
1455 If changes have been staged with
1457 these changes must first be committed with
1461 If the work tree contains local changes, these changes must first be
1469 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1470 Stage local changes for inclusion in the next commit.
1473 is specified, stage all changes in the work tree.
1474 Otherwise, stage changes at or within the specified paths.
1475 Paths may be staged if they are added, modified, or deleted according to
1478 Show the status of each affected file, using the following status codes:
1479 .Bl -column YXZ description
1480 .It A Ta file addition has been staged
1481 .It M Ta file modification has been staged
1482 .It D Ta file deletion has been staged
1485 Staged file contents are saved in newly created blob objects in the repository.
1486 These blobs will be referred to by tree objects once staged changes have been
1489 Staged changes affect the behaviour of
1494 While paths with staged changes exist, the
1496 command will refuse to commit any paths which do not have staged changes.
1497 Local changes created on top of staged changes can only be committed if
1498 the path is staged again, or if the staged changes are committed first.
1501 command will show both local changes and staged changes.
1504 command is able to display local changes relative to staged changes,
1505 and to display staged changes relative to the repository.
1508 command cannot revert staged changes but may be used to revert
1509 local changes created on top of staged changes.
1516 Instead of staging new changes, list paths which are already staged,
1517 along with the IDs of staged blob objects and stage status codes.
1518 If paths were provided in the command line show the staged paths
1519 among the specified paths.
1520 Otherwise, show all staged paths.
1522 Instead of staging the entire content of a changed file, interactively
1523 select or reject changes for staging based on
1527 (reject change), and
1529 (quit staging this file) responses.
1530 If a file is in modified status, individual patches derived from the
1531 modified file content can be staged.
1532 Files in added or deleted status may only be staged or rejected in
1534 .It Fl F Ar response-script
1542 responses line-by-line from the specified
1544 file instead of prompting interactively.
1548 will refuse to run if certain preconditions are not met.
1549 If a file contains merge conflicts, these conflicts must be resolved first.
1550 If a file is found to be out of date relative to the head commit on the
1551 work tree's current branch, the file must be updated with
1553 before it can be staged (however, this does not prevent the file from
1554 becoming out-of-date at some point after having been staged).
1561 commands will refuse to run while staged changes exist.
1562 If staged changes cannot be committed because a staged path
1563 is out of date, the path must be unstaged with
1565 before it can be updated with
1567 and may then be staged again if necessary.
1571 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1572 Merge staged changes back into the work tree and put affected paths
1573 back into non-staged status.
1576 is specified, unstage all staged changes across the entire work tree.
1577 Otherwise, unstage changes at or within the specified paths.
1579 Show the status of each affected file, using the following status codes:
1580 .Bl -column YXZ description
1581 .It G Ta file was unstaged
1582 .It C Ta file was unstaged and conflicts occurred during merge
1583 .It ! Ta changes destined for a missing file were not merged
1584 .It D Ta file was staged as deleted and still is deleted
1585 .It d Ta file's deletion was obstructed by local modifications
1586 .It \(a~ Ta changes destined for a non-regular file were not merged
1594 Instead of unstaging the entire content of a changed file, interactively
1595 select or reject changes for unstaging based on
1599 (keep change staged), and
1601 (quit unstaging this file) responses.
1602 If a file is staged in modified status, individual patches derived from the
1603 staged file content can be unstaged.
1604 Files staged in added or deleted status may only be unstaged in their entirety.
1605 .It Fl F Ar response-script
1613 responses line-by-line from the specified
1615 file instead of prompting interactively.
1620 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1621 Parse and print contents of objects to standard output in a line-based
1623 Content of commit, tree, and tag objects is printed in a way similar
1624 to the actual content stored in such objects.
1625 Blob object contents are printed as they would appear in files on disk.
1627 Attempt to interpret each argument as a reference, a tag name, or
1628 an object ID SHA1 hash.
1629 References will be resolved to an object ID.
1630 Tag names will resolved to a tag object.
1631 An abbreviated hash argument will be expanded to a full SHA1 hash
1632 automatically, provided the abbreviation is unique.
1634 If none of the above interpretations produce a valid result, or if the
1636 option is used, attempt to interpret the argument as a path which will
1637 be resolved to the ID of an object found at this path in the repository.
1644 Look up paths in the specified
1646 If this option is not used, paths are looked up in the commit resolved
1647 via the repository's HEAD reference.
1648 The expected argument is a commit ID SHA1 hash or an existing reference
1649 or tag name which will be resolved to a commit ID.
1650 An abbreviated hash argument will be expanded to a full SHA1 hash
1651 automatically, provided the abbreviation is unique.
1652 .It Fl r Ar repository-path
1653 Use the repository at the specified path.
1654 If not specified, assume the repository is located at or above the current
1656 If this directory is a
1658 work tree, use the repository path associated with this work tree.
1660 Interpret all arguments as paths only.
1661 This option can be used to resolve ambiguity in cases where paths
1662 look like tag names, reference names, or object IDs.
1666 .Bl -tag -width GOT_AUTHOR
1668 The author's name and email address for
1673 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1676 may fail to parse commits without an email address in author data,
1680 environment variables with a missing email address.
1686 configuration settings in the repository's
1688 file will override the value of
1694 configuration settings contained in Git's global
1696 configuration file will be used only if the
1698 environment variable is
1701 .It Ev VISUAL , EDITOR
1702 The editor spawned by
1707 .It Ev GOT_LOG_DEFAULT_LIMIT
1708 The default limit on the number of commits traversed by
1710 If set to zero, the limit is unbounded.
1711 This variable will be silently ignored if it is set to a non-numeric value.
1712 .It Ev GOT_FETCH_DEBUG
1713 Enables protocol tracing on standard error output during
1721 Clone an existing Git repository for use with
1725 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1727 Use of HTTP URLs currently requires
1731 .Dl $ git clone --bare https://github.com/openbsd/src.git
1733 Alternatively, for quick and dirty local testing of
1735 a new Git repository could be created and populated with files,
1736 e.g. from a temporary CVS checkout located at
1739 .Dl $ got init /var/git/src.git
1740 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1742 Check out a work tree from the Git repository to /usr/src:
1744 .Dl $ got checkout /var/git/src.git /usr/src
1746 View local changes in a work tree directory:
1749 .Dl $ got diff | less
1751 Interactively revert selected local changes in a work tree directory:
1753 .Dl $ got revert -p -R\ .
1755 In a work tree or a git repository directory, list all branch references:
1759 In a work tree or a git repository directory, create a new branch called
1760 .Dq unified-buffer-cache
1761 which is forked off the
1765 .Dl $ got branch unified-buffer-cache master
1767 Switch an existing work tree to the branch
1768 .Dq unified-buffer-cache .
1769 Local changes in the work tree will be preserved and merged if necessary:
1771 .Dl $ got update -b unified-buffer-cache
1773 Create a new commit from local changes in a work tree directory.
1774 This new commit will become the head commit of the work tree's current branch:
1778 In a work tree or a git repository directory, view changes committed in
1779 the 3 most recent commits to the work tree's branch, or the branch resolved
1780 via the repository's HEAD reference, respectively:
1782 .Dl $ got log -p -l 3
1784 In a work tree or a git repository directory, log the history of a subdirectory:
1786 .Dl $ got log sys/uvm
1788 While operating inside a work tree, paths are specified relative to the current
1789 working directory, so this command will log the subdirectory
1792 .Dl $ cd sys/uvm && got log '.'
1794 And this command has the same effect:
1796 .Dl $ cd sys/dev/usb && got log ../../uvm
1798 Add new files and remove obsolete files in a work tree directory:
1800 .Dl $ got add sys/uvm/uvm_ubc.c
1801 .Dl $ got remove sys/uvm/uvm_vnode.c
1803 Create a new commit from local changes in a work tree directory
1804 with a pre-defined log message.
1806 .Dl $ got commit -m 'unify the buffer cache'
1808 Update any work tree checked out from the
1809 .Dq unified-buffer-cache
1810 branch to the latest commit on this branch:
1814 Roll file content on the unified-buffer-cache branch back by one commit,
1815 and then fetch the rolled-back change into the work tree as a local change
1816 to be amended and perhaps committed again:
1818 .Dl $ got backout unified-buffer-cache
1819 .Dl $ got commit -m 'roll back previous'
1820 .Dl $ # now back out the previous backout :-)
1821 .Dl $ got backout unified-buffer-cache
1823 Fetch new upstream commits into the local repository's
1830 In a repository created with a HTTP URL and
1831 .Cm git clone --bare
1834 command must be used instead:
1836 .Dl $ cd /var/git/src.git
1837 .Dl $ git fetch origin master:refs/remotes/origin/master
1841 branch to merge the new changes that are now visible on the
1846 .Dl $ got update -b origin/master
1847 .Dl $ got rebase master
1850 .Dq unified-buffer-cache
1851 branch on top of the new head commit of the
1855 .Dl $ got update -b master
1856 .Dl $ got rebase unified-buffer-cache
1858 Create a patch from all changes on the unified-buffer-cache branch.
1859 The patch can be mailed out for review and applied to
1863 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1865 Edit the entire commit history of the
1866 .Dq unified-buffer-cache
1869 .Dl $ got update -b unified-buffer-cache
1870 .Dl $ got update -c master
1873 In order to merge changes committed to the
1874 .Dq unified-buffer-cache
1875 branch back into the
1878 .Dq unified-buffer-cache
1879 branch must first be rebased onto the
1883 .Dl $ got update -b master
1884 .Dl $ got rebase unified-buffer-cache
1887 .Dq unified-buffer-cache
1888 branch can now be made visible on the
1892 Because the rebase operation switched the work tree to the
1893 .Dq unified-buffer-cache
1894 branch, the work tree must be switched back to the
1897 .Dq unified-buffer-cache
1898 branch can be integrated into
1901 .Dl $ got update -b master
1902 .Dl $ got integrate unified-buffer-cache
1904 Additional steps may be necessary if local changes need to be pushed back
1905 to the remote repository, which currently requires
1907 Before working against existing branches in a repository cloned with
1908 .Cm git clone --bare
1913 must be configured to map all references in the remote repository
1916 namespace of the local repository.
1917 This can achieved by setting Git's
1918 .Pa remote.origin.fetch
1919 configuration variable to the value
1920 .Dq +refs/heads/*:refs/remotes/origin/*
1925 .Dl $ cd /var/git/repo
1926 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1929 option must be disabled:
1931 .Dl $ cd /var/git/repo
1932 .Dl $ git config remote.origin.mirror false
1934 Alternatively, the following
1936 configuration item can be added manually to the Git repository's
1940 .Dl [remote "origin"]
1942 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1945 This configuration leaves the local repository's
1947 namespace free for use by local branches checked out with
1949 and, if needed, created with
1954 namespace can now be updated with incoming changes from the remote
1959 without extra command line arguments:
1961 .Dl $ cd /var/git/repo
1964 To make changes fetched from the remote repository appear on the
1968 branch must be rebased onto the
1971 This will also merge local changes, if any, with the incoming changes:
1973 .Dl $ got update -b origin/master
1974 .Dl $ got rebase master
1978 branch, log messages for local changes can now be amended with
1980 by other developers and any other important new information:
1982 .Dl $ got update -c origin/master
1983 .Dl $ got histedit -m
1985 Local changes on the
1987 branch can then be pushed to the remote
1991 .Dl $ cd /var/git/repo
1992 .Dl $ git push origin master
1995 .Xr git-repository 5 ,
1998 .An Stefan Sperling Aq Mt stsp@openbsd.org
1999 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2000 .An Joshua Stein Aq Mt jcs@openbsd.org
2001 .An Ori Bernstein Aq Mt ori@openbsd.org
2004 is a work-in-progress and many commands remain to be implemented.
2005 At present, the user has to fall back on
2007 to perform many tasks, in particular tasks related to repository
2008 administration and tasks which require a network connection.
