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, 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 This protocol is discouraged since it supports neither authentication nor
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.
181 creates a remote repository entry in the
183 file of the cloned repository to store the
195 Create the cloned repository as a mirror of the original repository.
196 This is useful if the cloned repository will not be used to store
197 local changes as created by
202 file will be set up with the
204 option enabled, such that
208 will write incoming changes directly to branches in the
210 reference namespace, rather than to branches in the
213 This avoids the usual requirement of having to run
217 in order to make incoming changes appear on branches in the
220 But maintaining custom branches with local changes in the cloned
221 repository becomes difficult since local changes are at risk of
222 being discarded whenever incoming changes are fetched.
224 Suppress progress reporting output.
225 The same option will be passed to
229 Increase the verbosity of progress reporting output.
230 The same option will be passed to
233 Multiple -v options increase the verbosity.
239 .It Cm fetch Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository-name
240 Fetch new changes from a remote repository.
242 .Ar remote-repository-name
243 is specified the name
246 The remote repository's URL is obtained from the corresponding entry in the
248 file of the repository, as created by
251 Branch references in the
253 reference namespace will be updated to point at the newly fetched commits,
256 command can then be used to make new changes visible on branches in the
258 reference namespace, merging incoming changes with local changes as necessary.
260 However, if the repository is configured as a mirror then all references will
261 be updated as needed to match the corresponding references in the remote
262 repository, including branches in the
265 If those branches contained local commits, these will no longer be reachable
266 via a reference and will therefore be at risk of being discarded by Git's
269 In any case, existing references in the
271 namespace will always be changed to match tags contained in the remote
278 .It Fl r Ar repository-path
279 Use the repository at the specified path.
280 If not specified, assume the repository is located at or above the current
282 If this directory is a
284 work tree, use the repository path associated with this work tree.
286 Suppress progress reporting output.
287 The same option will be passed to
291 Increase the verbosity of progress reporting output.
292 The same option will be passed to
295 Multiple -v options increase the verbosity.
301 .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
302 Copy files from a repository into a new work tree.
303 Show the status of each affected file, using the following status codes:
304 .Bl -column YXZ description
305 .It A Ta new file was added
306 .It E Ta file already exists in work tree's meta-data
311 is not specified, either use the last component of
312 .Ar repository path ,
315 was specified use the last component of
323 Proceed with the checkout operation even if the directory at
326 Existing files will be left intact.
328 Check out files from a commit on the specified
330 If this option is not specified, a branch resolved via the repository's HEAD
331 reference will be used.
333 Check out files from the specified
335 on the selected branch.
336 The expected argument is a commit ID SHA1 hash or an existing reference
337 or tag name which will be resolved to a commit ID.
338 An abbreviated hash argument will be expanded to a full SHA1 hash
339 automatically, provided the abbreviation is unique.
340 If this option is not specified, the most recent commit on the selected
345 is not contained in the selected branch, a different branch which contains
346 this commit must be specified with the
349 If no such branch is known a new branch must be created for this
355 Checking out work trees with an unknown branch is intentionally not supported.
356 .It Fl p Ar path-prefix
357 Restrict the work tree to a subset of the repository's tree hierarchy.
358 Only files beneath the specified
365 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
366 Update an existing work tree to a different commit.
367 Show the status of each affected file, using the following status codes:
368 .Bl -column YXZ description
369 .It U Ta file was updated and contained no local changes
370 .It G Ta file was updated and local changes were merged cleanly
371 .It C Ta file was updated and conflicts occurred during merge
372 .It D Ta file was deleted
373 .It A Ta new file was added
374 .It \(a~ Ta versioned file is obstructed by a non-regular file
375 .It ! Ta a missing versioned file was restored
380 is specified, update the entire work tree.
381 Otherwise, restrict the update operation to files at or within the
383 Each path is required to exist in the update operation's target commit.
384 Files in the work tree outside specified paths will remain unchanged and
385 will retain their previously recorded base commit.
388 commands may refuse to run while the work tree contains files from
389 multiple base commits.
390 The base commit of such a work tree can be made consistent by running
392 across the entire work tree.
395 is incompatible with the
400 cannot update paths with staged changes.
401 If changes have been staged with
403 these changes must first be committed with
413 Switch the work tree's branch reference to the specified
415 before updating the work tree.
416 This option requires that all paths in the work tree are updated.
418 Update the work tree to the specified
420 The expected argument is a commit ID SHA1 hash or an existing reference
421 or tag name which will be resolved to a commit ID.
422 An abbreviated hash argument will be expanded to a full SHA1 hash
423 automatically, provided the abbreviation is unique.
424 If this option is not specified, the most recent commit on the work tree's
430 .It Cm status Op Ar path ...
431 Show the current modification status of files in a work tree,
432 using the following status codes:
433 .Bl -column YXZ description
434 .It M Ta modified file
435 .It A Ta file scheduled for addition in next commit
436 .It D Ta file scheduled for deletion in next commit
437 .It C Ta modified or added file which contains merge conflicts
438 .It ! Ta versioned file was expected on disk but is missing
439 .It \(a~ Ta versioned file is obstructed by a non-regular file
440 .It ? Ta unversioned item not tracked by
442 .It m Ta modified file modes (executable bit only)
443 .It N Ta non-existent
445 specified on the command line
450 is specified, show modifications in the entire work tree.
451 Otherwise, show modifications at or within the specified paths.
453 If changes have been staged with
455 staged changes are shown in the second output column, using the following
457 .Bl -column YXZ description
458 .It M Ta file modification is staged
459 .It A Ta file addition is staged
460 .It D Ta file deletion is staged
463 Changes created on top of staged changes are indicated in the first column:
464 .Bl -column YXZ description
465 .It MM Ta file was modified after earlier changes have been staged
466 .It MA Ta file was modified after having been staged for addition
469 For compatibility with
480 files in each traversed directory and will not display unversioned files
481 which match these patterns.
486 supports consecutive asterisks,
488 which will match an arbitrary amount of directories.
492 only supports a single ignore pattern per line.
496 does not support negated ignore patterns prefixed with
498 and gives no special significance to the location of path component separators,
504 .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
505 Display history of a repository.
508 is specified, show only commits which modified this path.
509 If invoked in a work tree, the
511 is interpreted relative to the current working directory,
512 and the work tree's path prefix is implicitly prepended.
513 Otherwise, the path is interpreted relative to the repository root.
520 Display individual commits which were merged into the current branch
524 shows the linear history of the current branch only.
526 Start traversing history at the specified
528 The expected argument is a commit ID SHA1 hash or an existing reference
529 or tag name which will be resolved to a commit ID.
530 An abbreviated hash argument will be expanded to a full SHA1 hash
531 automatically, provided the abbreviation is unique.
532 If this option is not specified, default to the work tree's current branch
533 if invoked in a work tree, or to the repository's HEAD reference.
535 Set the number of context lines shown in diffs with
537 By default, 3 lines of context are shown.
539 Limit history traversal to a given number of commits.
540 If this option is not specified, a default limit value of zero is used,
541 which is treated as an unbounded limit.
543 .Ev GOT_LOG_DEFAULT_LIMIT
544 environment variable may be set to change this default value.
546 Display the patch of modifications made in each commit.
549 is specified, only show the patch of modifications at or within this path.
550 .It Fl s Ar search-pattern
551 If specified, show only commits with a log message matched by the extended
554 Regular expression syntax is documented in
556 .It Fl r Ar repository-path
557 Use the repository at the specified path.
558 If not specified, assume the repository is located at or above the current
560 If this directory is a
562 work tree, use the repository path associated with this work tree.
564 .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
565 When invoked within a work tree with less than two arguments, display
566 uncommitted changes in the work tree.
569 is specified, only show changes within this path.
571 If two arguments are provided, treat each argument as a reference, a tag
572 name, or an object ID SHA1 hash, and display differences between the
573 corresponding objects.
574 Both objects must be of the same type (blobs, trees, or commits).
575 An abbreviated hash argument will be expanded to a full SHA1 hash
576 automatically, provided the abbreviation is unique.
583 Set the number of context lines shown in the diff.
584 By default, 3 lines of context are shown.
585 .It Fl r Ar repository-path
586 Use the repository at the specified path.
587 If not specified, assume the repository is located at or above the current
589 If this directory is a
591 work tree, use the repository path associated with this work tree.
593 Show changes staged with
595 instead of showing local changes.
596 This option is only valid when
598 is invoked in a work tree.
600 Ignore whitespace-only changes.
605 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
606 Display line-by-line history of a file at the specified path.
613 Start traversing history at the specified
615 The expected argument is a commit ID SHA1 hash or an existing reference
616 or tag name which will be resolved to a commit ID.
617 An abbreviated hash argument will be expanded to a full SHA1 hash
618 automatically, provided the abbreviation is unique.
619 .It Fl r Ar repository-path
620 Use the repository at the specified path.
621 If not specified, assume the repository is located at or above the current
623 If this directory is a
625 work tree, use the repository path associated with this work tree.
630 .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
631 Display a listing of files and directories at the specified
632 directory path in the repository.
633 Entries shown in this listing may carry one of the following trailing
635 .Bl -column YXZ description
636 .It @ Ta entry is a symbolic link
637 .It / Ta entry is a directory
638 .It * Ta entry is an executable file
639 .It $ Ta entry is a Git submodule
644 is specified, list the repository path corresponding to the current
645 directory of the work tree, or the root directory of the repository
646 if there is no work tree.
653 List files and directories as they appear in the specified
655 The expected argument is a commit ID SHA1 hash or an existing reference
656 or tag name which will be resolved to a commit ID.
657 An abbreviated hash argument will be expanded to a full SHA1 hash
658 automatically, provided the abbreviation is unique.
659 .It Fl r Ar repository-path
660 Use the repository at the specified path.
661 If not specified, assume the repository is located at or above the current
663 If this directory is a
665 work tree, use the repository path associated with this work tree.
667 Show object IDs of files (blob objects) and directories (tree objects).
669 Recurse into sub-directories in the repository.
674 .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
675 Manage references in a repository.
677 If no options are passed, expect two arguments and attempt to create,
678 or update, the reference with the given
680 and make it point at the given
682 The name must be an absolute reference name, i.e. it must begin with
684 The target may be an object ID SHA1 hash or an existing reference which
685 will be resolved to an object ID.
686 An abbreviated hash argument will be expanded to a full SHA1 hash
687 automatically, provided the abbreviation is unique.
693 .It Fl r Ar repository-path
694 Use the repository at the specified path.
695 If not specified, assume the repository is located at or above the current
697 If this directory is a
699 work tree, use the repository path associated with this work tree.
701 List all existing references in the repository.
703 Delete the reference with the specified name from the repository.
705 Create a symbolic reference pointing at the specified
707 which must be an existing reference.
708 Care should be taken not to create loops between references when
711 .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
712 Create, list, or delete branches.
714 Branches are managed via references which live in the
719 command operates on references in this namespace only.
721 If invoked in a work tree without any arguments, print the name of the
722 work tree's current branch.
726 argument is passed, attempt to create a branch reference with the given name.
727 By default the new branch reference will point at the latest commit on the
728 work tree's current branch if invoked in a work tree, and otherwise to a commit
729 resolved via the repository's HEAD reference.
731 If invoked in a work tree, once the branch was created successfully
732 switch the work tree's head reference to the newly created branch and
733 update files across the entire work tree, just like
734 .Cm got update -b Ar name
736 Show the status of each affected file, using the following status codes:
737 .Bl -column YXZ description
738 .It U Ta file was updated and contained no local changes
739 .It G Ta file was updated and local changes were merged cleanly
740 .It C Ta file was updated and conflicts occurred during merge
741 .It D Ta file was deleted
742 .It A Ta new file was added
743 .It \(a~ Ta versioned file is obstructed by a non-regular file
744 .It ! Ta a missing versioned file was restored
752 Make a newly created branch reference point at the specified
756 argument is a commit ID SHA1 hash or an existing reference
757 or tag name which will be resolved to a commit ID.
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 branches in the repository.
767 If invoked in a work tree, the work tree's current branch is shown
768 with one the following annotations:
769 .Bl -column YXZ description
770 .It * Ta work tree's base commit matches the branch tip
771 .It \(a~ Ta work tree's base commit is out-of-date
774 Delete the branch with the specified name from the repository.
775 Only the branch reference is deleted.
776 Any commit, tree, and blob objects belonging to the branch
777 remain in the repository and may be removed separately with
778 Git's garbage collector.
780 Do not switch and update the work tree after creating a new branch.
785 .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
786 Manage tags in a repository.
788 Tags are managed via references which live in the
793 command operates on references in this namespace only.
794 References in this namespace point at tag objects which contain a pointer
795 to another object, a tag message, as well as author and timestamp information.
797 Attempt to create a tag with the given
799 and make this tag point at the given
801 If no commit is specified, default to the latest commit on the work tree's
802 current branch if invoked in a work tree, and to a commit resolved via
803 the repository's HEAD reference otherwise.
810 Make the newly created tag reference point at the specified
814 argument is a commit ID SHA1 hash or an existing reference or tag name which
815 will be resolved to a commit ID.
816 An abbreviated hash argument will be expanded to a full SHA1 hash
817 automatically, provided the abbreviation is unique.
819 Use the specified tag message when creating the new tag.
824 opens a temporary file in an editor where a tag message can be written.
825 .It Fl r Ar repository-path
826 Use the repository at the specified path.
827 If not specified, assume the repository is located at or above the current
829 If this directory is a
831 work tree, use the repository path associated with this work tree.
833 List all existing tags in the repository instead of creating a new tag.
834 If this option is used, no other command-line arguments are allowed.
839 command will not delete tags or change existing tags.
840 If a tag must be deleted, the
842 command may be used to delete a tag's reference.
843 This should only be done if the tag has not already been copied to
845 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
846 Schedule unversioned files in a work tree for addition to the
847 repository in the next commit.
854 Permit recursion into directories.
855 If this option is not specified,
857 will refuse to run if a specified
861 With -R, add files even if they match a
865 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
866 Remove versioned files from a work tree and schedule them for deletion
867 from the repository in the next commit.
874 Perform the operation even if a file contains uncommitted modifications.
876 Keep affected files on disk.
878 Permit recursion into directories.
879 If this option is not specified,
881 will refuse to run if a specified
888 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
889 Revert any uncommitted changes in files at the specified paths.
890 File contents will be overwritten with those contained in the
891 work tree's base commit.
892 There is no way to bring discarded changes back after
895 If a file was added with
897 it will become an unversioned file again.
898 If a file was deleted with
907 Instead of reverting all changes in files, interactively select or reject
908 changes to revert based on
914 (quit reverting this file) responses.
915 If a file is in modified status, individual patches derived from the
916 modified file content can be reverted.
917 Files in added or deleted status may only be reverted in their entirety.
918 .It Fl F Ar response-script
926 responses line-by-line from the specified
928 file instead of prompting interactively.
930 Permit recursion into directories.
931 If this option is not specified,
933 will refuse to run if a specified
940 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
941 Create a new commit in the repository from changes in a work tree
942 and use this commit as the new base commit for the work tree.
945 is specified, commit all changes in the work tree.
946 Otherwise, commit changes at or within the specified paths.
948 If changes have been explicitly staged for commit with
950 only commit staged changes and reject any specified paths which
951 have not been staged.
953 Show the status of each affected file, using the following status codes:
954 .Bl -column YXZ description
955 .It M Ta modified file
956 .It D Ta file was deleted
957 .It A Ta new file was added
958 .It m Ta modified file modes (executable bit only)
961 Files which are not part of the new commit will retain their previously
962 recorded base commit.
965 commands may refuse to run while the work tree contains files from
966 multiple base commits.
967 The base commit of such a work tree can be made consistent by running
969 across the entire work tree.
975 environment variable to be set,
980 configuration settings can be
981 obtained from the repository's
983 file or from Git's global
992 Use the specified log message when creating the new commit.
997 opens a temporary file in an editor where a log message can be written.
1001 will refuse to run if certain preconditions are not met.
1002 If the work tree's current branch is not in the
1004 reference namespace, new commits may not be created on this branch.
1005 Local changes may only be committed if they are based on file content
1006 found in the most recent commit on the work tree's branch.
1007 If a path is found to be out of date,
1009 must be used first in order to merge local changes with changes made
1014 .It Cm cherrypick Ar commit
1015 Merge changes from a single
1020 must be on a different branch than the work tree's base commit.
1021 The expected argument is a reference or a commit ID SHA1 hash.
1022 An abbreviated hash argument will be expanded to a full SHA1 hash
1023 automatically, provided the abbreviation is unique.
1025 Show the status of each affected file, using the following status codes:
1026 .Bl -column YXZ description
1027 .It G Ta file was merged
1028 .It C Ta file was merged and conflicts occurred during merge
1029 .It ! Ta changes destined for a missing file were not merged
1030 .It D Ta file was deleted
1031 .It d Ta file's deletion was obstructed by local modifications
1032 .It A Ta new file was added
1033 .It \(a~ Ta changes destined for a non-regular file were not merged
1036 The merged changes will appear as local changes in the work tree, which
1039 amended manually or with further
1044 or discarded again with
1048 will refuse to run if certain preconditions are not met.
1049 If the work tree contains multiple base commits it must first be updated
1050 to a single base commit with
1052 If the work tree already contains files with merge conflicts, these
1053 conflicts must be resolved first.
1057 .It Cm backout Ar commit
1058 Reverse-merge changes from a single
1063 must be on the same branch as the work tree's base commit.
1064 The expected argument is a reference or a commit ID SHA1 hash.
1065 An abbreviated hash argument will be expanded to a full SHA1 hash
1066 automatically, provided the abbreviation is unique.
1068 Show the status of each affected file, using the following status codes:
1069 .Bl -column YXZ description
1070 .It G Ta file was merged
1071 .It C Ta file was merged and conflicts occurred during merge
1072 .It ! Ta changes destined for a missing file were not merged
1073 .It D Ta file was deleted
1074 .It d Ta file's deletion was obstructed by local modifications
1075 .It A Ta new file was added
1076 .It \(a~ Ta changes destined for a non-regular file were not merged
1079 The reverse-merged changes will appear as local changes in the work tree,
1080 which may be viewed with
1082 amended manually or with further
1087 or discarded again with
1091 will refuse to run if certain preconditions are not met.
1092 If the work tree contains multiple base commits it must first be updated
1093 to a single base commit with
1095 If the work tree already contains files with merge conflicts, these
1096 conflicts must be resolved first.
1100 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1101 Rebase commits on the specified
1103 onto the tip of the current branch of the work tree.
1106 must share common ancestry with the work tree's current branch.
1107 Rebasing begins with the first descendant commit of the youngest
1108 common ancestor commit shared by the specified
1110 and the work tree's current branch, and stops once the tip commit
1117 is used as intended, the specified
1119 represents a local commit history and may already contain changes
1120 that are not yet visible in any other repositories.
1121 The work tree's current branch, which must be set with
1125 operation, represents a branch from a remote repository which shares
1126 a common history with the specified
1128 but has progressed, and perhaps diverged, due to commits added to the
1131 Rebased commits are accumulated on a temporary branch which the work tree
1132 will remain switched to throughout the entire rebase operation.
1133 Commits on this branch represent the same changes with the same log
1134 messages as their counterparts on the original
1136 but with different commit IDs.
1137 Once rebasing has completed successfully, the temporary branch becomes
1138 the new version of the specified
1140 and the work tree is automatically switched to it.
1142 While rebasing commits, show the status of each affected file,
1143 using the following status codes:
1144 .Bl -column YXZ description
1145 .It G Ta file was merged
1146 .It C Ta file was merged and conflicts occurred during merge
1147 .It ! Ta changes destined for a missing file were not merged
1148 .It D Ta file was deleted
1149 .It d Ta file's deletion was obstructed by local modifications
1150 .It A Ta new file was added
1151 .It \(a~ Ta changes destined for a non-regular file were not merged
1154 If merge conflicts occur the rebase operation is interrupted and may
1155 be continued once conflicts have been resolved.
1156 Alternatively, the rebase operation may be aborted which will leave
1158 unmodified and the work tree switched back to its original branch.
1160 If a merge conflict is resolved in a way which renders the merged
1161 change into a no-op change, the corresponding commit will be elided
1162 when the rebase operation continues.
1165 will refuse to run if certain preconditions are not met.
1166 If the work tree is not yet fully updated to the tip commit of its
1167 branch then the work tree must first be updated with
1169 If changes have been staged with
1171 these changes must first be committed with
1175 If the work tree contains local changes, these changes must first be
1182 contains changes to files outside of the work tree's path prefix,
1183 the work tree cannot be used to rebase this branch.
1189 commands will refuse to run while a rebase operation is in progress.
1190 Other commands which manipulate the work tree may be used for
1191 conflict resolution purposes.
1198 Abort an interrupted rebase operation.
1199 If this option is used, no other command-line arguments are allowed.
1201 Continue an interrupted rebase operation.
1202 If this option is used, no other command-line arguments are allowed.
1207 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1208 Edit commit history between the work tree's current base commit and
1209 the tip commit of the work tree's current branch.
1213 operation the work tree's current branch must be set with
1215 to the branch which should be edited, unless this branch is already the
1216 current branch of the work tree.
1217 The tip of this branch represents the upper bound (inclusive) of commits
1222 Furthermore, the work tree's base commit
1225 to a point in this branch's commit history where editing should begin.
1226 This commit represents the lower bound (non-inclusive) of commits touched
1231 Editing of commit history is controlled via a
1233 which can be written in an editor based on a template, passed on the
1234 command line, or generated with the
1236 option if only log messages need to be edited.
1238 The format of the histedit script is line-based.
1239 Each line in the script begins with a command name, followed by
1240 whitespace and an argument.
1241 For most commands, the expected argument is a commit ID SHA1 hash.
1242 Any remaining text on the line is ignored.
1243 Lines which begin with the
1245 character are ignored entirely.
1247 The available commands are as follows:
1248 .Bl -column YXZ pick-commit
1249 .It pick Ar commit Ta Use the specified commit as it is.
1250 .It edit Ar commit Ta Use the specified commit but once changes have been
1251 merged into the work tree interrupt the histedit operation for amending.
1252 .It fold Ar commit Ta Combine the specified commit with the next commit
1253 listed further below that will be used.
1254 .It drop Ar commit Ta Remove this commit from the edited history.
1255 .It mesg Ar log-message Ta Use the specified single-line log message for
1256 the commit on the previous line.
1257 If the log message argument is left empty, open an editor where a new
1258 log message can be written.
1261 Every commit in the history being edited must be mentioned in the script.
1262 Lines may be re-ordered to change the order of commits in the edited history.
1263 No commit may be listed more than once.
1265 Edited commits are accumulated on a temporary branch which the work tree
1266 will remain switched to throughout the entire histedit operation.
1267 Once history editing has completed successfully, the temporary branch becomes
1268 the new version of the work tree's branch and the work tree is automatically
1271 While merging commits, show the status of each affected file,
1272 using the following status codes:
1273 .Bl -column YXZ description
1274 .It G Ta file was merged
1275 .It C Ta file was merged and conflicts occurred during merge
1276 .It ! Ta changes destined for a missing file were not merged
1277 .It D Ta file was deleted
1278 .It d Ta file's deletion was obstructed by local modifications
1279 .It A Ta new file was added
1280 .It \(a~ Ta changes destined for a non-regular file were not merged
1283 If merge conflicts occur the histedit operation is interrupted and may
1284 be continued once conflicts have been resolved.
1285 Alternatively, the histedit operation may be aborted which will leave
1286 the work tree switched back to its original branch.
1288 If a merge conflict is resolved in a way which renders the merged
1289 change into a no-op change, the corresponding commit will be elided
1290 when the histedit operation continues.
1293 will refuse to run if certain preconditions are not met.
1294 If the work tree's current branch is not in the
1296 reference namespace, the history of the branch may not be edited.
1297 If the work tree contains multiple base commits it must first be updated
1298 to a single base commit with
1300 If changes have been staged with
1302 these changes must first be committed with
1306 If the work tree contains local changes, these changes must first be
1311 If the edited history contains changes to files outside of the work tree's
1312 path prefix, the work tree cannot be used to edit the history of this branch.
1319 commands will refuse to run while a histedit operation is in progress.
1320 Other commands which manipulate the work tree may be used, and the
1322 command may be used to commit arbitrary changes to the temporary branch
1323 while the histedit operation is interrupted.
1330 Abort an interrupted histedit operation.
1331 If this option is used, no other command-line arguments are allowed.
1333 Continue an interrupted histedit operation.
1334 If this option is used, no other command-line arguments are allowed.
1335 .It Fl F Ar histedit-script
1338 instead of opening a temporary file in an editor where a histedit script
1341 Edit log messages only.
1342 This option is a quick equivalent to a histedit script which edits
1343 only log messages but otherwise leaves every picked commit as-is.
1346 option can only be used when starting a new histedit operation.
1347 If this option is used, no other command-line arguments are allowed.
1352 .It Cm integrate Ar branch
1353 Integrate the specified
1355 into the work tree's current branch.
1356 Files in the work tree are updated to match the contents on the integrated
1358 and the reference of the work tree's branch is changed to point at the
1359 head commit of the integrated
1362 Both branches can be considered equivalent after integration since they
1363 will be pointing at the same commit.
1364 Both branches remain available for future work, if desired.
1365 In case the integrated
1367 is no longer needed it may be deleted with
1370 Show the status of each affected file, using the following status codes:
1371 .Bl -column YXZ description
1372 .It U Ta file was updated
1373 .It D Ta file was deleted
1374 .It A Ta new file was added
1375 .It \(a~ Ta versioned file is obstructed by a non-regular file
1376 .It ! Ta a missing versioned file was restored
1380 will refuse to run if certain preconditions are not met.
1381 Most importantly, the
1383 must have been rebased onto the work tree's current branch with
1385 before it can be integrated, in order to linearize commit history and
1386 resolve merge conflicts.
1387 If the work tree contains multiple base commits it must first be updated
1388 to a single base commit with
1390 If changes have been staged with
1392 these changes must first be committed with
1396 If the work tree contains local changes, these changes must first be
1404 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1405 Stage local changes for inclusion in the next commit.
1408 is specified, stage all changes in the work tree.
1409 Otherwise, stage changes at or within the specified paths.
1410 Paths may be staged if they are added, modified, or deleted according to
1413 Show the status of each affected file, using the following status codes:
1414 .Bl -column YXZ description
1415 .It A Ta file addition has been staged
1416 .It M Ta file modification has been staged
1417 .It D Ta file deletion has been staged
1420 Staged file contents are saved in newly created blob objects in the repository.
1421 These blobs will be referred to by tree objects once staged changes have been
1424 Staged changes affect the behaviour of
1429 While paths with staged changes exist, the
1431 command will refuse to commit any paths which do not have staged changes.
1432 Local changes created on top of staged changes can only be committed if
1433 the path is staged again, or if the staged changes are committed first.
1436 command will show both local changes and staged changes.
1439 command is able to display local changes relative to staged changes,
1440 and to display staged changes relative to the repository.
1443 command cannot revert staged changes but may be used to revert
1444 local changes created on top of staged changes.
1451 Instead of staging new changes, list paths which are already staged,
1452 along with the IDs of staged blob objects and stage status codes.
1453 If paths were provided in the command line show the staged paths
1454 among the specified paths.
1455 Otherwise, show all staged paths.
1457 Instead of staging the entire content of a changed file, interactively
1458 select or reject changes for staging based on
1462 (reject change), and
1464 (quit staging this file) responses.
1465 If a file is in modified status, individual patches derived from the
1466 modified file content can be staged.
1467 Files in added or deleted status may only be staged or rejected in
1469 .It Fl F Ar response-script
1477 responses line-by-line from the specified
1479 file instead of prompting interactively.
1483 will refuse to run if certain preconditions are not met.
1484 If a file contains merge conflicts, these conflicts must be resolved first.
1485 If a file is found to be out of date relative to the head commit on the
1486 work tree's current branch, the file must be updated with
1488 before it can be staged (however, this does not prevent the file from
1489 becoming out-of-date at some point after having been staged).
1496 commands will refuse to run while staged changes exist.
1497 If staged changes cannot be committed because a staged path
1498 is out of date, the path must be unstaged with
1500 before it can be updated with
1502 and may then be staged again if necessary.
1506 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1507 Merge staged changes back into the work tree and put affected paths
1508 back into non-staged status.
1511 is specified, unstage all staged changes across the entire work tree.
1512 Otherwise, unstage changes at or within the specified paths.
1514 Show the status of each affected file, using the following status codes:
1515 .Bl -column YXZ description
1516 .It G Ta file was unstaged
1517 .It C Ta file was unstaged and conflicts occurred during merge
1518 .It ! Ta changes destined for a missing file were not merged
1519 .It D Ta file was staged as deleted and still is deleted
1520 .It d Ta file's deletion was obstructed by local modifications
1521 .It \(a~ Ta changes destined for a non-regular file were not merged
1529 Instead of unstaging the entire content of a changed file, interactively
1530 select or reject changes for unstaging based on
1534 (keep change staged), and
1536 (quit unstaging this file) responses.
1537 If a file is staged in modified status, individual patches derived from the
1538 staged file content can be unstaged.
1539 Files staged in added or deleted status may only be unstaged in their entirety.
1540 .It Fl F Ar response-script
1548 responses line-by-line from the specified
1550 file instead of prompting interactively.
1555 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1556 Parse and print contents of objects to standard output in a line-based
1558 Content of commit, tree, and tag objects is printed in a way similar
1559 to the actual content stored in such objects.
1560 Blob object contents are printed as they would appear in files on disk.
1562 Attempt to interpret each argument as a reference, a tag name, or
1563 an object ID SHA1 hash.
1564 References will be resolved to an object ID.
1565 Tag names will resolved to a tag object.
1566 An abbreviated hash argument will be expanded to a full SHA1 hash
1567 automatically, provided the abbreviation is unique.
1569 If none of the above interpretations produce a valid result, or if the
1571 option is used, attempt to interpret the argument as a path which will
1572 be resolved to the ID of an object found at this path in the repository.
1579 Look up paths in the specified
1581 If this option is not used, paths are looked up in the commit resolved
1582 via the repository's HEAD reference.
1583 The expected argument is a commit ID SHA1 hash or an existing reference
1584 or tag name which will be resolved to a commit ID.
1585 An abbreviated hash argument will be expanded to a full SHA1 hash
1586 automatically, provided the abbreviation is unique.
1587 .It Fl r Ar repository-path
1588 Use the repository at the specified path.
1589 If not specified, assume the repository is located at or above the current
1591 If this directory is a
1593 work tree, use the repository path associated with this work tree.
1595 Interpret all arguments as paths only.
1596 This option can be used to resolve ambiguity in cases where paths
1597 look like tag names, reference names, or object IDs.
1601 .Bl -tag -width GOT_AUTHOR
1603 The author's name and email address for
1608 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1611 may fail to parse commits without an email address in author data,
1615 environment variables with a missing email address.
1621 configuration settings in the repository's
1623 file will override the value of
1629 configuration settings contained in Git's global
1631 configuration file will be used only if the
1633 environment variable is
1636 .It Ev VISUAL , EDITOR
1637 The editor spawned by
1642 .It Ev GOT_LOG_DEFAULT_LIMIT
1643 The default limit on the number of commits traversed by
1645 If set to zero, the limit is unbounded.
1646 This variable will be silently ignored if it is set to a non-numeric value.
1647 .It Ev GOT_FETCH_DEBUG
1648 Enables protocol tracing on standard error output during
1656 Clone an existing Git repository for use with
1660 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1662 Use of HTTP URLs currently requires
1666 .Dl $ git clone --bare https://github.com/openbsd/src.git
1668 Alternatively, for quick and dirty local testing of
1670 a new Git repository could be created and populated with files,
1671 e.g. from a temporary CVS checkout located at
1674 .Dl $ got init /var/git/src.git
1675 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1677 Check out a work tree from the Git repository to /usr/src:
1679 .Dl $ got checkout /var/git/src.git /usr/src
1681 View local changes in a work tree directory:
1684 .Dl $ got diff | less
1686 Interactively revert selected local changes in a work tree directory:
1688 .Dl $ got revert -p -R\ .
1690 In a work tree or a git repository directory, list all branch references:
1694 In a work tree or a git repository directory, create a new branch called
1695 .Dq unified-buffer-cache
1696 which is forked off the
1700 .Dl $ got branch unified-buffer-cache master
1702 Switch an existing work tree to the branch
1703 .Dq unified-buffer-cache .
1704 Local changes in the work tree will be preserved and merged if necessary:
1706 .Dl $ got update -b unified-buffer-cache
1708 Create a new commit from local changes in a work tree directory.
1709 This new commit will become the head commit of the work tree's current branch:
1713 In a work tree or a git repository directory, view changes committed in
1714 the 3 most recent commits to the work tree's branch, or the branch resolved
1715 via the repository's HEAD reference, respectively:
1717 .Dl $ got log -p -l 3
1719 In a work tree or a git repository directory, log the history of a subdirectory:
1721 .Dl $ got log sys/uvm
1723 While operating inside a work tree, paths are specified relative to the current
1724 working directory, so this command will log the subdirectory
1727 .Dl $ cd sys/uvm && got log '.'
1729 And this command has the same effect:
1731 .Dl $ cd sys/dev/usb && got log ../../uvm
1733 Add new files and remove obsolete files in a work tree directory:
1735 .Dl $ got add sys/uvm/uvm_ubc.c
1736 .Dl $ got remove sys/uvm/uvm_vnode.c
1738 Create a new commit from local changes in a work tree directory
1739 with a pre-defined log message.
1741 .Dl $ got commit -m 'unify the buffer cache'
1743 Update any work tree checked out from the
1744 .Dq unified-buffer-cache
1745 branch to the latest commit on this branch:
1749 Roll file content on the unified-buffer-cache branch back by one commit,
1750 and then fetch the rolled-back change into the work tree as a local change
1751 to be amended and perhaps committed again:
1753 .Dl $ got backout unified-buffer-cache
1754 .Dl $ got commit -m 'roll back previous'
1755 .Dl $ # now back out the previous backout :-)
1756 .Dl $ got backout unified-buffer-cache
1758 Fetch new upstream commits into the local repository's
1765 In a repository created with a HTTP URL and
1766 .Cm git clone --bare
1769 command must be used instead:
1771 .Dl $ cd /var/git/src.git
1772 .Dl $ git fetch origin master:refs/remotes/origin/master
1776 branch to merge the new changes that are now visible on the
1781 .Dl $ got update -b origin/master
1782 .Dl $ got rebase master
1785 .Dq unified-buffer-cache
1786 branch on top of the new head commit of the
1790 .Dl $ got update -b master
1791 .Dl $ got rebase unified-buffer-cache
1793 Create a patch from all changes on the unified-buffer-cache branch.
1794 The patch can be mailed out for review and applied to
1798 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1800 Edit the entire commit history of the
1801 .Dq unified-buffer-cache
1804 .Dl $ got update -b unified-buffer-cache
1805 .Dl $ got update -c master
1808 In order to merge changes committed to the
1809 .Dq unified-buffer-cache
1810 branch back into the
1813 .Dq unified-buffer-cache
1814 branch must first be rebased onto the
1818 .Dl $ got update -b master
1819 .Dl $ got rebase unified-buffer-cache
1822 .Dq unified-buffer-cache
1823 branch can now be made visible on the
1827 Because the rebase operation switched the work tree to the
1828 .Dq unified-buffer-cache
1829 branch, the work tree must be switched back to the
1832 .Dq unified-buffer-cache
1833 branch can be integrated into
1836 .Dl $ got update -b master
1837 .Dl $ got integrate unified-buffer-cache
1839 Additional steps may be necessary if local changes need to be pushed back
1840 to the remote repository, which currently requires
1842 Before working against existing branches in a repository cloned with
1843 .Cm git clone --bare
1848 must be configured to map all references in the remote repository
1851 namespace of the local repository.
1852 This can achieved by setting Git's
1853 .Pa remote.origin.fetch
1854 configuration variable to the value
1855 .Dq +refs/heads/*:refs/remotes/origin/*
1860 .Dl $ cd /var/git/repo
1861 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1864 option must be disabled:
1866 .Dl $ cd /var/git/repo
1867 .Dl $ git config remote.origin.mirror false
1869 Alternatively, the following
1871 configuration item can be added manually to the Git repository's
1875 .Dl [remote "origin"]
1877 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1880 This configuration leaves the local repository's
1882 namespace free for use by local branches checked out with
1884 and, if needed, created with
1889 namespace can now be updated with incoming changes from the remote
1894 without extra command line arguments:
1896 .Dl $ cd /var/git/repo
1899 To make changes fetched from the remote repository appear on the
1903 branch must be rebased onto the
1906 This will also merge local changes, if any, with the incoming changes:
1908 .Dl $ got update -b origin/master
1909 .Dl $ got rebase master
1913 branch, log messages for local changes can now be amended with
1915 by other developers and any other important new information:
1917 .Dl $ got update -c origin/master
1918 .Dl $ got histedit -m
1920 Local changes on the
1922 branch can then be pushed to the remote
1926 .Dl $ cd /var/git/repo
1927 .Dl $ git push origin master
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.
