2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
79 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Ar repository-URL Op Ar directory
140 Clone a Git repository at the specified
146 is specified the directory name will be derived from the name of the
149 will refuse to run if the
155 specifies a protocol scheme, a server hostname, an optional port number
156 separated from the hostname by a colon, and a path to the repository on
158 .Lk scheme://hostname:port/path/to/repository
160 The following protocol schemes are supported:
161 .Bl -tag -width git+ssh
163 The Git protocol as implemented by the
166 Use of this protocol is discouraged since it supports neither authentication
169 The Git protocol wrapped in an authenticated and encrypted
172 With this protocol the hostname may contain an embedded username for
177 Short alias for git+ssh.
180 Objects in the cloned repository are stored in a pack file which is downloaded
182 This pack file will then be indexed to facilitate access to the objects stored
184 If any objects in the pack file are stored in deltified form, all deltas will
185 be fully resolved in order to compute the ID of such objects.
186 This can take some time.
187 More details about the pack file format are documented in
188 .Xr git-repository 5 .
191 creates a remote repository entry in the
193 file of the cloned repository to store the
205 Fetch all branches from the remote repository.
206 If this option is not specified, a branch resolved via the remote
207 repository's HEAD reference will be fetched.
208 Cannot be used together with the
214 from the remote repository.
215 This option may be specified multiple times to build a list of branches
217 If the branch corresponding to the remote repository's HEAD reference is not
218 in this list, the cloned repository's HEAD reference will be set to the first
219 branch which was fetched.
220 If this option is not specified, a branch resolved via the remote
221 repository's HEAD reference will be fetched.
222 Cannot be used together with the
226 List branches and tags available for cloning from the remote repository
227 and exit immediately.
228 Cannot be used together with any of the other options except
231 Create the cloned repository as a mirror of the original repository.
232 This is useful if the cloned repository will not be used to store
233 local changes as created by
238 file will be set up with the
240 option enabled, such that
244 will write incoming changes directly to branches in the
246 reference namespace, rather than to branches in the
249 This avoids the usual requirement of having to run
253 in order to make incoming changes appear on branches in the
256 But maintaining custom branches with local changes in the cloned
257 repository becomes difficult since local changes are at risk of
258 being discarded whenever incoming changes are fetched.
260 Suppress progress reporting output.
261 The same option will be passed to
268 to print debugging messages to standard error output.
269 This option will be passed to
272 Multiple -v options increase the verbosity.
278 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository
279 Fetch new changes from a remote repository.
281 .Ar remote-repository
285 The remote repository's URL is obtained from the corresponding entry in the
287 file of the local repository, as created by
290 New changes will be stored in a separate pack file downloaded from the server.
291 Optionally, separate pack files stored in the repository can be combined with
294 Branch references in the
296 reference namespace will be updated to point at the newly fetched commits,
299 command can then be used to make new changes visible on branches in the
301 reference namespace, merging incoming changes with local changes as necessary.
303 However, if the repository is configured as a mirror then all references will
304 be updated as needed to match the corresponding references in the remote
305 repository, including branches in the
308 If those branches contained local commits, these commits will no longer be
309 reachable via a reference and will therefore be at risk of being discarded
310 by Git's garbage collector.
312 In any case, existing references in the
314 namespace will always be changed to match tags contained in the remote
322 Fetch all branches from the remote repository.
323 If this option is not specified, a branch resolved via the remote
324 repository's HEAD reference will be fetched.
325 Cannot be used together with the
331 from the remote repository.
332 This option may be specified multiple times to build a list of branches
334 If this option is not specified, a branch resolved via the remote
335 repository's HEAD reference will be fetched.
336 Cannot be used together with the
340 Delete branches and tags from the local repository which are no longer
341 present in the remote repository.
342 Only references are deleted.
343 Any commit, tree, and blob objects belonging to deleted branches or
344 tags remain in the repository and may be removed separately with
345 Git's garbage collector.
347 List branches and tags available for fetching from the remote repository
348 and exit immediately.
349 Cannot be used together with any of the other options except
353 .It Fl r Ar repository-path
354 Use the repository at the specified path.
355 If not specified, assume the repository is located at or above the current
357 If this directory is a
359 work tree, use the repository path associated with this work tree.
361 Suppress progress reporting output.
362 The same option will be passed to
369 to print debugging messages to standard error output.
370 The same option will be passed to
373 Multiple -v options increase the verbosity.
379 .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
380 Copy files from a repository into a new work tree.
381 Show the status of each affected file, using the following status codes:
382 .Bl -column YXZ description
383 .It A Ta new file was added
384 .It E Ta file already exists in work tree's meta-data
389 is not specified, either use the last component of
390 .Ar repository path ,
393 was specified use the last component of
401 Proceed with the checkout operation even if the directory at
404 Existing files will be left intact.
406 Check out files from a commit on the specified
408 If this option is not specified, a branch resolved via the repository's HEAD
409 reference will be used.
411 Check out files from the specified
413 on the selected branch.
414 The expected argument is a commit ID SHA1 hash or an existing reference
415 or tag name which will be resolved to a commit ID.
416 An abbreviated hash argument will be expanded to a full SHA1 hash
417 automatically, provided the abbreviation is unique.
418 If this option is not specified, the most recent commit on the selected
423 is not contained in the selected branch, a different branch which contains
424 this commit must be specified with the
427 If no such branch is known a new branch must be created for this
433 Checking out work trees with an unknown branch is intentionally not supported.
434 .It Fl p Ar path-prefix
435 Restrict the work tree to a subset of the repository's tree hierarchy.
436 Only files beneath the specified
443 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
444 Update an existing work tree to a different commit.
445 Show the status of each affected file, using the following status codes:
446 .Bl -column YXZ description
447 .It U Ta file was updated and contained no local changes
448 .It G Ta file was updated and local changes were merged cleanly
449 .It C Ta file was updated and conflicts occurred during merge
450 .It D Ta file was deleted
451 .It A Ta new file was added
452 .It \(a~ Ta versioned file is obstructed by a non-regular file
453 .It ! Ta a missing versioned file was restored
458 is specified, update the entire work tree.
459 Otherwise, restrict the update operation to files at or within the
461 Each path is required to exist in the update operation's target commit.
462 Files in the work tree outside specified paths will remain unchanged and
463 will retain their previously recorded base commit.
466 commands may refuse to run while the work tree contains files from
467 multiple base commits.
468 The base commit of such a work tree can be made consistent by running
470 across the entire work tree.
473 is incompatible with the
478 cannot update paths with staged changes.
479 If changes have been staged with
481 these changes must first be committed with
491 Switch the work tree's branch reference to the specified
493 before updating the work tree.
494 This option requires that all paths in the work tree are updated.
496 Update the work tree to the specified
498 The expected argument is a commit ID SHA1 hash or an existing reference
499 or tag name which will be resolved to a commit ID.
500 An abbreviated hash argument will be expanded to a full SHA1 hash
501 automatically, provided the abbreviation is unique.
502 If this option is not specified, the most recent commit on the work tree's
508 .It Cm status Op Ar path ...
509 Show the current modification status of files in a work tree,
510 using the following status codes:
511 .Bl -column YXZ description
512 .It M Ta modified file
513 .It A Ta file scheduled for addition in next commit
514 .It D Ta file scheduled for deletion in next commit
515 .It C Ta modified or added file which contains merge conflicts
516 .It ! Ta versioned file was expected on disk but is missing
517 .It \(a~ Ta versioned file is obstructed by a non-regular file
518 .It ? Ta unversioned item not tracked by
520 .It m Ta modified file modes (executable bit only)
521 .It N Ta non-existent
523 specified on the command line
528 is specified, show modifications in the entire work tree.
529 Otherwise, show modifications at or within the specified paths.
531 If changes have been staged with
533 staged changes are shown in the second output column, using the following
535 .Bl -column YXZ description
536 .It M Ta file modification is staged
537 .It A Ta file addition is staged
538 .It D Ta file deletion is staged
541 Changes created on top of staged changes are indicated in the first column:
542 .Bl -column YXZ description
543 .It MM Ta file was modified after earlier changes have been staged
544 .It MA Ta file was modified after having been staged for addition
547 For compatibility with
558 files in each traversed directory and will not display unversioned files
559 which match these patterns.
564 supports consecutive asterisks,
566 which will match an arbitrary amount of directories.
570 only supports a single ignore pattern per line.
574 does not support negated ignore patterns prefixed with
576 and gives no special significance to the location of path component separators,
582 .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
583 Display history of a repository.
586 is specified, show only commits which modified this path.
587 If invoked in a work tree, the
589 is interpreted relative to the current working directory,
590 and the work tree's path prefix is implicitly prepended.
591 Otherwise, the path is interpreted relative to the repository root.
598 Display individual commits which were merged into the current branch
602 shows the linear history of the current branch only.
604 Start traversing history at the specified
606 The expected argument is a commit ID SHA1 hash or an existing reference
607 or tag name which will be resolved to a commit ID.
608 An abbreviated hash argument will be expanded to a full SHA1 hash
609 automatically, provided the abbreviation is unique.
610 If this option is not specified, default to the work tree's current branch
611 if invoked in a work tree, or to the repository's HEAD reference.
613 Set the number of context lines shown in diffs with
615 By default, 3 lines of context are shown.
617 Limit history traversal to a given number of commits.
618 If this option is not specified, a default limit value of zero is used,
619 which is treated as an unbounded limit.
621 .Ev GOT_LOG_DEFAULT_LIMIT
622 environment variable may be set to change this default value.
624 Display the patch of modifications made in each commit.
627 is specified, only show the patch of modifications at or within this path.
628 .It Fl s Ar search-pattern
629 If specified, show only commits with a log message matched by the extended
632 Regular expression syntax is documented in
634 .It Fl r Ar repository-path
635 Use the repository at the specified path.
636 If not specified, assume the repository is located at or above the current
638 If this directory is a
640 work tree, use the repository path associated with this work tree.
642 .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
643 When invoked within a work tree with less than two arguments, display
644 uncommitted changes in the work tree.
647 is specified, only show changes within this path.
649 If two arguments are provided, treat each argument as a reference, a tag
650 name, or an object ID SHA1 hash, and display differences between the
651 corresponding objects.
652 Both objects must be of the same type (blobs, trees, or commits).
653 An abbreviated hash argument will be expanded to a full SHA1 hash
654 automatically, provided the abbreviation is unique.
661 Set the number of context lines shown in the diff.
662 By default, 3 lines of context are shown.
663 .It Fl r Ar repository-path
664 Use the repository at the specified path.
665 If not specified, assume the repository is located at or above the current
667 If this directory is a
669 work tree, use the repository path associated with this work tree.
671 Show changes staged with
673 instead of showing local changes.
674 This option is only valid when
676 is invoked in a work tree.
678 Ignore whitespace-only changes.
683 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
684 Display line-by-line history of a file at the specified path.
691 Start traversing history at the specified
693 The expected argument is a commit ID SHA1 hash or an existing reference
694 or tag name which will be resolved to a commit ID.
695 An abbreviated hash argument will be expanded to a full SHA1 hash
696 automatically, provided the abbreviation is unique.
697 .It Fl r Ar repository-path
698 Use the repository at the specified path.
699 If not specified, assume the repository is located at or above the current
701 If this directory is a
703 work tree, use the repository path associated with this work tree.
708 .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
709 Display a listing of files and directories at the specified
710 directory path in the repository.
711 Entries shown in this listing may carry one of the following trailing
713 .Bl -column YXZ description
714 .It @ Ta entry is a symbolic link
715 .It / Ta entry is a directory
716 .It * Ta entry is an executable file
717 .It $ Ta entry is a Git submodule
722 is specified, list the repository path corresponding to the current
723 directory of the work tree, or the root directory of the repository
724 if there is no work tree.
731 List files and directories as they appear in the specified
733 The expected argument is a commit ID SHA1 hash or an existing reference
734 or tag name which will be resolved to a commit ID.
735 An abbreviated hash argument will be expanded to a full SHA1 hash
736 automatically, provided the abbreviation is unique.
737 .It Fl r Ar repository-path
738 Use the repository at the specified path.
739 If not specified, assume the repository is located at or above the current
741 If this directory is a
743 work tree, use the repository path associated with this work tree.
745 Show object IDs of files (blob objects) and directories (tree objects).
747 Recurse into sub-directories in the repository.
752 .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
753 Manage references in a repository.
755 If no options are passed, expect two arguments and attempt to create,
756 or update, the reference with the given
758 and make it point at the given
760 The name must be an absolute reference name, i.e. it must begin with
762 The target may be an object ID SHA1 hash or an existing reference which
763 will be resolved to an object ID.
764 An abbreviated hash argument will be expanded to a full SHA1 hash
765 automatically, provided the abbreviation is unique.
771 .It Fl r Ar repository-path
772 Use the repository at the specified path.
773 If not specified, assume the repository is located at or above the current
775 If this directory is a
777 work tree, use the repository path associated with this work tree.
779 List all existing references in the repository.
781 Delete the reference with the specified name from the repository.
783 Create a symbolic reference pointing at the specified
785 which must be an existing reference.
786 Care should be taken not to create loops between references when
789 .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
790 Create, list, or delete branches.
792 Branches are managed via references which live in the
797 command operates on references in this namespace only.
799 If invoked in a work tree without any arguments, print the name of the
800 work tree's current branch.
804 argument is passed, attempt to create a branch reference with the given name.
805 By default the new branch reference will point at the latest commit on the
806 work tree's current branch if invoked in a work tree, and otherwise to a commit
807 resolved via the repository's HEAD reference.
809 If invoked in a work tree, once the branch was created successfully
810 switch the work tree's head reference to the newly created branch and
811 update files across the entire work tree, just like
812 .Cm got update -b Ar name
814 Show the status of each affected file, using the following status codes:
815 .Bl -column YXZ description
816 .It U Ta file was updated and contained no local changes
817 .It G Ta file was updated and local changes were merged cleanly
818 .It C Ta file was updated and conflicts occurred during merge
819 .It D Ta file was deleted
820 .It A Ta new file was added
821 .It \(a~ Ta versioned file is obstructed by a non-regular file
822 .It ! Ta a missing versioned file was restored
830 Make a newly created branch reference point at the specified
834 argument is a commit ID SHA1 hash or an existing reference
835 or tag name which will be resolved to a commit ID.
836 .It Fl r Ar repository-path
837 Use the repository at the specified path.
838 If not specified, assume the repository is located at or above the current
840 If this directory is a
842 work tree, use the repository path associated with this work tree.
844 List all existing branches in the repository.
845 If invoked in a work tree, the work tree's current branch is shown
846 with one the following annotations:
847 .Bl -column YXZ description
848 .It * Ta work tree's base commit matches the branch tip
849 .It \(a~ Ta work tree's base commit is out-of-date
852 Delete the branch with the specified name from the repository.
853 Only the branch reference is deleted.
854 Any commit, tree, and blob objects belonging to the branch
855 remain in the repository and may be removed separately with
856 Git's garbage collector.
858 Do not switch and update the work tree after creating a new branch.
863 .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
864 Manage tags in a repository.
866 Tags are managed via references which live in the
871 command operates on references in this namespace only.
872 References in this namespace point at tag objects which contain a pointer
873 to another object, a tag message, as well as author and timestamp information.
875 Attempt to create a tag with the given
877 and make this tag point at the given
879 If no commit is specified, default to the latest commit on the work tree's
880 current branch if invoked in a work tree, and to a commit resolved via
881 the repository's HEAD reference otherwise.
888 Make the newly created tag reference point at the specified
892 argument is a commit ID SHA1 hash or an existing reference or tag name which
893 will be resolved to a commit ID.
894 An abbreviated hash argument will be expanded to a full SHA1 hash
895 automatically, provided the abbreviation is unique.
897 Use the specified tag message when creating the new tag.
902 opens a temporary file in an editor where a tag message can be written.
903 .It Fl r Ar repository-path
904 Use the repository at the specified path.
905 If not specified, assume the repository is located at or above the current
907 If this directory is a
909 work tree, use the repository path associated with this work tree.
911 List all existing tags in the repository instead of creating a new tag.
912 If this option is used, no other command-line arguments are allowed.
917 command will not delete tags or change existing tags.
918 If a tag must be deleted, the
920 command may be used to delete a tag's reference.
921 This should only be done if the tag has not already been copied to
923 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
924 Schedule unversioned files in a work tree for addition to the
925 repository in the next commit.
932 Permit recursion into directories.
933 If this option is not specified,
935 will refuse to run if a specified
939 With -R, add files even if they match a
943 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
944 Remove versioned files from a work tree and schedule them for deletion
945 from the repository in the next commit.
952 Perform the operation even if a file contains uncommitted modifications.
954 Keep affected files on disk.
956 Permit recursion into directories.
957 If this option is not specified,
959 will refuse to run if a specified
966 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
967 Revert any uncommitted changes in files at the specified paths.
968 File contents will be overwritten with those contained in the
969 work tree's base commit.
970 There is no way to bring discarded changes back after
973 If a file was added with
975 it will become an unversioned file again.
976 If a file was deleted with
985 Instead of reverting all changes in files, interactively select or reject
986 changes to revert based on
992 (quit reverting this file) responses.
993 If a file is in modified status, individual patches derived from the
994 modified file content can be reverted.
995 Files in added or deleted status may only be reverted in their entirety.
996 .It Fl F Ar response-script
1004 responses line-by-line from the specified
1006 file instead of prompting interactively.
1008 Permit recursion into directories.
1009 If this option is not specified,
1011 will refuse to run if a specified
1018 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1019 Create a new commit in the repository from changes in a work tree
1020 and use this commit as the new base commit for the work tree.
1023 is specified, commit all changes in the work tree.
1024 Otherwise, commit changes at or within the specified paths.
1026 If changes have been explicitly staged for commit with
1028 only commit staged changes and reject any specified paths which
1029 have not been staged.
1031 Show the status of each affected file, using the following status codes:
1032 .Bl -column YXZ description
1033 .It M Ta modified file
1034 .It D Ta file was deleted
1035 .It A Ta new file was added
1036 .It m Ta modified file modes (executable bit only)
1039 Files which are not part of the new commit will retain their previously
1040 recorded base commit.
1043 commands may refuse to run while the work tree contains files from
1044 multiple base commits.
1045 The base commit of such a work tree can be made consistent by running
1047 across the entire work tree.
1051 command requires the
1053 environment variable to be set,
1058 configuration settings can be
1059 obtained from the repository's
1061 file or from Git's global
1070 Use the specified log message when creating the new commit.
1075 opens a temporary file in an editor where a log message can be written.
1079 will refuse to run if certain preconditions are not met.
1080 If the work tree's current branch is not in the
1082 reference namespace, new commits may not be created on this branch.
1083 Local changes may only be committed if they are based on file content
1084 found in the most recent commit on the work tree's branch.
1085 If a path is found to be out of date,
1087 must be used first in order to merge local changes with changes made
1092 .It Cm cherrypick Ar commit
1093 Merge changes from a single
1098 must be on a different branch than the work tree's base commit.
1099 The expected argument is a reference or a commit ID SHA1 hash.
1100 An abbreviated hash argument will be expanded to a full SHA1 hash
1101 automatically, provided the abbreviation is unique.
1103 Show the status of each affected file, using the following status codes:
1104 .Bl -column YXZ description
1105 .It G Ta file was merged
1106 .It C Ta file was merged and conflicts occurred during merge
1107 .It ! Ta changes destined for a missing file were not merged
1108 .It D Ta file was deleted
1109 .It d Ta file's deletion was obstructed by local modifications
1110 .It A Ta new file was added
1111 .It \(a~ Ta changes destined for a non-regular file were not merged
1114 The merged changes will appear as local changes in the work tree, which
1117 amended manually or with further
1122 or discarded again with
1126 will refuse to run if certain preconditions are not met.
1127 If the work tree contains multiple base commits it must first be updated
1128 to a single base commit with
1130 If the work tree already contains files with merge conflicts, these
1131 conflicts must be resolved first.
1135 .It Cm backout Ar commit
1136 Reverse-merge changes from a single
1141 must be on the same branch as the work tree's base commit.
1142 The expected argument is a reference or a commit ID SHA1 hash.
1143 An abbreviated hash argument will be expanded to a full SHA1 hash
1144 automatically, provided the abbreviation is unique.
1146 Show the status of each affected file, using the following status codes:
1147 .Bl -column YXZ description
1148 .It G Ta file was merged
1149 .It C Ta file was merged and conflicts occurred during merge
1150 .It ! Ta changes destined for a missing file were not merged
1151 .It D Ta file was deleted
1152 .It d Ta file's deletion was obstructed by local modifications
1153 .It A Ta new file was added
1154 .It \(a~ Ta changes destined for a non-regular file were not merged
1157 The reverse-merged changes will appear as local changes in the work tree,
1158 which may be viewed with
1160 amended manually or with further
1165 or discarded again with
1169 will refuse to run if certain preconditions are not met.
1170 If the work tree contains multiple base commits it must first be updated
1171 to a single base commit with
1173 If the work tree already contains files with merge conflicts, these
1174 conflicts must be resolved first.
1178 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1179 Rebase commits on the specified
1181 onto the tip of the current branch of the work tree.
1184 must share common ancestry with the work tree's current branch.
1185 Rebasing begins with the first descendant commit of the youngest
1186 common ancestor commit shared by the specified
1188 and the work tree's current branch, and stops once the tip commit
1195 is used as intended, the specified
1197 represents a local commit history and may already contain changes
1198 that are not yet visible in any other repositories.
1199 The work tree's current branch, which must be set with
1203 operation, represents a branch from a remote repository which shares
1204 a common history with the specified
1206 but has progressed, and perhaps diverged, due to commits added to the
1209 Rebased commits are accumulated on a temporary branch which the work tree
1210 will remain switched to throughout the entire rebase operation.
1211 Commits on this branch represent the same changes with the same log
1212 messages as their counterparts on the original
1214 but with different commit IDs.
1215 Once rebasing has completed successfully, the temporary branch becomes
1216 the new version of the specified
1218 and the work tree is automatically switched to it.
1220 While rebasing commits, show the status of each affected file,
1221 using the following status codes:
1222 .Bl -column YXZ description
1223 .It G Ta file was merged
1224 .It C Ta file was merged and conflicts occurred during merge
1225 .It ! Ta changes destined for a missing file were not merged
1226 .It D Ta file was deleted
1227 .It d Ta file's deletion was obstructed by local modifications
1228 .It A Ta new file was added
1229 .It \(a~ Ta changes destined for a non-regular file were not merged
1232 If merge conflicts occur the rebase operation is interrupted and may
1233 be continued once conflicts have been resolved.
1234 Alternatively, the rebase operation may be aborted which will leave
1236 unmodified and the work tree switched back to its original branch.
1238 If a merge conflict is resolved in a way which renders the merged
1239 change into a no-op change, the corresponding commit will be elided
1240 when the rebase operation continues.
1243 will refuse to run if certain preconditions are not met.
1244 If the work tree is not yet fully updated to the tip commit of its
1245 branch then the work tree must first be updated with
1247 If changes have been staged with
1249 these changes must first be committed with
1253 If the work tree contains local changes, these changes must first be
1260 contains changes to files outside of the work tree's path prefix,
1261 the work tree cannot be used to rebase this branch.
1267 commands will refuse to run while a rebase operation is in progress.
1268 Other commands which manipulate the work tree may be used for
1269 conflict resolution purposes.
1276 Abort an interrupted rebase operation.
1277 If this option is used, no other command-line arguments are allowed.
1279 Continue an interrupted rebase operation.
1280 If this option is used, no other command-line arguments are allowed.
1285 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1286 Edit commit history between the work tree's current base commit and
1287 the tip commit of the work tree's current branch.
1291 operation the work tree's current branch must be set with
1293 to the branch which should be edited, unless this branch is already the
1294 current branch of the work tree.
1295 The tip of this branch represents the upper bound (inclusive) of commits
1300 Furthermore, the work tree's base commit
1303 to a point in this branch's commit history where editing should begin.
1304 This commit represents the lower bound (non-inclusive) of commits touched
1309 Editing of commit history is controlled via a
1311 which can be written in an editor based on a template, passed on the
1312 command line, or generated with the
1314 option if only log messages need to be edited.
1316 The format of the histedit script is line-based.
1317 Each line in the script begins with a command name, followed by
1318 whitespace and an argument.
1319 For most commands, the expected argument is a commit ID SHA1 hash.
1320 Any remaining text on the line is ignored.
1321 Lines which begin with the
1323 character are ignored entirely.
1325 The available commands are as follows:
1326 .Bl -column YXZ pick-commit
1327 .It pick Ar commit Ta Use the specified commit as it is.
1328 .It edit Ar commit Ta Use the specified commit but once changes have been
1329 merged into the work tree interrupt the histedit operation for amending.
1330 .It fold Ar commit Ta Combine the specified commit with the next commit
1331 listed further below that will be used.
1332 .It drop Ar commit Ta Remove this commit from the edited history.
1333 .It mesg Ar log-message Ta Use the specified single-line log message for
1334 the commit on the previous line.
1335 If the log message argument is left empty, open an editor where a new
1336 log message can be written.
1339 Every commit in the history being edited must be mentioned in the script.
1340 Lines may be re-ordered to change the order of commits in the edited history.
1341 No commit may be listed more than once.
1343 Edited commits are accumulated on a temporary branch which the work tree
1344 will remain switched to throughout the entire histedit operation.
1345 Once history editing has completed successfully, the temporary branch becomes
1346 the new version of the work tree's branch and the work tree is automatically
1349 While merging commits, show the status of each affected file,
1350 using the following status codes:
1351 .Bl -column YXZ description
1352 .It G Ta file was merged
1353 .It C Ta file was merged and conflicts occurred during merge
1354 .It ! Ta changes destined for a missing file were not merged
1355 .It D Ta file was deleted
1356 .It d Ta file's deletion was obstructed by local modifications
1357 .It A Ta new file was added
1358 .It \(a~ Ta changes destined for a non-regular file were not merged
1361 If merge conflicts occur the histedit operation is interrupted and may
1362 be continued once conflicts have been resolved.
1363 Alternatively, the histedit operation may be aborted which will leave
1364 the work tree switched back to its original branch.
1366 If a merge conflict is resolved in a way which renders the merged
1367 change into a no-op change, the corresponding commit will be elided
1368 when the histedit operation continues.
1371 will refuse to run if certain preconditions are not met.
1372 If the work tree's current branch is not in the
1374 reference namespace, the history of the branch may not be edited.
1375 If the work tree contains multiple base commits it must first be updated
1376 to a single base commit with
1378 If changes have been staged with
1380 these changes must first be committed with
1384 If the work tree contains local changes, these changes must first be
1389 If the edited history contains changes to files outside of the work tree's
1390 path prefix, the work tree cannot be used to edit the history of this branch.
1397 commands will refuse to run while a histedit operation is in progress.
1398 Other commands which manipulate the work tree may be used, and the
1400 command may be used to commit arbitrary changes to the temporary branch
1401 while the histedit operation is interrupted.
1408 Abort an interrupted histedit operation.
1409 If this option is used, no other command-line arguments are allowed.
1411 Continue an interrupted histedit operation.
1412 If this option is used, no other command-line arguments are allowed.
1413 .It Fl F Ar histedit-script
1416 instead of opening a temporary file in an editor where a histedit script
1419 Edit log messages only.
1420 This option is a quick equivalent to a histedit script which edits
1421 only log messages but otherwise leaves every picked commit as-is.
1424 option can only be used when starting a new histedit operation.
1425 If this option is used, no other command-line arguments are allowed.
1430 .It Cm integrate Ar branch
1431 Integrate the specified
1433 into the work tree's current branch.
1434 Files in the work tree are updated to match the contents on the integrated
1436 and the reference of the work tree's branch is changed to point at the
1437 head commit of the integrated
1440 Both branches can be considered equivalent after integration since they
1441 will be pointing at the same commit.
1442 Both branches remain available for future work, if desired.
1443 In case the integrated
1445 is no longer needed it may be deleted with
1448 Show the status of each affected file, using the following status codes:
1449 .Bl -column YXZ description
1450 .It U Ta file was updated
1451 .It D Ta file was deleted
1452 .It A Ta new file was added
1453 .It \(a~ Ta versioned file is obstructed by a non-regular file
1454 .It ! Ta a missing versioned file was restored
1458 will refuse to run if certain preconditions are not met.
1459 Most importantly, the
1461 must have been rebased onto the work tree's current branch with
1463 before it can be integrated, in order to linearize commit history and
1464 resolve merge conflicts.
1465 If the work tree contains multiple base commits it must first be updated
1466 to a single base commit with
1468 If changes have been staged with
1470 these changes must first be committed with
1474 If the work tree contains local changes, these changes must first be
1482 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1483 Stage local changes for inclusion in the next commit.
1486 is specified, stage all changes in the work tree.
1487 Otherwise, stage changes at or within the specified paths.
1488 Paths may be staged if they are added, modified, or deleted according to
1491 Show the status of each affected file, using the following status codes:
1492 .Bl -column YXZ description
1493 .It A Ta file addition has been staged
1494 .It M Ta file modification has been staged
1495 .It D Ta file deletion has been staged
1498 Staged file contents are saved in newly created blob objects in the repository.
1499 These blobs will be referred to by tree objects once staged changes have been
1502 Staged changes affect the behaviour of
1507 While paths with staged changes exist, the
1509 command will refuse to commit any paths which do not have staged changes.
1510 Local changes created on top of staged changes can only be committed if
1511 the path is staged again, or if the staged changes are committed first.
1514 command will show both local changes and staged changes.
1517 command is able to display local changes relative to staged changes,
1518 and to display staged changes relative to the repository.
1521 command cannot revert staged changes but may be used to revert
1522 local changes created on top of staged changes.
1529 Instead of staging new changes, list paths which are already staged,
1530 along with the IDs of staged blob objects and stage status codes.
1531 If paths were provided in the command line show the staged paths
1532 among the specified paths.
1533 Otherwise, show all staged paths.
1535 Instead of staging the entire content of a changed file, interactively
1536 select or reject changes for staging based on
1540 (reject change), and
1542 (quit staging this file) responses.
1543 If a file is in modified status, individual patches derived from the
1544 modified file content can be staged.
1545 Files in added or deleted status may only be staged or rejected in
1547 .It Fl F Ar response-script
1555 responses line-by-line from the specified
1557 file instead of prompting interactively.
1561 will refuse to run if certain preconditions are not met.
1562 If a file contains merge conflicts, these conflicts must be resolved first.
1563 If a file is found to be out of date relative to the head commit on the
1564 work tree's current branch, the file must be updated with
1566 before it can be staged (however, this does not prevent the file from
1567 becoming out-of-date at some point after having been staged).
1574 commands will refuse to run while staged changes exist.
1575 If staged changes cannot be committed because a staged path
1576 is out of date, the path must be unstaged with
1578 before it can be updated with
1580 and may then be staged again if necessary.
1584 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1585 Merge staged changes back into the work tree and put affected paths
1586 back into non-staged status.
1589 is specified, unstage all staged changes across the entire work tree.
1590 Otherwise, unstage changes at or within the specified paths.
1592 Show the status of each affected file, using the following status codes:
1593 .Bl -column YXZ description
1594 .It G Ta file was unstaged
1595 .It C Ta file was unstaged and conflicts occurred during merge
1596 .It ! Ta changes destined for a missing file were not merged
1597 .It D Ta file was staged as deleted and still is deleted
1598 .It d Ta file's deletion was obstructed by local modifications
1599 .It \(a~ Ta changes destined for a non-regular file were not merged
1607 Instead of unstaging the entire content of a changed file, interactively
1608 select or reject changes for unstaging based on
1612 (keep change staged), and
1614 (quit unstaging this file) responses.
1615 If a file is staged in modified status, individual patches derived from the
1616 staged file content can be unstaged.
1617 Files staged in added or deleted status may only be unstaged in their entirety.
1618 .It Fl F Ar response-script
1626 responses line-by-line from the specified
1628 file instead of prompting interactively.
1633 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1634 Parse and print contents of objects to standard output in a line-based
1636 Content of commit, tree, and tag objects is printed in a way similar
1637 to the actual content stored in such objects.
1638 Blob object contents are printed as they would appear in files on disk.
1640 Attempt to interpret each argument as a reference, a tag name, or
1641 an object ID SHA1 hash.
1642 References will be resolved to an object ID.
1643 Tag names will resolved to a tag object.
1644 An abbreviated hash argument will be expanded to a full SHA1 hash
1645 automatically, provided the abbreviation is unique.
1647 If none of the above interpretations produce a valid result, or if the
1649 option is used, attempt to interpret the argument as a path which will
1650 be resolved to the ID of an object found at this path in the repository.
1657 Look up paths in the specified
1659 If this option is not used, paths are looked up in the commit resolved
1660 via the repository's HEAD reference.
1661 The expected argument is a commit ID SHA1 hash or an existing reference
1662 or tag name which will be resolved to a commit ID.
1663 An abbreviated hash argument will be expanded to a full SHA1 hash
1664 automatically, provided the abbreviation is unique.
1665 .It Fl r Ar repository-path
1666 Use the repository at the specified path.
1667 If not specified, assume the repository is located at or above the current
1669 If this directory is a
1671 work tree, use the repository path associated with this work tree.
1673 Interpret all arguments as paths only.
1674 This option can be used to resolve ambiguity in cases where paths
1675 look like tag names, reference names, or object IDs.
1679 .Bl -tag -width GOT_AUTHOR
1681 The author's name and email address for
1686 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1689 may fail to parse commits without an email address in author data,
1693 environment variables with a missing email address.
1699 configuration settings in the repository's
1701 file will override the value of
1707 configuration settings contained in Git's global
1709 configuration file will be used only if the
1711 environment variable is
1714 .It Ev VISUAL , EDITOR
1715 The editor spawned by
1720 .It Ev GOT_LOG_DEFAULT_LIMIT
1721 The default limit on the number of commits traversed by
1723 If set to zero, the limit is unbounded.
1724 This variable will be silently ignored if it is set to a non-numeric value.
1729 Clone an existing Git repository for use with
1733 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1735 Use of HTTP URLs currently requires
1739 .Dl $ git clone --bare https://github.com/openbsd/src.git
1741 Alternatively, for quick and dirty local testing of
1743 a new Git repository could be created and populated with files,
1744 e.g. from a temporary CVS checkout located at
1747 .Dl $ got init /var/git/src.git
1748 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1750 Check out a work tree from the Git repository to /usr/src:
1752 .Dl $ got checkout /var/git/src.git /usr/src
1754 View local changes in a work tree directory:
1757 .Dl $ got diff | less
1759 Interactively revert selected local changes in a work tree directory:
1761 .Dl $ got revert -p -R\ .
1763 In a work tree or a git repository directory, list all branch references:
1767 In a work tree or a git repository directory, create a new branch called
1768 .Dq unified-buffer-cache
1769 which is forked off the
1773 .Dl $ got branch unified-buffer-cache master
1775 Switch an existing work tree to the branch
1776 .Dq unified-buffer-cache .
1777 Local changes in the work tree will be preserved and merged if necessary:
1779 .Dl $ got update -b unified-buffer-cache
1781 Create a new commit from local changes in a work tree directory.
1782 This new commit will become the head commit of the work tree's current branch:
1786 In a work tree or a git repository directory, view changes committed in
1787 the 3 most recent commits to the work tree's branch, or the branch resolved
1788 via the repository's HEAD reference, respectively:
1790 .Dl $ got log -p -l 3
1792 In a work tree or a git repository directory, log the history of a subdirectory:
1794 .Dl $ got log sys/uvm
1796 While operating inside a work tree, paths are specified relative to the current
1797 working directory, so this command will log the subdirectory
1800 .Dl $ cd sys/uvm && got log '.'
1802 And this command has the same effect:
1804 .Dl $ cd sys/dev/usb && got log ../../uvm
1806 Add new files and remove obsolete files in a work tree directory:
1808 .Dl $ got add sys/uvm/uvm_ubc.c
1809 .Dl $ got remove sys/uvm/uvm_vnode.c
1811 Create a new commit from local changes in a work tree directory
1812 with a pre-defined log message.
1814 .Dl $ got commit -m 'unify the buffer cache'
1816 Update any work tree checked out from the
1817 .Dq unified-buffer-cache
1818 branch to the latest commit on this branch:
1822 Roll file content on the unified-buffer-cache branch back by one commit,
1823 and then fetch the rolled-back change into the work tree as a local change
1824 to be amended and perhaps committed again:
1826 .Dl $ got backout unified-buffer-cache
1827 .Dl $ got commit -m 'roll back previous'
1828 .Dl $ # now back out the previous backout :-)
1829 .Dl $ got backout unified-buffer-cache
1831 Fetch new upstream commits into the local repository's
1838 In a repository created with a HTTP URL and
1839 .Cm git clone --bare
1842 command must be used instead:
1844 .Dl $ cd /var/git/src.git
1845 .Dl $ git fetch origin master:refs/remotes/origin/master
1849 branch to merge the new changes that are now visible on the
1854 .Dl $ got update -b origin/master
1855 .Dl $ got rebase master
1858 .Dq unified-buffer-cache
1859 branch on top of the new head commit of the
1863 .Dl $ got update -b master
1864 .Dl $ got rebase unified-buffer-cache
1866 Create a patch from all changes on the unified-buffer-cache branch.
1867 The patch can be mailed out for review and applied to
1871 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1873 Edit the entire commit history of the
1874 .Dq unified-buffer-cache
1877 .Dl $ got update -b unified-buffer-cache
1878 .Dl $ got update -c master
1881 In order to merge changes committed to the
1882 .Dq unified-buffer-cache
1883 branch back into the
1886 .Dq unified-buffer-cache
1887 branch must first be rebased onto the
1891 .Dl $ got update -b master
1892 .Dl $ got rebase unified-buffer-cache
1895 .Dq unified-buffer-cache
1896 branch can now be made visible on the
1900 Because the rebase operation switched the work tree to the
1901 .Dq unified-buffer-cache
1902 branch, the work tree must be switched back to the
1905 .Dq unified-buffer-cache
1906 branch can be integrated into
1909 .Dl $ got update -b master
1910 .Dl $ got integrate unified-buffer-cache
1912 Additional steps may be necessary if local changes need to be pushed back
1913 to the remote repository, which currently requires
1915 Before working against existing branches in a repository cloned with
1916 .Cm git clone --bare
1921 must be configured to map all references in the remote repository
1924 namespace of the local repository.
1925 This can achieved by setting Git's
1926 .Pa remote.origin.fetch
1927 configuration variable to the value
1928 .Dq +refs/heads/*:refs/remotes/origin/*
1933 .Dl $ cd /var/git/repo
1934 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1937 option must be disabled:
1939 .Dl $ cd /var/git/repo
1940 .Dl $ git config remote.origin.mirror false
1942 Alternatively, the following
1944 configuration item can be added manually to the Git repository's
1948 .Dl [remote "origin"]
1950 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1953 This configuration leaves the local repository's
1955 namespace free for use by local branches checked out with
1957 and, if needed, created with
1962 namespace can now be updated with incoming changes from the remote
1967 without extra command line arguments:
1969 .Dl $ cd /var/git/repo
1972 To make changes fetched from the remote repository appear on the
1976 branch must be rebased onto the
1979 This will also merge local changes, if any, with the incoming changes:
1981 .Dl $ got update -b origin/master
1982 .Dl $ got rebase master
1986 branch, log messages for local changes can now be amended with
1988 by other developers and any other important new information:
1990 .Dl $ got update -c origin/master
1991 .Dl $ got histedit -m
1993 Local changes on the
1995 branch can then be pushed to the remote
1999 .Dl $ cd /var/git/repo
2000 .Dl $ git push origin master
2003 .Xr git-repository 5 ,
2006 .An Stefan Sperling Aq Mt stsp@openbsd.org
2007 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2008 .An Joshua Stein Aq Mt jcs@openbsd.org
2009 .An Ori Bernstein Aq Mt ori@openbsd.org
2012 is a work-in-progress and many commands remain to be implemented.
2013 At present, the user has to fall back on
2015 to perform many tasks, in particular tasks related to repository
2016 administration and tasks which require a network connection.
