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 s Ar search-pattern 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 s Ar search-pattern
358 If specified, show only commits with a log message matched by the extended
361 Regular expression syntax is documented in
363 .It Fl r Ar repository-path
364 Use the repository at the specified path.
365 If not specified, assume the repository is located at or above the current
367 If this directory is a
369 work tree, use the repository path associated with this work tree.
371 .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
372 When invoked within a work tree with less than two arguments, display
373 uncommitted changes in the work tree.
376 is specified, only show changes within this path.
378 If two arguments are provided, treat each argument as a reference, a tag
379 name, or an object ID SHA1 hash, and display differences between the
380 corresponding objects.
381 Both objects must be of the same type (blobs, trees, or commits).
382 An abbreviated hash argument will be expanded to a full SHA1 hash
383 automatically, provided the abbreviation is unique.
390 Set the number of context lines shown in the diff.
391 By default, 3 lines of context are shown.
392 .It Fl r Ar repository-path
393 Use the repository at the specified path.
394 If not specified, assume the repository is located at or above the current
396 If this directory is a
398 work tree, use the repository path associated with this work tree.
400 Show changes staged with
402 instead of showing local changes.
403 This option is only valid when
405 is invoked in a work tree.
407 Ignore whitespace-only changes.
412 .It Cm blame Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Ar path
413 Display line-by-line history of a file at the specified path.
420 Start traversing history at the specified
422 The expected argument is a commit ID SHA1 hash or an existing reference
423 or tag name which will be resolved to a commit ID.
424 An abbreviated hash argument will be expanded to a full SHA1 hash
425 automatically, provided the abbreviation is unique.
426 .It Fl r Ar repository-path
427 Use the repository at the specified path.
428 If not specified, assume the repository is located at or above the current
430 If this directory is a
432 work tree, use the repository path associated with this work tree.
437 .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
438 Display a listing of files and directories at the specified
439 directory path in the repository.
440 Entries shown in this listing may carry one of the following trailing
442 .Bl -column YXZ description
443 .It @ Ta entry is a symbolic link
444 .It / Ta entry is a directory
445 .It * Ta entry is an executable file
446 .It $ Ta entry is a Git submodule
451 is specified, list the repository path corresponding to the current
452 directory of the work tree, or the root directory of the repository
453 if there is no work tree.
460 List files and directories as they appear in the specified
462 The expected argument is a commit ID SHA1 hash or an existing reference
463 or tag name which will be resolved to a commit ID.
464 An abbreviated hash argument will be expanded to a full SHA1 hash
465 automatically, provided the abbreviation is unique.
466 .It Fl r Ar repository-path
467 Use the repository at the specified path.
468 If not specified, assume the repository is located at or above the current
470 If this directory is a
472 work tree, use the repository path associated with this work tree.
474 Show object IDs of files (blob objects) and directories (tree objects).
476 Recurse into sub-directories in the repository.
481 .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
482 Manage references in a repository.
484 If no options are passed, expect two arguments and attempt to create,
485 or update, the reference with the given
487 and make it point at the given
489 The name must be an absolute reference name, i.e. it must begin with
491 The target may be an object ID SHA1 hash or an existing reference which
492 will be resolved to an object ID.
493 An abbreviated hash argument will be expanded to a full SHA1 hash
494 automatically, provided the abbreviation is unique.
500 .It Fl r Ar repository-path
501 Use the repository at the specified path.
502 If not specified, assume the repository is located at or above the current
504 If this directory is a
506 work tree, use the repository path associated with this work tree.
508 List all existing references in the repository.
510 Delete the reference with the specified name from the repository.
512 Create a symbolic reference pointing at the specified
514 which must be an existing reference.
515 Care should be taken not to create loops between references when
518 .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
519 Manage branches in a repository.
521 Branches are managed via references which live in the
526 command operates on references in this namespace only.
528 If invoked in a work tree without any arguments, print the name of the
529 work tree's current branch.
532 argument is passed, attempt to create a branch reference with the given name.
533 By default the new branch reference will point at the latest commit on the
534 work tree's current branch if invoked in a work tree, and otherwise to a commit
535 resolved via the repository's HEAD reference.
542 Make a newly created branch reference point at the specified
546 argument is a commit ID SHA1 hash or an existing reference
547 or tag name which will be resolved to a commit ID.
548 .It Fl r Ar repository-path
549 Use the repository at the specified path.
550 If not specified, assume the repository is located at or above the current
552 If this directory is a
554 work tree, use the repository path associated with this work tree.
556 List all existing branches in the repository.
557 If invoked in a work tree, the work tree's current branch is shown
558 with one the following annotations:
559 .Bl -column YXZ description
560 .It * Ta work tree's base commit matches the branch tip
561 .It \(a~ Ta work tree's base commit is out-of-date
564 Delete the branch with the specified name from the repository.
565 Only the branch reference is deleted.
566 Any commit, tree, and blob objects belonging to the branch
567 remain in the repository and may be removed separately with
568 Git's garbage collector.
573 .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
574 Manage tags in a repository.
576 Tags are managed via references which live in the
581 command operates on references in this namespace only.
582 References in this namespace point at tag objects which contain a pointer
583 to another object, a tag message, as well as author and timestamp information.
585 Expect one or two arguments and attempt to create a tag with the given
587 and make this tag point at the given
589 If no commit is specified, default to the latest commit on the work tree's
590 current branch if invoked in a work tree, and to a commit resolved via
591 the repository's HEAD reference otherwise.
592 Otherwise, the expected argument is a commit ID SHA1 hash or an existing
593 reference or tag name which will be resolved to a commit ID.
594 An abbreviated hash argument will be expanded to a full SHA1 hash
595 automatically, provided the abbreviation is unique.
602 Use the specified tag message when creating the new tag
607 opens a temporary file in an editor where a tag message can be written.
608 .It Fl r Ar repository-path
609 Use the repository at the specified path.
610 If not specified, assume the repository is located at or above the current
612 If this directory is a
614 work tree, use the repository path associated with this work tree.
616 List all existing tags in the repository instead of creating a new tag.
617 If this option is used, no other command-line arguments are allowed.
622 command will not delete tags or change existing tags.
623 If a tag must be deleted, the
625 command may be used to delete a tag's reference.
626 This should only be done if the tag has not already been copied to
628 .It Cm add Oo Fl R Oc Oo Fl I Oc Ar path ...
629 Schedule unversioned files in a work tree for addition to the
630 repository in the next commit.
637 Permit recursion into directories.
638 If this option is not specified,
640 will refuse to run if a specified
644 With -R, add files even if they match a
648 .It Cm remove Oo Fl f Oc Oo Fl k Oc Oo Fl R Oc Ar path ...
649 Remove versioned files from a work tree and schedule them for deletion
650 from the repository in the next commit.
657 Perform the operation even if a file contains uncommitted modifications.
659 Keep affected files on disk.
661 Permit recursion into directories.
662 If this option is not specified,
664 will refuse to run if a specified
671 .It Cm revert Oo Fl p Oc Oo Fl F Ar response-script Oc Oo Fl R Oc Ar path ...
672 Revert any uncommitted changes in files at the specified paths.
673 File contents will be overwritten with those contained in the
674 work tree's base commit.
675 There is no way to bring discarded changes back after
678 If a file was added with
680 it will become an unversioned file again.
681 If a file was deleted with
690 Instead of reverting all changes in files, interactively select or reject
691 changes to revert based on
697 (quit reverting this file) responses.
698 If a file is in modified status, individual patches derived from the
699 modified file content can be reverted.
700 Files in added or deleted status may only be reverted in their entirety.
701 .It Fl F Ar response-script
709 responses line-by-line from the specified
711 file instead of prompting interactively.
713 Permit recursion into directories.
714 If this option is not specified,
716 will refuse to run if a specified
723 .It Cm commit Oo Fl m Ar message Oc Op Ar path ...
724 Create a new commit in the repository from changes in a work tree
725 and use this commit as the new base commit for the work tree.
728 is specified, commit all changes in the work tree.
729 Otherwise, commit changes at or within the specified paths.
731 If changes have been explicitly staged for commit with
733 only commit staged changes and reject any specified paths which
734 have not been staged.
736 Show the status of each affected file, using the following status codes:
737 .Bl -column YXZ description
738 .It M Ta modified file
739 .It D Ta file was deleted
740 .It A Ta new file was added
741 .It m Ta modified file modes (executable bit only)
744 Files which are not part of the new commit will retain their previously
745 recorded base commit.
748 commands may refuse to run while the work tree contains files from
749 multiple base commits.
750 The base commit of such a work tree can be made consistent by running
752 across the entire work tree.
758 environment variable to be set,
763 configuration settings can be
764 obtained from the repository's
766 file or from Git's global
775 Use the specified log message when creating the new commit.
780 opens a temporary file in an editor where a log message can be written.
784 will refuse to run if certain preconditions are not met.
785 If the work tree's current branch is not in the
787 reference namespace, new commits may not be created on this branch.
788 Local changes may only be committed if they are based on file content
789 found in the most recent commit on the work tree's branch.
790 If a path is found to be out of date,
792 must be used first in order to merge local changes with changes made
797 .It Cm cherrypick Ar commit
798 Merge changes from a single
803 must be on a different branch than the work tree's base commit.
804 The expected argument is a reference or a commit ID SHA1 hash.
805 An abbreviated hash argument will be expanded to a full SHA1 hash
806 automatically, provided the abbreviation is unique.
808 Show the status of each affected file, using the following status codes:
809 .Bl -column YXZ description
810 .It G Ta file was merged
811 .It C Ta file was merged and conflicts occurred during merge
812 .It ! Ta changes destined for a missing file were not merged
813 .It D Ta file was deleted
814 .It d Ta file's deletion was obstructed by local modifications
815 .It A Ta new file was added
816 .It \(a~ Ta changes destined for a non-regular file were not merged
819 The merged changes will appear as local changes in the work tree, which
822 amended manually or with further
827 or discarded again with
831 will refuse to run if certain preconditions are not met.
832 If the work tree contains multiple base commits it must first be updated
833 to a single base commit with
835 If the work tree already contains files with merge conflicts, these
836 conflicts must be resolved first.
840 .It Cm backout Ar commit
841 Reverse-merge changes from a single
846 must be on the same branch as the work tree's base commit.
847 The expected argument is a reference or a commit ID SHA1 hash.
848 An abbreviated hash argument will be expanded to a full SHA1 hash
849 automatically, provided the abbreviation is unique.
851 Show the status of each affected file, using the following status codes:
852 .Bl -column YXZ description
853 .It G Ta file was merged
854 .It C Ta file was merged and conflicts occurred during merge
855 .It ! Ta changes destined for a missing file were not merged
856 .It D Ta file was deleted
857 .It d Ta file's deletion was obstructed by local modifications
858 .It A Ta new file was added
859 .It \(a~ Ta changes destined for a non-regular file were not merged
862 The reverse-merged changes will appear as local changes in the work tree,
863 which may be viewed with
865 amended manually or with further
870 or discarded again with
874 will refuse to run if certain preconditions are not met.
875 If the work tree contains multiple base commits it must first be updated
876 to a single base commit with
878 If the work tree already contains files with merge conflicts, these
879 conflicts must be resolved first.
883 .It Cm rebase Oo Fl a Oc Oo Fl c Oc Op Ar branch
884 Rebase commits on the specified
886 onto the tip of the current branch of the work tree.
889 must share common ancestry with the work tree's current branch.
890 Rebasing begins with the first descendant commit of the youngest
891 common ancestor commit shared by the specified
893 and the work tree's current branch, and stops once the tip commit
898 Rebased commits are accumulated on a temporary branch which the work tree
899 will remain switched to throughout the entire rebase operation.
900 Commits on this branch represent the same changes with the same log
901 messages as their counterparts on the original
903 but with different commit IDs.
904 Once rebasing has completed successfully, the temporary branch becomes
905 the new version of the specified
907 and the work tree is automatically switched to it.
909 While rebasing commits, show the status of each affected file,
910 using the following status codes:
911 .Bl -column YXZ description
912 .It G Ta file was merged
913 .It C Ta file was merged and conflicts occurred during merge
914 .It ! Ta changes destined for a missing file were not merged
915 .It D Ta file was deleted
916 .It d Ta file's deletion was obstructed by local modifications
917 .It A Ta new file was added
918 .It \(a~ Ta changes destined for a non-regular file were not merged
921 If merge conflicts occur the rebase operation is interrupted and may
922 be continued once conflicts have been resolved.
923 Alternatively, the rebase operation may be aborted which will leave
925 unmodified and the work tree switched back to its original branch.
927 If a merge conflict is resolved in a way which renders the merged
928 change into a no-op change, the corresponding commit will be elided
929 when the rebase operation continues.
932 will refuse to run if certain preconditions are not met.
933 If the work tree is not yet fully updated to the tip commit of its
934 branch then the work tree must first be updated with
936 If changes have been staged with
938 these changes must first be committed with
942 If the work tree contains local changes, these changes must first be
949 contains changes to files outside of the work tree's path prefix,
950 the work tree cannot be used to rebase this branch.
956 commands will refuse to run while a rebase operation is in progress.
957 Other commands which manipulate the work tree may be used for
958 conflict resolution purposes.
965 Abort an interrupted rebase operation.
966 If this option is used, no other command-line arguments are allowed.
968 Continue an interrupted rebase operation.
969 If this option is used, no other command-line arguments are allowed.
974 .It Cm histedit Oo Fl a Oc Oo Fl c Oc Op Fl F Ar histedit-script
975 Edit commit history between the work tree's current base commit and
976 the tip commit of the work tree's current branch.
978 Editing of commit history is controlled via a
980 which can be edited interactively or passed on the command line.
981 The format of the histedit script is line-based.
982 Each line in the script begins with a command name, followed by
983 whitespace and an argument.
984 For most commands, the expected argument is a commit ID SHA1 hash.
985 Any remaining text on the line is ignored.
986 Lines which begin with the
988 character are ignored entirely.
990 The available commands are as follows:
991 .Bl -column YXZ pick-commit
992 .It pick Ar commit Ta Use the specified commit as it is.
993 .It edit Ar commit Ta Use the specified commit but once changes have been
994 merged into the work tree interrupt the histedit operation for amending.
995 .It fold Ar commit Ta Combine the specified commit with the next commit
996 listed further below that will be used.
997 .It drop Ar commit Ta Remove this commit from the edited history.
998 .It mesg Ar log-message Ta Use the specified single-line log message for
999 the commit on the previous line.
1000 If the log message argument is left empty, open an editor where a new
1001 log message can be written.
1004 Every commit in the history being edited must be mentioned in the script.
1005 Lines may be re-ordered to change the order of commits in the edited history.
1007 Edited commits are accumulated on a temporary branch which the work tree
1008 will remain switched to throughout the entire histedit operation.
1009 Once history editing has completed successfully, the temporary branch becomes
1010 the new version of the work tree's branch and the work tree is automatically
1013 While merging commits, show the status of each affected file,
1014 using the following status codes:
1015 .Bl -column YXZ description
1016 .It G Ta file was merged
1017 .It C Ta file was merged and conflicts occurred during merge
1018 .It ! Ta changes destined for a missing file were not merged
1019 .It D Ta file was deleted
1020 .It d Ta file's deletion was obstructed by local modifications
1021 .It A Ta new file was added
1022 .It \(a~ Ta changes destined for a non-regular file were not merged
1025 If merge conflicts occur the histedit operation is interrupted and may
1026 be continued once conflicts have been resolved.
1027 Alternatively, the histedit operation may be aborted which will leave
1028 the work tree switched back to its original branch.
1030 If a merge conflict is resolved in a way which renders the merged
1031 change into a no-op change, the corresponding commit will be elided
1032 when the histedit operation continues.
1035 will refuse to run if certain preconditions are not met.
1036 If the work tree's current branch is not in the
1038 reference namespace, the history of the branch may not be edited.
1039 If the work tree contains multiple base commits it must first be updated
1040 to a single base commit with
1042 If changes have been staged with
1044 these changes must first be committed with
1048 If the work tree contains local changes, these changes must first be
1053 If the edited history contains changes to files outside of the work tree's
1054 path prefix, the work tree cannot be used to edit the history of this branch.
1058 command will refuse to run while a histedit operation is in progress.
1059 Other commands which manipulate the work tree may be used, and the
1061 command may be used to commit arbitrary changes to the temporary branch
1062 while the histedit operation is interrupted.
1069 Abort an interrupted histedit operation.
1070 If this option is used, no other command-line arguments are allowed.
1072 Continue an interrupted histedit operation.
1073 If this option is used, no other command-line arguments are allowed.
1078 .It Cm integrate Ar branch
1079 Integrate the specified
1081 into the work tree's current branch.
1082 Files in the work tree are updated to match the contents on the integrated
1084 and the reference of the work tree's branch is changed to point at the
1085 head commit of the integrated
1088 Both branches can be considered equivalent after integration since they
1089 will be pointing at the same commit.
1090 Both branches remain available for future work, if desired.
1091 In case the integrated
1093 is no longer needed it may be deleted with
1096 Show the status of each affected file, using the following status codes:
1097 .Bl -column YXZ description
1098 .It U Ta file was updated
1099 .It D Ta file was deleted
1100 .It A Ta new file was added
1101 .It \(a~ Ta versioned file is obstructed by a non-regular file
1102 .It ! Ta a missing versioned file was restored
1106 will refuse to run if certain preconditions are not met.
1107 Most importantly, the
1109 must have been rebased onto the work tree's current branch with
1111 before it can be integrated, in order to linearize commit history and
1112 resolve merge conflicts.
1113 If the work tree contains multiple base commits it must first be updated
1114 to a single base commit with
1116 If changes have been staged with
1118 these changes must first be committed with
1122 If the work tree contains local changes, these changes must first be
1130 .It Cm stage Oo Fl l Oc Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1131 Stage local changes for inclusion in the next commit.
1134 is specified, stage all changes in the work tree.
1135 Otherwise, stage changes at or within the specified paths.
1136 Paths may be staged if they are added, modified, or deleted according to
1139 Show the status of each affected file, using the following status codes:
1140 .Bl -column YXZ description
1141 .It A Ta file addition has been staged
1142 .It M Ta file modification has been staged
1143 .It D Ta file deletion has been staged
1146 Staged file contents are saved in newly created blob objects in the repository.
1147 These blobs will be referred to by tree objects once staged changes have been
1150 Staged changes affect the behaviour of
1155 While paths with staged changes exist, the
1157 command will refuse to commit any paths which do not have staged changes.
1158 Local changes created on top of staged changes can only be committed if
1159 the path is staged again, or if the staged changes are committed first.
1162 command will show both local changes and staged changes.
1165 command is able to display local changes relative to staged changes,
1166 and to display staged changes relative to the repository.
1169 command cannot revert staged changes but may be used to revert
1170 local changes created on top of staged changes.
1177 Instead of staging new changes, list paths which are already staged,
1178 along with the IDs of staged blob objects and stage status codes.
1179 If paths were provided in the command line show the staged paths
1180 among the specified paths.
1181 Otherwise, show all staged paths.
1183 Instead of staging the entire content of a changed file, interactively
1184 select or reject changes for staging based on
1188 (reject change), and
1190 (quit staging this file) responses.
1191 If a file is in modified status, individual patches derived from the
1192 modified file content can be staged.
1193 Files in added or deleted status may only be staged or rejected in
1195 .It Fl F Ar response-script
1203 responses line-by-line from the specified
1205 file instead of prompting interactively.
1209 will refuse to run if certain preconditions are not met.
1210 If a file contains merge conflicts, these conflicts must be resolved first.
1211 If a file is found to be out of date relative to the head commit on the
1212 work tree's current branch, the file must be updated with
1214 before it can be staged (however, this does not prevent the file from
1215 becoming out-of-date at some point after having been staged).
1222 commands will refuse to run while staged changes exist.
1223 If staged changes cannot be committed because a staged path
1224 is out of date, the path must be unstaged with
1226 before it can be updated with
1228 and may then be staged again if necessary.
1232 .It Cm unstage Oo Fl p Oc Oo Fl F Ar response-script Oc Op Ar path ...
1233 Merge staged changes back into the work tree and put affected paths
1234 back into non-staged status.
1237 is specified, unstage all staged changes across the entire work tree.
1238 Otherwise, unstage changes at or within the specified paths.
1240 Show the status of each affected file, using the following status codes:
1241 .Bl -column YXZ description
1242 .It G Ta file was unstaged
1243 .It C Ta file was unstaged and conflicts occurred during merge
1244 .It ! Ta changes destined for a missing file were not merged
1245 .It D Ta file was staged as deleted and still is deleted
1246 .It d Ta file's deletion was obstructed by local modifications
1247 .It \(a~ Ta changes destined for a non-regular file were not merged
1255 Instead of unstaging the entire content of a changed file, interactively
1256 select or reject changes for unstaging based on
1260 (keep change staged), and
1262 (quit unstaging this file) responses.
1263 If a file is staged in modified status, individual patches derived from the
1264 staged file content can be unstaged.
1265 Files staged in added or deleted status may only be unstaged in their entirety.
1266 .It Fl F Ar response-script
1274 responses line-by-line from the specified
1276 file instead of prompting interactively.
1281 .It Cm cat Oo Fl c Ar commit Oc Oo Fl r Ar repository-path Oc Oo Fl P Oc Ar arg ...
1282 Parse and print contents of objects to standard output in a line-based
1284 Content of commit, tree, and tag objects is printed in a way similar
1285 to the actual content stored in such objects.
1286 Blob object contents are printed as they would appear in files on disk.
1288 Attempt to interpret each argument as a reference, a tag name, or
1289 an object ID SHA1 hash.
1290 References will be resolved to an object ID.
1291 Tag names will resolved to a tag object.
1292 An abbreviated hash argument will be expanded to a full SHA1 hash
1293 automatically, provided the abbreviation is unique.
1295 If none of the above interpretations produce a valid result, or if the
1297 option is used, attempt to interpret the argument as a path which will
1298 be resolved to the ID of an object found at this path in the repository.
1305 Look up paths in the specified
1307 If this option is not used, paths are looked up in the commit resolved
1308 via the repository's HEAD reference.
1309 The expected argument is a commit ID SHA1 hash or an existing reference
1310 or tag name which will be resolved to a commit ID.
1311 An abbreviated hash argument will be expanded to a full SHA1 hash
1312 automatically, provided the abbreviation is unique.
1313 .It Fl r Ar repository-path
1314 Use the repository at the specified path.
1315 If not specified, assume the repository is located at or above the current
1317 If this directory is a
1319 work tree, use the repository path associated with this work tree.
1321 Interpret all arguments as paths only.
1322 This option can be used to resolve ambiguity in cases where paths
1323 look like tag names, reference names, or object IDs.
1327 .Bl -tag -width GOT_AUTHOR
1329 The author's name and email address for
1334 .Dq An Flan Hacker Aq Mt flan_hacker@openbsd.org .
1337 may fail to parse commits without an email address in author data,
1341 environment variables with a missing email address.
1347 configuration settings in the repository's
1349 file will override the value of
1355 configuration settings contained in Git's global
1357 configuration file will be used only if the
1359 environment variable is
1362 .It Ev VISUAL , EDITOR
1363 The editor spawned by
1368 .It Ev GOT_LOG_DEFAULT_LIMIT
1369 The default limit on the number of commits traversed by
1371 If set to zero, the limit is unbounded.
1372 This variable will be silently ignored if it is set to a non-numeric value.
1377 Clone an existing Git repository for use with
1379 This step currently requires
1383 .Dl $ git clone --bare https://github.com/openbsd/src.git
1385 Alternatively, for quick and dirty local testing of
1387 a new Git repository could be created and populated with files,
1388 e.g. from a temporary CVS checkout located at
1391 .Dl $ got init /var/git/src.git
1392 .Dl $ got import -r /var/git/src.git -I CVS -I obj /tmp/src
1394 Check out a work tree from the Git repository to /usr/src:
1396 .Dl $ got checkout /var/git/src.git /usr/src
1398 View local changes in a work tree directory:
1401 .Dl $ got diff | less
1403 Interactively revert selected local changes in a work tree directory:
1405 .Dl $ got revert -p -R\ .
1407 In a work tree or a git repository directory, list all branch references:
1411 In a work tree or a git repository directory, create a new branch called
1412 .Dq unified-buffer-cache
1413 which is forked off the
1417 .Dl $ got branch unified-buffer-cache master
1419 Switch an existing work tree to the branch
1420 .Dq unified-buffer-cache .
1421 Local changes in the work tree will be preserved and merged if necessary:
1423 .Dl $ got update -b unified-buffer-cache
1425 Create a new commit from local changes in a work tree directory.
1426 This new commit will become the head commit of the work tree's current branch:
1430 In a work tree or a git repository directory, view changes committed in
1431 the 3 most recent commits to the work tree's branch, or the branch resolved
1432 via the repository's HEAD reference, respectively:
1434 .Dl $ got log -p -l 3 -f
1436 Add new files and remove obsolete files in a work tree directory:
1438 .Dl $ got add sys/uvm/uvm_ubc.c
1439 .Dl $ got remove sys/uvm/uvm_vnode.c
1441 Create a new commit from local changes in a work tree directory
1442 with a pre-defined log message.
1444 .Dl $ got commit -m 'unify the buffer cache'
1446 Update any work tree checked out from the
1447 .Dq unified-buffer-cache
1448 branch to the latest commit on this branch:
1452 Roll file content on the unified-buffer-cache branch back by one commit,
1453 and then fetch the rolled-back change into the work tree as a local change
1454 to be amended and perhaps committed again:
1456 .Dl $ got backout unified-buffer-cache
1457 .Dl $ got commit -m 'roll back previous'
1458 .Dl $ # now back out the previous backout :-)
1459 .Dl $ got backout unified-buffer-cache
1461 Fetch new upstream commits into the local repository's master branch.
1462 This step currently requires
1465 .Dl $ cd /var/git/src.git
1466 .Dl $ git fetch origin master:master
1469 .Dq unified-buffer-cache
1470 branch on top of the new head commit of the
1474 .Dl $ got update -b master
1475 .Dl $ got rebase unified-buffer-cache
1477 Create a patch from all changes on the unified-buffer-cache branch.
1478 The patch can be mailed out for review and applied to
1482 .Dl $ got diff master unified-buffer-cache > /tmp/ubc.diff
1484 Edit the entire commit history of the
1485 .Dq unified-buffer-cache
1488 .Dl $ got update -b unified-buffer-cache
1489 .Dl $ got update -c master
1492 Additional steps are necessary if local changes need to be pushed back
1493 to the remote repository, which currently requires
1497 Before working against existing branches in a repository cloned with
1498 .Dq git clone --bare ,
1501 must be configured to map all references in the remote repository
1504 namespace of the local repository.
1505 This can achieved by setting Git's
1506 .Pa remote.origin.fetch
1507 configuration variable to the value
1508 .Dq +refs/heads/*:refs/remotes/origin/*
1513 .Dl $ cd /var/git/repo
1514 .Dl $ git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*'
1516 Alternatively, the following
1518 configuration item can be added manually to the Git repository's
1522 .Dl [remote "origin"]
1524 .Dl fetch = +refs/heads/*:refs/remotes/origin/*
1526 This configuration leaves the local repository's
1528 namespace free for use by local branches checked out with
1530 and, if needed, created with
1535 namespace can be updated with incoming changes from the remote
1539 .Dl $ cd /var/git/repo
1542 Before outgoing changes on the local
1544 branch can be pushed to the remote repository, the local
1546 branch must be rebased onto the
1550 .Dl $ got update -b origin/master
1551 .Dl $ got rebase master
1553 Changes on the local
1555 branch can then be pushed to the remote
1559 .Dl $ cd /var/git/repo
1560 .Dl $ git push origin master
1562 In order to merge changes committed to the
1563 .Dq unified-buffer-cache
1564 branch back into the
1567 .Dq unified-buffer-cache
1568 branch must first be rebased onto the
1572 .Dl $ got update -b master
1573 .Dl $ got rebase unified-buffer-cache
1576 .Dq unified-buffer-cache
1577 branch can now be made visible on the
1581 Because the rebase operation switched the work tree to the
1582 .Dq unified-buffer-cache
1583 branch, the work tree must be switched back to the
1586 .Dq unified-buffer-cache
1587 branch can be integrated into
1590 .Dl $ got update -b master
1591 .Dl $ got integrate unified-buffer-cache
1594 .Xr git-repository 5 ,
1597 .An Stefan Sperling Aq Mt stsp@openbsd.org
1598 .An Martin Pieuchot Aq Mt mpi@openbsd.org
1599 .An Joshua Stein Aq Mt jcs@openbsd.org
1602 is a work-in-progress and many commands remain to be implemented.
1603 At present, the user has to fall back on
1605 to perform many tasks, in particular tasks related to repository
1606 administration and tasks which require a network connection.
