2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019, 2020 Stefan Sperling
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
30 is a version control system which stores the history of tracked files
31 in a Git repository, as used by the Git version control system.
32 This repository format is described in
33 .Xr git-repository 5 .
38 version control system because every copy of a repository is writeable.
39 Modifications made to files can be synchronized between repositories
44 must be checked out from the repository for modification.
45 Checked out files are stored in a
47 which can be placed at an arbitrary directory in the filesystem hierarchy.
48 The on-disk format of this work tree is described in
52 provides global and command-specific options.
53 Global options must precede the command name, and are as follows:
54 .Bl -tag -width tenletters
56 Display usage information and exit immediately.
58 Display program version and exit immediately.
64 .Bl -tag -width checkout
65 .It Cm init Ar repository-path
66 Create a new empty repository at the specified
73 command must be used to populate the empty repository before
79 .It Cm import Oo Fl b Ar branch Oc Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl I Ar pattern Oc Ar directory
80 Create an initial commit in a repository from the file hierarchy
83 The created commit will not have any parent commits, i.e. it will be a
85 Also create a new reference which provides a branch name for the newly
87 Show the path of each imported file to indicate progress.
93 environment variable to be set,
98 configuration settings can be obtained from the repository's
100 file or from Git's global
111 instead of creating the default branch
113 Use of this option is required if the
115 branch already exists.
117 Use the specified log message when creating the new commit.
122 opens a temporary file in an editor where a log message can be written.
123 .It Fl r Ar repository-path
124 Use the repository at the specified path.
125 If not specified, assume the repository is located at or above the current
128 Ignore files or directories with a name which matches the specified
130 This option may be specified multiple times to build a list of ignore patterns.
133 follows the globbing rules documented in
139 .It Cm clone Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl l Oc Oo Fl m Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Ar repository-URL Op Ar directory
140 Clone a Git repository at the specified
146 is specified the directory name will be derived from the name of the
149 will refuse to run if the
155 specifies a protocol scheme, a server hostname, an optional port number
156 separated from the hostname by a colon, and a path to the repository on
158 .Lk scheme://hostname:port/path/to/repository
160 The following protocol schemes are supported:
161 .Bl -tag -width git+ssh
163 The Git protocol as implemented by the
166 Use of this protocol is discouraged since it supports neither authentication
169 The Git protocol wrapped in an authenticated and encrypted
172 With this protocol the hostname may contain an embedded username for
177 Short alias for git+ssh.
180 Objects in the cloned repository are stored in a pack file which is downloaded
182 This pack file will then be indexed to facilitate access to the objects stored
184 If any objects in the pack file are stored in deltified form, all deltas will
185 be fully resolved in order to compute the ID of such objects.
186 This can take some time.
187 More details about the pack file format are documented in
188 .Xr git-repository 5 .
191 creates a remote repository entry in the
193 file of the cloned repository to store the
205 Fetch all branches from the remote repository's
208 If this option is not specified, a branch resolved via the remote
209 repository's HEAD reference will be fetched.
210 Cannot be used together with the
216 from the remote repository's
219 This option may be specified multiple times to build a list of branches
221 If the branch corresponding to the remote repository's HEAD reference is not
222 in this list, the cloned repository's HEAD reference will be set to the first
223 branch which was fetched.
224 If this option is not specified, a branch resolved via the remote
225 repository's HEAD reference will be fetched.
226 Cannot be used together with the
230 List branches and tags available for fetching from the remote repository
231 and exit immediately.
232 Cannot be used together with any of the other options except
235 Create the cloned repository as a mirror of the original repository.
236 This is useful if the cloned repository will not be used to store
237 local changes as created by
242 file will be set up with the
244 option enabled, such that
248 will write incoming changes directly to local branches in the
250 reference namespace, rather than to branches in the
253 This avoids the usual requirement of having to run
257 in order to make incoming changes appear on local branches.
258 But maintaining local changes in the cloned repository becomes difficult
259 since local changes will be at risk of being discarded whenever incoming
262 Suppress progress reporting output.
263 The same option will be passed to
270 to print debugging messages to standard error output.
271 This option will be passed to
274 Multiple -v options increase the verbosity.
276 .It Fl R Ar reference
277 In addition to the branches and tags that will be fetched, fetch an arbitrary
279 from the remote repository's
282 This option may be specified multiple times to build a list of additional
286 may either be a path to a specific reference, or a reference namespace
287 which will cause all references in this namespace to be fetched.
289 Each reference will be mapped into the cloned repository's
291 namespace, unless the
293 option is used to mirror references directly into the cloned repository's
298 will refuse to fetch references from the remote repository's
307 .It Cm fetch Oo Fl a Oc Oo Fl b Ar branch Oc Oo Fl d Oc Oo Fl l Oc Oo Fl r Ar repository-path Oc Oo Fl t Oc Oo Fl q Oc Oo Fl v Oc Oo Fl R Ar reference Oc Op Ar remote-repository
308 Fetch new changes from a remote repository.
310 .Ar remote-repository
314 The remote repository's URL is obtained from the corresponding entry in the
316 file of the local repository, as created by
319 New changes will be stored in a separate pack file downloaded from the server.
320 Optionally, separate pack files stored in the repository can be combined with
323 By default, branch references in the
325 reference namespace will be updated to point at the newly fetched commits.
328 command can then be used to make new changes visible on local branches in the
330 namespace, merging incoming changes with local changes as necessary.
332 If the repository was created as a mirror with
334 then all branches in the
336 namespace will be updated directly to match the corresponding branches in
337 the remote repository.
338 If those branches contained local commits, these commits will no longer be
339 reachable via a reference and will therefore be at risk of being discarded
340 by Git's garbage collector.
341 Maintaining local changes in a mirror repository is therefore discouraged.
343 In any case, references in the
345 namespace will always be fetched and mapped directly to local references
346 in the same namespace.
353 Fetch all branches from the remote repository's
356 If this option is not specified, a branch resolved via the remote
357 repository's HEAD reference will be fetched.
358 Cannot be used together with the
364 from the remote repository's
367 This option may be specified multiple times to build a list of branches
369 If this option is not specified, a branch resolved via the remote
370 repository's HEAD reference will be fetched.
371 Cannot be used together with the
375 Delete branches and tags from the local repository which are no longer
376 present in the remote repository.
377 Only references are deleted.
378 Any commit, tree, tag, and blob objects belonging to deleted branches or
379 tags remain in the repository and may be removed separately with
380 Git's garbage collector.
382 List branches and tags available for fetching from the remote repository
383 and exit immediately.
384 Cannot be used together with any of the other options except
389 Allow existing references in the
391 namespace to be updated if they have changed on the server.
392 If not specified, only new tag references will be created.
393 .It Fl r Ar repository-path
394 Use the repository at the specified path.
395 If not specified, assume the repository is located at or above the current
397 If this directory is a
399 work tree, use the repository path associated with this work tree.
401 Suppress progress reporting output.
402 The same option will be passed to
409 to print debugging messages to standard error output.
410 The same option will be passed to
413 Multiple -v options increase the verbosity.
415 .It Fl R Ar reference
416 In addition to the branches and tags that will be fetched, fetch an arbitrary
418 from the remote repository's
421 This option may be specified multiple times to build a list of additional
425 may either be a path to a specific reference, or a reference namespace
426 which will cause all references in this namespace to be fetched.
428 Each reference will be mapped into the local repository's
430 namespace, unless the local repository was created as a mirror with
432 in which case references will be mapped directly into the local repository's
436 Once a reference has been fetched, a local branch based on it can be
442 will refuse to fetch references from the remote repository's
451 .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
452 Copy files from a repository into a new work tree.
453 Show the status of each affected file, using the following status codes:
454 .Bl -column YXZ description
455 .It A Ta new file was added
456 .It E Ta file already exists in work tree's meta-data
461 is not specified, either use the last component of
462 .Ar repository path ,
465 was specified use the last component of
473 Proceed with the checkout operation even if the directory at
476 Existing files will be left intact.
478 Check out files from a commit on the specified
480 If this option is not specified, a branch resolved via the repository's HEAD
481 reference will be used.
483 Check out files from the specified
485 on the selected branch.
486 The expected argument is a commit ID SHA1 hash or an existing reference
487 or tag name which will be resolved to a commit ID.
488 An abbreviated hash argument will be expanded to a full SHA1 hash
489 automatically, provided the abbreviation is unique.
490 If this option is not specified, the most recent commit on the selected
495 is not contained in the selected branch, a different branch which contains
496 this commit must be specified with the
499 If no such branch is known a new branch must be created for this
505 Checking out work trees with an unknown branch is intentionally not supported.
506 .It Fl p Ar path-prefix
507 Restrict the work tree to a subset of the repository's tree hierarchy.
508 Only files beneath the specified
515 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
516 Update an existing work tree to a different commit.
517 Show the status of each affected file, using the following status codes:
518 .Bl -column YXZ description
519 .It U Ta file was updated and contained no local changes
520 .It G Ta file was updated and local changes were merged cleanly
521 .It C Ta file was updated and conflicts occurred during merge
522 .It D Ta file was deleted
523 .It A Ta new file was added
524 .It \(a~ Ta versioned file is obstructed by a non-regular file
525 .It ! Ta a missing versioned file was restored
530 is specified, update the entire work tree.
531 Otherwise, restrict the update operation to files at or within the
533 Each path is required to exist in the update operation's target commit.
534 Files in the work tree outside specified paths will remain unchanged and
535 will retain their previously recorded base commit.
538 commands may refuse to run while the work tree contains files from
539 multiple base commits.
540 The base commit of such a work tree can be made consistent by running
542 across the entire work tree.
545 is incompatible with the
550 cannot update paths with staged changes.
551 If changes have been staged with
553 these changes must first be committed with
563 Switch the work tree's branch reference to the specified
565 before updating the work tree.
566 This option requires that all paths in the work tree are updated.
568 Update the work tree to the specified
570 The expected argument is a commit ID SHA1 hash or an existing reference
571 or tag name which will be resolved to a commit ID.
572 An abbreviated hash argument will be expanded to a full SHA1 hash
573 automatically, provided the abbreviation is unique.
574 If this option is not specified, the most recent commit on the work tree's
580 .It Cm status Op Ar path ...
581 Show the current modification status of files in a work tree,
582 using the following status codes:
583 .Bl -column YXZ description
584 .It M Ta modified file
585 .It A Ta file scheduled for addition in next commit
586 .It D Ta file scheduled for deletion in next commit
587 .It C Ta modified or added file which contains merge conflicts
588 .It ! Ta versioned file was expected on disk but is missing
589 .It \(a~ Ta versioned file is obstructed by a non-regular file
590 .It ? Ta unversioned item not tracked by
592 .It m Ta modified file modes (executable bit only)
593 .It N Ta non-existent
595 specified on the command line
600 is specified, show modifications in the entire work tree.
601 Otherwise, show modifications at or within the specified paths.
603 If changes have been staged with
605 staged changes are shown in the second output column, using the following
607 .Bl -column YXZ description
608 .It M Ta file modification is staged
609 .It A Ta file addition is staged
610 .It D Ta file deletion is staged
613 Changes created on top of staged changes are indicated in the first column:
614 .Bl -column YXZ description
615 .It MM Ta file was modified after earlier changes have been staged
616 .It MA Ta file was modified after having been staged for addition
619 For compatibility with
630 files in each traversed directory and will not display unversioned files
631 which match these patterns.
636 supports consecutive asterisks,
638 which will match an arbitrary amount of directories.
642 only supports a single ignore pattern per line.
646 does not support negated ignore patterns prefixed with
648 and gives no special significance to the location of path component separators,
654 .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
655 Display history of a repository.
658 is specified, show only commits which modified this path.
659 If invoked in a work tree, the
661 is interpreted relative to the current working directory,
662 and the work tree's path prefix is implicitly prepended.
663 Otherwise, the path is interpreted relative to the repository root.
670 Display individual commits which were merged into the current branch
674 shows the linear history of the current branch only.
676 Start traversing history at the specified
678 The expected argument is a commit ID SHA1 hash or an existing reference
679 or tag name which will be resolved to a commit ID.
680 An abbreviated hash argument will be expanded to a full SHA1 hash
681 automatically, provided the abbreviation is unique.
682 If this option is not specified, default to the work tree's current branch
683 if invoked in a work tree, or to the repository's HEAD reference.
685 Set the number of context lines shown in diffs with
687 By default, 3 lines of context are shown.
689 Limit history traversal to a given number of commits.
690 If this option is not specified, a default limit value of zero is used,
691 which is treated as an unbounded limit.
693 .Ev GOT_LOG_DEFAULT_LIMIT
694 environment variable may be set to change this default value.
696 Display the patch of modifications made in each commit.
699 is specified, only show the patch of modifications at or within this path.
700 .It Fl s Ar search-pattern
701 If specified, show only commits with a log message matched by the extended
704 Regular expression syntax is documented in
706 .It Fl r Ar repository-path
707 Use the repository at the specified path.
708 If not specified, assume the repository is located at or above the current
710 If this directory is a
712 work tree, use the repository path associated with this work tree.
714 .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
715 When invoked within a work tree with less than two arguments, display
716 uncommitted changes in the work tree.
719 is specified, only show changes within this path.
721 If two arguments are provided, treat each argument as a reference, a tag
722 name, or an object ID SHA1 hash, and display differences between the
723 corresponding objects.
724 Both objects must be of the same type (blobs, trees, or commits).
725 An abbreviated hash argument will be expanded to a full SHA1 hash
726 automatically, provided the abbreviation is unique.
733 Set the number of context lines shown in the diff.
734 By default, 3 lines of context are shown.
735 .It Fl r Ar repository-path
736 Use the repository at the specified path.
737 If not specified, assume the repository is located at or above the current
739 If this directory is a
741 work tree, use the repository path associated with this work tree.
743 Show changes staged with
745 instead of showing local changes.
746 This option is only valid when
748 is invoked in a work tree.
750 Ignore whitespace-only changes.
755 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
756 Display line-by-line history of a file at the specified path.
763 Start traversing history at the specified
765 The expected argument is a commit ID SHA1 hash or an existing reference
766 or tag name which will be resolved to a commit ID.
767 An abbreviated hash argument will be expanded to a full SHA1 hash
768 automatically, provided the abbreviation is unique.
769 .It Fl r Ar repository-path
770 Use the repository at the specified path.
771 If not specified, assume the repository is located at or above the current
773 If this directory is a
775 work tree, use the repository path associated with this work tree.
780 .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
781 Display a listing of files and directories at the specified
782 directory path in the repository.
783 Entries shown in this listing may carry one of the following trailing
785 .Bl -column YXZ description
786 .It @ Ta entry is a symbolic link
787 .It / Ta entry is a directory
788 .It * Ta entry is an executable file
789 .It $ Ta entry is a Git submodule
794 is specified, list the repository path corresponding to the current
795 directory of the work tree, or the root directory of the repository
796 if there is no work tree.
803 List files and directories as they appear in the specified
805 The expected argument is a commit ID SHA1 hash or an existing reference
806 or tag name which will be resolved to a commit ID.
807 An abbreviated hash argument will be expanded to a full SHA1 hash
808 automatically, provided the abbreviation is unique.
809 .It Fl r Ar repository-path
810 Use the repository at the specified path.
811 If not specified, assume the repository is located at or above the current
813 If this directory is a
815 work tree, use the repository path associated with this work tree.
817 Show object IDs of files (blob objects) and directories (tree objects).
819 Recurse into sub-directories in the repository.
824 .It Cm ref Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl c Ar object Oc Oo Fl s Ar reference Oc Oo Fl d Oc Op Ar name
825 Manage references in a repository.
827 References may be listed, created, deleted, and changed.
828 When creating, deleting, or changing a reference the specified
830 must be an absolute reference name, i.e. it must begin with
838 .It Fl r Ar repository-path
839 Use the repository at the specified path.
840 If not specified, assume the repository is located at or above the current
842 If this directory is a
844 work tree, use the repository path associated with this work tree.
846 List references in the repository.
849 is specified, list all existing references in the repository.
852 is a reference namespace, list all references in this namespace.
853 Otherwise, show only the reference with the given
855 Cannot be used together with any other options except
858 Create a reference or change an existing reference.
859 The reference with the specified
861 will point at the specified
865 argument is a ID SHA1 hash or an existing reference or tag name which will
866 be resolved to the ID of a corresponding commit, tree, tag, or blob object.
867 Cannot be used together with any other options except
869 .It Fl s Ar reference
870 Create a symbolic reference, or change an existing symbolic reference.
871 The symbolic reference with the specified
873 will point at the specified
875 which must already exist in the repository.
876 Care should be taken not to create loops between references when
878 Cannot be used together with any other options except
881 Delete the reference with the specified
884 Cannot be used together with any other options except
887 .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
888 Create, list, or delete branches.
890 Branches are managed via references which live in the
895 command operates on references in this namespace only.
897 If invoked in a work tree without any arguments, print the name of the
898 work tree's current branch.
902 argument is passed, attempt to create a branch reference with the given name.
903 By default the new branch reference will point at the latest commit on the
904 work tree's current branch if invoked in a work tree, and otherwise to a commit
905 resolved via the repository's HEAD reference.
907 If invoked in a work tree, once the branch was created successfully
908 switch the work tree's head reference to the newly created branch and
909 update files across the entire work tree, just like
910 .Cm got update -b Ar name
912 Show the status of each affected file, using the following status codes:
913 .Bl -column YXZ description
914 .It U Ta file was updated and contained no local changes
915 .It G Ta file was updated and local changes were merged cleanly
916 .It C Ta file was updated and conflicts occurred during merge
917 .It D Ta file was deleted
918 .It A Ta new file was added
919 .It \(a~ Ta versioned file is obstructed by a non-regular file
920 .It ! Ta a missing versioned file was restored
928 Make a newly created branch reference point at the specified
932 argument is a commit ID SHA1 hash or an existing reference
933 or tag name which will be resolved to a commit ID.
934 .It Fl r Ar repository-path
935 Use the repository at the specified path.
936 If not specified, assume the repository is located at or above the current
938 If this directory is a
940 work tree, use the repository path associated with this work tree.
942 List all existing branches in the repository.
943 If invoked in a work tree, the work tree's current branch is shown
944 with one the following annotations:
945 .Bl -column YXZ description
946 .It * Ta work tree's base commit matches the branch tip
947 .It \(a~ Ta work tree's base commit is out-of-date
950 Delete the branch with the specified name from the repository.
951 Only the branch reference is deleted.
952 Any commit, tree, and blob objects belonging to the branch
953 remain in the repository and may be removed separately with
954 Git's garbage collector.
956 Do not switch and update the work tree after creating a new branch.
961 .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
962 Manage tags in a repository.
964 Tags are managed via references which live in the
969 command operates on references in this namespace only.
970 References in this namespace point at tag objects which contain a pointer
971 to another object, a tag message, as well as author and timestamp information.
973 Attempt to create a tag with the given
975 and make this tag point at the given
977 If no commit is specified, default to the latest commit on the work tree's
978 current branch if invoked in a work tree, and to a commit resolved via
979 the repository's HEAD reference otherwise.
986 Make the newly created tag reference point at the specified
990 argument is a commit ID SHA1 hash or an existing reference or tag name which
991 will be resolved to a commit ID.
992 An abbreviated hash argument will be expanded to a full SHA1 hash
993 automatically, provided the abbreviation is unique.
995 Use the specified tag message when creating the new tag.
1000 opens a temporary file in an editor where a tag message can be written.
1001 .It Fl r Ar repository-path
1002 Use the repository at the specified path.
1003 If not specified, assume the repository is located at or above the current
1005 If this directory is a
1007 work tree, use the repository path associated with this work tree.
1009 List all existing tags in the repository instead of creating a new tag.
1010 If this option is used, no other command-line arguments are allowed.
1015 command will not delete tags or change existing tags.
1016 If a tag must be deleted, the
1018 command may be used to delete a tag's reference.
1019 This should only be done if the tag has not already been copied to
1021 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
1022 Schedule unversioned files in a work tree for addition to the
1023 repository in the next commit.
1030 Permit recursion into directories.
1031 If this option is not specified,
1033 will refuse to run if a specified
1037 With -R, add files even if they match a
1041 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
1042 Remove versioned files from a work tree and schedule them for deletion
1043 from the repository in the next commit.
1050 Perform the operation even if a file contains uncommitted modifications.
1052 Keep affected files on disk.
1054 Permit recursion into directories.
1055 If this option is not specified,
1057 will refuse to run if a specified
1064 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
1065 Revert any uncommitted changes in files at the specified paths.
1066 File contents will be overwritten with those contained in the
1067 work tree's base commit.
1068 There is no way to bring discarded changes back after
1071 If a file was added with
1073 it will become an unversioned file again.
1074 If a file was deleted with
1076 it will be restored.
1083 Instead of reverting all changes in files, interactively select or reject
1084 changes to revert based on
1090 (quit reverting this file) responses.
1091 If a file is in modified status, individual patches derived from the
1092 modified file content can be reverted.
1093 Files in added or deleted status may only be reverted in their entirety.
1094 .It Fl F Ar response-script
1102 responses line-by-line from the specified
1104 file instead of prompting interactively.
1106 Permit recursion into directories.
1107 If this option is not specified,
1109 will refuse to run if a specified
1116 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
1117 Create a new commit in the repository from changes in a work tree
1118 and use this commit as the new base commit for the work tree.
1121 is specified, commit all changes in the work tree.
1122 Otherwise, commit changes at or within the specified paths.
1124 If changes have been explicitly staged for commit with
1126 only commit staged changes and reject any specified paths which
1127 have not been staged.
1129 Show the status of each affected file, using the following status codes:
1130 .Bl -column YXZ description
1131 .It M Ta modified file
1132 .It D Ta file was deleted
1133 .It A Ta new file was added
1134 .It m Ta modified file modes (executable bit only)
1137 Files which are not part of the new commit will retain their previously
1138 recorded base commit.
1141 commands may refuse to run while the work tree contains files from
1142 multiple base commits.
1143 The base commit of such a work tree can be made consistent by running
1145 across the entire work tree.
1149 command requires the
1151 environment variable to be set,
1156 configuration settings can be
1157 obtained from the repository's
1159 file or from Git's global
1168 Use the specified log message when creating the new commit.
1173 opens a temporary file in an editor where a log message can be written.
1177 will refuse to run if certain preconditions are not met.
1178 If the work tree's current branch is not in the
1180 reference namespace, new commits may not be created on this branch.
1181 Local changes may only be committed if they are based on file content
1182 found in the most recent commit on the work tree's branch.
1183 If a path is found to be out of date,
1185 must be used first in order to merge local changes with changes made
1190 .It Cm cherrypick Ar commit
1191 Merge changes from a single
1196 must be on a different branch than the work tree's base commit.
1197 The expected argument is a reference or a commit ID SHA1 hash.
1198 An abbreviated hash argument will be expanded to a full SHA1 hash
1199 automatically, provided the abbreviation is unique.
1201 Show the status of each affected file, using the following status codes:
1202 .Bl -column YXZ description
1203 .It G Ta file was merged
1204 .It C Ta file was merged and conflicts occurred during merge
1205 .It ! Ta changes destined for a missing file were not merged
1206 .It D Ta file was deleted
1207 .It d Ta file's deletion was obstructed by local modifications
1208 .It A Ta new file was added
1209 .It \(a~ Ta changes destined for a non-regular file were not merged
1212 The merged changes will appear as local changes in the work tree, which
1215 amended manually or with further
1220 or discarded again with
1224 will refuse to run if certain preconditions are not met.
1225 If the work tree contains multiple base commits it must first be updated
1226 to a single base commit with
1228 If the work tree already contains files with merge conflicts, these
1229 conflicts must be resolved first.
1233 .It Cm backout Ar commit
1234 Reverse-merge changes from a single
1239 must be on the same branch as the work tree's base commit.
1240 The expected argument is a reference or a commit ID SHA1 hash.
1241 An abbreviated hash argument will be expanded to a full SHA1 hash
1242 automatically, provided the abbreviation is unique.
1244 Show the status of each affected file, using the following status codes:
1245 .Bl -column YXZ description
1246 .It G Ta file was merged
1247 .It C Ta file was merged and conflicts occurred during merge
1248 .It ! Ta changes destined for a missing file were not merged
1249 .It D Ta file was deleted
1250 .It d Ta file's deletion was obstructed by local modifications
1251 .It A Ta new file was added
1252 .It \(a~ Ta changes destined for a non-regular file were not merged
1255 The reverse-merged changes will appear as local changes in the work tree,
1256 which may be viewed with
1258 amended manually or with further
1263 or discarded again with
1267 will refuse to run if certain preconditions are not met.
1268 If the work tree contains multiple base commits it must first be updated
1269 to a single base commit with
1271 If the work tree already contains files with merge conflicts, these
1272 conflicts must be resolved first.
1276 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1277 Rebase commits on the specified
1279 onto the tip of the current branch of the work tree.
1282 must share common ancestry with the work tree's current branch.
1283 Rebasing begins with the first descendant commit of the youngest
1284 common ancestor commit shared by the specified
1286 and the work tree's current branch, and stops once the tip commit
1293 is used as intended, the specified
1295 represents a local commit history and may already contain changes
1296 that are not yet visible in any other repositories.
1297 The work tree's current branch, which must be set with
1301 operation, represents a branch from a remote repository which shares
1302 a common history with the specified
1304 but has progressed, and perhaps diverged, due to commits added to the
1307 Rebased commits are accumulated on a temporary branch which the work tree
1308 will remain switched to throughout the entire rebase operation.
1309 Commits on this branch represent the same changes with the same log
1310 messages as their counterparts on the original
1312 but with different commit IDs.
1313 Once rebasing has completed successfully, the temporary branch becomes
1314 the new version of the specified
1316 and the work tree is automatically switched to it.
1318 While rebasing commits, show the status of each affected file,
1319 using the following status codes:
1320 .Bl -column YXZ description
1321 .It G Ta file was merged
1322 .It C Ta file was merged and conflicts occurred during merge
1323 .It ! Ta changes destined for a missing file were not merged
1324 .It D Ta file was deleted
1325 .It d Ta file's deletion was obstructed by local modifications
1326 .It A Ta new file was added
1327 .It \(a~ Ta changes destined for a non-regular file were not merged
1330 If merge conflicts occur the rebase operation is interrupted and may
1331 be continued once conflicts have been resolved.
1332 Alternatively, the rebase operation may be aborted which will leave
1334 unmodified and the work tree switched back to its original branch.
1336 If a merge conflict is resolved in a way which renders the merged
1337 change into a no-op change, the corresponding commit will be elided
1338 when the rebase operation continues.
1341 will refuse to run if certain preconditions are not met.
1342 If the work tree is not yet fully updated to the tip commit of its
1343 branch then the work tree must first be updated with
1345 If changes have been staged with
1347 these changes must first be committed with
1351 If the work tree contains local changes, these changes must first be
1358 contains changes to files outside of the work tree's path prefix,
1359 the work tree cannot be used to rebase this branch.
1365 commands will refuse to run while a rebase operation is in progress.
1366 Other commands which manipulate the work tree may be used for
1367 conflict resolution purposes.
1374 Abort an interrupted rebase operation.
1375 If this option is used, no other command-line arguments are allowed.
1377 Continue an interrupted rebase operation.
1378 If this option is used, no other command-line arguments are allowed.
1383 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1384 Edit commit history between the work tree's current base commit and
1385 the tip commit of the work tree's current branch.
1389 operation the work tree's current branch must be set with
1391 to the branch which should be edited, unless this branch is already the
1392 current branch of the work tree.
1393 The tip of this branch represents the upper bound (inclusive) of commits
1398 Furthermore, the work tree's base commit
1401 to a point in this branch's commit history where editing should begin.
1402 This commit represents the lower bound (non-inclusive) of commits touched
1407 Editing of commit history is controlled via a
1409 which can be written in an editor based on a template, passed on the
1410 command line, or generated with the
1412 option if only log messages need to be edited.
1414 The format of the histedit script is line-based.
1415 Each line in the script begins with a command name, followed by
1416 whitespace and an argument.
1417 For most commands, the expected argument is a commit ID SHA1 hash.
1418 Any remaining text on the line is ignored.
1419 Lines which begin with the
1421 character are ignored entirely.
1423 The available commands are as follows:
1424 .Bl -column YXZ pick-commit
1425 .It pick Ar commit Ta Use the specified commit as it is.
1426 .It edit Ar commit Ta Use the specified commit but once changes have been
1427 merged into the work tree interrupt the histedit operation for amending.
1428 .It fold Ar commit Ta Combine the specified commit with the next commit
1429 listed further below that will be used.
1430 .It drop Ar commit Ta Remove this commit from the edited history.
1431 .It mesg Ar log-message Ta Use the specified single-line log message for
1432 the commit on the previous line.
1433 If the log message argument is left empty, open an editor where a new
1434 log message can be written.
1437 Every commit in the history being edited must be mentioned in the script.
1438 Lines may be re-ordered to change the order of commits in the edited history.
1439 No commit may be listed more than once.
1441 Edited commits are accumulated on a temporary branch which the work tree
1442 will remain switched to throughout the entire histedit operation.
1443 Once history editing has completed successfully, the temporary branch becomes
1444 the new version of the work tree's branch and the work tree is automatically
1447 While merging commits, show the status of each affected file,
1448 using the following status codes:
1449 .Bl -column YXZ description
1450 .It G Ta file was merged
1451 .It C Ta file was merged and conflicts occurred during merge
1452 .It ! Ta changes destined for a missing file were not merged
1453 .It D Ta file was deleted
1454 .It d Ta file's deletion was obstructed by local modifications
1455 .It A Ta new file was added
1456 .It \(a~ Ta changes destined for a non-regular file were not merged
1459 If merge conflicts occur the histedit operation is interrupted and may
1460 be continued once conflicts have been resolved.
1461 Alternatively, the histedit operation may be aborted which will leave
1462 the work tree switched back to its original branch.
1464 If a merge conflict is resolved in a way which renders the merged
1465 change into a no-op change, the corresponding commit will be elided
1466 when the histedit operation continues.
1469 will refuse to run if certain preconditions are not met.
1470 If the work tree's current branch is not in the
1472 reference namespace, the history of the branch may not be edited.
1473 If the work tree contains multiple base commits it must first be updated
1474 to a single base commit with
1476 If changes have been staged with
1478 these changes must first be committed with
1482 If the work tree contains local changes, these changes must first be
1487 If the edited history contains changes to files outside of the work tree's
1488 path prefix, the work tree cannot be used to edit the history of this branch.
1495 commands will refuse to run while a histedit operation is in progress.
1496 Other commands which manipulate the work tree may be used, and the
1498 command may be used to commit arbitrary changes to the temporary branch
1499 while the histedit operation is interrupted.
1506 Abort an interrupted histedit operation.
1507 If this option is used, no other command-line arguments are allowed.
1509 Continue an interrupted histedit operation.
1510 If this option is used, no other command-line arguments are allowed.
1511 .It Fl F Ar histedit-script
1514 instead of opening a temporary file in an editor where a histedit script
1517 Edit log messages only.
1518 This option is a quick equivalent to a histedit script which edits
1519 only log messages but otherwise leaves every picked commit as-is.
1522 option can only be used when starting a new histedit operation.
1523 If this option is used, no other command-line arguments are allowed.
1528 .It Cm integrate Ar branch
1529 Integrate the specified
1531 into the work tree's current branch.
1532 Files in the work tree are updated to match the contents on the integrated
1534 and the reference of the work tree's branch is changed to point at the
1535 head commit of the integrated
1538 Both branches can be considered equivalent after integration since they
1539 will be pointing at the same commit.
1540 Both branches remain available for future work, if desired.
1541 In case the integrated
1543 is no longer needed it may be deleted with
1546 Show the status of each affected file, using the following status codes:
1547 .Bl -column YXZ description
1548 .It U Ta file was updated
1549 .It D Ta file was deleted
1550 .It A Ta new file was added
1551 .It \(a~ Ta versioned file is obstructed by a non-regular file
1552 .It ! Ta a missing versioned file was restored
1556 will refuse to run if certain preconditions are not met.
1557 Most importantly, the
1559 must have been rebased onto the work tree's current branch with
1561 before it can be integrated, in order to linearize commit history and
1562 resolve merge conflicts.
1563 If the work tree contains multiple base commits it must first be updated
1564 to a single base commit with
1566 If changes have been staged with
1568 these changes must first be committed with
1572 If the work tree contains local changes, these changes must first be
1580 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1581 Stage local changes for inclusion in the next commit.
1584 is specified, stage all changes in the work tree.
1585 Otherwise, stage changes at or within the specified paths.
1586 Paths may be staged if they are added, modified, or deleted according to
1589 Show the status of each affected file, using the following status codes:
1590 .Bl -column YXZ description
1591 .It A Ta file addition has been staged
1592 .It M Ta file modification has been staged
1593 .It D Ta file deletion has been staged
1596 Staged file contents are saved in newly created blob objects in the repository.
1597 These blobs will be referred to by tree objects once staged changes have been
1600 Staged changes affect the behaviour of
1605 While paths with staged changes exist, the
1607 command will refuse to commit any paths which do not have staged changes.
1608 Local changes created on top of staged changes can only be committed if
1609 the path is staged again, or if the staged changes are committed first.
1612 command will show both local changes and staged changes.
1615 command is able to display local changes relative to staged changes,
1616 and to display staged changes relative to the repository.
1619 command cannot revert staged changes but may be used to revert
1620 local changes created on top of staged changes.
1627 Instead of staging new changes, list paths which are already staged,
1628 along with the IDs of staged blob objects and stage status codes.
1629 If paths were provided in the command line show the staged paths
1630 among the specified paths.
1631 Otherwise, show all staged paths.
1633 Instead of staging the entire content of a changed file, interactively
1634 select or reject changes for staging based on
1638 (reject change), and
1640 (quit staging this file) responses.
1641 If a file is in modified status, individual patches derived from the
1642 modified file content can be staged.
1643 Files in added or deleted status may only be staged or rejected in
1645 .It Fl F Ar response-script
1653 responses line-by-line from the specified
1655 file instead of prompting interactively.
1659 will refuse to run if certain preconditions are not met.
1660 If a file contains merge conflicts, these conflicts must be resolved first.
1661 If a file is found to be out of date relative to the head commit on the
1662 work tree's current branch, the file must be updated with
1664 before it can be staged (however, this does not prevent the file from
1665 becoming out-of-date at some point after having been staged).
1672 commands will refuse to run while staged changes exist.
1673 If staged changes cannot be committed because a staged path
1674 is out of date, the path must be unstaged with
1676 before it can be updated with
1678 and may then be staged again if necessary.
1682 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1683 Merge staged changes back into the work tree and put affected paths
1684 back into non-staged status.
1687 is specified, unstage all staged changes across the entire work tree.
1688 Otherwise, unstage changes at or within the specified paths.
1690 Show the status of each affected file, using the following status codes:
1691 .Bl -column YXZ description
1692 .It G Ta file was unstaged
1693 .It C Ta file was unstaged and conflicts occurred during merge
1694 .It ! Ta changes destined for a missing file were not merged
1695 .It D Ta file was staged as deleted and still is deleted
1696 .It d Ta file's deletion was obstructed by local modifications
1697 .It \(a~ Ta changes destined for a non-regular file were not merged
1705 Instead of unstaging the entire content of a changed file, interactively
1706 select or reject changes for unstaging based on
1710 (keep change staged), and
1712 (quit unstaging this file) responses.
1713 If a file is staged in modified status, individual patches derived from the
1714 staged file content can be unstaged.
1715 Files staged in added or deleted status may only be unstaged in their entirety.
1716 .It Fl F Ar response-script
1724 responses line-by-line from the specified
1726 file instead of prompting interactively.
1731 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1732 Parse and print contents of objects to standard output in a line-based
1734 Content of commit, tree, and tag objects is printed in a way similar
1735 to the actual content stored in such objects.
1736 Blob object contents are printed as they would appear in files on disk.
1738 Attempt to interpret each argument as a reference, a tag name, or
1739 an object ID SHA1 hash.
1740 References will be resolved to an object ID.
1741 Tag names will resolved to a tag object.
1742 An abbreviated hash argument will be expanded to a full SHA1 hash
1743 automatically, provided the abbreviation is unique.
1745 If none of the above interpretations produce a valid result, or if the
1747 option is used, attempt to interpret the argument as a path which will
1748 be resolved to the ID of an object found at this path in the repository.
1755 Look up paths in the specified
1757 If this option is not used, paths are looked up in the commit resolved
1758 via the repository's HEAD reference.
1759 The expected argument is a commit ID SHA1 hash or an existing reference
1760 or tag name which will be resolved to a commit ID.
1761 An abbreviated hash argument will be expanded to a full SHA1 hash
1762 automatically, provided the abbreviation is unique.
1763 .It Fl r Ar repository-path
1764 Use the repository at the specified path.
1765 If not specified, assume the repository is located at or above the current
1767 If this directory is a
1769 work tree, use the repository path associated with this work tree.
1771 Interpret all arguments as paths only.
1772 This option can be used to resolve ambiguity in cases where paths
1773 look like tag names, reference names, or object IDs.
1777 .Bl -tag -width GOT_AUTHOR
1779 The author's name and email address for
1784 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1787 may fail to parse commits without an email address in author data,
1791 environment variables with a missing email address.
1797 configuration settings in the repository's
1799 file will override the value of
1805 configuration settings contained in Git's global
1807 configuration file will be used only if the
1809 environment variable is
1812 .It Ev VISUAL , EDITOR
1813 The editor spawned by
1818 .It Ev GOT_LOG_DEFAULT_LIMIT
1819 The default limit on the number of commits traversed by
1821 If set to zero, the limit is unbounded.
1822 This variable will be silently ignored if it is set to a non-numeric value.
1827 Clone an existing Git repository for use with
1831 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1833 Use of HTTP URLs currently requires
1837 .Dl $ git clone --bare https://github.com/openbsd/src.git
1839 Alternatively, for quick and dirty local testing of
1841 a new Git repository could be created and populated with files,
1842 e.g. from a temporary CVS checkout located at
1845 .Dl $ got init /var/git/src.git
1846 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1848 Check out a work tree from the Git repository to /usr/src:
1850 .Dl $ got checkout /var/git/src.git /usr/src
1852 View local changes in a work tree directory:
1855 .Dl $ got diff | less
1857 Interactively revert selected local changes in a work tree directory:
1859 .Dl $ got revert -p -R\ .
1861 In a work tree or a git repository directory, list all branch references:
1865 In a work tree or a git repository directory, create a new branch called
1866 .Dq unified-buffer-cache
1867 which is forked off the
1871 .Dl $ got branch unified-buffer-cache master
1873 Switch an existing work tree to the branch
1874 .Dq unified-buffer-cache .
1875 Local changes in the work tree will be preserved and merged if necessary:
1877 .Dl $ got update -b unified-buffer-cache
1879 Create a new commit from local changes in a work tree directory.
1880 This new commit will become the head commit of the work tree's current branch:
1884 In a work tree or a git repository directory, view changes committed in
1885 the 3 most recent commits to the work tree's branch, or the branch resolved
1886 via the repository's HEAD reference, respectively:
1888 .Dl $ got log -p -l 3
1890 In a work tree or a git repository directory, log the history of a subdirectory:
1892 .Dl $ got log sys/uvm
1894 While operating inside a work tree, paths are specified relative to the current
1895 working directory, so this command will log the subdirectory
1898 .Dl $ cd sys/uvm && got log '.'
1900 And this command has the same effect:
1902 .Dl $ cd sys/dev/usb && got log ../../uvm
1904 Add new files and remove obsolete files in a work tree directory:
1906 .Dl $ got add sys/uvm/uvm_ubc.c
1907 .Dl $ got remove sys/uvm/uvm_vnode.c
1909 Create a new commit from local changes in a work tree directory
1910 with a pre-defined log message.
1912 .Dl $ got commit -m 'unify the buffer cache'
1914 Update any work tree checked out from the
1915 .Dq unified-buffer-cache
1916 branch to the latest commit on this branch:
1920 Roll file content on the unified-buffer-cache branch back by one commit,
1921 and then fetch the rolled-back change into the work tree as a local change
1922 to be amended and perhaps committed again:
1924 .Dl $ got backout unified-buffer-cache
1925 .Dl $ got commit -m 'roll back previous'
1926 .Dl $ # now back out the previous backout :-)
1927 .Dl $ got backout unified-buffer-cache
1929 Fetch new upstream commits into the local repository's
1936 In a repository created with a HTTP URL and
1937 .Cm git clone --bare
1940 command must be used instead:
1942 .Dl $ cd /var/git/src.git
1943 .Dl $ git fetch origin master:refs/remotes/origin/master
1947 branch to merge the new changes that are now visible on the
1952 .Dl $ got update -b origin/master
1953 .Dl $ got rebase master
1956 .Dq unified-buffer-cache
1957 branch on top of the new head commit of the
1961 .Dl $ got update -b master
1962 .Dl $ got rebase unified-buffer-cache
1964 Create a patch from all changes on the unified-buffer-cache branch.
1965 The patch can be mailed out for review and applied to
1969 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1971 Edit the entire commit history of the
1972 .Dq unified-buffer-cache
1975 .Dl $ got update -b unified-buffer-cache
1976 .Dl $ got update -c master
1979 In order to merge changes committed to the
1980 .Dq unified-buffer-cache
1981 branch back into the
1984 .Dq unified-buffer-cache
1985 branch must first be rebased onto the
1989 .Dl $ got update -b master
1990 .Dl $ got rebase unified-buffer-cache
1993 .Dq unified-buffer-cache
1994 branch can now be made visible on the
1998 Because the rebase operation switched the work tree to the
1999 .Dq unified-buffer-cache
2000 branch, the work tree must be switched back to the
2003 .Dq unified-buffer-cache
2004 branch can be integrated into
2007 .Dl $ got update -b master
2008 .Dl $ got integrate unified-buffer-cache
2010 Additional steps may be necessary if local changes need to be pushed back
2011 to the remote repository, which currently requires
2013 Before working against existing branches in a repository cloned with
2014 .Cm git clone --bare
2019 must be configured to map all references in the remote repository
2022 namespace of the local repository.
2023 This can achieved by setting Git's
2024 .Pa remote.origin.fetch
2025 configuration variable to the value
2026 .Dq +refs/heads/*:refs/remotes/origin/*
2031 .Dl $ cd /var/git/repo
2032 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
2036 option must be disabled:
2038 .Dl $ cd /var/git/repo
2039 .Dl $ git config remote.origin.mirror false
2041 Alternatively, the following
2043 configuration item can be added manually to the Git repository's
2047 .Dl [remote "origin"]
2049 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
2052 This configuration leaves the local repository's
2054 namespace free for use by local branches checked out with
2056 and, if needed, created with
2061 namespace can now be updated with incoming changes from the remote
2066 without extra command line arguments:
2068 .Dl $ cd /var/git/repo
2071 To make changes fetched from the remote repository appear on the
2075 branch must be rebased onto the
2078 This will also merge local changes, if any, with the incoming changes:
2080 .Dl $ got update -b origin/master
2081 .Dl $ got rebase master
2085 branch, log messages for local changes can now be amended with
2087 by other developers and any other important new information:
2089 .Dl $ got update -c origin/master
2090 .Dl $ got histedit -m
2092 Local changes on the
2094 branch can then be pushed to the remote
2098 .Dl $ cd /var/git/repo
2099 .Dl $ git push origin master
2102 .Xr git-repository 5 ,
2105 .An Stefan Sperling Aq Mt stsp@openbsd.org
2106 .An Martin Pieuchot Aq Mt mpi@openbsd.org
2107 .An Joshua Stein Aq Mt jcs@openbsd.org
2108 .An Ori Bernstein Aq Mt ori@openbsd.org
2111 is a work-in-progress and many commands remain to be implemented.
2112 At present, the user has to fall back on
2114 to perform many tasks, in particular tasks related to repository
2115 administration and tasks which require a network connection.
