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 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
140 Copy files from a repository into a new work tree.
141 Show the status of each affected file, using the following status codes:
142 .Bl -column YXZ description
143 .It A Ta new file was added
144 .It E Ta file already exists in work tree's meta-data
149 is not specified, either use the last component of
150 .Ar repository path ,
153 was specified use the last component of
161 Proceed with the checkout operation even if the directory at
164 Existing files will be left intact.
166 Check out files from a commit on the specified
168 If this option is not specified, a branch resolved via the repository's HEAD
169 reference will be used.
171 Check out files from the specified
173 on the selected branch.
174 The expected argument is a commit ID SHA1 hash or an existing reference
175 or tag name which will be resolved to a commit ID.
176 An abbreviated hash argument will be expanded to a full SHA1 hash
177 automatically, provided the abbreviation is unique.
178 If this option is not specified, the most recent commit on the selected
183 is not contained in the selected branch, a different branch which contains
184 this commit must be specified with the
187 If no such branch is known a new branch must be created for this
193 Checking out work trees with an unknown branch is intentionally not supported.
194 .It Fl p Ar path-prefix
195 Restrict the work tree to a subset of the repository's tree hierarchy.
196 Only files beneath the specified
203 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
204 Update an existing work tree to a different commit.
205 Show the status of each affected file, using the following status codes:
206 .Bl -column YXZ description
207 .It U Ta file was updated and contained no local changes
208 .It G Ta file was updated and local changes were merged cleanly
209 .It C Ta file was updated and conflicts occurred during merge
210 .It D Ta file was deleted
211 .It A Ta new file was added
212 .It \(a~ Ta versioned file is obstructed by a non-regular file
213 .It ! Ta a missing versioned file was restored
218 is specified, update the entire work tree.
219 Otherwise, restrict the update operation to files at or within the
221 Each path is required to exist in the update operation's target commit.
222 Files in the work tree outside specified paths will remain unchanged and
223 will retain their previously recorded base commit.
226 commands may refuse to run while the work tree contains files from
227 multiple base commits.
228 The base commit of such a work tree can be made consistent by running
230 across the entire work tree.
233 is incompatible with the
238 cannot update paths with staged changes.
239 If changes have been staged with
241 these changes must first be committed with
251 Switch the work tree's branch reference to the specified
253 before updating the work tree.
254 This option requires that all paths in the work tree are updated.
256 Update the work tree to the specified
258 The expected argument is a commit ID SHA1 hash or an existing reference
259 or tag name which will be resolved to a commit ID.
260 An abbreviated hash argument will be expanded to a full SHA1 hash
261 automatically, provided the abbreviation is unique.
262 If this option is not specified, the most recent commit on the work tree's
268 .It Cm status Op Ar path ...
269 Show the current modification status of files in a work tree,
270 using the following status codes:
271 .Bl -column YXZ description
272 .It M Ta modified file
273 .It A Ta file scheduled for addition in next commit
274 .It D Ta file scheduled for deletion in next commit
275 .It C Ta modified or added file which contains merge conflicts
276 .It ! Ta versioned file was expected on disk but is missing
277 .It \(a~ Ta versioned file is obstructed by a non-regular file
278 .It ? Ta unversioned item not tracked by
280 .It m Ta modified file modes (executable bit only)
281 .It N Ta non-existent
283 specified on the command line
288 is specified, show modifications in the entire work tree.
289 Otherwise, show modifications at or within the specified paths.
291 If changes have been staged with
293 staged changes are shown in the second output column, using the following
295 .Bl -column YXZ description
296 .It M Ta file modification is staged
297 .It A Ta file addition is staged
298 .It D Ta file deletion is staged
301 Changes created on top of staged changes are indicated in the first column:
302 .Bl -column YXZ description
303 .It MM Ta file was modified after earlier changes have been staged
304 .It MA Ta file was modified after having been staged for addition
307 For compatibility with
318 files in each traversed directory and will not display unversioned files
319 which match these patterns.
324 supports consecutive asterisks,
326 which will match an arbitrary amount of directories.
330 only supports a single ignore pattern per line.
334 does not support negated ignore patterns prefixed with
336 and gives no special significance to the location of path component separators,
342 .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
343 Display history of a repository.
346 is specified, show only commits which modified this path.
347 If invoked in a work tree, the
349 is interpreted relative to the current working directory,
350 and the work tree's path prefix is implicitly prepended.
351 Otherwise, the path is interpreted relative to the repository root.
358 Display individual commits which were merged into the current branch
362 shows the linear history of the current branch only.
364 Start traversing history at the specified
366 The expected argument is a commit ID SHA1 hash or an existing reference
367 or tag name which will be resolved to a commit ID.
368 An abbreviated hash argument will be expanded to a full SHA1 hash
369 automatically, provided the abbreviation is unique.
370 If this option is not specified, default to the work tree's current branch
371 if invoked in a work tree, or to the repository's HEAD reference.
373 Set the number of context lines shown in diffs with
375 By default, 3 lines of context are shown.
377 Limit history traversal to a given number of commits.
378 If this option is not specified, a default limit value of zero is used,
379 which is treated as an unbounded limit.
381 .Ev GOT_LOG_DEFAULT_LIMIT
382 environment variable may be set to change this default value.
384 Display the patch of modifications made in each commit.
387 is specified, only show the patch of modifications at or within this path.
388 .It Fl s Ar search-pattern
389 If specified, show only commits with a log message matched by the extended
392 Regular expression syntax is documented in
394 .It Fl r Ar repository-path
395 Use the repository at the specified path.
396 If not specified, assume the repository is located at or above the current
398 If this directory is a
400 work tree, use the repository path associated with this work tree.
402 .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
403 When invoked within a work tree with less than two arguments, display
404 uncommitted changes in the work tree.
407 is specified, only show changes within this path.
409 If two arguments are provided, treat each argument as a reference, a tag
410 name, or an object ID SHA1 hash, and display differences between the
411 corresponding objects.
412 Both objects must be of the same type (blobs, trees, or commits).
413 An abbreviated hash argument will be expanded to a full SHA1 hash
414 automatically, provided the abbreviation is unique.
421 Set the number of context lines shown in the diff.
422 By default, 3 lines of context are shown.
423 .It Fl r Ar repository-path
424 Use the repository at the specified path.
425 If not specified, assume the repository is located at or above the current
427 If this directory is a
429 work tree, use the repository path associated with this work tree.
431 Show changes staged with
433 instead of showing local changes.
434 This option is only valid when
436 is invoked in a work tree.
438 Ignore whitespace-only changes.
443 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
444 Display line-by-line history of a file at the specified path.
451 Start traversing history at the specified
453 The expected argument is a commit ID SHA1 hash or an existing reference
454 or tag name which will be resolved to a commit ID.
455 An abbreviated hash argument will be expanded to a full SHA1 hash
456 automatically, provided the abbreviation is unique.
457 .It Fl r Ar repository-path
458 Use the repository at the specified path.
459 If not specified, assume the repository is located at or above the current
461 If this directory is a
463 work tree, use the repository path associated with this work tree.
468 .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
469 Display a listing of files and directories at the specified
470 directory path in the repository.
471 Entries shown in this listing may carry one of the following trailing
473 .Bl -column YXZ description
474 .It @ Ta entry is a symbolic link
475 .It / Ta entry is a directory
476 .It * Ta entry is an executable file
477 .It $ Ta entry is a Git submodule
482 is specified, list the repository path corresponding to the current
483 directory of the work tree, or the root directory of the repository
484 if there is no work tree.
491 List files and directories as they appear in the specified
493 The expected argument is a commit ID SHA1 hash or an existing reference
494 or tag name which will be resolved to a commit ID.
495 An abbreviated hash argument will be expanded to a full SHA1 hash
496 automatically, provided the abbreviation is unique.
497 .It Fl r Ar repository-path
498 Use the repository at the specified path.
499 If not specified, assume the repository is located at or above the current
501 If this directory is a
503 work tree, use the repository path associated with this work tree.
505 Show object IDs of files (blob objects) and directories (tree objects).
507 Recurse into sub-directories in the repository.
512 .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
513 Manage references in a repository.
515 If no options are passed, expect two arguments and attempt to create,
516 or update, the reference with the given
518 and make it point at the given
520 The name must be an absolute reference name, i.e. it must begin with
522 The target may be an object ID SHA1 hash or an existing reference which
523 will be resolved to an object ID.
524 An abbreviated hash argument will be expanded to a full SHA1 hash
525 automatically, provided the abbreviation is unique.
531 .It Fl r Ar repository-path
532 Use the repository at the specified path.
533 If not specified, assume the repository is located at or above the current
535 If this directory is a
537 work tree, use the repository path associated with this work tree.
539 List all existing references in the repository.
541 Delete the reference with the specified name from the repository.
543 Create a symbolic reference pointing at the specified
545 which must be an existing reference.
546 Care should be taken not to create loops between references when
549 .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
550 Create, list, or delete branches.
552 Branches are managed via references which live in the
557 command operates on references in this namespace only.
559 If invoked in a work tree without any arguments, print the name of the
560 work tree's current branch.
564 argument is passed, attempt to create a branch reference with the given name.
565 By default the new branch reference will point at the latest commit on the
566 work tree's current branch if invoked in a work tree, and otherwise to a commit
567 resolved via the repository's HEAD reference.
569 If invoked in a work tree, once the branch was created successfully
570 switch the work tree's head reference to the newly created branch and
571 update files across the entire work tree, just like
572 .Cm got update -b Ar name
574 Show the status of each affected file, using the following status codes:
575 .Bl -column YXZ description
576 .It U Ta file was updated and contained no local changes
577 .It G Ta file was updated and local changes were merged cleanly
578 .It C Ta file was updated and conflicts occurred during merge
579 .It D Ta file was deleted
580 .It A Ta new file was added
581 .It \(a~ Ta versioned file is obstructed by a non-regular file
582 .It ! Ta a missing versioned file was restored
590 Make a newly created branch reference point at the specified
594 argument is a commit ID SHA1 hash or an existing reference
595 or tag name which will be resolved to a commit ID.
596 .It Fl r Ar repository-path
597 Use the repository at the specified path.
598 If not specified, assume the repository is located at or above the current
600 If this directory is a
602 work tree, use the repository path associated with this work tree.
604 List all existing branches in the repository.
605 If invoked in a work tree, the work tree's current branch is shown
606 with one the following annotations:
607 .Bl -column YXZ description
608 .It * Ta work tree's base commit matches the branch tip
609 .It \(a~ Ta work tree's base commit is out-of-date
612 Delete the branch with the specified name from the repository.
613 Only the branch reference is deleted.
614 Any commit, tree, and blob objects belonging to the branch
615 remain in the repository and may be removed separately with
616 Git's garbage collector.
618 Do not switch and update the work tree after creating a new branch.
623 .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
624 Manage tags in a repository.
626 Tags are managed via references which live in the
631 command operates on references in this namespace only.
632 References in this namespace point at tag objects which contain a pointer
633 to another object, a tag message, as well as author and timestamp information.
635 Attempt to create a tag with the given
637 and make this tag point at the given
639 If no commit is specified, default to the latest commit on the work tree's
640 current branch if invoked in a work tree, and to a commit resolved via
641 the repository's HEAD reference otherwise.
648 Make the newly created tag reference point at the specified
652 argument is a commit ID SHA1 hash or an existing reference or tag name which
653 will be resolved to a commit ID.
654 An abbreviated hash argument will be expanded to a full SHA1 hash
655 automatically, provided the abbreviation is unique.
657 Use the specified tag message when creating the new tag.
662 opens a temporary file in an editor where a tag message can be written.
663 .It Fl r Ar repository-path
664 Use the repository at the specified path.
665 If not specified, assume the repository is located at or above the current
667 If this directory is a
669 work tree, use the repository path associated with this work tree.
671 List all existing tags in the repository instead of creating a new tag.
672 If this option is used, no other command-line arguments are allowed.
677 command will not delete tags or change existing tags.
678 If a tag must be deleted, the
680 command may be used to delete a tag's reference.
681 This should only be done if the tag has not already been copied to
683 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
684 Schedule unversioned files in a work tree for addition to the
685 repository in the next commit.
692 Permit recursion into directories.
693 If this option is not specified,
695 will refuse to run if a specified
699 With -R, add files even if they match a
703 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
704 Remove versioned files from a work tree and schedule them for deletion
705 from the repository in the next commit.
712 Perform the operation even if a file contains uncommitted modifications.
714 Keep affected files on disk.
716 Permit recursion into directories.
717 If this option is not specified,
719 will refuse to run if a specified
726 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
727 Revert any uncommitted changes in files at the specified paths.
728 File contents will be overwritten with those contained in the
729 work tree's base commit.
730 There is no way to bring discarded changes back after
733 If a file was added with
735 it will become an unversioned file again.
736 If a file was deleted with
745 Instead of reverting all changes in files, interactively select or reject
746 changes to revert based on
752 (quit reverting this file) responses.
753 If a file is in modified status, individual patches derived from the
754 modified file content can be reverted.
755 Files in added or deleted status may only be reverted in their entirety.
756 .It Fl F Ar response-script
764 responses line-by-line from the specified
766 file instead of prompting interactively.
768 Permit recursion into directories.
769 If this option is not specified,
771 will refuse to run if a specified
778 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
779 Create a new commit in the repository from changes in a work tree
780 and use this commit as the new base commit for the work tree.
783 is specified, commit all changes in the work tree.
784 Otherwise, commit changes at or within the specified paths.
786 If changes have been explicitly staged for commit with
788 only commit staged changes and reject any specified paths which
789 have not been staged.
791 Show the status of each affected file, using the following status codes:
792 .Bl -column YXZ description
793 .It M Ta modified file
794 .It D Ta file was deleted
795 .It A Ta new file was added
796 .It m Ta modified file modes (executable bit only)
799 Files which are not part of the new commit will retain their previously
800 recorded base commit.
803 commands may refuse to run while the work tree contains files from
804 multiple base commits.
805 The base commit of such a work tree can be made consistent by running
807 across the entire work tree.
813 environment variable to be set,
818 configuration settings can be
819 obtained from the repository's
821 file or from Git's global
830 Use the specified log message when creating the new commit.
835 opens a temporary file in an editor where a log message can be written.
839 will refuse to run if certain preconditions are not met.
840 If the work tree's current branch is not in the
842 reference namespace, new commits may not be created on this branch.
843 Local changes may only be committed if they are based on file content
844 found in the most recent commit on the work tree's branch.
845 If a path is found to be out of date,
847 must be used first in order to merge local changes with changes made
852 .It Cm cherrypick Ar commit
853 Merge changes from a single
858 must be on a different branch than the work tree's base commit.
859 The expected argument is a reference or a commit ID SHA1 hash.
860 An abbreviated hash argument will be expanded to a full SHA1 hash
861 automatically, provided the abbreviation is unique.
863 Show the status of each affected file, using the following status codes:
864 .Bl -column YXZ description
865 .It G Ta file was merged
866 .It C Ta file was merged and conflicts occurred during merge
867 .It ! Ta changes destined for a missing file were not merged
868 .It D Ta file was deleted
869 .It d Ta file's deletion was obstructed by local modifications
870 .It A Ta new file was added
871 .It \(a~ Ta changes destined for a non-regular file were not merged
874 The merged changes will appear as local changes in the work tree, which
877 amended manually or with further
882 or discarded again with
886 will refuse to run if certain preconditions are not met.
887 If the work tree contains multiple base commits it must first be updated
888 to a single base commit with
890 If the work tree already contains files with merge conflicts, these
891 conflicts must be resolved first.
895 .It Cm backout Ar commit
896 Reverse-merge changes from a single
901 must be on the same branch as the work tree's base commit.
902 The expected argument is a reference or a commit ID SHA1 hash.
903 An abbreviated hash argument will be expanded to a full SHA1 hash
904 automatically, provided the abbreviation is unique.
906 Show the status of each affected file, using the following status codes:
907 .Bl -column YXZ description
908 .It G Ta file was merged
909 .It C Ta file was merged and conflicts occurred during merge
910 .It ! Ta changes destined for a missing file were not merged
911 .It D Ta file was deleted
912 .It d Ta file's deletion was obstructed by local modifications
913 .It A Ta new file was added
914 .It \(a~ Ta changes destined for a non-regular file were not merged
917 The reverse-merged changes will appear as local changes in the work tree,
918 which may be viewed with
920 amended manually or with further
925 or discarded again with
929 will refuse to run if certain preconditions are not met.
930 If the work tree contains multiple base commits it must first be updated
931 to a single base commit with
933 If the work tree already contains files with merge conflicts, these
934 conflicts must be resolved first.
938 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
939 Rebase commits on the specified
941 onto the tip of the current branch of the work tree.
944 must share common ancestry with the work tree's current branch.
945 Rebasing begins with the first descendant commit of the youngest
946 common ancestor commit shared by the specified
948 and the work tree's current branch, and stops once the tip commit
955 is used as intended, the specified
957 represents a local commit history and may already contain changes
958 that are not yet visible in any other repositories.
959 The work tree's current branch, which must be set with
963 operation, represents a branch from a remote repository which shares
964 a common history with the specified
966 but has progressed, and perhaps diverged, due to commits added to the
969 Rebased commits are accumulated on a temporary branch which the work tree
970 will remain switched to throughout the entire rebase operation.
971 Commits on this branch represent the same changes with the same log
972 messages as their counterparts on the original
974 but with different commit IDs.
975 Once rebasing has completed successfully, the temporary branch becomes
976 the new version of the specified
978 and the work tree is automatically switched to it.
980 While rebasing commits, show the status of each affected file,
981 using the following status codes:
982 .Bl -column YXZ description
983 .It G Ta file was merged
984 .It C Ta file was merged and conflicts occurred during merge
985 .It ! Ta changes destined for a missing file were not merged
986 .It D Ta file was deleted
987 .It d Ta file's deletion was obstructed by local modifications
988 .It A Ta new file was added
989 .It \(a~ Ta changes destined for a non-regular file were not merged
992 If merge conflicts occur the rebase operation is interrupted and may
993 be continued once conflicts have been resolved.
994 Alternatively, the rebase operation may be aborted which will leave
996 unmodified and the work tree switched back to its original branch.
998 If a merge conflict is resolved in a way which renders the merged
999 change into a no-op change, the corresponding commit will be elided
1000 when the rebase operation continues.
1003 will refuse to run if certain preconditions are not met.
1004 If the work tree is not yet fully updated to the tip commit of its
1005 branch then the work tree must first be updated with
1007 If changes have been staged with
1009 these changes must first be committed with
1013 If the work tree contains local changes, these changes must first be
1020 contains changes to files outside of the work tree's path prefix,
1021 the work tree cannot be used to rebase this branch.
1027 commands will refuse to run while a rebase operation is in progress.
1028 Other commands which manipulate the work tree may be used for
1029 conflict resolution purposes.
1036 Abort an interrupted rebase operation.
1037 If this option is used, no other command-line arguments are allowed.
1039 Continue an interrupted rebase operation.
1040 If this option is used, no other command-line arguments are allowed.
1045 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Oo Fl F Ar histedit-script Oc Oo Fl m Oc
1046 Edit commit history between the work tree's current base commit and
1047 the tip commit of the work tree's current branch.
1051 operation the work tree's current branch must be set with
1053 to the branch which should be edited, unless this branch is already the
1054 current branch of the work tree.
1055 The tip of this branch represents the upper bound (inclusive) of commits
1060 Furthermore, the work tree's base commit
1063 to a point in this branch's commit history where editing should begin.
1064 This commit represents the lower bound (non-inclusive) of commits touched
1069 Editing of commit history is controlled via a
1071 which can be written in an editor based on a template, passed on the
1072 command line, or generated with the
1074 option if only log messages need to be edited.
1076 The format of the histedit script is line-based.
1077 Each line in the script begins with a command name, followed by
1078 whitespace and an argument.
1079 For most commands, the expected argument is a commit ID SHA1 hash.
1080 Any remaining text on the line is ignored.
1081 Lines which begin with the
1083 character are ignored entirely.
1085 The available commands are as follows:
1086 .Bl -column YXZ pick-commit
1087 .It pick Ar commit Ta Use the specified commit as it is.
1088 .It edit Ar commit Ta Use the specified commit but once changes have been
1089 merged into the work tree interrupt the histedit operation for amending.
1090 .It fold Ar commit Ta Combine the specified commit with the next commit
1091 listed further below that will be used.
1092 .It drop Ar commit Ta Remove this commit from the edited history.
1093 .It mesg Ar log-message Ta Use the specified single-line log message for
1094 the commit on the previous line.
1095 If the log message argument is left empty, open an editor where a new
1096 log message can be written.
1099 Every commit in the history being edited must be mentioned in the script.
1100 Lines may be re-ordered to change the order of commits in the edited history.
1102 Edited commits are accumulated on a temporary branch which the work tree
1103 will remain switched to throughout the entire histedit operation.
1104 Once history editing has completed successfully, the temporary branch becomes
1105 the new version of the work tree's branch and the work tree is automatically
1108 While merging commits, show the status of each affected file,
1109 using the following status codes:
1110 .Bl -column YXZ description
1111 .It G Ta file was merged
1112 .It C Ta file was merged and conflicts occurred during merge
1113 .It ! Ta changes destined for a missing file were not merged
1114 .It D Ta file was deleted
1115 .It d Ta file's deletion was obstructed by local modifications
1116 .It A Ta new file was added
1117 .It \(a~ Ta changes destined for a non-regular file were not merged
1120 If merge conflicts occur the histedit operation is interrupted and may
1121 be continued once conflicts have been resolved.
1122 Alternatively, the histedit operation may be aborted which will leave
1123 the work tree switched back to its original branch.
1125 If a merge conflict is resolved in a way which renders the merged
1126 change into a no-op change, the corresponding commit will be elided
1127 when the histedit operation continues.
1130 will refuse to run if certain preconditions are not met.
1131 If the work tree's current branch is not in the
1133 reference namespace, the history of the branch may not be edited.
1134 If the work tree contains multiple base commits it must first be updated
1135 to a single base commit with
1137 If changes have been staged with
1139 these changes must first be committed with
1143 If the work tree contains local changes, these changes must first be
1148 If the edited history contains changes to files outside of the work tree's
1149 path prefix, the work tree cannot be used to edit the history of this branch.
1156 commands will refuse to run while a histedit operation is in progress.
1157 Other commands which manipulate the work tree may be used, and the
1159 command may be used to commit arbitrary changes to the temporary branch
1160 while the histedit operation is interrupted.
1167 Abort an interrupted histedit operation.
1168 If this option is used, no other command-line arguments are allowed.
1170 Continue an interrupted histedit operation.
1171 If this option is used, no other command-line arguments are allowed.
1172 .It Fl F Ar histedit-script
1175 instead of opening a temporary file in an editor where a histedit script
1178 Edit log messages only.
1179 This option is a quick equivalent to a histedit script which edits
1180 only log messages but otherwise leaves every picked commit as-is.
1183 option can only be used when starting a new histedit operation.
1184 If this option is used, no other command-line arguments are allowed.
1189 .It Cm integrate Ar branch
1190 Integrate the specified
1192 into the work tree's current branch.
1193 Files in the work tree are updated to match the contents on the integrated
1195 and the reference of the work tree's branch is changed to point at the
1196 head commit of the integrated
1199 Both branches can be considered equivalent after integration since they
1200 will be pointing at the same commit.
1201 Both branches remain available for future work, if desired.
1202 In case the integrated
1204 is no longer needed it may be deleted with
1207 Show the status of each affected file, using the following status codes:
1208 .Bl -column YXZ description
1209 .It U Ta file was updated
1210 .It D Ta file was deleted
1211 .It A Ta new file was added
1212 .It \(a~ Ta versioned file is obstructed by a non-regular file
1213 .It ! Ta a missing versioned file was restored
1217 will refuse to run if certain preconditions are not met.
1218 Most importantly, the
1220 must have been rebased onto the work tree's current branch with
1222 before it can be integrated, in order to linearize commit history and
1223 resolve merge conflicts.
1224 If the work tree contains multiple base commits it must first be updated
1225 to a single base commit with
1227 If changes have been staged with
1229 these changes must first be committed with
1233 If the work tree contains local changes, these changes must first be
1241 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1242 Stage local changes for inclusion in the next commit.
1245 is specified, stage all changes in the work tree.
1246 Otherwise, stage changes at or within the specified paths.
1247 Paths may be staged if they are added, modified, or deleted according to
1250 Show the status of each affected file, using the following status codes:
1251 .Bl -column YXZ description
1252 .It A Ta file addition has been staged
1253 .It M Ta file modification has been staged
1254 .It D Ta file deletion has been staged
1257 Staged file contents are saved in newly created blob objects in the repository.
1258 These blobs will be referred to by tree objects once staged changes have been
1261 Staged changes affect the behaviour of
1266 While paths with staged changes exist, the
1268 command will refuse to commit any paths which do not have staged changes.
1269 Local changes created on top of staged changes can only be committed if
1270 the path is staged again, or if the staged changes are committed first.
1273 command will show both local changes and staged changes.
1276 command is able to display local changes relative to staged changes,
1277 and to display staged changes relative to the repository.
1280 command cannot revert staged changes but may be used to revert
1281 local changes created on top of staged changes.
1288 Instead of staging new changes, list paths which are already staged,
1289 along with the IDs of staged blob objects and stage status codes.
1290 If paths were provided in the command line show the staged paths
1291 among the specified paths.
1292 Otherwise, show all staged paths.
1294 Instead of staging the entire content of a changed file, interactively
1295 select or reject changes for staging based on
1299 (reject change), and
1301 (quit staging this file) responses.
1302 If a file is in modified status, individual patches derived from the
1303 modified file content can be staged.
1304 Files in added or deleted status may only be staged or rejected in
1306 .It Fl F Ar response-script
1314 responses line-by-line from the specified
1316 file instead of prompting interactively.
1320 will refuse to run if certain preconditions are not met.
1321 If a file contains merge conflicts, these conflicts must be resolved first.
1322 If a file is found to be out of date relative to the head commit on the
1323 work tree's current branch, the file must be updated with
1325 before it can be staged (however, this does not prevent the file from
1326 becoming out-of-date at some point after having been staged).
1333 commands will refuse to run while staged changes exist.
1334 If staged changes cannot be committed because a staged path
1335 is out of date, the path must be unstaged with
1337 before it can be updated with
1339 and may then be staged again if necessary.
1343 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1344 Merge staged changes back into the work tree and put affected paths
1345 back into non-staged status.
1348 is specified, unstage all staged changes across the entire work tree.
1349 Otherwise, unstage changes at or within the specified paths.
1351 Show the status of each affected file, using the following status codes:
1352 .Bl -column YXZ description
1353 .It G Ta file was unstaged
1354 .It C Ta file was unstaged and conflicts occurred during merge
1355 .It ! Ta changes destined for a missing file were not merged
1356 .It D Ta file was staged as deleted and still is deleted
1357 .It d Ta file's deletion was obstructed by local modifications
1358 .It \(a~ Ta changes destined for a non-regular file were not merged
1366 Instead of unstaging the entire content of a changed file, interactively
1367 select or reject changes for unstaging based on
1371 (keep change staged), and
1373 (quit unstaging this file) responses.
1374 If a file is staged in modified status, individual patches derived from the
1375 staged file content can be unstaged.
1376 Files staged in added or deleted status may only be unstaged in their entirety.
1377 .It Fl F Ar response-script
1385 responses line-by-line from the specified
1387 file instead of prompting interactively.
1392 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1393 Parse and print contents of objects to standard output in a line-based
1395 Content of commit, tree, and tag objects is printed in a way similar
1396 to the actual content stored in such objects.
1397 Blob object contents are printed as they would appear in files on disk.
1399 Attempt to interpret each argument as a reference, a tag name, or
1400 an object ID SHA1 hash.
1401 References will be resolved to an object ID.
1402 Tag names will resolved to a tag object.
1403 An abbreviated hash argument will be expanded to a full SHA1 hash
1404 automatically, provided the abbreviation is unique.
1406 If none of the above interpretations produce a valid result, or if the
1408 option is used, attempt to interpret the argument as a path which will
1409 be resolved to the ID of an object found at this path in the repository.
1416 Look up paths in the specified
1418 If this option is not used, paths are looked up in the commit resolved
1419 via the repository's HEAD reference.
1420 The expected argument is a commit ID SHA1 hash or an existing reference
1421 or tag name which will be resolved to a commit ID.
1422 An abbreviated hash argument will be expanded to a full SHA1 hash
1423 automatically, provided the abbreviation is unique.
1424 .It Fl r Ar repository-path
1425 Use the repository at the specified path.
1426 If not specified, assume the repository is located at or above the current
1428 If this directory is a
1430 work tree, use the repository path associated with this work tree.
1432 Interpret all arguments as paths only.
1433 This option can be used to resolve ambiguity in cases where paths
1434 look like tag names, reference names, or object IDs.
1438 .Bl -tag -width GOT_AUTHOR
1440 The author's name and email address for
1445 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1448 may fail to parse commits without an email address in author data,
1452 environment variables with a missing email address.
1458 configuration settings in the repository's
1460 file will override the value of
1466 configuration settings contained in Git's global
1468 configuration file will be used only if the
1470 environment variable is
1473 .It Ev VISUAL , EDITOR
1474 The editor spawned by
1479 .It Ev GOT_LOG_DEFAULT_LIMIT
1480 The default limit on the number of commits traversed by
1482 If set to zero, the limit is unbounded.
1483 This variable will be silently ignored if it is set to a non-numeric value.
1488 Clone an existing Git repository for use with
1490 This step currently requires
1494 .Dl $ git clone --bare https://github.com/openbsd/src.git
1496 Alternatively, for quick and dirty local testing of
1498 a new Git repository could be created and populated with files,
1499 e.g. from a temporary CVS checkout located at
1502 .Dl $ got init /var/git/src.git
1503 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1505 Check out a work tree from the Git repository to /usr/src:
1507 .Dl $ got checkout /var/git/src.git /usr/src
1509 View local changes in a work tree directory:
1512 .Dl $ got diff | less
1514 Interactively revert selected local changes in a work tree directory:
1516 .Dl $ got revert -p -R\ .
1518 In a work tree or a git repository directory, list all branch references:
1522 In a work tree or a git repository directory, create a new branch called
1523 .Dq unified-buffer-cache
1524 which is forked off the
1528 .Dl $ got branch unified-buffer-cache master
1530 Switch an existing work tree to the branch
1531 .Dq unified-buffer-cache .
1532 Local changes in the work tree will be preserved and merged if necessary:
1534 .Dl $ got update -b unified-buffer-cache
1536 Create a new commit from local changes in a work tree directory.
1537 This new commit will become the head commit of the work tree's current branch:
1541 In a work tree or a git repository directory, view changes committed in
1542 the 3 most recent commits to the work tree's branch, or the branch resolved
1543 via the repository's HEAD reference, respectively:
1545 .Dl $ got log -p -l 3
1547 In a work tree or a git repository directory, log the history of a subdirectory:
1549 .Dl $ got log sys/uvm
1551 While operating inside a work tree, paths are specified relative to the current
1552 working directory, so this command will log the subdirectory
1555 .Dl $ cd sys/uvm && got log '.'
1557 And this command has the same effect:
1559 .Dl $ cd sys/dev/usb && got log ../../uvm
1561 Add new files and remove obsolete files in a work tree directory:
1563 .Dl $ got add sys/uvm/uvm_ubc.c
1564 .Dl $ got remove sys/uvm/uvm_vnode.c
1566 Create a new commit from local changes in a work tree directory
1567 with a pre-defined log message.
1569 .Dl $ got commit -m 'unify the buffer cache'
1571 Update any work tree checked out from the
1572 .Dq unified-buffer-cache
1573 branch to the latest commit on this branch:
1577 Roll file content on the unified-buffer-cache branch back by one commit,
1578 and then fetch the rolled-back change into the work tree as a local change
1579 to be amended and perhaps committed again:
1581 .Dl $ got backout unified-buffer-cache
1582 .Dl $ got commit -m 'roll back previous'
1583 .Dl $ # now back out the previous backout :-)
1584 .Dl $ got backout unified-buffer-cache
1586 Fetch new upstream commits into the local repository's master branch.
1587 This step currently requires
1590 .Dl $ cd /var/git/src.git
1591 .Dl $ git fetch origin master:master
1594 .Dq unified-buffer-cache
1595 branch on top of the new head commit of the
1599 .Dl $ got update -b master
1600 .Dl $ got rebase unified-buffer-cache
1602 Create a patch from all changes on the unified-buffer-cache branch.
1603 The patch can be mailed out for review and applied to
1607 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1609 Edit the entire commit history of the
1610 .Dq unified-buffer-cache
1613 .Dl $ got update -b unified-buffer-cache
1614 .Dl $ got update -c master
1617 Additional steps are necessary if local changes need to be pushed back
1618 to the remote repository, which currently requires
1622 Before working against existing branches in a repository cloned with
1623 .Dq git clone --bare ,
1626 must be configured to map all references in the remote repository
1629 namespace of the local repository.
1630 This can achieved by setting Git's
1631 .Pa remote.origin.fetch
1632 configuration variable to the value
1633 .Dq +refs/heads/*:refs/remotes/origin/*
1638 .Dl $ cd /var/git/repo
1639 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1641 Alternatively, the following
1643 configuration item can be added manually to the Git repository's
1647 .Dl [remote "origin"]
1649 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1651 This configuration leaves the local repository's
1653 namespace free for use by local branches checked out with
1655 and, if needed, created with
1660 namespace can be updated with incoming changes from the remote
1664 .Dl $ cd /var/git/repo
1667 To make changes fetched from the remote repository appear on the
1671 branch must be rebased onto the
1674 This will also merge local changes, if any, with the incoming changes:
1676 .Dl $ got update -b origin/master
1677 .Dl $ got rebase master
1681 branch, log messages for local changes can now be amended with
1683 by other developers and any other important new information:
1685 .Dl $ got update -c origin/master
1686 .Dl $ got histedit -m
1688 Local changes on the
1690 branch can then be pushed to the remote
1694 .Dl $ cd /var/git/repo
1695 .Dl $ git push origin master
1697 In order to merge changes committed to the
1698 .Dq unified-buffer-cache
1699 branch back into the
1702 .Dq unified-buffer-cache
1703 branch must first be rebased onto the
1707 .Dl $ got update -b master
1708 .Dl $ got rebase unified-buffer-cache
1711 .Dq unified-buffer-cache
1712 branch can now be made visible on the
1716 Because the rebase operation switched the work tree to the
1717 .Dq unified-buffer-cache
1718 branch, the work tree must be switched back to the
1721 .Dq unified-buffer-cache
1722 branch can be integrated into
1725 .Dl $ got update -b master
1726 .Dl $ got integrate unified-buffer-cache
1729 .Xr git-repository 5 ,
1732 .An Stefan Sperling Aq Mt stsp@openbsd.org
1733 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1734 .An Joshua Stein Aq Mt jcs@openbsd.org
1737 is a work-in-progress and many commands remain to be implemented.
1738 At present, the user has to fall back on
1740 to perform many tasks, in particular tasks related to repository
1741 administration and tasks which require a network connection.
