2 .\" Copyright (c) 2017 Martin Pieuchot
3 .\" Copyright (c) 2018, 2019 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 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.
143 is not specified, either use the last component of
144 .Ar repository path ,
147 was specified use the last component of
155 Check out files from a commit on the specified
157 If this option is not specified, a branch resolved via the repository's HEAD
158 reference will be used.
160 Check out files from the specified
162 on the selected branch.
163 The expected argument is a commit ID SHA1 hash or an existing reference
164 or tag name which will be resolved to a commit ID.
165 An abbreviated hash argument will be expanded to a full SHA1 hash
166 automatically, provided the abbreviation is unique.
167 If this option is not specified, the most recent commit on the selected
169 .It Fl p Ar path-prefix
170 Restrict the work tree to a subset of the repository's tree hierarchy.
171 Only files beneath the specified
178 .It Cm update Oo Fl b Ar branch Oc Oo Fl c Ar commit Oc Op Ar path ...
179 Update an existing work tree to a different commit.
180 Show the status of each affected file, using the following status codes:
181 .Bl -column YXZ description
182 .It U Ta file was updated and contained no local changes
183 .It G Ta file was updated and local changes were merged cleanly
184 .It C Ta file was updated and conflicts occurred during merge
185 .It D Ta file was deleted
186 .It A Ta new file was added
187 .It \(a~ Ta versioned file is obstructed by a non-regular file
188 .It ! Ta a missing versioned file was restored
193 is specified, update the entire work tree.
194 Otherwise, restrict the update operation to files at or within the
196 Each path is required to exist in the update operation's target commit.
197 Files in the work tree outside specified paths will remain unchanged and
198 will retain their previously recorded base commit.
201 commands may refuse to run while the work tree contains files from
202 multiple base commits.
203 The base commit of such a work tree can be made consistent by running
205 across the entire work tree.
208 is incompatible with the
213 cannot update paths with staged changes.
214 If changes have been staged with
216 these changes must first be committed with
226 Switch the work tree's branch reference to the specified
228 before updating the work tree.
229 This option requires that all paths in the work tree are updated.
231 Update the work tree to the specified
233 The expected argument is a commit ID SHA1 hash or an existing reference
234 or tag name which will be resolved to a commit ID.
235 An abbreviated hash argument will be expanded to a full SHA1 hash
236 automatically, provided the abbreviation is unique.
237 If this option is not specified, the most recent commit on the work tree's
243 .It Cm status Op Ar path ...
244 Show the current modification status of files in a work tree,
245 using the following status codes:
246 .Bl -column YXZ description
247 .It M Ta modified file
248 .It A Ta file scheduled for addition in next commit
249 .It D Ta file scheduled for deletion in next commit
250 .It C Ta modified or added file which contains merge conflicts
251 .It ! Ta versioned file was expected on disk but is missing
252 .It \(a~ Ta versioned file is obstructed by a non-regular file
253 .It ? Ta unversioned item not tracked by
255 .It N Ta non-existent
257 specified on the command line
262 is specified, show modifications in the entire work tree.
263 Otherwise, show modifications at or within the specified paths.
265 If changes have been staged with
267 staged changes are shown in the second output column, using the following
269 .Bl -column YXZ description
270 .It M Ta file modification is staged
271 .It A Ta file addition is staged
272 .It D Ta file deletion is staged
275 Changes created on top of staged changes are indicated in the first column:
276 .Bl -column YXZ description
277 .It MM Ta file was modified after earlier changes have been staged
278 .It MA Ta file was modified after having been staged for addition
281 For compatibility with
292 files in each traversed directory and will not display unversioned files
293 which match these patterns.
298 supports consecutive asterisks,
300 which will match an arbitrary amount of directories.
304 only supports a single ignore pattern per line.
308 does not support negated ignore patterns prefixed with
310 and gives no special significance to the location of path component separators,
316 .It Cm log Oo Fl c Ar commit Oc Oo Fl C Ar number Oc Oo Fl f Oc Oo Fl l Ar N Oc Oo Fl p Oc Oo Fl r Ar repository-path Oc Op Ar path
317 Display history of a repository.
320 is specified, show only commits which modified this path.
327 Start traversing history at the specified
329 The expected argument is a commit ID SHA1 hash or an existing reference
330 or tag name which will be resolved to a commit ID.
331 An abbreviated hash argument will be expanded to a full SHA1 hash
332 automatically, provided the abbreviation is unique.
333 If this option is not specified, default to the work tree's current branch
334 if invoked in a work tree, or to the repository's HEAD reference.
336 Set the number of context lines shown in diffs with
338 By default, 3 lines of context are shown.
340 Restrict history traversal to the first parent of each commit.
341 This shows the linear history of the current branch only.
342 Merge commits which affected the current branch will be shown but
343 individual commits which originated on other branches will be omitted.
345 Limit history traversal to a given number of commits.
346 If this option is not specified, a default limit value of zero is used,
347 which is treated as an unbounded limit.
349 .Ev GOT_LOG_DEFAULT_LIMIT
350 environment variable may be set to change this default value.
352 Display the patch of modifications made in each commit.
355 is specified, only show the patch of modifications at or within this path.
356 .It Fl r Ar repository-path
357 Use the repository at the specified path.
358 If not specified, assume the repository is located at or above the current
360 If this directory is a
362 work tree, use the repository path associated with this work tree.
364 .It Cm diff Oo Fl C Ar number Oc Oo Fl r Ar repository-path Oc Oo Fl s Oc Op Ar object1 Ar object2 | Ar path
365 When invoked within a work tree with less than two arguments, display
366 uncommitted changes in the work tree.
369 is specified, only show changes within this path.
371 If two arguments are provided, treat each argument as a reference, a tag
372 name, or an object ID SHA1 hash, and display differences between the
373 corresponding objects.
374 Both objects must be of the same type (blobs, trees, or commits).
375 An abbreviated hash argument will be expanded to a full SHA1 hash
376 automatically, provided the abbreviation is unique.
383 Set the number of context lines shown in the diff.
384 By default, 3 lines of context are shown.
385 .It Fl r Ar repository-path
386 Use the repository at the specified path.
387 If not specified, assume the repository is located at or above the current
389 If this directory is a
391 work tree, use the repository path associated with this work tree.
393 Show changes staged with
395 instead of showing local changes.
396 This option is only valid when
398 is invoked in a work tree.
403 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
404 Display line-by-line history of a file at the specified path.
411 Start traversing history at the specified
413 The expected argument is a commit ID SHA1 hash or an existing reference
414 or tag name which will be resolved to a commit ID.
415 An abbreviated hash argument will be expanded to a full SHA1 hash
416 automatically, provided the abbreviation is unique.
417 .It Fl r Ar repository-path
418 Use the repository at the specified path.
419 If not specified, assume the repository is located at or above the current
421 If this directory is a
423 work tree, use the repository path associated with this work tree.
428 .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
429 Display a listing of files and directories at the specified
430 directory path in the repository.
431 Entries shown in this listing may carry one of the following trailing
433 .Bl -column YXZ description
434 .It @ Ta entry is a symbolic link
435 .It / Ta entry is a directory
436 .It * Ta entry is an executable file
437 .It $ Ta entry is a Git submodule
442 is specified, list the repository path corresponding to the current
443 directory of the work tree, or the root directory of the repository
444 if there is no work tree.
451 List files and directories as they appear in 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.
465 Show object IDs of files (blob objects) and directories (tree objects).
467 Recurse into sub-directories in the repository.
472 .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
473 Manage references in a repository.
475 If no options are passed, expect two arguments and attempt to create,
476 or update, the reference with the given
478 and make it point at the given
480 The target may be an object ID SHA1 hash or an existing reference which
481 will be resolved to an object ID.
482 An abbreviated hash argument will be expanded to a full SHA1 hash
483 automatically, provided the abbreviation is unique.
489 .It Fl r Ar repository-path
490 Use the repository at the specified path.
491 If not specified, assume the repository is located at or above the current
493 If this directory is a
495 work tree, use the repository path associated with this work tree.
497 List all existing references in the repository.
499 Delete the reference with the specified name from the repository.
501 Create a symbolic reference pointing at the specified
503 which must be an existing reference.
504 Care should be taken not to create loops between references when
507 .It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar commit
508 Manage branches in a repository.
510 Branches are managed via references which live in the
515 command operates on references in this namespace only.
517 If no options are passed, expect one or two arguments and attempt to create
518 a branch reference with the given
520 and make it point at the given
524 argument is a commit ID SHA1 hash or an existing reference
525 or tag name which will be resolved to a commit ID.
528 is specified, default to the latest commit on the work tree's current
529 branch if invoked in a work tree, or to a commit resolved via the
530 repository's HEAD reference.
536 .It Fl r Ar repository-path
537 Use the repository at the specified path.
538 If not specified, assume the repository is located at or above the current
540 If this directory is a
542 work tree, use the repository path associated with this work tree.
544 List all existing branches in the repository.
545 If invoked in a work tree, the work tree's current branch is shown
546 with one the following annotations:
547 .Bl -column YXZ description
548 .It * Ta work tree's base commit matches the branch tip
549 .It \(a~ Ta work tree's base commit is out-of-date
552 Delete the branch with the specified name from the repository.
553 Only the branch reference is deleted.
554 Any commit, tree, and blob objects belonging to the branch
555 remain in the repository and may be removed separately with
556 Git's garbage collector.
561 .It Cm tag Oo Fl m Ar message Oc Oo Fl r Ar repository-path Oc Oo Fl l Oc Ar name Op Ar commit Oc
562 Manage tags in a repository.
564 Tags are managed via references which live in the
569 command operates on references in this namespace only.
570 References in this namespace point at tag objects which contain a pointer
571 to another object, a tag message, as well as author and timestamp information.
573 Expect one or two arguments and attempt to create a tag with the given
575 and make this tag point at the given
577 If no commit is specified, default to the latest commit on the work tree's
578 current branch if invoked in a work tree, and to a commit resolved via
579 the repository's HEAD reference otherwise.
580 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
581 reference or tag name which will be resolved to a commit ID.
582 An abbreviated hash argument will be expanded to a full SHA1 hash
583 automatically, provided the abbreviation is unique.
590 Use the specified tag message when creating the new tag
595 opens a temporary file in an editor where a tag message can be written.
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 tags in the repository instead of creating a new tag.
605 If this option is used, no other command-line arguments are allowed.
610 command will not delete tags or change existing tags.
611 If a tag must be deleted, the
613 command may be used to delete a tag's reference.
614 This should only be done if the tag has not already been copied to
616 .It Cm add Ar file-path ...
617 Schedule unversioned files in a work tree for addition to the
618 repository in the next commit.
619 .It Cm remove Ar file-path ...
620 Remove versioned files from a work tree and schedule them for deletion
621 from the repository in the next commit.
628 Perform the operation even if a file contains uncommitted modifications.
633 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
634 Revert any uncommitted changes in files at the specified paths.
635 File contents will be overwritten with those contained in the
636 work tree's base commit.
637 There is no way to bring discarded changes back after
640 If a file was added with
642 it will become an unversioned file again.
643 If a file was deleted with
652 Instead of reverting all changes in files, interactively select or reject
653 changes to revert based on
659 (quit reverting this file) responses.
660 If a file is in modified status, individual patches derived from the
661 modified file content can be reverted.
662 Files in added or deleted status may only be reverted in their entirety.
663 .It Fl F Ar response-script
671 responses line-by-line from the specified
673 file instead of prompting interactively.
675 Permit recursion into directories.
676 If this option is not specified,
678 will refuse to run if a specified
685 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
686 Create a new commit in the repository from changes in a work tree
687 and use this commit as the new base commit for the work tree.
690 is specified, commit all changes in the work tree.
691 Otherwise, commit changes at or within the specified paths.
693 If changes have been explicitly staged for commit with
695 only commit staged changes and reject any specified paths which
696 have not been staged.
698 Show the status of each affected file, using the following status codes:
699 .Bl -column YXZ description
700 .It M Ta modified file
701 .It D Ta file was deleted
702 .It A Ta new file was added
705 Files which are not part of the new commit will retain their previously
706 recorded base commit.
709 commands may refuse to run while the work tree contains files from
710 multiple base commits.
711 The base commit of such a work tree can be made consistent by running
713 across the entire work tree.
719 environment variable to be set,
724 configuration settings can be
725 obtained from the repository's
727 file or from Git's global
736 Use the specified log message when creating the new commit.
741 opens a temporary file in an editor where a log message can be written.
745 will refuse to run if certain preconditions are not met.
746 If the work tree's current branch is not in the
748 reference namespace, new commits may not be created on this branch.
749 Local changes may only be committed if they are based on file content
750 found in the most recent commit on the work tree's branch.
751 If a path is found to be out of date,
753 must be used first in order to merge local changes with changes made
758 .It Cm cherrypick Ar commit
759 Merge changes from a single
764 must be on a different branch than the work tree's base commit.
765 The expected argument is a reference or a commit ID SHA1 hash.
766 An abbreviated hash argument will be expanded to a full SHA1 hash
767 automatically, provided the abbreviation is unique.
769 Show the status of each affected file, using the following status codes:
770 .Bl -column YXZ description
771 .It G Ta file was merged
772 .It C Ta file was merged and conflicts occurred during merge
773 .It ! Ta changes destined for a missing file were not merged
774 .It D Ta file was deleted
775 .It d Ta file's deletion was obstructed by local modifications
776 .It A Ta new file was added
777 .It \(a~ Ta changes destined for a non-regular file were not merged
780 The merged changes will appear as local changes in the work tree, which
783 amended manually or with further
788 or discarded again with
792 will refuse to run if certain preconditions are not met.
793 If the work tree contains multiple base commits it must first be updated
794 to a single base commit with
796 If the work tree already contains files with merge conflicts, these
797 conflicts must be resolved first.
801 .It Cm backout Ar commit
802 Reverse-merge changes from a single
807 must be on the same branch as the work tree's base commit.
808 The expected argument is a reference or a commit ID SHA1 hash.
809 An abbreviated hash argument will be expanded to a full SHA1 hash
810 automatically, provided the abbreviation is unique.
812 Show the status of each affected file, using the following status codes:
813 .Bl -column YXZ description
814 .It G Ta file was merged
815 .It C Ta file was merged and conflicts occurred during merge
816 .It ! Ta changes destined for a missing file were not merged
817 .It D Ta file was deleted
818 .It d Ta file's deletion was obstructed by local modifications
819 .It A Ta new file was added
820 .It \(a~ Ta changes destined for a non-regular file were not merged
823 The reverse-merged changes will appear as local changes in the work tree,
824 which may be viewed with
826 amended manually or with further
831 or discarded again with
835 will refuse to run if certain preconditions are not met.
836 If the work tree contains multiple base commits it must first be updated
837 to a single base commit with
839 If the work tree already contains files with merge conflicts, these
840 conflicts must be resolved first.
844 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
845 Rebase commits on the specified
847 onto the tip of the current branch of the work tree.
850 must share common ancestry with the work tree's current branch.
851 Rebasing begins with the first descendant commit of the youngest
852 common ancestor commit shared by the specified
854 and the work tree's current branch, and stops once the tip commit
859 Rebased commits are accumulated on a temporary branch which the work tree
860 will remain switched to throughout the entire rebase operation.
861 Commits on this branch represent the same changes with the same log
862 messages as their counterparts on the original
864 but with different commit IDs.
865 Once rebasing has completed successfully, the temporary branch becomes
866 the new version of the specified
868 and the work tree is automatically switched to it.
870 While rebasing commits, show the status of each affected file,
871 using the following status codes:
872 .Bl -column YXZ description
873 .It G Ta file was merged
874 .It C Ta file was merged and conflicts occurred during merge
875 .It ! Ta changes destined for a missing file were not merged
876 .It D Ta file was deleted
877 .It d Ta file's deletion was obstructed by local modifications
878 .It A Ta new file was added
879 .It \(a~ Ta changes destined for a non-regular file were not merged
882 If merge conflicts occur the rebase operation is interrupted and may
883 be continued once conflicts have been resolved.
884 Alternatively, the rebase operation may be aborted which will leave
886 unmodified and the work tree switched back to its original branch.
888 If a merge conflict is resolved in a way which renders the merged
889 change into a no-op change, the corresponding commit will be elided
890 when the rebase operation continues.
893 will refuse to run if certain preconditions are not met.
894 If the work tree contains multiple base commits it must first be updated
895 to a single base commit with
897 If changes have been staged with
899 these changes must first be committed with
903 If the work tree contains local changes, these changes must first be
910 contains changes to files outside of the work tree's path prefix,
911 the work tree cannot be used to rebase this branch.
917 commands will refuse to run while a rebase operation is in progress.
918 Other commands which manipulate the work tree may be used for
919 conflict resolution purposes.
926 Abort an interrupted rebase operation.
927 If this option is used, no other command-line arguments are allowed.
929 Continue an interrupted rebase operation.
930 If this option is used, no other command-line arguments are allowed.
935 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
936 Edit commit history between the work tree's current base commit and
937 the tip commit of the work tree's current branch.
939 Editing of commit history is controlled via a
941 which can be edited interactively or passed on the command line.
942 The format of the histedit script is line-based.
943 Each line in the script begins with a command name, followed by
944 whitespace and an argument.
945 For most commands, the expected argument is a commit ID SHA1 hash.
946 Any remaining text on the line is ignored.
947 Lines which begin with the
949 character are ignored entirely.
951 The available commands are as follows:
952 .Bl -column YXZ pick-commit
953 .It pick Ar commit Ta Use the specified commit as it is.
954 .It edit Ar commit Ta Use the specified commit but once changes have been
955 merged into the work tree interrupt the histedit operation for amending.
956 .It fold Ar commit Ta Combine the specified commit with the next commit
957 listed further below that will be used.
958 .It drop Ar commit Ta Remove this commit from the edited history.
959 .It mesg Ar log-message Ta Use the specified single-line log message for
960 the commit on the previous line.
961 If the log message argument is left empty, open an editor where a new
962 log message can be written.
965 Every commit in the history being edited must be mentioned in the script.
966 Lines may be re-ordered to change the order of commits in the edited history.
968 Edited commits are accumulated on a temporary branch which the work tree
969 will remain switched to throughout the entire histedit operation.
970 Once history editing has completed successfully, the temporary branch becomes
971 the new version of the work tree's branch and the work tree is automatically
974 While merging commits, show the status of each affected file,
975 using the following status codes:
976 .Bl -column YXZ description
977 .It G Ta file was merged
978 .It C Ta file was merged and conflicts occurred during merge
979 .It ! Ta changes destined for a missing file were not merged
980 .It D Ta file was deleted
981 .It d Ta file's deletion was obstructed by local modifications
982 .It A Ta new file was added
983 .It \(a~ Ta changes destined for a non-regular file were not merged
986 If merge conflicts occur the histedit operation is interrupted and may
987 be continued once conflicts have been resolved.
988 Alternatively, the histedit operation may be aborted which will leave
989 the work tree switched back to its original branch.
991 If a merge conflict is resolved in a way which renders the merged
992 change into a no-op change, the corresponding commit will be elided
993 when the histedit operation continues.
996 will refuse to run if certain preconditions are not met.
997 If the work tree's current branch is not in the
999 reference namespace, the history of the branch may not be edited.
1000 If the work tree contains multiple base commits it must first be updated
1001 to a single base commit with
1003 If changes have been staged with
1005 these changes must first be committed with
1009 If the work tree contains local changes, these changes must first be
1014 If the edited history contains changes to files outside of the work tree's
1015 path prefix, the work tree cannot be used to edit the history of this branch.
1019 command will refuse to run while a histedit operation is in progress.
1020 Other commands which manipulate the work tree may be used, and the
1022 command may be used to commit arbitrary changes to the temporary branch
1023 while the histedit operation is interrupted.
1030 Abort an interrupted histedit operation.
1031 If this option is used, no other command-line arguments are allowed.
1033 Continue an interrupted histedit operation.
1034 If this option is used, no other command-line arguments are allowed.
1039 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1040 Stage local changes for inclusion in the next commit.
1043 is specified, stage all changes in the work tree.
1044 Otherwise, stage changes at or within the specified paths.
1045 Paths may be staged if they are added, modified, or deleted according to
1048 Show the status of each affected file, using the following status codes:
1049 .Bl -column YXZ description
1050 .It A Ta file addition has been staged
1051 .It M Ta file modification has been staged
1052 .It D Ta file deletion has been staged
1055 Staged file contents are saved in newly created blob objects in the repository.
1056 These blobs will be referred to by tree objects once staged changes have been
1059 Staged changes affect the behaviour of
1064 While paths with staged changes exist, the
1066 command will refuse to commit any paths which do not have staged changes.
1067 Local changes created on top of staged changes can only be committed if
1068 the path is staged again, or if the staged changes are committed first.
1071 command will show both local changes and staged changes.
1074 command is able to display local changes relative to staged changes,
1075 and to display staged changes relative to the repository.
1078 command cannot revert staged changes but may be used to revert
1079 local changes created on top of staged changes.
1086 Instead of staging new changes, list paths which are already staged,
1087 along with the IDs of staged blob objects and stage status codes.
1088 If paths were provided in the command line show the staged paths
1089 among the specified paths.
1090 Otherwise, show all staged paths.
1092 Instead of staging the entire content of a changed file, interactively
1093 select or reject changes for staging based on
1097 (reject change), and
1099 (quit staging this file) responses.
1100 If a file is in modified status, individual patches derived from the
1101 modified file content can be staged.
1102 Files in added or deleted status may only be staged or rejected in
1104 .It Fl F Ar response-script
1112 responses line-by-line from the specified
1114 file instead of prompting interactively.
1118 will refuse to run if certain preconditions are not met.
1119 If a file contains merge conflicts, these conflicts must be resolved first.
1120 If a file is found to be out of date relative to the head commit on the
1121 work tree's current branch, the file must be updated with
1123 before it can be staged (however, this does not prevent the file from
1124 becoming out-of-date at some point after having been staged).
1131 commands will refuse to run while staged changes exist.
1132 If staged changes cannot be committed because a staged path
1133 is out of date, the path must be unstaged with
1135 before it can be updated with
1137 and may then be staged again if necessary.
1141 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1142 Merge staged changes back into the work tree and put affected paths
1143 back into non-staged status.
1146 is specified, unstage all staged changes across the entire work tree.
1147 Otherwise, unstage changes at or within the specified paths.
1149 Show the status of each affected file, using the following status codes:
1150 .Bl -column YXZ description
1151 .It G Ta file was unstaged
1152 .It C Ta file was unstaged and conflicts occurred during merge
1153 .It ! Ta changes destined for a missing file were not merged
1154 .It D Ta file was staged as deleted and still is deleted
1155 .It d Ta file's deletion was obstructed by local modifications
1156 .It \(a~ Ta changes destined for a non-regular file were not merged
1164 Instead of unstaging the entire content of a changed file, interactively
1165 select or reject changes for unstaging based on
1169 (keep change staged), and
1171 (quit unstaging this file) responses.
1172 If a file is staged in modified status, individual patches derived from the
1173 staged file content can be unstaged.
1174 Files staged in added or deleted status may only be unstaged in their entirety.
1175 .It Fl F Ar response-script
1183 responses line-by-line from the specified
1185 file instead of prompting interactively.
1190 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1191 Parse and print contents of objects to standard output in a line-based
1193 Content of commit, tree, and tag objects is printed in a way similar
1194 to the actual content stored in such objects.
1195 Blob object contents are printed as they would appear in files on disk.
1197 Attempt to interpret each argument as a reference, a tag name, or
1198 an object ID SHA1 hash.
1199 References will be resolved to an object ID.
1200 Tag names will resolved to a tag object.
1201 An abbreviated hash argument will be expanded to a full SHA1 hash
1202 automatically, provided the abbreviation is unique.
1204 If none of the above interpretations produce a valid result, or if the
1206 option is used, attempt to interpret the argument as a path which will
1207 be resolved to the ID of an object found at this path in the repository.
1214 Look up paths in the specified
1216 If this option is not used, paths are looked up in the commit resolved
1217 via the repository's HEAD reference.
1218 The expected argument is a commit ID SHA1 hash or an existing reference
1219 or tag name which will be resolved to a commit ID.
1220 An abbreviated hash argument will be expanded to a full SHA1 hash
1221 automatically, provided the abbreviation is unique.
1222 .It Fl r Ar repository-path
1223 Use the repository at the specified path.
1224 If not specified, assume the repository is located at or above the current
1226 If this directory is a
1228 work tree, use the repository path associated with this work tree.
1230 Interpret all arguments as paths only.
1231 This option can be used to resolve ambiguity in cases where paths
1232 look like tag names, reference names, or object IDs.
1236 .Bl -tag -width GOT_AUTHOR
1238 The author's name and email address for
1243 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1246 may fail to parse commits without an email address in author data,
1250 environment variables with a missing email address.
1256 configuration settings in the repository's
1258 file will override the value of
1264 configuration settings contained in Git's global
1266 configuration file will be used only if the
1268 environment variable is
1271 .It Ev VISUAL , EDITOR
1272 The editor spawned by
1277 .It Ev GOT_LOG_DEFAULT_LIMIT
1278 The default limit on the number of commits traversed by
1280 If set to zero, the limit is unbounded.
1281 This variable will be silently ignored if it is set to a non-numeric value.
1286 Clone an existing Git repository for use with
1288 This step currently requires
1292 .Dl $ git clone --bare https://github.com/openbsd/src.git
1294 Alternatively, for quick and dirty local testing of
1296 a new Git repository could be created and populated with files,
1297 e.g. from a temporary CVS checkout located at
1300 .Dl $ got init /var/git/src.git
1301 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1303 Check out a work tree from the Git repository to /usr/src:
1305 .Dl $ got checkout /var/git/src.git /usr/src
1307 View local changes in a work tree directory:
1310 .Dl $ got diff | less
1312 Interactively revert selected local changes in a work tree directory:
1314 .Dl $ got revert -p -R\ .
1316 In a work tree or a git repository directory, list all branch references:
1320 In a work tree or a git repository directory, create a new branch called
1321 .Dq unified-buffer-cache
1322 which is forked off the
1326 .Dl $ got branch unified-buffer-cache master
1328 Switch an existing work tree to the branch
1329 .Dq unified-buffer-cache .
1330 Local changes in the work tree will be preserved and merged if necessary:
1332 .Dl $ got update -b unified-buffer-cache
1334 Create a new commit from local changes in a work tree directory.
1335 This new commit will become the head commit of the work tree's current branch:
1339 In a work tree or a git repository directory, view changes committed in
1340 the 3 most recent commits to the work tree's branch, or the branch resolved
1341 via the repository's HEAD reference, respectively:
1343 .Dl $ got log -p -l 3 -f
1345 Add new files and remove obsolete files in a work tree directory:
1347 .Dl $ got add sys/uvm/uvm_ubc.c
1348 .Dl $ got remove sys/uvm/uvm_vnode.c
1350 Create a new commit from local changes in a work tree directory
1351 with a pre-defined log message.
1353 .Dl $ got commit -m 'unify the buffer cache'
1355 Update any work tree checked out from the
1356 .Dq unified-buffer-cache
1357 branch to the latest commit on this branch:
1361 Roll file content on the unified-buffer-cache branch back by one commit,
1362 and then fetch the rolled-back change into the work tree as a local change
1363 to be amended and perhaps committed again:
1365 .Dl $ got backout unified-buffer-cache
1366 .Dl $ got commit -m 'roll back previous'
1367 .Dl $ # now back out the previous backout :-)
1368 .Dl $ got backout unified-buffer-cache
1370 Fetch new upstream commits into the local repository's master branch.
1371 This step currently requires
1374 .Dl $ cd /var/git/src.git
1375 .Dl $ git fetch origin master:master
1378 .Dq unified-buffer-cache
1379 branch on top of the new head commit of the
1383 .Dl $ got update -b master
1384 .Dl $ got rebase unified-buffer-cache
1386 Create a patch from all changes on the unified-buffer-cache branch.
1387 The patch can be mailed out for review and applied to
1391 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1393 Edit the entire commit history of the
1394 .Dq unified-buffer-cache
1397 .Dl $ got update -b unified-buffer-cache
1398 .Dl $ got update -c master
1401 Additional steps are necessary if local changes need to be pushed back
1402 to the remote repository, which currently requires
1406 Before working against existing branches in a repository cloned with
1407 .Dq git clone --bare ,
1410 must be configured to map all references in the remote repository
1413 namespace of the local repository.
1414 This can achieved by setting Git's
1415 .Pa remote.origin.fetch
1416 configuration variable to the value
1417 .Dq +refs/heads/*:refs/remotes/origin/*
1422 .Dl $ cd /var/git/repo
1423 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1425 Alternatively, the following
1427 configuration item can be added manually to the Git repository's
1431 .Dl [remote "origin"]
1433 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1435 This configuration leaves the local repository's
1437 namespace free for use by local branches checked out with
1439 and, if needed, created with
1444 namespace can be updated with incoming changes from the remote
1448 .Dl $ cd /var/git/repo
1451 Before outgoing changes on the local
1453 branch can be pushed to the remote repository, the local
1455 branch must be rebased onto the
1459 .Dl $ got update -b origin/master
1460 .Dl $ got rebase master
1462 Changes on the local
1464 branch can then be pushed to the remote
1468 .Dl $ cd /var/git/repo
1469 .Dl $ git push origin master
1472 .Xr git-repository 5 ,
1475 .An Stefan Sperling Aq Mt stsp@openbsd.org
1476 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1477 .An Joshua Stein Aq Mt jcs@openbsd.org
1480 is a work-in-progress and many commands remain to be implemented.
1481 At present, the user has to fall back on
1483 to perform many tasks, in particular tasks related to repository
1484 administration and tasks which require a network connection.
