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 m Ta modified file modes (executable bit only)
256 .It N Ta non-existent
258 specified on the command line
263 is specified, show modifications in the entire work tree.
264 Otherwise, show modifications at or within the specified paths.
266 If changes have been staged with
268 staged changes are shown in the second output column, using the following
270 .Bl -column YXZ description
271 .It M Ta file modification is staged
272 .It A Ta file addition is staged
273 .It D Ta file deletion is staged
276 Changes created on top of staged changes are indicated in the first column:
277 .Bl -column YXZ description
278 .It MM Ta file was modified after earlier changes have been staged
279 .It MA Ta file was modified after having been staged for addition
282 For compatibility with
293 files in each traversed directory and will not display unversioned files
294 which match these patterns.
299 supports consecutive asterisks,
301 which will match an arbitrary amount of directories.
305 only supports a single ignore pattern per line.
309 does not support negated ignore patterns prefixed with
311 and gives no special significance to the location of path component separators,
317 .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
318 Display history of a repository.
321 is specified, show only commits which modified this path.
328 Start traversing history at the specified
330 The expected argument is a commit ID SHA1 hash or an existing reference
331 or tag name which will be resolved to a commit ID.
332 An abbreviated hash argument will be expanded to a full SHA1 hash
333 automatically, provided the abbreviation is unique.
334 If this option is not specified, default to the work tree's current branch
335 if invoked in a work tree, or to the repository's HEAD reference.
337 Set the number of context lines shown in diffs with
339 By default, 3 lines of context are shown.
341 Restrict history traversal to the first parent of each commit.
342 This shows the linear history of the current branch only.
343 Merge commits which affected the current branch will be shown but
344 individual commits which originated on other branches will be omitted.
346 Limit history traversal to a given number of commits.
347 If this option is not specified, a default limit value of zero is used,
348 which is treated as an unbounded limit.
350 .Ev GOT_LOG_DEFAULT_LIMIT
351 environment variable may be set to change this default value.
353 Display the patch of modifications made in each commit.
356 is specified, only show the patch of modifications at or within this path.
357 .It Fl r Ar repository-path
358 Use the repository at the specified path.
359 If not specified, assume the repository is located at or above the current
361 If this directory is a
363 work tree, use the repository path associated with this work tree.
365 .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
366 When invoked within a work tree with less than two arguments, display
367 uncommitted changes in the work tree.
370 is specified, only show changes within this path.
372 If two arguments are provided, treat each argument as a reference, a tag
373 name, or an object ID SHA1 hash, and display differences between the
374 corresponding objects.
375 Both objects must be of the same type (blobs, trees, or commits).
376 An abbreviated hash argument will be expanded to a full SHA1 hash
377 automatically, provided the abbreviation is unique.
384 Set the number of context lines shown in the diff.
385 By default, 3 lines of context are shown.
386 .It Fl r Ar repository-path
387 Use the repository at the specified path.
388 If not specified, assume the repository is located at or above the current
390 If this directory is a
392 work tree, use the repository path associated with this work tree.
394 Show changes staged with
396 instead of showing local changes.
397 This option is only valid when
399 is invoked in a work tree.
401 Ignore whitespace-only changes.
406 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
407 Display line-by-line history of a file at the specified path.
414 Start traversing history at the specified
416 The expected argument is a commit ID SHA1 hash or an existing reference
417 or tag name which will be resolved to a commit ID.
418 An abbreviated hash argument will be expanded to a full SHA1 hash
419 automatically, provided the abbreviation is unique.
420 .It Fl r Ar repository-path
421 Use the repository at the specified path.
422 If not specified, assume the repository is located at or above the current
424 If this directory is a
426 work tree, use the repository path associated with this work tree.
431 .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
432 Display a listing of files and directories at the specified
433 directory path in the repository.
434 Entries shown in this listing may carry one of the following trailing
436 .Bl -column YXZ description
437 .It @ Ta entry is a symbolic link
438 .It / Ta entry is a directory
439 .It * Ta entry is an executable file
440 .It $ Ta entry is a Git submodule
445 is specified, list the repository path corresponding to the current
446 directory of the work tree, or the root directory of the repository
447 if there is no work tree.
454 List files and directories as they appear in the specified
456 The expected argument is a commit ID SHA1 hash or an existing reference
457 or tag name which will be resolved to a commit ID.
458 An abbreviated hash argument will be expanded to a full SHA1 hash
459 automatically, provided the abbreviation is unique.
460 .It Fl r Ar repository-path
461 Use the repository at the specified path.
462 If not specified, assume the repository is located at or above the current
464 If this directory is a
466 work tree, use the repository path associated with this work tree.
468 Show object IDs of files (blob objects) and directories (tree objects).
470 Recurse into sub-directories in the repository.
475 .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
476 Manage references in a repository.
478 If no options are passed, expect two arguments and attempt to create,
479 or update, the reference with the given
481 and make it point at the given
483 The name must be an absolute reference name, i.e. it must begin with
485 The target may be an object ID SHA1 hash or an existing reference which
486 will be resolved to an object ID.
487 An abbreviated hash argument will be expanded to a full SHA1 hash
488 automatically, provided the abbreviation is unique.
494 .It Fl r Ar repository-path
495 Use the repository at the specified path.
496 If not specified, assume the repository is located at or above the current
498 If this directory is a
500 work tree, use the repository path associated with this work tree.
502 List all existing references in the repository.
504 Delete the reference with the specified name from the repository.
506 Create a symbolic reference pointing at the specified
508 which must be an existing reference.
509 Care should be taken not to create loops between references when
512 .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 Op Ar name
513 Manage branches in a repository.
515 Branches are managed via references which live in the
520 command operates on references in this namespace only.
522 If invoked in a work tree without any arguments, print the name of the
523 work tree's current branch.
526 argument is passed, attempt to create a branch reference with the given name.
527 By default the new branch reference will point at the latest commit on the
528 work tree's current branch if invoked in a work tree, and otherwise to a commit
529 resolved via the repository's HEAD reference.
536 Make a newly created branch reference point at the specified
540 argument is a commit ID SHA1 hash or an existing reference
541 or tag name which will be resolved to a commit ID.
542 .It Fl r Ar repository-path
543 Use the repository at the specified path.
544 If not specified, assume the repository is located at or above the current
546 If this directory is a
548 work tree, use the repository path associated with this work tree.
550 List all existing branches in the repository.
551 If invoked in a work tree, the work tree's current branch is shown
552 with one the following annotations:
553 .Bl -column YXZ description
554 .It * Ta work tree's base commit matches the branch tip
555 .It \(a~ Ta work tree's base commit is out-of-date
558 Delete the branch with the specified name from the repository.
559 Only the branch reference is deleted.
560 Any commit, tree, and blob objects belonging to the branch
561 remain in the repository and may be removed separately with
562 Git's garbage collector.
567 .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
568 Manage tags in a repository.
570 Tags are managed via references which live in the
575 command operates on references in this namespace only.
576 References in this namespace point at tag objects which contain a pointer
577 to another object, a tag message, as well as author and timestamp information.
579 Expect one or two arguments and attempt to create a tag with the given
581 and make this tag point at the given
583 If no commit is specified, default to the latest commit on the work tree's
584 current branch if invoked in a work tree, and to a commit resolved via
585 the repository's HEAD reference otherwise.
586 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
587 reference or tag name which will be resolved to a commit ID.
588 An abbreviated hash argument will be expanded to a full SHA1 hash
589 automatically, provided the abbreviation is unique.
596 Use the specified tag message when creating the new tag
601 opens a temporary file in an editor where a tag message can be written.
602 .It Fl r Ar repository-path
603 Use the repository at the specified path.
604 If not specified, assume the repository is located at or above the current
606 If this directory is a
608 work tree, use the repository path associated with this work tree.
610 List all existing tags in the repository instead of creating a new tag.
611 If this option is used, no other command-line arguments are allowed.
616 command will not delete tags or change existing tags.
617 If a tag must be deleted, the
619 command may be used to delete a tag's reference.
620 This should only be done if the tag has not already been copied to
622 .It Cm add Oo Fl R Oc Ar path ...
623 Schedule unversioned files in a work tree for addition to the
624 repository in the next commit.
631 Permit recursion into directories.
632 If this option is not specified,
634 will refuse to run if a specified
638 .It Cm remove Ar file-path ...
639 Remove versioned files from a work tree and schedule them for deletion
640 from the repository in the next commit.
647 Perform the operation even if a file contains uncommitted modifications.
652 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
653 Revert any uncommitted changes in files at the specified paths.
654 File contents will be overwritten with those contained in the
655 work tree's base commit.
656 There is no way to bring discarded changes back after
659 If a file was added with
661 it will become an unversioned file again.
662 If a file was deleted with
671 Instead of reverting all changes in files, interactively select or reject
672 changes to revert based on
678 (quit reverting this file) responses.
679 If a file is in modified status, individual patches derived from the
680 modified file content can be reverted.
681 Files in added or deleted status may only be reverted in their entirety.
682 .It Fl F Ar response-script
690 responses line-by-line from the specified
692 file instead of prompting interactively.
694 Permit recursion into directories.
695 If this option is not specified,
697 will refuse to run if a specified
704 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
705 Create a new commit in the repository from changes in a work tree
706 and use this commit as the new base commit for the work tree.
709 is specified, commit all changes in the work tree.
710 Otherwise, commit changes at or within the specified paths.
712 If changes have been explicitly staged for commit with
714 only commit staged changes and reject any specified paths which
715 have not been staged.
717 Show the status of each affected file, using the following status codes:
718 .Bl -column YXZ description
719 .It M Ta modified file
720 .It D Ta file was deleted
721 .It A Ta new file was added
722 .It m Ta modified file modes (executable bit only)
725 Files which are not part of the new commit will retain their previously
726 recorded base commit.
729 commands may refuse to run while the work tree contains files from
730 multiple base commits.
731 The base commit of such a work tree can be made consistent by running
733 across the entire work tree.
739 environment variable to be set,
744 configuration settings can be
745 obtained from the repository's
747 file or from Git's global
756 Use the specified log message when creating the new commit.
761 opens a temporary file in an editor where a log message can be written.
765 will refuse to run if certain preconditions are not met.
766 If the work tree's current branch is not in the
768 reference namespace, new commits may not be created on this branch.
769 Local changes may only be committed if they are based on file content
770 found in the most recent commit on the work tree's branch.
771 If a path is found to be out of date,
773 must be used first in order to merge local changes with changes made
778 .It Cm cherrypick Ar commit
779 Merge changes from a single
784 must be on a different branch than the work tree's base commit.
785 The expected argument is a reference or a commit ID SHA1 hash.
786 An abbreviated hash argument will be expanded to a full SHA1 hash
787 automatically, provided the abbreviation is unique.
789 Show the status of each affected file, using the following status codes:
790 .Bl -column YXZ description
791 .It G Ta file was merged
792 .It C Ta file was merged and conflicts occurred during merge
793 .It ! Ta changes destined for a missing file were not merged
794 .It D Ta file was deleted
795 .It d Ta file's deletion was obstructed by local modifications
796 .It A Ta new file was added
797 .It \(a~ Ta changes destined for a non-regular file were not merged
800 The merged changes will appear as local changes in the work tree, which
803 amended manually or with further
808 or discarded again with
812 will refuse to run if certain preconditions are not met.
813 If the work tree contains multiple base commits it must first be updated
814 to a single base commit with
816 If the work tree already contains files with merge conflicts, these
817 conflicts must be resolved first.
821 .It Cm backout Ar commit
822 Reverse-merge changes from a single
827 must be on the same branch as the work tree's base commit.
828 The expected argument is a reference or a commit ID SHA1 hash.
829 An abbreviated hash argument will be expanded to a full SHA1 hash
830 automatically, provided the abbreviation is unique.
832 Show the status of each affected file, using the following status codes:
833 .Bl -column YXZ description
834 .It G Ta file was merged
835 .It C Ta file was merged and conflicts occurred during merge
836 .It ! Ta changes destined for a missing file were not merged
837 .It D Ta file was deleted
838 .It d Ta file's deletion was obstructed by local modifications
839 .It A Ta new file was added
840 .It \(a~ Ta changes destined for a non-regular file were not merged
843 The reverse-merged changes will appear as local changes in the work tree,
844 which may be viewed with
846 amended manually or with further
851 or discarded again with
855 will refuse to run if certain preconditions are not met.
856 If the work tree contains multiple base commits it must first be updated
857 to a single base commit with
859 If the work tree already contains files with merge conflicts, these
860 conflicts must be resolved first.
864 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
865 Rebase commits on the specified
867 onto the tip of the current branch of the work tree.
870 must share common ancestry with the work tree's current branch.
871 Rebasing begins with the first descendant commit of the youngest
872 common ancestor commit shared by the specified
874 and the work tree's current branch, and stops once the tip commit
879 Rebased commits are accumulated on a temporary branch which the work tree
880 will remain switched to throughout the entire rebase operation.
881 Commits on this branch represent the same changes with the same log
882 messages as their counterparts on the original
884 but with different commit IDs.
885 Once rebasing has completed successfully, the temporary branch becomes
886 the new version of the specified
888 and the work tree is automatically switched to it.
890 While rebasing commits, show the status of each affected file,
891 using the following status codes:
892 .Bl -column YXZ description
893 .It G Ta file was merged
894 .It C Ta file was merged and conflicts occurred during merge
895 .It ! Ta changes destined for a missing file were not merged
896 .It D Ta file was deleted
897 .It d Ta file's deletion was obstructed by local modifications
898 .It A Ta new file was added
899 .It \(a~ Ta changes destined for a non-regular file were not merged
902 If merge conflicts occur the rebase operation is interrupted and may
903 be continued once conflicts have been resolved.
904 Alternatively, the rebase operation may be aborted which will leave
906 unmodified and the work tree switched back to its original branch.
908 If a merge conflict is resolved in a way which renders the merged
909 change into a no-op change, the corresponding commit will be elided
910 when the rebase operation continues.
913 will refuse to run if certain preconditions are not met.
914 If the work tree contains multiple base commits it must first be updated
915 to a single base commit with
917 If changes have been staged with
919 these changes must first be committed with
923 If the work tree contains local changes, these changes must first be
930 contains changes to files outside of the work tree's path prefix,
931 the work tree cannot be used to rebase this branch.
937 commands will refuse to run while a rebase operation is in progress.
938 Other commands which manipulate the work tree may be used for
939 conflict resolution purposes.
946 Abort an interrupted rebase operation.
947 If this option is used, no other command-line arguments are allowed.
949 Continue an interrupted rebase operation.
950 If this option is used, no other command-line arguments are allowed.
955 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
956 Edit commit history between the work tree's current base commit and
957 the tip commit of the work tree's current branch.
959 Editing of commit history is controlled via a
961 which can be edited interactively or passed on the command line.
962 The format of the histedit script is line-based.
963 Each line in the script begins with a command name, followed by
964 whitespace and an argument.
965 For most commands, the expected argument is a commit ID SHA1 hash.
966 Any remaining text on the line is ignored.
967 Lines which begin with the
969 character are ignored entirely.
971 The available commands are as follows:
972 .Bl -column YXZ pick-commit
973 .It pick Ar commit Ta Use the specified commit as it is.
974 .It edit Ar commit Ta Use the specified commit but once changes have been
975 merged into the work tree interrupt the histedit operation for amending.
976 .It fold Ar commit Ta Combine the specified commit with the next commit
977 listed further below that will be used.
978 .It drop Ar commit Ta Remove this commit from the edited history.
979 .It mesg Ar log-message Ta Use the specified single-line log message for
980 the commit on the previous line.
981 If the log message argument is left empty, open an editor where a new
982 log message can be written.
985 Every commit in the history being edited must be mentioned in the script.
986 Lines may be re-ordered to change the order of commits in the edited history.
988 Edited commits are accumulated on a temporary branch which the work tree
989 will remain switched to throughout the entire histedit operation.
990 Once history editing has completed successfully, the temporary branch becomes
991 the new version of the work tree's branch and the work tree is automatically
994 While merging commits, show the status of each affected file,
995 using the following status codes:
996 .Bl -column YXZ description
997 .It G Ta file was merged
998 .It C Ta file was merged and conflicts occurred during merge
999 .It ! Ta changes destined for a missing file were not merged
1000 .It D Ta file was deleted
1001 .It d Ta file's deletion was obstructed by local modifications
1002 .It A Ta new file was added
1003 .It \(a~ Ta changes destined for a non-regular file were not merged
1006 If merge conflicts occur the histedit operation is interrupted and may
1007 be continued once conflicts have been resolved.
1008 Alternatively, the histedit operation may be aborted which will leave
1009 the work tree switched back to its original branch.
1011 If a merge conflict is resolved in a way which renders the merged
1012 change into a no-op change, the corresponding commit will be elided
1013 when the histedit operation continues.
1016 will refuse to run if certain preconditions are not met.
1017 If the work tree's current branch is not in the
1019 reference namespace, the history of the branch may not be edited.
1020 If the work tree contains multiple base commits it must first be updated
1021 to a single base commit with
1023 If changes have been staged with
1025 these changes must first be committed with
1029 If the work tree contains local changes, these changes must first be
1034 If the edited history contains changes to files outside of the work tree's
1035 path prefix, the work tree cannot be used to edit the history of this branch.
1039 command will refuse to run while a histedit operation is in progress.
1040 Other commands which manipulate the work tree may be used, and the
1042 command may be used to commit arbitrary changes to the temporary branch
1043 while the histedit operation is interrupted.
1050 Abort an interrupted histedit operation.
1051 If this option is used, no other command-line arguments are allowed.
1053 Continue an interrupted histedit operation.
1054 If this option is used, no other command-line arguments are allowed.
1059 .It Cm integrate Ar branch
1060 Integrate the specified
1062 into the work tree's current branch.
1063 Files in the work tree are updated to match the contents on the integrated
1065 and the reference of the work tree's branch is changed to point at the
1066 head commit of the integrated
1069 Both branches can be considered equivalent after integration since they
1070 will be pointing at the same commit.
1071 Both branches remain available for future work, if desired.
1072 In case the integrated
1074 is no longer needed it may be deleted with
1077 Show the status of each affected file, using the following status codes:
1078 .Bl -column YXZ description
1079 .It U Ta file was updated
1080 .It D Ta file was deleted
1081 .It A Ta new file was added
1082 .It \(a~ Ta versioned file is obstructed by a non-regular file
1083 .It ! Ta a missing versioned file was restored
1087 will refuse to run if certain preconditions are not met.
1088 Most importantly, the
1090 must have been rebased onto the work tree's current branch with
1092 before it can be integrated, in order to linearize commit history and
1093 resolve merge conflicts.
1094 If the work tree contains multiple base commits it must first be updated
1095 to a single base commit with
1097 If changes have been staged with
1099 these changes must first be committed with
1103 If the work tree contains local changes, these changes must first be
1111 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1112 Stage local changes for inclusion in the next commit.
1115 is specified, stage all changes in the work tree.
1116 Otherwise, stage changes at or within the specified paths.
1117 Paths may be staged if they are added, modified, or deleted according to
1120 Show the status of each affected file, using the following status codes:
1121 .Bl -column YXZ description
1122 .It A Ta file addition has been staged
1123 .It M Ta file modification has been staged
1124 .It D Ta file deletion has been staged
1127 Staged file contents are saved in newly created blob objects in the repository.
1128 These blobs will be referred to by tree objects once staged changes have been
1131 Staged changes affect the behaviour of
1136 While paths with staged changes exist, the
1138 command will refuse to commit any paths which do not have staged changes.
1139 Local changes created on top of staged changes can only be committed if
1140 the path is staged again, or if the staged changes are committed first.
1143 command will show both local changes and staged changes.
1146 command is able to display local changes relative to staged changes,
1147 and to display staged changes relative to the repository.
1150 command cannot revert staged changes but may be used to revert
1151 local changes created on top of staged changes.
1158 Instead of staging new changes, list paths which are already staged,
1159 along with the IDs of staged blob objects and stage status codes.
1160 If paths were provided in the command line show the staged paths
1161 among the specified paths.
1162 Otherwise, show all staged paths.
1164 Instead of staging the entire content of a changed file, interactively
1165 select or reject changes for staging based on
1169 (reject change), and
1171 (quit staging this file) responses.
1172 If a file is in modified status, individual patches derived from the
1173 modified file content can be staged.
1174 Files in added or deleted status may only be staged or rejected in
1176 .It Fl F Ar response-script
1184 responses line-by-line from the specified
1186 file instead of prompting interactively.
1190 will refuse to run if certain preconditions are not met.
1191 If a file contains merge conflicts, these conflicts must be resolved first.
1192 If a file is found to be out of date relative to the head commit on the
1193 work tree's current branch, the file must be updated with
1195 before it can be staged (however, this does not prevent the file from
1196 becoming out-of-date at some point after having been staged).
1203 commands will refuse to run while staged changes exist.
1204 If staged changes cannot be committed because a staged path
1205 is out of date, the path must be unstaged with
1207 before it can be updated with
1209 and may then be staged again if necessary.
1213 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1214 Merge staged changes back into the work tree and put affected paths
1215 back into non-staged status.
1218 is specified, unstage all staged changes across the entire work tree.
1219 Otherwise, unstage changes at or within the specified paths.
1221 Show the status of each affected file, using the following status codes:
1222 .Bl -column YXZ description
1223 .It G Ta file was unstaged
1224 .It C Ta file was unstaged and conflicts occurred during merge
1225 .It ! Ta changes destined for a missing file were not merged
1226 .It D Ta file was staged as deleted and still is deleted
1227 .It d Ta file's deletion was obstructed by local modifications
1228 .It \(a~ Ta changes destined for a non-regular file were not merged
1236 Instead of unstaging the entire content of a changed file, interactively
1237 select or reject changes for unstaging based on
1241 (keep change staged), and
1243 (quit unstaging this file) responses.
1244 If a file is staged in modified status, individual patches derived from the
1245 staged file content can be unstaged.
1246 Files staged in added or deleted status may only be unstaged in their entirety.
1247 .It Fl F Ar response-script
1255 responses line-by-line from the specified
1257 file instead of prompting interactively.
1262 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1263 Parse and print contents of objects to standard output in a line-based
1265 Content of commit, tree, and tag objects is printed in a way similar
1266 to the actual content stored in such objects.
1267 Blob object contents are printed as they would appear in files on disk.
1269 Attempt to interpret each argument as a reference, a tag name, or
1270 an object ID SHA1 hash.
1271 References will be resolved to an object ID.
1272 Tag names will resolved to a tag object.
1273 An abbreviated hash argument will be expanded to a full SHA1 hash
1274 automatically, provided the abbreviation is unique.
1276 If none of the above interpretations produce a valid result, or if the
1278 option is used, attempt to interpret the argument as a path which will
1279 be resolved to the ID of an object found at this path in the repository.
1286 Look up paths in the specified
1288 If this option is not used, paths are looked up in the commit resolved
1289 via the repository's HEAD reference.
1290 The expected argument is a commit ID SHA1 hash or an existing reference
1291 or tag name which will be resolved to a commit ID.
1292 An abbreviated hash argument will be expanded to a full SHA1 hash
1293 automatically, provided the abbreviation is unique.
1294 .It Fl r Ar repository-path
1295 Use the repository at the specified path.
1296 If not specified, assume the repository is located at or above the current
1298 If this directory is a
1300 work tree, use the repository path associated with this work tree.
1302 Interpret all arguments as paths only.
1303 This option can be used to resolve ambiguity in cases where paths
1304 look like tag names, reference names, or object IDs.
1308 .Bl -tag -width GOT_AUTHOR
1310 The author's name and email address for
1315 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1318 may fail to parse commits without an email address in author data,
1322 environment variables with a missing email address.
1328 configuration settings in the repository's
1330 file will override the value of
1336 configuration settings contained in Git's global
1338 configuration file will be used only if the
1340 environment variable is
1343 .It Ev VISUAL , EDITOR
1344 The editor spawned by
1349 .It Ev GOT_LOG_DEFAULT_LIMIT
1350 The default limit on the number of commits traversed by
1352 If set to zero, the limit is unbounded.
1353 This variable will be silently ignored if it is set to a non-numeric value.
1358 Clone an existing Git repository for use with
1360 This step currently requires
1364 .Dl $ git clone --bare https://github.com/openbsd/src.git
1366 Alternatively, for quick and dirty local testing of
1368 a new Git repository could be created and populated with files,
1369 e.g. from a temporary CVS checkout located at
1372 .Dl $ got init /var/git/src.git
1373 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1375 Check out a work tree from the Git repository to /usr/src:
1377 .Dl $ got checkout /var/git/src.git /usr/src
1379 View local changes in a work tree directory:
1382 .Dl $ got diff | less
1384 Interactively revert selected local changes in a work tree directory:
1386 .Dl $ got revert -p -R\ .
1388 In a work tree or a git repository directory, list all branch references:
1392 In a work tree or a git repository directory, create a new branch called
1393 .Dq unified-buffer-cache
1394 which is forked off the
1398 .Dl $ got branch unified-buffer-cache master
1400 Switch an existing work tree to the branch
1401 .Dq unified-buffer-cache .
1402 Local changes in the work tree will be preserved and merged if necessary:
1404 .Dl $ got update -b unified-buffer-cache
1406 Create a new commit from local changes in a work tree directory.
1407 This new commit will become the head commit of the work tree's current branch:
1411 In a work tree or a git repository directory, view changes committed in
1412 the 3 most recent commits to the work tree's branch, or the branch resolved
1413 via the repository's HEAD reference, respectively:
1415 .Dl $ got log -p -l 3 -f
1417 Add new files and remove obsolete files in a work tree directory:
1419 .Dl $ got add sys/uvm/uvm_ubc.c
1420 .Dl $ got remove sys/uvm/uvm_vnode.c
1422 Create a new commit from local changes in a work tree directory
1423 with a pre-defined log message.
1425 .Dl $ got commit -m 'unify the buffer cache'
1427 Update any work tree checked out from the
1428 .Dq unified-buffer-cache
1429 branch to the latest commit on this branch:
1433 Roll file content on the unified-buffer-cache branch back by one commit,
1434 and then fetch the rolled-back change into the work tree as a local change
1435 to be amended and perhaps committed again:
1437 .Dl $ got backout unified-buffer-cache
1438 .Dl $ got commit -m 'roll back previous'
1439 .Dl $ # now back out the previous backout :-)
1440 .Dl $ got backout unified-buffer-cache
1442 Fetch new upstream commits into the local repository's master branch.
1443 This step currently requires
1446 .Dl $ cd /var/git/src.git
1447 .Dl $ git fetch origin master:master
1450 .Dq unified-buffer-cache
1451 branch on top of the new head commit of the
1455 .Dl $ got update -b master
1456 .Dl $ got rebase unified-buffer-cache
1458 Create a patch from all changes on the unified-buffer-cache branch.
1459 The patch can be mailed out for review and applied to
1463 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1465 Edit the entire commit history of the
1466 .Dq unified-buffer-cache
1469 .Dl $ got update -b unified-buffer-cache
1470 .Dl $ got update -c master
1473 Additional steps are necessary if local changes need to be pushed back
1474 to the remote repository, which currently requires
1478 Before working against existing branches in a repository cloned with
1479 .Dq git clone --bare ,
1482 must be configured to map all references in the remote repository
1485 namespace of the local repository.
1486 This can achieved by setting Git's
1487 .Pa remote.origin.fetch
1488 configuration variable to the value
1489 .Dq +refs/heads/*:refs/remotes/origin/*
1494 .Dl $ cd /var/git/repo
1495 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1497 Alternatively, the following
1499 configuration item can be added manually to the Git repository's
1503 .Dl [remote "origin"]
1505 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1507 This configuration leaves the local repository's
1509 namespace free for use by local branches checked out with
1511 and, if needed, created with
1516 namespace can be updated with incoming changes from the remote
1520 .Dl $ cd /var/git/repo
1523 Before outgoing changes on the local
1525 branch can be pushed to the remote repository, the local
1527 branch must be rebased onto the
1531 .Dl $ got update -b origin/master
1532 .Dl $ got rebase master
1534 Changes on the local
1536 branch can then be pushed to the remote
1540 .Dl $ cd /var/git/repo
1541 .Dl $ git push origin master
1543 In order to merge changes committed to the
1544 .Dq unified-buffer-cache
1545 branch back into the
1548 .Dq unified-buffer-cache
1549 branch must first be rebased onto the
1553 .Dl $ got update -b master
1554 .Dl $ got rebase unified-buffer-cache
1557 .Dq unified-buffer-cache
1558 branch can now be made visible on the
1562 Because the rebase operation switched the work tree to the
1563 .Dq unified-buffer-cache
1564 branch, the work tree must be switched back to the
1567 .Dq unified-buffer-cache
1568 branch can be integrated into
1571 .Dl $ got update -b master
1572 .Dl $ got integrate unified-buffer-cache
1576 .Xr git-repository 5 ,
1579 .An Stefan Sperling Aq Mt stsp@openbsd.org
1580 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1581 .An Joshua Stein Aq Mt jcs@openbsd.org
1584 is a work-in-progress and many commands remain to be implemented.
1585 At present, the user has to fall back on
1587 to perform many tasks, in particular tasks related to repository
1588 administration and tasks which require a network connection.
