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 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 repository's HEAD
207 reference will be fetched.
209 Create the cloned repository as a mirror of the original repository.
210 This is useful if the cloned repository will not be used to store
211 local changes as created by
216 file will be set up with the
218 option enabled, such that
222 will write incoming changes directly to branches in the
224 reference namespace, rather than to branches in the
227 This avoids the usual requirement of having to run
231 in order to make incoming changes appear on branches in the
234 But maintaining custom branches with local changes in the cloned
235 repository becomes difficult since local changes are at risk of
236 being discarded whenever incoming changes are fetched.
238 Suppress progress reporting output.
239 The same option will be passed to
243 Increase the verbosity of progress reporting output.
244 The same option will be passed to
247 Multiple -v options increase the verbosity.
253 .It Cm fetch Oo Fl a Oc Oo Fl r Ar repository-path Oc Oo Fl q Oc Oo Fl v Oc Op Ar remote-repository-name
254 Fetch new changes from a remote repository.
256 .Ar remote-repository-name
257 is specified the name
260 The remote repository's URL is obtained from the corresponding entry in the
262 file of the repository, as created by
265 New changes will be stored in a separate pack file downloaded from the server.
266 Optionally, separate pack files stored in the repository can be combined with
269 Branch references in the
271 reference namespace will be updated to point at the newly fetched commits,
274 command can then be used to make new changes visible on branches in the
276 reference namespace, merging incoming changes with local changes as necessary.
278 However, if the repository is configured as a mirror then all references will
279 be updated as needed to match the corresponding references in the remote
280 repository, including branches in the
283 If those branches contained local commits, these commits will no longer be
284 reachable via a reference and will therefore be at risk of being discarded
285 by Git's garbage collector.
287 In any case, existing references in the
289 namespace will always be changed to match tags contained in the remote
297 Fetch all branches from the remote repository.
298 If this option is not specified, a branch resolved via the repository's HEAD
299 reference will be fetched.
300 .It Fl r Ar repository-path
301 Use the repository at the specified path.
302 If not specified, assume the repository is located at or above the current
304 If this directory is a
306 work tree, use the repository path associated with this work tree.
308 Suppress progress reporting output.
309 The same option will be passed to
313 Increase the verbosity of progress reporting output.
314 The same option will be passed to
317 Multiple -v options increase the verbosity.
323 .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
324 Copy files from a repository into a new work tree.
325 Show the status of each affected file, using the following status codes:
326 .Bl -column YXZ description
327 .It A Ta new file was added
328 .It E Ta file already exists in work tree's meta-data
333 is not specified, either use the last component of
334 .Ar repository path ,
337 was specified use the last component of
345 Proceed with the checkout operation even if the directory at
348 Existing files will be left intact.
350 Check out files from a commit on the specified
352 If this option is not specified, a branch resolved via the repository's HEAD
353 reference will be used.
355 Check out files from the specified
357 on the selected branch.
358 The expected argument is a commit ID SHA1 hash or an existing reference
359 or tag name which will be resolved to a commit ID.
360 An abbreviated hash argument will be expanded to a full SHA1 hash
361 automatically, provided the abbreviation is unique.
362 If this option is not specified, the most recent commit on the selected
367 is not contained in the selected branch, a different branch which contains
368 this commit must be specified with the
371 If no such branch is known a new branch must be created for this
377 Checking out work trees with an unknown branch is intentionally not supported.
378 .It Fl p Ar path-prefix
379 Restrict the work tree to a subset of the repository's tree hierarchy.
380 Only files beneath the specified
387 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
388 Update an existing work tree to a different commit.
389 Show the status of each affected file, using the following status codes:
390 .Bl -column YXZ description
391 .It U Ta file was updated and contained no local changes
392 .It G Ta file was updated and local changes were merged cleanly
393 .It C Ta file was updated and conflicts occurred during merge
394 .It D Ta file was deleted
395 .It A Ta new file was added
396 .It \(a~ Ta versioned file is obstructed by a non-regular file
397 .It ! Ta a missing versioned file was restored
402 is specified, update the entire work tree.
403 Otherwise, restrict the update operation to files at or within the
405 Each path is required to exist in the update operation's target commit.
406 Files in the work tree outside specified paths will remain unchanged and
407 will retain their previously recorded base commit.
410 commands may refuse to run while the work tree contains files from
411 multiple base commits.
412 The base commit of such a work tree can be made consistent by running
414 across the entire work tree.
417 is incompatible with the
422 cannot update paths with staged changes.
423 If changes have been staged with
425 these changes must first be committed with
435 Switch the work tree's branch reference to the specified
437 before updating the work tree.
438 This option requires that all paths in the work tree are updated.
440 Update the work tree to the specified
442 The expected argument is a commit ID SHA1 hash or an existing reference
443 or tag name which will be resolved to a commit ID.
444 An abbreviated hash argument will be expanded to a full SHA1 hash
445 automatically, provided the abbreviation is unique.
446 If this option is not specified, the most recent commit on the work tree's
452 .It Cm status Op Ar path ...
453 Show the current modification status of files in a work tree,
454 using the following status codes:
455 .Bl -column YXZ description
456 .It M Ta modified file
457 .It A Ta file scheduled for addition in next commit
458 .It D Ta file scheduled for deletion in next commit
459 .It C Ta modified or added file which contains merge conflicts
460 .It ! Ta versioned file was expected on disk but is missing
461 .It \(a~ Ta versioned file is obstructed by a non-regular file
462 .It ? Ta unversioned item not tracked by
464 .It m Ta modified file modes (executable bit only)
465 .It N Ta non-existent
467 specified on the command line
472 is specified, show modifications in the entire work tree.
473 Otherwise, show modifications at or within the specified paths.
475 If changes have been staged with
477 staged changes are shown in the second output column, using the following
479 .Bl -column YXZ description
480 .It M Ta file modification is staged
481 .It A Ta file addition is staged
482 .It D Ta file deletion is staged
485 Changes created on top of staged changes are indicated in the first column:
486 .Bl -column YXZ description
487 .It MM Ta file was modified after earlier changes have been staged
488 .It MA Ta file was modified after having been staged for addition
491 For compatibility with
502 files in each traversed directory and will not display unversioned files
503 which match these patterns.
508 supports consecutive asterisks,
510 which will match an arbitrary amount of directories.
514 only supports a single ignore pattern per line.
518 does not support negated ignore patterns prefixed with
520 and gives no special significance to the location of path component separators,
526 .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
527 Display history of a repository.
530 is specified, show only commits which modified this path.
531 If invoked in a work tree, the
533 is interpreted relative to the current working directory,
534 and the work tree's path prefix is implicitly prepended.
535 Otherwise, the path is interpreted relative to the repository root.
542 Display individual commits which were merged into the current branch
546 shows the linear history of the current branch only.
548 Start traversing history at the specified
550 The expected argument is a commit ID SHA1 hash or an existing reference
551 or tag name which will be resolved to a commit ID.
552 An abbreviated hash argument will be expanded to a full SHA1 hash
553 automatically, provided the abbreviation is unique.
554 If this option is not specified, default to the work tree's current branch
555 if invoked in a work tree, or to the repository's HEAD reference.
557 Set the number of context lines shown in diffs with
559 By default, 3 lines of context are shown.
561 Limit history traversal to a given number of commits.
562 If this option is not specified, a default limit value of zero is used,
563 which is treated as an unbounded limit.
565 .Ev GOT_LOG_DEFAULT_LIMIT
566 environment variable may be set to change this default value.
568 Display the patch of modifications made in each commit.
571 is specified, only show the patch of modifications at or within this path.
572 .It Fl s Ar search-pattern
573 If specified, show only commits with a log message matched by the extended
576 Regular expression syntax is documented in
578 .It Fl r Ar repository-path
579 Use the repository at the specified path.
580 If not specified, assume the repository is located at or above the current
582 If this directory is a
584 work tree, use the repository path associated with this work tree.
586 .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
587 When invoked within a work tree with less than two arguments, display
588 uncommitted changes in the work tree.
591 is specified, only show changes within this path.
593 If two arguments are provided, treat each argument as a reference, a tag
594 name, or an object ID SHA1 hash, and display differences between the
595 corresponding objects.
596 Both objects must be of the same type (blobs, trees, or commits).
597 An abbreviated hash argument will be expanded to a full SHA1 hash
598 automatically, provided the abbreviation is unique.
605 Set the number of context lines shown in the diff.
606 By default, 3 lines of context are shown.
607 .It Fl r Ar repository-path
608 Use the repository at the specified path.
609 If not specified, assume the repository is located at or above the current
611 If this directory is a
613 work tree, use the repository path associated with this work tree.
615 Show changes staged with
617 instead of showing local changes.
618 This option is only valid when
620 is invoked in a work tree.
622 Ignore whitespace-only changes.
627 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
628 Display line-by-line history of a file at the specified path.
635 Start traversing history at the specified
637 The expected argument is a commit ID SHA1 hash or an existing reference
638 or tag name which will be resolved to a commit ID.
639 An abbreviated hash argument will be expanded to a full SHA1 hash
640 automatically, provided the abbreviation is unique.
641 .It Fl r Ar repository-path
642 Use the repository at the specified path.
643 If not specified, assume the repository is located at or above the current
645 If this directory is a
647 work tree, use the repository path associated with this work tree.
652 .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
653 Display a listing of files and directories at the specified
654 directory path in the repository.
655 Entries shown in this listing may carry one of the following trailing
657 .Bl -column YXZ description
658 .It @ Ta entry is a symbolic link
659 .It / Ta entry is a directory
660 .It * Ta entry is an executable file
661 .It $ Ta entry is a Git submodule
666 is specified, list the repository path corresponding to the current
667 directory of the work tree, or the root directory of the repository
668 if there is no work tree.
675 List files and directories as they appear in the specified
677 The expected argument is a commit ID SHA1 hash or an existing reference
678 or tag name which will be resolved to a commit ID.
679 An abbreviated hash argument will be expanded to a full SHA1 hash
680 automatically, provided the abbreviation is unique.
681 .It Fl r Ar repository-path
682 Use the repository at the specified path.
683 If not specified, assume the repository is located at or above the current
685 If this directory is a
687 work tree, use the repository path associated with this work tree.
689 Show object IDs of files (blob objects) and directories (tree objects).
691 Recurse into sub-directories in the repository.
696 .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
697 Manage references in a repository.
699 If no options are passed, expect two arguments and attempt to create,
700 or update, the reference with the given
702 and make it point at the given
704 The name must be an absolute reference name, i.e. it must begin with
706 The target may be an object ID SHA1 hash or an existing reference which
707 will be resolved to an object ID.
708 An abbreviated hash argument will be expanded to a full SHA1 hash
709 automatically, provided the abbreviation is unique.
715 .It Fl r Ar repository-path
716 Use the repository at the specified path.
717 If not specified, assume the repository is located at or above the current
719 If this directory is a
721 work tree, use the repository path associated with this work tree.
723 List all existing references in the repository.
725 Delete the reference with the specified name from the repository.
727 Create a symbolic reference pointing at the specified
729 which must be an existing reference.
730 Care should be taken not to create loops between references when
733 .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
734 Create, list, or delete branches.
736 Branches are managed via references which live in the
741 command operates on references in this namespace only.
743 If invoked in a work tree without any arguments, print the name of the
744 work tree's current branch.
748 argument is passed, attempt to create a branch reference with the given name.
749 By default the new branch reference will point at the latest commit on the
750 work tree's current branch if invoked in a work tree, and otherwise to a commit
751 resolved via the repository's HEAD reference.
753 If invoked in a work tree, once the branch was created successfully
754 switch the work tree's head reference to the newly created branch and
755 update files across the entire work tree, just like
756 .Cm got update -b Ar name
758 Show the status of each affected file, using the following status codes:
759 .Bl -column YXZ description
760 .It U Ta file was updated and contained no local changes
761 .It G Ta file was updated and local changes were merged cleanly
762 .It C Ta file was updated and conflicts occurred during merge
763 .It D Ta file was deleted
764 .It A Ta new file was added
765 .It \(a~ Ta versioned file is obstructed by a non-regular file
766 .It ! Ta a missing versioned file was restored
774 Make a newly created branch reference point at the specified
778 argument is a commit ID SHA1 hash or an existing reference
779 or tag name which will be resolved to a commit ID.
780 .It Fl r Ar repository-path
781 Use the repository at the specified path.
782 If not specified, assume the repository is located at or above the current
784 If this directory is a
786 work tree, use the repository path associated with this work tree.
788 List all existing branches in the repository.
789 If invoked in a work tree, the work tree's current branch is shown
790 with one the following annotations:
791 .Bl -column YXZ description
792 .It * Ta work tree's base commit matches the branch tip
793 .It \(a~ Ta work tree's base commit is out-of-date
796 Delete the branch with the specified name from the repository.
797 Only the branch reference is deleted.
798 Any commit, tree, and blob objects belonging to the branch
799 remain in the repository and may be removed separately with
800 Git's garbage collector.
802 Do not switch and update the work tree after creating a new branch.
807 .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
808 Manage tags in a repository.
810 Tags are managed via references which live in the
815 command operates on references in this namespace only.
816 References in this namespace point at tag objects which contain a pointer
817 to another object, a tag message, as well as author and timestamp information.
819 Attempt to create a tag with the given
821 and make this tag point at the given
823 If no commit is specified, default to the latest commit on the work tree's
824 current branch if invoked in a work tree, and to a commit resolved via
825 the repository's HEAD reference otherwise.
832 Make the newly created tag reference point at the specified
836 argument is a commit ID SHA1 hash or an existing reference or tag name which
837 will be resolved to a commit ID.
838 An abbreviated hash argument will be expanded to a full SHA1 hash
839 automatically, provided the abbreviation is unique.
841 Use the specified tag message when creating the new tag.
846 opens a temporary file in an editor where a tag message can be written.
847 .It Fl r Ar repository-path
848 Use the repository at the specified path.
849 If not specified, assume the repository is located at or above the current
851 If this directory is a
853 work tree, use the repository path associated with this work tree.
855 List all existing tags in the repository instead of creating a new tag.
856 If this option is used, no other command-line arguments are allowed.
861 command will not delete tags or change existing tags.
862 If a tag must be deleted, the
864 command may be used to delete a tag's reference.
865 This should only be done if the tag has not already been copied to
867 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
868 Schedule unversioned files in a work tree for addition to the
869 repository in the next commit.
876 Permit recursion into directories.
877 If this option is not specified,
879 will refuse to run if a specified
883 With -R, add files even if they match a
887 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
888 Remove versioned files from a work tree and schedule them for deletion
889 from the repository in the next commit.
896 Perform the operation even if a file contains uncommitted modifications.
898 Keep affected files on disk.
900 Permit recursion into directories.
901 If this option is not specified,
903 will refuse to run if a specified
910 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
911 Revert any uncommitted changes in files at the specified paths.
912 File contents will be overwritten with those contained in the
913 work tree's base commit.
914 There is no way to bring discarded changes back after
917 If a file was added with
919 it will become an unversioned file again.
920 If a file was deleted with
929 Instead of reverting all changes in files, interactively select or reject
930 changes to revert based on
936 (quit reverting this file) responses.
937 If a file is in modified status, individual patches derived from the
938 modified file content can be reverted.
939 Files in added or deleted status may only be reverted in their entirety.
940 .It Fl F Ar response-script
948 responses line-by-line from the specified
950 file instead of prompting interactively.
952 Permit recursion into directories.
953 If this option is not specified,
955 will refuse to run if a specified
962 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
963 Create a new commit in the repository from changes in a work tree
964 and use this commit as the new base commit for the work tree.
967 is specified, commit all changes in the work tree.
968 Otherwise, commit changes at or within the specified paths.
970 If changes have been explicitly staged for commit with
972 only commit staged changes and reject any specified paths which
973 have not been staged.
975 Show the status of each affected file, using the following status codes:
976 .Bl -column YXZ description
977 .It M Ta modified file
978 .It D Ta file was deleted
979 .It A Ta new file was added
980 .It m Ta modified file modes (executable bit only)
983 Files which are not part of the new commit will retain their previously
984 recorded base commit.
987 commands may refuse to run while the work tree contains files from
988 multiple base commits.
989 The base commit of such a work tree can be made consistent by running
991 across the entire work tree.
997 environment variable to be set,
1002 configuration settings can be
1003 obtained from the repository's
1005 file or from Git's global
1014 Use the specified log message when creating the new commit.
1019 opens a temporary file in an editor where a log message can be written.
1023 will refuse to run if certain preconditions are not met.
1024 If the work tree's current branch is not in the
1026 reference namespace, new commits may not be created on this branch.
1027 Local changes may only be committed if they are based on file content
1028 found in the most recent commit on the work tree's branch.
1029 If a path is found to be out of date,
1031 must be used first in order to merge local changes with changes made
1036 .It Cm cherrypick Ar commit
1037 Merge changes from a single
1042 must be on a different branch than the work tree's base commit.
1043 The expected argument is a reference or a commit ID SHA1 hash.
1044 An abbreviated hash argument will be expanded to a full SHA1 hash
1045 automatically, provided the abbreviation is unique.
1047 Show the status of each affected file, using the following status codes:
1048 .Bl -column YXZ description
1049 .It G Ta file was merged
1050 .It C Ta file was merged and conflicts occurred during merge
1051 .It ! Ta changes destined for a missing file were not merged
1052 .It D Ta file was deleted
1053 .It d Ta file's deletion was obstructed by local modifications
1054 .It A Ta new file was added
1055 .It \(a~ Ta changes destined for a non-regular file were not merged
1058 The merged changes will appear as local changes in the work tree, which
1061 amended manually or with further
1066 or discarded again with
1070 will refuse to run if certain preconditions are not met.
1071 If the work tree contains multiple base commits it must first be updated
1072 to a single base commit with
1074 If the work tree already contains files with merge conflicts, these
1075 conflicts must be resolved first.
1079 .It Cm backout Ar commit
1080 Reverse-merge changes from a single
1085 must be on the same branch as the work tree's base commit.
1086 The expected argument is a reference or a commit ID SHA1 hash.
1087 An abbreviated hash argument will be expanded to a full SHA1 hash
1088 automatically, provided the abbreviation is unique.
1090 Show the status of each affected file, using the following status codes:
1091 .Bl -column YXZ description
1092 .It G Ta file was merged
1093 .It C Ta file was merged and conflicts occurred during merge
1094 .It ! Ta changes destined for a missing file were not merged
1095 .It D Ta file was deleted
1096 .It d Ta file's deletion was obstructed by local modifications
1097 .It A Ta new file was added
1098 .It \(a~ Ta changes destined for a non-regular file were not merged
1101 The reverse-merged changes will appear as local changes in the work tree,
1102 which may be viewed with
1104 amended manually or with further
1109 or discarded again with
1113 will refuse to run if certain preconditions are not met.
1114 If the work tree contains multiple base commits it must first be updated
1115 to a single base commit with
1117 If the work tree already contains files with merge conflicts, these
1118 conflicts must be resolved first.
1122 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
1123 Rebase commits on the specified
1125 onto the tip of the current branch of the work tree.
1128 must share common ancestry with the work tree's current branch.
1129 Rebasing begins with the first descendant commit of the youngest
1130 common ancestor commit shared by the specified
1132 and the work tree's current branch, and stops once the tip commit
1139 is used as intended, the specified
1141 represents a local commit history and may already contain changes
1142 that are not yet visible in any other repositories.
1143 The work tree's current branch, which must be set with
1147 operation, represents a branch from a remote repository which shares
1148 a common history with the specified
1150 but has progressed, and perhaps diverged, due to commits added to the
1153 Rebased commits are accumulated on a temporary branch which the work tree
1154 will remain switched to throughout the entire rebase operation.
1155 Commits on this branch represent the same changes with the same log
1156 messages as their counterparts on the original
1158 but with different commit IDs.
1159 Once rebasing has completed successfully, the temporary branch becomes
1160 the new version of the specified
1162 and the work tree is automatically switched to it.
1164 While rebasing commits, show the status of each affected file,
1165 using the following status codes:
1166 .Bl -column YXZ description
1167 .It G Ta file was merged
1168 .It C Ta file was merged and conflicts occurred during merge
1169 .It ! Ta changes destined for a missing file were not merged
1170 .It D Ta file was deleted
1171 .It d Ta file's deletion was obstructed by local modifications
1172 .It A Ta new file was added
1173 .It \(a~ Ta changes destined for a non-regular file were not merged
1176 If merge conflicts occur the rebase operation is interrupted and may
1177 be continued once conflicts have been resolved.
1178 Alternatively, the rebase operation may be aborted which will leave
1180 unmodified and the work tree switched back to its original branch.
1182 If a merge conflict is resolved in a way which renders the merged
1183 change into a no-op change, the corresponding commit will be elided
1184 when the rebase operation continues.
1187 will refuse to run if certain preconditions are not met.
1188 If the work tree is not yet fully updated to the tip commit of its
1189 branch then the work tree must first be updated with
1191 If changes have been staged with
1193 these changes must first be committed with
1197 If the work tree contains local changes, these changes must first be
1204 contains changes to files outside of the work tree's path prefix,
1205 the work tree cannot be used to rebase this branch.
1211 commands will refuse to run while a rebase operation is in progress.
1212 Other commands which manipulate the work tree may be used for
1213 conflict resolution purposes.
1220 Abort an interrupted rebase operation.
1221 If this option is used, no other command-line arguments are allowed.
1223 Continue an interrupted rebase operation.
1224 If this option is used, no other command-line arguments are allowed.
1229 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1230 Edit commit history between the work tree's current base commit and
1231 the tip commit of the work tree's current branch.
1235 operation the work tree's current branch must be set with
1237 to the branch which should be edited, unless this branch is already the
1238 current branch of the work tree.
1239 The tip of this branch represents the upper bound (inclusive) of commits
1244 Furthermore, the work tree's base commit
1247 to a point in this branch's commit history where editing should begin.
1248 This commit represents the lower bound (non-inclusive) of commits touched
1253 Editing of commit history is controlled via a
1255 which can be written in an editor based on a template, passed on the
1256 command line, or generated with the
1258 option if only log messages need to be edited.
1260 The format of the histedit script is line-based.
1261 Each line in the script begins with a command name, followed by
1262 whitespace and an argument.
1263 For most commands, the expected argument is a commit ID SHA1 hash.
1264 Any remaining text on the line is ignored.
1265 Lines which begin with the
1267 character are ignored entirely.
1269 The available commands are as follows:
1270 .Bl -column YXZ pick-commit
1271 .It pick Ar commit Ta Use the specified commit as it is.
1272 .It edit Ar commit Ta Use the specified commit but once changes have been
1273 merged into the work tree interrupt the histedit operation for amending.
1274 .It fold Ar commit Ta Combine the specified commit with the next commit
1275 listed further below that will be used.
1276 .It drop Ar commit Ta Remove this commit from the edited history.
1277 .It mesg Ar log-message Ta Use the specified single-line log message for
1278 the commit on the previous line.
1279 If the log message argument is left empty, open an editor where a new
1280 log message can be written.
1283 Every commit in the history being edited must be mentioned in the script.
1284 Lines may be re-ordered to change the order of commits in the edited history.
1285 No commit may be listed more than once.
1287 Edited commits are accumulated on a temporary branch which the work tree
1288 will remain switched to throughout the entire histedit operation.
1289 Once history editing has completed successfully, the temporary branch becomes
1290 the new version of the work tree's branch and the work tree is automatically
1293 While merging commits, show the status of each affected file,
1294 using the following status codes:
1295 .Bl -column YXZ description
1296 .It G Ta file was merged
1297 .It C Ta file was merged and conflicts occurred during merge
1298 .It ! Ta changes destined for a missing file were not merged
1299 .It D Ta file was deleted
1300 .It d Ta file's deletion was obstructed by local modifications
1301 .It A Ta new file was added
1302 .It \(a~ Ta changes destined for a non-regular file were not merged
1305 If merge conflicts occur the histedit operation is interrupted and may
1306 be continued once conflicts have been resolved.
1307 Alternatively, the histedit operation may be aborted which will leave
1308 the work tree switched back to its original branch.
1310 If a merge conflict is resolved in a way which renders the merged
1311 change into a no-op change, the corresponding commit will be elided
1312 when the histedit operation continues.
1315 will refuse to run if certain preconditions are not met.
1316 If the work tree's current branch is not in the
1318 reference namespace, the history of the branch may not be edited.
1319 If the work tree contains multiple base commits it must first be updated
1320 to a single base commit with
1322 If changes have been staged with
1324 these changes must first be committed with
1328 If the work tree contains local changes, these changes must first be
1333 If the edited history contains changes to files outside of the work tree's
1334 path prefix, the work tree cannot be used to edit the history of this branch.
1341 commands will refuse to run while a histedit operation is in progress.
1342 Other commands which manipulate the work tree may be used, and the
1344 command may be used to commit arbitrary changes to the temporary branch
1345 while the histedit operation is interrupted.
1352 Abort an interrupted histedit operation.
1353 If this option is used, no other command-line arguments are allowed.
1355 Continue an interrupted histedit operation.
1356 If this option is used, no other command-line arguments are allowed.
1357 .It Fl F Ar histedit-script
1360 instead of opening a temporary file in an editor where a histedit script
1363 Edit log messages only.
1364 This option is a quick equivalent to a histedit script which edits
1365 only log messages but otherwise leaves every picked commit as-is.
1368 option can only be used when starting a new histedit operation.
1369 If this option is used, no other command-line arguments are allowed.
1374 .It Cm integrate Ar branch
1375 Integrate the specified
1377 into the work tree's current branch.
1378 Files in the work tree are updated to match the contents on the integrated
1380 and the reference of the work tree's branch is changed to point at the
1381 head commit of the integrated
1384 Both branches can be considered equivalent after integration since they
1385 will be pointing at the same commit.
1386 Both branches remain available for future work, if desired.
1387 In case the integrated
1389 is no longer needed it may be deleted with
1392 Show the status of each affected file, using the following status codes:
1393 .Bl -column YXZ description
1394 .It U Ta file was updated
1395 .It D Ta file was deleted
1396 .It A Ta new file was added
1397 .It \(a~ Ta versioned file is obstructed by a non-regular file
1398 .It ! Ta a missing versioned file was restored
1402 will refuse to run if certain preconditions are not met.
1403 Most importantly, the
1405 must have been rebased onto the work tree's current branch with
1407 before it can be integrated, in order to linearize commit history and
1408 resolve merge conflicts.
1409 If the work tree contains multiple base commits it must first be updated
1410 to a single base commit with
1412 If changes have been staged with
1414 these changes must first be committed with
1418 If the work tree contains local changes, these changes must first be
1426 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1427 Stage local changes for inclusion in the next commit.
1430 is specified, stage all changes in the work tree.
1431 Otherwise, stage changes at or within the specified paths.
1432 Paths may be staged if they are added, modified, or deleted according to
1435 Show the status of each affected file, using the following status codes:
1436 .Bl -column YXZ description
1437 .It A Ta file addition has been staged
1438 .It M Ta file modification has been staged
1439 .It D Ta file deletion has been staged
1442 Staged file contents are saved in newly created blob objects in the repository.
1443 These blobs will be referred to by tree objects once staged changes have been
1446 Staged changes affect the behaviour of
1451 While paths with staged changes exist, the
1453 command will refuse to commit any paths which do not have staged changes.
1454 Local changes created on top of staged changes can only be committed if
1455 the path is staged again, or if the staged changes are committed first.
1458 command will show both local changes and staged changes.
1461 command is able to display local changes relative to staged changes,
1462 and to display staged changes relative to the repository.
1465 command cannot revert staged changes but may be used to revert
1466 local changes created on top of staged changes.
1473 Instead of staging new changes, list paths which are already staged,
1474 along with the IDs of staged blob objects and stage status codes.
1475 If paths were provided in the command line show the staged paths
1476 among the specified paths.
1477 Otherwise, show all staged paths.
1479 Instead of staging the entire content of a changed file, interactively
1480 select or reject changes for staging based on
1484 (reject change), and
1486 (quit staging this file) responses.
1487 If a file is in modified status, individual patches derived from the
1488 modified file content can be staged.
1489 Files in added or deleted status may only be staged or rejected in
1491 .It Fl F Ar response-script
1499 responses line-by-line from the specified
1501 file instead of prompting interactively.
1505 will refuse to run if certain preconditions are not met.
1506 If a file contains merge conflicts, these conflicts must be resolved first.
1507 If a file is found to be out of date relative to the head commit on the
1508 work tree's current branch, the file must be updated with
1510 before it can be staged (however, this does not prevent the file from
1511 becoming out-of-date at some point after having been staged).
1518 commands will refuse to run while staged changes exist.
1519 If staged changes cannot be committed because a staged path
1520 is out of date, the path must be unstaged with
1522 before it can be updated with
1524 and may then be staged again if necessary.
1528 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1529 Merge staged changes back into the work tree and put affected paths
1530 back into non-staged status.
1533 is specified, unstage all staged changes across the entire work tree.
1534 Otherwise, unstage changes at or within the specified paths.
1536 Show the status of each affected file, using the following status codes:
1537 .Bl -column YXZ description
1538 .It G Ta file was unstaged
1539 .It C Ta file was unstaged and conflicts occurred during merge
1540 .It ! Ta changes destined for a missing file were not merged
1541 .It D Ta file was staged as deleted and still is deleted
1542 .It d Ta file's deletion was obstructed by local modifications
1543 .It \(a~ Ta changes destined for a non-regular file were not merged
1551 Instead of unstaging the entire content of a changed file, interactively
1552 select or reject changes for unstaging based on
1556 (keep change staged), and
1558 (quit unstaging this file) responses.
1559 If a file is staged in modified status, individual patches derived from the
1560 staged file content can be unstaged.
1561 Files staged in added or deleted status may only be unstaged in their entirety.
1562 .It Fl F Ar response-script
1570 responses line-by-line from the specified
1572 file instead of prompting interactively.
1577 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1578 Parse and print contents of objects to standard output in a line-based
1580 Content of commit, tree, and tag objects is printed in a way similar
1581 to the actual content stored in such objects.
1582 Blob object contents are printed as they would appear in files on disk.
1584 Attempt to interpret each argument as a reference, a tag name, or
1585 an object ID SHA1 hash.
1586 References will be resolved to an object ID.
1587 Tag names will resolved to a tag object.
1588 An abbreviated hash argument will be expanded to a full SHA1 hash
1589 automatically, provided the abbreviation is unique.
1591 If none of the above interpretations produce a valid result, or if the
1593 option is used, attempt to interpret the argument as a path which will
1594 be resolved to the ID of an object found at this path in the repository.
1601 Look up paths in the specified
1603 If this option is not used, paths are looked up in the commit resolved
1604 via the repository's HEAD reference.
1605 The expected argument is a commit ID SHA1 hash or an existing reference
1606 or tag name which will be resolved to a commit ID.
1607 An abbreviated hash argument will be expanded to a full SHA1 hash
1608 automatically, provided the abbreviation is unique.
1609 .It Fl r Ar repository-path
1610 Use the repository at the specified path.
1611 If not specified, assume the repository is located at or above the current
1613 If this directory is a
1615 work tree, use the repository path associated with this work tree.
1617 Interpret all arguments as paths only.
1618 This option can be used to resolve ambiguity in cases where paths
1619 look like tag names, reference names, or object IDs.
1623 .Bl -tag -width GOT_AUTHOR
1625 The author's name and email address for
1630 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1633 may fail to parse commits without an email address in author data,
1637 environment variables with a missing email address.
1643 configuration settings in the repository's
1645 file will override the value of
1651 configuration settings contained in Git's global
1653 configuration file will be used only if the
1655 environment variable is
1658 .It Ev VISUAL , EDITOR
1659 The editor spawned by
1664 .It Ev GOT_LOG_DEFAULT_LIMIT
1665 The default limit on the number of commits traversed by
1667 If set to zero, the limit is unbounded.
1668 This variable will be silently ignored if it is set to a non-numeric value.
1669 .It Ev GOT_FETCH_DEBUG
1670 Enables protocol tracing on standard error output during
1678 Clone an existing Git repository for use with
1682 .Dl $ got clone ssh://git@github.com/openbsd/src.git
1684 Use of HTTP URLs currently requires
1688 .Dl $ git clone --bare https://github.com/openbsd/src.git
1690 Alternatively, for quick and dirty local testing of
1692 a new Git repository could be created and populated with files,
1693 e.g. from a temporary CVS checkout located at
1696 .Dl $ got init /var/git/src.git
1697 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1699 Check out a work tree from the Git repository to /usr/src:
1701 .Dl $ got checkout /var/git/src.git /usr/src
1703 View local changes in a work tree directory:
1706 .Dl $ got diff | less
1708 Interactively revert selected local changes in a work tree directory:
1710 .Dl $ got revert -p -R\ .
1712 In a work tree or a git repository directory, list all branch references:
1716 In a work tree or a git repository directory, create a new branch called
1717 .Dq unified-buffer-cache
1718 which is forked off the
1722 .Dl $ got branch unified-buffer-cache master
1724 Switch an existing work tree to the branch
1725 .Dq unified-buffer-cache .
1726 Local changes in the work tree will be preserved and merged if necessary:
1728 .Dl $ got update -b unified-buffer-cache
1730 Create a new commit from local changes in a work tree directory.
1731 This new commit will become the head commit of the work tree's current branch:
1735 In a work tree or a git repository directory, view changes committed in
1736 the 3 most recent commits to the work tree's branch, or the branch resolved
1737 via the repository's HEAD reference, respectively:
1739 .Dl $ got log -p -l 3
1741 In a work tree or a git repository directory, log the history of a subdirectory:
1743 .Dl $ got log sys/uvm
1745 While operating inside a work tree, paths are specified relative to the current
1746 working directory, so this command will log the subdirectory
1749 .Dl $ cd sys/uvm && got log '.'
1751 And this command has the same effect:
1753 .Dl $ cd sys/dev/usb && got log ../../uvm
1755 Add new files and remove obsolete files in a work tree directory:
1757 .Dl $ got add sys/uvm/uvm_ubc.c
1758 .Dl $ got remove sys/uvm/uvm_vnode.c
1760 Create a new commit from local changes in a work tree directory
1761 with a pre-defined log message.
1763 .Dl $ got commit -m 'unify the buffer cache'
1765 Update any work tree checked out from the
1766 .Dq unified-buffer-cache
1767 branch to the latest commit on this branch:
1771 Roll file content on the unified-buffer-cache branch back by one commit,
1772 and then fetch the rolled-back change into the work tree as a local change
1773 to be amended and perhaps committed again:
1775 .Dl $ got backout unified-buffer-cache
1776 .Dl $ got commit -m 'roll back previous'
1777 .Dl $ # now back out the previous backout :-)
1778 .Dl $ got backout unified-buffer-cache
1780 Fetch new upstream commits into the local repository's
1787 In a repository created with a HTTP URL and
1788 .Cm git clone --bare
1791 command must be used instead:
1793 .Dl $ cd /var/git/src.git
1794 .Dl $ git fetch origin master:refs/remotes/origin/master
1798 branch to merge the new changes that are now visible on the
1803 .Dl $ got update -b origin/master
1804 .Dl $ got rebase master
1807 .Dq unified-buffer-cache
1808 branch on top of the new head commit of the
1812 .Dl $ got update -b master
1813 .Dl $ got rebase unified-buffer-cache
1815 Create a patch from all changes on the unified-buffer-cache branch.
1816 The patch can be mailed out for review and applied to
1820 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1822 Edit the entire commit history of the
1823 .Dq unified-buffer-cache
1826 .Dl $ got update -b unified-buffer-cache
1827 .Dl $ got update -c master
1830 In order to merge changes committed to the
1831 .Dq unified-buffer-cache
1832 branch back into the
1835 .Dq unified-buffer-cache
1836 branch must first be rebased onto the
1840 .Dl $ got update -b master
1841 .Dl $ got rebase unified-buffer-cache
1844 .Dq unified-buffer-cache
1845 branch can now be made visible on the
1849 Because the rebase operation switched the work tree to the
1850 .Dq unified-buffer-cache
1851 branch, the work tree must be switched back to the
1854 .Dq unified-buffer-cache
1855 branch can be integrated into
1858 .Dl $ got update -b master
1859 .Dl $ got integrate unified-buffer-cache
1861 Additional steps may be necessary if local changes need to be pushed back
1862 to the remote repository, which currently requires
1864 Before working against existing branches in a repository cloned with
1865 .Cm git clone --bare
1870 must be configured to map all references in the remote repository
1873 namespace of the local repository.
1874 This can achieved by setting Git's
1875 .Pa remote.origin.fetch
1876 configuration variable to the value
1877 .Dq +refs/heads/*:refs/remotes/origin/*
1882 .Dl $ cd /var/git/repo
1883 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1886 option must be disabled:
1888 .Dl $ cd /var/git/repo
1889 .Dl $ git config remote.origin.mirror false
1891 Alternatively, the following
1893 configuration item can be added manually to the Git repository's
1897 .Dl [remote "origin"]
1899 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1902 This configuration leaves the local repository's
1904 namespace free for use by local branches checked out with
1906 and, if needed, created with
1911 namespace can now be updated with incoming changes from the remote
1916 without extra command line arguments:
1918 .Dl $ cd /var/git/repo
1921 To make changes fetched from the remote repository appear on the
1925 branch must be rebased onto the
1928 This will also merge local changes, if any, with the incoming changes:
1930 .Dl $ got update -b origin/master
1931 .Dl $ got rebase master
1935 branch, log messages for local changes can now be amended with
1937 by other developers and any other important new information:
1939 .Dl $ got update -c origin/master
1940 .Dl $ got histedit -m
1942 Local changes on the
1944 branch can then be pushed to the remote
1948 .Dl $ cd /var/git/repo
1949 .Dl $ git push origin master
1952 .Xr git-repository 5 ,
1955 .An Stefan Sperling Aq Mt stsp@openbsd.org
1956 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1957 .An Joshua Stein Aq Mt jcs@openbsd.org
1958 .An Ori Bernstein Aq Mt ori@openbsd.org
1961 is a work-in-progress and many commands remain to be implemented.
1962 At present, the user has to fall back on
1964 to perform many tasks, in particular tasks related to repository
1965 administration and tasks which require a network connection.
