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 q Oc Oo Fl v Oc Ar repository-URL Op Ar target-directory
140 Clone a Git repository at the specified
143 .Ar target-directory .
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, and a path to the repository
157 .Lk scheme://hostname/path/to/repository
159 The following protocol schemes are supported:
160 .Bl -tag -width git+ssh
162 The Git protocol as implemented by the
165 This protocol is discouraged since it supports neither authentication nor
168 The Git protocol wrapped in an authenticated and encrypted
171 With this protocol the hostname may contain an embedded username for
176 Short alias for git+ssh.
180 creates a remote repository entry in the
182 file of the cloned repository to store the
194 Create the cloned repository as a mirror of the original repository.
195 This is useful if the cloned repository will not be used to store
196 local changes as created by
201 file will be set up with the
203 option enabled, such that
207 will write incoming changes directly to branches in the
209 reference namespace, rather than to branches in the
212 This avoids the usual requirement of having to run
216 in order to make incoming changes appear on branches in the
219 But maintaining custom branches with local changes in the cloned
220 repository becomes difficult since local changes are at risk of
221 being discarded whenever incoming changes are fetched.
223 Suppress progress reporting output.
224 The same option will be passed to
228 Increase the verbosity of progress reporting output.
229 The same option will be passed to
232 Multiple -v options increase the verbosity.
238 .It Cm fetch Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository-name
239 Fetch new changes from a remote repository.
241 .Ar remote-repository-name
242 is specified the name
245 The remote repository's URL is obtained from the corresponding entry in the
247 file of the repository, as created by
250 Branch references in the
252 reference namespace will be updated to point at the newly fetched commits,
255 command can then be used to make new changes visible on branches in the
257 reference namespace, merging incoming changes with local changes as necessary.
259 However, if the repository is configured as a mirror then all references will
260 be updated as needed to match the corresponding references in the remote
261 repository, including branches in the
264 If those branches contained local commits, these will no longer be reachable
265 via a reference and will therefore be at risk of being discarded by Git's
268 In any case, existing references in the
270 namespace will always be changed to match tags contained in the remote
277 .It Fl r Ar repository-path
278 Use the repository at the specified path.
279 If not specified, assume the repository is located at or above the current
281 If this directory is a
283 work tree, use the repository path associated with this work tree.
285 Suppress progress reporting output.
286 The same option will be passed to
290 Increase the verbosity of progress reporting output.
291 The same option will be passed to
294 Multiple -v options increase the verbosity.
300 .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
301 Copy files from a repository into a new work tree.
302 Show the status of each affected file, using the following status codes:
303 .Bl -column YXZ description
304 .It A Ta new file was added
305 .It E Ta file already exists in work tree's meta-data
310 is not specified, either use the last component of
311 .Ar repository path ,
314 was specified use the last component of
322 Proceed with the checkout operation even if the directory at
325 Existing files will be left intact.
327 Check out files from a commit on the specified
329 If this option is not specified, a branch resolved via the repository's HEAD
330 reference will be used.
332 Check out files from the specified
334 on the selected branch.
335 The expected argument is a commit ID SHA1 hash or an existing reference
336 or tag name which will be resolved to a commit ID.
337 An abbreviated hash argument will be expanded to a full SHA1 hash
338 automatically, provided the abbreviation is unique.
339 If this option is not specified, the most recent commit on the selected
344 is not contained in the selected branch, a different branch which contains
345 this commit must be specified with the
348 If no such branch is known a new branch must be created for this
354 Checking out work trees with an unknown branch is intentionally not supported.
355 .It Fl p Ar path-prefix
356 Restrict the work tree to a subset of the repository's tree hierarchy.
357 Only files beneath the specified
364 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
365 Update an existing work tree to a different commit.
366 Show the status of each affected file, using the following status codes:
367 .Bl -column YXZ description
368 .It U Ta file was updated and contained no local changes
369 .It G Ta file was updated and local changes were merged cleanly
370 .It C Ta file was updated and conflicts occurred during merge
371 .It D Ta file was deleted
372 .It A Ta new file was added
373 .It \(a~ Ta versioned file is obstructed by a non-regular file
374 .It ! Ta a missing versioned file was restored
379 is specified, update the entire work tree.
380 Otherwise, restrict the update operation to files at or within the
382 Each path is required to exist in the update operation's target commit.
383 Files in the work tree outside specified paths will remain unchanged and
384 will retain their previously recorded base commit.
387 commands may refuse to run while the work tree contains files from
388 multiple base commits.
389 The base commit of such a work tree can be made consistent by running
391 across the entire work tree.
394 is incompatible with the
399 cannot update paths with staged changes.
400 If changes have been staged with
402 these changes must first be committed with
412 Switch the work tree's branch reference to the specified
414 before updating the work tree.
415 This option requires that all paths in the work tree are updated.
417 Update the work tree to the specified
419 The expected argument is a commit ID SHA1 hash or an existing reference
420 or tag name which will be resolved to a commit ID.
421 An abbreviated hash argument will be expanded to a full SHA1 hash
422 automatically, provided the abbreviation is unique.
423 If this option is not specified, the most recent commit on the work tree's
429 .It Cm status Op Ar path ...
430 Show the current modification status of files in a work tree,
431 using the following status codes:
432 .Bl -column YXZ description
433 .It M Ta modified file
434 .It A Ta file scheduled for addition in next commit
435 .It D Ta file scheduled for deletion in next commit
436 .It C Ta modified or added file which contains merge conflicts
437 .It ! Ta versioned file was expected on disk but is missing
438 .It \(a~ Ta versioned file is obstructed by a non-regular file
439 .It ? Ta unversioned item not tracked by
441 .It m Ta modified file modes (executable bit only)
442 .It N Ta non-existent
444 specified on the command line
449 is specified, show modifications in the entire work tree.
450 Otherwise, show modifications at or within the specified paths.
452 If changes have been staged with
454 staged changes are shown in the second output column, using the following
456 .Bl -column YXZ description
457 .It M Ta file modification is staged
458 .It A Ta file addition is staged
459 .It D Ta file deletion is staged
462 Changes created on top of staged changes are indicated in the first column:
463 .Bl -column YXZ description
464 .It MM Ta file was modified after earlier changes have been staged
465 .It MA Ta file was modified after having been staged for addition
468 For compatibility with
479 files in each traversed directory and will not display unversioned files
480 which match these patterns.
485 supports consecutive asterisks,
487 which will match an arbitrary amount of directories.
491 only supports a single ignore pattern per line.
495 does not support negated ignore patterns prefixed with
497 and gives no special significance to the location of path component separators,
503 .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
504 Display history of a repository.
507 is specified, show only commits which modified this path.
508 If invoked in a work tree, the
510 is interpreted relative to the current working directory,
511 and the work tree's path prefix is implicitly prepended.
512 Otherwise, the path is interpreted relative to the repository root.
519 Display individual commits which were merged into the current branch
523 shows the linear history of the current branch only.
525 Start traversing history at the specified
527 The expected argument is a commit ID SHA1 hash or an existing reference
528 or tag name which will be resolved to a commit ID.
529 An abbreviated hash argument will be expanded to a full SHA1 hash
530 automatically, provided the abbreviation is unique.
531 If this option is not specified, default to the work tree's current branch
532 if invoked in a work tree, or to the repository's HEAD reference.
534 Set the number of context lines shown in diffs with
536 By default, 3 lines of context are shown.
538 Limit history traversal to a given number of commits.
539 If this option is not specified, a default limit value of zero is used,
540 which is treated as an unbounded limit.
542 .Ev GOT_LOG_DEFAULT_LIMIT
543 environment variable may be set to change this default value.
545 Display the patch of modifications made in each commit.
548 is specified, only show the patch of modifications at or within this path.
549 .It Fl s Ar search-pattern
550 If specified, show only commits with a log message matched by the extended
553 Regular expression syntax is documented in
555 .It Fl r Ar repository-path
556 Use the repository at the specified path.
557 If not specified, assume the repository is located at or above the current
559 If this directory is a
561 work tree, use the repository path associated with this work tree.
563 .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
564 When invoked within a work tree with less than two arguments, display
565 uncommitted changes in the work tree.
568 is specified, only show changes within this path.
570 If two arguments are provided, treat each argument as a reference, a tag
571 name, or an object ID SHA1 hash, and display differences between the
572 corresponding objects.
573 Both objects must be of the same type (blobs, trees, or commits).
574 An abbreviated hash argument will be expanded to a full SHA1 hash
575 automatically, provided the abbreviation is unique.
582 Set the number of context lines shown in the diff.
583 By default, 3 lines of context are shown.
584 .It Fl r Ar repository-path
585 Use the repository at the specified path.
586 If not specified, assume the repository is located at or above the current
588 If this directory is a
590 work tree, use the repository path associated with this work tree.
592 Show changes staged with
594 instead of showing local changes.
595 This option is only valid when
597 is invoked in a work tree.
599 Ignore whitespace-only changes.
604 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
605 Display line-by-line history of a file at the specified path.
612 Start traversing history at the specified
614 The expected argument is a commit ID SHA1 hash or an existing reference
615 or tag name which will be resolved to a commit ID.
616 An abbreviated hash argument will be expanded to a full SHA1 hash
617 automatically, provided the abbreviation is unique.
618 .It Fl r Ar repository-path
619 Use the repository at the specified path.
620 If not specified, assume the repository is located at or above the current
622 If this directory is a
624 work tree, use the repository path associated with this work tree.
629 .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
630 Display a listing of files and directories at the specified
631 directory path in the repository.
632 Entries shown in this listing may carry one of the following trailing
634 .Bl -column YXZ description
635 .It @ Ta entry is a symbolic link
636 .It / Ta entry is a directory
637 .It * Ta entry is an executable file
638 .It $ Ta entry is a Git submodule
643 is specified, list the repository path corresponding to the current
644 directory of the work tree, or the root directory of the repository
645 if there is no work tree.
652 List files and directories as they appear in the specified
654 The expected argument is a commit ID SHA1 hash or an existing reference
655 or tag name which will be resolved to a commit ID.
656 An abbreviated hash argument will be expanded to a full SHA1 hash
657 automatically, provided the abbreviation is unique.
658 .It Fl r Ar repository-path
659 Use the repository at the specified path.
660 If not specified, assume the repository is located at or above the current
662 If this directory is a
664 work tree, use the repository path associated with this work tree.
666 Show object IDs of files (blob objects) and directories (tree objects).
668 Recurse into sub-directories in the repository.
673 .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
674 Manage references in a repository.
676 If no options are passed, expect two arguments and attempt to create,
677 or update, the reference with the given
679 and make it point at the given
681 The name must be an absolute reference name, i.e. it must begin with
683 The target may be an object ID SHA1 hash or an existing reference which
684 will be resolved to an object ID.
685 An abbreviated hash argument will be expanded to a full SHA1 hash
686 automatically, provided the abbreviation is unique.
692 .It Fl r Ar repository-path
693 Use the repository at the specified path.
694 If not specified, assume the repository is located at or above the current
696 If this directory is a
698 work tree, use the repository path associated with this work tree.
700 List all existing references in the repository.
702 Delete the reference with the specified name from the repository.
704 Create a symbolic reference pointing at the specified
706 which must be an existing reference.
707 Care should be taken not to create loops between references when
710 .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
711 Create, list, or delete branches.
713 Branches are managed via references which live in the
718 command operates on references in this namespace only.
720 If invoked in a work tree without any arguments, print the name of the
721 work tree's current branch.
725 argument is passed, attempt to create a branch reference with the given name.
726 By default the new branch reference will point at the latest commit on the
727 work tree's current branch if invoked in a work tree, and otherwise to a commit
728 resolved via the repository's HEAD reference.
730 If invoked in a work tree, once the branch was created successfully
731 switch the work tree's head reference to the newly created branch and
732 update files across the entire work tree, just like
733 .Cm got update -b Ar name
735 Show the status of each affected file, using the following status codes:
736 .Bl -column YXZ description
737 .It U Ta file was updated and contained no local changes
738 .It G Ta file was updated and local changes were merged cleanly
739 .It C Ta file was updated and conflicts occurred during merge
740 .It D Ta file was deleted
741 .It A Ta new file was added
742 .It \(a~ Ta versioned file is obstructed by a non-regular file
743 .It ! Ta a missing versioned file was restored
751 Make a newly created branch reference point at the specified
755 argument is a commit ID SHA1 hash or an existing reference
756 or tag name which will be resolved to a commit ID.
757 .It Fl r Ar repository-path
758 Use the repository at the specified path.
759 If not specified, assume the repository is located at or above the current
761 If this directory is a
763 work tree, use the repository path associated with this work tree.
765 List all existing branches in the repository.
766 If invoked in a work tree, the work tree's current branch is shown
767 with one the following annotations:
768 .Bl -column YXZ description
769 .It * Ta work tree's base commit matches the branch tip
770 .It \(a~ Ta work tree's base commit is out-of-date
773 Delete the branch with the specified name from the repository.
774 Only the branch reference is deleted.
775 Any commit, tree, and blob objects belonging to the branch
776 remain in the repository and may be removed separately with
777 Git's garbage collector.
779 Do not switch and update the work tree after creating a new branch.
784 .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
785 Manage tags in a repository.
787 Tags are managed via references which live in the
792 command operates on references in this namespace only.
793 References in this namespace point at tag objects which contain a pointer
794 to another object, a tag message, as well as author and timestamp information.
796 Attempt to create a tag with the given
798 and make this tag point at the given
800 If no commit is specified, default to the latest commit on the work tree's
801 current branch if invoked in a work tree, and to a commit resolved via
802 the repository's HEAD reference otherwise.
809 Make the newly created tag reference point at the specified
813 argument is a commit ID SHA1 hash or an existing reference or tag name which
814 will be resolved to a commit ID.
815 An abbreviated hash argument will be expanded to a full SHA1 hash
816 automatically, provided the abbreviation is unique.
818 Use the specified tag message when creating the new tag.
823 opens a temporary file in an editor where a tag message can be written.
824 .It Fl r Ar repository-path
825 Use the repository at the specified path.
826 If not specified, assume the repository is located at or above the current
828 If this directory is a
830 work tree, use the repository path associated with this work tree.
832 List all existing tags in the repository instead of creating a new tag.
833 If this option is used, no other command-line arguments are allowed.
838 command will not delete tags or change existing tags.
839 If a tag must be deleted, the
841 command may be used to delete a tag's reference.
842 This should only be done if the tag has not already been copied to
844 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
845 Schedule unversioned files in a work tree for addition to the
846 repository in the next commit.
853 Permit recursion into directories.
854 If this option is not specified,
856 will refuse to run if a specified
860 With -R, add files even if they match a
864 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
865 Remove versioned files from a work tree and schedule them for deletion
866 from the repository in the next commit.
873 Perform the operation even if a file contains uncommitted modifications.
875 Keep affected files on disk.
877 Permit recursion into directories.
878 If this option is not specified,
880 will refuse to run if a specified
887 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
888 Revert any uncommitted changes in files at the specified paths.
889 File contents will be overwritten with those contained in the
890 work tree's base commit.
891 There is no way to bring discarded changes back after
894 If a file was added with
896 it will become an unversioned file again.
897 If a file was deleted with
906 Instead of reverting all changes in files, interactively select or reject
907 changes to revert based on
913 (quit reverting this file) responses.
914 If a file is in modified status, individual patches derived from the
915 modified file content can be reverted.
916 Files in added or deleted status may only be reverted in their entirety.
917 .It Fl F Ar response-script
925 responses line-by-line from the specified
927 file instead of prompting interactively.
929 Permit recursion into directories.
930 If this option is not specified,
932 will refuse to run if a specified
939 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
940 Create a new commit in the repository from changes in a work tree
941 and use this commit as the new base commit for the work tree.
944 is specified, commit all changes in the work tree.
945 Otherwise, commit changes at or within the specified paths.
947 If changes have been explicitly staged for commit with
949 only commit staged changes and reject any specified paths which
950 have not been staged.
952 Show the status of each affected file, using the following status codes:
953 .Bl -column YXZ description
954 .It M Ta modified file
955 .It D Ta file was deleted
956 .It A Ta new file was added
957 .It m Ta modified file modes (executable bit only)
960 Files which are not part of the new commit will retain their previously
961 recorded base commit.
964 commands may refuse to run while the work tree contains files from
965 multiple base commits.
966 The base commit of such a work tree can be made consistent by running
968 across the entire work tree.
974 environment variable to be set,
979 configuration settings can be
980 obtained from the repository's
982 file or from Git's global
991 Use the specified log message when creating the new commit.
996 opens a temporary file in an editor where a log message can be written.
1000 will refuse to run if certain preconditions are not met.
1001 If the work tree's current branch is not in the
1003 reference namespace, new commits may not be created on this branch.
1004 Local changes may only be committed if they are based on file content
1005 found in the most recent commit on the work tree's branch.
1006 If a path is found to be out of date,
1008 must be used first in order to merge local changes with changes made
1013 .It Cm cherrypick Ar commit
1014 Merge changes from a single
1019 must be on a different branch than the work tree's base commit.
1020 The expected argument is a reference or a commit ID SHA1 hash.
1021 An abbreviated hash argument will be expanded to a full SHA1 hash
1022 automatically, provided the abbreviation is unique.
1024 Show the status of each affected file, using the following status codes:
1025 .Bl -column YXZ description
1026 .It G Ta file was merged
1027 .It C Ta file was merged and conflicts occurred during merge
1028 .It ! Ta changes destined for a missing file were not merged
1029 .It D Ta file was deleted
1030 .It d Ta file's deletion was obstructed by local modifications
1031 .It A Ta new file was added
1032 .It \(a~ Ta changes destined for a non-regular file were not merged
1035 The merged changes will appear as local changes in the work tree, which
1038 amended manually or with further
1043 or discarded again with
1047 will refuse to run if certain preconditions are not met.
1048 If the work tree contains multiple base commits it must first be updated
1049 to a single base commit with
1051 If the work tree already contains files with merge conflicts, these
1052 conflicts must be resolved first.
1056 .It Cm backout Ar commit
1057 Reverse-merge changes from a single
1062 must be on the same branch as the work tree's base commit.
1063 The expected argument is a reference or a commit ID SHA1 hash.
1064 An abbreviated hash argument will be expanded to a full SHA1 hash
1065 automatically, provided the abbreviation is unique.
1067 Show the status of each affected file, using the following status codes:
1068 .Bl -column YXZ description
1069 .It G Ta file was merged
1070 .It C Ta file was merged and conflicts occurred during merge
1071 .It ! Ta changes destined for a missing file were not merged
1072 .It D Ta file was deleted
1073 .It d Ta file's deletion was obstructed by local modifications
1074 .It A Ta new file was added
1075 .It \(a~ Ta changes destined for a non-regular file were not merged
1078 The reverse-merged changes will appear as local changes in the work tree,
1079 which may be viewed with
1081 amended manually or with further
1086 or discarded again with
1090 will refuse to run if certain preconditions are not met.
1091 If the work tree contains multiple base commits it must first be updated
1092 to a single base commit with
1094 If the work tree already contains files with merge conflicts, these
1095 conflicts must be resolved first.
1099 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1100 Rebase commits on the specified
1102 onto the tip of the current branch of the work tree.
1105 must share common ancestry with the work tree's current branch.
1106 Rebasing begins with the first descendant commit of the youngest
1107 common ancestor commit shared by the specified
1109 and the work tree's current branch, and stops once the tip commit
1116 is used as intended, the specified
1118 represents a local commit history and may already contain changes
1119 that are not yet visible in any other repositories.
1120 The work tree's current branch, which must be set with
1124 operation, represents a branch from a remote repository which shares
1125 a common history with the specified
1127 but has progressed, and perhaps diverged, due to commits added to the
1130 Rebased commits are accumulated on a temporary branch which the work tree
1131 will remain switched to throughout the entire rebase operation.
1132 Commits on this branch represent the same changes with the same log
1133 messages as their counterparts on the original
1135 but with different commit IDs.
1136 Once rebasing has completed successfully, the temporary branch becomes
1137 the new version of the specified
1139 and the work tree is automatically switched to it.
1141 While rebasing commits, show the status of each affected file,
1142 using the following status codes:
1143 .Bl -column YXZ description
1144 .It G Ta file was merged
1145 .It C Ta file was merged and conflicts occurred during merge
1146 .It ! Ta changes destined for a missing file were not merged
1147 .It D Ta file was deleted
1148 .It d Ta file's deletion was obstructed by local modifications
1149 .It A Ta new file was added
1150 .It \(a~ Ta changes destined for a non-regular file were not merged
1153 If merge conflicts occur the rebase operation is interrupted and may
1154 be continued once conflicts have been resolved.
1155 Alternatively, the rebase operation may be aborted which will leave
1157 unmodified and the work tree switched back to its original branch.
1159 If a merge conflict is resolved in a way which renders the merged
1160 change into a no-op change, the corresponding commit will be elided
1161 when the rebase operation continues.
1164 will refuse to run if certain preconditions are not met.
1165 If the work tree is not yet fully updated to the tip commit of its
1166 branch then the work tree must first be updated with
1168 If changes have been staged with
1170 these changes must first be committed with
1174 If the work tree contains local changes, these changes must first be
1181 contains changes to files outside of the work tree's path prefix,
1182 the work tree cannot be used to rebase this branch.
1188 commands will refuse to run while a rebase operation is in progress.
1189 Other commands which manipulate the work tree may be used for
1190 conflict resolution purposes.
1197 Abort an interrupted rebase operation.
1198 If this option is used, no other command-line arguments are allowed.
1200 Continue an interrupted rebase operation.
1201 If this option is used, no other command-line arguments are allowed.
1206 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1207 Edit commit history between the work tree's current base commit and
1208 the tip commit of the work tree's current branch.
1212 operation the work tree's current branch must be set with
1214 to the branch which should be edited, unless this branch is already the
1215 current branch of the work tree.
1216 The tip of this branch represents the upper bound (inclusive) of commits
1221 Furthermore, the work tree's base commit
1224 to a point in this branch's commit history where editing should begin.
1225 This commit represents the lower bound (non-inclusive) of commits touched
1230 Editing of commit history is controlled via a
1232 which can be written in an editor based on a template, passed on the
1233 command line, or generated with the
1235 option if only log messages need to be edited.
1237 The format of the histedit script is line-based.
1238 Each line in the script begins with a command name, followed by
1239 whitespace and an argument.
1240 For most commands, the expected argument is a commit ID SHA1 hash.
1241 Any remaining text on the line is ignored.
1242 Lines which begin with the
1244 character are ignored entirely.
1246 The available commands are as follows:
1247 .Bl -column YXZ pick-commit
1248 .It pick Ar commit Ta Use the specified commit as it is.
1249 .It edit Ar commit Ta Use the specified commit but once changes have been
1250 merged into the work tree interrupt the histedit operation for amending.
1251 .It fold Ar commit Ta Combine the specified commit with the next commit
1252 listed further below that will be used.
1253 .It drop Ar commit Ta Remove this commit from the edited history.
1254 .It mesg Ar log-message Ta Use the specified single-line log message for
1255 the commit on the previous line.
1256 If the log message argument is left empty, open an editor where a new
1257 log message can be written.
1260 Every commit in the history being edited must be mentioned in the script.
1261 Lines may be re-ordered to change the order of commits in the edited history.
1262 No commit may be listed more than once.
1264 Edited commits are accumulated on a temporary branch which the work tree
1265 will remain switched to throughout the entire histedit operation.
1266 Once history editing has completed successfully, the temporary branch becomes
1267 the new version of the work tree's branch and the work tree is automatically
1270 While merging commits, show the status of each affected file,
1271 using the following status codes:
1272 .Bl -column YXZ description
1273 .It G Ta file was merged
1274 .It C Ta file was merged and conflicts occurred during merge
1275 .It ! Ta changes destined for a missing file were not merged
1276 .It D Ta file was deleted
1277 .It d Ta file's deletion was obstructed by local modifications
1278 .It A Ta new file was added
1279 .It \(a~ Ta changes destined for a non-regular file were not merged
1282 If merge conflicts occur the histedit operation is interrupted and may
1283 be continued once conflicts have been resolved.
1284 Alternatively, the histedit operation may be aborted which will leave
1285 the work tree switched back to its original branch.
1287 If a merge conflict is resolved in a way which renders the merged
1288 change into a no-op change, the corresponding commit will be elided
1289 when the histedit operation continues.
1292 will refuse to run if certain preconditions are not met.
1293 If the work tree's current branch is not in the
1295 reference namespace, the history of the branch may not be edited.
1296 If the work tree contains multiple base commits it must first be updated
1297 to a single base commit with
1299 If changes have been staged with
1301 these changes must first be committed with
1305 If the work tree contains local changes, these changes must first be
1310 If the edited history contains changes to files outside of the work tree's
1311 path prefix, the work tree cannot be used to edit the history of this branch.
1318 commands will refuse to run while a histedit operation is in progress.
1319 Other commands which manipulate the work tree may be used, and the
1321 command may be used to commit arbitrary changes to the temporary branch
1322 while the histedit operation is interrupted.
1329 Abort an interrupted histedit operation.
1330 If this option is used, no other command-line arguments are allowed.
1332 Continue an interrupted histedit operation.
1333 If this option is used, no other command-line arguments are allowed.
1334 .It Fl F Ar histedit-script
1337 instead of opening a temporary file in an editor where a histedit script
1340 Edit log messages only.
1341 This option is a quick equivalent to a histedit script which edits
1342 only log messages but otherwise leaves every picked commit as-is.
1345 option can only be used when starting a new histedit operation.
1346 If this option is used, no other command-line arguments are allowed.
1351 .It Cm integrate Ar branch
1352 Integrate the specified
1354 into the work tree's current branch.
1355 Files in the work tree are updated to match the contents on the integrated
1357 and the reference of the work tree's branch is changed to point at the
1358 head commit of the integrated
1361 Both branches can be considered equivalent after integration since they
1362 will be pointing at the same commit.
1363 Both branches remain available for future work, if desired.
1364 In case the integrated
1366 is no longer needed it may be deleted with
1369 Show the status of each affected file, using the following status codes:
1370 .Bl -column YXZ description
1371 .It U Ta file was updated
1372 .It D Ta file was deleted
1373 .It A Ta new file was added
1374 .It \(a~ Ta versioned file is obstructed by a non-regular file
1375 .It ! Ta a missing versioned file was restored
1379 will refuse to run if certain preconditions are not met.
1380 Most importantly, the
1382 must have been rebased onto the work tree's current branch with
1384 before it can be integrated, in order to linearize commit history and
1385 resolve merge conflicts.
1386 If the work tree contains multiple base commits it must first be updated
1387 to a single base commit with
1389 If changes have been staged with
1391 these changes must first be committed with
1395 If the work tree contains local changes, these changes must first be
1403 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1404 Stage local changes for inclusion in the next commit.
1407 is specified, stage all changes in the work tree.
1408 Otherwise, stage changes at or within the specified paths.
1409 Paths may be staged if they are added, modified, or deleted according to
1412 Show the status of each affected file, using the following status codes:
1413 .Bl -column YXZ description
1414 .It A Ta file addition has been staged
1415 .It M Ta file modification has been staged
1416 .It D Ta file deletion has been staged
1419 Staged file contents are saved in newly created blob objects in the repository.
1420 These blobs will be referred to by tree objects once staged changes have been
1423 Staged changes affect the behaviour of
1428 While paths with staged changes exist, the
1430 command will refuse to commit any paths which do not have staged changes.
1431 Local changes created on top of staged changes can only be committed if
1432 the path is staged again, or if the staged changes are committed first.
1435 command will show both local changes and staged changes.
1438 command is able to display local changes relative to staged changes,
1439 and to display staged changes relative to the repository.
1442 command cannot revert staged changes but may be used to revert
1443 local changes created on top of staged changes.
1450 Instead of staging new changes, list paths which are already staged,
1451 along with the IDs of staged blob objects and stage status codes.
1452 If paths were provided in the command line show the staged paths
1453 among the specified paths.
1454 Otherwise, show all staged paths.
1456 Instead of staging the entire content of a changed file, interactively
1457 select or reject changes for staging based on
1461 (reject change), and
1463 (quit staging this file) responses.
1464 If a file is in modified status, individual patches derived from the
1465 modified file content can be staged.
1466 Files in added or deleted status may only be staged or rejected in
1468 .It Fl F Ar response-script
1476 responses line-by-line from the specified
1478 file instead of prompting interactively.
1482 will refuse to run if certain preconditions are not met.
1483 If a file contains merge conflicts, these conflicts must be resolved first.
1484 If a file is found to be out of date relative to the head commit on the
1485 work tree's current branch, the file must be updated with
1487 before it can be staged (however, this does not prevent the file from
1488 becoming out-of-date at some point after having been staged).
1495 commands will refuse to run while staged changes exist.
1496 If staged changes cannot be committed because a staged path
1497 is out of date, the path must be unstaged with
1499 before it can be updated with
1501 and may then be staged again if necessary.
1505 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1506 Merge staged changes back into the work tree and put affected paths
1507 back into non-staged status.
1510 is specified, unstage all staged changes across the entire work tree.
1511 Otherwise, unstage changes at or within the specified paths.
1513 Show the status of each affected file, using the following status codes:
1514 .Bl -column YXZ description
1515 .It G Ta file was unstaged
1516 .It C Ta file was unstaged and conflicts occurred during merge
1517 .It ! Ta changes destined for a missing file were not merged
1518 .It D Ta file was staged as deleted and still is deleted
1519 .It d Ta file's deletion was obstructed by local modifications
1520 .It \(a~ Ta changes destined for a non-regular file were not merged
1528 Instead of unstaging the entire content of a changed file, interactively
1529 select or reject changes for unstaging based on
1533 (keep change staged), and
1535 (quit unstaging this file) responses.
1536 If a file is staged in modified status, individual patches derived from the
1537 staged file content can be unstaged.
1538 Files staged in added or deleted status may only be unstaged in their entirety.
1539 .It Fl F Ar response-script
1547 responses line-by-line from the specified
1549 file instead of prompting interactively.
1554 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1555 Parse and print contents of objects to standard output in a line-based
1557 Content of commit, tree, and tag objects is printed in a way similar
1558 to the actual content stored in such objects.
1559 Blob object contents are printed as they would appear in files on disk.
1561 Attempt to interpret each argument as a reference, a tag name, or
1562 an object ID SHA1 hash.
1563 References will be resolved to an object ID.
1564 Tag names will resolved to a tag object.
1565 An abbreviated hash argument will be expanded to a full SHA1 hash
1566 automatically, provided the abbreviation is unique.
1568 If none of the above interpretations produce a valid result, or if the
1570 option is used, attempt to interpret the argument as a path which will
1571 be resolved to the ID of an object found at this path in the repository.
1578 Look up paths in the specified
1580 If this option is not used, paths are looked up in the commit resolved
1581 via the repository's HEAD reference.
1582 The expected argument is a commit ID SHA1 hash or an existing reference
1583 or tag name which will be resolved to a commit ID.
1584 An abbreviated hash argument will be expanded to a full SHA1 hash
1585 automatically, provided the abbreviation is unique.
1586 .It Fl r Ar repository-path
1587 Use the repository at the specified path.
1588 If not specified, assume the repository is located at or above the current
1590 If this directory is a
1592 work tree, use the repository path associated with this work tree.
1594 Interpret all arguments as paths only.
1595 This option can be used to resolve ambiguity in cases where paths
1596 look like tag names, reference names, or object IDs.
1600 .Bl -tag -width GOT_AUTHOR
1602 The author's name and email address for
1607 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1610 may fail to parse commits without an email address in author data,
1614 environment variables with a missing email address.
1620 configuration settings in the repository's
1622 file will override the value of
1628 configuration settings contained in Git's global
1630 configuration file will be used only if the
1632 environment variable is
1635 .It Ev VISUAL , EDITOR
1636 The editor spawned by
1641 .It Ev GOT_LOG_DEFAULT_LIMIT
1642 The default limit on the number of commits traversed by
1644 If set to zero, the limit is unbounded.
1645 This variable will be silently ignored if it is set to a non-numeric value.
1646 .It Ev GOT_FETCH_DEBUG
1647 Enables protocol tracing on standard error output during
1655 Clone an existing Git repository for use with
1659 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1661 Use of HTTP URLs currently requires
1665 .Dl $ git clone --bare https://github.com/openbsd/src.git
1667 Alternatively, for quick and dirty local testing of
1669 a new Git repository could be created and populated with files,
1670 e.g. from a temporary CVS checkout located at
1673 .Dl $ got init /var/git/src.git
1674 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1676 Check out a work tree from the Git repository to /usr/src:
1678 .Dl $ got checkout /var/git/src.git /usr/src
1680 View local changes in a work tree directory:
1683 .Dl $ got diff | less
1685 Interactively revert selected local changes in a work tree directory:
1687 .Dl $ got revert -p -R\ .
1689 In a work tree or a git repository directory, list all branch references:
1693 In a work tree or a git repository directory, create a new branch called
1694 .Dq unified-buffer-cache
1695 which is forked off the
1699 .Dl $ got branch unified-buffer-cache master
1701 Switch an existing work tree to the branch
1702 .Dq unified-buffer-cache .
1703 Local changes in the work tree will be preserved and merged if necessary:
1705 .Dl $ got update -b unified-buffer-cache
1707 Create a new commit from local changes in a work tree directory.
1708 This new commit will become the head commit of the work tree's current branch:
1712 In a work tree or a git repository directory, view changes committed in
1713 the 3 most recent commits to the work tree's branch, or the branch resolved
1714 via the repository's HEAD reference, respectively:
1716 .Dl $ got log -p -l 3
1718 In a work tree or a git repository directory, log the history of a subdirectory:
1720 .Dl $ got log sys/uvm
1722 While operating inside a work tree, paths are specified relative to the current
1723 working directory, so this command will log the subdirectory
1726 .Dl $ cd sys/uvm && got log '.'
1728 And this command has the same effect:
1730 .Dl $ cd sys/dev/usb && got log ../../uvm
1732 Add new files and remove obsolete files in a work tree directory:
1734 .Dl $ got add sys/uvm/uvm_ubc.c
1735 .Dl $ got remove sys/uvm/uvm_vnode.c
1737 Create a new commit from local changes in a work tree directory
1738 with a pre-defined log message.
1740 .Dl $ got commit -m 'unify the buffer cache'
1742 Update any work tree checked out from the
1743 .Dq unified-buffer-cache
1744 branch to the latest commit on this branch:
1748 Roll file content on the unified-buffer-cache branch back by one commit,
1749 and then fetch the rolled-back change into the work tree as a local change
1750 to be amended and perhaps committed again:
1752 .Dl $ got backout unified-buffer-cache
1753 .Dl $ got commit -m 'roll back previous'
1754 .Dl $ # now back out the previous backout :-)
1755 .Dl $ got backout unified-buffer-cache
1757 Fetch new upstream commits into the local repository's
1764 In a repository created with a HTTP URL and
1765 .Cm git clone --bare
1768 command must be used instead:
1770 .Dl $ cd /var/git/src.git
1771 .Dl $ git fetch origin master:refs/remotes/origin/master
1775 branch to merge the new changes that are now visible on the
1780 .Dl $ got update -b origin/master
1781 .Dl $ got rebase master
1784 .Dq unified-buffer-cache
1785 branch on top of the new head commit of the
1789 .Dl $ got update -b master
1790 .Dl $ got rebase unified-buffer-cache
1792 Create a patch from all changes on the unified-buffer-cache branch.
1793 The patch can be mailed out for review and applied to
1797 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1799 Edit the entire commit history of the
1800 .Dq unified-buffer-cache
1803 .Dl $ got update -b unified-buffer-cache
1804 .Dl $ got update -c master
1808 Additional steps may be necessary if local changes need to be pushed back
1809 to the remote repository, which currently requires
1811 Before working against existing branches in a repository cloned with
1812 .Cm git clone --bare
1817 must be configured to map all references in the remote repository
1820 namespace of the local repository.
1821 This can achieved by setting Git's
1822 .Pa remote.origin.fetch
1823 configuration variable to the value
1824 .Dq +refs/heads/*:refs/remotes/origin/*
1829 .Dl $ cd /var/git/repo
1830 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1833 option must be disabled:
1835 .Dl $ cd /var/git/repo
1836 .Dl $ git config remote.origin.mirror false
1838 Alternatively, the following
1840 configuration item can be added manually to the Git repository's
1844 .Dl [remote "origin"]
1846 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1849 This configuration leaves the local repository's
1851 namespace free for use by local branches checked out with
1853 and, if needed, created with
1858 namespace can now be updated with incoming changes from the remote
1863 without extra command line arguments:
1865 .Dl $ cd /var/git/repo
1868 To make changes fetched from the remote repository appear on the
1872 branch must be rebased onto the
1875 This will also merge local changes, if any, with the incoming changes:
1877 .Dl $ got update -b origin/master
1878 .Dl $ got rebase master
1882 branch, log messages for local changes can now be amended with
1884 by other developers and any other important new information:
1886 .Dl $ got update -c origin/master
1887 .Dl $ got histedit -m
1889 Local changes on the
1891 branch can then be pushed to the remote
1895 .Dl $ cd /var/git/repo
1896 .Dl $ git push origin master
1898 In order to merge changes committed to the
1899 .Dq unified-buffer-cache
1900 branch back into the
1903 .Dq unified-buffer-cache
1904 branch must first be rebased onto the
1908 .Dl $ got update -b master
1909 .Dl $ got rebase unified-buffer-cache
1912 .Dq unified-buffer-cache
1913 branch can now be made visible on the
1917 Because the rebase operation switched the work tree to the
1918 .Dq unified-buffer-cache
1919 branch, the work tree must be switched back to the
1922 .Dq unified-buffer-cache
1923 branch can be integrated into
1926 .Dl $ got update -b master
1927 .Dl $ got integrate unified-buffer-cache
1930 .Xr git-repository 5 ,
1933 .An Stefan Sperling Aq Mt stsp@openbsd.org
1934 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1935 .An Joshua Stein Aq Mt jcs@openbsd.org
1936 .An Ori Bernstein Aq Mt ori@openbsd.org
1939 is a work-in-progress and many commands remain to be implemented.
1940 At present, the user has to fall back on
1942 to perform many tasks, in particular tasks related to repository
1943 administration and tasks which require a network connection.
